k_builder 0.0.37 → 0.0.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '094bf462c5d39f6b39aa8df40e75d4623af9c5d1f6594109cb7afb4e9e82bfb2'
-  data.tar.gz: 4dd0400aa1a64e797c56aacc53d3af7ef4cda66c5aca9bbc32f13aeb1604e481
+  metadata.gz: 3f0600bab4a6de1743b8be1d7f14f4cc20e997edc60201e920fd3102086472bf
+  data.tar.gz: ad10a064ebf45d8e73aac310b7c6725193f3cf36bacc847f0fe2e312919c0b1b
 SHA512:
-  metadata.gz: a6196e9716b5e86f7cbdb5dba23252a5e7c477da329e2aa8a6a9989c59b790be10316130a9286fd6c5041c49d85a10282dc206a52ef5c73ce2ddf66601ad3c72
-  data.tar.gz: 301407050730841e77aad746a32bf046c636970346c4cda6f158699a571d125617eef1e15159a6495ba81fff19c125e25578a57f84407958a19c12f73f706dea
+  metadata.gz: b3c82683757bf60d630b3e9e6827b57abbaca1bbd83b132e7dd1433961f8946acd651beb5eebf8614cbcd5ad544ea7aa8b7bfd7a7c48feadf87a3e0d8c651acf
+  data.tar.gz: d8c7778a7501ccf7a76611bf15aae7d3824658e48e5249c2a1f7879fad7b18ae354323fe92794171737b1ddd386e38ab254f9f399895acd8af86014f3688e98c

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/STORIES.md

@@ -10,14 +10,34 @@ As a Polyglot Developer, I want to be up and running in any development language
 
 As a Polyglot Developer, I want to be up and running in any development language with consistency, so I am productive and using best practices [EPIC]
 
-### Tasks next on list
+As a Developer, I need builders to be easier to use, so I am more efficient
 
-BaseBuilder
+- Logging needs to be more informative
+- Template errors need to log the template and the filename
+- add_file with template_file: needs to support optional filename that is the same as the template_file (or use a token, eg. $TF_PATH$, $TF_NAME$, $TF_FILE$
+- add_file, the files being generated are not being logged
 
 ## Stories and tasks
 
+### Stories - completed
+
+As a Developer, I want have multiple template, so I can group my templates by area of specialty
+
+- Refactor global and app templates to a layered folder array using (First In, Last Out) priority
+- Support subfolders of any template folder (maybe)
+
+As a Developer, I want have multiple output folders, so I can write to multiple locations
+
+- Refactor output folder so that there are multiple named output folders, with :default working the same way as the existing system
+- Support subfolders of any output folder
+- Support output folder change of focus
+
 ### Tasks - completed
 
+WatchBuilder - Build Watcher (as a builder) - [k_builder-watch](https://github.com/klueless-io/k_builder-watch)
+
+Refactor BaseBuilder
+
 Setup RubyGems and RubyDoc
 
 - Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_builder)

data/USAGE.md

@@ -55,26 +55,26 @@ TEXT
 
 builder = KBuilder::Builder.init
 
-builder
-  .add_file('main.rb', template_file: 'class.rb', name: 'main')
-  .add_file('person.rb',
-            template_file: 'model.rb',
-            name: 'person',
-            fields: %i[first_name last_name])
-  .add_file('address.rb',
-            template_file: 'model.rb',
-            name: 'address',
-            fields: %i[street1 street2 post_code state])
-  .add_file('configuration.log.txt',
-            template: template,
-            a: builder.template_folder,
-            b: builder.global_template_folder,
-            c: builder.target_folder)
-  .add_file('css/index.css',
-            template: '{{#each colors}} .{{.}} { color: {{.}} }  {{/each}}',
-            colors: ['red', 'blue', 'green'],
-            pretty: true)
-
+builder.add_file('main.rb', template_file: 'class.rb', name: 'main').add_file(
+  'person.rb',
+  template_file: 'model.rb', name: 'person', fields: %i[first_name last_name]
+).add_file(
+  'address.rb',
+  template_file: 'model.rb',
+  name: 'address',
+  fields: %i[street1 street2 post_code state]
+).add_file(
+  'configuration.log.txt',
+  template: template,
+  a: builder.template_folder,
+  b: builder.global_template_folder,
+  c: builder.target_folder
+).add_file(
+  'css/index.css',
+  template: '{{#each colors}} .{{.}} { color: {{.}} }  {{/each}}',
+  colors: %w[red blue green],
+  pretty: true
+)
 ```
 
 #### Folder Structure (after)
@@ -85,7 +85,7 @@ Folder structure after running the builder
 
 #### main.rb
 
-![main.rb](usage/_out1.png)
+![](usage/_out1.png)
 
 #### person.rb
 
@@ -93,12 +93,12 @@ Folder structure after running the builder
 
 #### address.rb
 
-![person.rb](usage/_out3.png)
+![](usage/_out3.png)
 
 #### configuration.log.txt
 
-![configuration.log.txt](usage/_out4.png)
+![](usage/_out4.png)
 
 #### css/index.css
 
-![css/index.css](usage/_out5.png)
+![](usage/_out5.png)

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,18 +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/named_folders'
-require 'k_builder/layered_folders'
+require 'k_builder/file_segments'
 
 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(40)} : #{version.ljust(9)} : #{file_path}"
 end

data/lib/k_builder/base_builder.rb

@@ -41,16 +41,6 @@ module KBuilder
 
       @target_folders = configuration.target_folders.clone
       @template_folders = configuration.template_folders.clone
-
-      define_builder_setter_methods
-    end
-
-    # Return an array of symbols to represent the fluent
-    # setter methods that you want on your builder.
-    #
-    # Abstract method
-    def builder_setter_methods
-      []
     end
 
     # @return [Hash/StrongType] Returns data object, can be a hash
@@ -91,8 +81,9 @@ module KBuilder
     # @option opts [String] :to Recipient email
     # @option opts [String] :body The email's body
     def add_file(file, **opts)
-      full_file = target_file(file)
+      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
       FileUtils.mkdir_p(File.dirname(full_file))
 
       content = process_any_content(**opts)
@@ -104,6 +95,42 @@ module KBuilder
 
       self
     end
+    alias touch add_file # it is expected that you would not supply any options, just a file name
+
+    # Add content to the clipboard
+    #
+    # @option opts [String] :content Supply the content that you want to write to the file
+    # @option opts [String] :template Supply the template that you want to write to the file, template will be processed  ('nobody') From address
+    # @option opts [String] :content_file File with content, file location is based on where the program is running
+    # @option opts [String] :template_file File with handlebars templated content that will be transformed, file location is based on the configured template_path
+    #
+    # Extra options will be used as data for templates, e.g
+    # @option opts [String] :to Recipient email
+    # @option opts [String] :body The email's body
+    def add_clipboard(**opts)
+      content = process_any_content(**opts)
+
+      begin
+        IO.popen('pbcopy', 'w') { |f| f << content }
+      rescue Errno::ENOENT => e
+        if e.message == 'No such file or directory - pbcopy'
+          # May want to use this GEM in the future
+          # https://github.com/janlelis/clipboard
+          puts 'Clipboard paste is currently only supported on MAC'
+        end
+      end
+
+      self
+    end
+    alias clipboard_copy add_clipboard
+
+    def vscode(*file_parts, folder: current_folder_key)
+      file = target_file(*file_parts, folder: folder)
+
+      rc "code #{file}"
+
+      self
+    end
 
     # ----------------------------------------------------------------------
     # Attributes: Think getter/setter
@@ -125,10 +152,6 @@ module KBuilder
     end
     alias cd set_current_folder
 
-    def current_folder_key
-      target_folders.current
-    end
-
     # Fluent adder for target folder (KBuilder::NamedFolders)
     def add_target_folder(folder_key, value)
       target_folders.add(folder_key, value)
@@ -136,16 +159,40 @@ module KBuilder
       self
     end
 
-    # Get target folder
+    def current_folder_key
+      target_folders.current
+    end
+
+    # Get target folder by folder_key
     #
-    # Defaults to current_target_folder
-    def get_target_folder(folder_key = current_folder_key)
+    # If folder_key not supplied then get the current target folder
+    def target_folder(folder_key = current_folder_key)
       target_folders.get(folder_key)
     end
 
     # Get target file
-    def target_file(file_parts, folder: current_folder_key)
-      File.join(get_target_folder(folder), file_parts)
+    #
+    # If you provide a relative folder, then it will be relative to the :folder parameter
+    #
+    # If the :folder is not set, then it will be relative to the current folder
+    #
+    # @examples
+    #   target_file('abc.txt')
+    #   target_file('xyz/abc.txt')
+    #   target_file('xyz', 'abc.txt')
+    #
+    # If you provide an absolute folder, then it will ignore the :folder parameter
+    #
+    # @examples
+    #   target_file('/abc.txt')
+    #   target_file('/xyz/abc.txt')
+    #   target_file('/xyz', 'abc.txt')
+    def target_file(*file_parts, folder: current_folder_key)
+      # Absolute path
+      return File.join(*file_parts) if Pathname.new(file_parts.first).absolute?
+
+      # Relative to :folder
+      File.join(target_folder(folder), *file_parts)
     end
 
     # Template folder & Files
@@ -243,74 +290,16 @@ module KBuilder
 
     def run_command(command)
       # Deep path create if needed
-      target_folder = get_target_folder
+      tf = target_folder
 
-      FileUtils.mkdir_p(target_folder)
+      FileUtils.mkdir_p(tf)
 
-      build_command = "cd #{target_folder} && #{command}"
+      build_command = "cd #{tf} && #{command}"
 
       puts build_command
 
       system(build_command)
     end
     alias rc run_command
-
-    # TODO
-    # Support Nesting
-    # Support Generation fo the following
-    #   - fluent set_
-    #   - Support setter (non-fluent)
-    #   - Support getter (non-fluent)
-
-    # # builds a nested structure by either builder block or hash
-    # # @param data_structure [type=DataStructure]
-    # # @param builder [type=Builder]
-    # # @param attributes [type=Hash|DataStructure instance]
-    # # @param &block
-    # #
-    # # @return [type=Hash]
-    # def build_nested(data_structure, builder, attributes = {}, &block)
-    #   if block_given?
-    #     builder.build(&block).to_h
-    #   else
-    #     build_hash(data_structure, attributes)
-    #   end
-    # end
-
-    private
-
-    # #
-    # # @param data_structure [type=DataStructure]
-    # # @param attributes [type=Hash, DataStructure]
-    # #
-    # # @return [type=Hash]
-    # def build_hash(data_structure, attributes)
-    #   if attributes.is_a?(data_structure)
-    #     attributes.to_h
-    #   else
-    #     data_structure.new(attributes).to_h
-    #   end
-    # end
-
-    # Defines all of the necessary builder setter methods
-    #
-    # @return [Builder] Returns the builder via fluent interface
-    def define_builder_setter_methods
-      builder_setter_methods.each { |method| define_builder_method(method) }
-      self
-    end
-
-    # Defines a method using the convention set_[method_name]
-    #
-    # Convention: Setter methods (are Fluent) and use the prefix set_
-    #             Getter methods (are NOT fluent) and return the stored value
-    #
-    # @return [Builder] Returns the builder via fluent interface
-    def define_builder_method(method_name)
-      self.class.send(:define_method, "set_#{method_name}") do |value|
-        @hash[method_name.to_s] = value
-        self
-      end
-    end
   end
 end

data/lib/k_builder/base_configuration.rb

@@ -22,7 +22,7 @@ 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

data/lib/k_builder/configuration.rb

@@ -21,6 +21,8 @@ module KBuilder
 
   # Configuration class
   class Configuration < BaseConfiguration
+    include KLog::Logging
+
     attr_accessor :target_folders
     attr_accessor :template_folders
 
@@ -29,8 +31,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)
@@ -42,19 +44,22 @@ module KBuilder
 
     # rubocop:disable Metrics/AbcSize
     def debug
-      puts '-' * 120
-      puts 'kbuilder base configuration'
+      log.subheading 'kbuilder base configuration'
 
-      puts 'target_folders'
+      log.section_heading 'target_folders'
       target_folders.folders.each_key do |key|
         folder = target_folders.folders[key]
-        kv key.to_s, folder
+        log.kv key.to_s, folder
       end
+      log.info ''
+
+      log.section_heading 'template folders (search order)'
 
-      puts 'template folders (search order)'
-      template_folders.ordered_folders.each do |folder|
-        puts folder.to_s
+      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

data/lib/k_builder/file_segments.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module KBuilder
+  # Splits a file into its base parts (file, path, file_name, extension and file_name_only)
+  #
+  # Provides the interpolate helper to rebuild a different filename using those segments
+  class FileSegments
+    attr_reader :file
+    attr_reader :path
+    attr_reader :file_name
+    attr_reader :ext
+    attr_reader :file_name_only
+
+    def initialize(file)
+      @file = file
+      @path = File.dirname(file)
+      @file_name = File.basename(file)
+      @ext = File.extname(file)
+      @file_name_only = File.basename(file, @ext)
+    end
+
+    def interpolate(target_file)
+      # p str.gsub( /#{var}/, 'foo' )   # => "a test foo"
+      target_file
+        .gsub(/\$T_FILE\$/i, file)
+        .gsub(/\$T_PATH\$/i, path)
+        .gsub(/\$T_FILE_NAME\$/i, file_name)
+        .gsub(/\$T_EXT\$/i, ext)
+        .gsub(/\$T_FILE_NAME_ONLY\$/i, file_name_only)
+    end
+  end
+end

data/lib/k_builder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.37
+  version: 0.0.55
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2021-04-05 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,9 +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/layered_folders.rb
-- lib/k_builder/named_folders.rb
+- lib/k_builder/file_segments.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)
-      folder = super(folder_key, folder)
-
-      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,100 +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
-
-    def add(folder_key, folder)
-      # get a predefined folder by symbol
-      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 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