k_director 0.0.13 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf47752180cf17668d865a97b7b02c5cbc72ca1147a0d54a4033fad5f6d4dd7e
-  data.tar.gz: 8a88afd5bb024ff19f08fcfe7a90de2fe3bdd113a4a5bcc056dd67546379f6e5
+  metadata.gz: d0c8985292cf5c11bd7bd5e7887be4c29bf72e13095a4c7f1b7195595188a39a
+  data.tar.gz: aa90b26840c62e1c8e60edc0b4aeda07b62a76fa106de2618eb2571a48791680
 SHA512:
-  metadata.gz: 5858b4cb0b5a58c1d48c5f1d22e395fdb14930468996fa2ffa6ab1601d91f9f0cb91a65909de6b446d222c07e6ffe831cd2c49c11880fef8176c24359c025c5c
-  data.tar.gz: 59591fcbad758b23a768ec30f0ec36776d85e42b8956fbc340eaf2880a79fdaad2b8cbd7d0095c26a3b6a67844b4ee4c3e98492187963275f60cba284ff864c0
+  metadata.gz: '0458d1254d8ca4e459d3aa2a6bf23de2b3437d8df7cf0ded66376f6618f5f55f3ae4016506cde7381a81c095140200835950161b47041e6aaa6d086197547aaf'
+  data.tar.gz: 5f8d84e42051822825f82310c3a6ac1afb6fb87beeb10acb68137583b351fa6c92fe7d09356bbc4f03df4c0922cce9a9dd0a5ac4747174ca1f33d4a7c853b9e4

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

@@ -17,7 +17,7 @@ KManager.action :bootstrap do
         author:                     'David Cruwys',
         author_email:               'david@ideasmen.com.au',
         avatar:                     'Developer',
-        initial_semver:             '0.0.1',
+        initial_semver:             '0.0.13',
         main_story:                 'As a Developer, I want to generate code using a DSL, so that I can speed up application development',
         copyright_date:             '2022',
         website:                    'http://appydave.com/gems/k_director'
@@ -68,7 +68,6 @@ KManager.action :bootstrap do
 
         # add("lib/#{dom.application}.rb"             , template_file: 'lib/applet_name.rb'         , dom: dom)
         # add("lib/#{dom.application}/version.rb"     , template_file: 'lib/applet_name/version.rb' , dom: dom)
-        # add(".ver", dom: dom)
     
         # add('spec/spec_helper.rb')
         # add("spec/#{dom.application}_spec.rb"       , template_file: 'spec/applet_name_spec.rb', dom: dom)
@@ -96,30 +95,14 @@ KManager.action :bootstrap do
         self.dom = OpenStruct.new(parent.options.to_h.merge(options.to_h))
 
         # run_command("gh secret set SLACK_WEBHOOK --body \"$SLACK_REPO_WEBHOOK\"")
-        # add('.github/workflows/main.yml')
-        # add('.github/workflows/semver.yml')
-        # add('.releaserc')
-
-        # run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
-      end
-      .blueprint(
-        name: :intitial_gem_release,
-        description: 'initial GEM release',
-        on_exist: :write) do
-
-        cd(:app)
-        self.dom = OpenStruct.new(parent.options.to_h.merge(options.to_h))
-
-        # run_command("rake publish && rake clean")
         # run_command("gh secret set GEM_HOST_API_KEY --body \"$GEM_HOST_API_KEY\"")
         # add('.github/workflows/main.yml')
         # add('.github/workflows/semver.yml')
-        # add('.releaserc')
+        # add('.releaserc.json')
 
         # run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
       end
 
-
     # director.k_builder.debug
     director.play_actions
     # director.builder.logit

data/.releaserc.json

@@ -20,8 +20,8 @@
     [
       "@semantic-release/changelog",
       { 
-        "changelogFile": "docs/CHANGE.md",
-        "changelogFileTitle": "k_director Changelog"
+        "changelogFile": "docs/CHANGELOG.md",
+        "changelogFileTitle": "KDirector Changelog"
       }
     ],
     [

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

@@ -22,7 +22,6 @@ Or install it yourself as:
 gem install k_director
 ```
 
-
 ## Stories
 
 ### Main Story

data/docs/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [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_util', '~> 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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Builders
+    # Data builder for KBuilder Actions
+    class ActionsBuilder < KDirector::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/lib/k_director/builders/dom_builder.rb

@@ -0,0 +1,41 @@
+# 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

data/lib/k_director/directors/base_director.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+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 = KDirector::Builders::ActionsBuilder.new
+          else
+            builder.reset
+          end
+
+          new(k_builder, builder, **opts)
+        end
+      end
+
+      attr_reader :builder
+      attr_reader :k_builder
+      attr_reader :options
+      attr_accessor :dom
+
+      def initialize(k_builder, builder, **opts)
+        @k_builder  = k_builder
+        @builder    = builder
+        @options    = OpenStruct.new(**opts)
+
+        @options.director_name        ||= default_director_name
+        @options.template_base_folder ||= default_template_base_folder
+        @options.on_exist             ||= :skip       # %i[skip write compare]
+        @options.on_action            ||= :queue      # %i[queue execute]
+      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 template_base_folder
+        @options.template_base_folder
+      end
+
+      def on_exist
+        @options.on_exist
+      end
+
+      def on_action
+        @options.on_action
+      end
+
+      # Add a file to target folder
+      def add_file(file, **opts)
+        opts = {
+          on_exist: on_exist
+        }.merge(opts)
+
+        # WHAT IS THIS FOR?
+        opts[:dom] = dom 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), 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
+
+      def debug
+        log.section_heading director_name
+
+        h = options.to_h.sort.to_h
+        h.each_key do |key|
+          # requires k_funky
+          log.kv(titleize.parse(key.to_s), h[key])
+        end
+        nil
+      end
+
+      # def debug_info
+      #   log.kv 'Template Root Folder'   , k_builder.template_folders.folder_paths
+      #   log.kv 'Template Base Folder'   , template_base_folder
+      #   log.kv 'on_exist'               , on_exist
+      #   log.kv 'on_action'              , on_action
+      # end
+
+      private
+
+      def default_template_base_folder
+        ''
+      end
+
+      def default_director_name
+        titleize.parse(self.class.name.split('::').last)
+      end
+
+      def folder_parts(*parts)
+        parts.reject(&:blank?).map(&:to_s)
+      end
+
+      def handle_action(action)
+        builder.queue_action(action)
+        k_builder.play_action(action) if on_action == :execute
+      end
+
+      # run action will queue an action just like handle_action, but it will also run it immediately
+      def run_action(action)
+        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

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/version.rb

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

data/lib/k_director.rb

@@ -1,6 +1,14 @@
 # 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'
 
 module KDirector
   # raise KDirector::Error, 'Sample message'

data/package-lock.json

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

data/package.json

@@ -1,9 +1,9 @@
 {
   "name": "k_director",
-  "version": "0.0.13",
+  "version": "0.2.0",
   "description": "Command line and CI/CD tools for k_director",
   "scripts": {
-    "release": "semantic-release --no-ci"
+    "release": "semantic-release"
   },
   "devDependencies": {
     "semantic-release": "^19.0.2",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_director
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.2.0
 platform: ruby
 authors:
 - David Cruwys
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -24,6 +24,34 @@ 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
+    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
 description: "    KDirector provides domain specific language implementations for
   code generation\n"
 email:
@@ -47,22 +75,24 @@ files:
 - ".github/workflows/main.yml"
 - ".github/workflows/semver.yml"
 - ".gitignore"
-- ".releaserc-old"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
-- ".ver"
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docs/CHANGE.md
+- 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/version.rb
 - package-lock.json
 - package.json
@@ -72,7 +102,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: KDirector provides domain specific language implementations for code generation
 test_files: []

data/.releaserc-old

@@ -1,46 +0,0 @@
-{
-  "branches": [
-    "main"
-  ],
-  "verifyRelease": [{
-    "path": "@semantic-release/exec",
-    "cmd": "git config --global user.name 'David Cruwys';echo '${nextRelease.version}' > .ver;git add .;git commit -am '${nextRelease.version} [skip ci]';git push"
-  }],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    [
-      "@semantic-release/npm",
-      {
-        "npmPublish": false
-      }
-    ],
-    [
-      "@klueless-js/semantic-release-rubygem",
-      {
-        "gemPublish": false
-      }
-    ],
-    "semantic-release-rubygem",
-    [
-      "@semantic-release/changelog",
-      {
-        "changelogFile": "docs/CHANGELOG.md",
-        "changelogFileTitle": "k_director Changelog"
-      }
-    ],
-    [
-      "@semantic-release/git",
-      {
-        "assets": [
-          "lib/k_director/version.rb",
-          "docs/CHANGELOG.md"
-        ],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ],
-    "@semantic-release/github"
-  ],
-  "repositoryUrl": "git@github.com:klueless-io/k_director.git"
-}
-

data/.ver

@@ -1 +0,0 @@
-0.0.1

data/docs/CHANGE.md

@@ -1,28 +0,0 @@
-## [0.0.12](https://github.com/klueless-io/k_director/compare/v0.0.11...v0.0.12) (2022-01-25)
-
-
-### Bug Fixes
-
-* test publish [#11](https://github.com/klueless-io/k_director/issues/11) ([04f84a8](https://github.com/klueless-io/k_director/commit/04f84a8bf0c955bb3073d13a4ccb7a95c2c757a7))
-
-## [0.0.11](https://github.com/klueless-io/k_director/compare/v0.0.10...v0.0.11) (2022-01-25)
-
-
-### Bug Fixes
-
-* test publish [#10](https://github.com/klueless-io/k_director/issues/10) ([70e1b34](https://github.com/klueless-io/k_director/commit/70e1b3462fac657fd924d0ebaa757c316a7d77bb))
-* test publish [#9](https://github.com/klueless-io/k_director/issues/9) ([3fc7fd2](https://github.com/klueless-io/k_director/commit/3fc7fd2784679b8666ef4ddb9365c423ef3de55f))
-
-## [0.0.6](https://github.com/klueless-io/k_director/compare/v0.0.5...v0.0.6) (2022-01-25)
-
-
-### Bug Fixes
-
-* test publish [#3](https://github.com/klueless-io/k_director/issues/3) ([90f7067](https://github.com/klueless-io/k_director/commit/90f7067547fb26d09001ea3411d211def680bd46))
-
-## [0.0.4](https://github.com/klueless-io/k_director/compare/v0.0.3...v0.0.4) (2022-01-25)
-
-
-### Bug Fixes
-
-* test publish [#1](https://github.com/klueless-io/k_director/issues/1) ([1d001af](https://github.com/klueless-io/k_director/commit/1d001afb6087a50003ff3c18d53b10d35df31a1c))