RubyGems - n_cipher - Versions diffs - 0.3.4 → 0.4.0 - Mend

n_cipher 0.3.4 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80265f86091eec640ccb6b3e661105a67c1cf8d1
-  data.tar.gz: e1010ee33a1b842e8ea787cbb85b80985ed6be0b
+  metadata.gz: ebe26d7992ccd3683a3b01e1419ec107bf9c6d2e
+  data.tar.gz: 3f5dbef08cc12f691a01d2e80bf3506e3725c87a
 SHA512:
-  metadata.gz: 68ebf9aa789276fcbad2bb431f619cc3872e5ce6eceaaa865d1a234b059a9081837463294770509c972ddde4ca38f3ebefb0f3437ef59e3dd22f777ec3583ef2
-  data.tar.gz: f4e86dfdf1161bc516f60479015ca2f1997e355afbe856c63908fa83ff68c970f603ea7824a6442c9ffb1e9aead9a84ad8d798931e239248219e0ac046006b82
+  metadata.gz: 209966720f6bf66f82ef1c583fcfc9154d27a43d7346e321bf3e55a54cc3e62b179d97133967788a17e1bc2f6d2e0b60a0203b6d5d5d5904595b26e59ef1e4f5
+  data.tar.gz: 601afcfbd2a9411af22c825646edba42b48381c586cac13701a7f000fca586a531f0fc52143d120b3a881cad4f1d697c9c25079f9897049b453cb580594aa317

data/README.md CHANGED Viewed

@@ -5,7 +5,8 @@
 [![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)
-[![Issues](http://img.shields.io/github/issues/844196/n_cipher.svg)](https://github.com/844196/n_cipher/issues)
+[![Docunment](https://img.shields.io/badge/doc-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)

data/Rakefile CHANGED Viewed

@@ -1,10 +1,16 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
 task :default => :test
 task :test do
-  ruby("test/test_helper.rb")
+  ruby 'test/test_helper.rb', '--verbose', '--progress-row-max=0'
 end
 RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/bin/console CHANGED Viewed

@@ -1,14 +1,6 @@
 #!/usr/bin/env ruby
-require "bundler/setup"
-require "n_cipher"
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-require "irb"
+require 'bundler/setup'
+require 'n_cipher'
+require 'irb'
 IRB.start

data/lib/n_cipher/version.rb CHANGED Viewed

@@ -1,3 +1,4 @@
 module NCipher
-  VERSION = "0.3.4"
+  # バージョン番号
+  VERSION = '0.4.0'
 end

data/lib/n_cipher.rb CHANGED Viewed

@@ -1,46 +1,123 @@
-require "n_cipher/version"
+require 'n_cipher/version'
+# ユニコードエスケープシーケンスを用いた簡易的な暗号化及び復号化方式を提供するモジュール
 module NCipher
-  module Helper
-    def convert_table(string, mode)
-      table = [*'0'..'9', *'a'..'z'].zip(string.chars).reject(&:one?).to_h
+  # デフォルト値
+  @seed = 'にゃんぱす'
+  @delimiter = '〜'
+  # 実際の暗号化、復号化を行うメソッドが定義されているモジュール
+  # @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
-    def common_argument_check(string, seed, delimiter)
-      [string, seed, delimiter].each do |obj|
-        raise TypeError, "#{obj} is #{obj.class} object. Argument must be string object." unless obj.kind_of?(String)
-        raise ArgumentError, 'Invalid argument.' if obj.empty?
-      end
-      raise ArgumentError, 'Seed must be 2 to 36 characters.' unless seed.size.between?(2, 36)
-      raise ArgumentError, 'Seed and delimiter are duplicated.' unless (seed.chars & delimiter.chars).size.zero?
-      # シード値が重複していないか？
-      #   OK: 'あいう'
-      #   NG: 'ああい'（「あ」が重複）
-      raise ArgumentError, 'Character is duplicated in seed.' unless seed.size == seed.chars.uniq.size
+    # 実際の変換処理を行う
+    #
+    # @param [Symbol] mode +:encode+もしくは+:decode+を指定
+    # @param [String] string 対象文字列
+    # @param [String] seed シード値
+    # @param [String] delimiter 区切り文字
+    #
+    # @return [String] 変換された文字列オブジェクト
+    #
+    # @raise [ArgumentError]
+    def convert(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
+      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
+      rtn.join
     end
   end
   class << self
-    include NCipher::Helper
+    attr_accessor :seed, :delimiter
+    include NCipher::Convert
-    def encode(string, seed: 'にゃんぱす', delimiter: '〜')
-      common_argument_check(string, seed, delimiter)
-      string.unpack('U*').map {|c| c.to_s(seed.size).gsub(/./, convert_table(seed, :encode)).concat(delimiter) }.join
+    # 文字列を暗号化
+    #
+    # @note このメソッドは{Convert#convert}のラッパーメソッドである
+    #
+    # @example
+    #   NCipher.encode('abc', seed: 'にゃんぱす', delimiter: '〜')
+    #   #=> "ぱすん〜ぱすぱ〜ぱすす〜"
+    #
+    # @param [#to_str] string 対象文字列
+    # @param [#to_str] seed シード値
+    # @param [#to_str] delimiter 区切り文字
+    #
+    # @return [String] 暗号化された文字列オブジェクト
+    #
+    # @raise [ArgumentError]
+    # @raise [TypeError]
+    # @raise [RangeError]
+    #
+    # @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
-    def decode(string, seed: , delimiter: )
-      common_argument_check(string, seed, delimiter)
-      raise ArgumentError, 'Delimiter is not include in the cipher string.' unless string.match(delimiter)
-      raise ArgumentError, 'Invalid cipher string.' unless (string.chars - "#{seed}#{delimiter}".chars).size.zero?
-      string.split(delimiter).map {|ele| [ele.gsub(/./, convert_table(seed, :decode)).to_i(seed.size)].pack('U') }.join
+    # 文字列を復号化
+    #
+    # @note このメソッドは{Convert#convert}のラッパーメソッドである
+    #
+    # @example
+    #   NCipher.decode('ぱすん〜ぱすぱ〜ぱすす〜', seed: 'にゃんぱす', delimiter: '〜')
+    #   #=> "abc"
+    #
+    # @param [#to_str] string 対象文字列
+    # @param [#to_str] seed シード値
+    # @param [#to_str] delimiter 区切り文字
+    #
+    # @return [String] 復号化された文字列オブジェクト
+    #
+    # @raise [ArgumentError]
+    # @raise [TypeError]
+    # @raise [RangeError]
+    #
+    # @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)
     end
   end
-  private_class_method :convert_table, :common_argument_check
+  private_class_method :convert_table, :convert
 end

data/n_cipher.gemspec CHANGED Viewed

@@ -4,27 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'n_cipher/version'
 Gem::Specification.new do |spec|
-  spec.name          = "n_cipher"
+  spec.name          = 'n_cipher'
   spec.version       = NCipher::VERSION
-  spec.authors       = ["Masaya Takeda"]
-  spec.email         = ["844196@gmail.com"]
+  spec.authors       = ['Masaya Takeda']
+  spec.email         = ['844196@gmail.com']
-  spec.summary       = %q{ぱすすにすに〜ぱすすゃぱす〜ぱすすんんに〜ぱすすゃにゃ〜ぱすすににん〜ぱすぱんぱゃ}
-  spec.description   = %q{文字列のUnicodeエスケープシーケンスを利用した簡易的な暗号です}
-  spec.homepage      = "https://github.com/844196/n_cipher"
-  spec.license       = "MIT"
+  spec.summary       = 'ぱすすにすに〜ぱすすゃぱす〜ぱすすんんに〜ぱすすゃにゃ〜ぱすすににん〜ぱすぱんぱゃ'
+  spec.description   = '文字列のUnicodeエスケープシーケンスを利用した簡易的な暗号です'
+  spec.homepage      = 'https://github.com/844196/n_cipher'
+  spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.1.0'
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "test-unit"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
-  spec.add_dependency "thor"
+  spec.add_dependency 'thor'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: n_cipher
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Masaya Takeda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -141,3 +155,4 @@ signing_key:
 specification_version: 4
 summary: ぱすすにすに〜ぱすすゃぱす〜ぱすすんんに〜ぱすすゃにゃ〜ぱすすににん〜ぱすぱんぱゃ
 test_files: []
+has_rdoc: