<commit_before>FitNexus
========

This project aims to include a set of plugins and add-ons to [FitNesse](http://fitnesse.org/)
to enhance its capabilities and make it into a more full-featured testing platform. The
add-ons include:

- [Cukable](http://github.com/wapcaplet/cukable): [Cucumber](http://cukes.info)
  frontend for FitNesse
- [Mastiffe](http://github.com/Ken-g6/Mastiffe): Manual testing interface for FitNesse
- [Rsel](http://github.com/a-e/rsel): Ruby-based Selenium support for FitNesse

FitNexus is being developed by the [Automation Excellence](http://github.com/a-e)
team, and is still in early development. So far, it has only been tested on
Linux; it might work on OSX, but it will definitely not work on Windows.


Installation
------------

FitNexus is distributed as a lightweight gem file, and consists primarily of a
Ruby script that installs and configures a new FitNesse wiki in a directory of
your choice. To install FitNexus:

    $ sudo gem install fitnexus

To create a new project in `/tmp/foo`, run:

    $ fitnexus /tmp/foo

If all goes to plan, this will create the following files and folders in
`/tmp/foo`:

- `fitnesse.jar`: FitNesse executable
- `FitNesseRoot`: Wiki files and content
- `Gemfile`: Gem dependencies to be installed
- `mastiffe`: Symlink to Mastiffe files
- `Mastiffe`: Git clone of Mastiffe
- `plugins.properties`: FitNesse configuration
- `run.sh`: Script to start up the wiki

There's one more thing you need to do manually before FitNexus will be fully
installed, and that's to install the gem dependencies (Rsel and Cukable). This
is not handled automatically because FitNexus doesn't know whether you want to
use [RVM](http://beginrescueend.com) or not.

If you do NOT want to use RVM, you need to ensure that you have Ruby and
Rubygems installed systemwide. Then do:

    $ cd /tmp/foo
    $ sudo gem install bundler
    $ bundle install

Then skip ahead to "Running FitNexus" below.

If you do want to use RVM, then begin by doing this:

    $ bash < <(curl -s https://rvm.beginrescueend.com/install/rvm)

[Follow the instructions](http://www.beginrescueend.com/rvm/install/) to configure it.
When you get to the part about installing Ruby, use Ruby Enterprise Edition 1.8.7:

    $ rvm install ree

Switch to that ruby:

    $ rvm ree

Create a gemset for FitNexus:

    $ rvm gemset create fitnexus
    $ rvm ree@fitnexus

Once your gemset is created, you can switch to it at any time with `rvm
ree@fitnexus`. To do this automatically whenever you `cd` into the `FitNexus`
directory, create an `.rvmrc` file containing that command:

    $ echo "rvm ree@fitnexus" > .rvmrc

Install bundler in your global gemset:

    $ rvm ree@global
    $ gem install bundler

Then install the gem dependencies for FitNexus:

    $ rvm ree@fitnexus
    $ bundle install


Running FitNexus
----------------

FitNexus is just a regular FitNesse wiki with a few enhancements. A startup
script is provided, which you can edit to meet your needs (for instance, if you
want to run on a port other than 8080). Just run this:

    $ ./run.sh<commit_msg>Tidy up README<commit_after>FitNexus
========

This project aims to include a set of plugins and add-ons to [FitNesse](http://fitnesse.org/)
to enhance its capabilities and make it into a more full-featured testing platform. The
add-ons include:

- [Cukable](http://github.com/wapcaplet/cukable): [Cucumber](http://cukes.info)
  frontend for FitNesse
- [Mastiffe](http://github.com/Ken-g6/Mastiffe): Manual testing interface for FitNesse
- [Rsel](http://github.com/a-e/rsel): Ruby-based Selenium support for FitNesse

FitNexus is being developed by the [Automation Excellence](http://github.com/a-e)
team, and is still in early development. So far, it has only been tested on
Linux; it might work on OSX, but it will definitely not work on Windows.


Installation
------------

FitNexus is distributed as a lightweight gem file, and consists primarily of a
Ruby script that installs and configures a new FitNesse wiki in a directory of
your choice. To install FitNexus:

    $ sudo gem install fitnexus

To create a new project in `~/my_wiki`, run:

    $ fitnexus ~/my_wiki

If all goes to plan, this will create the following files and folders in
`~/my_wiki`:

- `fitnesse.jar`: FitNesse executable
- `FitNesseRoot`: Wiki files and content
- `Gemfile`: Gem dependencies to be installed
- `mastiffe`: Symlink to Mastiffe files
- `Mastiffe`: Git clone of Mastiffe
- `plugins.properties`: FitNesse configuration
- `run.sh`: Script to start up the wiki

There's one more thing you need to do manually before FitNexus will be fully
installed, and that's to install the gem dependencies (Rsel and Cukable). This
is not handled automatically because FitNexus doesn't know whether you want to
use [RVM](http://beginrescueend.com) or not.

If you do NOT want to use RVM, you need to ensure that you have Ruby and
Rubygems installed systemwide. Then do:

    $ sudo gem install bundler
    $ cd ~/my_wiki
    $ bundle install

Then skip ahead to "Running FitNexus" below.

If you do want to use RVM, then begin by doing this:

    $ bash < <(curl -s https://rvm.beginrescueend.com/install/rvm)

[Follow the instructions](http://www.beginrescueend.com/rvm/install/) to configure it.
When you get to the part about installing Ruby, use Ruby Enterprise Edition 1.8.7:

    $ rvm install ree

Switch to that ruby:

    $ rvm ree

Create a gemset for FitNexus:

    $ rvm gemset create fitnexus
    $ rvm ree@fitnexus

Once your gemset is created, you can switch to it at any time with `rvm
ree@fitnexus`. To do this automatically whenever you `cd` into your FitNexus
directory (i.e., `~/my_wiki`), create an `.rvmrc` file containing that command:

    $ echo "rvm ree@fitnexus" > ~/my_wiki/.rvmrc

Install bundler in your global gemset:

    $ cd ~/my_wiki
    $ rvm ree@global
    $ gem install bundler

Then install the gem dependencies for FitNexus:

    $ rvm ree@fitnexus
    $ bundle install


Running FitNexus
----------------

FitNexus is just a regular FitNesse wiki with a few enhancements. A startup
script is provided, which you can edit to meet your needs (for instance, if you
want to run on a port other than 8080). Just run this:

    $ ./run.sh
{'fraction_non_alphanumeric': 0.088871096877502, 'fraction_numerical': 0.0025620496397117695, 'mean_word_length': 3.6473214285714284, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2381670', 'n_tokens_mistral': 2049, 'n_tokens_neox': 1899, 'n_words': 841}