hiptest-publisher 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7e6e951a54117005ef23edde89a7b774c0e0406
-  data.tar.gz: 8ac2f19e6510ee971d2dcbeb3d3fb4944e97e8d8
+  metadata.gz: cb3bcbe735b896844146dc4141ee87a7a8edd184
+  data.tar.gz: 39259e0186e04ca5abf63ff9933a926a646301d8
 SHA512:
-  metadata.gz: 8ecb02311bb95c630d339d286f664b6cfe373f038a2cabfd8637e41176a167b479ee9316f917fd75d5521853b2440e4affe8d162341584dc2851bd9f6e0407ad
-  data.tar.gz: fc29b7ef057e6b543bd122e1606d1210c638a6068559a7bf494a71a43446e5c9a5196b0f95991bee35acbb2f4ac2d6a36439cbd1a061f15adf6a652268a52420
+  metadata.gz: 611f35d620f0545a61257915c46d767dc44d5c7575c850ba17ae3acd5b0cd04a88ca8df0b90aa87e42e7990d0157a55d571f5009a7d790680d3160258822daf1
+  data.tar.gz: 7a8f4f5489980971836a49e68116a4e13712290d4c7d3c6cc289ee25cd842fdc5c4fb42a746b38f3cd242c9ed80c4ff0dcfad8c9ec1044992c23d6fef8d71505

data/bin/hiptest-publisher

@@ -1,5 +1,16 @@
 #!/usr/bin/env ruby
 
+# Use the following command to run hiptest-publisher and test your changes:
+#
+#     bundle exec ruby -I lib bin/hiptest-publisher
+#
+# You can define an alias for this command and run it as if you were running
+# the gem.
+#
+#     alias hiptest-publisher='bundle exec ruby -I lib bin/hiptest-publisher'
+#     hiptest-publisher -v --token=1234567890
+#
+
 begin
   require 'rubygems'
   gem 'hiptest-publisher'
@@ -7,5 +18,6 @@ rescue LoadError
 end
 
 require 'hiptest-publisher'
+require 'pry'
 
 Hiptest::Publisher.new(ARGV).run

data/lib/hiptest-publisher.rb

@@ -228,6 +228,7 @@ module Hiptest
       Hiptest::Nodes::ParentAdder.add(@project)
       Hiptest::Nodes::ParameterTypeAdder.add(@project)
       Hiptest::DefaultArgumentAdder.add(@project)
+      Hiptest::GherkinAdder.add(@project)
 
       unless @options.actionwords_only
         @options.leafless_export ? export_tests : export_scenarios
@@ -249,4 +250,4 @@ module Hiptest
       end
     end
   end
-end
+end

data/lib/hiptest-publisher/actionword_indexer.rb

@@ -0,0 +1,31 @@
+module Hiptest
+  class ActionwordIndexer
+    def initialize(project)
+      @project = project
+      @indexed = {}
+      index_actionwords
+    end
+
+    def index_actionwords
+      @project.find_sub_nodes(Hiptest::Nodes::Actionword).each do |aw|
+        aw_name = aw.children[:name]
+        indexed_parameters = {}
+
+        aw.children[:parameters].map do |param|
+          param_name = param.children[:name]
+          indexed_parameters[param_name] = param.children[:default]
+        end
+
+        @indexed[aw_name] = {
+          :actionword => aw,
+          :parameters => indexed_parameters
+        }
+
+      end
+    end
+
+    def get_index(name)
+      @indexed[name]
+    end
+  end
+end

data/lib/hiptest-publisher/call_arguments_adder.rb

@@ -1,3 +1,4 @@
+require 'hiptest-publisher/actionword_indexer'
 require 'hiptest-publisher/nodes'
 
 module Hiptest
@@ -30,34 +31,4 @@ module Hiptest
       end
     end
   end
-
-  class ActionwordIndexer
-    def initialize(project)
-      @project = project
-      @indexed = {}
-      index_actionwords
-    end
-
-    def index_actionwords
-      @project.find_sub_nodes(Hiptest::Nodes::Actionword).each do |aw|
-        aw_name = aw.children[:name]
-        indexed_parameters = {}
-
-        aw.children[:parameters].map do |param|
-          param_name = param.children[:name]
-          indexed_parameters[param_name] = param.children[:default]
-        end
-
-        @indexed[aw_name] = {
-          :actionword => aw,
-          :parameters => indexed_parameters
-        }
-
-      end
-    end
-
-    def get_index(name)
-      @indexed[name]
-    end
-  end
-end
+end

data/lib/hiptest-publisher/gherkin_adder.rb

@@ -0,0 +1,123 @@
+require 'hiptest-publisher/actionword_indexer'
+require 'hiptest-publisher/nodes'
+
+module Hiptest
+  class GherkinAdder
+    def self.add(project)
+      GherkinAdder.new(project).update_calls
+    end
+
+    def initialize(project)
+      @project = project
+      @indexer = ActionwordIndexer.new(project)
+    end
+
+    def update_calls
+      @project.find_sub_nodes(Hiptest::Nodes::Call).each do |call|
+        call.children[:gherkin_text] ||= "#{annotation(call)} #{prettified(call)}"
+        if actionword = get_actionword(call)
+          actionword.children[:gherkin_annotation] ||= annotation(call)
+          actionword.children[:gherkin_pattern] ||= pattern(actionword)
+        end
+      end
+    end
+
+    def annotation(call)
+      if call.children[:annotation]
+        call.children[:annotation].capitalize
+      else
+        "Given"
+      end
+    end
+
+    def prettified(call)
+      all_arguments = all_valued_arguments_for(call)
+      inline_parameter_names = []
+
+      call_chunks = call.children[:actionword].split("\"", -1)
+      call_chunks.each_slice(2) do |text, inline_parameter_name|
+        if all_arguments.has_key?(inline_parameter_name)
+          inline_parameter_names << inline_parameter_name.clone
+          value = all_arguments[inline_parameter_name]
+          inline_parameter_name.replace(value)
+        end
+      end
+
+      missing_parameter_names = all_arguments.keys - inline_parameter_names
+
+      prettified = call_chunks.join("\"")
+      missing_parameter_names.each do |missing_parameter_name|
+        value = all_arguments[missing_parameter_name]
+        prettified << " \"#{value}\""
+      end
+      prettified
+    end
+
+    def pattern(actionword)
+      name = actionword.children[:name]
+      actionword_parameters = evaluated_map(actionword.children[:parameters])
+      name_chunks = name.split("\"", -1)
+      result = []
+      inline_parameter_names = []
+      name_chunks.each_slice(2) do |text, inline_parameter_name|
+        result << text.gsub(/[.|()\\.+*?\[\]{}^$]/) { |c| "\\#{c}" }
+        inline_parameter_names << inline_parameter_name if inline_parameter_name
+        if actionword_parameters.has_key?(inline_parameter_name)
+          result << "(.*)"
+        else
+          result << inline_parameter_name if inline_parameter_name
+        end
+      end
+      missing_parameter_names = actionword_parameters.keys - inline_parameter_names
+
+      patterned = result.join("\"")
+      missing_parameter_names.each do |missing_parameter_name|
+        patterned << " \"(.*)\""
+      end
+      "^#{patterned}$"
+    end
+
+    def all_valued_arguments_for(call)
+      evaluated_call_arguments = evaluated_map(call.children[:arguments])
+      evaluated_actionword_parameters = evaluated_map(get_actionword_parameters(call))
+      names = evaluated_actionword_parameters.keys
+
+      names.map { |name|
+        value = evaluated_call_arguments[name] || evaluated_actionword_parameters[name] || ""
+        [name, value]
+      }.to_h
+    end
+
+    def get_actionword_parameters(call)
+      actionword = get_actionword(call)
+      actionword && actionword.children[:parameters] || []
+    end
+
+    def get_actionword(call)
+      actionword = @indexer.get_index(call.children[:actionword])
+      actionword && actionword[:actionword] || nil
+    end
+
+    def evaluated_map(named_values)
+      named_values.map do |named_value|
+        name = named_value.children[:name]
+        value = evaluate(named_value.children[:value] || named_value.children[:default])
+        [name, value]
+      end.to_h
+    end
+
+    def evaluate(value)
+      if value.nil?
+        nil
+      elsif Hiptest::Nodes::Variable === value
+        "<#{value.children[:name]}>"
+      elsif value.children[:chunks]
+        value.children[:chunks].map {|chunk| evaluate(chunk) }.join('')
+      elsif value.children[:value]
+        value.children[:value]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/hiptest-publisher/nodes.rb

@@ -8,6 +8,10 @@ module Hiptest
       attr_reader :children, :parent
       attr_writer :parent
 
+      def pretty_print_instance_variables
+        super - [:@parent] # do not overload pry output
+      end
+
       def render(language = 'ruby', context = {})
         return Hiptest::Renderer.render(self, language, context)
       end
@@ -39,19 +43,25 @@ module Hiptest
         direct
       end
 
+      def ==(other)
+        other.class == self.class && other.children == @children
+      end
+
       private
 
       def all_sub_nodes
         path = [self]
         children = []
+        parsed_nodes_id = Set.new
 
         until path.empty?
           current_node = path.pop
 
           if current_node.is_a?(Node)
-            next if children.include? current_node
+            next if parsed_nodes_id.include? current_node.object_id
 
             children << current_node
+            parsed_nodes_id << current_node.object_id
             current_node.children.values.reverse.each {|item| path << item}
           elsif current_node.is_a?(Array)
             current_node.reverse.each {|item| path << item}
@@ -169,9 +179,10 @@ module Hiptest
     end
 
     class Call < Node
-      def initialize(actionword, arguments = [])
+      def initialize(actionword, arguments = [], annotation = nil)
         super()
-        @children = {:actionword => actionword, :arguments => arguments}
+        annotation = nil if annotation == ""
+        @children = {:actionword => actionword, :arguments => arguments, :all_arguments => arguments, :annotation => annotation}
       end
     end
 

data/lib/hiptest-publisher/options_parser.rb

@@ -174,16 +174,23 @@ class OptionsParser
 end
 
 class LanguageConfigParser
-  def initialize(options)
+  def initialize(options, language_config_path = nil)
     @options = options
-    @config = ParseConfig.new(find_config_file(options))
+    language_config_path ||= LanguageConfigParser.config_path_for(options)
+    @config = ParseConfig.new(language_config_path)
   end
 
-  def find_config_file(options)
-    ["#{options.language}/#{options.framework}", "#{options.language}"].map do |p|
+  def self.config_path_for(options)
+    config_path = ["#{options.language}/#{options.framework}", "#{options.language}"].map do |p|
       path = "#{hiptest_publisher_path}/lib/templates/#{p}/output_config"
-      path if File.file?(path)
+      File.expand_path(path) if File.file?(path)
     end.compact.first
+    if config_path.nil?
+      message = "cannot find output_config file in \"#{hiptest_publisher_path}/lib/templates\" for language #{options.language.inspect}"
+      message << " and framework #{options.framework.inspect}" if options.framework
+      raise ArgumentError.new(message)
+    end
+    config_path
   end
 
   def scenario_output_file(scenario_name)

data/lib/hiptest-publisher/renderer.rb

@@ -1,5 +1,6 @@
 require 'ruby-handlebars'
 
+require 'hiptest-publisher/gherkin_adder'
 require 'hiptest-publisher/nodes_walker'
 require 'hiptest-publisher/handlebars_helper'
 require 'hiptest-publisher/render_context_maker'
@@ -22,6 +23,7 @@ module Hiptest
       @rendered = {}
       @context = context
       @handlebars = Handlebars::Handlebars.new
+      @compiled_handlebars = {}
       register_partials()
 
       Hiptest::HandlebarsHelper.register_helpers(@handlebars, @context)
@@ -71,7 +73,15 @@ module Hiptest
       render_context[:context] = @context
 
       template = get_template_path(node)
-      @handlebars.compile(File.read(template)).call(render_context)
+      if template
+        get_compiled_handlebars(template).call(render_context)
+      else
+        raise ArgumentError.new("no template for node #{node.class}")
+      end
+    end
+
+    def get_compiled_handlebars(template)
+      @compiled_handlebars[template] ||= @handlebars.compile(File.read(template))
     end
 
     def get_template_by_name(name, extension)
@@ -81,13 +91,21 @@ module Hiptest
       end.compact.first
     end
 
+    def fallback_template(extension)
+      @fallback_template ||= begin
+        if @context[:fallback_template]
+          get_template_by_name(@context[:fallback_template], extension)
+        end
+      end
+    end
+
     def get_template_path(node, extension = 'hbs')
       normalized_name = node.class.name.split('::').last.downcase
       unless @context[:forced_templates][normalized_name].nil?
         normalized_name = @context[:forced_templates][normalized_name]
       end
 
-      get_template_by_name(normalized_name, extension)
+      get_template_by_name(normalized_name, extension) || fallback_template(extension)
     end
   end
-end
+end

data/lib/hiptest-publisher/string.rb

@@ -14,8 +14,7 @@ class String
   end
 
   def normalize_lower
-    literated = self.literate
-    literated.strip.gsub(/\s+/, '_').gsub(/\W/, '').downcase
+    self.normalize.downcase
   end
 
   def underscore
@@ -49,4 +48,4 @@ class String
   def clear_extension
     self.split('.')[0]
   end
-end
+end

data/lib/hiptest-publisher/xml_parser.rb

@@ -110,7 +110,8 @@ module Hiptest
     def build_call(call)
       Hiptest::Nodes::Call.new(
         css_first_content(call, '> actionword'),
-        build_arguments(call))
+        build_arguments(call),
+        css_first_content(call, '> annotation'))
     end
 
     def build_arguments(arguments)

data/lib/templates/cucumber/actionword.hbs

@@ -0,0 +1,5 @@
+{{#if rendered_children.gherkin_annotation }}
+{{{ rendered_children.gherkin_annotation }}} /{{{ rendered_children.gherkin_pattern }}}/ do{{#if has_parameters?}} |{{{ join rendered_children.parameters ', '}}}|{{/if}}
+{{#indent}}{{ underscore rendered_children.name }}{{#if has_parameters?}}({{{ join rendered_children.parameters ', '}}}){{/if}}{{/indent}}
+end
+{{/if}}

data/lib/templates/cucumber/actionwords.hbs

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+require_relative 'actionwords'
+World(Actionwords)
+{{#each rendered_children.actionwords}}{{{this}}}{{/each}}

data/lib/templates/cucumber/argument.hbs

@@ -0,0 +1 @@
+{{{ remove_quotes rendered_children.value }}}

data/lib/templates/cucumber/call.hbs

@@ -0,0 +1 @@
+{{{ rendered_children.gherkin_text }}}

data/lib/templates/cucumber/dataset.hbs

@@ -0,0 +1 @@
+| {{{ join rendered_children.arguments ' | ' }}} | {{#if rendered_children.uid}}uid:{{{rendered_children.uid}}}{{/if}} |

data/lib/templates/cucumber/datatable.hbs

@@ -0,0 +1,2 @@
+{{#each rendered_children.datasets}}{{{this}}}
+{{/each}}

data/lib/templates/cucumber/output_config

@@ -0,0 +1,10 @@
+[tests]
+filename = 'features.feature'
+scenario_filename = '%s.feature'
+indentation = "  "
+
+[actionwords]
+filename = 'step_definitions.rb'
+indentation = "  "
+naming_convention = 'underscore'
+fallback_template = 'empty'

data/lib/templates/cucumber/parameter.hbs

@@ -0,0 +1 @@
+{{{ underscore rendered_children.name }}}

data/lib/templates/cucumber/single_scenario.hbs

@@ -0,0 +1,16 @@
+Feature: {{{ rendered_children.name }}}{{#indent}}
+{{#if has_datasets?}}
+Scenario Outline: {{{ rendered_children.name }}}{{#indent}}
+{{#each rendered_children.body}}{{{ this }}}
+{{/each}}
+Examples:{{#indent}}
+| {{ join rendered_children.parameters ' | ' }} | hiptest-uid |
+{{{rendered_children.datatable}}}
+{{/indent}}{{/indent}}
+{{else}}
+Scenario: {{{ rendered_children.name }}}{{#if rendered_children.uid}} (uid:{{{rendered_children.uid}}}){{/if}}{{#indent}}
+{{#each rendered_children.body}}{{{ this }}}
+{{/each}}
+{{/indent}}
+{{/if}}
+{{/indent}}

data/lib/templates/cucumber/single_test.hbs

@@ -0,0 +1,3 @@
+Scenario: {{{ rendered_children.name }}}{{#indent}}
+{{#each rendered_children.body}}{{{ this }}}
+{{/each}}{{/indent}}

data/lib/templates/cucumber/step.hbs

@@ -0,0 +1 @@
+{{#comment '#'}}{{{rendered_children.key}}}: {{{rendered_children.value}}}{{/comment}}

data/lib/templates/cucumber/stringliteral.hbs

@@ -0,0 +1 @@
+{{ rendered_children.value }}

data/lib/templates/cucumber/template.hbs

@@ -0,0 +1 @@
+"{{#each treated_chunks}}{{#if this.is_variable?}}#{{#curly}}{{{this.raw.children.name}}}{{/curly}}{{else}}{{{ escape_quotes this.raw.children.value }}}{{/if}}{{/each}}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Hiptest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -138,6 +138,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +258,9 @@ files:
 - README.md
 - bin/hiptest-publisher
 - lib/hiptest-publisher.rb
+- lib/hiptest-publisher/actionword_indexer.rb
 - lib/hiptest-publisher/call_arguments_adder.rb
+- lib/hiptest-publisher/gherkin_adder.rb
 - lib/hiptest-publisher/handlebars_helper.rb
 - lib/hiptest-publisher/nodes.rb
 - lib/hiptest-publisher/nodes_walker.rb
@@ -265,6 +281,20 @@ files:
 - lib/templates/common/numericliteral.hbs
 - lib/templates/common/stringliteral.hbs
 - lib/templates/common/variable.hbs
+- lib/templates/cucumber/actionword.hbs
+- lib/templates/cucumber/actionwords.hbs
+- lib/templates/cucumber/argument.hbs
+- lib/templates/cucumber/call.hbs
+- lib/templates/cucumber/dataset.hbs
+- lib/templates/cucumber/datatable.hbs
+- lib/templates/cucumber/empty.hbs
+- lib/templates/cucumber/output_config
+- lib/templates/cucumber/parameter.hbs
+- lib/templates/cucumber/single_scenario.hbs
+- lib/templates/cucumber/single_test.hbs
+- lib/templates/cucumber/step.hbs
+- lib/templates/cucumber/stringliteral.hbs
+- lib/templates/cucumber/template.hbs
 - lib/templates/java/_body.hbs
 - lib/templates/java/_item_as_function.hbs
 - lib/templates/java/_scenario.hbs
@@ -483,7 +513,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Export your tests from Hiptest into executable tests.