robotag 1.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89fff41e4ffdbe57677af1e06e0e8e196cc0059785ef20d3bd848d5e2f51bc7
-  data.tar.gz: c481bfbaeb81da2a95e030e110c0296457d923f5135b67558cffc997994fcd60
+  metadata.gz: ab44b297b1fd2c5f003e7825deb734e12d46dc62470b02abd3da9feed0b9bdbc
+  data.tar.gz: ab1d7b1ddae29e276e481a7c72d957c1526c5cac46414ba604e30132a5983d7d
 SHA512:
-  metadata.gz: 8a8e00a69e05dbfab727a5a3f145b6b285bf08f14ff4356b3d018f56b9b4f9905edd191d7fb938295e0a9a1ad9c5bdbf4dd6405b7cbf40686ee288ace935e0da
-  data.tar.gz: 0ca51b8ac4619a7aabea4064762ce206925268b19d32908fe801ca993bbbcc561ba7a6e93c70f21614fb9cd49d8e27e226e16fa53815c7a3bb6648d4034c69f7
+  metadata.gz: 2ea9fed578bce9a570ce0a526d0e5ec2c83d466a50eac068b5d95cdda7cdfb5cf3e741efe7ac011b6c9fc89b25c20496fd462fd02a2d431ac047ac69659d4919
+  data.tar.gz: f22e93f4f1dfc97ee5851795214a3f909cf285466f306cd32bd0fc59f05bf192c71ebe17b81df86fbdcfc4ca14e8fe6a85d8038df6a382784b186c369e042cfc

data/lib/robotag.rb

@@ -1,16 +1,17 @@
 require 'cql'
 
 class Robotag
-  attr_accessor :repo, :chain_state
+  attr_accessor :repo, :chain_state, :write_directives
 
   def initialize(opts)
     self.repo = CQL::Repository.new(opts[:repo])
+    self.write_directives = {}
     self
   end
 
   def tests_with_steps_that_match(my_regex)
     self.chain_state = self.repo.query do
-      select name, steps, tags
+      select
       from scenarios, outlines
       with { |scenario| scenario.steps.map(&:text).any? { |step| step =~ my_regex } }
     end
@@ -19,7 +20,7 @@ class Robotag
 
   def all_have_tag?(tag)
     self.chain_state = self.chain_state.map do |query_result|
-      query_result["tags"].map do |cm_tag|
+      query_result[:self].tags.map do |cm_tag|
         cm_tag.map(&:name)
       end
     end.all? do |mapped_qr|
@@ -30,7 +31,94 @@ class Robotag
     self
   end
 
+  # This is heavily borrowed from https://raw.githubusercontent.com/enkessler/cuke_cataloger/master/lib/cuke_cataloger/unique_test_case_tagger.rb
+  # Specifically it is an adapted version of #tag_tests
+  def tag_all_with(tag)
+    warn('This script will potentially rewrite all of your feature files. Please be patient and remember to tip your source control system.') # rubocop:disable Metrics/LineLength
+
+    analysis_and_output(tag, :add)
+    self
+  end
+
+  def remove_all(tag)
+    warn('This script will potentially rewrite all of your feature files. Please be patient and remember to tip your source control system.') # rubocop:disable Metrics/LineLength
+
+    analysis_and_output(tag, :remove)
+    self
+  end
+
+  def process_tag(test, tag, action)
+    if action == :add
+      return if has_tag?(test, tag)
+    elsif action == :remove
+      return unless has_tag?(test, tag)
+    end
+
+    modify_test_tag(test, tag, action)
+  end
+
+  def modify_test_tag(test, tag, action)
+    feature_file = test.get_ancestor(:feature_file)
+    file_path = feature_file.path
+
+    tag_index = (test.source_line - 2)
+
+    file_lines = if self.write_directives[file_path].nil?
+                   File.readlines(file_path)
+                 else
+                   self.write_directives[file_path].split("\n").map { |line| line + "\n" }
+                 end
+
+    if action == :add
+      file_lines[tag_index] = "#{file_lines[tag_index].chomp} #{tag}\n"
+    elsif action == :remove
+      file_lines[tag_index].delete!(tag)
+    end
+
+    self.write_directives[file_path] = file_lines.join
+
+    new_tag = CukeModeler::Tag.new
+    new_tag.name = tag
+    test.tags << new_tag
+    self
+  end
+
+  def has_tag?(test, tag)
+    test.tags.map(&:name).include?(tag)
+  end
+
+  def preview
+    unless self.write_directives.empty?
+      dirname = "robotag_preview"
+      FileUtils.rm_rf(dirname)
+      self.write_directives.each do |filepath, file_contents|
+        FileUtils.mkdir_p(File.dirname("#{dirname}/#{filepath}"))
+        File.open("#{dirname}/#{filepath}", 'w+') do |tmp_file|
+          tmp_file.print file_contents
+        end
+      end
+    end
+  end
+
   def go!
-    self.chain_state
+    if !self.write_directives.empty?
+      self.write_directives.each do |file_path, joined_file_lines|
+        File.open(file_path, 'w+') { |file| file.print joined_file_lines }
+      end
+    else
+      self.chain_state
+    end
+  end
+
+  private
+
+  def analysis_and_output(tag, action)
+    self.chain_state.map { |query_result| query_result[:self] }.each do |test|
+      if (test.is_a?(CukeModeler::Scenario) || test.is_a?(CukeModeler::Outline))
+        process_tag(test, tag, action)
+      else
+        raise("Unknown test type: #{test.class}")
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robotag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - David West
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec