cuker 0.3.15

data/lib/cuker/models/state.rb

@@ -0,0 +1,3 @@
+class State
+
+end

data/lib/cuker/state/in_comment.rb

@@ -0,0 +1,3 @@
+class InComment < State
+
+end

data/lib/cuker/version.rb

@@ -0,0 +1,3 @@
+module Cuker
+  VERSION = "0.3.15"
+end

data/lib/cuker/writer_helper/_interfact.rb

@@ -0,0 +1,7 @@
+module Interface
+  def method(name)
+    define_method(name) {|*args|
+      raise NotImplementedError.new("implemented interface method: '#{name}'")
+    }
+  end
+end

data/lib/cuker/writer_helper/abstract_model.rb

@@ -0,0 +1,37 @@
+module IModel
+  extend Interface
+  method :initialize
+  method :write_title
+  method :write_new_row
+
+  method :make_file
+  method :write_new_sheet
+end
+
+
+class AbstractModel
+  include LoggerSetup
+
+  # @return [Array] writable rows of title
+  #   Defaults to []
+  attr_accessor :title
+
+  # @return [Array] writable array of rows of data
+  #   Defaults to []
+  attr_accessor :data
+
+  def initialize _model_input = []
+    init_logger
+    @title = []
+    @data = []
+  end
+
+  def get_values_ary ary_of_hshs
+    ary_of_hshs.map {|hsh| hsh.values}.flatten
+  end
+
+  def get_keys_ary ary_of_hshs
+    ary_of_hshs.map {|hsh| hsh.keys}.flatten
+  end
+
+end

data/lib/cuker/writer_helper/abstract_writer.rb

@@ -0,0 +1,77 @@
+module IWriter
+  extend Interface
+  method :initialize
+  method :write_title
+  method :write_new_row
+
+  method :make_file
+  method :write_new_sheet
+end
+
+class AbstractWriter
+  include IWriter
+  include LoggerSetup
+
+  NoNewFileMadeError = Class.new IOError
+
+  attr_accessor :ext
+  attr_accessor :sheets, :active_sheet
+  attr_reader :out_dir
+
+  def initialize
+    init_logger
+    # @out_dir = output_path
+    # FileUtils.mkdir_p(output_path) unless Dir.exist? output_path
+    @log.debug "initing AbstractWriter"
+    @active_sheet = nil
+    @sheets = {}
+  end
+
+  def write_title data
+    raise_unless_active_loc data
+  end
+
+  def write_new_row data
+    raise_unless_active_loc data
+  end
+
+  def raise_unless_active_loc data
+    raise NoNewFileMadeError.new "Please run 'make_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
+  end
+
+  def make_file name
+    @log.debug "make a new abstract file: #{name}"
+  end
+end
+
+class AbstractSheet
+  include LoggerSetup
+  attr_accessor :name, :rows
+
+  def initialize name
+    init_logger
+    @name = name
+    @rows = []
+  end
+
+  def current_row
+    @rows.size + 1
+  end
+
+  def add_row ary
+    @log.error "argument not an array.. instead is a '#{ary.class}' -> '#{ary}'" unless ary.is_a? Array
+    @rows << ary
+  end
+
+  # @return ary of rows
+  def read_rows
+    @rows
+  end
+end

data/lib/cuker/writer_helper/csv_model.rb

@@ -0,0 +1,148 @@
+require_relative 'abstract_writer'
+
+module Cuker
+  class CsvModel < AbstractModel
+    include LoggerSetup
+
+    attr_accessor :special_tag_list
+
+    def initialize ast_map
+      super
+      @log.trace "initing #{self.class}"
+      @log.debug "has #{ast_map.size} items"
+
+      @asts = ast_map
+
+      @order = make_order
+      @title = make_title @order
+      @data = make_rows
+    end
+
+    private
+
+    def make_order
+      [
+          {:counter => "Sl.No"},
+          {:s_type => "Type"},
+          {:s_title => "Title"},
+          # {:tags => special_tag_titles},
+          {:feature_title => "Feature"},
+          {:file_s_num => "S.no"},
+          {:file_name => "File"},
+          {:other_tags => "Tags"},
+      ]
+# todo: make title order reorderable
+# todo: tag based reordering
+    end
+
+    def special_tag_titles
+      @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
+    end
+
+    def make_title order
+      get_values_ary order
+    end
+
+    def make_rows
+      if @asts.nil? or @asts.empty?
+        @log.warn "No asts to parse!"
+        return []
+      end
+
+      total_counter = 0
+      res = []
+      @asts.each do |file_path, ast|
+        @file_path = file_path
+        in_feat_counter = 0
+        if ast[:type] == :GherkinDocument
+          in_feature(ast) do |feat_tags, feat_title, feat_item|
+            in_item(feat_item) do |tags, title, type|
+              all_tags = (feat_tags.to_set | tags.to_set).to_a # union
+              special_tags, other_tags = filter_special_tags all_tags
+              row_hsh = {
+                  :counter => total_counter += 1,
+                  :s_type => type,
+                  :s_title => title,
+                  :feature_title => feat_title,
+                  :file_s_num => in_feat_counter += 1,
+                  :file_name => @file_path,
+                  :other_tags => other_tags.join(', '),
+
+                  :tags => special_tags
+              }
+              row_ary = []
+              get_keys_ary(@order).each {|k| row_ary << row_hsh[k]}
+              # todo: a lot of flattening?
+              res << row_ary
+            end
+          end
+        end
+      end
+      @file_path = nil
+      res
+    end
+
+    def filter_special_tags(all_tags)
+      return [[],all_tags] unless special_tag_lookup
+      ignore_list = all_tags - special_tag_lookup
+      select_list = all_tags - ignore_list
+      [select_list, ignore_list]
+    end
+
+    def in_feature(hsh)
+      if hsh[:feature]
+        feat = hsh[:feature]
+        feat_tags = get_tags feat
+        feat_title = name_merge feat
+        children = feat[:children]
+        children.each do |item|
+          yield feat_tags, feat_title, item
+        end
+      else
+        @log.warn "No Features found in file @ #{@file_path}"
+      end
+    end
+
+    def in_item(item)
+      item_title = name_merge item
+      tags = get_tags item
+      if item[:type] == :Background
+        @log.debug "Skipping BG"
+      elsif item[:type] == :Scenario
+        yield tags, item_title, "S"
+      elsif item[:type] == :ScenarioOutline
+        yield tags, item_title, "SO"
+      else
+        @log.warn "Unknown type '#{item[:type]}' found in file @ #{@file_path}"
+      end
+    end
+
+    def get_tags(hsh)
+      if hsh[:tags] and hsh[:tags].any?
+        hsh[:tags].map {|tag| tag[:name]}
+      else
+        @log.warn "No Tags found in #{hsh[:keyword]} @ #{@file_path}"
+        []
+      end
+    end
+
+    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
+    end
+
+  end
+
+  class Identifier
+    attr_accessor :name, :title, :pattern
+  end
+
+end
+

data/lib/cuker/writer_helper/csv_writer.rb

@@ -0,0 +1,59 @@
+require_relative 'abstract_writer'
+
+class CsvWriter < AbstractWriter
+  def initialize
+    @ext = '.csv'
+    super
+    @log.debug "initing #{self.class}"
+  end
+
+  def write_title title_ary
+    super title_ary
+    @log.debug "csv write title"
+    @active_sheet.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
+  end
+
+  def make_new_sheet name
+    @log.debug "csv make new sheet"
+    path = super name
+    @sheets[path] = CsvSheet.new path, @ext
+    @active_sheet = @sheets[path]
+  end
+
+  def make_file name
+    super name
+    make_new_sheet name
+  end
+end
+
+require 'csv'
+# == CSV Sheet
+# 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
+  def initialize path, ext
+    file_name = "#{path}#{ext}"
+    super file_name
+    @csv_sheet = CSV.open(file_name, "wb")
+  end
+
+  def add_row row_ary
+    super row_ary
+    # @csv_sheet << ary
+    CSV.open(@name, "ab") do |csv|
+      csv << row_ary
+    end
+  end
+
+  # @return ary of rows
+  def read_rows
+    @rows = CSV.read(@name)
+  end
+end

data/lib/cuker/writer_helper/jira_model.rb

@@ -0,0 +1,174 @@
+require_relative 'abstract_writer'
+module Cuker
+  class JiraModel < AbstractModel
+    include LoggerSetup
+
+    def initialize ast_map
+      super
+      @log.trace "initing #{self.class}"
+      @log.debug "has #{ast_map.size} items"
+
+      @asts = ast_map
+
+      @order = make_order
+      title = make_title @order
+      data = make_rows
+
+      @title = [surround(title, '||')]
+      @data = data.join("\n").split("\n")
+    end
+
+    private
+
+    def make_order
+      [
+          # {:counter => "Sl.No"},
+          {:s_num => "Scen ID"},
+          {:s_content => "Scenario"},
+          {:item => "Result"},
+      ]
+# # todo: make title order reorderable
+# # todo: tag based reordering
+    end
+
+    def make_title order
+      get_values_ary order
+    end
+
+    def make_rows
+      if @asts.nil? or @asts.empty?
+        @log.warn "No asts to parse!"
+        return []
+      end
+
+      feat_counter = 1
+      res = []
+      @asts.each do |file_path, ast|
+        @file_path = file_path
+        in_feat_counter = 0
+        if ast[:type] == :GherkinDocument
+          in_feature(ast) do |feat_tags, feat_title, feat_item|
+            in_item(feat_item) do |tags, title, content|
+              row_hsh = {
+                  :s_num => "#{feat_counter}.#{in_feat_counter += 1}",
+                  :s_content => content.join("\n"),
+                  :item => "|(/)|",
+              }
+              row_ary = []
+              get_keys_ary(@order).each {|k| row_ary << row_hsh[k]}
+              res << surround(row_ary, '|')
+            end
+          end
+        end
+        feat_counter += 1
+      end
+      @file_path = nil
+      res
+    end
+
+    def in_feature(hsh)
+      if hsh[:feature]
+        feat = hsh[:feature]
+        feat_tags = get_tags feat
+        feat_title = name_merge feat
+        children = feat[:children]
+        children.each do |item|
+          yield feat_tags, feat_title, item
+        end
+      else
+        @log.warn "No Features found in file @ #{@file_path}"
+      end
+    end
+
+    def in_item(item)
+      item_title = name_merge item
+      tags = get_tags item
+      @bg_steps ||= []
+      if item[:type] == :Background
+        yield tags, item_title, get_steps(item)
+        # todo: think about handling this
+      elsif item[:type] == :Scenario
+        yield tags, item_title, get_steps(item)
+        @bg_steps = nil
+      elsif item[:type] == :ScenarioOutline
+        yield tags, item_title, get_steps(item)
+        @bg_steps = nil
+      else
+        @log.warn "Unknown type '#{item[:type]}' found in file @ #{@file_path}"
+      end
+    end
+
+    def get_steps(hsh)
+      if hsh[:steps] and hsh[:steps].any?
+        content = []
+        steps = hsh[:steps]
+        in_step(steps) do |step|
+          content += step
+        end
+        content
+      else
+        @log.warn "No Tags found in #{hsh[:keyword]} @ #{@file_path}"
+        []
+      end
+    end
+
+    def in_step(steps)
+      # todo: table
+      steps.each do |step|
+        if step[:type] == :Step
+          step_ary = []
+          step_ary << [
+              step[:keyword].strip,
+              step[:text].strip
+          ].join(" ")
+          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
+
+    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| hsh[:value]}, sep)
+        end
+        return res
+      elsif arg[:type] == :DocString
+        # todo: handle if needed
+      else
+        @log.warn "Unknown type '#{arg[:type]}' found in file @ #{@file_path}"
+      end
+      []
+    end
+
+    def get_tags(hsh)
+      if hsh[:tags] and hsh[:tags].any?
+        hsh[:tags].map {|tag| tag[:name]}
+      else
+        @log.warn "No Tags found in #{hsh[:keyword]} @ #{@file_path}"
+        []
+      end
+    end
+
+    def union feat_tags, tags
+      (feat_tags.to_set | tags.to_set).to_a # union
+    end
+
+    def surround ary, sep
+      "#{sep}#{ary.join(sep)}#{sep}"
+    end
+
+    def name_merge hsh
+      str = ""
+      @log.warn hsh
+      str += hsh[:name].strip.force_encoding("UTF-8") if hsh[:name]
+      str += hsh[:description].strip.force_encoding("UTF-8") if hsh[:description]
+      str
+    end
+  end
+end