n_cipher 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6745670732254c4a64708cb93de4303e926b6387
-  data.tar.gz: 1ef6c8752f76ed5899c6ecb88cdca30aa0a79096
+  metadata.gz: 085ee55c1f4188ae5c6cafc2e87a42ccb2e279a7
+  data.tar.gz: e7a842e0cbb49c4d5f068368d71143bee6c81697
 SHA512:
-  metadata.gz: fa2eb75273ba70afaf3874d920a9e63eceb465f44519ee6ead3f459f6347ca4729508429e760f784ad5271c6f0638507927f1411543278fc99da400573a6d19d
-  data.tar.gz: 519123fa2cc902e4d33db79f1e091bdc571a65eb1cac9b58101fa6382b6491efadc85435650aedde35ce8a0dcf9ca671670b37b37da398a0952ffebc1f927642
+  metadata.gz: 9c9b39423522f91c26e530f7f8f8a213441d89bc3746d93e2326299051284b22d7623c46127f4a75e68f176fae1508c7a75fe7db84877f3e12a5515b3065cea3
+  data.tar.gz: 8bc14fe168d59fa92adcdce3b667ee0e7faba59ebe4f61c314bd6415f5550702f3167654479399477265f975d5b1ada095fa491d254a454c50b97e02ddb93033

data/README.md

@@ -5,8 +5,6 @@
 [![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/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)
 
@@ -34,57 +32,15 @@ $ gem install n_cipher
 
 ## Usage
 
-### Library
-
-```ruby
-require 'n_cipher'
-
-NCipher.encode('にゃんぱす', seed: 'おうどん', delimiter: 'ひげ')
-#=> "んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ"
-
-NCipher.decode(
-  'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ',
-  seed: 'おうどん', delimiter: 'ひげ')
-#=> "にゃんぱす"
-```
-
 ```ruby
-# いちいちオプション指定するのが面倒なとき用
 NCipher.configure do |config|
   config.seed = 'おうどん'
   config.delimiter = 'ひげ'
 end
 
 NCipher.encode 'にゃんぱす'
-#=> "んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ"
+#=> "んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどう"
 
-NCipher.decode 'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ'
+NCipher.decode 'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどう'
 #=> "にゃんぱす"
 ```
-
-### Command
-
-シード値と区切り文字は以下の環境変数でも設定できます
-
-- `NCIPHER_SEED` : シード値
-- `NCIPHER_DELIMITER` : 区切り文字
-
-```shellsession
-$ # encode
-$ n_cipher encode 'にゃんぱす'
-ぱすすにすに〜ぱすすゃぱす〜ぱすすんんに〜ぱすすゃにゃ〜ぱすすににん〜
-$ n_cipher encode --seed 'おうどん' --delimiter 'ひげ' 'にゃんぱす'
-んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ
-```
-
-```shellsession
-$ # decode
-$ n_cipher decode --seed 'おうどん' --delimiter 'ひげ' 'んおおうどどんひげんおおどおおんひげんおおどうおんひげんおおうんおうひげんおおううどうひげ'
-にゃんぱす
-```
-
-```shellsession
-$ # support STDIN
-$ renge | n_cipher encode
-んんぱんにぱに〜ゃぱんぱゃゃん〜ぱすすにぱゃ〜ぱすすゃにぱ〜ぱすすゃすゃ〜すににゃぱに〜ゃんゃんぱゃぱ〜ゃぱゃんんぱぱ〜ぱすすににに〜ぱすすにゃぱ〜ぱすすんんに〜ぱすすにぱす〜すにすんんんゃ〜
-```

data/lib/n_cipher/argument_validation.rb

@@ -0,0 +1,83 @@
+module NCipher::ArgumentValidation
+  @@validations = {}
+
+  def self.included(klass)
+    klass.extend(ClassMethod)
+    klass.extend(InheritValidation)
+    Method.send(:include, MonkeyPatchToMethodClass)
+  end
+
+  module MonkeyPatchToMethodClass
+    def validation
+      ::NCipher::ArgumentValidation.validations[owner]["__#{name}__"]
+    end
+  end
+
+  module InheritValidation
+    def inherited(klass)
+      super
+      # 継承先へバリデーションをディープコピー
+      baseclass_validations = ::NCipher::ArgumentValidation.validations[self]
+      ::NCipher::ArgumentValidation.validations[klass] = baseclass_validations.map {|k, v| [k, v.map(&:clone)] }.to_h
+    end
+  end
+
+  module ClassMethod
+    private
+
+    def args_validation(method, message=nil, &validation)
+      exception = ArgumentError.new(message).tap do |ex|
+        # バックトレースの偽装
+        ex.set_backtrace(validation.source_location.push("in `args_validation'").join(':'))
+      end
+
+      ::NCipher::ArgumentValidation.store_validation(self, "__#{method}__", validation, exception)
+
+      unless private_method_defined?("__#{method}__")
+        ::NCipher::ArgumentValidation.around_alias(self, "__#{method}__", method)
+        ::NCipher::ArgumentValidation.define_proxy_method(self, method)
+      end
+
+      self
+    end
+  end
+
+  class << self
+    def store_validation(owner, method_name, validation, exception)
+      @@validations[owner] ||= {}
+      @@validations[owner][method_name] ||= []
+      @@validations[owner][method_name] << {
+        :validation => validation,
+        :exception  => exception
+      }
+    end
+
+    def define_proxy_method(owner, name)
+      owner.class_eval do
+        define_method(name) do |*args, &block|
+          validations = ::NCipher::ArgumentValidation.validations.tap do |hash|
+            break hash.has_key?(self.class) ? hash[self.class] : hash[self.singleton_class]
+          end
+
+          validations["__#{name}__"].each do |pattern|
+            # ブロックをインスタンスのコンテキストで評価
+            raise(pattern[:exception]) unless self.instance_exec(*args, block, &pattern[:validation])
+          end
+
+          __send__("__#{name}__", *args, &block)
+        end
+      end
+    end
+
+    def around_alias(owner, new_name, old_name)
+      owner.class_eval do
+        private(old_name)
+        alias_method new_name, old_name
+      end
+    end
+
+    def validations
+      @@validations
+    end
+  end
+end

data/lib/n_cipher/configuration.rb

@@ -0,0 +1,45 @@
+class NCipher::Configuration
+  include NCipher::ArgumentValidation
+
+  attr_reader :seed
+  attr_accessor :delimiter
+
+  def initialize
+    reset
+  end
+
+  def reset
+    @seed      = 'にゃんぱす'.chars
+    @delimiter = '〜'
+  end
+
+  def seed=(string)
+    @seed = string.chars
+  end
+
+  args_validation :seed=, 'Seed must be 2 to 36 characters.' do |seed|
+    seed.length.between?(2, 36)
+  end
+
+  args_validation :seed=, 'Character is duplicated in seed.' do |seed|
+    seed.length == seed.chars.uniq.length
+  end
+
+  args_validation :seed=, 'Seed and delimiter are duplicated.' do |seed|
+    !seed.include?(@delimiter)
+  end
+
+  args_validation :delimiter=, 'Delimiter and seed are duplicated.' do |delimiter|
+    !@seed.join.include?(delimiter)
+  end
+end
+
+class << NCipher
+  def config
+    @config ||= NCipher::Configuration.new
+  end
+
+  def configure(&block)
+    block.call(config)
+  end
+end

data/lib/n_cipher/version.rb

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

data/lib/n_cipher.rb

@@ -1,154 +1,53 @@
+module NCipher; end
 require 'n_cipher/version'
-
-# ユニコードエスケープシーケンスを用いた簡易的な暗号化及び復号化方式を提供するモジュール
-module NCipher
-  # デフォルト値
-  @seed = 'にゃんぱす'
-  @delimiter = '〜'
-
-  # シード値、区切り文字を設定するためのモジュール
-  module Configuration
-    # @!attribute seed
-    #   シード値
-    # @!attribute delimiter
-    #   区切り文字
-    attr_accessor :seed, :delimiter
-
-    # @example
-    #   NCipher.configure do |config|
-    #     config.seed = 'abc'
-    #     config.delimiter = ','
-    #   end
-    def configure
-      yield self
-    end
+require 'n_cipher/argument_validation'
+require 'n_cipher/configuration'
+
+class << NCipher
+  include NCipher::ArgumentValidation
+
+  def encode(string)
+    string
+      .to_str
+      .unpack('U*')
+      .map {|char| char.to_s(NCipher.config.seed.length) }
+      .map {|char| char.gsub(/./, convert_table(:for => :encode)) }
+      .join(NCipher.config.delimiter)
   end
 
-  # 実際の暗号化、復号化を行うメソッドが定義されているモジュール
-  # @note このモジュール内のメソッドはプライベートクラスメソッドに指定されているため、外部から呼び出すことはできない
-  module Convert
-    # シード値から変換テーブルを構築する
-    #
-    # @example
-    #   convert_table(:encode, 'あいうえお')
-    #   #=> {"0"=>"あ", "1"=>"い", "2"=>"う", "3"=>"え", "4"=>"お"}
-    #
-    #   convert_table(:decode, 'あいうえお')
-    #   #=> {"あ"=>"0", "い"=>"1", "う"=>"2", "え"=>"3", "お"=>"4"}
-    #
-    # @param [Symbol] mode +:encode+もしくは+:decode+を指定
-    # @param [String] seed 元となるシード値
-    #
-    # @return [Hash] 変換テーブル
-    #
-    # @raise [RangeError] シード値が2文字以下、もしくは36文字以上の場合
-    def convert_table(mode, seed)
-      fail RangeError, 'Seed must be 2 to 36 characters.' unless seed.size.between?(2, 36)
-
-      table = [*'0'..'9', *'a'..'z'].zip(seed.chars).reject(&:one?).to_h
-      case mode
-      when :encode then table
-      when :decode then table.invert
-      end
-    end
-
-    # 引数チェック
-    #
-    # @param [Symbol] mode +:encode+もしくは+:decode+を指定
-    # @param [String] string 対象文字列
-    # @param [String] seed シード値
-    # @param [String] delimiter 区切り文字
-    #
-    # @return [true] チェックをパスした場合
-    #
-    # @raise [ArgumentError]
-    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
+  def decode(string)
+    string
+      .to_str
+      .split(NCipher.config.delimiter)
+      .map {|char| char.gsub(/./, convert_table(:for => :decode)) }
+      .map {|char| char.to_i(NCipher.config.seed.length) }
+      .map {|char| [char].pack('U') }
+      .join
+  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)
+  args_validation :encode, "Arguments must be respond to 'to_str' method." do |string|
+    string.respond_to? :to_str
+  end
 
-      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
-              string.split(delimiter).map {|ele| [ele.gsub(/./, table).to_i(seed.size)].pack('U') }
-            end
+  args_validation :decode, "Arguments must be respond to 'to_str' method." do |string|
+    string.respond_to? :to_str
+  end
 
-      rtn.join
-    end
+  args_validation :decode, 'Delimiter is not include in the cipher string.' do |string|
+    string.to_str.match(NCipher.config.delimiter)
   end
 
-  class << self
-    include NCipher::Configuration
-    include NCipher::Convert
+  args_validation :decode, 'Invalid cipher string.' do |string|
+    (string.to_str.chars - "#{NCipher.config.seed.join}#{NCipher.config.delimiter}".chars).size.zero?
+  end
 
-    # 文字列を暗号化
-    #
-    # @note このメソッドは{Convert#convert}のラッパーメソッドである
-    #
-    # @example
-    #   NCipher.encode('abc', seed: 'にゃんぱす', delimiter: '〜')
-    #   #=> "ぱすん〜ぱすぱ〜ぱすす〜"
-    #
-    # @param [#to_str] string 対象文字列
-    # @param [#to_str] seed シード値
-    # @param [#to_str] delimiter 区切り文字
-    #
-    # @return [String] 暗号化された文字列オブジェクト
-    #
-    # @raise [TypeError]
-    #
-    # @see Convert#convert
-    def encode(string, seed: @seed, delimiter: @delimiter)
-      [string, seed, delimiter].each do |obj|
-        fail TypeError, "Arguments must be respond to 'to_str' method." unless obj.respond_to? :to_str
-      end
-      convert(:encode, string.to_str, seed.to_str, delimiter.to_str)
-    end
+  private
 
-    # 文字列を復号化
-    #
-    # @note このメソッドは{Convert#convert}のラッパーメソッドである
-    #
-    # @example
-    #   NCipher.decode('ぱすん〜ぱすぱ〜ぱすす〜', seed: 'にゃんぱす', delimiter: '〜')
-    #   #=> "abc"
-    #
-    # @param [#to_str] string 対象文字列
-    # @param [#to_str] seed シード値
-    # @param [#to_str] delimiter 区切り文字
-    #
-    # @return [String] 復号化された文字列オブジェクト
-    #
-    # @raise [TypeError]
-    #
-    # @see Convert#convert
-    def decode(string, seed: @seed, delimiter: @delimiter)
-      [string, seed, delimiter].each do |obj|
-        fail TypeError, "Arguments must be respond to 'to_str' method." unless obj.respond_to? :to_str
-      end
-      convert(:decode, string.to_str, seed.to_str, delimiter.to_str)
+  def convert_table(param={:for => nil})
+    table = [*'0'..'9', *'a'..'z'].zip(NCipher.config.seed).reject(&:one?).to_h
+    case param[:for]
+    when :encode then table
+    when :decode then table.invert
     end
   end
-
-  private_class_method :convert_table, :convert
 end

data/n_cipher.gemspec

@@ -20,12 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.2.0'
-  spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
-
-  spec.add_dependency 'thor'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: n_cipher
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Masaya Takeda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,25 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 文字列のUnicodeエスケープシーケンスを利用した簡易的な暗号です
 email:
 - 844196@gmail.com
-executables:
-- n_cipher
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -126,8 +111,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/n_cipher
 - lib/n_cipher.rb
+- lib/n_cipher/argument_validation.rb
+- lib/n_cipher/configuration.rb
 - lib/n_cipher/version.rb
 - n_cipher.gemspec
 homepage: https://github.com/844196/n_cipher

data/exe/n_cipher

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'n_cipher'
-require 'thor'
-
-class NCipherCLI < Thor
-  map %w(-v --version) => :version
-  class_option :seed, :type => :string
-  class_option :delimiter, :type => :string
-
-  sub_commands = {'encode' => ['encode <STRING>', '文字列をN暗号化'],
-                  'decode' => ['decode <STRING>', 'N暗号文字列を復号化']}
-
-  sub_commands.each_pair do |command, (synopsis, description)|
-    desc(synopsis, description)
-    define_method(command) do |string = nil|
-      begin
-        string ||= $stdin.read.chomp
-        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
-      end
-    end
-  end
-
-  desc 'version', 'Print version'
-  def version
-    STDOUT.puts NCipher::VERSION
-    exit 0
-  end
-end
-
-NCipherCLI.start