cucumber_analytics 0.0.1

data/lib/cucumber_analytics/world.rb

@@ -0,0 +1,182 @@
+module CucumberAnalytics
+  module World
+
+
+    SANITARY_STRING = '___!!!___'
+    STEP_KEYWORD_PATTERN = '\s*(?:Given|When|Then|And|\*)\s*'
+
+
+    # Returns the left delimiter, which is used to mark the beginning of a step
+    # argument.
+    def self.left_delimiter
+      @left_delimiter || @right_delimiter
+    end
+
+    # Sets the left delimiter that will be used by default when determining
+    # step arguments.
+    def self.left_delimiter=(new_delimiter)
+      @left_delimiter = new_delimiter
+    end
+
+    # Returns the right delimiter, which is used to mark the end of a step
+    # argument.
+    def self.right_delimiter
+      @right_delimiter || @left_delimiter
+    end
+
+    # Sets the right delimiter that will be used by default when determining
+    # step arguments.
+    def self.right_delimiter=(new_delimiter)
+      @right_delimiter = new_delimiter
+    end
+
+    # Loads the step patterns contained in the given file into the World.
+    def self.load_step_file(file_path)
+      @@defined_expressions ||= []
+
+      File.open(file_path, 'r') do |file|
+        file.readlines.each do |line|
+          if step_def_line?(line)
+            the_reg_ex = extract_regular_expression(line)
+            @@defined_expressions << the_reg_ex
+          end
+        end
+      end
+    end
+
+    # Returns the step patterns that have been loaded into the World.
+    def self.defined_step_patterns
+      @@defined_expressions
+    end
+
+    # Returns all tags found in the passed container.
+    def self.tags_in(container)
+      Array.new.tap do |accumulated_tags|
+        collect_tags(accumulated_tags, container)
+      end
+    end
+
+    # Returns all feature files found in the passed container.
+    def self.files_in(container)
+      Array.new.tap do |accumulated_files|
+        collect_files(accumulated_files, container)
+      end
+    end
+
+    # Returns all features found in the passed container.
+    def self.features_in(container)
+      Array.new.tap do |accumulated_features|
+        collect_features(accumulated_features, container)
+      end
+    end
+
+    # Returns all tests found in the passed container.
+    def self.tests_in(container)
+      Array.new.tap do |accumulated_tests|
+        collect_tests(accumulated_tests, container)
+      end
+    end
+
+    # Returns all steps found in the passed container.
+    def self.steps_in(container)
+      Array.new.tap do |accumulated_steps|
+        collect_steps(accumulated_steps, container)
+      end
+    end
+
+    # Returns all undefined steps found in the passed container.
+    def self.undefined_steps_in(container)
+      all_steps = steps_in(container)
+
+      all_steps.select { |step| !World.defined_step_patterns.any? { |pattern| step.base =~ Regexp.new(pattern) } }
+    end
+
+    # Returns all defined steps found in the passed container.
+    def self.defined_steps_in(container)
+      all_steps = steps_in(container)
+
+      all_steps.select { |step| World.defined_step_patterns.any? { |pattern| step.base =~ Regexp.new(pattern) } }
+    end
+
+
+    private
+
+
+    # Make life easier by ensuring that the only forward slashes in the
+    # regular expression are the important ones.
+    def self.sanitize_line(line)
+      line.gsub('\/', SANITARY_STRING)
+    end
+
+    # And be sure to restore the line to its original state.
+    def self.desanitize_line(line)
+      line.gsub(SANITARY_STRING, '\/')
+    end
+
+    # Returns whether or not the passed line is a step pattern.
+    def self.step_def_line?(line)
+      !!(sanitize_line(line) =~ /^#{World::STEP_KEYWORD_PATTERN}\/[^\/]*\//)
+    end
+
+    # Returns the regular expression portion of a step pattern line.
+    def self.extract_regular_expression(line)
+      desanitize_line(sanitize_line(line).match(/^#{World::STEP_KEYWORD_PATTERN}\/([^\/]*)\//)[1])
+    end
+
+    # Recursively gathers all tags found in the passed container.
+    def self.collect_tags(accumulated_tags, container)
+      accumulated_tags.concat container.tags if container.respond_to?(:tags)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_tags(accumulated_tags, child_container)
+        end
+      end
+    end
+
+    # Recursively gathers all feature files found in the passed container.
+    def self.collect_files(accumulated_files, container)
+      accumulated_files.concat container.feature_files if container.respond_to?(:feature_files)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_files(accumulated_files, child_container)
+        end
+      end
+    end
+
+    # Recursively gathers all features found in the passed container.
+    def self.collect_features(accumulated_features, container)
+      accumulated_features << container.feature if container.respond_to?(:feature)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_features(accumulated_features, child_container)
+        end
+      end
+    end
+
+    # Recursively gathers all tests found in the passed container.
+    def self.collect_tests(accumulated_tests, container)
+      accumulated_tests.concat container.tests if container.respond_to?(:tests)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_tests(accumulated_tests, child_container)
+        end
+      end
+    end
+
+    # Recursively gathers all steps found in the passed container.
+    def self.collect_steps(accumulated_steps, container)
+      accumulated_steps.concat container.steps if container.respond_to?(:steps)
+
+      if container.respond_to?(:contains)
+        container.contains.each do |child_container|
+          collect_steps(accumulated_steps, child_container)
+        end
+      end
+    end
+
+  end
+end

data/lib/cucumber_analytics.rb

@@ -0,0 +1,12 @@
+require 'cucumber_analytics/version'
+require 'cucumber_analytics/parsed_file'
+require 'cucumber_analytics/parsed_directory'
+require 'cucumber_analytics/feature_element.rb'
+require 'cucumber_analytics/parsed_feature'
+require 'cucumber_analytics/test_element.rb'
+require 'cucumber_analytics/parsed_background'
+require 'cucumber_analytics/parsed_scenario'
+require 'cucumber_analytics/parsed_scenario_outline'
+require 'cucumber_analytics/outline_example'
+require 'cucumber_analytics/step'
+require 'cucumber_analytics/world'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: cucumber_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Kessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Static analysis of Cucumber tests made easy.
+email:
+- morrow748@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- cucumber_analytics.gemspec
+- features/analysis/feature_collection.feature
+- features/analysis/feature_file_collection.feature
+- features/analysis/step_collection.feature
+- features/analysis/tag_collection.feature
+- features/analysis/test_collection.feature
+- features/analysis/test_comparison.feature
+- features/modeling/background_modeling.feature
+- features/modeling/directory_modeling.feature
+- features/modeling/feature_file_modeling.feature
+- features/modeling/feature_modeling.feature
+- features/modeling/outline_modeling.feature
+- features/modeling/scenario_modeling.feature
+- features/step_definitions/background_steps.rb
+- features/step_definitions/directory_steps.rb
+- features/step_definitions/feature_steps.rb
+- features/step_definitions/file_steps.rb
+- features/step_definitions/outline_steps.rb
+- features/step_definitions/setup_steps.rb
+- features/step_definitions/test_steps.rb
+- features/step_definitions/world_steps.rb
+- features/support/env.rb
+- features/support/transforms.rb
+- lib/cucumber_analytics.rb
+- lib/cucumber_analytics/feature_element.rb
+- lib/cucumber_analytics/outline_example.rb
+- lib/cucumber_analytics/parsed_background.rb
+- lib/cucumber_analytics/parsed_directory.rb
+- lib/cucumber_analytics/parsed_feature.rb
+- lib/cucumber_analytics/parsed_file.rb
+- lib/cucumber_analytics/parsed_scenario.rb
+- lib/cucumber_analytics/parsed_scenario_outline.rb
+- lib/cucumber_analytics/step.rb
+- lib/cucumber_analytics/test_element.rb
+- lib/cucumber_analytics/version.rb
+- lib/cucumber_analytics/world.rb
+homepage: https://github.com/enkessler/cucumber_analytics
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem provides an API to programmatically break down Cucumber feature
+  files so that they can be inspected and analyzed in a straightforward manner.
+test_files:
+- features/analysis/feature_collection.feature
+- features/analysis/feature_file_collection.feature
+- features/analysis/step_collection.feature
+- features/analysis/tag_collection.feature
+- features/analysis/test_collection.feature
+- features/analysis/test_comparison.feature
+- features/modeling/background_modeling.feature
+- features/modeling/directory_modeling.feature
+- features/modeling/feature_file_modeling.feature
+- features/modeling/feature_modeling.feature
+- features/modeling/outline_modeling.feature
+- features/modeling/scenario_modeling.feature
+- features/step_definitions/background_steps.rb
+- features/step_definitions/directory_steps.rb
+- features/step_definitions/feature_steps.rb
+- features/step_definitions/file_steps.rb
+- features/step_definitions/outline_steps.rb
+- features/step_definitions/setup_steps.rb
+- features/step_definitions/test_steps.rb
+- features/step_definitions/world_steps.rb
+- features/support/env.rb
+- features/support/transforms.rb
+has_rdoc: