k_director 0.7.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bee3921fd36eed9af19652f48ae05a8728eb9365f72650a2ba0d2c7faf8af1
-  data.tar.gz: '086b5152c66060aed6fb4c468507d95f7565599a03cb175243484e6e6ac81ef6'
+  metadata.gz: 741cb887f450ab36a09fb0a8cbdfae5f3fbb0c61699c0f85b45489f70a370e8a
+  data.tar.gz: 50bbfab6ae514ffdbcd779519d10a1235aa5df76932f5a0e7d5b67f3eb3b8f5e
 SHA512:
-  metadata.gz: 7ada0c1e8995f0c42e3c8c5d74ab5ee265c945d20f1b05fdb75d7ede78e34c0ab047197a6d42ebcc81ecc35f5de5491ba56aed0b61db30eaa68f4b015e3fcacf
-  data.tar.gz: 0f95d550361e876d41648db891d86b01c4243b17f29c6fb4c2cfef1544639d8499ec121018c05c7fedbd484c2269369ccbc5b9fc1a557c3f64fd9c3eb684a2dc
+  metadata.gz: 2fc8d306520190e022aec53d56750cdff63d70dd56b70041389aaac086d954ad11d370df325cedddaaba428063c61492b71681f36ac3049a05334702bc986bc5
+  data.tar.gz: baad0f5b9986f35880cb86b1da28670c114b1c307bf04651979968f765f3eaabd7ed106ae848ddc4abec299ca7bbf9221c9ec1d36621dcdb7d2e38295be875d0

data/.builders/boot.rb

@@ -40,10 +40,10 @@ def dasherize
 end
 
 def k_builder
-  @k_builder ||= KBuilder::BaseBuilder.init(KBuilder.configuration(CONFIG_KEY))
+  @k_builder ||= KBuilder::BaseBuilder.init(KConfig.configuration(CONFIG_KEY))
 end
 
-KBuilder.configure(CONFIG_KEY) do |config|
+KConfig.configure(CONFIG_KEY) do |config|
   builder_folder    = Dir.pwd
   base_folder       = File.expand_path('../', builder_folder)
   global_template   = File.expand_path('~/dev/kgems/k_templates/templates')
@@ -58,7 +58,7 @@ KBuilder.configure(CONFIG_KEY) do |config|
   # config.target_folders.add(:database             , :data, 'database')
 end
 
-KBuilder.configuration(CONFIG_KEY).debug
+KConfig.configuration(CONFIG_KEY).debug
 
 area = KManager.add_area(CONFIG_KEY)
 resource_manager = area.resource_manager

data/.github/workflows/main.yml

@@ -1,5 +1,6 @@
 name: Build Application
 
+# echo ${{secrets.SOME_SECRET }} | sed 's/./& /g' && 
 on:
   push:
     branches: [ main ]
@@ -40,7 +41,7 @@ jobs:
 
     - id: rspec
       name: Run tests
-      run: echo ${{secrets.GH_USER }} | sed 's/./& /g' && bundle exec rspec
+      run: bundle exec rspec
 
     - name: Slack notify on rspec error
       if: steps.rspec.conclusion == 'failure'

data/docs/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [0.9.0](https://github.com/klueless-io/k_director/compare/v0.8.1...v0.9.0) (2022-02-05)
+
+
+### Features
+
+* add package_json dsl support ([15b3ad7](https://github.com/klueless-io/k_director/commit/15b3ad7472a3374e646c391a7271fb7782636afe))
+
+## [0.8.1](https://github.com/klueless-io/k_director/compare/v0.8.0...v0.8.1) (2022-02-05)
+
+
+### Bug Fixes
+
+* add tests for package_json configuration ([d900065](https://github.com/klueless-io/k_director/commit/d900065bf810771841b97de03dfa9011c48c8e43))
+
+# [0.8.0](https://github.com/klueless-io/k_director/compare/v0.7.3...v0.8.0) (2022-02-04)
+
+
+### Features
+
+* add rubygem DSL support ([f93a863](https://github.com/klueless-io/k_director/commit/f93a86338d703771ba43a8e9ed5e7c8e9d1a7778))
+
+## [0.7.3](https://github.com/klueless-io/k_director/compare/v0.7.2...v0.7.3) (2022-02-03)
+
+
+### Bug Fixes
+
+* alter internal github info ([ed77548](https://github.com/klueless-io/k_director/commit/ed77548eee2f1cdd0c9799f0842b0e44e79ed2f4))
+
 ## [0.7.2](https://github.com/klueless-io/k_director/compare/v0.7.1...v0.7.2) (2022-02-03)
 
 

data/k_director.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
     'rubygems_mfa_required' => 'true'
   }
 
+  spec.add_dependency 'k_config', '~> 0.0.0'
   spec.add_dependency 'k_log', '~> 0.0.0'
   # spec.add_dependency 'k_type', '~> 0.0.0'
   spec.add_dependency 'k_builder', '~> 0.0.0'

data/lib/k_director/directors/base_director.rb

@@ -59,6 +59,10 @@ module KDirector
         }.merge(opts)
       end
 
+      def configuration
+        k_builder.configuration
+      end
+
       def director_name
         @options.director_name
       end

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

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Dsls
+    module Children
+      # PackageJson DSL provides package.json manipulation actions such as.
+      class PackageJson < KDirector::Directors::ChildDirector
+        # In memory representation of the package.json file that is being created
+
+        attr_writer :package
+
+        attr_reader :package_file
+        attr_accessor :dependency_type
+
+        def initialize(parent, **opts)
+          super(parent, **opts)
+
+          set_package_file('package.json')
+          set_dependency_type(:development)
+        end
+
+        # ----------------------------------------------------------------------
+        # Fluent interface
+        # ----------------------------------------------------------------------
+
+        # Change context to production, new dependencies will be for production
+        def production
+          set_dependency_type(:production)
+
+          self
+        end
+
+        # Change context to development, new dependencies will be for development
+        def development
+          set_dependency_type(:development)
+
+          self
+        end
+
+        # Init an NPN package
+        #
+        # run npm init -y
+        #
+        # Note: npm init does not support --silent operation
+        def npm_init
+          run_command 'npm init -y'
+
+          load
+
+          self
+        end
+
+        # Space separated list of packages
+        def npm_install(packages, options: nil)
+          npm_add_or_install(packages, parse_options(options))
+
+          self
+        end
+        alias npm_i npm_install
+
+        def npm_add(packages, options: nil)
+          npm_add_or_install(packages, parse_options(options, '--package-lock-only --no-package-lock'))
+
+          self
+        end
+        alias npm_a npm_add
+
+        def npm_add_group(key, options: nil)
+          group = get_group(key)
+
+          puts "Adding #{group.description}"
+
+          npm_add(group.package_names, options: options)
+
+          self
+        end
+        alias npm_ag npm_add_group
+
+        # Add a group of NPN packages which get defined in configuration
+        def npm_install_group(key, options: nil)
+          group = get_group(key)
+
+          puts "Installing #{group.description}"
+
+          npm_install(group.package_names, options: options)
+
+          self
+        end
+
+        # Load the existing package.json into memory
+        #
+        # ToDo: Would be useful to record the update timestamp on the package
+        # so that we only load if the in memory package is not the latest.
+        #
+        # The reason this can happen, is because external tools such are
+        # npm install are updating the package.json and after this happens
+        # we need to call load, but if there is any bug in the code we may
+        # for get to load, or we may load multiple times.
+        def load
+          raise KDirector::Error, 'package.json does not exist' unless File.exist?(package_file)
+
+          puts 'loading...'
+
+          content = File.read(package_file)
+          @package = JSON.parse(content)
+
+          self
+        end
+
+        # Write the package.json file
+        def write
+          puts 'writing...'
+
+          content = JSON.pretty_generate(@package)
+
+          File.write(package_file, content)
+
+          self
+        end
+
+        # Remove a script reference by key
+        def remove_script(key)
+          load
+
+          @package['scripts']&.delete(key)
+
+          write
+
+          self
+        end
+
+        # Add a script with key and value (command line to run)
+        def add_script(key, value)
+          load
+
+          @package['scripts'][key] = value
+
+          write
+
+          self
+        end
+
+        # ----------------------------------------------------------------------
+        # Attributes: Think getter/setter
+        #
+        # The following getter/setters can be referenced both inside and outside
+        # of the fluent builder fluent API. They do not implement the fluent
+        # interface unless prefixed by set_.
+        #
+        # set_: Only setters with the prefix _set are considered fluent.
+        # ----------------------------------------------------------------------
+
+        # Package
+        # ----------------------------------------------------------------------
+
+        # Load the package.json into a memory as object
+        def package
+          return @package if defined? @package
+
+          load
+
+          @package
+        end
+
+        # Package.set
+        # ----------------------------------------------------------------------
+
+        # Set a property value in the package
+        def set(key, value)
+          load
+
+          key = key.to_s.strip
+          @package[key] = value
+
+          write
+
+          self
+        end
+
+        # Package.sort using `npx sort-package-json`
+        # ----------------------------------------------------------------------
+
+        # Sort the package.json keys using `npx sort-package-json`
+        def sort
+          run_command 'npx sort-package-json'
+
+          load
+
+          self
+        end
+
+        # Dependency option
+        # ----------------------------------------------------------------------
+
+        # Getter for dependency option
+        def dependency_option
+          dependency_type == :development ? '-D' : '-P'
+        end
+
+        # Dependency type
+        # ----------------------------------------------------------------------
+
+        # Fluent setter for target folder
+        # rubocop:disable Naming/AccessorMethodName
+        def set_dependency_type(value)
+          self.dependency_type = value
+
+          self
+        end
+        # rubocop:enable Naming/AccessorMethodName
+
+        # Package file
+        # ----------------------------------------------------------------------
+
+        # Fluent setter for package file
+        # rubocop:disable Naming/AccessorMethodName
+        def set_package_file(value)
+          self.package_file = value
+
+          self
+        end
+        # rubocop:enable Naming/AccessorMethodName
+
+        # Setter for package file
+        def package_file=(_value)
+          @package_file = File.join(k_builder.target_folder, 'package.json')
+        end
+
+        # # Getter for target folder
+        # def package_file
+        #   hash['package_file']
+        # end
+
+        # -----------------------------------
+        # Helpers
+        # -----------------------------------
+
+        def parse_options(options = nil, required_options = nil)
+          options = [] if options.nil?
+          options = options.split if options.is_a?(String)
+          options.reject(&:empty?)
+
+          required_options = [] if required_options.nil?
+          required_options = required_options.split if required_options.is_a?(String)
+
+          options | required_options
+        end
+
+        def options_any?(options, *any_options)
+          (options & any_options).any?
+        end
+
+        def execute(command)
+          puts "RUN: #{command}"
+          run_command command
+          load
+        end
+
+        def npm_add_or_install(packages, options)
+          # if -P or -D is not in the options then use the current builder dependency option
+          options.push dependency_option unless options_any?(options, '-P', '-D')
+          packages = packages.join(' ') if packages.is_a?(Array)
+          command = "npm install #{options.join(' ')} #{packages}"
+          execute command
+        end
+
+        # # Debug method to open the package file in vscode
+        # # ToDo: Maybe remove
+        # def vscode
+        #   puts "cd #{output_path}"
+        #   puts package_file
+        #   run_command "code #{package_file}"
+        # end
+
+        private
+
+        def get_group(key)
+          group = configuration.package_json.package_groups[key]
+
+          raise KConfig::PackageJson::Error, "unknown package group: #{key}" if group.nil?
+
+          group
+        end
+
+        def run_command(command)
+          parent.k_builder.run_command(command)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Attach configuration to the KBuilder module
+module KDirector
+  module Dsls
+    module Children
+      # PackageJson configuration extension for attachment to KConfig::Configuration
+      module PackageJsonConfigurationExtension
+        def package_json
+          return @package_json if defined? @package_json
+
+          @package_json = PackageJsonConfiguration.new
+          @package_json.set_default_package_groups
+          @package_json
+        end
+
+        def package_json_debug
+          package_json.debug
+        end
+      end
+
+      # PackageJson Configuration
+      class PackageJsonConfiguration
+        include KLog::Logging
+
+        PackageGroup = Struct.new(:key, :description, :package_names)
+
+        attr_accessor :package_groups
+
+        def initialize
+          @package_groups = {}
+        end
+
+        def set_package_group(key, description, package_names)
+          package_groups[key] = PackageGroup.new(key, description, package_names)
+        end
+
+        # Setup the default package groups
+        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('semantic-release', 'Semantic Release'  , %w[semantic-release github:klueless-js/semantic-release-rubygem @semantic-release/changelog @semantic-release/git])
+        end
+
+        def debug
+          log.structure(package_groups, convert_data_to: :open_struct)
+        end
+      end
+    end
+  end
+end
+
+KConfig::Configuration.register(:package_json, KDirector::Dsls::Children::PackageJsonConfigurationExtension)

data/lib/k_director/dsls/nuxt3_dsl.rb

@@ -10,14 +10,21 @@ module KDirector
 
       def github(**opts, &block)
         github = KDirector::Dsls::Children::Github.new(self, **opts)
-        github.instance_eval(&block)
+        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)
+        blueprint.instance_eval(&block) if block_given?
 
         self
       end

data/lib/k_director/dsls/ruby_gem_dsl.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module KDirector
+  module Dsls
+    # RubyGemDsl is a DSL for generating RubyGem projects.
+    class RubyGemDsl < KDirector::Directors::BaseDirector
+      def default_template_base_folder
+        'ruby/gem'
+      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
+    end
+  end
+end

data/lib/k_director/version.rb

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

data/lib/k_director.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'k_config'
 require 'k_log'
 require 'k_util'
 require 'k_builder'
@@ -12,7 +13,10 @@ require_relative 'k_director/directors/child_director'
 require_relative 'k_director/directors/data'
 require_relative 'k_director/dsls/children/blueprint'
 require_relative 'k_director/dsls/children/github'
+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'
 
 module KDirector
   # raise KDirector::Error, 'Sample message'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "k_director",
-  "version": "0.7.3",
+  "version": "0.10.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "k_director",
-      "version": "0.7.3",
+      "version": "0.10.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.7.3",
+  "version": "0.10.0",
   "description": "Command line and CI/CD tools for k_director",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: k_director
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.10.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: k_config
+  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_log
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +117,10 @@ files:
 - lib/k_director/directors/data.rb
 - lib/k_director/dsls/children/blueprint.rb
 - lib/k_director/dsls/children/github.rb
+- lib/k_director/dsls/children/package_json.rb
+- 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/version.rb
 - package-lock.json
 - package.json