k_builder 0.0.16 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 050b7375cf0a60393e140589a7a3517097097ca969153fc969bc47f7d4815d93
-  data.tar.gz: 76deda3ada30401133f1ac8fc5cea88a51bd1b0b2618b53a82613cd4f85569c3
+  metadata.gz: ec75b1356060e7075bd481790769fb8f3fd80112a07247fb3a5ac1f6bac36993
+  data.tar.gz: 388c3f334b6864e973a4fbfd1f41d6bdbf769c3b58fb5d72a9bafeb847e11656
 SHA512:
-  metadata.gz: 7d5c01ea1307ff86b577b69f2cd4fe5307c97c75c70d873ddfa01a1ccf6205e993bcfabd3fc0c99495c5e59f2c63e031de47c6e2f720390344f36766fbe21504
-  data.tar.gz: 5027f3bfbc0212a3cde6aa1389d2cb68f389c5381303f5dedeb2ae2fdbb0d88e372dfc7ed83875a587523f883b1e3b4c34e425db4f10fdeab9468eb63addfc4a
+  metadata.gz: e6937c692f052d1ec7b0f6abae35cce72e775e65a962e05ca21ba5dda647cb85c3215fb465e86ba76428bffc66038727afde3ca60666920773467bc36996cbef
+  data.tar.gz: 3988883cfe6543a2c97fe56c4b99bf634b4a77c3210eccf2d1e56711d045729144aa0735edd94238c400f9ed82fcf7db847343949e0d04b325fa66f52c0073b6

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'
@@ -39,5 +39,6 @@ Gem::Specification.new do |spec|
   # spec.extensions    = ['ext/k_builder/extconf.rb']
 
   spec.add_dependency 'handlebars-helpers', '~> 0'
-  # spec.add_dependency 'tty-box',         '~> 0.5.0'
+  # spec.add_dependency "anyway_config"     , ">= 2.0.0"
+  # spec.add_dependency "config"     , ">= 3.0.0"
 end

data/lib/k_builder.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'k_builder/version'
-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_builder.rb

@@ -70,35 +70,42 @@ module KBuilder
       hash
     end
 
-    # 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
+    # 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
+    # #
+    # # @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
     #

data/lib/k_builder/base_configuration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module KBuilder
+  # Base configuration object for all k_builder* GEM
+  class BaseConfiguration
+    def self.attach_to(klass_me, klass_target, accessor_name)
+      # Create a memoized getter to an instance of the attaching class (:klass_me)
+      #
+      # 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 to_hash
+      hash = {}
+      instance_variables.each do |var|
+        value = instance_variable_get(var)
+
+        value = value.to_hash if value.is_a?(KBuilder::BaseConfiguration)
+
+        hash[var.to_s.delete('@')] = value
+      end
+      hash
+    end
+
+    def kv(name, value)
+      puts "#{name.rjust(30)} : #{value}"
+    end
+  end
+end

data/lib/k_builder/builder.rb

@@ -105,11 +105,13 @@ module KBuilder
     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
@@ -125,11 +127,13 @@ module KBuilder
     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

data/lib/k_builder/configuration.rb

@@ -20,12 +20,13 @@ module KBuilder
   end
 
   # Configuration class
-  class Configuration
+  class Configuration < BaseConfiguration
     attr_accessor :target_folder
     attr_accessor :template_folder
     attr_accessor :global_template_folder
 
     def initialize
+      super
       @target_folder = Dir.getwd
       @template_folder = File.join(Dir.getwd, '.templates')
       @global_template_folder = nil
@@ -38,17 +39,5 @@ module KBuilder
       kv 'template_folder'       , template_folder
       kv 'global_template_folder', global_template_folder
     end
-
-    def to_hash
-      hash = {}
-      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
-      hash
-    end
-
-    private
-
-    def kv(name, value)
-      puts "#{name.rjust(30)} : #{value}"
-    end
   end
 end

data/lib/k_builder/data_helper.rb

@@ -0,0 +1,62 @@
+# 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
+          hash[key] = struct_to_hash(value)
+        when Array
+          # No test yet
+          values = value.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
+          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.16'
+  VERSION = '0.0.26'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.26
 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
@@ -54,14 +54,23 @@ files:
 - k_builder.gemspec
 - 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/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: