k_builder 0.0.19 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f81ce6d464232f632884a2d3c1e04c180551644bf5ce9202a4a5d4a2e20d5c40
-  data.tar.gz: bdc67f51753f3b63944b88ad3f739ba4710bf0981190fd9d7b8ce69eea6493aa
+  metadata.gz: ad123a63da5538fbf3c598f39f6af371760f01dcd90320f7d4c43cfa081c2a04
+  data.tar.gz: b851793f9e4716209fc5a49183d4bb49257e71648515a0dfb4c185581adbd604
 SHA512:
-  metadata.gz: db0ac5f45c53b1a4d7d58e9acfd5bd106402039f1d28d81c998d3279f4b1177980817b284362cd272853735f02eb492a8d131cbcade21dacf707132269b84c75
-  data.tar.gz: 24ff7bfeefa7db10f9a028cbda7695f171a5d7d6095be2a23637a9d3e7e727323512962414d5236d6961d4864aa4aad3521770f33120f2df07740671878a9e70
+  metadata.gz: 1f528ed1fecbc4776e7a5315d844207bb819e9cda4a4b43ff508ccbaf56e4b1e844f53824f50857a57051b8d5b5c8f7b3aeea0528767cb2dd809e1b55c2077cf
+  data.tar.gz: 38f600a8f7016f6f8aed25b5745122efd8b1e7e3f10a77d47a56cee3b54b2885ac7f563f8e1bba1d3ee17ef00fda870b98764ff858e256b47835dfc55e034dbb

data/README.md

@@ -1,29 +1,6 @@
 # K Builder
 
-> K Builder provides various fluent builders for initializing applications with different language requirements
-
-## ToDo
-
-- BuildWatcher (as a builder)
-- AppBuilder
-- BaseBuilder
-- WebBuilder
-  - PackageBuilder
-  - Webpack5Builder
-  - ReactBuilder
-  - SlideDeckBuilder
-  - JavscriptBuilder
-- SolutionBuilder
-- DotnetBuilder
-  - C#Console
-  - C#Mvc
-- RubyBuilder
-  - RubyGem
-  - RailsApp
-- PythonBuilder
-- DddBuilder
-  - DddGenerator
-
+> KBuilder provides various fluent builders and code generators for initializing applications with different language requirements
 
 ## Installation
 
@@ -59,12 +36,41 @@ See all [usage examples](./USAGE.md)
 
 ### Basic Example
 
-#### Basic example
+#### Configure and Run
+
+Setup configuration for KBuilder
+
+Generate two files:
+
+1. main.rb is based on class.rb from app_template
+2. configuration.log.txt is based on an inline template
 
-Description for a basic example to be featured in the main README.MD file
+Check out usage.md for more details
 
 ```ruby
-class SomeRuby; end
+usecases_folder = File.join(Dir.getwd, 'spec', 'usecases')
+
+KBuilder.configure do |config|
+  config.template_folder = File.join(usecases_folder, '.app_template')
+  config.global_template_folder = File.join(usecases_folder, '.global_template')
+  config.target_folder = File.join(usecases_folder, '.output')
+end
+
+template = <<~TEXT
+  Configured Template Folder        : {{a}}
+  Configured Global Template Folder : {{b}}
+  Configured Output Folder          : {{c}}
+TEXT
+
+builder = KBuilder::Builder.init
+
+builder.add_file('main.rb', template_file: 'class.rb', name: 'main').add_file(
+  'configuration.log.txt',
+  template: template,
+  a: builder.template_folder,
+  b: builder.global_template_folder,
+  c: builder.target_folder
+)
 ```
 
 ## Development

data/STORIES.md

@@ -1,6 +1,6 @@
 # K Builder
 
-> K Builder provides various fluent builders for initializing applications with different language requirements
+> KBuilder provides various fluent builders and code generators for initializing applications with different language requirements
 
 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
 

data/USAGE.md

@@ -1,19 +1,104 @@
 # K Builder
 
-> K Builder provides various fluent builders for initializing applications with different language requirements
+> KBuilder provides various fluent builders and code generators for initializing applications with different language requirements
 
 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
 
 ## Usage
 
-### Sample Classes
+### Configure And Build
 
-#### Simple example
-
-Description for a simple example that shows up in the USAGE.MD
+Print the configuration
 
 ```ruby
-class SomeRuby
-  def initialize; end
+usecases_folder = File.join(Dir.getwd, 'spec', 'usecases')
+
+KBuilder.configure do |config|
+  config.template_folder = File.join(usecases_folder, '.app_template')
+  config.global_template_folder = File.join(usecases_folder, '.global_template')
+  config.target_folder = File.join(usecases_folder, '.output')
 end
+
+puts JSON.pretty_generate(KBuilder.configuration.to_hash)
+```
+
+```javascript
+{
+  "target_folder": "/Users/name/dev/kgems/k_builder/spec/usecases/.output",
+  "template_folder": "/Users/name/dev/kgems/k_builder/spec/usecases/.app_template",
+  "global_template_folder": "/Users/name/dev/kgems/k_builder/spec/usecases/.global_template"
+}
 ```
+
+#### Folder Structure (starting)
+
+Example folder structure for this usecase before running the builder
+
+> Note: app-templates will take preference over global templates
+
+![](usage/_usage_folder_before.png)
+
+#### Run builder
+
+This example builder will add 4 files into the output folder.
+
+1. `main.rb` is based on `class.rb` from `app_template`
+2. `person.rb` & `address.rb` are based on `model.rb` from `global_template`
+3. `configuration.log.txt` is based on an inline template
+
+```ruby
+template = <<~TEXT
+  Configured Template Folder        : {{a}}
+  Configured Global Template Folder : {{b}}
+  Configured Output Folder          : {{c}}
+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)
+
+```
+
+#### Folder Structure (after)
+
+Folder structure after running the builder
+
+![](usage/_usage_folder_after.png)
+
+#### main.rb
+
+![main.rb](usage/_out1.png)
+
+#### person.rb
+
+![](usage/_out2.png)
+
+#### address.rb
+
+![person.rb](usage/_out3.png)
+
+#### configuration.log.txt
+
+![configuration.log.txt](usage/_out4.png)
+
+#### css/index.css
+
+![css/index.css](usage/_out5.png)

data/k_builder.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description            = <<-TEXT
     K Builder provides various fluent builders for initializing applications with different language requirements
   TEXT
-  spec.homepage               = 'http://appydave.com/gems/k-builder'
+  spec.homepage               = 'http://appydave.com' # /gems/k-builder'
   spec.license                = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/k_builder.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'k_builder/version'
-require 'k_builder/base_configuration'
-require 'k_builder/configuration'
 require 'k_builder/base_builder'
+require 'k_builder/base_configuration'
 require 'k_builder/builder'
+require 'k_builder/configuration'
+require 'k_builder/data_helper'
 
 require 'handlebars/helpers/template'
 

data/lib/k_builder/base_configuration.rb

@@ -3,104 +3,33 @@
 module KBuilder
   # Base configuration object for all k_builder* GEM
   class BaseConfiguration
-    def to_hash
-      hash = {}
-      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
-    end
-
-    def kv(name, value)
-      puts "#{name.rjust(30)} : #{value}"
-    end
-
-    # All of this code should be extracted into a module
-    #
-    # The module should then be extracted out into a GEM so that
-    # I can include it as needed. The GEM might be called
-    # (dynamic attributes) and would allow a regular class to act like an OpenStruct
-    # K-DSL uses data hash, while base configuration uses instance variables
-
-    def respond_to_missing?(name, *_args, &_block)
-      # puts 'respond_to_missing?'
-      # puts "respond_to_missing: #{name}"
-      n = name.to_s
-      n = n[0..-2] if n.end_with?('=')
-
-      if n.end_with?('?')
-        super
-      else
-        # This has not been fully tested
-        instance_variable_defined?("@#{n}") || super
+    def self.attach_to(klass_me, klass_target, accessor_name)
+      # Create a memoized getter to an instance of the attaching class (:klass_me)
+      #
+      # 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}")
+
+        instance_variable_set("@#{accessor_name}", klass_me.new)
       end
     end
 
-    def method_missing(name, *args, &_block)
-      # puts "method_missing: #{name}"
-      # puts "args.length   : #{args.length}"
-
-      add_getter_or_param_method(name)
-      add_setter_method(name)
-
-      send(name, args[0]) if args.length == 1 # name.end_with?('=')
-
-      super unless self.class.method_defined?(name)
-    end
-
-    # Handles Getter method and method with single parameter
-    # object.my_name
-    # object.my_name('david')
-    def add_getter_or_param_method(name)
-      # L.progress(1, 'add_getter_or_param_method')
-      self.class.class_eval do
-        # L.progress(2, 'add_getter_or_param_method')
-        name = name.to_s.gsub(/=$/, '')
-        # L.progress(3, 'add_getter_or_param_method')
-        # L.kv 'name', name
-        define_method(name) do |*args|
-          # L.progress(4, 'add_getter_or_param_method')
-          # L.kv 'add_getter_or_param_method', name
-          raise KBuilder::Error, 'Multiple setting values is not supported' if args.length > 1
+    def to_hash
+      hash = {}
+      instance_variables.each do |var|
+        value = instance_variable_get(var)
 
-          if args.length.zero?
-            get_value(name)
-          else
-            send("#{name}=", args[0])
-          end
-        end
-      end
-    end
+        value = value.to_hash if value.is_a?(KBuilder::BaseConfiguration)
 
-    # Handles Setter method
-    # object.my_name = 'david'
-    def add_setter_method(name)
-      # L.progress(1, 'add_setter_method')
-      self.class.class_eval do
-        # L.progress(2, 'add_setter_method')
-        name = name.to_s.gsub(/=$/, '')
-        # L.progress(3, 'add_setter_method')
-        # L.kv 'add_setter_method', name
-        define_method("#{name}=") do |value|
-          # L.progress(4, 'add_setter_method')
-          # L.kv 'name', name
-          # L.kv 'value', value
-          instance_variable_set("@#{name}", value)
-          # my_data[name.to_s] = value
-        end
+        hash[var.to_s.delete('@')] = value
       end
+      hash
     end
 
-    def get_value(name)
-      instance_variable_get("@#{name}")
+    def kv(name, value)
+      puts "#{name.rjust(30)} : #{value}"
     end
   end
-
-  # class L
-  #   def self.progress(index, label)
-  #     puts "#{index} - #{label}"
-  #   end
-
-  #   def self.kv(name, value)
-  #     puts "#{name.rjust(30)} : #{value}"
-  #   end
-  # end
 end

data/lib/k_builder/data_helper.rb

@@ -0,0 +1,64 @@
+# 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
+    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
+
+      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
+
+    def clean_symbol(value)
+      return value if value.nil?
+
+      value.is_a?(Symbol) ? value.to_s : value
+    end
+  end
+end

data/lib/k_builder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.27
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: handlebars-helpers
@@ -57,12 +57,20 @@ files:
 - 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/version.rb
-homepage: http://appydave.com/gems/k-builder
+- usage/_out1.png
+- usage/_out2.png
+- usage/_out3.png
+- usage/_out4.png
+- usage/_out5.png
+- usage/_usage_folder_after.png
+- usage/_usage_folder_before.png
+homepage: http://appydave.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://appydave.com/gems/k-builder
+  homepage_uri: http://appydave.com
   source_code_uri: https://github.com/klueless-io/k_builder
   changelog_uri: https://github.com/klueless-io/k_builder/commits/master
 post_install_message: