synt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d7b75a92d1cd6cc21cfc17b54babed054b65fa1
-  data.tar.gz: 942b65488bf1e539c4c9c70c433e7a53faa4c7ef
+  metadata.gz: db6a29021a6d20069699409309b0d876e895cfe6
+  data.tar.gz: 2917519bf768b6f16d51eab71811716f7aef5297
 SHA512:
-  metadata.gz: aa07f696d7888077c36bbfbc398385a8a50b7065db536419742fa8d44249a594654660a8d2910403b6fa39c65d092573a3395f47d57d1c3a0454b8ac8dbd910d
-  data.tar.gz: 852a28d465c22c2dadcb06a289011000109ff3c118d936efe8e3a9ff0b1b65b74394ff3a3279f9c0d5fef3063f5e9b865186bfd51d90fd146fd6f48de48bb582
+  metadata.gz: 616a83ae7baf88e13f25c1fd11677e3cad5781808029e560a2e3d0808bb570cd4aaf531908331d8a0b50a1bf2b47a4cfc6b57854685aafb928facef93b37a8e0
+  data.tar.gz: e7d885f8d603edbb1e93def360a851537ff6ebd9075a1bd0ff5eed613890340401b2ece433119acdda8a52bdbbc79a585ebbd9cd8fc04e8327094d6681d14297

data/.rubocop.yml

@@ -2,3 +2,23 @@ Style/Documentation:
   Enabled: false
 Style/Encoding:
   Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Blocks:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 18
+Metrics/CyclomaticComplexity:
+  Max: 7
+Style/FileName:
+  Enabled: false
+Style/WordArray:
+  MinSize: 2

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'slop', '3.6.0'
 gem 'manowar', '0.0.1'
-gem 'rubocop', '0.25.0', require: false
-gem 'simplecov', '0.9.0', require: false
-gem 'simplecov-lcov', require: false
+gem 'rspec', '3.0.0', require: false, group: :development
+gem 'rubocop', '0.25.0', require: false, group: :development
+gem 'simplecov', '0.9.0', require: false, group: :development
+gem 'simplecov-lcov', require: false, group: :development

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.0.0)
+    diff-lcs (1.2.5)
     docile (1.1.5)
     manowar (0.0.1)
     multi_json (1.10.1)
@@ -10,6 +11,18 @@ GEM
       slop (~> 3.4, >= 3.4.5)
     powerpack (0.0.9)
     rainbow (2.0.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
     rubocop (0.25.0)
       parser (>= 2.2.0.pre.4, < 3.0)
       powerpack (~> 0.0.6)
@@ -29,6 +42,7 @@ PLATFORMS
 
 DEPENDENCIES
   manowar (= 0.0.1)
+  rspec (= 3.0.0)
   rubocop (= 0.25.0)
   simplecov (= 0.9.0)
   simplecov-lcov

data/bin/lint

@@ -1,2 +1,2 @@
 #!/usr/bin/env sh
-bundle exec rubocop . -f e
+bundle exec rubocop lib spec -f e

data/bin/synt

@@ -1,14 +1,3 @@
 #!/usr/bin/env ruby
-
-if ENV.has_key? 'TEST_COV'
-  require 'simplecov'
-  require 'simplecov-lcov'
-  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
-  SimpleCov.start do
-    add_filter "/fixtures/"
-  end
-end
-
 require_relative '../lib/synt'
-
 Synt.new

data/bin/test

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+bundle exec rspec -f p -c

data/bin/test-cov

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+rm -rf coverage/
+TEST_COV=true bin/test

data/lib/synt/cli.rb

@@ -8,27 +8,26 @@ module Synt::CLI
   extend self
 
   def parse
-    Slop.parse help: true, &options
+    Slop.parse help: true, &API
   end
 
   private
 
-  def options
-    Proc.new {
-      banner 'Usage: synt.rb [options]'
+  API = proc {
+    banner 'Usage: synt.rb [options]'
 
-      on 't=', 'tokenize=', 'file or string to tokenize'
-      on 'c=', 'compare=', 'File or String to compare to something.'
-      on 't=', 'to=', 'File or String to compare against.'
-      on 'a=', 'algorithm=', 'Similarity algorithm [default=jaccard,tanimoto].'
-      on 'n=', 'ngram=', 'Specify what ngrams are generated and used for
-                         comparing token sequences. [default=1,2,4..5,10,...,all]'
-      on 'd=', 'threshold=', 'Similarity threshold and exit with error.'
+    on 't=', 'tokenize=', 'file or string to tokenize'
+    on 'c=', 'compare=', 'File or String to compare to something.'
+    on 't=', 'to=', 'File or String to compare against.'
+    on 'a=', 'algorithm=', 'Similarity algorithm [default=jaccard,tanimoto].'
+    on 'n=', 'ngram=', 'Specify what ngrams are generated and used for
+                       comparing token sequences.
+                       [default=1,2,4..5,10,...,all]'
+    on 'd=', 'threshold=', 'Similarity threshold and exit with error.'
 
-      on '-v', 'version', 'Print the version.' do
-        puts Synt::VERSION
-        exit 0
-      end
-    }
-  end
+    on '-v', 'version', 'Print the version.' do
+      puts Synt::VERSION
+      exit 0
+    end
+  }
 end

data/lib/synt/similar.rb

@@ -9,15 +9,13 @@ module Synt::Similar
   extend self
 
   def compare opts
-    error 'no compare propery provided' if !opts[:compare]
-    error 'no to propery provided' if !opts[:to]
+    error 'no compare propery provided' unless opts[:compare]
+    error 'no to propery provided' unless opts[:to]
 
     src = opts[:compare] || ''
     cmp = opts[:to] || ''
-    algorithm = algorithms[opts[:algorithm] || 'jaccard']
-    src_t = cmp_t = nil
+    algorithm = algorithms[(opts[:algorithm] || 'jaccard').to_sym]
     n_start, n_end = ngram_range opts[:ngram]
-
     src_t = normalize_ripper_tokens Synt::Parser.parse(src)
     cmp_t = normalize_ripper_tokens Synt::Parser.parse(cmp)
 
@@ -32,29 +30,26 @@ module Synt::Similar
   private
 
   def algorithms
-    { 'jaccard' => Jaccard, 'tanimoto' => Tanimoto }
+    { jaccard: Jaccard, tanimoto: Tanimoto }
   end
 
   def generate_ngrams arr, start, nend
-    nend = arr.length if nend.nil?
-    start = 1 if start.nil?
+    nend = arr.length unless nend
+    start = 1 unless start
 
     if nend > arr.length
-      puts 'ngram end value exceeds length- setting start/end to: 1.'
+      start = nend = 1
+      puts 'ngram end value exceeds max length- setting start/end to: 1'
     end
 
-    if start == nend && start == 1 # short circuit
-      return arr
-    end
+    return arr if start == nend && start == 1 # short circuit
 
     sets = []
 
     (start..nend).to_a.each_index do |n_len|
-      arr.each_with_index do |token, index|
+      arr.each_index do |index|
         s_len = index + n_len
-        if s_len <= arr.length
-          sets.push arr[index, s_len].join('')
-        end
+        sets.push arr[index, s_len].join('') if s_len <= arr.length
       end
     end
 

data/lib/synt/version.rb

@@ -1,3 +1,3 @@
 module Synt
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/readme.md

@@ -10,8 +10,16 @@ This is the Ruby implementation of Synt.
 
 For more languages, see the top level [Synt](http://github.com/brentlintner/synt) project.
 
-### Requirements
+### Installation
 
-* Ruby
-* RubyGems
-* Bundler
+    gem install synt
+
+### Usage
+
+    synt -h
+
+### Using In Code
+
+This is a TODO. :-)
+
+In the meantime, please figure out at your own risk, or use the top level project.

data/spec/fixtures/compare-rb-dissimilar-a.rb

@@ -0,0 +1,7 @@
+def bar
+  a = lambda {
+    print 'hey!'
+  }
+
+  a.call
+end

data/spec/fixtures/compare-rb-dissimilar-b.rb

@@ -0,0 +1,11 @@
+def foo
+  a = [1, 2, 3]
+
+  puts a.sum
+
+  if a.length > 3
+    puts 'narf'
+  else
+    puts 'mer'
+  end
+end

data/spec/fixtures/compare-rb-duplicate.rb

@@ -0,0 +1,3 @@
+def foo(a, b)
+  a * b + (a / b)
+end

data/spec/fixtures/compare-rb-similar-a.rb

@@ -0,0 +1,10 @@
+def foo
+  a = 'one'
+  b = 'two'
+
+  [1, 2].each do |i|
+    puts i
+  end
+
+  a + b
+end

data/spec/fixtures/compare-rb-similar-b.rb

@@ -0,0 +1,10 @@
+def foo
+  one = 'one'
+  two = 'two'
+
+  [1, 2].each do |num|
+    puts num
+  end
+
+  one + two
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+if ENV.key? 'TEST_COV'
+  require 'simplecov'
+  require 'simplecov-lcov'
+
+  SimpleCov::Formatter::LcovFormatter.report_with_single_file = true
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::LcovFormatter,
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+
+  SimpleCov.start do
+    add_filter "/fixtures/"
+  end
+end
+
+def file_to_s path
+  IO.readlines(path).join
+end

data/spec/synt_spec.rb

@@ -0,0 +1,63 @@
+require_relative './spec_helper'
+require_relative './../lib/synt/similar'
+
+describe Synt::Similar do
+  subject { Synt::Similar }
+
+  algorithms = ['jaccard', 'tanimoto']
+  ngram_types = [1, '1..3', 'all']
+
+  let(:duplicate_path) { 'spec/fixtures/compare-rb-duplicate.rb' }
+  let(:similar_a_path) { 'spec/fixtures/compare-rb-similar-a.rb' }
+  let(:similar_b_path) { 'spec/fixtures/compare-rb-similar-b.rb' }
+  let(:dissimilar_a_path) { 'spec/fixtures/compare-rb-dissimilar-a.rb' }
+  let(:dissimilar_b_path) { 'spec/fixtures/compare-rb-dissimilar-b.rb' }
+
+  context 'duplicate code comparison' do
+    let(:dupe) { file_to_s duplicate_path }
+
+    algorithms.each do |algorithm|
+      context "using the #{algorithm} algorithm" do
+        ngram_types.each do |ngram|
+          context "with an ngram of #{ngram}" do
+            it 'is 100%' do
+              sim = subject.compare compare: dupe, to: dupe,
+                                    ngram: ngram, algorithm: algorithm
+              expect(sim).to eq 100
+            end
+          end
+        end
+      end
+    end
+  end
+
+  context 'similar code comparison' do
+    let(:sim_a) { file_to_s similar_a_path }
+    let(:sim_b) { file_to_s similar_b_path }
+
+    algorithms.each do |algorithm|
+      context "using the #{algorithm} algorithm" do
+        it 'is ~81%' do
+          sim = subject.compare compare: sim_a, to: sim_b,
+                                algorithm: algorithm
+          expect(80..82).to cover(sim)
+        end
+      end
+    end
+  end
+
+  context 'dissimilar code comparison' do
+    let(:dissim_a) { file_to_s dissimilar_a_path }
+    let(:dissim_b) { file_to_s dissimilar_b_path }
+
+    algorithms.each do |algorithm|
+      context "using the #{algorithm} algorithm" do
+        it 'is ~22%' do
+          sim = subject.compare compare: dissim_a, to: dissim_b,
+                                algorithm: algorithm
+          expect(21..23).to cover(sim)
+        end
+      end
+    end
+  end
+end

data/synt.gemspec

@@ -10,14 +10,15 @@ Gem::Specification.new do |spec|
   spec.email         = ["brent.lintner@gmail.com"]
   spec.summary       = "Similar code analysis."
   spec.description   = "Calculate the percentage of difference between code."
-  spec.homepage      = "https://github.com/brentlintner/synt/tree/ruby"
+  spec.homepage      = "https://github.com/brentlintner/synt"
   spec.license       = "ISC"
 
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = ["synt"]
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9'
   spec.add_runtime_dependency 'manowar', '0.0.1'
   spec.add_runtime_dependency 'slop', '3.6.0'
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brent Lintner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manowar
@@ -65,6 +65,8 @@ files:
 - Gemfile.lock
 - bin/lint
 - bin/synt
+- bin/test
+- bin/test-cov
 - lib/synt.rb
 - lib/synt/cli.rb
 - lib/synt/parser.rb
@@ -73,9 +75,15 @@ files:
 - lib/synt/similar/tanimoto.rb
 - lib/synt/version.rb
 - readme.md
-- spec/synt.spec
+- spec/fixtures/compare-rb-dissimilar-a.rb
+- spec/fixtures/compare-rb-dissimilar-b.rb
+- spec/fixtures/compare-rb-duplicate.rb
+- spec/fixtures/compare-rb-similar-a.rb
+- spec/fixtures/compare-rb-similar-b.rb
+- spec/spec_helper.rb
+- spec/synt_spec.rb
 - synt.gemspec
-homepage: https://github.com/brentlintner/synt/tree/ruby
+homepage: https://github.com/brentlintner/synt
 licenses:
 - ISC
 metadata: {}
@@ -87,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -100,4 +108,10 @@ signing_key:
 specification_version: 4
 summary: Similar code analysis.
 test_files:
-- spec/synt.spec
+- spec/fixtures/compare-rb-dissimilar-a.rb
+- spec/fixtures/compare-rb-dissimilar-b.rb
+- spec/fixtures/compare-rb-duplicate.rb
+- spec/fixtures/compare-rb-similar-a.rb
+- spec/fixtures/compare-rb-similar-b.rb
+- spec/spec_helper.rb
+- spec/synt_spec.rb

data/spec/synt.spec

@@ -1 +0,0 @@
-# TODO