h1. Cohesion

!https://badge.fury.io/rb/cohesion.png!:http://badge.fury.io/rb/cohesion
!https://gemnasium.com/stewartmckee/coffee_table.png!
!https://coveralls.io/repos/stewartmckee/cohesion/badge.png?branch=master(Coverage Status)!:https://coveralls.io/r/stewartmckee/cohesion


h2. Intro

Cohesion is a group of tasks that allow you to check link cohesion in a site.

h2. Installation

Add to your Gemfile

bc. gem 'cohesion'

or you can just install without bundler with

bc. gem install cohesion

h2. Usage

h3. Executable

Running from the command line has the following syntax

bc. cohesion --url http://your-site-to-check.com/


h4. Options

Cohesion allows you to control the crawl through various command line options.  These are available through help (see below) and are listed here.


  * --url <start_url>                               Url to start crawl from
  * --internal_urls <url1,url2>                     List of url patterns to include
  * --external_urls <exclude_url1, exclude_url2>    List of url patterns to exclude
  * --seed_urls <seed_url1,seed_url2>               Seed urls
  * --crawl_limit <number_of_urls>                  Limit the crawl to a number of urls
  * --thread_count <number_of_threads>              Set the number of threads used
  * --cache <number_of_seconds>                     Sets the timeout for the cache, leave blank for no cache
  * --timeout <timeout_in_seconds>                  Sets the timeout for http requests
  * --output <filename>                             Path to output data to
  * --output_format <format_for_output_file>        Output format, csv or json

  * -v, --verbose                                   Display crawl information
  * -d, --debug                                     Display debug information
  * -w, --web_statistics                            Start web stats server


h4. Help

Help with available options is available with --help

bc. cohesion --help




h3. Checking an external site

You can check an external site with the rake task below.  This will crawl the site and check each link within the site, and will also check the links to external sites.  It will also check image, stylesheet and javascript references from link tags.

bc. rake cohesion:check["http://your-site-to-check.com"]

h3. Checking your local development environment

Currently you can check your local development environment the same way as you do an external, but point to your local server:

bc. rake cohesion:check["http://localhost:3000/"]


h2. Future

I intend to add the ability to check the rails app without starting the server though, which would allow you to add it to your specs.

h2. Contribute

If you want to contribute, you can fork the github repository and submit pull requests, or you can donate me some development fuel... ie coffee/beer use this link 

"DONATE!":https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VDJK49HD3DNAS&lc=GB&item_name=stewartmckee&item_number=stewartmckee_donation&no_note=1&no_shipping=1&currency_code=GBP&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted