k_builder 0.0.61 → 0.0.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c78906798abec61e633a8e6447baed740f5618025e6ec1733655c5173ee62b43
-  data.tar.gz: fd412c1aab0fa24ea34c2394c43ae77bba5588d4d25c50e890f1dc4a14f84f7e
+  metadata.gz: c3544040b2994f74c65d824516980a5ca980d441c53e97629920c23513cf76a2
+  data.tar.gz: e0c8e494f82a58e1564f59cfb66f960f6a99561a3cc28bfab81c17a77a3b4f8d
 SHA512:
-  metadata.gz: bbf46357650901ba2a5af3ba6c9371d6ca4752c281a57f88edcbb9b9264b75fa83afab90d679642dfe0475b4b48d5291fe936f83e70bc61cff193bdc96978105
-  data.tar.gz: a41800fce5dfe7297995317eed2441f1bd27d52e3af4def56558dcad53e1390c75cf4a699cd4f9fa2b90b76087d86c011b7204ff14a161be0b490edef09e3de9
+  metadata.gz: 8a27d1f32b26b8878260c11f15a0285b64a65769d9b17631cb05f9c772deab1ddf97bb3f7db9ab392efd9d9b257344bb85272827de19228905b9fe4493d6a485
+  data.tar.gz: f1a237017caff54b821d750dc9e467ec659a7127abae3d9640afe4a997c83afd9347c0113c99eb60d78c849875d26c34305983dbfc478d9e33a6be229ad8149f

data/lib/k_builder.rb

@@ -10,6 +10,8 @@ require 'k_builder/base_builder'
 require 'k_builder/base_configuration'
 require 'k_builder/configuration'
 require 'k_builder/file_segments'
+require 'k_builder/commands/base_command'
+require 'k_builder/commands/rubo_cop_command'
 
 require 'handlebars/helpers/template'
 

data/lib/k_builder/base_builder.rb

@@ -320,13 +320,11 @@ module KBuilder
       Handlebars::Helpers::Template.render(template_content, opts) unless template_content.nil?
     end
 
-    def run_cop(file, auto_safe: false, auto_all: false)
-      cli = RuboCop::CLI.new
-      opts = ['--format', 'simple', file]
-      opts.prepend('-a') if auto_safe
-      opts.prepend('-A') if auto_all
+    def run_cop(file, **opts)
+      command = Commands::RuboCopCommand.new(file, builder: self, **opts)
+      command.execute
 
-      cli.run(opts)
+      self
     end
 
     # Need to handle absolute files, see

data/lib/k_builder/commands/base_command.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module Commands
+    # Base command for single responsibility actions that can be fired
+    # from methods in the builder.
+    #
+    # Uses the command pattern
+    class BaseCommand
+      include KLog::Logging
+
+      attr_accessor :builder
+      attr_accessor :valid
+
+      def initialize(**opts)
+        @builder = opts[:builder]
+        @valid = true
+      end
+
+      def guard(message)
+        # THIS SHOULD ONLY LOG IF DEBUGGING IS TURNED ON
+        log.error(message)
+        @valid = false
+      end
+
+      def valid?
+        @valid
+      end
+
+      def debug(title: nil)
+        log.section_heading(title) if title
+        debug_values if respond_to?(:debug_values)
+      end
+    end
+  end
+end

data/lib/k_builder/commands/rubo_cop_command.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module Commands
+    # Run RuboCop against a file
+    class RuboCopCommand < BaseCommand
+      attr_reader :file_pattern
+      attr_reader :fix_safe
+      attr_reader :fix_unsafe
+      attr_reader :rubo_config_file
+      attr_reader :show_console
+
+      attr_reader :cop_options
+      attr_reader :cop_opt_values
+
+      # Initialize RuboCop command
+      #
+      # @param [String] file_pattern File name or file pattern
+      # @param [Hash] **opts The options
+      # @option opts [Boolean] :fix_safe RuboCop -a option will fix simple and safe issues
+      # @option opts [Boolean] :fix_unsafe RuboCop -A option will fix simple but potentially unsafe issues
+      # @option opts [Boolean] :show_console This will show in console, or if false set --out ~/last_cop.txt so that console is redirected to file
+      # @option opts [String] :rubo_config_file YAML file with RuboCop configuration options
+      #
+      # @example Cop for single file with auto fix turned on for simple issues
+      #
+      #   RubCopCommand.new('abc.rb', fix_safe: true)
+      #
+      # @example Cop for all spec files to auto simple and unsafe issues
+      #
+      #   RubCopCommand.new('spec/**/*.rb', fix_unsafe: true)
+      def initialize(file_pattern, **opts)
+        super(**opts)
+
+        @valid = true
+
+        self.file_pattern       = file_pattern
+
+        self.fix_safe           = opts[:fix_safe]
+        self.fix_unsafe         = opts[:fix_unsafe]
+        self.show_console       = opts[:show_console]
+        self.rubo_config_file   = opts[:rubo_config_file]
+      end
+
+      def execute
+        return unless valid?
+
+        cop_run
+      end
+
+      def cli_options
+        cli_options = []
+        # quite is the same as simple, except you will see nothing if no offenses
+        cli_options << '--format' << 'quiet' # 'simple'
+        cli_options << '-a' if fix_safe
+        cli_options << '-A' if fix_unsafe
+        cli_options << '--config' << rubo_config_file if rubo_config_file
+        cli_options << '--out' << '~/last_cop.txt' unless show_console
+        cli_options << file_pattern
+        cli_options
+      end
+
+      def debug_values
+        log.kv 'rubocop target', file_pattern
+        log.kv '-a', 'automatic fix for safe issues'                  if fix_safe
+        log.kv '-A', 'automatic fix for potentially unsafe issues'    if fix_unsafe
+        log.kv '-config', rubo_config_file                            if rubo_config_file
+      end
+
+      private
+
+      def file_pattern=(value)
+        @file_pattern = value
+
+        if value.nil? || value.empty?
+          guard 'file_pattern is required'
+        elsif Pathname.glob(value).length.zero?
+          guard 'file_pattern does not reference an existing file'
+        end
+      end
+
+      def fix_safe=(value)
+        @fix_safe = value || false
+      end
+
+      def fix_unsafe=(value)
+        @fix_unsafe = value || false
+      end
+
+      def show_console=(value)
+        @show_console = value || false
+      end
+
+      def rubo_config_file=(value)
+        @rubo_config_file = value
+
+        return if value.nil? || value.empty?
+
+        guard("Unknown RuboCop config file: #{value}") unless File.exist?(value)
+      end
+
+      def cop_run
+        cli = RuboCop::CLI.new
+
+        # log.section_heading('CLI OPTIONS')
+        # log.block cli_options
+
+        cli.run(cli_options)
+      end
+    end
+  end
+end

data/lib/k_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KBuilder
-  VERSION = '0.0.61'
+  VERSION = '0.0.62'
 end

data/~/last_cop.txt

@@ -0,0 +1,19 @@
+== /var/folders/jh/nffr8l5j4rzgc7s386gj770r0000gn/T/rspec-20210701-95573-12q1az6/make-pretty.rb ==
+C:  1:  1: Naming/FileName: The name of this source file (make-pretty.rb) should use snake_case.
+C:  1:  1: [Corrected] Style/FrozenStringLiteralComment: Missing frozen string literal comment.
+C:  2:  1: [Corrected] Layout/EmptyLineAfterMagicComment: Add an empty line after magic comments.
+C:  2:  1: [Corrected] Layout/IndentationWidth: Use 2 (not 0) spaces for indentation.
+C:  2:  1: [Corrected] Style/SingleLineMethods: Avoid single-line method definitions.
+C:  2: 19: [Corrected] Layout/SpaceAfterComma: Space missing after comma.
+W:  2: 20: [Corrected] Lint/UnusedMethodArgument: Unused method argument - xyz. If it's necessary, use _ or _xyz as an argument name to indicate that it won't be used.
+C:  2: 30: [Corrected] Layout/SpaceAroundOperators: Surrounding space missing for operator =.
+C:  3:  1: Style/Documentation: Missing top-level class documentation comment.
+C:  3:  4: [Corrected] Layout/TrailingEmptyLines: Final newline missing.
+C:  3: 28: [Corrected] Style/Semicolon: Do not use semicolons to terminate expressions.
+C:  3: 29: [Corrected] Layout/TrailingWhitespace: Trailing whitespace detected.
+C:  4:  3: [Corrected] Layout/IndentationWidth: Use 2 (not 0) spaces for indentation.
+C:  4: 13: [Corrected] Style/Semicolon: Do not use semicolons to terminate expressions.
+C:  4: 14: [Corrected] Layout/TrailingWhitespace: Trailing whitespace detected.
+W:  5:  1: [Corrected] Layout/DefEndAlignment: end at 5, 0 is not aligned with def at 3, 2.
+
+1 file inspected, 16 offenses detected, 14 offenses corrected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.61
+  version: 0.0.62
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -111,6 +111,8 @@ files:
 - lib/k_builder.rb
 - lib/k_builder/base_builder.rb
 - lib/k_builder/base_configuration.rb
+- lib/k_builder/commands/base_command.rb
+- lib/k_builder/commands/rubo_cop_command.rb
 - lib/k_builder/configuration.rb
 - lib/k_builder/file_segments.rb
 - lib/k_builder/version.rb
@@ -121,6 +123,7 @@ files:
 - usage/_out5.png
 - usage/_usage_folder_after.png
 - usage/_usage_folder_before.png
+- "~/last_cop.txt"
 homepage: http://appydave.com
 licenses:
 - MIT