k_builder 0.0.57 → 0.0.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fabea0178e317cd8bd8658d91b8813a143e48a8af8710465f5531cfba00535
-  data.tar.gz: b86a69632dac4f08256af550addfea622cd78d26dec7b92e5801f087bd917da7
+  metadata.gz: c3544040b2994f74c65d824516980a5ca980d441c53e97629920c23513cf76a2
+  data.tar.gz: e0c8e494f82a58e1564f59cfb66f960f6a99561a3cc28bfab81c17a77a3b4f8d
 SHA512:
-  metadata.gz: e23dfcad31466228dca0ada1a183ff422878a0d5893358f3561fb545748c5a91f1b1e6ed123f5bae2d1117b72c4605cfc08e68c7c2993fb86df0387a2abe7325
-  data.tar.gz: 8c563d0d7aebb402540852839b55e14c639c1a451e837345b3913f72f6674a3db894089a966d107cc80b3d65ea1c3f720d3716e278bfeac4397c3231dca5c141
+  metadata.gz: 8a27d1f32b26b8878260c11f15a0285b64a65769d9b17631cb05f9c772deab1ddf97bb3f7db9ab392efd9d9b257344bb85272827de19228905b9fe4493d6a485
+  data.tar.gz: f1a237017caff54b821d750dc9e467ec659a7127abae3d9640afe4a997c83afd9347c0113c99eb60d78c849875d26c34305983dbfc478d9e33a6be229ad8149f

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

@@ -8,6 +8,8 @@ module KBuilder
   #             Setter methods (are NOT fluent) can be created as needed
   #             these methods would not be prefixed with the set_
   class BaseBuilder
+    include KLog::Logging
+
     attr_reader :configuration
 
     attr_accessor :target_folders
@@ -57,6 +59,19 @@ module KBuilder
       }
     end
 
+    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 ''
+
+      template_folders.debug(title: 'template folders (search order)')
+      ''
+    end
+
     # ----------------------------------------------------------------------
     # Fluent interface
     # ----------------------------------------------------------------------
@@ -81,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
@@ -92,11 +108,22 @@ module KBuilder
 
       # Prettier needs to work with the original file name
       run_prettier file if opts.key?(:pretty)
+      # Need support for rubocop -a
 
       self
     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
@@ -108,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
@@ -125,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}"
@@ -234,9 +263,19 @@ module KBuilder
 
       return unless opts[:content_file]
 
-      cf = opts[:content_file]
+      # NOTE: when using content file, you still want to search for it in the template folders, I THINK?
+      cf = find_template_file(opts[:content_file])
+
+      return "content not found: #{opts[:content_file]}" if cf.nil?
+
+      # cf = opts[:content_file]
+
+      # unless File.exist?(cf)
+      #   cf_from_template_folders = find_template_file(cf)
+      #   return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf_from_template_folders)
 
-      return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf)
+      #   cf = cf_from_template_folders
+      # end
 
       File.read(cf)
     end
@@ -281,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}"
@@ -298,6 +346,8 @@ module KBuilder
 
       puts build_command
 
+      # need to support the fork process options as I was not able to run
+      # k_builder_watch -n because it hid all the following output
       system(build_command)
     end
     alias rc run_command

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/configuration.rb

@@ -48,25 +48,15 @@ module KBuilder
       @template_folders = orig.template_folders.clone
     end
 
-    # rubocop:disable Metrics/AbcSize
     def debug
       log.subheading 'kbuilder base configuration'
 
-      log.section_heading 'target_folders'
-      target_folders.folders.each_key do |key|
-        folder = target_folders.folders[key]
-        log.kv key.to_s, folder
-      end
-      log.info ''
+      target_folders.debug(title: 'target_folders')
 
-      log.section_heading 'template folders (search order)'
+      log.info ''
 
-      template_folders.ordered_keys.each do |key|
-        folder = template_folders.folders[key]
-        log.kv key.to_s, folder
-      end
+      template_folders.debug(title: 'template folders (search order)')
       ''
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/k_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KBuilder
-  VERSION = '0.0.57'
+  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.57
+  version: 0.0.62
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-19 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
@@ -107,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