yard-cucumber 2.2.3 → 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 141a8f048e0ec232851c10aefa060821c1885684
+  data.tar.gz: bcfbe2d833588a9494394773037fada8dab64d31
+SHA512:
+  metadata.gz: 31b2dc9fcd5d5455e7909f722598474fd74a618b6f43bccdfcd078c064f70159ee72850917e7b6e95d94f47d767ddc7698fdb2013eb1a2e24b8e0a228bacadf8
+  data.tar.gz: 8d11412d13f7e4eaf317f7123be3b8a9805451164479e4fcd7d306b596b32220e590183b35c5bafdb8f533cfc16853be51067dec5b8915256ac1c7d65976da50

data/.ruby-gemset

@@ -0,0 +1 @@
+yard-cucumber

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p195

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gem 'redcarpet'
 

data/Gemfile.lock

@@ -1,26 +1,28 @@
 PATH
   remote: .
   specs:
-    yard-cucumber (2.2.2)
-      cucumber (>= 0.7.5)
-      gherkin (>= 2.2.9)
+    yard-cucumber (2.3.0)
+      cucumber (~> 1.3)
+      gherkin (~> 2.12)
       yard (>= 0.8.1)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    builder (3.0.0)
-    cucumber (1.2.0)
+    builder (3.2.2)
+    cucumber (1.3.3)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.10.0)
-      json (>= 1.4.6)
-    diff-lcs (1.1.3)
-    gherkin (2.10.0)
-      json (>= 1.4.6)
-    json (1.7.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (~> 0.0.1)
+    diff-lcs (1.2.4)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    multi_json (1.7.7)
+    multi_test (0.0.1)
     redcarpet (2.2.2)
-    yard (0.8.3)
+    yard (0.8.6.2)
 
 PLATFORMS
   ruby

data/History.txt

@@ -1,3 +1,8 @@
+=== 2.3.0/ 2013-07-12
+
+* Fixes for Cucumber ~> 1.3 and gherkin ~> 2.12 by loading
+  a required platform file.
+
 === 2.2.3/ 2013-02-15
 
 * Step Definitions that are marked as 'pending' will now appear as pending

data/city.gemspec

@@ -53,8 +53,8 @@ Gem::Specification.new do |s|
 
 }
 
-  s.add_dependency 'gherkin', '>= 2.2.9'
-  s.add_dependency 'cucumber', '>= 0.7.5'
+  s.add_dependency 'gherkin', '~> 2.12'
+  s.add_dependency 'cucumber', '~> 1.3'
   s.add_dependency 'yard', '>= 0.8.1'
 
   s.rubygems_version   = "1.3.7"

data/lib/cucumber/city_builder.rb

@@ -2,19 +2,19 @@ module Cucumber
   module Parser
     class CityBuilder
       include Gherkin::Rubify
-      
+
       #
       # The Gherkin Parser is going to call the various methods within this
       # class as it finds items. This is similar to how Cucumber generates
       # it's Abstract Syntax Tree (AST). Here instead this generates the
       # various YARD::CodeObjects defined within this template.
-      # 
+      #
       # A namespace is specified and that is the place in the YARD namespacing
       # where all cucumber features generated will reside. The namespace specified
       # is the root namespaces.
-      # 
+      #
       # @param [String] file the name of the file which the content belongs
-      # 
+      #
       def initialize(file)
         @namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
         find_or_create_namespace(file)
@@ -24,29 +24,29 @@ module Cucumber
       # Return the feature that has been defined. This method is the final
       # method that is called when all the work is done. It is called by
       # the feature parser to return the complete Feature object that was created
-      # 
+      #
       # @return [YARD::CodeObject::Cucumber::Feature] the completed feature
-      # 
+      #
       # @see YARD::Parser::Cucumber::FeatureParser
       def ast
         @feature
       end
-      
+
       #
       # Feature that are found in sub-directories are considered, in the way
       # that I chose to implement it, in another namespace. This is because
       # when you execute a cucumber test run on a directory any sub-directories
       # of features will be executed with that directory so the file is split
       # and then namespaces are generated if they have not already have been.
-      # 
+      #
       # The other duty that this does is look for a README.md file within the
       # specified directory of the file and loads it as the description for the
       # namespace. This is useful if you want to give a particular directory
       # some flavor or text to describe what is going on.
-      # 
+      #
       def find_or_create_namespace(file)
         @namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
-        
+
         File.dirname(file).split('/').each do |directory|
           @namespace = @namespace.children.find {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) && child.name.to_s == directory } ||
             @namespace = YARD::CodeObjects::Cucumber::FeatureDirectory.new(@namespace,directory) {|dir| dir.add_file(directory)}
@@ -56,20 +56,20 @@ module Cucumber
           @namespace.description = File.read("#{File.dirname(file)}/README.md")
         end
       end
-      
+
       #
       # Find the tag if it exists within the YARD Registry, if it doesn' t then
-      # create it. 
-      # 
+      # create it.
+      #
       # We note that the tag was used in this file at the current line.
-      # 
+      #
       # Then we add the tag to the current scenario or feature. We also add the
       # feature or scenario to the tag.
-      # 
+      #
       # @param [String] tag_name the name of the tag
       # @param [parent] parent the scenario or feature that is going to adopt
       #     this tag.
-      # 
+      #
       def find_or_create_tag(tag_name,parent)
         #log.debug "Processing tag #{tag_name}"
         tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.value == tag_name } ||
@@ -80,15 +80,15 @@ module Cucumber
         parent.tags << tag_code_object unless parent.tags.find {|tag| tag == tag_code_object }
         tag_code_object.owners << parent unless tag_code_object.owners.find {|owner| owner == parent}
       end
-      
+
       #
       # Each feature found will call this method, generating the feature object.
       # This is once, as the gherking parser does not like multiple feature per
       # file.
-      # 
+      #
       def feature(feature)
         #log.debug "FEATURE"
-        
+
         @feature = YARD::CodeObjects::Cucumber::Feature.new(@namespace,File.basename(@file.gsub('.feature','').gsub('.','_'))) do |f|
           f.comments = feature.comments.map{|comment| comment.value}.join("\n")
           f.description = feature.description
@@ -100,14 +100,14 @@ module Cucumber
           feature.tags.each {|feature_tag| find_or_create_tag(feature_tag.name,f) }
         end
       end
-      
+
       #
       # Called when a background has been found
-      # 
+      #
       # @see #scenario
       def background(background)
         #log.debug "BACKGROUND"
-        
+
         @background = YARD::CodeObjects::Cucumber::Scenario.new(@feature,"background") do |b|
           b.comments = background.comments.map{|comment| comment.value}.join("\n")
           b.description = background.description
@@ -120,20 +120,20 @@ module Cucumber
         @background.feature = @feature
         @step_container = @background
       end
-      
+
       #
       # Called when a scenario has been found
       #   - create a scenario
       #   - assign the scenario to the feature
       #   - assign the feature to the scenario
       #   - find or create tags associated with the scenario
-      # 
+      #
       # The scenario is set as the @step_container, which means that any steps
       # found before another scenario is defined belong to this scenario
-      # 
+      #
       # @param [Scenario] statement is a scenario object returned from Gherkin
       # @see #find_or_create_tag
-      # 
+      #
       def scenario(statement)
         #log.debug "SCENARIO"
 
@@ -151,17 +151,17 @@ module Cucumber
         @feature.scenarios << scenario
         @step_container = scenario
       end
-      
+
       #
       # Called when a scenario outline is found. Very similar to a scenario,
       # the ScenarioOutline is still a distinct object as it can contain
       # multiple different example groups that can contain different values.
-      # 
+      #
       # @see #scenario
-      # 
+      #
       def scenario_outline(statement)
         #log.debug "SCENARIO OUTLINE"
-        
+
         outline = YARD::CodeObjects::Cucumber::ScenarioOutline.new(@feature,"scenario_#{@feature.scenarios.length + 1}") do |s|
           s.comments = statement.comments.map{|comment| comment.value}.join("\n")
           s.description = statement.description
@@ -182,18 +182,18 @@ module Cucumber
       # from the Cucumber parser because here each of the examples are exploded
       # out here as individual scenarios and step definitions. This is so that
       # later we can ensure that we have all the variations of the scenario
-      # outline defined to be displayed. 
-      # 
+      # outline defined to be displayed.
+      #
       def examples(examples)
         #log.debug "EXAMPLES"
-        
+
         example = YARD::CodeObjects::Cucumber::ScenarioOutline::Examples.new(:keyword => examples.keyword,
           :name => examples.name,
           :line => examples.line,
           :comments => examples.comments.map{|comment| comment.value}.join("\n"),
           :rows => matrix(examples.rows))
-          
-          
+
+
         # add the example to the step containers list of examples
 
         @step_container.examples << example
@@ -202,7 +202,7 @@ module Cucumber
         # current scenario as the template.
 
         example.data.length.times do |row_index|
-          
+
           # Generate a copy of the scenario.
 
           scenario = YARD::CodeObjects::Cucumber::Scenario.new(@step_container,"example_#{@step_container.scenarios.length + 1}") do |s|
@@ -234,32 +234,32 @@ module Cucumber
               step_instance.text.gsub!("<#{key}>",text) if step_instance.has_text?
               step_instance.table.each{|row| row.each{|col| col.gsub!("<#{key}>",text)}} if step_instance.has_table?
             end
-            
+
             # Connect these steps that we created to the scenario we created
             # and then add the steps to the scenario created.
-            
+
             step_instance.scenario = scenario
             scenario.steps << step_instance
           end
 
-          # Add the scenario to the list of scenarios maintained by the  feature 
+          # Add the scenario to the list of scenarios maintained by the  feature
           # and add the feature to the scenario
-          
+
           scenario.feature = @feature
           @step_container.scenarios << scenario
-        
+
         end
-        
+
       end
 
-      # 
+      #
       # Called when a step is found. The step is refered to a table owner, though
       # not all steps have a table or multliline arguments associated with them.
-      # 
+      #
       # If a multiline string is present with the step it is included as the text
       # of the step. If the step has a table it is added to the step using the
       # same method used by the Cucumber Gherkin model.
-      # 
+      #
       def step(step)
         #log.debug "STEP"
 
@@ -279,8 +279,6 @@ module Cucumber
           rubify(step.doc_string)
         end
 
-        log.debug "Step: #{multiline_arg}"
-        
         case(multiline_arg)
         when gherkin_multiline_string_class
           @table_owner.text = multiline_arg.value
@@ -288,7 +286,7 @@ module Cucumber
           #log.info "Matrix: #{matrix(multiline_arg).collect{|row| row.collect{|cell| cell.class } }.flatten.join("\n")}"
           @table_owner.table = matrix(multiline_arg)
         end
-        
+
         @table_owner.scenario = @step_container
         @step_container.steps << @table_owner
       end
@@ -306,11 +304,11 @@ module Cucumber
       def matrix(gherkin_table)
         gherkin_table.map {|gherkin_row| gherkin_row.cells }
       end
-      
+
       #
       # This helper method is used to deteremine what class is the current
       # Gherkin class.
-      # 
+      #
       # @return [Class] the class that is the current supported Gherkin Model
       #     for multiline strings. Prior to Gherkin 2.4.0 this was the PyString
       #     class. As of Gherkin 2.4.0 it is the DocString class.
@@ -327,7 +325,7 @@ module Cucumber
       def clone_table(base)
         base.map {|row| row.map {|cell| cell.dup }}
       end
-      
+
     end
   end
 end

data/lib/yard-cucumber.rb

@@ -1,3 +1,4 @@
+require 'cucumber/platform'
 require 'cucumber/parser/gherkin_builder'
 require 'gherkin/parser/parser'
 require 'gherkin/formatter/tag_count_formatter'

data/lib/yard-cucumber/version.rb

@@ -1,3 +1,3 @@
 module CucumberInTheYARD
-  VERSION = '2.2.3'
+  VERSION = '2.3.0'
 end

data/lib/yard/code_objects/step_transformer.rb

@@ -5,29 +5,31 @@ module YARD::CodeObjects
 
     include Cucumber::LocationHelper
 
-    attr_reader :constants, :keyword, :source, :value, :literal_value, :pending
-    attr_accessor :steps
-    
+    attr_reader :constants, :keyword, :source, :value, :literal_value
+    attr_accessor :steps, :pending, :substeps
+
     # This defines an escape pattern within a string or regex:
     #     /^the first #{CONSTANT} step$/
-    # 
+    #
     # This is used below in the value to process it if there happen to be
     # constants defined here.
-    # 
+    #
     # @note this does not handle the result of method calls
     # @note this does not handle multiple constants within the same escaped area
-    # 
-    ESCAPE_PATTERN = /#\{\s*(\w+)\s*\}/ unless defined?(ESCAPE_PATTERN)
+    #
+    def escape_pattern
+      /#\{\s*(\w+)\s*\}/
+    end
 
     #
     # When requesting a step tranformer object value, process it, if it hasn't
     # alredy been processed, replacing any constants that may be lurking within
     # the value.
-    # 
+    #
     # Processing it means looking for any escaped characters that happen to be
     # CONSTANTS that could be matched and then replaced. This is done recursively
     # as CONSTANTS can be defined with more CONSTANTS.
-    # 
+    #
     def value
       unless @processed
         @processed = true
@@ -35,23 +37,23 @@ module YARD::CodeObjects
           nested.each {|n| @value.gsub!(value_regex(n),find_value_for_constant(n)) }
         end
       end
-      
+
       @value
     end
 
     #
     # Set the literal value and the value of the step definition.
-    # 
+    #
     # The literal value is as it appears in the step definition file with any
-    # constants. The value, when retrieved will attempt to replace those 
+    # constants. The value, when retrieved will attempt to replace those
     # constants with their regex or string equivalents to hopefully match more
     # steps and step definitions.
-    # 
-    # 
+    #
+    #
     def value=(value)
       @literal_value = format_source(value)
       @value = format_source(value)
-      
+
       @steps = []
       value
     end
@@ -60,13 +62,13 @@ module YARD::CodeObjects
     def regex
       @regex ||= /#{strip_regex_from(value)}/
     end
-    
+
     # Look through the specified data for the escape pattern and return an array
     # of those constants found. This defaults to the @value within step transformer
     # as it is used internally, however, it can be called externally if it's
     # needed somewhere.
     def constants_from_value(data=@value)
-      data.scan(ESCAPE_PATTERN).flatten.collect { |value| value.strip }
+      data.scan(escape_pattern).flatten.collect { |value| value.strip }
     end
 
     protected
@@ -74,13 +76,13 @@ module YARD::CodeObjects
     #
     # Looking through all the constants in the registry and returning the value
     # with the regex items replaced from the constnat if present
-    # 
+    #
     def find_value_for_constant(name)
       constant = YARD::Registry.all(:constant).find{|c| c.name == name.to_sym }
       log.warn "StepTransformer#find_value_for_constant : Could not find the CONSTANT [#{name}] using the string value." unless constant
       constant ? strip_regex_from(constant.value) : name
     end
-  
+
     # Return a regex of the value
     def value_regex(value)
       /#\{\s*#{value}\s*\}/

data/lib/yard/handlers/step_definition_handler.rb

@@ -48,11 +48,9 @@ class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
     instance = YARD::CodeObjects::StepDefinitionObject.new(step_transform_namespace,step_definition_name) do |o|
       o.source = statement.source
       o.comments = statement.comments
-      # o.keyword = statement.method_name.source
-      o.keyword = statement[0].source
-      # o.value = statement.parameters.source
-      o.value = statement[1].source
-      o.pending = pending_keyword_used(statement.block)
+      o.keyword = statement.method_name.source
+      o.value = statement.parameters.source
+      o.pending = pending_keyword_used?(statement.block)
     end
 
     obj = register instance
@@ -65,11 +63,10 @@ class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
   end
 
   def pending_command_statement?(line)
-    puts "#{line.type} #{line.source}"
     (line.type == :command || line.type == :vcall) && line.first.source == pending_keyword
   end
 
-  def pending_keyword_used(block)
+  def pending_keyword_used?(block)
     code_in_block = block.last
     code_in_block.find { |line| pending_command_statement?(line) }
   end

metadata

@@ -1,65 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: yard-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.2.3
-  prerelease: 
+  version: 2.3.0
 platform: ruby
 authors:
 - Franklin Webber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.9
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.9
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: ! "\n    YARD-Cucumber is a YARD extension that processes Cucumber Features,
+description: "\n    YARD-Cucumber is a YARD extension that processes Cucumber Features,
   Scenarios, Steps,\n    Step Definitions, Transforms, and Tags and provides a documentation
   interface that allows you\n    easily view and investigate the test suite.  This
   tools hopes to bridge the gap of being able\n    to provide your feature descriptions
@@ -73,7 +66,8 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -162,32 +156,30 @@ files:
 - lib/yard/templates/helpers/base_helper.rb
 homepage: http://github.com/burtlo/yard-cucumber
 licenses: []
-post_install_message: ! "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.2.3 / 2013-02-15.\n\n
-  \ Changes:\n    \n  * Step Definitions that are marked as 'pending' will now appear
-  as pending\n    on the step definition and transforms page.\n  \n\n(::) (::) (::)
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+metadata: {}
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.3.0 / 2013-07-12.\n\n
+  \ Changes:\n    \n  * Fixes for Cucumber ~> 1.3 and gherkin ~> 2.12 by loading\n
+  \   a required platform file.\n  \n\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options:
 - --charset=UTF-8
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cucumber Features in YARD
 test_files: []
-has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm gemset use yard-cucumber