rotor_machine 1.0.3 → 1.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +35 -6
- data/lib/rotor_machine/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f94b32c2319156d3776c48968d38156f23c7de7b6f3bd0d1122a922ee489e6b8
|
4
|
+
data.tar.gz: 58800af20530d489a363467825b7aa4dece4d215592c4060b8b23bc08a50a7fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6844c77894049fb7346f811f7e4758e922c8ae554a3bf983908234c37c22c5021739aa91bc1b8571b6a2ad48a36f1bad1ad6eaea62bd5c273d25d4f6e0b34db4
|
7
|
+
data.tar.gz: 925d2892d5a594ef13a179d329676b3426f29ae607626068ee8a4a2b28dea57b7111f9affbedc267fab956a59eb397ce770c73b0d04e5ee90bc5651e55749562
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ for idiomatic conciseness. My aims were fairly modular code and a relatively
|
|
9
9
|
complete RSpec test suite.
|
10
10
|
|
11
11
|
Many thanks to Kevin Sylvestre, whose
|
12
|
-
[blog post](https://ksylvest.com/posts/2015-01-03/the-enigma-machine-using-ruby
|
12
|
+
[blog post](https://ksylvest.com/posts/2015-01-03/the-enigma-machine-using-ruby)
|
13
13
|
helped me understand some aspects of the internal workings of the Enigma and
|
14
14
|
how the signals flowed through the pieces of the machine.
|
15
15
|
|
@@ -76,6 +76,9 @@ from left to right. The signal then passes through the reflector (where it
|
|
76
76
|
is transposed again), then back through the rotors in reverse order, and
|
77
77
|
finally back through the plugboard a second time before being displayed on
|
78
78
|
the light grid and/or printer.
|
79
|
+
|
80
|
+
[https://commons.wikimedia.org/wiki/File:Enigma_wiring_kleur.svg] depicts
|
81
|
+
this visually.
|
79
82
|
|
80
83
|
One important consequence of this signal path is that encryption and
|
81
84
|
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.
|
|
138
141
|
|
139
142
|
## Development
|
140
143
|
|
141
|
-
After checking out the repo, run `bin/setup` to install dependencies. Then,
|
144
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then,
|
145
|
+
run `rake spec` to run the tests. You can also run `bin/console` for an
|
146
|
+
interactive prompt that will allow you to experiment.
|
147
|
+
|
148
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
149
|
+
|
150
|
+
To release a new version, update the version number in `version.rb`, and then
|
151
|
+
run `bundle exec rake release`, which will create a git tag for the version,
|
152
|
+
push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
142
153
|
|
143
|
-
|
154
|
+
This gem depends on the `tcravit_ruby_lib` gem, which provides Rake tasks to
|
155
|
+
update the version number. You can use the `bundle exec rake version:bump:build`,
|
156
|
+
`bundle exec version:bump:minor` and `bundle exec rake version:bump:major` tasks
|
157
|
+
to increment the parts of the version number. (These tasks rewrite the file
|
158
|
+
`lib/rotor_machine/version.rb`). After using them, you'll need to run a
|
159
|
+
`git add lib/rotor_machine/version.rb` and `git commit -m "version bump"`.
|
144
160
|
|
145
161
|
## Contributing
|
146
162
|
|
147
|
-
Bug reports and pull requests are welcome on GitHub at
|
163
|
+
Bug reports and pull requests are welcome on GitHub at
|
164
|
+
[https://github.com/tammycravit/rotor_machine]. Pull requests for code changes
|
165
|
+
should include [RSpec](http://rspec.info) tests for the new/changed features.
|
166
|
+
Pull requests for documentation and other updates are also welcome.
|
167
|
+
|
168
|
+
This project is intended to be a safe, welcoming space for collaboration, and
|
169
|
+
contributors are expected to adhere to the
|
170
|
+
[Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
171
|
+
Contributions from people who identify as women, BIPOC folx, LGBT folx,
|
172
|
+
and members of other marginalized communities are especially welcomed.
|
148
173
|
|
149
174
|
## License
|
150
175
|
|
151
|
-
The gem is available as open source under the terms of the
|
176
|
+
The gem is available as open source under the terms of the
|
177
|
+
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
|
152
178
|
|
153
179
|
## Code of Conduct
|
154
180
|
|
155
|
-
Everyone interacting in the RotorMachine project’s codebases, issue trackers,
|
181
|
+
Everyone interacting in the RotorMachine project’s codebases, issue trackers,
|
182
|
+
chat rooms and mailing lists is expected to follow the
|
183
|
+
[code of conduct](https://github.com/tammycravit/rotor_machine/blob/master/CODE_OF_CONDUCT.md).
|
184
|
+
|