divergence_meter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11401d367f7f29f91db7ec7b2a96629558f66b3e
-  data.tar.gz: 7e9c6d0a2dd47883133ad9656ce475026e85ff76
+  metadata.gz: b90019f6be0496d440450b1b72f805f51ef5d53a
+  data.tar.gz: 5f6e89452d90476fe2d0714864901ccd9252eebb
 SHA512:
-  metadata.gz: e8e3400eb78ef692b6b69d12d38f1260507103a4ba2e7f0afe094eeac2cd061028dd87e869ce66cf37795b54240497ab6a773406eea0d6e08c56177ded3e04d3
-  data.tar.gz: f2051a1fae07242df719f07dff08445001c4f7841b93b42ef20f9b97a13432c97ddcbf058428836b05383d83af8e59544e89fe94461c56cfbe9a3a4fd9ff7529
+  metadata.gz: 28f6fed4c20954814e6ab9ac3ff9b3ece4dcdf335e98aee1a3d61f2d71d6ada22ea1d0bd8bd0b9de2387d93ac540b399905ea4c69fb4a0c700a8741ff5eebc49
+  data.tar.gz: adcfbcd44d170c29896194a9458fc37907830c400aacb73a85f9e8bc651321ce221880507481b1b553128405562a4d29d634aaa4b45193495ed5ae76b9e717aa

data/.rubocop.yml

@@ -1 +1,4 @@
 inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -1,11 +1,15 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-11-09 22:14:15 +0900 using RuboCop version 0.27.0.
+# on 2014-11-15 01:32:52 +0900 using RuboCop version 0.27.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 1
+Lint/HandleExceptions:
+  Enabled: false
+
+# Offense count: 3
 Metrics/AbcSize:
   Max: 33
 
@@ -14,7 +18,11 @@ Metrics/AbcSize:
 Metrics/MethodLength:
   Max: 13
 
-# Offense count: 4
+# Offense count: 5
+Style/AsciiIdentifiers:
+  Enabled: false
+
+# Offense count: 1
 Style/Documentation:
   Enabled: false
 
@@ -23,7 +31,16 @@ Style/Documentation:
 Style/GuardClause:
   Enabled: false
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Enabled: false
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Enabled: false
+
 # Offense count: 2
 Style/RegexpLiteral:
   MaxSlashes: 0
-

data/.tachikoma.yml

@@ -0,0 +1 @@
+strategy: bundler

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+script: CODECLIMATE_REPO_TOKEN=2fa45e86ab64ac5f1e439f0af829c54e5776886e883b3ddbec5996ab3870fee3 bundle exec rake

data/README.md

@@ -1,8 +1,14 @@
 # DivergenceMeter
 
+[![Gem Version](https://badge.fury.io/rb/divergence_meter.svg)](http://badge.fury.io/rb/divergence_meter)
 [![Build Status](https://travis-ci.org/sugamasao/divergence_meter.svg)](https://travis-ci.org/sugamasao/divergence_meter)
+[![Code Climate](https://codeclimate.com/github/sugamasao/divergence_meter/badges/gpa.svg)](https://codeclimate.com/github/sugamasao/divergence_meter)
+[![Test Coverage](https://codeclimate.com/github/sugamasao/divergence_meter/badges/coverage.svg)](https://codeclimate.com/github/sugamasao/divergence_meter)
+[![Inline docs](http://inch-ci.org/github/sugamasao/divergence_meter.svg?branch=master)](http://inch-ci.org/github/sugamasao/divergence_meter)
 
-DivergenceMeter is Levenshtein distance tool and Library.
+DivergenceMeter is Levenshtein distance(レーベンシュタイン距離) tool and Library.
+
+algorithm : http://ja.wikipedia.org/wiki/%E3%83%AC%E3%83%BC%E3%83%99%E3%83%B3%E3%82%B7%E3%83%A5%E3%82%BF%E3%82%A4%E3%83%B3%E8%B7%9D%E9%9B%A2
 
 ## Installation
 
@@ -37,8 +43,10 @@ $ divergence_meter retire hoge
 
 did you mean?
 
+`retare` is typo. `tire retire hoge` is dictionary words.
+
 ```sh
-$ divergence_meter retire tire retare hoge
+$ divergence_meter retare tire retire hoge
 retare
 ```
 
@@ -58,8 +66,8 @@ did you mean?
 ```ruby
 require 'divergence_meter'
 
-puts DivergenceMeter.did_you_mean('retire', %w(tire retare hoge))
-# => hog1
+puts DivergenceMeter.did_you_mean('retare', %w(tire  retire hoge))
+# => retire
 ```
 
 ## Contributing

data/Rakefile

@@ -4,3 +4,8 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+end

data/divergence_meter.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'rubocop', '~> 0.27'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

data/lib/divergence_meter.rb

@@ -1,25 +1,23 @@
 require 'divergence_meter/version'
 require_relative 'divergence_meter/levenshtein_distance'
+require_relative 'divergence_meter/did_you_mean'
 require_relative 'divergence_meter/cli'
 
+# DiveergenceMeter main module
 module DivergenceMeter
   class << self
+    # @param [String] word1 target1
+    # @param [String] word2 target2
+    # @return [Fixnum] Levenshtein Distance
     def distance(word1, word2)
       LevenshteinDistance.run(word1, word2)
     end
 
+    # @param [String] target target
+    # @param [Array<String>] words check words
+    # @return [String] did you mean word
     def did_you_mean(target, words)
-      size = target.size
-
-      Array(words).map { |word|
-        { word: word, distance: distance(target, word) }
-      }.sort { |a, b|
-        if a[:distance] == b[:distance]
-          (size - a[:word].size).abs <=> (size - b[:word].size).abs
-        else
-          a[:distance] <=> b[:distance]
-        end
-      }.first[:word]
+      DidYouMean.new(target, words).run
     end
 
     alias_method :もしかして, :did_you_mean

data/lib/divergence_meter/cli.rb

@@ -1,9 +1,14 @@
 module DivergenceMeter
+  # CLI Option Parser
   class CLI
+    # cli initialize
+    # @param [Array] argv ARGV
     def initialize(argv)
       @argv = argv
     end
 
+    # parse argv
+    # @return [void]
     def parse
       if @argv.include?('-h') || @argv.include?('--help')
         puts usage

data/lib/divergence_meter/did_you_mean.rb

@@ -0,0 +1,44 @@
+require_relative 'levenshtein_distance'
+
+module DivergenceMeter
+  # did you mean?
+  class DidYouMean
+    # initialize
+    # @param [String] target base word
+    # @param [Array] words check words
+    def initialize(target, words)
+      @target = target
+      @words = Array(words)
+    end
+
+    # calculate did you mean?
+    # @return [String] word
+    def run
+      target_size = @target.size
+
+      @words.map do |word|
+        { word: word, distance: LevenshteinDistance.run(@target, word) }
+      end.sort do |a, b|
+        sort_distance(a, b, target_size)
+      end.first[:word]
+    end
+
+    private
+
+    # sort by distance
+    # @param [Hash] a sort object a
+    # @param [Hash] b sort object b
+    # @param [Fixnum] target_size target word string size
+    # @return [Fixnum] sort point
+    def sort_distance(a, b, target_size)
+      a_distance = a[:distance]
+      b_distance = b[:distance]
+
+      if a_distance == b_distance
+        (target_size - a[:word].size).abs <=> (target_size - b[:word].size).abs
+      else
+        a_distance <=> b_distance
+      end
+    end
+  end
+end

data/lib/divergence_meter/levenshtein_distance.rb

@@ -1,9 +1,18 @@
 module DivergenceMeter
+  # algorithm for levenshtein distance class.
   class LevenshteinDistance
+    # calculate levenshetein distance short cut method.
+    # @param [String] word1 word1
+    # @param [String] word2 word2
+    # @return [Fixnum] distance
     def self.run(word1, word2)
       new.run(word1, word2)
     end
 
+    # calculate levenshetein distance
+    # @param [String] word1 word1
+    # @param [String] word2 word2
+    # @return [Fixnum] distance
     def run(word1, word2)
       list = create_list(word1.size, word2.size)
 
@@ -36,6 +45,10 @@ module DivergenceMeter
       list
     end
 
+    # levenshtein distance's cost
+    # @param [String] char1
+    # @param [String] char2
+    # @return [Fixnum] cost
     def cost(char1, char2)
       char1 == char2 ? 0 : 1
     end

data/lib/divergence_meter/version.rb

@@ -1,3 +1,4 @@
 module DivergenceMeter
-  VERSION = '1.0.0'
+  # version
+  VERSION = '1.0.1'
 end

data/spec/divergence_meter/cli_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'divergence_meter/cli'
+
+describe DivergenceMeter::CLI do
+  before do
+    $stdout = File.open(File::NULL, 'w')
+    $stderr = File.open(File::NULL, 'w')
+  end
+  after do
+    $stdout.close unless $stdout.closed?
+    $stdout = STDOUT
+    $stderr.close unless $stderr.closed?
+    $stderr = STDERR
+  end
+
+  describe '#parse' do
+    it 'help' do
+      expect { DivergenceMeter::CLI.new(%w(-h)).parse }.to raise_error(SystemExit)
+      expect { DivergenceMeter::CLI.new(%w(--help)).parse }.to raise_error(SystemExit)
+    end
+
+    it 'version' do
+      expect { DivergenceMeter::CLI.new(%w(-v)).parse }.to raise_error(SystemExit)
+      expect { DivergenceMeter::CLI.new(%w(--version)).parse }.to raise_error(SystemExit)
+    end
+
+    it 'unknown arguments' do
+      expect { DivergenceMeter::CLI.new(%w(hoge)).parse }.to raise_error(SystemExit)
+      expect { DivergenceMeter::CLI.new(%w(--foo)).parse }.to raise_error(SystemExit)
+    end
+
+    it 'normal arguments' do
+      expect { DivergenceMeter::CLI.new(%w(hoge fuga)).parse }.not_to raise_error
+      expect { DivergenceMeter::CLI.new(%w(foo bar baz)).parse }.not_to raise_error
+    end
+  end
+end

data/spec/divergence_meter_spec.rb

@@ -6,7 +6,6 @@ describe DivergenceMeter do
   end
 
   describe '.distance' do
-
     it 'hoge vs hoga' do
       expect(DivergenceMeter.distance('hoge', 'hoga')).to eq(1)
     end
@@ -24,6 +23,9 @@ describe DivergenceMeter do
     it '__send vs [__send__, send]' do
       expect(DivergenceMeter.もしかして(':__send', methods)).to eq(:__send__)
     end
+    it '__send vs [send, __send__](reverse)' do
+      expect(DivergenceMeter.もしかして(':__send', methods.reverse)).to eq(:__send__)
+    end
     it 'tire, retire' do
       expect(DivergenceMeter.もしかして('tire', %w(tire retire))).to eq('tire')
       expect(DivergenceMeter.もしかして('rtire', %w(tire retire))).to eq('tire')

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
 require 'simplecov'
+require 'codeclimate-test-reporter'
 SimpleCov.start
+CodeClimate::TestReporter.start
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'divergence_meter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: divergence_meter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - sugamasao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Levenshtein distance tool and Library. provide Levenshtein distance and
   did you mean keyword.
 email:
@@ -93,6 +121,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".tachikoma.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -102,8 +131,10 @@ files:
 - divergence_meter.gemspec
 - lib/divergence_meter.rb
 - lib/divergence_meter/cli.rb
+- lib/divergence_meter/did_you_mean.rb
 - lib/divergence_meter/levenshtein_distance.rb
 - lib/divergence_meter/version.rb
+- spec/divergence_meter/cli_spec.rb
 - spec/divergence_meter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sugamasao/divergence_meter
@@ -131,5 +162,7 @@ signing_key:
 specification_version: 4
 summary: Levenshtein distance tool and Library.
 test_files:
+- spec/divergence_meter/cli_spec.rb
 - spec/divergence_meter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: