n_cipher 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b39d00720a451c7e4b08aad44eccf6eece731daa
-  data.tar.gz: d9ddbc351f43179acfedc7912ce22c1bd19d5e83
+  metadata.gz: 2126680aa66698771c9b79645302925e95b1cf2b
+  data.tar.gz: 798adc75827207896f8f49ce53846fc66b1c29b8
 SHA512:
-  metadata.gz: 63cf98faa8b70179c7739044b2d00b5eae7f6f4e695a1d32efca40a3321c613214614387329c2fd805a1bb65574a503707e01c888b84947557678b779f09c4ab
-  data.tar.gz: 657c84e892dc261242cc6fbb030bc34a98d0fdeca4fad89b2ab3ba7ba634c2da3f2a22c8423ee8e322cc616c523a33b60ffc56c408bf7a9f0a44b6fc250a8566
+  metadata.gz: d9cf3ba5c3326214ba61743de75ca1676c0d58fdebdd2585c1555daf6bebb6370d8e88e78472746d77ab2368deda8da82c19aab39e0b0d3ddf91035c08e5852c
+  data.tar.gz: f47651c4242b453a998e06c66f775b9b75bbb5353aae3ee0fc9e7baddf2dd9258f6025b58c52a2cfe78e5001db3c84eaf123648323cb3e795f1815ca2ea325a3

data/.rubocop.yml

@@ -15,3 +15,5 @@ Metrics/AbcSize:
   Max: 25
 Metrics/LineLength:
   Max: 120
+Metrics/CyclomaticComplexity:
+  Max: 6

data/Guardfile

@@ -1,6 +1,6 @@
 # vim:set filetype=ruby:
 
 guard :shell do
-  watch(/(?:lib|test)\/.+\.rb/) { `bundle exec rake test` }
-  watch(/lib\/.+\.rb/) { `bundle exec rake yard` }
+  watch(%r{(?:lib|test)/.+\.rb}) { `bundle exec rake test` }
+  watch(%r{lib/.+\.rb}) { `bundle exec rake yard` }
 end

data/README.md

@@ -5,7 +5,7 @@
 [![Travis branch](https://img.shields.io/travis/844196/n_cipher.svg)](https://travis-ci.org/844196/n_cipher)
 [![Coveralls branch](https://img.shields.io/coveralls/844196/n_cipher/master.svg)](https://coveralls.io/github/844196/n_cipher)
 [![Code Climate](https://img.shields.io/codeclimate/github/844196/n_cipher.svg)](https://codeclimate.com/github/844196/n_cipher)
-[![Docunment](https://img.shields.io/badge/doc-RubyDoc.info-blue.svg)](http://www.rubydoc.info/github/844196/n_cipher/master)
+[![Docunment](https://img.shields.io/badge/docs-RubyDoc.info-blue.svg)](http://www.rubydoc.info/github/844196/n_cipher/master)
 [![Inline docs](http://inch-ci.org/github/844196/n_cipher.svg?branch=master&style=shields)](http://inch-ci.org/github/844196/n_cipher)
 
 ![](https://cloud.githubusercontent.com/assets/4990822/10408480/9bf5d63a-6f39-11e5-9568-55e24afcbdc5.png)
@@ -39,41 +39,51 @@ $ gem install n_cipher
 ```ruby
 require 'n_cipher'
 
-NCipher::encode('にゃんぱす', seed: 'おうどん', delimiter: 'ひげ')
+NCipher.encode('にゃんぱす', seed: 'おうどん', delimiter: 'ひげ')
 #=> "んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ"
 
-NCipher::decode(
+NCipher.decode(
   'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ',
   seed: 'おうどん', delimiter: 'ひげ')
 #=> "にゃんぱす"
 ```
 
+```ruby
+# いちいちオプション指定するのが面倒なとき用
+NCipher.configure do |config|
+  config.seed = 'おうどん'
+  config.delimiter = 'ひげ'
+end
+
+NCipher.encode 'にゃんぱす'
+#=> "んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ"
+
+NCipher.decode 'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ'
+#=> "にゃんぱす"
+```
+
 ### Command
 
-```shellsession
-$ n_cipher --help
-Commands:
-  n_cipher decode <STRING>  # N暗号文字列を復号化
-  n_cipher encode <STRING>  # 文字列をN暗号化
-  n_cipher help [COMMAND]   # Describe available commands or one specific command
-  n_cipher version          # Print version
-
-Options:
-  [--seed=SEED]
-                           # Default: にゃんぱす
-  [--delimiter=DELIMITER]
-                           # Default: 〜
+シード値と区切り文字は以下の環境変数でも設定できます
+
+- `NCIPHER_SEED` : シード値
+- `NCIPHER_DELIMITER` : 区切り文字
 
+```shellsession
 $ # encode
 $ n_cipher encode 'にゃんぱす'
 ぱすすにすに〜ぱすすゃぱす〜ぱすすんんに〜ぱすすゃにゃ〜ぱすすににん〜
 $ n_cipher encode --seed 'おうどん' --delimiter 'ひげ' 'にゃんぱす'
 んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ
+```
 
+```
 $ # decode
 $ n_cipher decode --seed 'おうどん' --delimiter 'ひげ' 'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ'
 にゃんぱす
+```
 
+```
 $ # support STDIN
 $ renge | n_cipher encode
 んんぱんにぱに〜ゃぱんぱゃゃん〜ぱすすにぱゃ〜ぱすすゃにぱ〜ぱすすゃすゃ〜すににゃぱに〜ゃんゃんぱゃぱ〜ゃぱゃんんぱぱ〜ぱすすににに〜ぱすすにゃぱ〜ぱすすんんに〜ぱすすにぱす〜すにすんんんゃ〜

data/exe/n_cipher

@@ -5,8 +5,8 @@ require 'thor'
 
 class NCipherCLI < Thor
   map %w(-v --version) => :version
-  class_option :seed, :type => :string, :default => 'にゃんぱす'
-  class_option :delimiter, :type => :string, :default => '〜'
+  class_option :seed, :type => :string
+  class_option :delimiter, :type => :string
 
   sub_commands = {'encode' => ['encode <STRING>', '文字列をN暗号化'],
                   'decode' => ['decode <STRING>', 'N暗号文字列を復号化']}
@@ -16,7 +16,9 @@ class NCipherCLI < Thor
     define_method(command) do |string = nil|
       begin
         string ||= $stdin.read.chomp
-        STDOUT.puts NCipher.send(command, string, seed: options[:seed], delimiter: options[:delimiter])
+        seed = options[:seed] || ENV['NCIPHER_SEED'] || 'にゃんぱす'
+        delimiter = options[:delimiter] || ENV['NCIPHER_DELIMITER'] || '〜'
+        STDOUT.puts NCipher.send(command, string, seed: seed, delimiter: delimiter)
       rescue => e
         STDERR.puts "#{__FILE__}: #{e.message}"
         exit 1

data/lib/n_cipher/version.rb

@@ -1,4 +1,4 @@
 module NCipher
   # バージョン番号
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/lib/n_cipher.rb

@@ -52,29 +52,46 @@ module NCipher
       end
     end
 
-    # 実際の変換処理を行う
+    # 引数チェック
     #
     # @param [Symbol] mode +:encode+もしくは+:decode+を指定
     # @param [String] string 対象文字列
     # @param [String] seed シード値
     # @param [String] delimiter 区切り文字
     #
-    # @return [String] 変換された文字列オブジェクト
+    # @return [true] チェックをパスした場合
     #
     # @raise [ArgumentError]
-    def convert(mode, string, seed, delimiter)
+    def validate_arguments(mode, string, seed, delimiter)
       fail ArgumentError, 'Seed and delimiter are duplicated.' unless (seed.chars & delimiter.chars).size.zero?
       fail ArgumentError, 'Character is duplicated in seed.' unless seed.size == seed.chars.uniq.size
 
+      if mode == :decode
+        fail ArgumentError, 'Delimiter is not include in the cipher string.' unless string.match(delimiter)
+        fail ArgumentError, 'Invalid cipher string.' unless (string.chars - "#{seed}#{delimiter}".chars).size.zero?
+      end
+
+      true
+    end
+
+    # 実際の変換処理を行う
+    #
+    # @param [Symbol] mode +:encode+もしくは+:decode+を指定
+    # @param [String] string 対象文字列
+    # @param [String] seed シード値
+    # @param [String] delimiter 区切り文字
+    #
+    # @return [String] 変換された文字列オブジェクト
+    def convert(mode, string, seed, delimiter)
+      validate_arguments(mode, string, seed, delimiter)
+
       table = convert_table(mode.to_sym, seed)
       rtn = case mode
-        when :encode
-          string.unpack('U*').map {|ele| ele.to_s(seed.size).gsub(/./, table).concat(delimiter) }
-        when :decode
-          fail ArgumentError, 'Delimiter is not include in the cipher string.' unless string.match(delimiter)
-          fail ArgumentError, 'Invalid cipher string.' unless (string.chars - "#{seed}#{delimiter}".chars).size.zero?
-          string.split(delimiter).map {|ele| [ele.gsub(/./, table).to_i(seed.size)].pack('U') }
-        end
+            when :encode
+              string.unpack('U*').map {|ele| ele.to_s(seed.size).gsub(/./, table).concat(delimiter) }
+            when :decode
+              string.split(delimiter).map {|ele| [ele.gsub(/./, table).to_i(seed.size)].pack('U') }
+            end
 
       rtn.join
     end
@@ -98,9 +115,7 @@ module NCipher
     #
     # @return [String] 暗号化された文字列オブジェクト
     #
-    # @raise [ArgumentError]
     # @raise [TypeError]
-    # @raise [RangeError]
     #
     # @see Convert#convert
     def encode(string, seed: @seed, delimiter: @delimiter)
@@ -124,9 +139,7 @@ module NCipher
     #
     # @return [String] 復号化された文字列オブジェクト
     #
-    # @raise [ArgumentError]
     # @raise [TypeError]
-    # @raise [RangeError]
     #
     # @see Convert#convert
     def decode(string, seed: @seed, delimiter: @delimiter)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_cipher
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Masaya Takeda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2015-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler