k_builder 0.0.1 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d63754fbda587b7ea17d7ae17d4fb33029fac853280ce5125bfb1d7924c4ddfc
-  data.tar.gz: 62d174cd9cf2b5ad60a43319875efffc6845a409ea1067b4cb01d916f69456cf
+  metadata.gz: ff2053d7113bdfdf11d6289f81220840a742362b20a5ee4283a995eff8010101
+  data.tar.gz: f3a70c18493de81b6b5eebaf90555ce222cb2144825aeb154265f4704a9cd43e
 SHA512:
-  metadata.gz: 53b98c935cb446629725ccb9a4bd4fa6babe87e985e7886ab2308592cb5413604063cb54eee5f439dfe79263b3d73d03c32c94cbe9ccb89eaf0599b1c655e9ea
-  data.tar.gz: 985ad06c8e9a92f5e79eab2167b35cebee0940ae87bd9044e3de466c09786364444cbffafe7441bef59f8d031186106ffc317d9ddc91dc6c9288066db670f548
+  metadata.gz: 20f67a1a1409f111b4d76c6bd45858342d6d04c82e60f6b5d646e07eea64ff2a0630a290ef94832e09181528d1d86143b0635717a33f06bcc84d12c55d93d8fb
+  data.tar.gz: 6527ac296eb3f43f89bfad8028084adbe89412ebb3547143a8c0a6771e1af95ae06805d79ce696f428ac5e955b444e96dbb0dec399b12d2e0c525c11956a23b5

data/.rubocop.yml

@@ -60,6 +60,9 @@ Naming/MemoizedInstanceVariableName:
 Naming/VariableNumber:
   Exclude:
     - "**/spec/**/*"
+Naming/AccessorMethodName:
+  Exclude:
+    - "**/*builder*.rb"
 Style/EmptyMethod:    
   Exclude:
     - "**/spec/**/*"

data/Guardfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+guard :bundler, cmd: 'bundle install' do
+  watch('Gemfile')
+  watch('k_builder.gemspec')
+end
+
+group :green_pass_then_cop, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec -f doc' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+    watch(%r{^lib/k_builder/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch(%r{^lib/k_builder/commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+    watch(/{.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -2,6 +2,29 @@
 
 > 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
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,16 +49,23 @@ gem install k_builder
 
 ### Main Story
 
-
+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
 
 See all [stories](./STORIES.md)
 
-
 ## Usage
 
 See all [usage examples](./USAGE.md)
 
+### Basic Example
 
+#### Basic example
+
+Description for a basic example to be featured in the main README.MD file
+
+```ruby
+class SomeRuby; end
+```
 
 ## Development
 
@@ -45,7 +75,7 @@ Checkout the repo
 git clone klueless-io/k_builder
 ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/STORIES.md

@@ -8,26 +8,21 @@ As a Polyglot Developer, I want to be up and running in any development language
 
 ### Stories next on list
 
-As a Developer, I can DO_SOMETHING, so that I QUALITY_OF_LIFE
-
-- Subtask
+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
 
-Setup RubyGems and RubyDoc
-
-- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_builder)
-- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/k_builder/master)
-
-Setup GitHub Action (test and lint)
-
-- Setup Rspec action
-- Setup RuboCop action
+BaseBuilder
 
 ## Stories and tasks
 
 ### Tasks - completed
 
+Setup RubyGems and RubyDoc
+
+- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_builder)
+- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/k_builder/master)
+
 Setup project management, requirement and SCRUM documents
 
 - Setup readme file
@@ -35,6 +30,11 @@ Setup project management, requirement and SCRUM documents
 - Setup a project backlog
 - Setup an examples/usage document
 
+Setup GitHub Action (test and lint)
+
+- Setup Rspec action
+- Setup RuboCop action
+
 Setup new Ruby GEM
 
 - Build out a standard GEM structure

data/k_builder.gemspec

@@ -38,5 +38,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_builder/extconf.rb']
 
+  spec.add_dependency 'handlebars-helpers', '~> 0'
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

data/lib/k_builder.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 require 'k_builder/version'
+require 'k_builder/configuration'
+require 'k_builder/base_builder'
+require 'k_builder/builder'
+
+require 'handlebars/helpers/template'
 
 module KBuilder
   # raise KBuilder::Error, 'Sample message'

data/lib/k_builder/base_builder.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module KBuilder
+  # Base builder defines builder methods, build method and configuration
+  #
+  # Convention: Setter methods (are Fluent) and use the prefix set_
+  #             Getter methods (are NOT fluent) and return the stored value
+  #             Setter methods (are NOT fluent) can be created as needed
+  #             these methods would not be prefixed with the set_
+  class BaseBuilder
+    attr_reader :hash
+
+    # Factory method that provides a builder for a specified structure
+    # runs through a configuration block and then builds the final structure
+    #
+    # @return [type=Object] data structure
+    def self.build
+      init.build
+    end
+
+    # 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)
+
+        hash.merge!(configuration)
+      end
+
+      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
+    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
+
+    # 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/builder.rb

@@ -0,0 +1,252 @@
+# 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
+    def template_folder=(value)
+      hash['template_folder'] = File.expand_path(value)
+    end
+
+    # Getter for template folder
+    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
+    def global_template_folder=(value)
+      hash['global_template_folder'] = File.expand_path(value)
+    end
+
+    # Setter for global template folder
+    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 = "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}"
+
+      system(build_command)
+    end
+    alias rc run_command
+  end
+end

data/lib/k_builder/configuration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Attach configuration to the KBuilder module
+module KBuilder
+  # Configuration for webpack5/builder
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  # Configuration class
+  class Configuration
+    attr_accessor :target_folder
+    attr_accessor :template_folder
+    attr_accessor :global_template_folder
+
+    def initialize
+      @target_folder = Dir.getwd
+      @template_folder = File.join(Dir.getwd, '.templates')
+      @global_template_folder = nil
+    end
+
+    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
+    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/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: k_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.14
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
-dependencies: []
+date: 2021-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: handlebars-helpers
+  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:
@@ -24,6 +38,7 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -38,6 +53,9 @@ files:
 - hooks/update-version
 - k_builder.gemspec
 - lib/k_builder.rb
+- lib/k_builder/base_builder.rb
+- lib/k_builder/builder.rb
+- lib/k_builder/configuration.rb
 - lib/k_builder/version.rb
 homepage: http://appydave.com/gems/k-builder
 licenses: