<commit_before>devtools
========

[![Build Status](https://secure.travis-ci.org/rom-rb/devtools.png?branch=master)](http://travis-ci.org/rom-rb/devtools)
[![Dependency Status](https://gemnasium.com/rom-rb/devtools.png)](https://gemnasium.com/rom-rb/devtools)
[![Code Climate](https://codeclimate.com/github/datamapper/devtools.png)](https://codeclimate.com/github/datamapper/devtools)
<!-- [![Code Climate](https://codeclimate.com/github/rom-rb/devtools.png)](https://codeclimate.com/github/rom-rb/devtools) -->

Metagem to assist [ROM](https://github.com/rom-rb) style development.
Used to centralize metric setup and development gem dependencies.

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

The installation looks stupid because Gemfiles are not nestable (Gemfile cannot
include another Gemfile from a remote repository). Because of this we use an
updatable local copy of the shared parts.

Add the git source to your Gemfile's development section:

```ruby
group :development, :test do
  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
end
```

NOTE: The https URL is preferred to using `github: 'rom-rb/devtools` because
that will expand to a `git://` URL which is plain text by default. There is an
outstanding [pull request](https://github.com/bundler/bundler/pull/2569) that
will change `github:` to use https by default; when a stable bundler gem is
released all related gems should be updated to use it.

Run:
```
bundle install
```

Create a `Rakefile` in the project root with the following contents:

```ruby
require 'devtools'
Devtools.init_rake_tasks
```

To copy `Gemfile.devtools` to your project, run the following commands:

```
bundle update
bundle exec rake devtools:sync
```

To allow bundler to pick up the dependencies, append the following
line to your Gemfile's development section:

```ruby
eval_gemfile 'Gemfile.devtools'
```

To make the devtools dependencies available to your project, run:

```
bundle install
```

Finally, adjust `spec/spec_helper.rb` to include

```ruby
require 'devtools/spec_helper'
```

Now you have access to the [ROM](https://github.com/rom-rb) rake tasks, metrics
and spec helpers.

Credits
-------

The whole [ROM](https://github.com/rom-rb) team that created and maintained all
these tasks before they were centralized here.

Contributing
-------------

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with Rakefile or version
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

License
-------

See `LICENSE` file.
<commit_msg>Simplify and update README<commit_after># devtools

[![Build Status](https://secure.travis-ci.org/rom-rb/devtools.png?branch=master)](http://travis-ci.org/rom-rb/devtools)
[![Dependency Status](https://gemnasium.com/rom-rb/devtools.png)](https://gemnasium.com/rom-rb/devtools)
[![Code Climate](https://codeclimate.com/github/datamapper/devtools.png)](https://codeclimate.com/github/datamapper/devtools)
<!-- [![Code Climate](https://codeclimate.com/github/rom-rb/devtools.png)](https://codeclimate.com/github/rom-rb/devtools) -->

Metagem to assist [ROM](https://github.com/rom-rb) style development.
Used to centralize metric setup and development gem dependencies.

## Installation

The installation looks stupid because Gemfiles are not nestable (Gemfile cannot
include another Gemfile from a remote repository). Because of this we use an
updatable local copy of the shared parts.

Add the git source to your Gemfile's development section:

```ruby
group :development, :test do
  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
end
```

To initialize devtools in a project run the following command:

```ruby
bundle install
devtools init
```

This will *change your Gemfile and Rakefile* and add config files. Make sure to
review the diff and don't freak out ;)

## Updating

Later on if you want to update to the latest devtools just run:

```
bundle update devtools
devtools sync
bundle install
```

## RSpec support

If you're using RSpec and want to have access to our common setup just adjust
`spec/spec_helper.rb` to include

```ruby
require 'devtools/spec_helper'
```

## Credits

The whole [ROM](https://github.com/rom-rb) team that created and maintained all
these tasks before they were centralized here.

## Contributing

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with Rakefile or version
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

## License

See `LICENSE` file.

{'fraction_non_alphanumeric': 0.11593317033414834, 'fraction_numerical': 0.0008149959250203749, 'mean_word_length': 4.406387665198238, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, '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': '5462144', 'n_tokens_mistral': 1508, 'n_tokens_neox': 1445, 'n_words': 562}