suiteview 2.0.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c709ba98435b663cba7c18f576061a1bae25fce3fdb152d69f9a2708a647cff2
-  data.tar.gz: d9f6efe857796d8dc432c1f8949cf8e8447fabf87783d5294370ff7044569efd
+  metadata.gz: bc3d14c800ffc83b237e71923484783cd7360bd84f37151f53fed9cfe33ea1c6
+  data.tar.gz: baae20f73d79a8e79810a8ef0993e82a0526ca14362043767ea55c79cdeaada1
 SHA512:
-  metadata.gz: 170a7e0a5443c10d95223dc1f6b070abc861dcc1881905d8b309a4d692976a40ee622d6b50cb789d8811e61abe635f79430f81c8197142284c069ad119cdb6b0
-  data.tar.gz: f5c5ecff8920a67b7800c0f90c58f42e2b214130a4df28c6e5d1751db9a2ea40e67b289fd7785568b0d5084617624cf20c0b62ecd16e58c6080ebcdb228f047b
+  metadata.gz: 0bfe734a751c11ce061faba67253d4c41e9a80c0f430589cdc73e5e02cd1d0432b6d2c6bd8d8529f3793401d04532d03ca5c8175f99eabe8d7e7a4d0bfcc41ab
+  data.tar.gz: cf21d411cebda7188151d8ff5434499db1fdab2092305e10df76e433b043de66bcc23b06f7c238fb14d8465aeb9796225a29b900bf1141f962bd9101b333bc47

data/lib/suiteview.rb

@@ -1,29 +1,24 @@
 require 'cql'
 require 'csv'
+require_relative './suitestat'
+# SuiteView is responsible for providing consumable Ruby Cucumber suite stats
 class SuiteView
   attr_accessor :repo, :include_tags, :output
+
   def initialize(opts)
     self.output = nil
     self.repo = CQL::Repository.new(opts[:repo])
-    self.include_tags = opts[:include_tags]
+    self.include_tags = opts[:include_tags] || ""
+    self.include_tags = self.include_tags.split(',')
   end
 
   def outline_tag_count(tag)
-    self.output = self.repo.query do
-      select examples
-      transform examples => lambda {|examples| examples[0].rows.drop(1) }
-      from outlines
-      with { |outline| outline.tags.map(&:name).include?(tag)}
-    end.map {|item| item['examples']}.flatten.count
+    self.output = outline_query(tag).map { |item| item['examples'] }.flatten.count
     self
   end
 
   def scenario_tag_count(tag)
-    self.output = self.repo.query do
-      select name
-      from scenarios
-      with { |scenario| scenario.tags.map(&:name).include?(tag)}
-    end.map {|item| item['name']}.count
+    self.output = scenario_query(tag).map { |item| item['name'] }.count
     self
   end
 
@@ -32,26 +27,24 @@ class SuiteView
     self
   end
 
-  def percentages
-    output = [%w(tag percent)]
-    total_count = 0
-    tag_counts = {}
-    self.include_tags.split(',').each do |include_tag|
-      total_count += total_tag_count(include_tag).render
-      tag_counts[include_tag] = total_tag_count(include_tag).render
-    end
-    self.include_tags.split(',').each do |include_tag|
-      output << [include_tag, ((tag_counts[include_tag]/total_count.to_f)*100).to_s]
+  def total_tags_count
+    output = [%w(tag count)]
+    self.include_tags.each do |tag|
+      output << [tag, total_tag_count(tag).render.to_s]
     end
     self.output = output
     self
   end
 
+  def percentages
+    suite_stat_dto = SuiteStat.new([%w(tag percent)], 0, {})
+    self.output = calc_percentage(suite_stat_dto)
+    self
+  end
+
   def to_csv
     self.output = CSV.generate do |csv|
-      self.output.each do |row|
-        csv << row
-      end
+      self.output.each { |row| csv << row }
     end
     self
   end
@@ -61,8 +54,50 @@ class SuiteView
   end
 
   def render_to_file(filename)
-    File.open(filename, "w") do |f|
-      f.puts self.output
+    File.open(filename, "w") do |file|
+      file.puts self.output
+    end
+  end
+
+  private
+
+  def calc_percentage(suite_stat_dto)
+    suite_stat_dto.total_count = calc_percentage_totals(suite_stat_dto)
+    collate_percentage_rows(suite_stat_dto)
+  end
+
+  def collate_percentage_rows(suite_stat_dto)
+    output = suite_stat_dto.output
+    self.include_tags.each do |include_tag|
+      output << [include_tag, ((suite_stat_dto.tag_counts[include_tag] / suite_stat_dto.total_count.to_f) * 100).to_s]
+    end
+    output
+  end
+
+  def calc_percentage_totals(suite_stat_dto)
+    total_count = suite_stat_dto.total_count
+    self.include_tags.each do |include_tag|
+      count_for_tag = total_tag_count(include_tag)
+      total_count += count_for_tag.render
+      suite_stat_dto.tag_counts[include_tag] = count_for_tag.render
+    end
+    total_count
+  end
+
+  def outline_query(tag)
+    self.repo.query do
+      select examples
+      transform examples => lambda { |examples| examples[0].rows.drop(1) }
+      from outlines
+      with { |outline| outline.tags.map(&:name).include?(tag) }
+    end
+  end
+
+  def scenario_query(tag)
+    self.repo.query do
+      select name
+      from scenarios
+      with { |scenario| scenario.tags.map(&:name).include?(tag) }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suiteview
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.3
 platform: ruby
 authors:
 - David West
@@ -66,8 +66,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: suiteview is a tool to help show the contents of a cucumber suite with
-  your unique specifications
+description: |
+  suiteview is a tool to help show the contents of a cucumber suite with your unique specifications
+
+  `my_suiteview.rb`
+
+  ```ruby
+  require "suiteview"
+
+  # Instantiate the SuiteView class and give it the location of your Cucumber Suite (repo)
+  sv = SuiteView.new({repo: "features", include_tags: "@tweets,@followers"})
+
+  # Get a count of all Scenarios directly tagged with a particular tag
+  sv.percentages.to_csv.render_to_file("my.csv")
+  ```
+
+  And you'll have your output
+
+  `my.csv`
+
+  ```csv
+  tag,percent
+  @tweets,80.0
+  @followers,20.0
+  ```
+
+  `my_suiteview2.rb`
+
+  ```ruby
+  require "suiteview"
+
+  # Instantiate the SuiteView class and give it the location of your Cucumber Suite (repo)
+  sv = SuiteView.new({repo: "features", include_tags: "@tweets,@followers"})
+
+  # Get a count of all Scenarios directly tagged with a particular tag
+  sv.total_tags_count.to_csv.render_to_file("my2.csv")
+  ```
+
+  `my2.csv`
+
+  ```csv
+  tag,count
+  @tweets,4
+  @followers,1
+  ```
 email: support@suiteview.xyz
 executables: []
 extensions: []