feature_map 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1243d054f38c9a5520a3790190ad36cf49a447c4e931d7e5cc85cd1a958eb20
-  data.tar.gz: 275ed70329b4df76a18412719ee004c8626cb53f708905f5ff3413846fab34e2
+  metadata.gz: 206bf1a9f4dcf4bb82658ce1a6e7f3c532b5929521e53c070b4efa92eb4b61b1
+  data.tar.gz: dbde9980709b0d3a28bb2b7319da42a9bbd188aec2c78c9ecbaef6405a95bf96
 SHA512:
-  metadata.gz: 62100534249d7ccc2ec67849ca92bcaf38dc55bd6d22a3d1aefb673b6a6222c16cddbb742af38f895832d758de85ffe75c6f93fccf2b4d6c292d344566b04089
-  data.tar.gz: e055eaa7af6fe4a6e27c9f29a38e1c2d1a687cbf0f5ba500541a0b2b21cbec9a78b29cc23c95128995eb81142b98cbeee3d01e4dc454084e956f8a748f0b8e95
+  metadata.gz: 03b1baec50bb36335af87eabf62885290cfe53516686bded3ac61d6ae660dd9d181d6df817e1b2089f0e3c605dfdf119bedd334d61ae0c9ee1049fe29ee7cd75
+  data.tar.gz: c2c72319780a7043aa1654cf691d53a576275af18ef968fde2777a13b89bba4208c77daed041ff0def4ec15f0851ce1cc9bdf3c4d724e89af28a7c26cd41a8be

data/README.md

@@ -259,7 +259,7 @@ That's it! Assuming you can complete all of these steps without any error or iss
 
 When a new version of the gem is ready to be published, please follow these steps:
 
-* Update `spec.version` value in the (feature_map.gemspec)[feature_map.gemspec] file.
+* Update `spec.version` value in the [feature_map.gemspec](feature_map.gemspec) file.
     * Assign a version to this release in accordance with [Semantic Versioning](https://semver.org/) based on the changes contained in this release.
 * Create a new release tag in Github ([link](https://github.com/Beyond-Finance/feature_map/releases)) with a value that matches the new Gemspec version.
 * Checkout the release tag in your local environment.

data/lib/feature_map/cli.rb

@@ -9,7 +9,9 @@ module FeatureMap
   class Cli
     def self.run!(argv)
       command = argv.shift
-      if command == 'validate'
+      if command == 'apply_assignments'
+        apply_assignments!(argv)
+      elsif command == 'validate'
         validate!(argv)
       elsif command == 'docs'
         docs!(argv)
@@ -26,19 +28,47 @@ module FeatureMap
           Usage: bin/featuremap <subcommand>
 
           Subcommands:
-            validate - run all validations
+            apply_assignments - applies specified feature assignments to source files
             docs - generates feature documentation
+            for_feature - find assignment information for a feature
+            for_file - find feature assignment for a single file
             test_coverage - generates per-feature test coverage statistics
             test_pyramid - generates per-feature test pyramid (unit, integration, regression) statistics
-            for_file - find feature assignment for a single file
-            for_feature - find assignment information for a feature
+            validate - run all validations
+
+            ##################################################
             help  - display help information about feature_map
+            ##################################################
         USAGE
       else
         puts "'#{command}' is not a feature_map command. See `bin/featuremap help`."
       end
     end
 
+    def self.apply_assignments!(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = <<~MSG
+          Usage: bin/featuremap apply_assignments [assignments.csv].
+          Note:  Expects two fields with no header:  dir/filepath,feature
+                 Supports assignments in the following filetypes:
+                   cls,html,js,jsx,rb,ts,tsx,xml
+        MSG
+
+        opts.on('--help', 'Shows this prompt') do
+          puts opts
+          exit
+        end
+      end
+      args = parser.order!(argv)
+      parser.parse!(args)
+      non_flag_args = argv.reject { |arg| arg.start_with?('--') }
+      assignments_file_path = non_flag_args[0]
+
+      raise 'Please specify assignments.csv file' if assignments_file_path.nil?
+
+      FeatureMap.apply_assignments!(assignments_file_path)
+    end
+
     def self.validate!(argv)
       options = {}
 

data/lib/feature_map/private/assignment_applicator.rb

@@ -0,0 +1,112 @@
+# typed: strict
+# frozen_string_literal: true
+
+module FeatureMap
+  module Private
+    class AssignmentApplicator
+      extend T::Sig
+
+      sig { params(assignments: T::Array[T::Array[T.nilable(String)]]).void }
+      def self.apply_assignments!(assignments)
+        file_to_feature_map = map_files_to_feature
+        assignments.each do |(filepath, feature)|
+          next puts("Missing data: #{filepath}, #{feature}") unless filepath && feature
+          next puts("Already assigned: #{filepath}, #{feature}") if file_to_feature_map[filepath]
+
+          apply_assignment(filepath, feature)
+        end
+      end
+
+      sig { params(filepath: String, feature: String).void }
+      def self.apply_assignment(filepath, feature)
+        return apply_to_directory(filepath, feature) if File.directory?(filepath)
+
+        # NOTE:  For simplicity we're reading the entire file into system memory
+        #        and then writing it back out.  This breaks in theory for exceptionally
+        #        large source files on very resource-constrained machines.  In practice it's
+        #        probably fine.
+        file = File.readlines(filepath)
+        case File.extname(filepath)
+        when '.cls'
+          apply_to_apex(file, filepath, feature)
+        when '.html'
+          apply_to_html(file, filepath, feature)
+        when '.js', '.jsx', '.ts', '.tsx'
+          apply_to_javascript(file, filepath, feature)
+        when '.rb'
+          apply_to_ruby(file, filepath, feature)
+        when '.xml'
+          apply_to_xml(file, filepath, feature)
+        else
+          puts "Cannot auto assign #{filepath} to #{feature}"
+        end
+      end
+
+      sig { params(file: T::Array[String], filepath: String, feature: String).void }
+      def self.apply_to_apex(file, filepath, feature)
+        File.open(filepath, 'w') do |f|
+          f.write("// @feature #{feature}\n\n")
+          file.each { |line| f.write(line) }
+        end
+      end
+
+      sig { params(filepath: String, feature: String).void }
+      def self.apply_to_directory(filepath, feature)
+        feature_path = File.join(filepath, '.feature')
+
+        File.write(feature_path, "#{feature}\n")
+      end
+
+      sig { params(file: T::Array[String], filepath: String, feature: String).void }
+      def self.apply_to_html(file, filepath, feature)
+        File.open(filepath, 'w') do |f|
+          f.write("<!-- @feature #{feature} -->\n\n")
+          file.each { |line| f.write(line) }
+        end
+      end
+
+      sig { params(file: T::Array[String], filepath: String, feature: String).void }
+      def self.apply_to_javascript(file, filepath, feature)
+        File.open(filepath, 'w') do |f|
+          f.write("// @feature #{feature}\n\n")
+          file.each { |line| f.write(line) }
+        end
+      end
+
+      sig { params(file: T::Array[String], filepath: String, feature: String).void }
+      def self.apply_to_ruby(file, filepath, feature)
+        File.open(filepath, 'w') do |f|
+          # NOTE:  No spacing newline; doing so would separate
+          #        the feature declaration into the only "first" comment
+          #        section, which breaks existing magic comments.
+          #        https://docs.ruby-lang.org/en/3.1/syntax/comments_rdoc.html#label-Magic+Comments
+
+          f.write("# @feature #{feature}\n")
+          file.each { |line| f.write(line) }
+        end
+      end
+
+      sig { params(file: T::Array[String], filepath: String, feature: String).void }
+      def self.apply_to_xml(file, filepath, feature)
+        # NOTE:  Installation of top-level comments in some XML files (notably, in Salesforce)
+        #        breaks parsing.  Instead, we'll insert them right after the opening XML declaration.
+        xml_declaration = file.index { |line| line =~ /<\?xml/i }
+        insert_index = xml_declaration.nil? ? 0 : xml_declaration + 1
+        file.insert(insert_index, "<!-- @feature #{feature} -->\n\n")
+
+        File.open(filepath, 'w') do |f|
+          file.each { |line| f.write(line) }
+        end
+      end
+
+      sig { returns(T::Hash[String, String]) }
+      def self.map_files_to_feature
+        Private.feature_file_assignments.reduce({}) do |content, (feature_name, files)|
+          mapped_files = files.to_h { |f| [f, feature_name] }
+
+          content.merge(mapped_files)
+        end
+      end
+    end
+  end
+end