cryptogram 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52be6b3851ed66b26a6d4d8310bd726f1ff9d31b
-  data.tar.gz: c799b07969056cf91bf201080c50412a503d53d3
+  metadata.gz: bb05a3f7c332d9aaf05ccbfb7a5d88df477dfbeb
+  data.tar.gz: d921172d42eb5ded2869c04ec605fa60e0205cb3
 SHA512:
-  metadata.gz: '08bac23d613b18d5962dc7deccdc45be18b3455300bf86a592a8e03bee34cd20fb5db4d058844b6a9004b907f3a15811bf8834fb7333ba59794f11dad0d9a629'
-  data.tar.gz: 6dca54e86cb47a2995f549c543d6c59029fd945a69e7231e651017e9d66eca37d56052ca136bd89f4d26507fe803a77c6b779c03a178b8f386780b94c542f666
+  metadata.gz: c7dcec80d8c8a2c56d4e86e454cdfb38a7a37d6be2dc26260cdce08ec43bb4e834c18d5cff55d776aa74364e69195d0e6176ba6f15c64008831f50a370af6e3f
+  data.tar.gz: 69e791543035b8b511676dd1bd5ab4494dbc633dcaf606dc874ea939e1f29801b9424800e0828870059586c3a55eb535f8a545c400113d1fb81760d786fb66d9

data/README.md

@@ -53,6 +53,12 @@ encryptor.decrypt('Sdfn pb era zlwk ilyh grchq oltxru mxjv')
  # => "Pack my box with five dozen liquor jugs"
 ```
 
+You can also use built-in alphabet presets (`lib/cryptogram/presets/alphabets.rb`):
+
+```ruby
+encryptor = Cryptogram::Ciphers::Caesar.new(alphabet: :english, shift: shift)
+```
+
 ## 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.
@@ -63,6 +69,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mkalmykov/cryptogram.
 
+To contribute:
+
+1. Fork it.
+2. `git checkout -b feature/my_awesome_feature develop`
+3. Create a pull request into develop.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/cryptogram/ciphers/base_cipher.rb

@@ -0,0 +1,34 @@
+require 'cryptogram/presets/alphabets'
+
+module Cryptogram
+  module Ciphers
+    class BaseCipher
+      #
+      # @param [Array, Symbol] alphabet Array of chars or presetted alphabet name
+      def initialize(alphabet:)
+        @alphabet = initialize_alphabet(alphabet)
+      end
+
+      def encrypt
+        raise NotImplementedError
+      end
+
+      def decrypt
+        raise NotImplementedError
+      end
+
+      private
+
+      def initialize_alphabet(alphabet)
+        case alphabet
+        when Array
+          alphabet
+        when Symbol
+          Cryptogram::Presets::Alphabets.fetch(alphabet)
+        else
+          raise ArgumentError, "Unsupported alphabet class: #{alphabet.class}"
+        end
+      end
+    end
+  end
+end

data/lib/cryptogram/ciphers/caesar.rb

@@ -1,24 +1,28 @@
+require 'cryptogram/ciphers/base_cipher'
 require 'cryptogram/mapper'
 
 module Cryptogram
   module Ciphers
-    class Caesar
+    class Caesar < BaseCipher
+      #
+      # @param [Array, Symbol] alphabet Array of chars or presetted alphabet name
+      # @param [Integer] shift Encryption shift
       def initialize(alphabet:, shift:)
-        @mapper = ::Cryptogram::Mapper.new(alphabet: alphabet, shift: shift)
+        super(alphabet: alphabet)
+
+        @mapper = ::Cryptogram::Mapper.new(alphabet: @alphabet, shift: shift)
       end
 
       def encrypt(string)
-        process(string) { |char| mapper.map_by_key(char) }
+        process(string) { |char| @mapper.map_to_shifted(char) }
       end
 
       def decrypt(string)
-        process(string) { |char| mapper.map_by_value(char) }
+        process(string) { |char| @mapper.map_to_initial(char) }
       end
 
       private
 
-      attr_reader :alphabet, :shift, :mapper
-
       def process(string, &block)
         raise ArgumentError unless block_given?
 

data/lib/cryptogram/mapper.rb

@@ -3,26 +3,24 @@ module Cryptogram
     def initialize(alphabet:, shift:)
       @shift = shift
 
-      @shifted_mapper = build_mapper(alphabet)
-      @shifted_swapcased_mapper = build_mapper(alphabet.join.swapcase.chars)
+      @mapper = build_mapper(alphabet)
+      @swapcased_mapper = build_mapper(alphabet.join.swapcase.chars)
     end
 
-    def map_by_key(char)
-      shifted_mapper.dig(char) || shifted_swapcased_mapper.dig(char) || char
+    def map_to_shifted(char)
+      @mapper.dig(char) || @swapcased_mapper.dig(char) || char
     end
 
-    def map_by_value(char)
-      shifted_mapper.key(char) || shifted_swapcased_mapper.key(char) || char
+    def map_to_initial(char)
+      @mapper.key(char) || @swapcased_mapper.key(char) || char
     end
 
     private
 
     def build_mapper(alphabet)
-      shifted_alphabet = alphabet.rotate(shift)
+      shifted_alphabet = alphabet.rotate(@shift)
 
       Hash[alphabet.zip(shifted_alphabet)]
     end
-
-    attr_reader :shift, :shifted_mapper, :shifted_swapcased_mapper
   end
 end

data/lib/cryptogram/presets/alphabets.rb

@@ -0,0 +1,18 @@
+module Cryptogram
+  module Presets
+    module Alphabets
+      ALPHABETS = {
+        english:  Array('a'..'z'),
+        russian: Array('а'..'я')
+      }.freeze
+
+      class << self
+        def fetch(alphabet_name)
+          ALPHABETS.fetch(alphabet_name) do
+            raise ArgumentError, "Unrecognized alphabet preset: #{alphabet_name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cryptogram/version.rb

@@ -1,3 +1,3 @@
 module Cryptogram
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptogram
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Maksim Kalmykov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,8 +85,10 @@ files:
 - bin/setup
 - cryptogram.gemspec
 - lib/cryptogram.rb
+- lib/cryptogram/ciphers/base_cipher.rb
 - lib/cryptogram/ciphers/caesar.rb
 - lib/cryptogram/mapper.rb
+- lib/cryptogram/presets/alphabets.rb
 - lib/cryptogram/version.rb
 homepage: https://github.com/mkalmykov/cryptogram
 licenses: