k_director 0.1.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d209a43e4a6ff73dcaee458f9c1b7a568a2afd4f554028054ce5392918c1dcc3
-  data.tar.gz: a54f0d64cf0bc1f5e55c3599d886585f3062c50c30deac454a1ac1dea14478b6
+  metadata.gz: 0036ab3aba8fde78577b1c3e02d9adb122d14631c309eb6cd8e849d43777928c
+  data.tar.gz: 7566359e95804068637fd4e52da588a8445d978d0986cbbc2cc6b84063728a30
 SHA512:
-  metadata.gz: 80737996ee3d29ac2aab7f3bb86ccb0184354298897f686d214be6bb35b1c9e71e5304a610e48f0b8691a20b8aee38531910ca7db895dc9aec881fc2142eb50b
-  data.tar.gz: 8f8f1ae7621f296216a3b7a8b5d1decd2335382ec648f631015bc9966aa689ac6d87ac16f39484881063a2fe32ee47463346d88a1c0c8bd6f66d102bdc08d806
+  metadata.gz: 004ca6fe76f586ef5eb163797dfca591098bd4d3454c0a80366bf9f43f1f4be2a1fd78f94ba522a6d227e9c1b4f6ece76e3e5877989757579d6c44cb9c37a674
+  data.tar.gz: 9d94e04bfe8b244ff8940700b6c3ce49a100eac27e28f29e14b3f7d27f995ece20178fa9f8380408ef7b03588f472135c6370b1916bdd26bdbc20814d34e8a99

data/.builders/_.rb

@@ -1,4 +1,3 @@
-require_relative './dsl/builders/dom_builder'
 require_relative './dsl/builders/actions_builder'
 require_relative './dsl/directors/base_director'
 require_relative './dsl/directors/child_director'

data/.builders/generators/01-bootstrap.rb

@@ -6,7 +6,9 @@ KManager.action :bootstrap do
       .init(k_builder,
         template_base_folder:       'ruby/gem',
         on_exist:                   :skip,                      # %i[skip write compare]
-        on_action:                  :queue,                     # %i[queue execute]
+        on_action:                  :queue                      # %i[queue execute]
+      )
+      .dom(:settings,
         ruby_version:               '2.7',
         repo_name:                  application_name,
         application:                application_name,
@@ -25,6 +27,9 @@ KManager.action :bootstrap do
       .github do
         parent.options.repo_info = repo_info
 
+        self.repo
+        self.name
+
         # create_repository # (:k_director)
         # delete_repository # (:k_director)
         # list_repositories

data/.rubocop.yml

@@ -52,6 +52,9 @@ Style/BlockComments:
   Include:
     - "**/spec/*"
 
+Style/OpenStructUse:
+  Enabled: false
+
 # My Preferences - Start
 Metrics/ClassLength:
   Enabled: false

data/README.md

@@ -1,3 +1,11 @@
+# Agenda
+
+- GitHub Copilot (Ruby)
+  - Writing specs
+  - DSL
+- SemVer (conventionl commits)
+- GitHub Copilot (GoLang) - Build a Game
+
 # K Director
 
 > KDirector provides domain specific language implementations for code generation

data/docs/CHANGELOG.md

@@ -0,0 +1,39 @@
+# [0.4.0](https://github.com/klueless-io/k_director/compare/v0.3.0...v0.4.0) (2022-01-29)
+
+
+### Bug Fixes
+
+* run rubocop ([e8805aa](https://github.com/klueless-io/k_director/commit/e8805aaddfde04ba1def563d3f7e5e311fa2841a))
+
+
+### Features
+
+* add GitHub DSL ([e8de7d5](https://github.com/klueless-io/k_director/commit/e8de7d599af16be9dced907617d534f029e1e1ad))
+
+# [0.3.0](https://github.com/klueless-io/k_director/compare/v0.2.0...v0.3.0) (2022-01-29)
+
+
+### Features
+
+* add Blueprint DSL ([c27ec12](https://github.com/klueless-io/k_director/commit/c27ec124b8c55b84f2dfd67f37de6ab2c4fb8d22))
+
+# [0.2.0](https://github.com/klueless-io/k_director/compare/v0.1.2...v0.2.0) (2022-01-27)
+
+
+### Features
+
+* add BaseDirector and ChildDirector ([d32265a](https://github.com/klueless-io/k_director/commit/d32265a1e46811bde6bdfbef4b8c9dc8602a8f88))
+
+## [0.1.2](https://github.com/klueless-io/k_director/compare/v0.1.1...v0.1.2) (2022-01-26)
+
+
+### Bug Fixes
+
+* add semver change log ([2069bd2](https://github.com/klueless-io/k_director/commit/2069bd24b9d32649c666480da76781514beeecf3))
+
+
+## [0.1.1](https://github.com/klueless-io/k_director/compare/v0.1.0...v0.1.1) (2022-01-26)
+
+### Feature
+
+* add dom and action builder ([a61e841](https://github.com/klueless-io/k_director/commit/a61e841a40f544f4751e4aaa012d60a447d2dfab))

data/k_director.gemspec

@@ -43,5 +43,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'k_log', '~> 0.0.0'
   # spec.add_dependency 'k_type', '~> 0.0.0'
+  spec.add_dependency 'k_builder', '~> 0.0.0'
   spec.add_dependency 'k_util', '~> 0.0.0'
 end

data/lib/k_director/builders/actions_builder.rb

@@ -2,26 +2,96 @@
 
 module KDirector
   module Builders
-    # Data builder for KBuilder Actions
-    class ActionsBuilder < KDirector::Builders::DomBuilder
+    # Actions document builder
+    class ActionsBuilder
+      attr_reader :actions
+      attr_reader :dom
+      attr_reader :last_action
+
       def initialize
-        super(schema)
+        reset
+      end
+
+      def reset
+        @actions = []
+        @dom = {}
+        @last_action = {}
       end
 
       def queue_action(action)
-        dom[:actions] << current_node(action)
+        @actions << action
+        @last_action = action
+      end
+
+      # set key_set/value pair, can be used for
+      #
+      # - simple key/value pairs
+      # - initialize key/array pairs
+      #
+      # example:
+      #   set(:a, 1)
+      #   set(:a, [])
+      #   set(:a, [1, 2, 3])
+      #   set(:a, some_value, default_value: 'use if not supplied')
+      #   set(:a, :b, 'nested value')
+      #   set(:a, :b, :c, 'deeply nested value')
+      #   set(:a, :b, :c, :d, :e, :f, 'depth is no barrier')
+      def set(*keyset_value, default_value: nil)
+        size = keyset_value.size
+
+        raise ArgumentError, 'set requires 2 or more arguments' if size < 2
+
+        target = initialize_hierarchy(keyset_value)
+
+        set_kv(target, keyset_value[size - 2], keyset_value[size - 1], default_value: default_value)
+      end
+
+      # add value to array
+      def add(*keyset_value, default_value: nil)
+        size = keyset_value.size
+
+        raise ArgumentError, 'add requires 2 or more arguments' if size < 2
+
+        target = initialize_hierarchy(keyset_value)
+
+        add_kv(target, keyset_value[size - 2], keyset_value[size - 1], default_value: default_value)
+      end
+
+      def debug
+        puts JSON.pretty_generate(dom)
+        # log.structure(dom)
+
+        self
       end
 
-      def actions
-        dom[:actions]
+      def build
+        # hook into the set, add and queue_action methods form memoization
+        KUtil.data.to_open_struct(@dom)
       end
 
       private
 
-      def schema
-        {
-          actions: []
-        }
+      def initialize_hierarchy(keys_value)
+        target = @dom
+
+        return target unless keys_value.size > 2
+
+        keys_value.slice(0..-3).each_with_index do |key, _index|
+          target[key] = {} unless target.key?(key)
+          target = target[key]
+        end
+        target
+      end
+
+      def set_kv(target, key, value, default_value: nil)
+        set_value = value.nil? ? default_value : value
+        target[key] = set_value
+      end
+
+      def add_kv(target, key, value, default_value: nil)
+        add_value = value.nil? ? default_value : value
+        target[key] = [] unless target.key?(key)
+        target[key] << add_value
       end
     end
   end

data/{.builders/dsl → lib/k_director}/directors/base_director.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-module Dsl
+module KDirector
   module Directors
+    # Base Director is paired with the ActionsBuilder and provides a base
+    # on which to build code generation directors.
     class BaseDirector
       include KLog::Logging
 
       class << self
         def init(k_builder, builder = nil, **opts)
           if builder.nil?
-            builder = Dsl::Builders::ActionsBuilder.new
+            builder = KDirector::Builders::ActionsBuilder.new
           else
             builder.reset
           end
@@ -20,9 +22,9 @@ module Dsl
       attr_reader :builder
       attr_reader :k_builder
       attr_reader :options
-      attr_accessor :dom
-    
+
       def initialize(k_builder, builder, **opts)
+        @index = 1
         @k_builder  = k_builder
         @builder    = builder
         @options    = OpenStruct.new(**opts)
@@ -33,10 +35,29 @@ module Dsl
         @options.on_action            ||= :queue      # %i[queue execute]
       end
 
+      def dom
+        @index += 1
+        puts "dom#{@index}"
+        builder.dom
+      end
+
+      # Used by child directors to inherit options from parent
+      def inherited_opts(**opts)
+        {
+          on_exist: @options.on_exist,
+          on_action: @options.on_action,
+          template_base_folder: @options.template_base_folder
+        }.merge(opts)
+      end
+
       def director_name
         @options.director_name
       end
 
+      def director_name=(name)
+        @options.director_name = name
+      end
+
       def template_base_folder
         @options.template_base_folder
       end
@@ -49,38 +70,46 @@ module Dsl
         @options.on_action
       end
 
+      # Add a file to target folder
       def add_file(file, **opts)
         opts = {
           on_exist: on_exist
         }.merge(opts)
 
-        opts[:dom] = dom if dom
+        opts[:dom] = dom.except(:actions) if dom
 
         handle_action(k_builder.add_file_action(file, **opts))
 
         self
       end
 
+      # Set current target folder
+      # rubocop:disable Naming/AccessorMethodName
       def set_current_folder_action(folder_key)
-        # RUN (not handle)
+        # RUN (not handle), current folder effects subsequent actions and so it needs to be executed straight away.
         run_action(k_builder.set_current_folder_action(folder_key))
 
         self
       end
+      # rubocop:enable Naming/AccessorMethodName
       alias cd set_current_folder_action
 
+      # Run a command using shell, this is useful with command line tools
       def run_command(command)
         handle_action(k_builder.run_command_action(command))
 
         self
       end
 
+      # Run a command using Open3.capture2, can be used in place of run_command
+      # but is also useful with multiline scripts
       def run_script(script)
         handle_action(k_builder.run_script_action(script))
 
         self
       end
 
+      # play any un-played actions
       def play_actions
         k_builder.play_actions(builder.actions)
       end
@@ -89,7 +118,8 @@ module Dsl
         log.section_heading director_name
 
         h = options.to_h.sort.to_h
-        h.keys.each do |key|
+        h.each_key do |key|
+          # requires k_funky
           log.kv(titleize.parse(key.to_s), h[key])
         end
         nil
@@ -109,7 +139,7 @@ module Dsl
       end
 
       def default_director_name
-        titleize.parse(self.class.name.split("::").last)
+        titleize.parse(self.class.name.split('::').last)
       end
 
       def folder_parts(*parts)
@@ -126,6 +156,11 @@ module Dsl
         builder.queue_action(action)
         k_builder.run_action(action)
       end
+
+      def titleize
+        require 'handlebars/helpers/string_formatting/titleize'
+        Handlebars::Helpers::StringFormatting::Titleize.new
+      end
     end
   end
-end
+end

data/lib/k_director/directors/child_director.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Directors
+    # Child directors hang of a parent director and provide fluent builders for
+    # specialized flow control, e.g branching of a RubyGem Director into a GitHub
+    # Child director
+    class ChildDirector < KDirector::Directors::BaseDirector
+      attr_reader :parent
+
+      def initialize(parent, **opts)
+        @parent = parent
+
+        super(parent.k_builder, parent.builder, **@parent.inherited_opts(**opts))
+      end
+    end
+  end
+end

data/lib/k_director/dsls/children/blueprint.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Dsls
+    module Children
+      # Blueprint DSL is used to add files to the target folder.
+      #
+      # A blueprint is a recipe that you can follow to build out assets on the target application
+      class Blueprint < KDirector::Directors::ChildDirector
+        # Add a single file into the code base
+        #
+        # @param [String] output_filename The output file name, this can be a relative path
+        # @param [Hash] **opts The options
+        # @option opts [String] :template_filename Template filename can be set or it will default to the same value as the output file name
+        # @option opts [String] :template_subfolder Template subfolder
+        def add(output_file, **opts)
+          template_file = opts[:template_file] || output_file
+          template_parts = [template_base_folder, opts[:template_subfolder], template_file].reject(&:blank?)
+          template_path = File.join(*template_parts)
+
+          # maybe template_file should be renamed to template_path in k_builder
+          opts[:template_file] = template_path
+
+          add_file(output_file, **opts)
+        end
+
+        def oadd(name, **opts)
+          add(name, **{ open: true          }.merge(opts))
+        end
+
+        def tadd(name, **opts)
+          add(name, **{ open_template: true }.merge(opts))
+        end
+
+        def fadd(name, **opts)
+          add(name, **{ on_exist: :write    }.merge(opts))
+        end
+
+        # def template_content(template_file, **opts)
+        #   template_parts = [template_base_folder, opts[:template_subfolder], template_file].reject(&:blank?)
+        #   template_file = File.join(*template_parts)
+
+        #   file = k_builder.find_template_file(template_file)
+        #   File.read(file)
+        # end
+
+        def run_template_script(template_file, **opts)
+          template_parts = [template_base_folder, opts[:template_subfolder], template_file].reject(&:blank?)
+          template_path = File.join(*template_parts)
+
+          script = k_builder.process_any_content(template_file: template_path, **opts)
+
+          run_script(script)
+        end
+      end
+    end
+  end
+end

data/lib/k_director/dsls/children/github.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# klueless-io
+# k_director
+# kluless-sites
+
+module KDirector
+  module Dsls
+    module Children
+      # Github DSL provides useful GitHub actions such as (create, delete, list, open repository).
+      class Github < KDirector::Directors::ChildDirector
+        def initialize(parent, **opts)
+          super(parent, **opts)
+
+          @options.repo_name          ||= parent.options.repo_name
+          @options.repo_organization  ||= parent.options.repo_organization
+        end
+
+        def repo
+          return parent.options.repo if defined? parent.options.repo
+
+          parent.options.repo = OpenStruct.new(name: nil, organization: nil)
+        end
+
+        def name
+          repo.repo_name
+        end
+
+        def organization
+          repo.repo_organization
+        end
+      end
+    end
+  end
+end

data/lib/k_director/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDirector
-  VERSION = '0.1.2'
+  VERSION = '0.4.1'
 end

data/lib/k_director.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require 'k_log'
 require 'k_util'
+require 'k_builder'
 
 require_relative 'k_director/version'
-require_relative 'k_director/builders/dom_builder'
 require_relative 'k_director/builders/actions_builder'
+require_relative 'k_director/directors/base_director'
+require_relative 'k_director/directors/child_director'
+require_relative 'k_director/dsls/children/blueprint'
+require_relative 'k_director/dsls/children/github'
 
 module KDirector
   # raise KDirector::Error, 'Sample message'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "k_director",
-  "version": "0.1.2",
+  "version": "0.4.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.1.2",
+      "version": "0.4.1",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k_director",
-  "version": "0.1.2",
+  "version": "0.4.1",
   "description": "Command line and CI/CD tools for k_director",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_director
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: k_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: k_util
   requirement: !ruby/object:Gem::Requirement
@@ -48,10 +62,6 @@ extra_rdoc_files: []
 files:
 - ".builders/_.rb"
 - ".builders/boot.rb"
-- ".builders/dsl/builders/actions_builder.rb"
-- ".builders/dsl/builders/dom_builder.rb"
-- ".builders/dsl/directors/base_director.rb"
-- ".builders/dsl/directors/child_director.rb"
 - ".builders/dsl/github_dsl.rb"
 - ".builders/dsl/ruby_gem_dsl.rb"
 - ".builders/generators/01-bootstrap.rb"
@@ -70,12 +80,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/CHANGELOG.md
 - docs/CODE_OF_CONDUCT.md
 - docs/LICENSE.txt
 - k_director.gemspec
 - lib/k_director.rb
 - lib/k_director/builders/actions_builder.rb
-- lib/k_director/builders/dom_builder.rb
+- lib/k_director/directors/base_director.rb
+- lib/k_director/directors/child_director.rb
+- lib/k_director/dsls/children/blueprint.rb
+- lib/k_director/dsls/children/github.rb
 - lib/k_director/version.rb
 - package-lock.json
 - package.json

data/.builders/dsl/builders/actions_builder.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Dsl
-  module Builders
-    class ActionsBuilder < Dsl::Builders::DomBuilder
-      def initialize
-        super(schema)
-      end
-
-      def queue_action(action)
-        dom[:actions] << current_node(action)
-      end
-
-      def actions
-        dom[:actions]
-      end
-
-      private
-
-      def schema
-        { 
-          actions: []
-        }
-      end
-    end
-  end
-end

data/.builders/dsl/builders/dom_builder.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Dsl
-  module Builders
-    class DomBuilder
-      attr_reader :dom
-      attr_reader :node
-
-      def initialize(dom = nil)
-        @dom = dom || schema
-      end
-
-      def current_node(node)
-        @node = node
-      end
-
-      alias last_node node
-
-      def reset
-        @dom = schema
-        @last_node = nil
-      end
-
-      def schema
-        {}
-      end
-
-      def logit
-        puts JSON.pretty_generate(dom)
-        # log.structure(dom)
-
-        self
-      end
-
-      def data
-        KUtil.data.to_open_struct(@dom)
-      end
-    end
-  end
-end

data/.builders/dsl/directors/child_director.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Dsl
-  module Directors
-    class ChildDirector < Dsl::Directors::BaseDirector
-      attr_reader :parent
-
-      def initialize(parent, **opts)
-        @parent = parent
-
-        opts = {
-          on_exist: parent.on_exist,
-          on_action: parent.on_action,
-          template_base_folder: parent.template_base_folder
-        }.merge(opts)
-
-        super(parent.k_builder, parent.builder, **opts)
-      end
-
-      def debug
-        parent.debug
-
-        super
-      end
-    end
-  end
-end

data/lib/k_director/builders/dom_builder.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module KDirector
-  module Builders
-    # Base document builder
-    class DomBuilder
-      attr_reader :dom
-      attr_reader :node
-
-      def initialize(dom = nil)
-        @dom = dom || schema
-      end
-
-      def current_node(node)
-        @node = node
-      end
-
-      alias last_node node
-
-      def reset
-        @dom = schema
-        @last_node = nil
-      end
-
-      def schema
-        {}
-      end
-
-      def logit
-        puts JSON.pretty_generate(dom)
-        # log.structure(dom)
-
-        self
-      end
-
-      def data
-        KUtil.data.to_open_struct(@dom)
-      end
-    end
-  end
-end