k_director 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e855ea56fe8350c6d8f348caafec612a3faa998f6f39f0bfd631c0968b5476f
-  data.tar.gz: 3a8ef5a51b2f968d17e688953cf6868a5a387bbe7579a19896fd0c21d4c01b36
+  metadata.gz: 61ab15797b459bd3b8a2938801a016638c268ef5339cd5df1a5a4a7985c255cd
+  data.tar.gz: d8670419a2617533e13c8ad2eef7e1f74b412ee780c119550f670d850b6f9897
 SHA512:
-  metadata.gz: bf168f42f0a1e1df0bc0e169b824601579c793623458b5d13fbd8b3cf933d2fbe8abacf4e52f76c3c4795585cb32b276a5bae3505fa74d2cc63cb3d839a27341
-  data.tar.gz: c3d3d4fd6fc847d62d23e32c15db3874badce4c8743d28c40111d725eb7a3e5f4d39fdb3442b42c213ae524c262d128ea9de4062e985a044ce4e8c85bba2bae5
+  metadata.gz: 67eabf548f77d0d21d444b8186304054fe097195ce78a7f5d8e0ccc072dd04b16a05d59a43956d287c2045e3fe2aeb8a9ba778442c2620dd1ff9668b503968a0
+  data.tar.gz: c29f1c1d1440a5de7d3081cefd7463efcd4d6d8d95020d72a3efab8f71c25c5ee7ba0fceb0b9e76d2a5eb372a0459080299d9952a82cb19ea3ed3cca2ad26202

data/docs/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [0.11.3](https://github.com/klueless-io/k_director/compare/v0.11.2...v0.11.3) (2022-02-08)
+
+
+### Bug Fixes
+
+* add simple dsl ([0fd61ab](https://github.com/klueless-io/k_director/commit/0fd61abbe90a136c96b750fcf7456bc46aa73463))
+
+## [0.11.2](https://github.com/klueless-io/k_director/compare/v0.11.1...v0.11.2) (2022-02-08)
+
+
+### Bug Fixes
+
+* add typed_dom to base_director ([22ee75d](https://github.com/klueless-io/k_director/commit/22ee75da20cd00fe1f48f7027775b59dcf1c17a5))
+* move add, oadd, tadd, fadd from blueprint_director to base_director ([82f6aa0](https://github.com/klueless-io/k_director/commit/82f6aa02311ec04b9cb716846630274700deefb5))
+
+## [0.11.1](https://github.com/klueless-io/k_director/compare/v0.11.0...v0.11.1) (2022-02-07)
+
+
+### Bug Fixes
+
+* move add, oadd, tadd, fadd from blueprint_director to base_director ([caab926](https://github.com/klueless-io/k_director/commit/caab92618406a072c3e326a3a640f7c6a4b71f03))
+
+# [0.11.0](https://github.com/klueless-io/k_director/compare/v0.10.4...v0.11.0) (2022-02-07)
+
+
+### Features
+
+* move github, blueprint and package_json fluent accessors onto BaseDirector ([88fa3fd](https://github.com/klueless-io/k_director/commit/88fa3fd0df530bef3731f0b4a62369d925df2fa5))
+
 ## [0.10.4](https://github.com/klueless-io/k_director/compare/v0.10.3...v0.10.4) (2022-02-07)
 
 

data/lib/k_director/builders/actions_builder.rb

@@ -3,18 +3,13 @@
 module KDirector
   module Builders
     # Actions document builder
-    class ActionsBuilder
+    class ActionsBuilder < KDirector::Builders::DomBuilder
       attr_reader :actions
-      attr_reader :dom
       attr_reader :last_action
 
-      def initialize
-        reset
-      end
-
       def reset
+        super
         @actions = []
-        @dom = {}
         @last_action = {}
       end
 
@@ -23,100 +18,12 @@ module KDirector
         @last_action = action
       end
 
-      # Set many key/value pairs gainst a group
-      #
-      # example:
-      #   set_many(:github, repo_name: 'repo-name', organization: 'org-name')
-      def group_set(group = nil, **opts)
-        return if group.nil? && opts.empty?
-
-        if group.nil?
-          opts.each do |key, value|
-            set(key, value)
-          end
-        else
-          dom[group] = {} if opts.empty? # initialize the group name if no options are provided
-          opts.each do |key, value|
-            set(group, key, value)
-          end
-        end
-      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
-      #   set(:a, [])
-      #   add(:a, 1])
-      #   add(:a, 2])
-      #   add(:a, 3])
-      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(actions)
-        puts JSON.pretty_generate(dom)
-        # log.structure(dom)
+        super
 
         self
       end
-
-      def build
-        # hook into the set, add and queue_action methods form memoization
-        KUtil.data.to_open_struct(@dom)
-      end
-
-      private
-
-      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
 end

data/lib/k_director/builders/dom_builder.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Builders
+    # Dom builder
+    class DomBuilder
+      attr_reader :dom
+
+      def initialize
+        reset
+      end
+
+      def reset
+        @dom = {}
+      end
+
+      # Set many key/value pairs gainst a group
+      #
+      # example:
+      #   set_many(:github, repo_name: 'repo-name', organization: 'org-name')
+      def group_set(group = nil, **opts)
+        return if group.nil? && opts.empty?
+
+        if group.nil?
+          opts.each do |key, value|
+            set(key, value)
+          end
+        else
+          dom[group] = {} if opts.empty? # initialize the group name if no options are provided
+          opts.each do |key, value|
+            set(group, key, value)
+          end
+        end
+      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
+      #   set(:a, [])
+      #   add(:a, 1])
+      #   add(:a, 2])
+      #   add(:a, 3])
+      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 build
+        # hook into the set, add and queue_action methods form memoization
+        KUtil.data.to_open_struct(@dom)
+      end
+
+      private
+
+      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
+end

data/lib/k_director/directors/base_director.rb

@@ -51,6 +51,10 @@ module KDirector
         builder.dom
       end
 
+      def typed_dom
+        builder.build
+      end
+
       # Used by child directors to inherit options from parent
       def inherited_opts(**opts)
         {
@@ -89,6 +93,37 @@ module KDirector
         @options.on_action
       end
 
+      # Add a single file into the code base
+      #
+      # This is a wrapper around add_file that will add the file to the codebase using template path rules
+      #
+      # @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
+
       # Add a file to target folder
       def add_file(file, **opts)
         opts = {

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

@@ -7,35 +7,6 @@ module KDirector
       #
       # 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)

data/lib/k_director/dsls/simple_dsl.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Dsls
+    # BasicDsl is a DSL for generating basic projects.
+    class BasicDsl < KDirector::Directors::BaseDirector
+      def default_template_base_folder
+        'basic'
+      end
+    end
+  end
+end

data/lib/k_director/version.rb

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

data/lib/k_director.rb

@@ -7,6 +7,7 @@ require 'k_builder'
 require 'k_ext/github'
 
 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'
@@ -17,6 +18,7 @@ require_relative 'k_director/dsls/children/package_json_configuration'
 require_relative 'k_director/dsls/children/package_json'
 require_relative 'k_director/dsls/nuxt3_dsl'
 require_relative 'k_director/dsls/ruby_gem_dsl'
+require_relative 'k_director/dsls/simple_dsl'
 
 module KDirector
   # raise KDirector::Error, 'Sample message'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "k_director",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.11.0",
+      "version": "0.12.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.11.0",
+  "version": "0.12.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.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config
@@ -113,6 +113,7 @@ files:
 - 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/directors/data.rb
@@ -122,6 +123,7 @@ files:
 - lib/k_director/dsls/children/package_json_configuration.rb
 - lib/k_director/dsls/nuxt3_dsl.rb
 - lib/k_director/dsls/ruby_gem_dsl.rb
+- lib/k_director/dsls/simple_dsl.rb
 - lib/k_director/version.rb
 - package-lock.json
 - package.json