k_builder-package_json 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15cb594096bcde9a4e3c2961b7266983587cea63433596c7711434bdca451a2d
-  data.tar.gz: 9d0dee4384addeb90e56d9afa8b587f81517c8d966c3fe4d37aaed687a90fde0
+  metadata.gz: 1955feb6eddedfbaf20e83f6192b80f8646b2a1a7c0331fb77d7b7a083382897
+  data.tar.gz: 3e40c92dc419c5d4c3187fe0841aea1f5bec8212b8050b596c6077b4ddf8f618
 SHA512:
-  metadata.gz: 2f53379cf8f2336cee626f0df81e4bfd22240e1792734013933dfe20c966ac8939ce674a123ec53f8d235bbc9633744a7fea3ce15d29de721dfbd970519dd060
-  data.tar.gz: 148f8e1f2a1aac4b6650a41f6266ede0c76f701e62fa079159ba9fc6767508cb4c1c3dde133c7483ca99aaec1ceb588f5f1bd44c5b86f688d94929fe7123f8d3
+  metadata.gz: 1668eacd9e2778018298d89cf569fd2fb8e27cb2c43ae35abac7a6964a8f47ab0ecd4205aeee1daad7bb81696275c6b7d1bf914f550f7a35d14af116b81dbe6b
+  data.tar.gz: 649800ddb5bf9f33ea33d9079ca381d4c07b4f9b9a5092417e847325c3c0c535ece2b4f2c49c33f791cb66616c53091d89d73728bccf0024642cdfdd250b627a

data/.rubocop.yml

@@ -60,6 +60,9 @@ Naming/MemoizedInstanceVariableName:
 Naming/VariableNumber:
   Exclude:
     - "**/spec/**/*"
+Naming/AccessorMethodName:
+  Exclude:
+    - "**/*builder*.rb"
 Style/EmptyMethod:    
   Exclude:
     - "**/spec/**/*"

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "cSpell.words": [
+    "boolbase",
+    "yallist"
+  ]
+}

data/k_builder-package_json.gemspec

@@ -38,5 +38,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_builder_package_json/extconf.rb']
 
-  # spec.add_dependency 'tty-box',         '~> 0.5.0'
+  spec.add_dependency 'k_builder', '~> 0.0.19'
 end

data/lib/k_builder/package_json.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require 'k_builder'
 require 'k_builder/package_json/version'
+require 'k_builder/package_json/configuration'
+require 'k_builder/package_json/package_builder'
 
 module KBuilder
   module PackageJson
     # raise KBuilder::PackageJson::Error, 'Sample message'
     class Error < StandardError; end
-
-    # Your code goes here...
   end
 end

data/lib/k_builder/package_json/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Attach configuration to the KBuilder module
+module KBuilder
+  module PackageJson
+    PackageGroup = Struct.new(:key, :description, :package_names)
+
+    # Configuration class
+    class Configuration < BaseConfiguration
+      attach_to(self, KBuilder::BaseConfiguration, :package_json)
+
+      attr_accessor :package_groups
+
+      def initialize
+        super()
+        @package_groups = {}
+      end
+
+      def set_package_group(key, description, package_names)
+        package_groups[key] = PackageGroup.new(key, description, package_names)
+      end
+
+      def 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])
+      end
+    end
+  end
+end

data/lib/k_builder/package_json/package_builder.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+module KBuilder
+  module PackageJson
+    # Configuration currently comes from KBuilder and stores template folders and target folders if configured
+    class PackageBuilder < KBuilder::Builder
+      SETTER_METHODS = %w[dependency_type].freeze
+
+      # In memory representation of the package.json file that is being created
+      attr_writer :package
+
+      def initialize(configuration = nil)
+        super(configuration)
+
+        set_package_file('package.json')
+        set_dependency_type(:development)
+      end
+
+      # Return an array of symbols to represent the fluent setter methods in this builder.
+      def builder_setter_methods
+        SETTER_METHODS
+      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
+        rc '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 KBuilder::PackageJson::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
+
+        @package[key] = value
+
+        write
+
+        self
+      end
+
+      # Dependency option
+      # ----------------------------------------------------------------------
+
+      # Getter for dependency option
+      def dependency_option
+        dependency_type == :development ? '-D' : '-P'
+      end
+
+      # Dependency type
+      # ----------------------------------------------------------------------
+
+      # Getter for dependency type
+      def dependency_type
+        hash['dependency_type']
+      end
+
+      # Target folder
+      # ----------------------------------------------------------------------
+
+      # Fluent setter for target folder
+      def set_package_file(value)
+        self.package_file = value
+
+        self
+      end
+
+      # Setter for target folder
+      def package_file=(_value)
+        hash['package_file'] = File.join(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}"
+        rc 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
+      #   rc "code #{package_file}"
+      # end
+
+      # private
+
+      # This is all wrong, but useful for now
+      def context
+        KBuilder.data.to_struct(hash)
+      end
+
+      def get_group(key)
+        group = context.package_json.package_groups[key]
+
+        raise KBuilder::PackageJson::Error, "unknown package group: #{key}" if group.nil?
+
+        group
+      end
+    end
+  end
+end

data/lib/k_builder/package_json/version.rb

@@ -2,6 +2,6 @@
 
 module KBuilder
   module PackageJson
-    VERSION = '0.0.2'
+    VERSION = '0.0.6'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: k_builder-package_json
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
-dependencies: []
+date: 2021-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: k_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.19
 description: "    KBuilder-PackageJson provides various fluent builders and code generators
   for building package.json file\n"
 email:
@@ -22,6 +36,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -39,6 +54,8 @@ files:
 - hooks/update-version
 - k_builder-package_json.gemspec
 - lib/k_builder/package_json.rb
+- lib/k_builder/package_json/configuration.rb
+- lib/k_builder/package_json/package_builder.rb
 - lib/k_builder/package_json/version.rb
 homepage: http://appydave.com/gems/k-builder-package-json
 licenses: