k_builder 0.0.51 → 0.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528f2587aacba6aa1d13d32737aa081b3ebb5364d3bc7e4628a2935a3746ff15
-  data.tar.gz: bb780d8e64e7c814e0b51c8561537a2cbdc31a1ab81f5ee4c78e8d3bb3fa1e89
+  metadata.gz: f173e365f4bece5981d87548e67b32f9748e2ae8438d2d3bb54c121de957ec87
+  data.tar.gz: 3d2c0d23e74b0049a112f8e175fa6dce05a1afad90b80f77a63f82d3231c772a
 SHA512:
-  metadata.gz: 2d1dfa3e5875b691576390c970d8005036244566277fee71bbaebe5fc8e63e43588b87780c7616d8e5e07df838dcc3f2ccbf2d4edad8689d2308b8ce41e780e0
-  data.tar.gz: 2eda2bb2b6caa396b0a7ffa0052d22e1bd98fc2931fbb3eb1352ff0b2e0c4fe86880c70e947f456d862d7279bf862f948ffb1c8eea9f9581b29257eb75ded468
+  metadata.gz: 63901b9242e0933f4d6b639fbdbba2212b5f37d614b1cf43cf7ace40d97560bd0afb47cba1879c4e2ba9d923f52c12f5456ce03c734a77d63472977adc996184
+  data.tar.gz: eec21944c6e4d9cc64f2fa841ecbe1c655f14146626e04152b9ad152824b19f0a1d7450346781aaba1f0d4994649d99faa00ea39a5f40714a1df143b0adbc22a

data/.rubocop.yml

@@ -73,6 +73,9 @@ Layout/EmptyLineBetweenDefs:
   Exclude:
     - "**/spec/**/*"
 
+Style/Documentation:
+  Enabled: false
+
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "**/spec/**/*"

data/Rakefile

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+GEM_NAME = 'k_builder'
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'k_builder/version'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -14,4 +17,15 @@ Rake::ExtensionTask.new('k_builder') do |ext|
   ext.lib_dir = 'lib/k_builder'
 end
 
+desc 'Publish the gem to RubyGems.org'
+task :publish do
+  system 'gem build'
+  system "gem push #{GEM_NAME}-#{KBuilder::VERSION}.gem"
+end
+
+desc 'Remove old *.gem files'
+task :clean do
+  system 'rm *.gem'
+end
+
 task default: %i[clobber compile spec]

data/k_builder.gemspec

@@ -39,6 +39,9 @@ Gem::Specification.new do |spec|
   # spec.extensions    = ['ext/k_builder/extconf.rb']
 
   spec.add_dependency 'handlebars-helpers', '~> 0'
+  spec.add_dependency 'k_log', '~> 0'
+  spec.add_dependency 'k_type', '~> 0'
+  spec.add_dependency 'k_util', '~> 0'
   # spec.add_dependency "anyway_config"     , ">= 2.0.0"
   # spec.add_dependency "config"     , ">= 3.0.0"
 end

data/lib/k_builder.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
+require 'k_log'
+require 'k_util'
+require 'k_type'
 require 'k_builder/version'
 require 'k_builder/base_builder'
 require 'k_builder/base_configuration'
 require 'k_builder/configuration'
-require 'k_builder/data_helper'
 require 'k_builder/file_segments'
-require 'k_builder/named_folders'
-require 'k_builder/layered_folders'
 
 require 'handlebars/helpers/template'
 
 module KBuilder
   # raise KBuilder::Error, 'Sample message'
   class Error < StandardError; end
+end
 
-  # Your code goes here...
+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(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,17 @@ module KBuilder
       }
     end
 
+    def debug
+      log.subheading 'kbuilder'
+
+      target_folders.debug(title: 'target_folders')
+
+      log.info ''
+
+      template_folders.debug(title: 'template folders (search order)')
+      ''
+    end
+
     # ----------------------------------------------------------------------
     # Fluent interface
     # ----------------------------------------------------------------------
@@ -92,6 +105,7 @@ 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
@@ -234,9 +248,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
@@ -298,6 +322,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

@@ -3,17 +3,25 @@
 module KBuilder
   # Base configuration object for all k_builder* GEM
   class BaseConfiguration
-    def self.attach_to(klass_me, klass_target, accessor_name)
-      # Create a memoized getter to an instance of the attaching class (:klass_me)
+    class << self
+      # Attach a child configuration with it's own settings to a parent configuration
       #
-      # def third_party
-      #   @third_party ||= KBuilder::ThirdPartyGem::Configuration.new
-      # end
-      klass_target.send(:define_method, accessor_name) do
-        return instance_variable_get("@#{accessor_name}") if instance_variable_defined?("@#{accessor_name}")
+      # @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_me.new)
+          instance_variable_set("@#{accessor_name}", klass_child.new)
+        end
       end
+      alias attach_to attach_config_to_parent
     end
 
     # move out into module
@@ -22,13 +30,14 @@ module KBuilder
       instance_variables.each do |var|
         value = instance_variable_get(var)
 
-        value = KBuilder.data.struct_to_hash(value) if complex_type?(value)
+        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) ||

data/lib/k_builder/configuration.rb

@@ -19,9 +19,17 @@ module KBuilder
     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
@@ -29,8 +37,8 @@ module KBuilder
       # @target_folder = Dir.getwd
       # @template_folder = File.join(Dir.getwd, '.templates')
       # @global_template_folder = nil
-      @target_folders = NamedFolders.new
-      @template_folders = LayeredFolders.new
+      @target_folders = KType::NamedFolders.new
+      @template_folders = KType::LayeredFolders.new
     end
 
     def initialize_copy(orig)
@@ -40,22 +48,15 @@ module KBuilder
       @template_folders = orig.template_folders.clone
     end
 
-    # rubocop:disable Metrics/AbcSize
     def debug
-      puts '-' * 120
-      puts 'kbuilder base configuration'
-
-      puts 'target_folders'
-      target_folders.folders.each_key do |key|
-        folder = target_folders.folders[key]
-        kv key.to_s, folder
-      end
-
-      puts 'template folders (search order)'
-      template_folders.ordered_folders.each do |folder|
-        puts folder.to_s
-      end
+      log.subheading 'kbuilder base configuration'
+
+      target_folders.debug(title: 'target_folders')
+
+      log.info ''
+
+      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.51'
+  VERSION = '0.0.58'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.51
+  version: 0.0.58
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: k_log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: k_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: k_util
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "    K Builder provides various fluent builders for initializing applications
   with different language requirements\n"
 email:
@@ -56,10 +98,7 @@ files:
 - lib/k_builder/base_builder.rb
 - lib/k_builder/base_configuration.rb
 - lib/k_builder/configuration.rb
-- lib/k_builder/data_helper.rb
 - lib/k_builder/file_segments.rb
-- lib/k_builder/layered_folders.rb
-- lib/k_builder/named_folders.rb
 - lib/k_builder/version.rb
 - usage/_out1.png
 - usage/_out2.png

data/lib/k_builder/data_helper.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-# Attach data helper to the KBuilder module
-module KBuilder
-  # Data helpers/utils for Kbuilder
-  class << self
-    attr_writer :data
-  end
-
-  def self.data
-    @data ||= DataHelper.new
-  end
-
-  # Helper methods attached to the namespace for working with Data
-  #
-  # Usage: KBuilder.data.to_struct(data)
-  class DataHelper
-    # Convert a hash into a deep OpenStruct or array an array
-    # of objects into an array of OpenStruct
-    def to_struct(data)
-      case data
-      when Hash
-        OpenStruct.new(data.transform_values { |v| to_struct(v) })
-
-      when Array
-        data.map { |o| to_struct(o) }
-
-      else
-        # Some primitave type: String, True/False, Symbol or an ObjectStruct
-        data
-      end
-    end
-
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def struct_to_hash(data)
-      # No test yet
-      if data.is_a?(Array)
-        return data.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
-      end
-
-      return struct_to_hash(data.to_h) if !data.is_a?(Hash) && data.respond_to?(:to_h)
-
-      data.each_pair.with_object({}) do |(key, value), hash|
-        case value
-        when OpenStruct, Struct, Hash
-          hash[key] = struct_to_hash(value)
-        when Array
-          # No test yet
-          values = value.map do |v|
-            v.is_a?(OpenStruct) || v.is_a?(Struct) || v.is_a?(Hash) ? struct_to_hash(v) : v
-          end
-          hash[key] = values
-        else
-          hash[key] = value
-        end
-      end
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-    def clean_symbol(value)
-      return value if value.nil?
-
-      value.is_a?(Symbol) ? value.to_s : value
-    end
-  end
-end

data/lib/k_builder/layered_folders.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module KBuilder
-  #
-  # Named folders makes sense for generated/output folders because you may want
-  # more than one type of location to generate output.
-  #
-  # Don't confuse multiple named output folders with sub-paths, when you want to
-  # build up a file name in a child folder, you can do that as part of building
-  # the filename.
-  #
-  # The idea behind named folders is for when you have two or more totally different
-  # outputs that (may live in the a similar location) or live in different locations.
-
-  # Layered folders allow files to be found in any of the searchable folders
-  #
-  # They derive from and thus work just like named folders in that they allow folders
-  # to be stored with easy to remember names/alias's.
-  #
-  # Where they differ is that they are retrieved in preferential search order that is
-  # by default (First In, Last Out) priority aka a Stack (Last In, First Out) or
-  # optionally over ridden via the search_order method
-  #
-  # Layered folders makes sense for use with template files and source data/model
-  # where you can have specific usage files available and if they are not found then
-  # you can use fall-back files in other folders.
-  #
-  # example:
-  #   folders = LayeredFolders.new
-  #   folders.add(:global       , '~/global_templates')
-  #   folders.add(:domain       , '/my-project/domain_templates')
-  #   folders.add(:app          , '/my-project/my-app/.templates')
-  #
-  #   # Find a file and folder will in folders in this order
-  #   # app_templates, then domain_templates and then finally global templates
-  #   # ['/my-project/my-app/.templates', '/my-project/domain_templates', '~/global_templates']
-  #   #
-  #   # Find a file called template1.txt and return its fully-qualified path
-  #   folders.find_file('template1.txt')
-  #
-  #   # As above, but returns the folder only, file name and sub-paths are ignored
-  #   folders.find_file_folder('template1.txt')
-  #   folders.find_file_folder('abc/xyz/deep-template.txt')
-  #
-  #   # If an additional folder is added, say in child configuration that is designed
-  #   # to override some of the global templates, then you can run a search_order
-  #   # method to re-order the templates
-  #
-  #   folders.add(:global_shim  , '~/global_templates_shim')
-  #   folders.search_order(:app, :domain, :global_shim, :global)
-  #
-  # class Builder < KBuilder::BaseBuilder
-  class LayeredFolders < KBuilder::NamedFolders
-    attr_reader :ordered_keys
-    attr_reader :ordered_folders
-
-    def initialize
-      super()
-
-      @ordered_keys = []
-      @ordered_folders = []
-    end
-
-    def initialize_copy(orig)
-      super(orig)
-
-      @ordered_keys = orig.ordered_keys.clone
-      @ordered_folders = orig.ordered_folders.clone
-    end
-
-    def add(folder_key, *folder_parts)
-      folder = super(folder_key, *folder_parts)
-
-      ordered_keys.prepend(folder_key)
-      ordered_folders.prepend(folder)
-
-      folder
-    end
-
-    # File name or array of sub-paths plus file
-    #
-    # Return the folder that a file is found in
-    def find_file(file_parts)
-      folder = find_file_folder(file_parts)
-      folder.nil? ? nil : File.join(folder, file_parts)
-    end
-
-    # File name or array of sub-paths plus file
-    #
-    # Return the folder that a file is found in
-    def find_file_folder(file_parts)
-      ordered_folders.find { |folder| File.exist?(File.join(folder, file_parts)) }
-    end
-
-    def to_h
-      {
-        ordered: {
-          keys: ordered_keys,
-          folders: ordered_folders
-        }
-      }.merge(@folders)
-    end
-  end
-end

data/lib/k_builder/named_folders.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module KBuilder
-  # Named folders allow folders to be stored with easy to remember names/alias's
-  # Secondarily, you can also build up file names based on these named folders.
-  #
-  # Named folders makes sense for generated/output folders because you may want
-  # more than one type of location to generate output.
-  #
-  # Don't confuse multiple named output folders with sub-paths, when you want to
-  # build up a file name in a child folder, you can do that as part of building
-  # the filename.
-  #
-  # The idea behind named folders is for when you have two or more totally different
-  # outputs that (may live in the a similar location) or live in different locations.
-  # Samples:
-  #   name: :code       - generating source code into a project
-  #   name: :slide      - generating slide deck into a documentation folder
-  #   name: :webpack    - folder where you might generate webpack files, e.g. webpack.config.*.json
-  #
-  # example:
-  #   folders = NamedFolders.new
-  #   folders.add(:csharp       , '~/dev/csharp/cool-project')
-  #   folders.add(:package_json , :csharp)
-  #   folders.add(:webpack      , folders.join(:csharp, 'config'))
-  #   folders.add(:builder      , folders.join(:csharp, 'builder'))
-  #   folders.add(:slides       , '~/doc/csharp/cool-project')
-  #
-  #   puts folders.get(:builder)
-  #
-  #   puts folders.get_filename(:csharp, 'Program.cs')
-  #   puts folders.get_filename(:csharp, 'Models/Order.cs')
-  #   puts folders.get_filename(:csharp, 'Models', 'Order.cs')
-  #
-  # Do I need to support :default?
-  class NamedFolders
-    attr_reader :folders
-
-    attr_reader :current
-
-    def initialize
-      @folders = {}
-      @current = nil
-    end
-
-    def initialize_copy(orig)
-      super(orig)
-
-      @folders = orig.folders.clone
-    end
-
-    def current=(folder_key)
-      guard_folder_key(folder_key)
-      @current = folder_key
-    end
-
-    # Add support for file_parts
-    def add(folder_key, *folder_parts)
-      # get a predefined folder by symbol
-      folder = join_folder_parts(folder_parts)
-      if folder.is_a?(Symbol)
-        folder = get(folder)
-      elsif folder.start_with?('~')
-        folder = File.expand_path(folder)
-      end
-
-      @current = folder_key if @current.nil?
-      folders[folder_key] = folder
-    end
-
-    # Get a folder
-    def get(folder_key)
-      guard_folder_key(folder_key)
-      folders[folder_key]
-    end
-
-    # Join the lookup folder key with the subpath folder parts (optionally + filename) and return the folder or filename
-    #
-    # Return fully qualified filename
-    def join(folder_key, *file_folder_parts)
-      folder = get(folder_key)
-
-      File.join(folder, file_folder_parts)
-    end
-    # Get a file name using the lookup folder key and the file name or array of sub-paths plus filename
-    alias get_filename join
-
-    def folder_keys
-      @folders.keys
-    end
-
-    def to_h
-      @folders
-    end
-
-    private
-
-    def join_folder_parts(folder_parts)
-      raise KBuilder::Error, 'No folder part provided' if folder_parts.nil? || folder_parts.length.zero?
-
-      # If only one part, and that can be a folder or :folder_key, then just return it
-      return folder_parts.first if folder_parts.length == 1
-
-      folder_parts = folder_parts.map.with_index do |folder_part, index|
-        folder_part = get(folder_part) if index.zero? && folder_part.is_a?(Symbol)
-        folder_part
-      end
-
-      File.join(folder_parts)
-    end
-
-    def guard_folder_key(folder_key)
-      raise KBuilder::Error, "Folder not found, this folder key not found: #{folder_key}" unless folders.key?(folder_key)
-    end
-  end
-end