rotor_machine 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a52da896d6dbf81dd24ef00e3f9c80c26b9cd48e64441d6be91e37b54710eb1e
-  data.tar.gz: af1fcf7f5cfc1786ae5b33e4c216f387b0d8345f76a270dc5428649ea1ba682f
+  metadata.gz: f94b32c2319156d3776c48968d38156f23c7de7b6f3bd0d1122a922ee489e6b8
+  data.tar.gz: 58800af20530d489a363467825b7aa4dece4d215592c4060b8b23bc08a50a7fe
 SHA512:
-  metadata.gz: bb1878e52b14f84edfd06944815ec7bc97862823be50be3c497a959cfa9fc5f4d502759884568ac38e6e179de52c1f54868ca2650d4dd8033c85bba837a5e328
-  data.tar.gz: cf0017ad6357c67a4f1833bed242f20dbb770baee03c322b7c41e4fc4a8accdc743dde22d23b99b5e770a30d88e969611a3cf3a81621c8d0888acbc3d0bf1c2d
+  metadata.gz: 6844c77894049fb7346f811f7e4758e922c8ae554a3bf983908234c37c22c5021739aa91bc1b8571b6a2ad48a36f1bad1ad6eaea62bd5c273d25d4f6e0b34db4
+  data.tar.gz: 925d2892d5a594ef13a179d329676b3426f29ae607626068ee8a4a2b28dea57b7111f9affbedc267fab956a59eb397ce770c73b0d04e5ee90bc5651e55749562

data/README.md

@@ -9,7 +9,7 @@ for idiomatic conciseness. My aims were fairly modular code and a relatively
 complete RSpec test suite.
 
 Many thanks to Kevin Sylvestre, whose 
-[blog post](https://ksylvest.com/posts/2015-01-03/the-enigma-machine-using-ruby blog post) 
+[blog post](https://ksylvest.com/posts/2015-01-03/the-enigma-machine-using-ruby) 
 helped me understand some aspects of the internal workings of the Enigma and 
 how the signals flowed through the pieces of the machine.
 
@@ -76,6 +76,9 @@ from left to right. The signal then passes through the reflector (where it
 is transposed again), then back through the rotors in reverse order, and 
 finally back through the plugboard a second time before being displayed on
 the light grid and/or printer.
+
+[https://commons.wikimedia.org/wiki/File:Enigma_wiring_kleur.svg] depicts
+this visually.
   
 One important consequence of this signal path is that encryption and
 decryption are the same operation. That is to say, if you set the rotors
@@ -138,18 +141,44 @@ are also instructive for how the library works and how to use it.
 
 ## 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.
+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).
 
-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).
+This gem depends on the `tcravit_ruby_lib` gem, which provides Rake tasks to
+update the version number. You can use the `bundle exec rake version:bump:build`,
+`bundle exec version:bump:minor` and `bundle exec rake version:bump:major` tasks
+to increment the parts of the version number. (These tasks rewrite the file
+`lib/rotor_machine/version.rb`). After using them, you'll need to run a
+`git add lib/rotor_machine/version.rb` and `git commit -m "version bump"`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tammycravit/rotor_machine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at 
+[https://github.com/tammycravit/rotor_machine]. Pull requests for code changes 
+should include [RSpec](http://rspec.info) tests for the new/changed features.
+Pull requests for documentation and other updates are also welcome.
+
+This project is intended to be a safe, welcoming space for collaboration, and 
+contributors are expected to adhere to the 
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Contributions from people who identify as women, BIPOC folx, LGBT folx, 
+and members of other marginalized communities are especially welcomed.
 
 ## License
 
-The gem is available as open source under the terms of the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
+The gem is available as open source under the terms of the 
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
 
 ## Code of Conduct
 
-Everyone interacting in the RotorMachine project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.comtammycravitrotor_machine/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RotorMachine project’s codebases, issue trackers, 
+chat rooms and mailing lists is expected to follow the 
+[code of conduct](https://github.com/tammycravit/rotor_machine/blob/master/CODE_OF_CONDUCT.md).
+

data/lib/rotor_machine/version.rb

@@ -1,4 +1,4 @@
 module RotorMachine
-	VERSION_DATA = [1, 0, 3]
+	VERSION_DATA = [1, 0, 4]
 	VERSION = VERSION_DATA.join(".")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotor_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Tammy Cravit