k_builder 0.0.56 → 0.0.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758519925163c21cae5ef6bd99798577d7481f6bff55d6ce51599ee15bdd1baa
-  data.tar.gz: 89fbffd295334411d71ea48279838e13029ed01e3fa9c5b76be2aea7f1d44c8b
+  metadata.gz: c78906798abec61e633a8e6447baed740f5618025e6ec1733655c5173ee62b43
+  data.tar.gz: fd412c1aab0fa24ea34c2394c43ae77bba5588d4d25c50e890f1dc4a14f84f7e
 SHA512:
-  metadata.gz: a620cc2730bdac7d129de3b7975967d2bea5819213091c7c551a4ed59a480f994617f08fb2649c9aeb46968181f0dea956875c3c6e87d456eacbe29310ab5295
-  data.tar.gz: 3bd54f3c7e9869fbb232239096ac201a62299b292fffa00cfd3612a7fb7f2b43b9242e86d6821142f1ed4743d7e68cff3d2e10789342dd346a8abb2241b3e9c7
+  metadata.gz: bbf46357650901ba2a5af3ba6c9371d6ca4752c281a57f88edcbb9b9264b75fa83afab90d679642dfe0475b4b48d5291fe936f83e70bc61cff193bdc96978105
+  data.tar.gz: a41800fce5dfe7297995317eed2441f1bd27d52e3af4def56558dcad53e1390c75cf4a699cd4f9fa2b90b76087d86c011b7204ff14a161be0b490edef09e3de9

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'
@@ -20,5 +22,5 @@ if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
   namespace = 'KBuilder::Version'
   file_path = $LOADED_FEATURES.find { |f| f.include?('k_builder/version') }
   version   = KBuilder::VERSION.ljust(9)
-  puts "#{namespace.ljust(40)} : #{version.ljust(9)} : #{file_path}"
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
 end

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]
 
-      return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf)
+      # 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)
+
+      #   cf = cf_from_template_folders
+      # end
 
       File.read(cf)
     end
@@ -281,6 +320,17 @@ 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
+
+      cli.run(opts)
+    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 +348,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/base_configuration.rb

@@ -1,63 +1,64 @@
-# frozen_string_literal: true
-
-module KBuilder
-  # Base configuration object for all k_builder* GEM
-  class BaseConfiguration
-    class << self
-      # Attach a child configuration with it's own settings to a parent configuration
-      #
-      # @param [Class] klass_child what class would you like as the child
-      # @param [Class] klass_parent what class would you like to extend with a new child configuration
-      # @param [Symbol] accessor_name what is the name of the accessor that you are adding
-      def attach_config_to_parent(klass_child, klass_parent, accessor_name)
-        # Create a memoized getter to an instance of the attaching class (:klass_child)
-        #
-        # def third_party
-        #   @third_party ||= KBuilder::ThirdPartyGem::Configuration.new
-        # end
-        klass_parent.send(:define_method, accessor_name) do
-          return instance_variable_get("@#{accessor_name}") if instance_variable_defined?("@#{accessor_name}")
-
-          instance_variable_set("@#{accessor_name}", klass_child.new)
-        end
-      end
-      alias attach_to attach_config_to_parent
-    end
-
-    # move out into module
-    def to_h
-      hash = {}
-      instance_variables.each do |var|
-        value = instance_variable_get(var)
-
-        value = KUtil.data.to_hash(value) if complex_type?(value)
-
-        hash[var.to_s.delete('@')] = value
-      end
-      hash
-    end
-
-    # Any basic (aka primitive) type
-    def basic_type?(value)
-      value.is_a?(String) ||
-        value.is_a?(Symbol) ||
-        value.is_a?(FalseClass) ||
-        value.is_a?(TrueClass) ||
-        value.is_a?(Integer) ||
-        value.is_a?(Float)
-    end
-
-    # Anything container that is not a regular class
-    def complex_type?(value)
-      value.is_a?(Array) ||
-        value.is_a?(Hash) ||
-        value.is_a?(Struct) ||
-        value.is_a?(OpenStruct) ||
-        value.respond_to?(:to_h)
-    end
-
-    def kv(name, value)
-      puts "#{name.rjust(30)} : #{value}"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module KBuilder
+  # Base configuration object for all k_builder* GEM
+  class BaseConfiguration
+    class << self
+      # Attach a child configuration with it's own settings to a parent configuration
+      #
+      # @param [Class] klass_child what class would you like as the child
+      # @param [Class] klass_parent what class would you like to extend with a new child configuration
+      # @param [Symbol] accessor_name what is the name of the accessor that you are adding
+      def attach_config_to_parent(klass_child, klass_parent, accessor_name)
+        # Create a memoized getter to an instance of the attaching class (:klass_child)
+        #
+        # def third_party
+        #   @third_party ||= KBuilder::ThirdPartyGem::Configuration.new
+        # end
+        klass_parent.send(:define_method, accessor_name) do
+          return instance_variable_get("@#{accessor_name}") if instance_variable_defined?("@#{accessor_name}")
+
+          instance_variable_set("@#{accessor_name}", klass_child.new)
+        end
+      end
+      alias attach_to attach_config_to_parent
+    end
+
+    # move out into module
+    def to_h
+      hash = {}
+      instance_variables.each do |var|
+        value = instance_variable_get(var)
+
+        value = KUtil.data.to_hash(value) if complex_type?(value)
+
+        hash[var.to_s.delete('@')] = value
+      end
+      hash
+    end
+
+    # This code is being moved into k_util (data)
+    # Any basic (aka primitive) type
+    def basic_type?(value)
+      value.is_a?(String) ||
+        value.is_a?(Symbol) ||
+        value.is_a?(FalseClass) ||
+        value.is_a?(TrueClass) ||
+        value.is_a?(Integer) ||
+        value.is_a?(Float)
+    end
+
+    # Anything container that is not a regular class
+    def complex_type?(value)
+      value.is_a?(Array) ||
+        value.is_a?(Hash) ||
+        value.is_a?(Struct) ||
+        value.is_a?(OpenStruct) ||
+        value.respond_to?(:to_h)
+    end
+
+    def kv(name, value)
+      puts "#{name.rjust(30)} : #{value}"
+    end
+  end
+end

data/lib/k_builder/configuration.rb

@@ -1,72 +1,62 @@
-# frozen_string_literal: true
-
-# Attach configuration to the KBuilder module
-module KBuilder
-  # Configuration for webpack5/builder
-  class << self
-    attr_writer :configuration
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.reset
-    @configuration = Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  # Does this class need to move out into k_types?
-  # It is being used with k_manager in a similar fashion
-  #
-  # Configuration class
-  class Configuration < BaseConfiguration
-    include KLog::Logging
-
-    # Target folders provide a set named folders that can be written to
-    attr_accessor :target_folders
-
-    # Template folders provides layered folders that templates can exist within
-    attr_accessor :template_folders
-
-    def initialize
-      super
-      # @target_folder = Dir.getwd
-      # @template_folder = File.join(Dir.getwd, '.templates')
-      # @global_template_folder = nil
-      @target_folders = KType::NamedFolders.new
-      @template_folders = KType::LayeredFolders.new
-    end
-
-    def initialize_copy(orig)
-      super(orig)
-
-      @target_folders = orig.target_folders.clone
-      @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 ''
-
-      log.section_heading 'template folders (search order)'
-
-      template_folders.ordered_keys.each do |key|
-        folder = template_folders.folders[key]
-        log.kv key.to_s, folder
-      end
-      ''
-    end
-    # rubocop:enable Metrics/AbcSize
-  end
-end
+# frozen_string_literal: true
+
+# Attach configuration to the KBuilder module
+module KBuilder
+  # Configuration for webpack5/builder
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  # Does this class need to move out into k_types?
+  # It is being used with k_manager in a similar fashion
+  #
+  # Configuration class
+  class Configuration < BaseConfiguration
+    include KLog::Logging
+
+    # Target folders provide a set named folders that can be written to
+    attr_accessor :target_folders
+
+    # Template folders provides layered folders that templates can exist within
+    attr_accessor :template_folders
+
+    def initialize
+      super
+      # @target_folder = Dir.getwd
+      # @template_folder = File.join(Dir.getwd, '.templates')
+      # @global_template_folder = nil
+      @target_folders = KType::NamedFolders.new
+      @template_folders = KType::LayeredFolders.new
+    end
+
+    def initialize_copy(orig)
+      super(orig)
+
+      @target_folders = orig.target_folders.clone
+      @template_folders = orig.template_folders.clone
+    end
+
+    def debug
+      log.subheading 'kbuilder base configuration'
+
+      target_folders.debug(title: 'target_folders')
+
+      log.info ''
+
+      template_folders.debug(title: 'template folders (search order)')
+      ''
+    end
+  end
+end

data/lib/k_builder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.56
+  version: 0.0.61
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-06-30 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: