k_builder 0.0.27 → 0.0.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad123a63da5538fbf3c598f39f6af371760f01dcd90320f7d4c43cfa081c2a04
-  data.tar.gz: b851793f9e4716209fc5a49183d4bb49257e71648515a0dfb4c185581adbd604
+  metadata.gz: 528f2587aacba6aa1d13d32737aa081b3ebb5364d3bc7e4628a2935a3746ff15
+  data.tar.gz: bb780d8e64e7c814e0b51c8561537a2cbdc31a1ab81f5ee4c78e8d3bb3fa1e89
 SHA512:
-  metadata.gz: 1f528ed1fecbc4776e7a5315d844207bb819e9cda4a4b43ff508ccbaf56e4b1e844f53824f50857a57051b8d5b5c8f7b3aeea0528767cb2dd809e1b55c2077cf
-  data.tar.gz: 38f600a8f7016f6f8aed25b5745122efd8b1e7e3f10a77d47a56cee3b54b2885ac7f563f8e1bba1d3ee17ef00fda870b98764ff858e256b47835dfc55e034dbb
+  metadata.gz: 2d1dfa3e5875b691576390c970d8005036244566277fee71bbaebe5fc8e63e43588b87780c7616d8e5e07df838dcc3f2ccbf2d4edad8689d2308b8ce41e780e0
+  data.tar.gz: 2eda2bb2b6caa396b0a7ffa0052d22e1bd98fc2931fbb3eb1352ff0b2e0c4fe86880c70e947f456d862d7279bf862f948ffb1c8eea9f9581b29257eb75ded468

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/lib/k_builder.rb

@@ -3,9 +3,11 @@
 require 'k_builder/version'
 require 'k_builder/base_builder'
 require 'k_builder/base_configuration'
-require 'k_builder/builder'
 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'
 

data/lib/k_builder/base_builder.rb

@@ -8,7 +8,11 @@ module KBuilder
   #             Setter methods (are NOT fluent) can be created as needed
   #             these methods would not be prefixed with the set_
   class BaseBuilder
-    attr_reader :hash
+    attr_reader :configuration
+
+    attr_accessor :target_folders
+
+    attr_accessor :template_folders
 
     # Factory method that provides a builder for a specified structure
     # runs through a configuration block and then builds the final structure
@@ -20,112 +24,282 @@ module KBuilder
 
     # Create and initialize the builder.
     #
-    # Initialization can be done via any of these three sequential steps.
-    #   - Configuration hash
-    #   - After new event
-    #   - Configuration block (lambda)
-    #
     # @return [Builder] Returns the builder via fluent interface
     def self.init(configuration = nil)
       builder = new(configuration)
 
-      builder.after_new
-
       yield(builder) if block_given?
 
       builder
     end
 
-    # Use after_new to massage hash values that come in via
-    # configuration into more complex values
-    #
-    # Abstract method
-    def after_new; end
-
     # assigns a builder hash and defines builder methods
     def initialize(configuration = nil)
-      @hash = {}
-
-      unless configuration.nil?
-        raise KBuilder::StandardError, 'Unknown configuration object' unless configuration.is_a?(Hash)
+      configuration = KBuilder.configuration if configuration.nil?
 
-        hash.merge!(configuration)
-      end
+      @configuration = configuration
 
-      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
-      raise NotImplementedError
+      @target_folders = configuration.target_folders.clone
+      @template_folders = configuration.template_folders.clone
     end
 
     # @return [Hash/StrongType] Returns data object, can be a hash
     #                           or strong typed object that you
     #                           have wrapped around the hash
     def build
-      hash
-    end
-
-    # 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
+      raise NotImplementedError
+    end
+
+    def to_h
+      {
+        target_folders: target_folders.to_h,
+        template_folders: template_folders.to_h
+      }
+    end
+
+    # ----------------------------------------------------------------------
+    # Fluent interface
+    # ----------------------------------------------------------------------
+
+    # Internal Actions are considered helpers for the builder, they do
+    # something useful, but they do not tend to implement fluent interfaces.
     #
-    # @return [Builder] Returns the builder via fluent interface
-    def define_builder_setter_methods
-      builder_setter_methods.each { |method| define_builder_method(method) }
+    # They some times do actions, they sometimes return information.
+    #
+    # NOTE: [SRP] - These methods should probably be converted into objects
+    # ----------------------------------------------------------------------
+
+    # Add a file to the target location
+    #
+    # @param [String] file The file name with or without relative path, eg. my_file.json or src/my_file.json
+    # @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_file(file, **opts)
+      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)
+
+      File.write(full_file, content)
+
+      # Prettier needs to work with the original file name
+      run_prettier file if opts.key?(:pretty)
+
       self
     end
+    alias touch add_file # it is expected that you would not supply any options, just a file name
 
-    # Defines a method using the convention set_[method_name]
+    # Add content to the clipboard
     #
-    # Convention: Setter methods (are Fluent) and use the prefix set_
-    #             Getter methods (are NOT fluent) and return the stored value
+    # @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
     #
-    # @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
+    # 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
+    #
+    # The following getter/setters can be referenced both inside and outside
+    # of the fluent builder fluent API. They do not implement the fluent
+    # interface unless prefixed by set_.
+    #
+    # set_: Only setters with the prefix _set are considered fluent.
+    # ----------------------------------------------------------------------
+
+    # Target folders and files
+    # ----------------------------------------------------------------------
+
+    def set_current_folder(folder_key)
+      target_folders.current = folder_key
+
+      self
+    end
+    alias cd set_current_folder
+
+    # Fluent adder for target folder (KBuilder::NamedFolders)
+    def add_target_folder(folder_key, value)
+      target_folders.add(folder_key, value)
+
+      self
+    end
+
+    def current_folder_key
+      target_folders.current
+    end
+
+    # Get target folder by 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
+    #
+    # 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
+    # ----------------------------------------------------------------------
+
+    # Fluent adder for template folder (KBuilder::LayeredFolders)
+    def add_template_folder(folder_key, value)
+      template_folders.add(folder_key, value)
+
+      self
+    end
+
+    # Get for template folder
+    def get_template_folder(folder_key)
+      template_folders.get(folder_key)
+    end
+
+    # Gets a template_file relative to the template folder, looks first in
+    # local template folder and if not found, looks in global template folder
+    def find_template_file(file_parts)
+      template_folders.find_file(file_parts)
+    end
+
+    # Building content from templates
+    # ----------------------------------------------------------------------
+
+    # Use content from a a selection of content sources
+    #
+    # @option opts [String] :content Just pass through the :content as is.
+    # @option opts [String] :content_file Read content from the :content_file
+    #
+    # Future options
+    # @option opts [String] :content_loren [TODO]Create Loren Ipsum text as a :content_loren count of words
+    # @option opts [String] :content_url Read content from the :content_url
+    #
+    # @return Returns some content
+    def use_content(**opts)
+      return opts[:content] unless opts[:content].nil?
+
+      return unless opts[:content_file]
+
+      cf = opts[:content_file]
+
+      return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf)
+
+      File.read(cf)
+    end
+
+    # Use template from a a selection of template sources
+    #
+    # @option opts [String] :template Just pass through the :template as is.
+    # @option opts [String] :template_file Read template from the :template_file
+    #
+    # @return Returns some template
+    def use_template(**opts)
+      return opts[:template] unless opts[:template].nil?
+
+      return unless opts[:template_file]
+
+      tf = find_template_file(opts[:template_file])
+
+      return "template not found: #{opts[:template_file]}" if tf.nil?
+
+      File.read(tf)
+    end
+
+    # Process content will take any one of the following
+    #  - Raw content
+    #  - File based content
+    #  - Raw template (translated via handlebars)
+    #  - File base template (translated via handlebars)
+    #
+    # Process any of the above inputs to create final content output
+    #
+    # @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 transformed using handlebars
+    # @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
+    def process_any_content(**opts)
+      raw_content = use_content(**opts)
+
+      return raw_content if raw_content
+
+      template_content = use_template(**opts)
+
+      Handlebars::Helpers::Template.render(template_content, opts) unless template_content.nil?
+    end
+
+    def run_prettier(file, log_level: :log)
+      # command = "prettier --check #{file} --write #{file}"
+      command = "npx prettier --loglevel #{log_level} --write #{file}"
+
+      run_command command
+    end
+
+    def run_command(command)
+      # Deep path create if needed
+      tf = target_folder
+
+      FileUtils.mkdir_p(tf)
+
+      build_command = "cd #{tf} && #{command}"
+
+      puts build_command
+
+      system(build_command)
     end
+    alias rc run_command
   end
 end

data/lib/k_builder/base_configuration.rb

@@ -16,18 +16,38 @@ module KBuilder
       end
     end
 
-    def to_hash
+    # move out into module
+    def to_h
       hash = {}
       instance_variables.each do |var|
         value = instance_variable_get(var)
 
-        value = value.to_hash if value.is_a?(KBuilder::BaseConfiguration)
+        value = KBuilder.data.struct_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

data/lib/k_builder/configuration.rb

@@ -21,23 +21,41 @@ module KBuilder
 
   # Configuration class
   class Configuration < BaseConfiguration
-    attr_accessor :target_folder
-    attr_accessor :template_folder
-    attr_accessor :global_template_folder
+    attr_accessor :target_folders
+    attr_accessor :template_folders
 
     def initialize
       super
-      @target_folder = Dir.getwd
-      @template_folder = File.join(Dir.getwd, '.templates')
-      @global_template_folder = nil
+      # @target_folder = Dir.getwd
+      # @template_folder = File.join(Dir.getwd, '.templates')
+      # @global_template_folder = nil
+      @target_folders = NamedFolders.new
+      @template_folders = 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
       puts '-' * 120
       puts 'kbuilder base configuration'
-      kv 'target_folder'         , target_folder
-      kv 'template_folder'       , template_folder
-      kv 'global_template_folder', global_template_folder
+
+      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
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/k_builder/data_helper.rb

@@ -31,13 +31,15 @@ module KBuilder
       end
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # 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
@@ -53,7 +55,7 @@ module KBuilder
         end
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def clean_symbol(value)
       return value if value.nil?

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

@@ -0,0 +1,104 @@
+# 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

@@ -0,0 +1,116 @@
+# 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

data/lib/k_builder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.51
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -55,9 +55,11 @@ files:
 - lib/k_builder.rb
 - lib/k_builder/base_builder.rb
 - lib/k_builder/base_configuration.rb
-- lib/k_builder/builder.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/builder.rb

@@ -1,258 +0,0 @@
-# frozen_string_literal: true
-
-module KBuilder
-  # Base builder defines builder methods, build method and configuration
-  class Builder < KBuilder::BaseBuilder
-    # builder_setter_methods = %w[].freeze
-    # target_folder
-    # template_folder
-    # global_template_folder
-
-    def initialize(configuration = nil)
-      configuration = KBuilder.configuration.to_hash if configuration.nil?
-
-      super(configuration)
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def after_new
-      # ensure that any configured folders are expanded
-      self.target_folder = hash['target_folder'] unless hash['target_folder'].nil?
-      self.template_folder = hash['template_folder'] unless hash['template_folder'].nil?
-      self.global_template_folder = hash['global_template_folder'] unless hash['global_template_folder'].nil?
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    # Return an array of symbols to represent the fluent setter methods in this builder.
-    def builder_setter_methods
-      # Currently I have manually created my settings because I needed custom
-      # logic in the settings to handle path expansion
-      []
-    end
-
-    # def build
-    #   # SomeDryStruct.new(hash)
-    # end
-
-    # ----------------------------------------------------------------------
-    # Fluent interface
-    # ----------------------------------------------------------------------
-
-    # Add a file to the target location
-    #
-    # @param [String] file The file name with or without relative path, eg. my_file.json or src/my_file.json
-    # @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_file(file, **opts)
-      full_file = target_file(file)
-
-      FileUtils.mkdir_p(File.dirname(full_file))
-
-      content = process_any_content(**opts)
-
-      File.write(full_file, content)
-
-      # Prettier needs to work with the original file name
-      run_prettier file if opts.key?(:pretty)
-
-      self
-    end
-
-    # ----------------------------------------------------------------------
-    # Attributes: Think getter/setter
-    #
-    # The following getter/setters can be referenced both inside and outside
-    # of the fluent builder fluent API. They do not implement the fluent
-    # interface unless prefixed by set_.
-    #
-    # set_: Only setters with the prefix _set are considered fluent.
-    # ----------------------------------------------------------------------
-
-    # Target folder
-    # ----------------------------------------------------------------------
-
-    # Fluent setter for target folder
-    def set_target_folder(value)
-      self.target_folder = value
-
-      self
-    end
-
-    # Setter for target folder
-    def target_folder=(value)
-      hash['target_folder'] = File.expand_path(value)
-    end
-
-    # Getter for target folder
-    def target_folder
-      hash['target_folder']
-    end
-
-    # Template folder
-    # ----------------------------------------------------------------------
-
-    # Fluent setter for template folder
-    def set_template_folder(value)
-      self.template_folder = value
-
-      self
-    end
-
-    # Setter for template folder
-    # Refactor: Make Private
-    def template_folder=(value)
-      hash['template_folder'] = File.expand_path(value)
-    end
-
-    # Getter for template folder
-    # Refactor: generate
-    def template_folder
-      hash['template_folder']
-    end
-
-    # Global Target folder
-    # ----------------------------------------------------------------------
-
-    # Fluent setter for global template folder
-    def set_global_template_folder(value)
-      self.global_template_folder = value
-
-      self
-    end
-
-    # Setter for global template folder
-    # Refactor: Make Private
-    def global_template_folder=(value)
-      hash['global_template_folder'] = File.expand_path(value)
-    end
-
-    # Setter for global template folder
-    # Refactor: generate
-    def global_template_folder
-      hash['global_template_folder']
-    end
-
-    # Internal Actions are considered helpers for the builder, they do
-    # something useful, but they do not tend to implement fluent interfaces.
-    #
-    # They some times do actions, they sometimes return information.
-    #
-    # NOTE: [SRP] - These methods should probably be converted into objects
-    # ----------------------------------------------------------------------
-
-    # Gets a target_file relative to target folder
-    def target_file(file)
-      File.join(target_folder, file)
-    end
-
-    # Gets a template_file relative to the template folder
-    def template_file(file)
-      File.join(template_folder, file)
-    end
-
-    # Gets a global_template_file relative to the global template folder
-    def global_template_file(file)
-      File.join(global_template_folder, file)
-    end
-
-    # Gets a template_file relative to the template folder, looks first in
-    # local template folder and if not found, looks in global template folder
-    def find_template_file(file)
-      full_file = template_file(file)
-      return full_file if File.exist?(full_file)
-
-      full_file = global_template_file(file)
-      return full_file if File.exist?(full_file)
-
-      # File not found
-      nil
-    end
-
-    # Use content from a a selection of content sources
-    #
-    # @option opts [String] :content Just pass through the :content as is.
-    # @option opts [String] :content_file Read content from the :content_file
-    #
-    # Future options
-    # @option opts [String] :content_loren [TODO]Create Loren Ipsum text as a :content_loren count of words
-    # @option opts [String] :content_url Read content from the :content_url
-    #
-    # @return Returns some content
-    def use_content(**opts)
-      return opts[:content] unless opts[:content].nil?
-
-      return unless opts[:content_file]
-
-      cf = opts[:content_file]
-
-      return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf)
-
-      File.read(cf)
-    end
-
-    # Use template from a a selection of template sources
-    #
-    # @option opts [String] :template Just pass through the :template as is.
-    # @option opts [String] :template_file Read template from the :template_file
-    #
-    # @return Returns some template
-    def use_template(**opts)
-      return opts[:template] unless opts[:template].nil?
-
-      return unless opts[:template_file]
-
-      tf = find_template_file(opts[:template_file])
-
-      return "template not found: #{opts[:template_file]}" if tf.nil?
-
-      File.read(tf)
-    end
-
-    # Process content will take any one of the following
-    #  - Raw content
-    #  - File based content
-    #  - Raw template (translated via handlebars)
-    #  - File base template (translated via handlebars)
-    #
-    # Process any of the above inputs to create final content output
-    #
-    # @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 transformed using handlebars
-    # @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
-    def process_any_content(**opts)
-      raw_content = use_content(**opts)
-
-      return raw_content if raw_content
-
-      template_content = use_template(**opts)
-
-      Handlebars::Helpers::Template.render(template_content, opts) unless template_content.nil?
-    end
-
-    def run_prettier(file, log_level: :log)
-      # command = "prettier --check #{file} --write #{file}"
-      command = "npx prettier --loglevel #{log_level} --write #{file}"
-
-      run_command command
-    end
-
-    def run_command(command)
-      # Deep path create if needed
-      FileUtils.mkdir_p(target_folder)
-
-      build_command = "cd #{target_folder} && #{command}"
-
-      puts build_command
-
-      system(build_command)
-    end
-    alias rc run_command
-  end
-end