k_director 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d209a43e4a6ff73dcaee458f9c1b7a568a2afd4f554028054ce5392918c1dcc3
-  data.tar.gz: a54f0d64cf0bc1f5e55c3599d886585f3062c50c30deac454a1ac1dea14478b6
+  metadata.gz: d0c8985292cf5c11bd7bd5e7887be4c29bf72e13095a4c7f1b7195595188a39a
+  data.tar.gz: aa90b26840c62e1c8e60edc0b4aeda07b62a76fa106de2618eb2571a48791680
 SHA512:
-  metadata.gz: 80737996ee3d29ac2aab7f3bb86ccb0184354298897f686d214be6bb35b1c9e71e5304a610e48f0b8691a20b8aee38531910ca7db895dc9aec881fc2142eb50b
-  data.tar.gz: 8f8f1ae7621f296216a3b7a8b5d1decd2335382ec648f631015bc9966aa689ac6d87ac16f39484881063a2fe32ee47463346d88a1c0c8bd6f66d102bdc08d806
+  metadata.gz: '0458d1254d8ca4e459d3aa2a6bf23de2b3437d8df7cf0ded66376f6618f5f55f3ae4016506cde7381a81c095140200835950161b47041e6aaa6d086197547aaf'
+  data.tar.gz: 5f8d84e42051822825f82310c3a6ac1afb6fb87beeb10acb68137583b351fa6c92fe7d09356bbc4f03df4c0922cce9a9dd0a5ac4747174ca1f33d4a7c853b9e4

data/.rubocop.yml

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

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_builder', '~> 0.0.0'
   spec.add_dependency 'k_util', '~> 0.0.0'
 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.1.2'
+  VERSION = '0.2.0'
 end

data/lib/k_director.rb

@@ -1,10 +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.1.2",
+  "version": "0.2.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.1.2",
+      "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,6 +1,6 @@
 {
   "name": "k_director",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "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.2.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-26 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,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
@@ -70,12 +84,15 @@ 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/version.rb
 - package-lock.json
 - package.json