hiptest-publisher 1.9.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dd144d9f192a260569659d26360bf10a0c34992
-  data.tar.gz: 30d6081b77bd1226a55eff65398ea20a48ceeafd
+  metadata.gz: 1056cc45510dac48067122241a68934a61085bda
+  data.tar.gz: 4f3138eeb3df795a6ac4dd5b45187657b35e80ee
 SHA512:
-  metadata.gz: 4cf3971eea3f78f5ac5eee01e6c8faf6963e658374f84ab65f674e9f7aabaea9167b99b8e0b6506ee8e0e21929eaab054510d5c426dd8d5e3f2b11427e6828ce
-  data.tar.gz: d77ea86b848d94276ecc5bc37313755a1206acca9464b02ae2a087ffba9f12f75e64a17a4d1e3c9c10489e53325c7c5a28a17d5343f9c32ee47e1fd1325b3b56
+  metadata.gz: ae34a4ca108dcd3c0bfabd34f6369ef1ff52766e2f60d8c9479dbcad15dba913881638f2b5408ccb3fffc1d4b3566c81e530ca2b222b625182a15c1b1db43e9d
+  data.tar.gz: 7df5447feb46498086727bdbc5cec26358b3da6fc3644f72cc52b2a10f1483f16e6ee8c5bf8f144755a099fb1b0b2bddb782fff8275976540b9414258a11525b

data/lib/hiptest-publisher.rb

@@ -7,6 +7,7 @@ require 'hiptest-publisher/call_arguments_adder'
 require 'hiptest-publisher/cli_options_checker'
 require 'hiptest-publisher/client'
 require 'hiptest-publisher/datatable_fixer'
+require 'hiptest-publisher/diff_displayer'
 require 'hiptest-publisher/formatters/reporter'
 require 'hiptest-publisher/gherkin_adder'
 require 'hiptest-publisher/handlebars_helper'
@@ -21,7 +22,6 @@ require 'hiptest-publisher/string'
 require 'hiptest-publisher/utils'
 require 'hiptest-publisher/xml_parser'
 
-
 module Hiptest
   class Publisher
     attr_reader :reporter
@@ -179,7 +179,7 @@ module Hiptest
       ) { Hiptest::SignatureExporter.export_actionwords(@project).to_yaml }
     end
 
-    def show_actionwords_diff
+    def compute_actionwords_diff
       old = nil
       reporter.with_status_message "Loading previous definition" do
         old = YAML.load_file("#{@cli_options.output_directory}/actionwords_signature.yaml")
@@ -189,101 +189,14 @@ module Hiptest
 
       current = Hiptest::SignatureExporter.export_actionwords(@project, true)
       diff =  Hiptest::SignatureDiffer.diff( old, current)
+    end
 
-      if @cli_options.aw_deleted
-        return if diff[:deleted].nil?
-
-        diff[:deleted].map {|deleted|
-          puts @language_config.name_action_word(deleted[:name])
-        }
-        return
-      end
-
-      if @cli_options.aw_created
-        print_updated_aws(diff[:created])
-        return
-      end
-
-      if @cli_options.aw_renamed
-        return if diff[:renamed].nil?
-
-        diff[:renamed].map {|renamed|
-          puts "#{@language_config.name_action_word(renamed[:name])}\t#{@language_config.name_action_word(renamed[:new_name])}"
-        }
-        return
-      end
-
-      if @cli_options.aw_signature_changed
-        print_updated_aws(diff[:signature_changed])
-        return
-      end
-
-      if @cli_options.aw_definition_changed
-        print_updated_aws(diff[:definition_changed])
-        return
-      end
-
-      command_line = @cli_options.command_line_used(exclude: [:actionwords_diff])
-
-      unless diff[:deleted].nil?
-        puts "#{pluralize(diff[:deleted].length, "action word")} deleted,"
-        puts "run '#{command_line} --show-actionwords-deleted' to list the #{pluralize_word(diff[:deleted].length, "name")} in the code"
-        puts diff[:deleted].map {|d| "- #{d[:name]}"}.join("\n")
-        puts ""
-      end
-
-      unless diff[:created].nil?
-        puts "#{pluralize(diff[:created].length, "action word")} created,"
-        puts "run '#{command_line} --show-actionwords-created' to get the #{pluralize_word(diff[:created].length, "definition")}"
-
-        puts diff[:created].map {|c| "- #{c[:name]}"}.join("\n")
-        puts ""
-      end
-
-      unless diff[:renamed].nil?
-        puts "#{pluralize(diff[:renamed].length, "action word")} renamed,"
-        puts "run '#{command_line} --show-actionwords-renamed' to get the new #{pluralize_word(diff[:renamed].length, "name")}"
-        puts diff[:renamed].map {|r| "- #{r[:name]} => #{r[:new_name]}"}.join("\n")
-        puts ""
-      end
-
-      unless diff[:signature_changed].nil?
-        puts "#{pluralize(diff[:signature_changed].length, "action word")} which signature changed,"
-        puts "run '#{command_line} --show-actionwords-signature-changed' to get the new #{pluralize_word(diff[:signature_changed].length, "signature")}"
-        puts diff[:signature_changed].map {|c| "- #{c[:name]}"}.join("\n")
-        puts ""
-      end
-
-      unless diff[:definition_changed].nil?
-        puts "#{pluralize(diff[:definition_changed].length, "action word")} which definition changed:"
-        puts "run '#{command_line} --show-actionwords-definition-changed' to get the new #{pluralize_word(diff[:definition_changed].length, "definition")}"
-        puts diff[:definition_changed].map {|c| "- #{c[:name]}"}.join("\n")
-        puts ""
-      end
-
-      if diff.empty?
-        puts "No action words changed"
-        puts ""
-      end
+    def show_actionwords_diff
+      Hiptest::DiffDisplayer.new(compute_actionwords_diff, @cli_options, @language_config).display
     rescue Exception => err
       reporter.dump_error(err)
     end
 
-    def print_updated_aws(actionwords)
-        return if actionwords.nil?
-
-        @language_config.language_group_configs.select { |language_group_config|
-          language_group_config[:group_name] == "actionwords"
-        }.each do |language_group_config|
-          actionwords.each do |actionword|
-            node_rendering_context = language_group_config.build_node_rendering_context(actionword[:node])
-            puts actionword[:node].render(node_rendering_context)
-            puts ""
-          end
-        end
-        return
-    end
-
     def analyze_project_data
       return if @project_data_analyzed
       reporter.with_status_message "Analyzing data" do

data/lib/hiptest-publisher/diff_displayer.rb

@@ -0,0 +1,177 @@
+module Hiptest
+  class DiffDisplayer
+    def initialize(diff, cli_options, language_config)
+      @diff = diff
+      @cli_options = cli_options
+      @language_config = language_config
+    end
+
+    def display
+      return display_as_json if @cli_options.actionwords_diff_json
+      return display_deleted if @cli_options.aw_deleted
+      return display_created if @cli_options.aw_created
+      return display_renamed if @cli_options.aw_renamed
+      return display_signature_changed if @cli_options.aw_signature_changed
+      return display_definition_changed if @cli_options.aw_definition_changed
+
+      display_summary
+    end
+
+    def display_created
+      return display_skeletons(@diff[:created])
+    end
+
+    def display_renamed
+      return if @diff[:renamed].nil?
+
+      output(@diff[:renamed].map {|renamed|
+        "#{@language_config.name_action_word(renamed[:name])}\t#{@language_config.name_action_word(renamed[:new_name])}"
+      })
+    end
+
+    def display_signature_changed
+      display_skeletons(@diff[:signature_changed])
+    end
+
+    def display_definition_changed
+      display_skeletons(@diff[:definition_changed])
+    end
+
+    def display_deleted
+      return if @diff[:deleted].nil?
+
+      output(@diff[:deleted].map {|deleted|
+        @language_config.name_action_word(deleted[:name])
+      })
+    end
+
+    def display_as_json
+      output(JSON.pretty_generate(as_api))
+    end
+
+    def as_api
+      data = {}
+
+      data[:deleted] = @diff[:deleted].map {|aw|
+        {
+          name: aw[:name],
+          name_in_code: @language_config.name_action_word(aw[:name])
+        }
+      } unless @diff[:deleted].nil?
+
+      data[:created] = @diff[:created].map {|aw|
+        {
+          name: aw[:name],
+          skeleton: actionword_skeleton(aw)
+        }
+      } unless @diff[:created].nil?
+
+      data[:renamed] = @diff[:renamed].map {|aw|
+        {
+          name: aw[:name],
+          old_name: @language_config.name_action_word(aw[:name]),
+          new_name: @language_config.name_action_word(aw[:new_name])
+        }
+      } unless @diff[:renamed].nil?
+
+      data[:signature_changed] = @diff[:signature_changed].map {|aw|
+        {
+          name: aw[:name],
+          skeleton: actionword_skeleton(aw)
+        }
+      } unless @diff[:signature_changed].nil?
+
+
+      data[:definition_changed] = @diff[:definition_changed].map {|aw|
+        {
+          name: aw[:name],
+          skeleton: actionword_skeleton(aw)
+        }
+      } unless @diff[:definition_changed].nil?
+
+      return data
+    end
+
+    def display_summary
+      command_line = @cli_options.command_line_used(exclude: [:actionwords_diff])
+
+      unless @diff[:deleted].nil?
+        output([
+          "#{pluralize(@diff[:deleted].length, "action word")} deleted,",
+          "run '#{command_line} --show-actionwords-deleted' to list the #{pluralize_word(@diff[:deleted].length, "name")} in the code",
+          displayable_list(@diff[:deleted])
+        ])
+      end
+
+      unless @diff[:created].nil?
+        output([
+          "#{pluralize(@diff[:created].length, "action word")} created,",
+          "run '#{command_line} --show-actionwords-created' to get the #{pluralize_word(@diff[:created].length, "definition")}",
+          displayable_list(@diff[:created])
+        ])
+      end
+
+      unless @diff[:renamed].nil?
+        output([
+          "#{pluralize(@diff[:renamed].length, "action word")} renamed,",
+          "run '#{command_line} --show-actionwords-renamed' to get the new #{pluralize_word(@diff[:renamed].length, "name")}",
+          displayable_list(@diff[:renamed])
+        ])
+      end
+
+      unless @diff[:signature_changed].nil?
+        output([
+          "#{pluralize(@diff[:signature_changed].length, "action word")} which signature changed,",
+          "run '#{command_line} --show-actionwords-signature-changed' to get the new #{pluralize_word(@diff[:signature_changed].length, "signature")}",
+          displayable_list(@diff[:signature_changed])
+        ])
+      end
+
+      unless @diff[:definition_changed].nil?
+        output([
+          "#{pluralize(@diff[:definition_changed].length, "action word")} which definition changed:",
+          "run '#{command_line} --show-actionwords-definition-changed' to get the new #{pluralize_word(@diff[:definition_changed].length, "definition")}",
+          displayable_list(@diff[:definition_changed])
+        ])
+      end
+
+      if @diff.empty?
+        output("No action words changed")
+      end
+    end
+
+    private
+
+    def output(lines, add_empty_line: true)
+      lines = [lines] unless lines.is_a? Array
+
+      puts lines.join("\n")
+      puts "" if add_empty_line
+    end
+
+    def displayable_list(actionwords)
+      actionwords.map {|c| "- #{c[:name]}"}.join("\n")
+    end
+
+    def actionword_skeleton(actionword)
+      return if actionwords_group_config.nil?
+
+      node_rendering_context = actionwords_group_config.build_node_rendering_context(actionword[:node])
+      actionword[:node].render(node_rendering_context)
+    end
+
+    def display_skeletons(actionwords)
+      return if actionwords.nil?
+
+      actionwords.each do |actionword|
+        output(actionword_skeleton(actionword))
+      end
+    end
+
+    def actionwords_group_config
+      @actionwords_group_config ||= @language_config.language_group_configs.select { |language_group_config|
+        language_group_config[:group_name] == "actionwords"
+      }.first
+    end
+  end
+end

data/lib/hiptest-publisher/options_parser.rb

@@ -7,6 +7,8 @@ require 'pathname'
 require 'hiptest-publisher/formatters/console_formatter'
 require 'hiptest-publisher/renderer_addons'
 require 'hiptest-publisher/utils'
+require 'hiptest-publisher/handlebars_helper'
+
 
 class FileConfigParser
   FALSY_VALUE_PATTERN = /\A(false|no|0)\Z/i
@@ -90,11 +92,12 @@ class CliOptions < OpenStruct
     hash ||= {}
     hash[:language] ||= ""
     hash[:framework] ||= ""
+
     super(__cli_args: Set.new, __config_args: Set.new, **hash)
   end
 
   def actionwords_diff?
-    actionwords_diff || aw_deleted || aw_created || aw_renamed || aw_signature_changed || aw_definition_changed
+    actionwords_diff || actionwords_diff_json || aw_deleted || aw_created || aw_renamed || aw_signature_changed || aw_definition_changed
   end
 
   def push?
@@ -218,6 +221,7 @@ class OptionsParser
       Option.new(nil, 'actionwords-only', false, nil, "(deprecated) alias for --only=actionwords", :actionwords_only),
       Option.new(nil, 'actionwords-signature', false, nil, "Export actionwords signature", :actionwords_signature),
       Option.new(nil, 'show-actionwords-diff', false, nil, "Show actionwords diff since last update (summary)", :actionwords_diff),
+      Option.new(nil, 'show-actionwords-diff-as-json', false, nil, "Show actionwords diff since last update (JSON output)", :actionwords_diff_json),
       Option.new(nil, 'show-actionwords-deleted', false, nil, "Output signature of deleted action words", :aw_deleted),
       Option.new(nil, 'show-actionwords-created', false, nil, "Output code for new action words", :aw_created),
       Option.new(nil, 'show-actionwords-renamed', false, nil, "Output signatures of renamed action words", :aw_renamed),
@@ -679,11 +683,15 @@ class LanguageConfigParser
   end
 
   def name_action_word(name)
-    name.send(@config['actionwords']['naming_convention'])
+    name.send(get_key_from_group('actionwords', 'naming_convention'))
   end
 
   private
 
+  def get_key_from_group(group, key)
+    @config[group][key] || @config['_common'][key]
+  end
+
   def group_config(group_name)
     if @config[group_name]
       key_values = @config[group_name].map { |key, value| [key.to_sym, value] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiptest-publisher
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Hiptest R&D
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -252,6 +252,7 @@ files:
 - lib/hiptest-publisher/cli_options_checker.rb
 - lib/hiptest-publisher/client.rb
 - lib/hiptest-publisher/datatable_fixer.rb
+- lib/hiptest-publisher/diff_displayer.rb
 - lib/hiptest-publisher/formatters/console_formatter.rb
 - lib/hiptest-publisher/formatters/reporter.rb
 - lib/hiptest-publisher/gherkin_adder.rb
@@ -626,7 +627,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Export your tests from Hiptest into executable tests.