yard-cucumber 3.1.0 → 4.0.0

data/lib/yard/code_objects/step_definition.rb

@@ -1,7 +1,4 @@
-
-
 module YARD::CodeObjects
-
-  class StepDefinitionObject < StepTransformerObject ; end
-
-end
+  class StepDefinitionObject < StepTransformerObject;
+  end
+end

data/lib/yard/code_objects/step_transform.rb

@@ -1,7 +1,4 @@
-
-
 module YARD::CodeObjects
-
-  class StepTransformObject < StepTransformerObject ; end
-  
-end
+  class StepTransformObject < StepTransformerObject;
+  end
+end

data/lib/yard/code_objects/step_transformer.rb

@@ -1,6 +1,4 @@
-
 module YARD::CodeObjects
-
   class StepTransformerObject < Base
 
     include Cucumber::LocationHelper
@@ -93,5 +91,4 @@ module YARD::CodeObjects
       value.gsub(/^\/|\/$/,'')
     end
   end
-
-end
+end

data/lib/yard/handlers/constant_transform_handler.rb

@@ -0,0 +1,98 @@
+# There might be a nicer way to decorate this class but with my limited knowledge could only get this handler
+# to be applied after the default constant handler by inheriting from the default constant handler.
+# This is required so that the value assigned from the transform is not overridden in the registry by the
+# default handler
+class YARD::Handlers::Ruby::ConstantTransformHandler < YARD::Handlers::Ruby::ConstantHandler
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  handles :assign
+
+  namespace_only
+
+  process do
+    begin
+      if statement[1][0][0] == "Transform"
+        name = statement[0][0][0]
+        # Move the docstring to the transform statement
+        statement[1].docstring = statement.docstring
+        # Set the docstring on the constant to reference the transform that will be processed
+        statement.docstring = "Reference to {#{YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE}::#{name} transform}"
+        value = statement[1][1].source
+        value = substitute(value)
+        value = convert_captures(strip_anchors(value))
+        instance = register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value }
+        # specify the owner so that the transform can use the registered constant's name
+        parse_block(statement[1], {:owner => instance})
+      elsif statement[1][0][0] == "ParameterType"
+        name = statement[0][0][0]
+        # Move the docstring to the transform statement
+        statement[1].docstring = statement.docstring
+        # Set the docstring on the constant to reference the transform that will be processed
+        statement.docstring = "Reference to {#{YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE}::#{name} transform}"
+
+        value = find(statement, :label, 'regexp:').parent.children[1].source
+
+        value = substitute(value)
+        value = convert_captures(strip_anchors(value))
+        instance = register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value }
+        # specify the owner so that the transform can use the registered constant's name
+        parse_block(statement[1], {:owner => instance})
+      end
+    rescue
+      # This supresses any errors where any of the statement elements are out of bounds. 
+      # In this case the or in cases where the object being assigned is not a Transform
+      # the default constant handler will already have performed the relevant action
+    end
+  end
+
+  private
+
+  def find(node, node_type, value)
+    node.traverse { |child| return(child) if node_type == child.type && child.source == value }
+    self
+  end
+
+  # Cucumber's Transform object overrides the to_s function and strips
+  # the anchor tags ^$ and any captures so that id it is interpolated in a step definition
+  # the it can appear anywhere in the step without being effected by position or captures
+  def convert_captures(regexp_source)
+    regexp_source
+      .gsub(/(\()(?!\?[<:=!])/,'(?:')
+      .gsub(/(\(\?<)(?![=!])/,'(?:<')
+  end
+
+  def strip_anchors(regexp_source)
+    regexp_source.
+      gsub(/(^\(\/|\/\)$)/, '').
+      gsub(/(^\^|\$$)/, '')
+  end
+
+  # Support for interpolation in the Transform's Regex
+  def substitute(data)
+    until (nested = constants_from_value(data)).empty?
+      nested.each {|n| data.gsub!(value_regex(n),find_value_for_constant(n)) }
+    end
+    data
+  end
+
+  def constants_from_value(data)
+    escape_pattern = /#\{\s*(\w+)\s*\}/
+    data.scan(escape_pattern).flatten.collect { |value| value.strip }
+  end
+
+  # Return a regex of the value
+  def value_regex(value)
+    /#\{\s*#{value}\s*\}/
+  end
+
+  def find_value_for_constant(name)
+    constant = YARD::Registry.all(:constant).find{|c| c.name == name.to_sym }
+    log.warn "ConstantTransformHandler#find_value_for_constant : Could not find the CONSTANT [#{name}] using the string value." unless constant
+    constant ? strip_regex_from(constant.value) : name
+  end
+
+  # Step the regex starting / and ending / from the value
+  def strip_regex_from(value)
+    value.gsub(/^\/|\/$/,'')
+  end
+
+end

data/lib/yard/handlers/cucumber/feature_handler.rb

@@ -105,7 +105,7 @@ module YARD
 
               if stepdef_matches
                 step.definition = stepdef_object
-                stepdef_matches[-1..1].each do |match|
+                stepdef_matches[1..-1].each do |match|
                   @@step_transforms.each do |steptrans,steptransform_object|
                     if steptrans.match(match)
                       step.transforms << steptransform_object

data/lib/yard/handlers/step_transform_handler.rb

@@ -1,18 +1,26 @@
 
 class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
   handles method_call(:Transform)
+  handles method_call(:ParameterType)
 
   process do
 
+    nextStatement = nil
     instance = YARD::CodeObjects::StepTransformObject.new(step_transform_namespace,step_transformer_name) do |o|
       o.source = statement.source
       o.comments = statement.comments
       o.keyword = statement[0].source
-      o.value = statement[1].source
+      if (o.keyword == 'Transform')
+        o.value = statement[1].source.gsub(/(^\(?\/|\/\)?$)/, '').gsub(/(^\^|\$$)/, '')
+        nextStatement = statement[2]
+      elsif (o.keyword == 'ParameterType')
+        o.value = find(statement, :label, 'regexp:').parent.children[1].source.gsub(/(^\(?\/|\/\)?$)/, '').gsub(/(^\^|\$$)/, '')
+        nextStatement = find(statement, :label, 'transformer:').parent.children[1]
+      end
     end
 
     obj = register instance
-    parse_block(statement[2],:owner => obj)
+    parse_block(nextStatement,:owner => obj)
 
   end
 
@@ -21,11 +29,22 @@ class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
   end
 
   def step_transformer_name
-    "step_transform#{self.class.generate_unique_id}"
+    # If the owner is a constant then we get the name of the constant so that the reference from the constant will work
+    if (owner.is_a?(YARD::CodeObjects::ConstantObject))
+      owner.name
+    else
+      "step_transform#{self.class.generate_unique_id}"
+    end
   end
 
   def self.generate_unique_id
     @step_transformer_count = @step_transformer_count.to_i + 1
   end
 
+  private
+
+  def find(node, node_type, value)
+    node.traverse { |child| return(child) if node_type == child.type && child.source == value }
+    self
+  end
 end

data/yard-cucumber.gemspec

@@ -56,8 +56,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '~> 10'
 
-  s.add_dependency 'gherkin', '~> 4.0'
-  s.add_dependency 'cucumber', '~> 2'
+  s.add_dependency 'gherkin', '>= 4.0', '< 6.0'
+  s.add_dependency 'cucumber', '>= 2.0', '< 4.0'
   s.add_dependency 'yard', '~> 0.8', '>= 0.8.1'
 
   s.rubygems_version   = "1.3.7"

metadata

@@ -1,75 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: yard-cucumber
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Franklin Webber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: gherkin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
 description: "\n    YARD-Cucumber is a YARD extension that processes Cucumber Features,
@@ -84,10 +96,11 @@ extra_rdoc_files:
 - README.md
 - History.txt
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -163,6 +176,7 @@ files:
 - lib/yard/code_objects/step_definition.rb
 - lib/yard/code_objects/step_transform.rb
 - lib/yard/code_objects/step_transformer.rb
+- lib/yard/handlers/constant_transform_handler.rb
 - lib/yard/handlers/cucumber/base.rb
 - lib/yard/handlers/cucumber/feature_handler.rb
 - lib/yard/handlers/legacy/step_definition_handler.rb
@@ -180,27 +194,31 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  (::) (::) (::)\n\n  Thank you for installing yard-cucumber 3.1.0 / 2016-12-06.\n\n
-  \ Changes:\n    \n  * Updates to Gherkin 4.0 and Cucumber 2.4.0\n  * Fixes issues
-  with the formatting that comes from these changes\n  \n\n(::) (::) (::) (::) (::)
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+  (::) (::) (::)\n\n  Thank you for installing yard-cucumber 4.0.0 / 2018-02-25.\n\n
+  \ Changes:\n    \n  * @wellavelino: Adjusts the indentation of several project classes\n
+  \   (https://github.com/burtlo/yard-cucumber/pull/89)\n  * @elhuang: Adding example
+  tags and scenarios counts\n    (https://github.com/burtlo/yard-cucumber/pull/87)\n
+  \ * @weh: Update README.md\n    (https://github.com/burtlo/yard-cucumber/pull/84)\n
+  \ * @weh: Fix Gem Load Error\n    (https://github.com/burtlo/yard-cucumber/pull/83)\n
+  \ * @Stephen-Kaye: Transforms with CONSTANTS\n    (https://github.com/burtlo/yard-cucumber/pull/79)\n
+  \ \n\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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.0.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Cucumber Features in YARD