spreewald 1.5.5 → 1.6.0

data/Rakefile

@@ -7,15 +7,15 @@ task :default => 'all:rubies'
 desc 'Update the "Steps" section of the README'
 task :update_readme do
   if Kernel.respond_to? :require_relative
-    require_relative './support/documentation_generator'
+    require_relative './support/step_manager'
   else
-    require 'support/documentation_generator'
+    require 'support/step_manager'
   end
 
   readme = File.read('README.md')
   start_of_steps_section = readme =~ /^## Steps/
   length_of_steps_section = (readme[(start_of_steps_section+1)..-1] =~ /^##[^#]/) || readme.size - start_of_steps_section
-  readme[start_of_steps_section, length_of_steps_section] = "## Steps\n\n" + DocumentationGenerator::StepDefinitionsDirectory.new('lib/spreewald').format
+  readme[start_of_steps_section, length_of_steps_section] = "## Steps\n\n" + StepManager.new('lib/spreewald').to_markdown
   File.open('README.md', 'w') { |f| f.write(readme) }
 end
 

data/bin/spreewald

@@ -1,31 +1,72 @@
 #!/usr/bin/env ruby
-require File.expand_path('../../support/documentation_generator', __FILE__)
+require File.expand_path('../../support/step_manager', __FILE__)
+require File.expand_path('../../support/paths_manager', __FILE__)
 
-ORDERED_KINDS = %w[Given When Then]
-heading = 'All Spreewald steps'
-search_string = ARGV.shift
+def announce(text)
+  puts "\e[4;34m\n# #{text}\e[0m" # blue underline
+end
 
-# collect
-steps_glob = File.expand_path('../../lib/spreewald/*_steps.rb', __FILE__)
-step_names = `cat #{steps_glob}`.split($/).select { |line| line =~ /^\s*(Given|When|Then)/ }
+case (option = ARGV.shift)
+when '--selectors', '-s'
+  search = ARGV.join(' ')
+  manager = PathsManager.new('features/support/selectors.rb')
 
-# format
-step_names.map! do |step|
-  DocumentationGenerator::StepDefinition.try_and_parse(step).format_definition
-end
+  heading = 'All selectors from features/support/selectors.rb'
+  heading << " containing '#{search}'" if search
 
-# sort
-step_names = step_names.sort_by do |step|
-  step =~ /^(\w+)(.*)/
-  [ORDERED_KINDS.index($1), $2]
-end
+  announce heading
+  puts manager.paths(search)
+
+when '--paths', '-p'
+  search = ARGV.join(' ')
+  manager = PathsManager.new('features/support/paths.rb')
+
+  heading = 'All paths from features/support/paths.rb'
+  heading << " containing '#{search}'" if search
+
+  announce heading
+  puts manager.paths(search)
+
+when '--help', '-h'
+
+  puts <<-HELP
+USAGE:
+  spreewald [SEARCH]
+    List all Spreewald steps + all steps from the current project (run from
+    project root). Optionally filtered by SEARCH.
+
+  spreewald --paths [SEARCH]
+    List all paths from features/support/paths.rb, optionally filtered by SEARCH
+    Alias -p
+
+  spreewald --selectors [SEARCH]
+    List all paths from features/support/paths.rb, optionally filtered by SEARCH
+    Alias -s
+
+  spreewald --version
+    Print Spreewald's version and exit
+    Alias -v
+
+  spreewald --help
+    Print this help and exit
+    Alias -h
+
+  HELP
+
+when '--version', '-v'
+  require File.expand_path('../../lib/spreewald_support/version', __FILE__)
+  puts "Spreewald #{ Spreewald::VERSION }"
+
+else
+  search = [option].concat(ARGV).join(' ')
+  spreewald_steps = File.expand_path('../../lib/spreewald', __FILE__)
+  project_steps = 'features/step_definitions'
+  manager = StepManager.new(spreewald_steps, project_steps)
+
+  heading = 'All Spreewald steps'
+  heading << " containing '#{search}'" if search
 
-# filter
-if search_string
-  heading << " containing '#{search_string}'"
-  step_names = step_names.grep Regexp.new(search_string)
+  announce heading
+  puts manager.steps(search).map(&:to_s)
 end
 
-# Output
-puts "\e[4;34m\n# #{heading}\e[0m" # blue underline
-puts step_names

data/features/binary.feature

@@ -0,0 +1,246 @@
+Feature: The `spreewald` binary
+
+  Scenario: Without arguments, it prints a list of all its steps
+    When I run `spreewald`
+    Then the output should contain "# All Spreewald steps"
+      And the output should contain "Then it should work"
+
+
+  Scenario: Filters the steps (by a multi-word string)
+    When I run `spreewald should not see`
+    Then the output should contain:
+    """
+    # All Spreewald steps containing 'should not see'
+    Then I should not see "..."
+    Then I should not see "..." in the HTML
+    Then I should not see /.../
+    """
+    But the output should not contain "Then I should see"
+      And the output should not contain "mail"
+
+
+  Scenario: Steps from the local project directory are included
+    Given a file named "features/step_definitions/test_steps.rb" with:
+    """
+    Then /^there is a test step$/ do
+      # Just testing
+    end
+    """
+    And a file named "features/step_definitions/nested/nested_steps.rb" with:
+    """
+    Then /^there is a nested test step$/ do
+      # Nested step testing
+    end
+    """
+
+    When I run `spreewald`
+    Then the output should contain "Then there is a test step"
+      And the output should contain "Then there is a nested test step"
+
+
+  Scenario: It humanizes the step expressions
+    Given a file named "features/step_definitions/test_steps.rb" with:
+    """
+    Then(/it strips parentheses/) do
+    Then /^(?:|I )should see \/([^\/]*)\/$/ do
+    Then(/^the "(.*?)" field should (not )?contain:$/) do
+    """
+
+    When I run `spreewald`
+    Then the output should contain "Then it strips parentheses"
+      And the output should contain "Then I should see /.../"
+      And the output should contain:
+      """
+      Then the "..." field should (not )?contain:
+      """
+
+
+  Scenario: Listing paths from paths.rb (full example)
+    Given a file named "features/support/paths.rb" with:
+    """
+    module PathHelpers
+
+      def path_to(page_name)
+        case page_name
+
+        when /^regex (with|optional parts)$/
+          root_path
+        when /^simple regex$/
+          albums_path
+
+        when 'single quoted path'
+          admin_path anchor: '/videos_overview'
+
+        when "double quoted path"
+          admin_path anchor: '/photos_overview'
+
+        when /^the admin( .+)? (page|form) for the (.+) above$/
+          # Some path
+
+        when /^the path "(.+)"$/
+          $1
+
+        # Examples:
+        # the album collection above
+        when /^the (.+) above$/
+
+        else
+          raise "Unknown page: #{page_name.inspect}"
+        end
+      end
+
+    end
+    World(PathHelpers)
+    """
+
+    When I run `spreewald --paths`
+    Then the output should contain "All paths from features/support/paths.rb"
+      And the output should contain:
+      """
+      regex (with|optional parts)
+      simple regex
+      single quoted path
+      double quoted path
+      the admin( ...)? (page|form) for the ... above
+      the path "..."
+      the ... above
+      """
+
+
+  Scenario: Filtering paths
+    Given a file named "features/support/paths.rb" with:
+    """
+        when 'only quoted'
+        when 'single quoted path'
+        when "double quoted path"
+    """
+
+    When I run `spreewald --paths only`
+    Then the output should contain "All paths from features/support/paths.rb containing 'only'"
+      And the output should contain "only quoted"
+    But the output should not contain "single quoted path"
+      And the output should not contain "double quoted path"
+
+    # Support for multi-word filtering
+    When I run `spreewald --paths quoted path`
+    Then the output should contain "All paths from features/support/paths.rb containing 'quoted path'"
+      And the output should contain "single quoted path"
+      And the output should contain "double quoted path"
+    But the output from "spreewald --paths quoted path" should not contain "only quoted"
+
+
+  Scenario: List paths with short option "-p"
+    Given a file named "features/support/paths.rb" with:
+    """
+        when 'single quoted path'
+    """
+
+    When I run `spreewald -p`
+    Then the output should contain "All paths from features/support/paths.rb"
+      And the output should contain "single quoted path"
+
+
+  Scenario: List selectors from selectors.rb
+    Given a file named "features/support/selectors.rb" with:
+    """
+    module HtmlSelectorsHelpers
+      def selector_for(locator)
+        case locator
+
+        when /^simple regex$/
+          '.simple-regex'
+
+        when 'single quoted selector'
+          '.single-quoted-selector'
+
+        when "double quoted selector"
+          '.double-quoted-selector'
+
+        when /^the(?: (\d+)(?:st|nd|rd|th))? (.+) page item$/
+          # e.g. the frontend page items
+
+        when /^the (\d+)(st|nd|rd|th) gallery row$/
+          ".gallery .row:nth-of-type(#{$1})"
+
+        # Auto-mapper for BEM classes
+        # E.g. the slider's item that is current
+        when /^the (.+?)(?:'s? (.+?))?(?: that (.+))?$/
+          # Something
+
+        when /^"(.+)"$/
+          $1
+
+        else
+          raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+            "Now, go and add a mapping in #{__FILE__}"
+        end
+      end
+    end
+    """
+
+    When I run `spreewald --selectors`
+    Then the output should contain "All selectors from features/support/selectors.rb"
+      And the output should contain:
+      """
+      simple regex
+      single quoted selector
+      double quoted selector
+      the( <nth>)? ... page item
+      the <nth> gallery row
+      the ...('s? ...)?( that ...)?
+      "..."
+      """
+
+
+  Scenario: Filtering selectors
+    Given a file named "features/support/paths.rb" with:
+    """
+        when 'only quoted'
+        when 'single quoted selector'
+        when "double quoted selector"
+    """
+
+    When I run `spreewald --paths only`
+    Then the output should contain "All paths from features/support/paths.rb containing 'only'"
+      And the output should contain "only quoted"
+    But the output should not contain "single quoted selector"
+      And the output should not contain "double quoted selector"
+
+    # Support for multi-word filtering
+    When I run `spreewald --paths quoted selector`
+    Then the output should contain "All paths from features/support/paths.rb containing 'quoted selector'"
+      And the output should contain "single quoted selector"
+      And the output should contain "double quoted selector"
+    But the output from "spreewald --paths quoted selector" should not contain "only quoted"
+
+
+  Scenario: List selectors with short option "-s"
+    Given a file named "features/support/selectors.rb" with:
+    """
+        when 'single quoted selector'
+    """
+
+    When I run `spreewald -s`
+    Then the output should contain "All selectors from features/support/selectors.rb"
+      And the output should contain "single quoted selector"
+
+
+  Scenario: Print help
+    When I run `spreewald --help`
+    Then the output should contain:
+    """
+    USAGE:
+      spreewald [SEARCH]
+    """
+      And the output should contain "spreewald --paths"
+      And the output should contain "spreewald --selectors"
+      And the output should contain "spreewald --version"
+      And the output should contain "spreewald --help"
+
+
+  Scenario: Print version
+    When I run `spreewald --version`
+    Then the output should contain "Spreewald 1."
+
+    When I run `spreewald -v`
+    Then the output should contain "Spreewald 1."

data/features/support/aruba.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/spreewald/web_steps.rb

@@ -268,7 +268,6 @@ Then /^the "([^"]*)" field should have no error$/ do |field|
   end
 end.overridable
 
-# nodoc
 Then /^the "([^"]*)" checkbox should( not)? be checked$/ do |label, negate|
   expectation = negate ? :should_not : :should
 
@@ -353,7 +352,7 @@ Then /^"([^"]*)" should be selected for "([^"]*)"$/ do |value, field|
   step %(the "#{field}" field should contain "#{value}")
 end.overridable
 
-Then /^nothing should be selected for "([^"]*)"?$/ do |field|
+Then /^nothing should be selected for "([^"]*)"$/ do |field|
   patiently do
     select = find_field(field)
     begin
@@ -404,7 +403,6 @@ Then /^I should see an error$/ do
   (400 .. 599).should include(page.status_code)
 end.overridable
 
-#nodoc
 Then /^the window should be titled "([^"]*)"$/ do |title|
   patiently do
     page.should have_css('title', :text => title)

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '1.5.5'
+  VERSION = '1.6.0'
 end

data/spreewald.gemspec

@@ -19,4 +19,14 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('cucumber')
   gem.add_dependency('cucumber_priority')
+
+  # Development
+  gem.add_development_dependency 'bundler', '~> 1.11'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+
+  # Testing
+  gem.add_development_dependency 'aruba', '~> 0.10.2'
+  gem.add_development_dependency 'guard-cucumber'
+  gem.add_development_dependency 'rspec', '~> 3.4.0'
 end

data/support/parser.rb

@@ -0,0 +1,25 @@
+class Parser
+
+  ANYTHINGS = %w[([^\"]*) ([^"]+) ([^"]*) (.*) (.*?) [^"]+ ([^\"]+) ([^']*)
+    ([^\/]*) (.+) (.*[^:]) (.+?) .+].map &Regexp.method(:escape)
+
+  def self.human_regex(regex)
+    regex.
+      sub(/^\(?\/\^?/, ''). # Strip Regex beginning
+      sub(/\$?\/\)?$/, ''). # Strip Regex end
+      gsub(' ?', ' ').
+      gsub('(?:|I )', 'I ').
+      gsub('(?:', '(').
+      gsub(Regexp.new(Regexp.escape '(\d+)(st|nd|rd|th)'), '<nth>').
+      gsub(Regexp.new(ANYTHINGS.join '|'), '...').
+      gsub(/\\\//, '/')
+  end
+
+  def self.format_comment(comment)
+    comment.gsub! /.*coding:.*UTF-8.*/, ''
+    comment.strip!
+    comment_lines = comment.split("\n").take_while { |line| line =~ /^\s*#/ }
+    comment_lines && comment_lines.join("\n").gsub(/^\s*# ?/, '')
+  end
+
+end

data/support/paths_manager.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../parser', __FILE__)
+
+class PathsManager
+
+  def initialize(file_path)
+    @file_path = file_path
+    read_paths
+  end
+
+  def paths(search = nil)
+    paths = @raw_paths.map do |raw_path|
+      path = raw_path.sub(/^\s+when/, '').strip
+
+      if path.start_with? '/'
+        Parser.human_regex(path)
+      else
+        path.gsub /\A["']|["']\z/, ''
+      end
+    end
+
+    paths.reject do |path|
+      if search
+        path !~ Regexp.new(search)
+      end
+    end
+  end
+
+private
+
+  def read_paths
+    lines = File.readlines @file_path
+    @raw_paths = lines.grep /^\s*when /
+  end
+
+end