cuker 0.5.7 → 0.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94bf544c652ce97b7c985b1f4b0c4bec9905a19f37e9dc7ec76df6970c741470
-  data.tar.gz: 7778dfbbd84ec0d4ee0311a9c9f213a9c6bde4b2cfc5e753aa284e35ef3a671c
+  metadata.gz: 53ee9df71c45ebfe470bc55fac4b042237a53a5bbc13b54f0626d0aa79f157f2
+  data.tar.gz: 9dbb308de7cade288292180fec03a0eeaa5e7cd1d615b1ba05eb574d988da6a2
 SHA512:
-  metadata.gz: e75c2b294daf52c8aaeba9a258ce283124794e578fc7dff16c9614898c7b92917c9f959c256c0cc9e86809784059070692d7859f47b52990297c521796e668b6
-  data.tar.gz: 83962be132951c6af897e680da9dd1a33b590ca51adcd0d5302b562876b65e572f07551f41faf722a49463be2fea7a709fe022e97b0a41837d935d74e9f50252
+  metadata.gz: d2eff443de2f3ae8d757c8b15abb6ef286dd70561fc0f07e0e16460d5b425772a99533fe9b5e9f8fa62da81ce49e047e975e16c38ace3866128d00b893261cd3
+  data.tar.gz: 2379c423926e94ea62c6fa07da8e1dbf2fc80da5bae39989ba76a9323b1d7bae1a1484cb6a7390969136f3b9f9bde6785cf9b963150c0b1268c4d547a20e2dad

data/Gemfile

@@ -11,5 +11,6 @@ group :test do
 end
 
 # core
-
+# gem "table_print"
+# gem "text-table"
 # ext

data/cuker.gemspec

@@ -51,5 +51,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "highline"
 
   spec.add_development_dependency "rubyXL"
-
+  # spec.add_development_dependency "table_print"
+  spec.add_development_dependency "text-table"
 end

data/lib/cuker/gherkin_reporter.rb

@@ -21,9 +21,11 @@ class GherkinReporter
   end
 
   def write
+    # todo: why don't we just give the writer the model?
     file_name = @writer.make_new_file @file_path
     @writer.write_title @model.title
     @model.data.each {|row| @writer.write_new_row row}
+    @writer.finishup
     file_name
   end
 

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

@@ -169,8 +169,8 @@ module Cuker
           eg_header = surround(in_table_row(example[:tableHeader]), '||')
           res << eg_header
 
-          eg_rows = example[:tableBody]
-          eg_rows.map {|row_hsh| res << surround(in_table_row(row_hsh), '|')}
+          eg_body = example[:tableBody]
+          eg_body.map {|row_hsh| res << surround(in_table_row(row_hsh), '|')}
 
         else
           @log.warn "Unknown type '#{item[:type]}' found in file @ #{@file_path}"

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

@@ -2,6 +2,7 @@ require_relative '../writers/abstract_writer'
 
 module Cuker
   module ExcelSupport
+    EXCEL_BLANK = ''
 
     def surround_panel str, title = nil
       if title
@@ -19,8 +20,13 @@ module Cuker
       end
     end
 
-    def excel_title keyword, title
-      "#{excel_bold "#{keyword}:"}\n #{title}\n "
+    def excel_content_format ary
+      ary.join "\n"
+    end
+
+    def excel_title keyword, title_ary
+      # "#{excel_bold "#{keyword}:"}\n #{title}\n "
+      [excel_bold("#{keyword}:")] + title_ary
     end
 
     def excel_arg_hilight(str)
@@ -86,14 +92,6 @@ module Cuker
 
     def make_order
       [
-          # {:counter => "Sl.No"},
-          # {:feature_title => "Feature"},
-          # {:s_type => "Type"},
-          # {:s_title => "Title"},
-          # {:tags => special_tag_titles},
-          # {:file_s_num => "S.no"},
-          # {:file_name => "File"},
-          # {:other_tags => "Tags"},
           {:counter => "Sl.No"},
           {:feature => "Feature"},
           {:background => "Background"},
@@ -102,8 +100,8 @@ module Cuker
           {:result => "Result"},
           {:tested_by => "Tested By"},
           {:test_designer => "Test Designer"},
+          {:comments => "Comments"},
       ]
-
 # todo: make title order reorderable
 # todo: tag based reordering
     end
@@ -134,68 +132,47 @@ module Cuker
       end
 
       feat_counter = 1
-
       feat_content = ''
       bg_content = ''
 
       res = []
       @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, example_ary|
-
+            in_item(feat_item) do |tags_ary, type, item_title, content_ary, example_ary|
               row_hsh = {}
-
               if type == :Background or type == :Feature
-
-                # @feat_printed = true
-
-                title_str = ''
-                # feat handle
-                title_str += excel_title 'Feature', feat_title
-                # title_str += excel_title('Background', title) if type == :Background
-                row_hsh = {
-                    # :s_num => "#{feat_counter}",
-                    # :s_title => surround_panel(title_str),
-                    # :s_content => surround_panel(content_ary.join("\n")),
-                    # :item => simple_surround(EXCEL_ICONS[:empty], '|'),
-                }
-                feat_content = "Feature:\n#{title_str}"
-                bg_content = content_ary.join("\n")
-              elsif type == :Scenario or type == :ScenarioOutline
-                # row_hsh = {
-                # :s_num => "#{feat_counter}.#{in_feat_counter += 1}",
-                # :s_title => surround_panel(excel_title(type, title)),
-                # :s_content => surround_panel(content_ary.join("\n")),
-                # # :item => simple_surround(EXCEL_ICONS[type == :ScenarioOutline ? :info : :exclam], '|'),
-                # :item => simple_surround(EXCEL_ICONS[:info], '|'),
+                feat_content = excel_title FEATURE, feat_title
+                bg_content = [excel_title(BACKGROUND, item_title)] + content_ary
+              else
+                # if type == :Scenario or type == :ScenarioOutline
+                scen_content = [excel_title(type.to_s, item_title)] + content_ary
 
                 row_hsh[:counter] = "#{feat_counter}.#{in_feat_counter += 1}"
-                row_hsh[:feature] = "#{title}"
-                row_hsh[:background] = bg_content
-                row_hsh[:scenario] = content_ary.join("\n")
-
-                row_hsh[:result] = ""
+                row_hsh[:feature] = excel_content_format feat_content
+                row_hsh[:background] = excel_content_format bg_content
+                row_hsh[:scenario] = excel_content_format scen_content
+                row_hsh[:result] = EXCEL_CONSTS::RESULT::PENDING
                 row_hsh[:tested_by] = ""
                 row_hsh[:test_designer] = ""
-
-
-              elsif type == :Examples
-                row_hsh[:examples] = ""
+                row_hsh[:comments] = ""
+
+                if type == :ScenarioOutline
+                  row_hsh[:examples] = excel_content_format example_ary
+                end
+                row_ary = []
+                get_keys_ary(@order).each {|k| row_ary << (row_hsh[k])}
+                # get_keys_ary(@order).each {|k| row_ary << excel_arg_hilight(row_hsh[k])}
+                res << row_ary
               end
-              row_ary = []
-              # get_keys_ary(@order).each {|k| row_ary << excel_arg_hilight(row_hsh[k])}
-              res << row_ary
             end
           end
         end
         feat_counter += 1
-        feat_content = ''
+        feat_title = ''
         bg_content = ''
       end
       @file_path = nil
@@ -207,7 +184,7 @@ module Cuker
         feat = hsh[:feature]
 
         feat_tags = get_tags feat
-        feat_title = name_merge feat
+        feat_title = get_title_ary feat
 
         children = feat[:children]
         children.each {|child| yield feat_tags, feat_title, child}
@@ -217,17 +194,17 @@ module Cuker
     end
 
     def in_item(child)
-      item_title = name_merge child
+      item_title = get_title_ary child
       tags = get_tags child
       if child[:type] == :Background
-        yield tags, item_title, child[:type], get_steps(child), []
+        yield tags, child[:type], item_title, get_steps(child), []
         # elsif !@feat_printed
         #   yield [], EXCEL_BLANK, :Feature, [EXCEL_BLANK]
-        #   yield tags, item_title, child[:type], get_steps(child), []
+        #   yield tags, child[:type], item_title, get_steps(child), []
       elsif child[:type] == :Scenario
-        yield tags, item_title, child[:type], get_steps(child), []
+        yield tags, child[:type], item_title, get_steps(child), []
       elsif child[:type] == :ScenarioOutline
-        yield tags, item_title, child[:type], get_steps(child), get_examples(child[:examples])
+        yield tags, child[:type], item_title, get_steps(child), get_examples(child[:examples])
         #   todo: think about new examples in new lines
       else
         @log.warn "Unknown type '#{child[:type]}' found in file @ #{@file_path}"
@@ -239,7 +216,7 @@ module Cuker
         if step[:type] == :Step
           step_ary = []
           step_str = [
-              ((excel_bold(step[:keyword].strip)).rjust(7)), # bolding the keywords
+              ((excel_bold(step[:keyword].strip)).rjust(6)), # bolding the keywords
               (step[:text].strip)
           ].join(' ')
 
@@ -261,8 +238,8 @@ module Cuker
       if arg[:type] == :DataTable
         res = []
         arg[:rows].each_with_index do |row, i|
-          # sep = i == 0 ? EXCEL_TITLE_SEP : EXCEL_ROW_SEP
-          # res << surround(row[:cells].map {|hsh| excel_blank_pad hsh[:value]}, sep)
+          sep = i == 0 ? EXCEL_TITLE_SEP : EXCEL_ROW_SEP
+          res << surround(row[:cells].map {|hsh| excel_blank_pad hsh[:value]}, sep)
         end
         return res
       elsif arg[:type] == :DocString
@@ -292,14 +269,14 @@ module Cuker
         if example[:type] == :Examples
           # res << EXCEL_HORIZ_RULER
 
-          eg_title = excel_title 'Examples', name_merge(example)
+          eg_title = excel_title EXAMPLES, get_title_ary(example)
           res << eg_title
 
           eg_header = surround(get_table_row(example[:tableHeader]), EXCEL_TITLE_SEP)
           res << eg_header
 
-          eg_rows = example[:tableBody]
-          eg_rows.map {|row_hsh| res << surround(get_table_row(row_hsh), EXCEL_ROW_SEP)}
+          eg_body = example[:tableBody]
+          eg_body.map {|row_hsh| res << surround(get_table_row(row_hsh), EXCEL_ROW_SEP)}
 
         else
           @log.warn "Unknown type '#{example[:type]}' found in file @ #{@file_path}"
@@ -327,12 +304,11 @@ module Cuker
       end
     end
 
-    def name_merge hsh, max_len = TITLE_MAX_LEN
-      str = ''
-      @log.debug "name merge for #{hsh} with max_len (#{max_len})"
-      str += add_newlines!(hsh[:name].strip.force_encoding("UTF-8"), max_len) if hsh[:name]
-      str += add_newlines!("\n#{hsh[:description].strip.force_encoding("UTF-8")}", max_len) if hsh[:description]
-      str
+    def get_title_ary hsh, max_len = TITLE_MAX_LEN
+      title_ary = []
+      title_ary << hsh[:name].strip.force_encoding("UTF-8") if hsh[:name]
+      title_ary << hsh[:description].strip.force_encoding("UTF-8") if hsh[:description]
+      title_ary
     end
 
 
@@ -340,7 +316,7 @@ module Cuker
       attr_accessor :name, :title, :pattern
     end
 
-    module EXCEL
+    module EXCEL_CONSTS
       module RESULT
         PENDING = "Pending"
         PASS = "Pass"

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

@@ -7,6 +7,7 @@ module Cuker
 
     method :make_new_file
     method :write_new_sheet
+    method :finishup
   end
 
   class AbstractWriter
@@ -21,7 +22,7 @@ module Cuker
     # Active file name
     attr_accessor :active_file_name
 
-    attr_accessor :sheets, :active_sheet
+    attr_accessor :book, :active_file
     attr_reader :out_dir
 
     def initialize
@@ -29,8 +30,8 @@ module Cuker
       # @out_dir = output_path
       # FileUtils.mkdir_p(output_path) unless Dir.exist? output_path
       @log.debug "initing AbstractWriter"
-      @active_sheet = nil
-      @sheets = {}
+      @active_file = nil
+      @book = {}
     end
 
     def write_title data
@@ -42,7 +43,7 @@ module Cuker
     end
 
     def raise_unless_active_loc data
-      raise NoNewFileMadeError.new "Please run 'make_new_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_file.nil?
     end
 
     def make_new_sheet name = nil
@@ -52,6 +53,10 @@ module Cuker
       # todo: file name collision handle!!
     end
 
+    def finishup
+      @log.debug "closing up #{@name} file if needed"
+    end
+
     def make_new_file name
       @log.debug "make a new abstract file: #{name}#{@ext}"
       make_name name
@@ -63,11 +68,11 @@ module Cuker
     end
 
     def new_name name
-      name.nil? ? "Sheet_#{@sheets.size + 1}" : name
+      name.nil? ? "Sheet_#{@book.size + 1}" : name
     end
   end
 
-  class AbstractSheet
+  class AbstractFile
     include LoggerSetup
     attr_accessor :name, :rows
 
@@ -91,6 +96,10 @@ module Cuker
     def read_rows
       @rows
     end
+
+    def finishup
+      @log.debug "closing up #{@name} file if needed"
+    end
   end
 
 end

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

@@ -11,21 +11,21 @@ module Cuker
     def write_title title_ary
       super title_ary
       @log.debug "csv write title"
-      @active_sheet.add_row title_ary
+      @active_file.add_row title_ary
     end
 
     def write_new_row row_ary
       super row_ary
       @log.debug "csv write row: #{row_ary}"
-      @active_sheet.add_row row_ary
+      @active_file.add_row row_ary
     end
 
     def make_new_sheet name
       @log.debug "csv make new sheet"
       #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]
+      @book[file_name] = CsvFile.new file_name
+      @active_file = @book[file_name]
       file_name
     end
 
@@ -40,7 +40,7 @@ module Cuker
 # extends sheet to give csv read/write-ability
 # {file:https://docs.ruby-lang.org/en/2.1.0/CSV.html CSV usage documentation}
 
-  class CsvSheet < AbstractSheet
+  class CsvFile < AbstractFile
     def initialize file_name
       super file_name
       @log.info "Making new #{self.class} => #{file_name}"

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

@@ -11,13 +11,13 @@ module Cuker
     def write_title title_line
       super title_line
       @log.debug "JW write title: #{title_line}"
-      @active_sheet.add_line title_line
+      @active_file.add_line title_line
     end
 
     def write_new_row row_line
       super row_line
       @log.debug "JW write row: #{row_line}"
-      @active_sheet.add_line row_line
+      @active_file.add_line row_line
     end
 
     def make_new_sheet name = nil
@@ -28,13 +28,13 @@ module Cuker
 
     def make_new_file name
       path = super name
-      @sheets[path] = JiraFile.new path
-      @active_sheet = @sheets[path]
+      @book[path] = JiraFile.new path
+      @active_file = @book[path]
       path
     end
   end
 
-  class JiraFile < AbstractSheet
+  class JiraFile < AbstractFile
     def initialize file_name
       super file_name
       @log.info "Making new #{self.class} => #{file_name}"

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

@@ -1,55 +1,141 @@
 require_relative 'abstract_writer'
+require 'rubyXL'
+require 'rubyXL/convenience_methods'
 
 module Cuker
   class RubyXLWriter < AbstractWriter
     def initialize
+      @ext = '.xlsm'
       super
       @log.debug "initing #{self.class}"
     end
 
     def write_title title_ary
-      @log.debug "Rxl write title"
-      @active_sheet.add_row title_ary
+      super title_ary
+      @log.debug "rxl write title"
+      @active_file.add_row title_ary
     end
 
     def write_new_row row_ary
-      @log.debug "Rxl write row"
-      @active_sheet.add_row row_ary
+      super row_ary
+      @log.debug "rxl write row: #{row_ary}"
+      @active_file.add_row row_ary
     end
 
-    def make_new_sheet name = nil
-      @log.debug "Rxl make new sheet"
-      path = super name
-      @sheets[name] = RubyXLSheet.new path
+    def make_new_book name
+      @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
+      @active_file = @book[file_name]
+      file_name
     end
 
     def make_new_file name
-      super name
+      path = super name
+      finishup
+      make_new_book name
+    end
+
+    def finishup
+      @active_file.finishup if @active_file
     end
+  end
 
-    class RubyXLSheet < AbstractSheet
-      def initialize file_name
-        super file_name
-        @log.info "Making new #{self.class} => #{file_name}"
-        # @jira_file = File.open(file_name, "wb")
+  class RubyXLFile < AbstractFile
+    attr_accessor :workbook, :worksheets, :worksheet
 
-        @workbook = RubyXL::Parser.parse './sample_template.xlsx'
-      end
+    def initialize file_name
 
-      def current_row
-        @rows.size + 1
-      end
+      premade = File.basename(file_name) =~ /xlsm/
+      # premade = true
+      # premade = false
+      template_file_name = './lib/cuker/helpers/writers/simple_macro_template.xlsm'
+      # template_file_name = './lib/cuker/helpers/writers/demo_file2.xlsm'
+      @file_name = premade ? template_file_name : file_name
+
+      super @file_name
+      @log.info "Making new #{self.class} => #{@file_name}"
+
+      @workbook = premade ? RubyXL::Parser.parse(@file_name) : RubyXL::Workbook.new
+      # @workbook.add_worksheet('Acceptance Tests')
+      # @workbook[0].sheet_name = 'Acceptance Tests'
+
+      @worksheets = @workbook.worksheets
+
+      # todo: delete sheet convenienve method
+      # @workbook['test_id'].delete
+
+      # delete_sheet 'null'
+      locate_sheet 'test_id'
+
+      # @worksheet = @workbook[0]
+      @worksheet = @workbook['Acceptance Tests']
+
+
+      @rows = sheet_rows.dup # starting Row
+      @offset = 0 # starting Col
 
-      def add_row ary
-        @rows << ary
+      # inserting a blank cell to make sure title format is not being copied
+      @worksheet.add_cell(@rows.size, @offset, ' ')
+
+      @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
 
-      alias :add_line :add_row
+    def current_row
+      rows.size - 1
+    end
+
+    def current_col
+      @offset
+    end
 
-      # @return ary of rows
-      def read_rows
-        @rows
+    def add_row ary
+      super ary
+      row, col = current_row, current_col
+      worksheet.insert_row(row)
+      ary.each do |val|
+        worksheet.insert_cell(row, col, val.to_s)
+        col += 1
       end
+
+      link_sheet_name = "#{ary[0]} results"
+      workbook.add_worksheet(link_sheet_name)
+      back_link_value = @link_sheet[0][0].value
+      back_link_formula = @link_sheet[0][0].formula
+      @workbook[link_sheet_name].add_cell(0, 0, back_link_value, back_link_formula)
+      # workbook.worksheets <<
+          # (link_sheet_name)
+
+      @log.info workbook.worksheets.map(&:sheet_name)
+      @log.info sheet_rows
+      # @log.debug worksheet.rows
+    end
+
+    alias :add_line :add_row
+
+    # @return ary of rows
+    def sheet_rows
+      @worksheet.sheet_data.rows
+    end
+
+    def finishup
+      # @workbook.write("#{@name}")
+      @workbook.worksheets.delete_at(locate_sheet 'test_id') if locate_sheet 'test_id'
+      @workbook.write("#{@file_name}") if @workbook
     end
   end
 end

data/lib/cuker/test/book1.rb

@@ -0,0 +1,25 @@
+# require 'rubyXL'
+# require 'rubyXL/convenience_methods/cell'
+#
+# workbook = RubyXL::Parser.parse './Book1.xlsx'
+#
+#
+# worksheets = workbook.worksheets
+#
+# worksheets.each do |worksheet|
+#   puts "Reading: #{worksheet.sheet_name}"
+#   num_rows = 0
+#
+#   worksheet.each do |row|
+#     row_cells = row.cells.map(&:value)
+#     num_rows += 1
+#
+#     # uncomment to print out row values
+#     puts row_cells.join ' '
+#   end
+#   puts "Read #{num_rows} rows"
+# end
+#
+# workbook.write("res.xlsx")
+#
+# puts 'Done'

data/lib/cuker/test/ruby_xl.rb

@@ -54,3 +54,5 @@
 # workbook.write("res.xlsx")
 #
 # puts 'Done'
+#
+#

data/lib/cuker/version.rb

@@ -1,3 +1,3 @@
 module Cuker
-  VERSION = "0.5.7"
+  VERSION = "0.5.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuker
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.15
 platform: ruby
 authors:
 - ufo2mstar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: text-table
+  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'
 description: generates reports and gives some customizable formatting options
 email:
 - ufo2mstar@gmail.com
@@ -162,6 +176,7 @@ files:
 - lib/cuker/helpers/writers/simple_macro_template.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