cuker 0.5.22 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ac8aa67c6c20585405e1596f6280e292b49a4dbab8d3fad111c630143e1f93
-  data.tar.gz: fe355aa257aaf6a07a9966203ee5d16b57c56d6704627bdfc66f31466ac07f74
+  metadata.gz: d4f880c3869c84766c1f1b13faa959ffdeaf3b31416926561d1e23831b5fa3d3
+  data.tar.gz: f2e443c999f42b6699a59763a46e2239682d5af7d340d5fefbabcf3d1f621c79
 SHA512:
-  metadata.gz: 598d17169782a98f1c9166533bd2e2a9f5b6f2d18e717be84f9e9bab22b19b0325b131914f04bc945e23e0d20a97268ed6586d319f6ec88ce4a0dddd9309ce7a
-  data.tar.gz: 352db7d57634271a42485155de68311b15670202c413e59501f98e307ca1ebbb38f70e1f9e10c64603b444794bf8061650a049701441c2d015d9c81120ec0b6e
+  metadata.gz: ecd71bb41d84a324ec204a3287d810755d95d2065b869059e359d69623a9d137016476bbb2af165b893a6745e36f686e15dcb1d63de401253c14a45524a03265
+  data.tar.gz: ab111cea898528d105d23698c1de6edc5c8b470a89a62ec5537e99d829f7ea0bed53fa51d1085a235b6c82b1a4044478d769c3e92ca952dd20f41ba347e5db28

data/cuker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ufo2mstar@gmail.com"]
 
   spec.summary       = %q{Cucumber Summary Gem}
-  spec.description   = %q{generates reports and gives some customizable formatting options}
+  spec.description   = %q{generates reports of your feature files and gives some customizable formatting options}
   spec.homepage      = "https://github.com/ufo2mstar/cuker"
   spec.license       = "MIT"
 
@@ -37,20 +37,26 @@ Gem::Specification.new do |spec|
   # gem.executables   = ["cuker"]
   spec.require_paths = ["lib"]
 
+
+  # https://guides.rubygems.org/specification-reference/
+
+  # Dev Deps
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   # spec.add_development_dependency "rspec", "~> 3.0"
-
-  spec.add_development_dependency "require_all"
   spec.add_development_dependency "awesome_print"
-  spec.add_development_dependency "logging"
 
-  spec.add_development_dependency "gherkin", "~> 5.1"
+  # Runtime Deps
+  spec.add_runtime_dependency "require_all"
+  spec.add_runtime_dependency "logging"
+
+  spec.add_runtime_dependency "gherkin", "~> 5.1"
 
-  # spec.add_development_dependency "thor"
-  spec.add_development_dependency "highline"
+  spec.add_runtime_dependency "rubyXL"
+  # spec.add_runtime_dependency "table_print"
+  spec.add_runtime_dependency "text-table"
 
-  spec.add_development_dependency "rubyXL"
-  # spec.add_development_dependency "table_print"
-  spec.add_development_dependency "text-table"
+  # spec.add_runtime_dependency  "thor"
+  spec.add_runtime_dependency  "highline"
+  spec.add_runtime_dependency  "bindata"
 end

data/lib/cuker/cuker_cmd.rb

@@ -24,17 +24,30 @@ module Cuker
     PRODUCERS[:simple_jira] = [JiraModel, JiraWriter]
     PRODUCERS[:monospaced_jira] = [JiraMonoModel, JiraWriter]
     PRODUCERS[:jira_excel] = [RubyXLModel, RubyXLWriter]
+    PRODUCERS[:summary_excel] = [SummaryXLModel, SummaryXLWriter]
 
     PRESETS = {}
     PRESETS[:jira_package] = [:simple_jira, :jira_excel]
     PRESETS[:jira_text] = [:simple_jira]
     PRESETS[:jira_excel] = [:jira_excel]
+    PRESETS[:testsuite_summary] = [:summary_excel]
 
 
     # 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, feat_path = "../", report_file_name = 'sample_report', report_path_input = ".", log_level = :info
+    def report preset_key,
+               feat_path = "../",
+               report_file_name = 'sample_report',
+               report_path_input = ".",
+               special_tags_list = [
+                   "@uat_done",
+                   "@cmo_done",
+                   "@tech_done",
+                   "@test_done",
+               ],
+               log_level = :info
+
       init_logger log_level
       output_files = []
       producers = PRESETS[preset_key]
@@ -45,13 +58,13 @@ module Cuker
 
       producers.each do |producer|
         report_path = File.join report_path_input, 'reports', LOG_TIME_TODAY
-        msg = "running '#{preset_key.to_s.upcase}' reporter @\n Feature Path: '#{feat_path}' \n Report Path => '#{report_path}' - '#{report_file_name}'\n"
+        msg = "producing '#{producer.to_s.upcase}' report\t @ Report Path => '#{report_path}' - '#{report_file_name}' \t for Feature Files @ '#{feat_path}'\n"
 
         @log.info msg
         puts msg
         model, writer = PRODUCERS[producer]
 
-        preset_model = model.new ast_map
+        preset_model = model == SummaryXLModel ? model.new(ast_map, special_tags_list) : model.new(ast_map)
         preset_writer = writer.new
         grr = GherkinReporter.new preset_writer, preset_model, report_path, report_file_name
 

data/lib/cuker/helpers/formatters/abstract_model.rb

@@ -42,13 +42,6 @@ module Cuker
       @data = []
     end
 
-    def get_values_ary ary_of_hshs
-      get_item_ary ary_of_hshs, :values
-    end
-
-    def get_keys_ary ary_of_hshs
-      get_item_ary ary_of_hshs, :keys
-    end
 
     # utility methods
     # used by any model
@@ -90,10 +83,20 @@ module Cuker
       end
     end
 
+
+    def get_values_ary ary_of_hshs
+      get_item_ary ary_of_hshs, :values
+    end
+
+    def get_keys_ary ary_of_hshs
+      get_item_ary ary_of_hshs, :keys
+    end
+
     private
 
     def get_item_ary ary_of_hshs, item
       ary_of_hshs.map(&item).flatten
     end
+
   end
 end

data/lib/cuker/helpers/formatters/csv_model.rb

@@ -40,7 +40,7 @@ module Cuker
     end
 
     def special_tag_lookup
-      @special_tag_lookup ||= get_keys_ary @special_tag_list if @special_tag_list
+      @special_tags ||= get_keys_ary @special_tag_list if @special_tag_list
     end
 
     def make_title order

data/lib/cuker/helpers/formatters/ruby_x_l_model.rb

@@ -97,7 +97,8 @@ module Cuker
 
     TITLE_MAX_LEN = 60
 
-    EXCEL_BLANK = ''
+    # EXCEL_BLANK = ''
+    EXCEL_BLANK = nil
     EXCEL_TITLE_SEP = '|'
     EXCEL_ROW_SEP = '|'
     EXCEL_EMPTY_LINE = ' '
@@ -145,13 +146,13 @@ module Cuker
       @special_tag_titles ||= get_values_ary @special_tag_list if @special_tag_list
     end
 
-    def special_tag_lookup
-      @special_tag_lookup ||= get_keys_ary @special_tag_list if @special_tag_list
+    def special_tags
+      @special_tags ||= get_keys_ary @special_tag_list if @special_tag_list
     end
 
     def filter_special_tags(all_tags)
-      return [[], all_tags] unless special_tag_lookup
-      ignore_list = all_tags - special_tag_lookup
+      return [[], all_tags] unless special_tags
+      ignore_list = all_tags - special_tags
       select_list = all_tags - ignore_list
       [select_list, ignore_list]
     end
@@ -222,7 +223,7 @@ module Cuker
         children = feat[:children]
         children.each {|child| yield feat_tags, feat_title, child}
       else
-        @log.debug "No Features found in file @ #{@file_path}"
+        @log.warn "No Features found in file @ #{@file_path}"
       end
     end
 

data/lib/cuker/helpers/formatters/summary_x_l_model.rb

@@ -0,0 +1,140 @@
+module Cuker
+  class SummaryXLModel < RubyXLModel
+
+    EXCEL_BLANK = nil
+
+    def initialize ast_map, tags_list
+      init_logger
+
+      @log.trace "initing #{self.class}"
+      @log.debug "has #{ast_map.size} items"
+
+      @asts = ast_map
+
+      @special_tag_list = tags_list
+      # special_tag_titles
+
+      @order = make_order
+      @title = make_title @order
+      @data = make_rows
+    end
+
+    def make_order
+      [
+          {:counter => "Sl.No"},
+          {:s_type => "Type"},
+          {:s_title => "Title"},
+          {:tags => special_tag_titles},
+          {:other_tags => "Other Tags"},
+          {:feature_title => "Feature Title"},
+          {:feature_count => "Feature"},
+          {:bg_title => "Background"},
+          {:file_s_num => "Scen.no"},
+          {:file_name => "File"},
+      ]
+    end
+
+    def make_title order
+      get_values_ary order
+    end
+
+    def special_tag_titles
+      @special_tag_titles ||= @special_tag_list if @special_tag_list
+    end
+
+    def special_tags
+      @special_tags ||= @special_tag_list if @special_tag_list
+    end
+
+    def filter_special_tags(all_tags)
+      return [[], all_tags] unless special_tags
+      ignore_list = all_tags - special_tags
+      select_list = all_tags - ignore_list
+      ordered_list = []
+      special_tag_titles.each {|tag| ordered_list << (select_list.include?(tag) ? tag : EXCEL_BLANK)}
+      [ordered_list, ignore_list, select_list]
+    end
+
+    def make_rows
+      if @asts.nil? or @asts.empty?
+        @log.debug "No asts to parse!"
+        return []
+      end
+
+      feat_counter = 0
+      feature_title = []
+      bg_title = []
+
+      res = []
+      @asts.each do |file_path, ast|
+        @log.debug "Understanding file: #{file_path}"
+        @file_path = file_path
+        in_feat_counter = 0
+
+        if ast[:type] == :GherkinDocument
+          in_feature(ast) do |feat_tags_ary, feat_title, feat_item|
+            feat_counter += 1
+            in_item(feat_item) do |tags_ary, type, item_title, content_ary, example_ary|
+              row_hsh = {}
+              feature_title = feat_title
+              if type == :Background or type == :Feature
+                # bg_title = [excel_title(BACKGROUND, item_title)] + content_ary
+                bg_title = item_title
+              else
+                # if type == :Scenario or type == :ScenarioOutline
+                # scen_title = [excel_title(type.to_s, item_title)] + content_ary
+                scen_title = item_title
+
+                row_hsh[:counter] = feat_counter
+                row_hsh[:s_type] = type == :Scenario ? "S" : "SO"
+                row_hsh[:s_title] = excel_content_format scen_title
+
+                all_tags = [feat_tags_ary, tags_ary].flatten.compact
+                ordered_list, ignore_list, select_list = filter_special_tags(all_tags)
+                row_hsh[:tags] = ordered_list
+                row_hsh[:other_tags] = ignore_list.join ", "
+                row_hsh[:feature_title] = excel_content_format feature_title
+                row_hsh[:bg_title] = excel_content_format bg_title
+                row_hsh[:file_s_num] = in_feat_counter += 1
+                row_hsh[:feature_count] = in_feat_counter == 1 ? 1 : 0
+                row_hsh[:file_name] = file_path
+
+                # row_hsh[:examples] = "" # is nil by default
+                if type == :ScenarioOutline
+                  row_hsh[:examples] = example_count example_ary
+                end
+                row_ary = []
+                get_keys_ary(@order).each do |k|
+                  if k == :tags
+                    # v.each { |tag| row_ary << (tag.nil?? EXCEL_BLANK : tag) }
+                    tags_ary = row_hsh[k]
+                    tags_ary.each {|tag| row_ary << tag}
+                  else
+                    row_ary << (row_hsh[k])
+                  end
+                end
+                res << row_ary
+              end
+              # get_keys_ary(@order).each {|k| row_ary << excel_arg_hilight(row_hsh[k])}
+            end
+            feature_title = []
+            bg_title = []
+          end
+        end
+      end
+      @file_path = nil
+      res
+    end
+
+    def example_count example_ary
+      # [0] title
+      # [1] table = [[0] title [...] examples]
+      # [2] blank
+      sum = []
+      (1..example_ary.size).step(3).each {|i| sum << (example_ary[i].size - 1)}
+      sum.inject('+')
+    end
+
+  end
+
+end

data/lib/cuker/helpers/writers/ruby_x_l_writer.rb

@@ -7,6 +7,7 @@ module Cuker
     def initialize
       @ext = '.xlsm'
       super
+      @template_file_name = "template_excel_jira.xlsm"
       @log.debug "initing #{self.class}"
     end
 
@@ -26,7 +27,7 @@ module Cuker
       @log.debug "rxl make new sheet"
       #todo: dangit! handling this path naming properly
       file_name = "#{name.nil? ? super(name) : name}#{ext}"
-      @book[file_name] = RubyXLFile.new file_name
+      @book[file_name] = RubyXLFile.new file_name, @template_file_name
       @active_file = @book[file_name]
       file_name
     end
@@ -52,12 +53,12 @@ module Cuker
   class RubyXLFile < AbstractFile
     attr_accessor :workbook, :worksheets, :worksheet
 
-    def initialize file_name
+    def initialize file_name, template_file_name
 
       premade = File.basename(file_name) =~ /xlsm/
       # premade = true
       # premade = false
-      template_file_name = "simple_macro_template.xlsm"
+      # template_file_name = "simple_macro_template.xlsm"
       template_file_path = File.join File.dirname(__FILE__), template_file_name
       # template_file_name = './lib/cuker/helpers/writers/simple_macro_template.xlsm'
       # template_file_name = './lib/cuker/helpers/writers/demo_file2.xlsm'

data/lib/cuker/helpers/writers/summary_x_l_writer.rb

@@ -0,0 +1,104 @@
+require_relative 'abstract_writer'
+require 'rubyXL'
+require 'rubyXL/convenience_methods'
+
+module Cuker
+  class SummaryXLWriter < RubyXLWriter
+    def initialize
+      # @ext = '.xlsm'
+      super
+      @template_file_name = "template_excel_summary.xlsm"
+      @log.debug "initing #{self.class}"
+    end
+
+    def make_new_book name
+      @log.debug "summary rxl make new sheet"
+      #todo: dangit! handling this path naming properly
+      file_name = "#{name.nil? ? super(name) : name}#{ext}"
+      @book[file_name] = SummaryRubyXLFile.new file_name, @template_file_name
+      @active_file = @book[file_name]
+      file_name
+    end
+
+    def write model, output_file_path
+      file_name = make_new_file output_file_path
+      write_title model.title
+      model.data.each {|row| write_new_row row}
+      finishup
+      file_name
+    end
+  end
+
+  class SummaryRubyXLFile < RubyXLFile
+    attr_accessor :workbook, :worksheets, :worksheet
+
+    def initialize file_name, template_file_name
+
+      premade = File.basename(file_name) =~ /xlsm/
+      template_file_path = File.join File.dirname(__FILE__), template_file_name
+      @file_name = premade ? template_file_path : file_name
+
+      # super @file_name #replaced below
+      init_logger
+      @name = file_name
+      @rows = []
+
+      @log.debug "Making new #{self.class} => #{@file_name}"
+
+      @workbook = premade ? RubyXL::Parser.parse(@file_name) : RubyXL::Workbook.new
+
+      @worksheets = @workbook.worksheets
+      @worksheet = @workbook['Feature Summary raw']
+
+      @rows = sheet_rows.dup # starting Row
+      @offset = 0 # starting Col
+
+      @file_name = file_name
+    end
+
+    def locate_sheet sheet_name
+      sheet_index = @workbook.worksheets.index {|x| x.sheet_name == sheet_name}
+      @link_sheet = @workbook.worksheets[sheet_index]
+      if sheet_index
+        @log.debug "located sheet #{sheet_name} @location #{sheet_index}"
+        # @workbook.worksheets.delete_at(sheet_index)
+        sheet_index
+      else
+        @log.error "no sheet named '#{sheet_name}' found.. available sheets []"
+        nil
+      end
+    end
+
+    def current_row
+      rows.size - 1
+    end
+
+    def current_col
+      @offset
+    end
+
+    def add_row ary
+      # super ary
+      @rows << ary
+
+      row, col = current_row, current_col
+      worksheet.insert_row(row)
+      ary.each do |val|
+        case val.class.to_s
+        when "String", "Integer", /Nil/
+          worksheet.insert_cell(row, col, val)
+        else
+          @log.error "SummaryRubyXLFile auto stringification of unknown format: #{val.class} => '#{val}'"
+          worksheet.insert_cell(row, col, val.to_s)
+          # worksheet.insert_cell(row, col, val.to_s)
+        end
+        col += 1
+      end
+
+      @log.trace workbook.worksheets.map(&:sheet_name)
+    end
+
+    alias :add_line :add_row
+
+  end
+end

data/lib/cuker/version.rb

@@ -1,3 +1,3 @@
 module Cuker
-  VERSION = "0.5.22"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuker
 version: !ruby/object:Gem::Version
-  version: 0.5.22
+  version: 0.6.5
 platform: ruby
 authors:
 - ufo2mstar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -73,7 +73,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -87,7 +87,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: rubyXL
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubyXL
+  name: text-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,20 +123,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: text-table
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: generates reports and gives some customizable formatting options
+description: generates reports of your feature files and gives some customizable formatting
+  options
 email:
 - ufo2mstar@gmail.com
 executables: []
@@ -166,21 +181,25 @@ files:
 - lib/cuker/helpers/formatters/jira_model.rb
 - lib/cuker/helpers/formatters/jira_mono_model.rb
 - lib/cuker/helpers/formatters/ruby_x_l_model.rb
+- lib/cuker/helpers/formatters/summary_x_l_model.rb
 - lib/cuker/helpers/formatters/title.rb
 - lib/cuker/helpers/gherkin_helper.rb
 - lib/cuker/helpers/string_helper.rb
 - lib/cuker/helpers/writers/abstract_writer.rb
+- lib/cuker/helpers/writers/combos.xlsm
 - lib/cuker/helpers/writers/csv_writer.rb
 - lib/cuker/helpers/writers/jira_writer.rb
 - lib/cuker/helpers/writers/ruby_x_l_writer.rb
-- lib/cuker/helpers/writers/simple_macro_template.xlsm
+- lib/cuker/helpers/writers/summary_x_l_writer.rb
+- lib/cuker/helpers/writers/template_excel_jira.xlsm
+- lib/cuker/helpers/writers/template_excel_summary.xlsm
 - lib/cuker/high.rb
 - lib/cuker/log_utils.rb
-- lib/cuker/test/book1.rb
-- lib/cuker/test/ruby_xl.rb
-- lib/cuker/test/sablon-try.rb
-- lib/cuker/test/template.docx
-- lib/cuker/test/xlsx_500_rows.xlsx
+- lib/cuker/sandbox/book1.rb
+- lib/cuker/sandbox/ruby_xl.rb
+- lib/cuker/sandbox/sablon-try.rb
+- lib/cuker/sandbox/template.docx
+- lib/cuker/sandbox/xlsx_500_rows.xlsx
 - lib/cuker/version.rb
 - reports/.gitignore
 - spec.bat