<commit_before># Swift::Pyrite

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swift/pyrite`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'swift-pyrite'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install swift-pyrite

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swift-pyrite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
<commit_msg>improved readme - added usage<commit_after># Swift::Pyrite
Pyrite generates instrumented fakes for swift protocols! It is inspired by golang's [counterfeiter](https://github.com/maxbrunsfeld/counterfeiter). 

Pyrite will generate a fake which conforms to the first protocol definition it finds in the input file. Presently it only supports one protocol per file.

For some examples, look in the [spec/protocols](https://github.com/pivotal/swift-pyrite/tree/master/spec/expected_fakes) directory for input, and the spec/[expected_fakes](https://github.com/pivotal/swift-pyrite/tree/master/spec/expected_fakes) directory to see the generated output. 

## Installation

    $ gem install swift-pyrite

## Usage

```
$ pyrite help
Commands:
  pyrite generate INPUT_PATH OUTPUT_PATH  # Generates a fake for protocol in INPUT_PATH and writes it to OUTPUT_PATH
  pyrite help [COMMAND]                   # Describe available commands or one specific command
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pivotal/swift-pyrite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

{'fraction_non_alphanumeric': 0.07672487832808474, 'fraction_numerical': 0.0, 'mean_word_length': 4.375384615384616, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6996571', 'n_tokens_mistral': 964, 'n_tokens_neox': 922, 'n_words': 460}