k_director 0.10.2 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '080f78bce274be30bf0b77765c7fe6b40c56a9a5f40b385dd55ed96cd81b440b'
-  data.tar.gz: 7f12eeaf1ccdac94be739700260e30282766f85f9d4fad8f6e9cb81bd47359f0
+  metadata.gz: d6ee6da028f776a4ed4ed470290696dfcf2c15c0caa417666e9300f1d75ea390
+  data.tar.gz: 14dd16cd8185b21eef317ea6b8cfda1ee570c8559e77db264021722889962a74
 SHA512:
-  metadata.gz: 20fb925316d432b16e5ac5b5074f5e2d86845225262dae2460962b51199555d757e889a8a3fdd62b86dab2f60b7f35c5892a875b530369b9d83268e52d657be2
-  data.tar.gz: 2e5d5485a94a94cbfa2a86110e7bea1a5af50b32febc51830d935b5e4592ddc1bcd9d4424044acbb3d0ec0b606197e1c674bac57e43ccd5386a70bd1a0663272
+  metadata.gz: 34896604b4d9731e4a4ab0924572fdb65736bab9e71b63491ba16fd9d3f79418e3e63d4d81818048870333c002f76316846617df1ccbe5aaffb1c171e73efdc8
+  data.tar.gz: dcf6fd9985456ad96ac7383b29a08fcf020b8947502eac2af80c2618481f12bc193d180a1518d40cb4d074d8a8412dcaeecb5c017e1cddeda406ee365deab520

data/docs/CHANGELOG.md

@@ -1,3 +1,32 @@
+# [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)
+
+
+### Bug Fixes
+
+* add active option so that child directors can be suppressed or executed ([8a57617](https://github.com/klueless-io/k_director/commit/8a57617eea20dd9a020aec329bd994b3c444f087))
+
+## [0.10.3](https://github.com/klueless-io/k_director/compare/v0.10.2...v0.10.3) (2022-02-06)
+
+
+### Bug Fixes
+
+* package_json and multi-settings #settings(**opts, group: nil) ([7f23a08](https://github.com/klueless-io/k_director/commit/7f23a08751c3bca7ea99685f33a95eeed8786e1a))
+
+## [0.10.2](https://github.com/klueless-io/k_director/compare/v0.10.1...v0.10.2) (2022-02-06)
+
+
+### Bug Fixes
+
+* package_json, remove_package_lcok, remove_yarn_locak, create_yarn_lock ([d69c6a5](https://github.com/klueless-io/k_director/commit/d69c6a53a80551cdf5ac73024de8d2e597c37614))
+* package_json, remove_package_lcok, remove_yarn_locak, create_yarn_lock ([fdeef48](https://github.com/klueless-io/k_director/commit/fdeef481763160ca0c8d306491d7eb2e29536641))
+
 ## [0.10.1](https://github.com/klueless-io/k_director/compare/v0.10.0...v0.10.1) (2022-02-06)
 
 

data/lib/k_director/directors/base_director.rb

@@ -32,6 +32,7 @@ module KDirector
         @options.template_base_folder ||= default_template_base_folder
         @options.on_exist             ||= :skip       # %i[skip write compare]
         @options.on_action            ||= :queue      # %i[queue execute]
+        @options.active = true unless defined?(@options.active)
       end
 
       def data(name = nil, **opts)
@@ -55,7 +56,8 @@ module KDirector
         {
           on_exist: @options.on_exist,
           on_action: @options.on_action,
-          template_base_folder: @options.template_base_folder
+          template_base_folder: @options.template_base_folder,
+          active: @options.active
         }.merge(opts)
       end
 
@@ -63,6 +65,10 @@ module KDirector
         k_builder.configuration
       end
 
+      def active?
+        @options.active == true
+      end
+
       def director_name
         @options.director_name
       end
@@ -83,6 +89,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 = {
@@ -127,6 +164,29 @@ module KDirector
         k_builder.play_actions(builder.actions)
       end
 
+      # Common child directors
+
+      def github(**opts, &block)
+        github = KDirector::Dsls::Children::Github.new(self, **opts)
+        github.instance_eval(&block) if github.active? && block_given?
+
+        self
+      end
+
+      def package_json(**opts, &block)
+        package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
+        package_json.instance_eval(&block) if package_json.active? && block_given?
+
+        self
+      end
+
+      def blueprint(**opts, &block)
+        blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
+        blueprint.instance_eval(&block) if blueprint.active? && block_given?
+
+        self
+      end
+
       def debug
         debug_options
         debug_dom

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/children/package_json.rb

@@ -159,6 +159,28 @@ module KDirector
           @package
         end
 
+        # Package.settings is a hash of settings that can be applied to package.json
+        # ----------------------------------------------------------------------
+
+        # Settings
+        #
+        # Add multiple settings to the package.json
+        # @param opts [Hash] Hash of settings to add
+        #   opts[:group] is the group to add the settings to
+        def settings(**opts)
+          load
+
+          group = opts.delete(:group)
+
+          opts.each do |key, value|
+            set_key_value(key, value, group: group)
+          end
+
+          write
+
+          self
+        end
+
         # Package.set
         # ----------------------------------------------------------------------
 
@@ -166,15 +188,7 @@ module KDirector
         def set(key, value, group: nil)
           load
 
-          key = key.to_s.strip
-
-          if group.nil?
-            @package[key] = value
-          else
-            group = group.to_s.strip
-            @package[group] = {} unless @package[group]
-            @package[group][key] = value
-          end
+          set_key_value(key, value, group: group)
 
           write
 
@@ -245,8 +259,8 @@ module KDirector
         # rubocop:enable Naming/AccessorMethodName
 
         # Setter for package file
-        def package_file=(_value)
-          @package_file = File.join(k_builder.target_folder, 'package.json')
+        def package_file=(value)
+          @package_file = File.join(k_builder.target_folder, value)
         end
 
         # Remove package-lock.json
@@ -331,6 +345,18 @@ module KDirector
           group
         end
 
+        def set_key_value(key, value, group: nil)
+          key = key.to_s.strip
+
+          if group.nil?
+            @package[key] = value
+          else
+            group = group.to_s.strip
+            @package[group] = {} unless @package[group]
+            @package[group][key] = value
+          end
+        end
+
         def run_command(command)
           parent.k_builder.run_command(command)
         end

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

@@ -36,12 +36,18 @@ module KDirector
         end
 
         # Setup the default package groups
+        # rubocop:disable Metrics/MethodLength
         def set_default_package_groups
           set_package_group('webpack'         , 'Webpack V5'                , %w[webpack webpack-cli webpack-dev-server])
           set_package_group('swc'             , 'SWC Transpiler'            , %w[@swc/cli @swc/core swc-loader])
           set_package_group('babel'           , 'Babel Transpiler'          , %w[@babel/core @babel/cli @babel/preset-env babel-loader])
           set_package_group('typescript'      , 'Typescript'                , %w[typescript ts-loader])
-          set_package_group('semver-ruby'     , 'Semantic Release for Ruby' , %w[semantic-release github:klueless-js/semantic-release-rubygem @semantic-release/changelog @semantic-release/git])
+          set_package_group('semver-ruby'     , 'Semantic Release for Ruby' , %w[
+                              semantic-release
+                              @semantic-release/changelog
+                              @semantic-release/git
+                              @klueless-js/semantic-release-rubygem@github:klueless-js/semantic-release-rubygem
+                            ])
 
           set_package_group('semver-nuxt'     , 'Semantic Release for Nuxt' , %w[
                               semantic-release
@@ -55,7 +61,6 @@ module KDirector
                               autoprefixer@latest
                             ])
 
-          # this does not work yet
           set_package_group('storybook-nuxt'  , 'Storybook for (Vite/Nuxt)' , %w[
                               @storybook/vue3@6.4.18
                               @storybook/addon-postcss@2.0.0
@@ -63,10 +68,11 @@ module KDirector
                               storybook-builder-vite
                             ])
 
-          # Currently these two need to be foreced
+          # Currently these two need to be forced
           # @storybook/addon-docs@6.4.18
           # @storybook/addon-essentials@6.4.18
         end
+        # rubocop:enable Metrics/MethodLength
 
         def debug
           log.structure(package_groups, convert_data_to: :open_struct)

data/lib/k_director/dsls/nuxt3_dsl.rb

@@ -8,27 +8,6 @@ module KDirector
         'nuxt3'
       end
 
-      def github(**opts, &block)
-        github = KDirector::Dsls::Children::Github.new(self, **opts)
-        github.instance_eval(&block) if block_given?
-
-        self
-      end
-
-      def package_json(**opts, &block)
-        package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
-        package_json.instance_eval(&block) if block_given?
-
-        self
-      end
-
-      def blueprint(**opts, &block)
-        blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
-        blueprint.instance_eval(&block) if block_given?
-
-        self
-      end
-
       # def app(**opts, &block)
       #   app = Dsl::Nuxt3App.new(self, **opts)
       #   app.instance_eval(&block)

data/lib/k_director/dsls/ruby_gem_dsl.rb

@@ -8,26 +8,26 @@ module KDirector
         'ruby/gem'
       end
 
-      def github(**opts, &block)
-        github = KDirector::Dsls::Children::Github.new(self, **opts)
-        github.instance_eval(&block) if block_given?
+      # def github(**opts, &block)
+      #   github = KDirector::Dsls::Children::Github.new(self, **opts)
+      #   github.instance_eval(&block) if github.active? && block_given?
 
-        self
-      end
+      #   self
+      # end
 
-      def package_json(**opts, &block)
-        package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
-        package_json.instance_eval(&block) if block_given?
+      # def package_json(**opts, &block)
+      #   package_json = KDirector::Dsls::Children::PackageJson.new(self, **opts)
+      #   package_json.instance_eval(&block) if package_json.active? && block_given?
 
-        self
-      end
+      #   self
+      # end
 
-      def blueprint(**opts, &block)
-        blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
-        blueprint.instance_eval(&block) if block_given?
+      # def blueprint(**opts, &block)
+      #   blueprint = KDirector::Dsls::Children::Blueprint.new(self, **opts)
+      #   blueprint.instance_eval(&block) if blueprint.active? && block_given?
 
-        self
-      end
+      #   self
+      # end
     end
   end
 end

data/lib/k_director/version.rb

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

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "k_director",
-  "version": "0.10.2",
+  "version": "0.11.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.10.2",
+      "version": "0.11.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.10.2",
+  "version": "0.11.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.10.2
+  version: 0.11.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-06 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_config