fuzzy_gherkin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b493153f4f8988dc261ffdd67ee06b687ec74c5
+  data.tar.gz: f33185b1c79b31eafabd0c9e4bc568ed8bcee092
+SHA512:
+  metadata.gz: a9ed55ce72124339a3145a870af5251dcb1161f74063c49c52a9a893ebe32f3f558b094455c01e542a9b7e61e4295ee0be89db8301ebc3c00d3851d0d73537f2
+  data.tar.gz: 5dc6a80d2f7662c4e9d54c6678307f754908284ce3d68737a4da58039562d98384f68bc54de22838f727ba323c22156b6936ee0d89ca7f0c2449d6db7293ab8b

data/.gitignore

@@ -0,0 +1,112 @@
+
+# Created by https://www.gitignore.io/api/ruby,rubymine
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/dictionaries
+.idea/vcs.xml
+.idea/jsLibraryMappings.xml
+
+# Sensitive or high-churn files:
+.idea/dataSources.ids
+.idea/dataSources.xml
+.idea/dataSources.local.xml
+.idea/sqlDataSources.xml
+.idea/dynamic.xml
+.idea/uiDesigner.xml
+
+# Gradle:
+.idea/gradle.xml
+.idea/libraries
+
+# Mongo Explorer plugin:
+.idea/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml 
+# *.ipr
+
+results.json
+config.yml

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-11 10:13:54 -0400 using RuboCop version 0.42.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.
+AllCops:
+  Exclude: 
+    - 'fuzzy_gherkin.gemspec' 
+    - 'lib/fuzzy_gherkin/version.rb'
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 150

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fuzzy_gherkin.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    fuzzy_gherkin (0.1.0)
+      fuzzy-string-match (~> 0.9.7)
+      gherkin (~> 4.0)
+      json (~> 2.0, >= 2.0.2)
+      pry (~> 0.10.4)
+      thor (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    RubyInline (3.12.4)
+      ZenTest (~> 4.3)
+    ZenTest (4.11.1)
+    coderay (1.1.1)
+    fuzzy-string-match (0.9.7)
+      RubyInline (>= 3.8.6)
+    gherkin (4.0.0)
+    json (2.0.2)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  fuzzy_gherkin!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Stalter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# FuzzyGherkin
+
+Fuzzy Matching Gherkin steps to show where potential similarities may exist and where code can be refactored or combined. *WIP*
+
+## Installation
+
+```ruby
+gem install fuzzy_gherkin
+```
+
+## Usage
+
+The gem is a command line app that will search for your feature files in the directory you run the command in. 
+The output will be spit into a json file sorted by similarity %s. 
+
+The compare command is broken into two parts, the base step and the threshold. Threshold will default to 0.80.
+
+```ruby 
+fuzzy_gherkin compare "Step you want to compare against", 0.85
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/u/distortia. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/fuzzy_gherkin

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "fuzzy_gherkin"
+
+FuzzyGherkin::Main.start(ARGV)

data/fuzzy_gherkin.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy_gherkin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fuzzy_gherkin'
+  spec.version       = FuzzyGherkin::VERSION
+  spec.authors       = ['Nick Stalter']
+  spec.email         = ['nickstalter@gmail.com']
+
+  spec.summary       = %q({Fuzzy Matching Gherkin steps})
+  spec.description   = %q({Fuzzy Matching Gherkin steps to show where potential similarities may exist and where code can be refactored or combined.})
+  spec.homepage      = 'https://gitlab.com/distortia/fuzzy_gherkin'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fuzzy-string-match', '~> 0.9.7'
+  spec.add_dependency 'pry', '~> 0.10.4'
+  spec.add_dependency 'gherkin', '~> 4.0'
+  spec.add_dependency 'json', '~> 2.0', '>= 2.0.2'
+  spec.add_dependency 'thor', "~> 0"
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+end

data/lib/fuzzy_gherkin.rb

@@ -0,0 +1,26 @@
+require 'fuzzy_gherkin/version'
+require 'fuzzystringmatch'
+require 'gherkin/parser'
+require 'gherkin/pickles/compiler'
+require 'fuzzy_gherkin/comparitor'
+require 'fuzzy_gherkin/io'
+require 'json'
+require 'pry'
+require 'thor'
+
+module FuzzyGherkin
+  # Main Class to keep everything in for the time being
+  class Main < Thor
+  
+    include FuzzyStringMatch
+    include Gherkin
+
+    desc "compare 'step', (0.00 to 1.00)[optional]", "Compares the step given to the other steps in all feature files"
+    def compare(base_step = 'I press the latte button', threshold = 0.80)
+      comparitor = Comparitor.new(base_step, threshold)
+      comparitor.compare_all_steps_in_files
+      io = IO.new(comparitor.base_step, comparitor.similar_steps)
+      io.write_results
+    end
+  end
+end

data/lib/fuzzy_gherkin/comparitor.rb

@@ -0,0 +1,60 @@
+module FuzzyGherkin
+    class Comparitor
+
+        attr_accessor :threshold, :fsm, :similar_steps, :base_step, :all_steps
+
+        def initialize(base_step, threshold)
+          @threshold = threshold.to_f
+          @similar_steps = []
+          @base_step = base_step
+          @all_steps = []
+          @fsm = FuzzyStringMatch::JaroWinkler.create(:pure)
+        end
+
+        def all_feature_files
+          Dir['**/*.feature']
+        end
+
+        def all_steps_in_files
+            all_steps = []
+            all_feature_files.each do |file|
+                scenarios = parse_feature_file(file)
+                scenarios.each do |scenario|
+                    all_steps << scenario[:steps].map! { |step| step[:text] }
+                end
+            end
+            all_steps.flatten.uniq
+        end
+
+        def compare_all_steps_in_files
+            start_time = Time.now
+            all_steps_in_files.each do |step|
+                compare_step_to_base_step(step)
+            end
+            end_time = Time.now
+            puts "Comparison ended after #{end_time - start_time} seconds!"
+        end
+
+        # Returns background and sceanrios in feature file
+        def parse_feature_file(feature_file)
+            parser = Gherkin::Parser.new
+            raise "FAILURE: File not found at #{feature_path}" unless File.file?(feature_file)
+            gherkin_document = parser.parse(File.read(feature_file))
+            gherkin_document[:feature][:children]
+        end
+
+        # Compares the given step to the base step
+        def compare_step_to_base_step(comparing_step)
+            puts "Comparing base step to: '#{comparing_step}'"
+            distance = @fsm.getDistance(@base_step, comparing_step)
+            puts "distance: #{distance}"
+            # 1.0 is a perfect match.
+            # This means its a repeated step and we can ignore.
+            if distance >= @threshold && distance != 1.0
+                @similar_steps << "#{(distance * 100).round(2)}% - " + comparing_step
+            else
+                distance
+            end
+        end
+    end
+end

data/lib/fuzzy_gherkin/example.feature

@@ -0,0 +1,15 @@
+Feature: Serve coffee
+
+  Background: 
+    Given I want some coffee
+    And the office has some in stock
+
+  Scenario: Making espresso  
+    When I press the espresso button
+    And I press the brew coffee button
+    Then espresso should be brewing
+
+  Scenario: Making Coffee
+    When I press the coffee button
+    And I press the brew button
+    Then coffee should be brewing

data/lib/fuzzy_gherkin/example2.feature

@@ -0,0 +1,13 @@
+Feature: Stock coffee
+
+  Background:
+    Given we are out of coffee
+    And the staff is getting upset
+
+  Scenario: Restock the coffee supply
+    And I restock the coffee
+    Then the staff is happy
+
+  Scenario: Catastrophic Failure
+    And we are out of coffee
+    Then there is a revolt

data/lib/fuzzy_gherkin/io.rb

@@ -0,0 +1,31 @@
+module FuzzyGherkin
+    class IO 
+        # {
+        #   "base-step" : [
+        #     "first.feature" : [
+        #       "matching % - step that matches base"
+        #     ],
+        #     "second.feature" : [
+        #       "matching % - step that matches base"
+        #     ]
+        #   ]
+        # }
+
+        def initialize(base_step, similar_steps)
+            @base_step = base_step
+            @similar_steps = similar_steps
+        end
+
+        def format_similar_steps_hash
+          { @base_step => @similar_steps.uniq.sort.reverse }
+        end
+
+        def write_results
+          file_name = 'results.json'
+          f = File.new(file_name, 'w+')
+          f.write(JSON.pretty_generate(format_similar_steps_hash))
+          f.close
+          puts "Writing results to file: #{file_name}"
+        end
+    end
+end

data/lib/fuzzy_gherkin/version.rb

@@ -0,0 +1,3 @@
+module FuzzyGherkin
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy_gherkin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Stalter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fuzzy-string-match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: gherkin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "{Fuzzy Matching Gherkin steps to show where potential similarities may
+  exist and where code can be refactored or combined.}"
+email:
+- nickstalter@gmail.com
+executables:
+- fuzzy_gherkin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fuzzy_gherkin
+- fuzzy_gherkin.gemspec
+- lib/fuzzy_gherkin.rb
+- lib/fuzzy_gherkin/comparitor.rb
+- lib/fuzzy_gherkin/example.feature
+- lib/fuzzy_gherkin/example2.feature
+- lib/fuzzy_gherkin/io.rb
+- lib/fuzzy_gherkin/version.rb
+homepage: https://gitlab.com/distortia/fuzzy_gherkin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: "{Fuzzy Matching Gherkin steps}"
+test_files: []