k_builder 0.0.40 → 0.0.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 323fb5218f6098e38b7aedb951f8ff7c6aa93e891a9bbe77ffecf4ef2b0385ad
-  data.tar.gz: '085e4f77356020cb7bbbf8b45332d635ef915c80d109fe5101b81ae101446874'
+  metadata.gz: 528f2587aacba6aa1d13d32737aa081b3ebb5364d3bc7e4628a2935a3746ff15
+  data.tar.gz: bb780d8e64e7c814e0b51c8561537a2cbdc31a1ab81f5ee4c78e8d3bb3fa1e89
 SHA512:
-  metadata.gz: 86eb1f2f02fea68c10bfa428e4e415931378ca6d696b041abeb995590f14488e01aa90a19832e697c4faff6dca97b9522d7ac5e3ca734a004ff3b2f7c821c1c3
-  data.tar.gz: 76c486d493078154cafe97ab96870b856cbd9813a18fc6b353210c1aed82a11df7ae039fcef291c4806c505788acef4d85fa1f3199e324cbab293405c653743d
+  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

@@ -5,6 +5,7 @@ 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'
 

data/lib/k_builder/base_builder.rb

@@ -81,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)
@@ -94,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
@@ -134,8 +171,28 @@ module KBuilder
     end
 
     # Get target file
-    def target_file(file_parts, folder: current_folder_key)
-      File.join(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

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

@@ -68,8 +68,8 @@ module KBuilder
       @ordered_folders = orig.ordered_folders.clone
     end
 
-    def add(folder_key, folder)
-      folder = super(folder_key, folder)
+    def add(folder_key, *folder_parts)
+      folder = super(folder_key, *folder_parts)
 
       ordered_keys.prepend(folder_key)
       ordered_folders.prepend(folder)

data/lib/k_builder/named_folders.rb

@@ -54,8 +54,10 @@ module KBuilder
       @current = folder_key
     end
 
-    def add(folder_key, folder)
+    # 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?('~')
@@ -93,6 +95,20 @@ module KBuilder
 
     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

data/lib/k_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KBuilder
-  VERSION = '0.0.40'
+  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.40
+  version: 0.0.51
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -57,6 +57,7 @@ files:
 - 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