cuker 0.3.17 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6b1d180c3c6993a9369242cbb2f1f8f5d445b99e9ea053b0b23a1c8b2afa015
-  data.tar.gz: 44f6f7ec50da9849b81c3f12b7149087073781d0bd802dcec5f6f05381a8df66
+  metadata.gz: 0bdf1f98d5596286d2b3f14b542c400255e1a45db25832550b1bfff6ba33ae66
+  data.tar.gz: c14d46c7af705d2f90ab86b32e84c0f6a2875e6db66f7a3bc52d05eb5aba5fc7
 SHA512:
-  metadata.gz: 4242e860043fc50f7321d3dd157d372a12ea7f3b97187d07ddbb6645a71101de9b32ac3acbf2670355e803f3bda2395a388b14e52fa19b9fb24c86dddfb8092f
-  data.tar.gz: 37782b63570653d0115514017671247af1220e777ac54dca1b7940e6adbc0f8223b73cf8f66eb0c3583db2dfb5174b5ea388cc32b073c724105d37dbc9ab4efb
+  metadata.gz: 6bb47ac4ec1d74ff23c6ad8cfe6980e273231c1e9e6c949f6f77ee7f08c84fdf4df5a591bfd8438c0e4686f60d7415f5378da95c90b09cc4a74f7581146ad83d
+  data.tar.gz: 4edf5dde8c2b961809ba439cab9f426d4dcd7879f053bd30b08d8b6acfd390c14657e22a11b9518d1f46888a7d58e35ab3b676b386a9722d460392e21b0632b5

data/lib/cuker/cuker_cmd.rb

@@ -22,12 +22,13 @@ module Cuker
     PRESETS = {
         :simple_csv => [CsvModel, CsvWriter],
         :simple_jira => [JiraModel, JiraWriter],
+        :monospaced_jira => [JiraMonoModel, JiraWriter],
     }
 
     # desc "report PRESET_KEY [FEATURE_PATH [REPORT_PATH [REPORT_FILE_NAME [LOG_LEVEL]]]]",
     #      "reports parsed results into \nREPORT_PATH/REPORT_FILE_NAME \nfor all '*.feature' files in the given FEATURE_PATH\nSTDIO LOG_LEVEL adjustable\n"
 
-    def report preset_key, report_file_name = 'sample_report', feat_path = "../", report_path = ".", log_level = :error
+    def report preset_key, feat_path = "../", report_file_name = 'sample_report', report_path = ".", log_level = :error
       init_logger log_level
       report_path = File.join report_path, 'reports', LOG_TIME_TODAY
 
@@ -43,7 +44,7 @@ module Cuker
       preset_model = model.new ast_map
       preset_writer = writer.new
       grr = GherkinReporter.new preset_writer, preset_model, report_path, report_file_name
-      grr.write
+      File.expand_path grr.write
     end
 
     private

data/lib/cuker/gherkin_reporter.rb

@@ -21,10 +21,10 @@ class GherkinReporter
   end
 
   def write
-    @writer.make_file @file_path
+    file_name = @writer.make_new_file @file_path
     @writer.write_title @model.title
     @model.data.each {|row| @writer.write_new_row row}
-    @file_path
+    file_name
   end
 
   private

data/lib/cuker/high.rb

@@ -5,34 +5,38 @@
 # CLI = HighLine.new
 #
 # DEFAULT_REPORT_FILE_NAME = 'DEFAULT_REPORT_NAME'
-# # DEFAULT_FEATURES_PATH = "../../features/uat/gcm/jira_stories/"
+# # DEFAULT_FEATURES_PATH = "../../features/"
 # DEFAULT_FEATURES_PATH = "."
 # # DEFAULT_REPORT_PATH = './reports'
 #
 # def ask_for_input_location
 #   loc = CLI.ask "\nType your JIRA number:\n"
-#   File.join DEFAULT_FEATURES_PATH, '**', loc
+#   [File.join(DEFAULT_FEATURES_PATH, '**', loc), loc]
 # end
 #
-# def ask_for_output_file_name
-#   name = CLI.ask "\nType your report file name: \n[hit enter to use default name => '#{DEFAULT_REPORT_FILE_NAME}']\n"
-#   name.empty? ? DEFAULT_REPORT_FILE_NAME : name
+# def ask_for_output_file_name default = DEFAULT_REPORT_FILE_NAME
+#   # name = CLI.ask "\nType your report file name: \n[hit enter to use this default name => '#{default}']\n"
+#   name = CLI.ask "\nHit enter to use this default name for your output file => '#{default}'\n[if not, please type in the name you want]\n"
+#   name.empty? ? default : name
 # end
 #
 # def handle_call preset
 #   begin
-#     feat_path = ask_for_input_location
-#     report_name = ask_for_output_file_name
-#     file_name = CCC.report preset, report_name, feat_path
-#     CLI.say("\n\nCreated '#{preset}' @ '#{file_name}' ... Enjoy!\n") if file_name
+#     feat_path, default_file_name = ask_for_input_location
+#     report_name = ask_for_output_file_name("#{preset}_#{default_file_name.empty? ? DEFAULT_REPORT_FILE_NAME : default_file_name}")
+#     file_name = CCC.report preset, feat_path, report_name
+#     CLI.say("\n\nCreated '#{preset}' @ \n'#{file_name}' ... Enjoy!\n") if file_name
 #   rescue Exception
-#     puts "An Error occured\nplease contact NarenSS (v675166) for more details\n"
+#     puts "An Error occured while \nplease contact NarenSS (v675166) for more details\n"
 #     puts e
 #   end
 # end
 #
 # def exit_message
-#   CLI.say("Thank you for using Cuker :)\nFeel free to reach out to NarenSS (v675166) for any feature request\nHave a very good day!")
+#   CLI.say("\nThank you for using Cuker (a Gherkin Reporting Tool) :)\n
+# Have Feature requests or Usage questions?
+# Feel free to reach out to NarenSS (v675166)\n
+# Have a very good day!")
 #   exit
 # end
 #
@@ -50,13 +54,13 @@
 #       end
 #     end
 #
-#     menu.choice(:quit) {exit_message}
+#     menu.choice(:quit) { exit_message }
 #     menu.default = :quit
 #   end
 #
-#   answer = CLI.ask "\nWant to rerun? \n[ type anything and hit enter to rerun\nor just hit enter to quit this program ]\n"
-#   break if answer.empty?
+#   answer = CLI.agree "\nWant to rerun? \n y [n]\n"
+#   break unless answer
 #   puts "\n... rebooting ...\n\n"
 # end
 #
-# exit_message
+# exit_message

data/lib/cuker/version.rb

@@ -1,3 +1,3 @@
 module Cuker
-  VERSION = "0.3.17"
+  VERSION = "0.4.0"
 end

data/lib/cuker/writer_helper/abstract_model.rb

@@ -4,7 +4,7 @@ module IModel
   method :write_title
   method :write_new_row
 
-  method :make_file
+  method :make_new_file
   method :write_new_sheet
 end
 
@@ -34,18 +34,17 @@ class AbstractModel
     ary_of_hshs.map(&:keys).flatten
   end
 
-#   utility methods
-# used by any model
+  # utility methods
+  # used by any model
 
   def name_merge hsh
     str = ""
     @log.warn "name merge for #{hsh}"
     str += hsh[:name].strip.force_encoding("UTF-8") if hsh[:name]
-    str += " - #{hsh[:description].strip.force_encoding("UTF-8")}" if hsh[:description]
+    str += "\n#{hsh[:description].strip.force_encoding("UTF-8")}" if hsh[:description]
     str
   end
 
-
   def union feat_tags, tags
     (feat_tags.to_set | tags.to_set).to_a # union
   end
@@ -56,8 +55,8 @@ class AbstractModel
     simple_surround ary.join(sep), sep
   end
 
-  def simple_surround item, sep
-    "#{sep}#{item}#{sep}"
+  def simple_surround item, sep, r_sep = nil
+    "#{sep}#{item}#{r_sep || sep}"
   end
 
   # def padded_surround item, sep, pad

data/lib/cuker/writer_helper/abstract_writer.rb

@@ -4,7 +4,7 @@ module IWriter
   method :write_title
   method :write_new_row
 
-  method :make_file
+  method :make_new_file
   method :write_new_sheet
 end
 
@@ -14,7 +14,12 @@ class AbstractWriter
 
   NoNewFileMadeError = Class.new IOError
 
+  # File Extension
   attr_accessor :ext
+
+  # Active file name
+  attr_accessor :active_file_name
+
   attr_accessor :sheets, :active_sheet
   attr_reader :out_dir
 
@@ -36,18 +41,28 @@ class AbstractWriter
   end
 
   def raise_unless_active_loc data
-    raise NoNewFileMadeError.new "Please run 'make_file' before trying to write: '#{data}'" if @active_sheet.nil?
+    raise NoNewFileMadeError.new "Please run 'make_new_file' before trying to write: '#{data}'" if @active_sheet.nil?
   end
 
   def make_new_sheet name = nil
-    file_name = name.nil? ? "Sheet_#{@sheets.size + 1}" : name
-    @log.debug "make a new abstract sheet: #{file_name}"
-    file_name
-    # todo: file name collision handle
+    sheet = new_name name
+    @log.debug "make a new abstract sheet: #{sheet}"
+    sheet
+    # todo: file name collision handle!!
+  end
+
+  def make_new_file name
+    @log.debug "make a new abstract file: #{name}#{@ext}"
+    make_name name
   end
 
-  def make_file name
-    @log.debug "make a new abstract file: #{name}"
+  # @return [String] name with ext path added
+  def make_name name
+    "#{new_name name}#{@ext}"
+  end
+
+  def new_name name
+    name.nil? ? "Sheet_#{@sheets.size + 1}" : name
   end
 end
 
@@ -68,6 +83,7 @@ class AbstractSheet
   def add_row ary
     @rows << ary
   end
+
   alias :add_line :add_row
 
   # @return ary of rows

data/lib/cuker/writer_helper/csv_writer.rb

@@ -21,13 +21,15 @@ class CsvWriter < AbstractWriter
 
   def make_new_sheet name
     @log.debug "csv make new sheet"
-    path = super name
-    @sheets[path] = CsvSheet.new path, @ext
-    @active_sheet = @sheets[path]
+    #todo: dangit! handling this path naming properly
+    file_name = "#{name.nil? ? super(name) : name}#{ext}"
+    @sheets[file_name] = CsvSheet.new file_name
+    @active_sheet = @sheets[file_name]
+    file_name
   end
 
-  def make_file name
-    super name
+  def make_new_file name
+    path = super name
     make_new_sheet name
   end
 end
@@ -38,8 +40,7 @@ require 'csv'
 # {file:https://docs.ruby-lang.org/en/2.1.0/CSV.html CSV usage documentation}
 
 class CsvSheet < AbstractSheet
-  def initialize path, ext
-    file_name = "#{path}#{ext}"
+  def initialize file_name
     super file_name
     @csv_sheet = CSV.open(file_name, "wb")
   end

data/lib/cuker/writer_helper/jira_model.rb

@@ -3,14 +3,23 @@ module Cuker
   class JiraModel < AbstractModel
     include LoggerSetup
 
+    JIRA_BLANK = ' '
+    JIRA_TITLE_SEP = '||'
+    JIRA_ROW_SEP = '|'
+    JIRA_EMPTY_LINE = '(empty line)'
+    JIRA_NEW_LINE = '\\\\'
+    JIRA_HORIZ_RULER = '----'
+
     JIRA_ICONS = {
         info: "(i)",
         pass: "(/)",
         fail: "(x)",
         exclam: "(!)",
         question: "(?)",
+        empty: JIRA_BLANK
     }
 
+
     def initialize ast_map
       super
       @log.trace "initing #{self.class}"
@@ -55,34 +64,41 @@ module Cuker
       @asts.each do |file_path, ast|
         @file_path = file_path
         in_feat_counter = 0
+        @feat_printed = false
         if ast[:type] == :GherkinDocument
           in_feature(ast) do |feat_tags_ary, feat_title, feat_item|
             in_item(feat_item) do |tags_ary, title, type, content_ary|
               row_hsh = {}
-              if type == :Background
+              if type == :Background or type == :Feature
+                @feat_printed = true
+                title_str = ''
+                # feat handle
+                title_str += jira_title 'Feature', feat_title
+                title_str += jira_title('Background', title) if title
                 row_hsh = {
                     :s_num => "#{feat_counter}",
-                    :s_title => "Feature: #{feat_title}\nBackground: #{title}",
+                    :s_title => surround_panel(title_str),
                     :s_content => surround_panel(content_ary.join("\n")),
                     :item => simple_surround(JIRA_ICONS[:empty], '|'),
                 }
               elsif type == :Scenario or type == :ScenarioOutline
                 row_hsh = {
                     :s_num => "#{feat_counter}.#{in_feat_counter += 1}",
-                    :s_title => title,
+                    :s_title => surround_panel(jira_title(type, title)),
                     :s_content => surround_panel(content_ary.join("\n")),
-                    :item => simple_surround(JIRA_ICONS[type == :ScenarioOutline ? :info : :exclam], '|'),
+                    # :item => simple_surround(JIRA_ICONS[type == :ScenarioOutline ? :info : :exclam], '|'),
+                    :item => simple_surround(JIRA_ICONS[:info], '|'),
                 }
               elsif type == :Examples
                 row_hsh = {
                     :s_num => "#{feat_counter}.#{in_feat_counter}.x",
-                    :s_title => title, # example title
+                    :s_title => surround_panel(jira_title(type, title)), # example title
                     :s_content => surround_panel(content_ary.join("\n")),
                     :item => simple_surround(JIRA_ICONS[:info], '|'),
                 }
               end
               row_ary = []
-              get_keys_ary(@order).each {|k| row_ary << row_hsh[k]}
+              get_keys_ary(@order).each {|k| row_ary << jira_arg_hilight(row_hsh[k])}
               res << surround(row_ary, '|')
             end
           end
@@ -112,6 +128,9 @@ module Cuker
       tags = get_tags child
       if child[:type] == :Background
         yield tags, item_title, child[:type], get_steps(child)
+      elsif !@feat_printed
+        yield [], JIRA_BLANK, :Feature, [JIRA_BLANK]
+        yield tags, item_title, child[:type], get_steps(child)
       elsif child[:type] == :Scenario
         yield tags, item_title, child[:type], get_steps(child)
       elsif child[:type] == :ScenarioOutline
@@ -141,9 +160,9 @@ module Cuker
       res = []
       examples.each do |example|
         if example[:type] == :Examples
-          res << " "
+          res << JIRA_HORIZ_RULER
 
-          eg_title = "Examples: #{name_merge(example)}"
+          eg_title = jira_title 'Examples', name_merge(example)
           res << eg_title
 
           eg_header = surround(in_table_row(example[:tableHeader]), '||')
@@ -170,9 +189,11 @@ module Cuker
 
     def in_table_cell cell_hsh
       if cell_hsh[:type] == :TableCell
-        cell_hsh[:value]
+        val = cell_hsh[:value].strip
+        val.empty? ? JIRA_BLANK : val
       else
         @log.warn "Expected :TableCell in #{cell_hsh} @ #{@file_path}"
+        JIRA_BLANK
       end
     end
 
@@ -180,10 +201,14 @@ module Cuker
       steps.each do |step|
         if step[:type] == :Step
           step_ary = []
-          step_ary << [
-              "*#{step[:keyword].strip}*", # bolding the keywords
-              step[:text].strip
-          ].join(" ")
+          step_str = [
+              ((jira_bold(step[:keyword].strip)).rjust(7)), # bolding the keywords
+              (step[:text].strip)
+          ].join(' ')
+
+          # step_ary << jira_monospace(step_str)
+          step_ary << (step_str)
+
           step_ary += in_step_args(step[:argument]) if step[:argument]
           # todo: padding as needed
           yield step_ary
@@ -193,6 +218,7 @@ module Cuker
       end
     end
 
+    # helps handle tables for now
     def in_step_args arg
       if arg[:type] == :DataTable
         res = []
@@ -218,5 +244,36 @@ module Cuker
       end
     end
 
+    def surround_color str, color = nil
+      if title
+        "{color:#{color}} #{str} {color}"
+      else
+        "{color} #{str} {color}"
+      end
+    end
+
+    def jira_title keyword, title
+      "#{jira_bold "#{keyword}:"} #{title}\n "
+    end
+
+    def jira_arg_hilight(str)
+      str.gsub(/<(.*)>/, jira_bold_italics('<\1>'))
+    end
+
+    def jira_bold str
+      simple_surround str, '*'
+    end
+
+    def jira_monospace str
+      simple_surround str, '{{', '}}'
+    end
+
+    def jira_bold_italics(str)
+      jira_bold(jira_italics(str))
+    end
+
+    def jira_italics(str)
+      simple_surround(str, '_')
+    end
   end
 end

data/lib/cuker/writer_helper/jira_mono_model.rb

@@ -0,0 +1,60 @@
+require_relative 'abstract_writer'
+module Cuker
+  class JiraMonoModel < JiraModel
+    include LoggerSetup
+
+    def in_table_cell cell_hsh
+      if cell_hsh[:type] == :TableCell
+        val = cell_hsh[:value].strip
+        val.empty? ? JIRA_BLANK : jira_monospace(val)
+      else
+        @log.warn "Expected :TableCell in #{cell_hsh} @ #{@file_path}"
+        JIRA_BLANK
+      end
+    end
+
+    def in_step(steps)
+      steps.each do |step|
+        if step[:type] == :Step
+          step_ary = []
+          step_str = [
+              (jira_monospace(jira_bold(step[:keyword].strip)).rjust(11)), # bolding the keywords
+              jira_monospace(step[:text].strip)
+          ].join(' ')
+
+          # step_ary << jira_monospace(step_str)
+          step_ary << (step_str)
+
+          step_ary += in_step_args(step[:argument]) if step[:argument]
+          # todo: padding as needed
+          yield step_ary
+        else
+          @log.warn "Unknown type '#{item[:type]}' found in file @ #{@file_path}"
+        end
+      end
+    end
+
+    # helps handle tables for now
+    def in_step_args arg
+      if arg[:type] == :DataTable
+        res = []
+        arg[:rows].each_with_index do |row, i|
+          sep = i == 0 ? '||' : '|'
+          res << surround(row[:cells].map {|hsh| jira_monospace(hsh[:value])}, sep)
+        end
+        return res
+      elsif arg[:type] == :DocString
+        # todo: handle if needed
+        @log.warn "Docstrings found in '#{arg}' found in file @ #{@file_path}"
+      else
+        @log.warn "Unknown type '#{arg[:type]}' found in file @ #{@file_path}"
+      end
+      []
+    end
+
+    def jira_monospace str
+      simple_surround str, '{{', '}}'
+    end
+
+  end
+end

data/lib/cuker/writer_helper/jira_writer.rb

@@ -22,26 +22,26 @@ class JiraWriter < AbstractWriter
   def make_new_sheet name = nil
     @log.debug "JW make new sheet"
     path = super name
-    @sheets[path] = JiraFile.new path, @ext
-    @active_sheet = @sheets[path]
+    path
   end
 
-  def make_file name
-    super name
-    make_new_sheet name
+  def make_new_file name
+    path = super name
+    @sheets[path] = JiraFile.new path
+    @active_sheet = @sheets[path]
+    path
   end
 end
 
 class JiraFile < AbstractSheet
-  def initialize path, ext
-    file_name = "#{path}#{ext}"
+  def initialize file_name
     super file_name
-    @csv_sheet = File.open(file_name, "wb")
+    @jira_file = File.open(file_name, "wb")
   end
 
   def add_line line
     super line
-    @log.warn "argument not a String.. instead is a '#{line.class}' -> '#{line}'" unless line.is_a? String
+    @log.error "argument not a String.. instead is a '#{line.class}' -> '#{line}'" unless line.is_a? String
     File.open(@name, "ab") do |file|
       file << "#{line}\n"
     end

data/lib/cuker/writer_helper/ruby_x_l_writer.rb

@@ -22,7 +22,7 @@ class RubyXLWriter < AbstractWriter
     @sheets[name] = RubyXLSheet.new path
   end
 
-  def make_file name
+  def make_new_file name
     super name
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuker
 version: !ruby/object:Gem::Version
-  version: 0.3.17
+  version: 0.4.0
 platform: ruby
 authors:
 - ufo2mstar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,6 +183,7 @@ files:
 - lib/cuker/writer_helper/csv_model.rb
 - lib/cuker/writer_helper/csv_writer.rb
 - lib/cuker/writer_helper/jira_model.rb
+- lib/cuker/writer_helper/jira_mono_model.rb
 - lib/cuker/writer_helper/jira_writer.rb
 - lib/cuker/writer_helper/ruby_x_l_writer.rb
 - lib/cuker/writer_helper/title.rb