k_builder 0.0.58 → 0.0.63

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f173e365f4bece5981d87548e67b32f9748e2ae8438d2d3bb54c121de957ec87
-  data.tar.gz: 3d2c0d23e74b0049a112f8e175fa6dce05a1afad90b80f77a63f82d3231c772a
+  metadata.gz: 260817fcc90386176ab82712c52a9a15e5a822b04f348a1b3f5b9ba7ea57c0dd
+  data.tar.gz: 68587734f564fac66c1fe8378cb417f81a88539cfa1cb58f08d34a29dca288ff
 SHA512:
-  metadata.gz: 63901b9242e0933f4d6b639fbdbba2212b5f37d614b1cf43cf7ace40d97560bd0afb47cba1879c4e2ba9d923f52c12f5456ce03c734a77d63472977adc996184
-  data.tar.gz: eec21944c6e4d9cc64f2fa841ecbe1c655f14146626e04152b9ad152824b19f0a1d7450346781aaba1f0d4994649d99faa00ea39a5f40714a1df143b0adbc22a
+  metadata.gz: 57099e14149c32c39e02d85322bfa241ba5525ffe939a59824a21a67738db77a4fae2eb070cb777feb85dcaf9aa7113d107a53ed2be15e1219607a7f271f4852
+  data.tar.gz: e2b5a3aa292859d76c69f70ff0e99d20fd2b0f5ea67be17c20f4cf338f3c5be5fb37370528f44c64ad2376a8b22f1ecd21f011581f688b72dbf60cb7f830b5c0

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   Exclude:
     - "_/**/*"
     - "spec/samples/**/*"
+    - "bin/*"
 
 Metrics/BlockLength:
   Exclude:

data/bin/k

@@ -5,7 +5,7 @@
 #       chmod +x bin/k
 
 help = %(
-----------------------------------------------------------------------
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ----------------------------------------------------------------------
 Klue Scripts - Help
 ----------------------------------------------------------------------
 k                       - This Help File

data/k_builder.gemspec

@@ -42,6 +42,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'k_log', '~> 0'
   spec.add_dependency 'k_type', '~> 0'
   spec.add_dependency 'k_util', '~> 0'
+  spec.add_dependency 'rubocop', '~> 1.8'
+
   # spec.add_dependency "anyway_config"     , ">= 2.0.0"
   # spec.add_dependency "config"     , ">= 3.0.0"
 end

data/lib/k_builder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rubocop'
+
 require 'k_log'
 require 'k_util'
 require 'k_type'
@@ -8,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

@@ -62,6 +62,8 @@ module KBuilder
     def debug
       log.subheading 'kbuilder'
 
+      log.kv 'current folder key' , current_folder_key
+      log.kv 'current folder'     , target_folder
       target_folders.debug(title: 'target_folders')
 
       log.info ''
@@ -94,6 +96,7 @@ module KBuilder
     # @option opts [String] :to Recipient email
     # @option opts [String] :body The email's body
     def add_file(file, **opts)
+      # move to command
       full_file = opts.key?(:folder_key) ? target_file(file, folder: opts[:folder_key]) : target_file(file)
 
       # Need logging options that can log these internal details
@@ -111,6 +114,16 @@ module KBuilder
     end
     alias touch add_file # it is expected that you would not supply any options, just a file name
 
+    def make_folder(folder_key = nil, sub_path: nil)
+      folder_key  = current_folder_key if folder_key.nil?
+      folder      = target_folder(folder_key)
+      folder      = File.join(folder, sub_path) unless sub_path.nil?
+
+      FileUtils.mkdir_p(folder)
+
+      self
+    end
+
     # Add content to the clipboard
     #
     # @option opts [String] :content Supply the content that you want to write to the file
@@ -122,6 +135,7 @@ module KBuilder
     # @option opts [String] :to Recipient email
     # @option opts [String] :body The email's body
     def add_clipboard(**opts)
+      # move to command
       content = process_any_content(**opts)
 
       begin
@@ -139,6 +153,7 @@ module KBuilder
     alias clipboard_copy add_clipboard
 
     def vscode(*file_parts, folder: current_folder_key)
+      # move to command
       file = target_file(*file_parts, folder: folder)
 
       rc "code #{file}"
@@ -305,6 +320,15 @@ module KBuilder
       Handlebars::Helpers::Template.render(template_content, opts) unless template_content.nil?
     end
 
+    def run_cop(file, **opts)
+      command = Commands::RuboCopCommand.new(file, builder: self, **opts)
+      command.execute
+
+      self
+    end
+
+    # Need to handle absolute files, see
+    # /Users/davidcruwys/dev/printspeak/reference_application/printspeak-domain/.builders/presentation/presentation_builder/commands/copy_ruby_resource_command.rb
     def run_prettier(file, log_level: :log)
       # command = "prettier --check #{file} --write #{file}"
       command = "npx prettier --loglevel #{log_level} --write #{file}"

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' << File.expand_path('~/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.58'
+  VERSION = '0.0.63'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.58
+  version: 0.0.63
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-26 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: "    K Builder provides various fluent builders for initializing applications
   with different language requirements\n"
 email:
@@ -97,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