k_manager 0.0.13 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e1e2ee281f38810223b80d27b7ed6ba17f6d766c9bc3362925cb781faea6e6f
-  data.tar.gz: cce3bcc06ce095f5f00c55bc60ac47b0ea493930db4ebed635fe106303cf5957
+  metadata.gz: 10d0353e9cdde7cbec88c6b6a7dd47135da7fa026bf90ec9b6e5017c75ac2a0b
+  data.tar.gz: a77c72d2aa9888f29f3b3b835919828cbf6480e349cecb723e6862d81478f540
 SHA512:
-  metadata.gz: 7c6154b2a689a193cc88415d89959ca564783b04ee256a74c9a845c3d94102c2ae69be11d47e6cf01cc8e75ca52784d2f4a5b4cb8f373be074112464e7a1da5c
-  data.tar.gz: 70e7121af0c37a4458670b4668e4e8a9f0e4c798e317bca98ccdb27414529b4b7966373f0689a654991eefabdd9af783536aba33691c54b844cc51ade55071c5
+  metadata.gz: eda368dd81ee863ad42831c6527f27b56a60d78d2e2417d377d8425fc6bcf823efe3998a61c5c358ff0329ba2251530b16e94e51acf44c2d463e0dc24874d921
+  data.tar.gz: 6aa66dabe51fcecf3d76dd65f202e5b21b7023133ca1892d1d743ed7059f0b7d3e2a00a354ea3b6d780ec59a77131d50b784aaf786e0937f20a8f71a419d24ea

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   Exclude:
     - "_/**/*"
     - "spec/samples/**/*"
+    - "spec/k_manager/scenarios/**/*"
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile

@@ -23,3 +23,26 @@ group :development, :test do
   gem 'rubocop-rake', require: false
   gem 'rubocop-rspec', require: false
 end
+
+# If local dependency
+if ENV['KLUE_LOCAL_GEMS']&.to_s&.downcase == 'true'
+  group :development, :test do
+    puts 'Using Local GEMs'
+    gem 'handlebars-helpers'      , path: '../handlebars-helpers'
+    gem 'k_builder'               , path: '../k_builder'
+    gem 'k_builder-dotnet'        , path: '../k_builder-dotnet'
+    # gem 'k_builder-package_json'  , path: '../k_builder-package_json'
+    gem 'k_builder-webpack5'      , path: '../k_builder-webpack5'
+    gem 'k_config'                , path: '../k_config'
+    gem 'k_decor'                 , path: '../k_decor'
+    gem 'k_director'              , path: '../k_director'
+    gem 'k_doc'                   , path: '../k_doc'
+    gem 'k_domain'                , path: '../k_domain'
+    gem 'k_ext-github'            , path: '../k_ext-github'
+    gem 'k_fileset'               , path: '../k_fileset'
+    gem 'k_log'                   , path: '../k_log'
+    gem 'k_type'                  , path: '../k_type'
+    gem 'k_util'                  , path: '../k_util'
+    gem 'peeky'                   , path: '../peeky'
+  end
+end

data/Rakefile

@@ -8,6 +8,8 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'k_manager/version'
 
+Dir.glob('tasks/*.rake').each { |r| import r }
+
 RSpec::Core::RakeTask.new(:spec)
 
 require 'rake/extensiontask'

data/docs/flow.drawio

@@ -0,0 +1,16 @@
+<mxfile host="65bd71144e">
+    <diagram id="AE9tsI4e_FXgj975v7li" name="Page-1">
+        <mxGraphModel dx="1087" dy="583" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" background="#ffffff" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="2" value="KManager" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="200" y="70" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="3" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+                    <mxGeometry x="390" y="210" width="120" height="60" as="geometry"/>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>

data/exe/k_manager

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'pry'
+puts 'dddddddddddddddddddddd'
+
+lib_path = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+gem_path = File.expand_path(File.join(File.dirname(__FILE__), '../Gemfile'))
+
+$LOAD_PATH.unshift(lib_path)
+
+ENV['BUNDLE_GEMFILE'] = gem_path
+
+require 'bundler/setup'
+require 'k_manager'
+require 'k_manager/cli/commands'
+
+Dry::CLI.new(KManager::Cli::Commands).call

data/hooks/update-version

@@ -30,4 +30,4 @@ end
 output.push('')
 
 printf "%-25<label>s : %<version>s\n", label: 'GEM VERSION', version: version
-File.open('lib/k_manager/version.rb', 'w+') { |f| f.write(output.join("\n")) }
+File.write('lib/k_manager/version.rb', output.join("\n"))

data/k_manager.gemspec

@@ -38,10 +38,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_manager/extconf.rb']
 
+  spec.add_dependency 'dry-struct', '~> 1'
+  spec.add_dependency 'filewatcher', '~> 2.0.0.beta5'
   spec.add_dependency 'k_builder', '~> 0.0.0'
+  spec.add_dependency 'k_director', '~> 0.1'
   spec.add_dependency 'k_doc', '~> 0.0.0'
+  spec.add_dependency 'k_domain', '~> 0.0.0'
   spec.add_dependency 'k_ext-github', '~> 0.0.0'
+  spec.add_dependency 'k_fileset', '~> 0.0.0'
   spec.add_dependency 'k_log', '~> 0.0.0'
   # spec.add_dependency 'k_type'                , '~> 0.0.0'
   # spec.add_dependency 'k_util'                , '~> 0.0.0'
+  spec.add_dependency 'dry-cli', '~> 0.7.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/lib/k_manager/area.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module KManager
+  class Area
+    include KLog::Logging
+    extend Forwardable
+
+    attr_reader :manager
+    # TODO: I have not got a use for area name yet, it may be able to drive default config, but not sure.
+    attr_reader :name
+    attr_reader :namespace
+    attr_reader :config
+
+    def initialize(**opts)
+      @manager    = opts[:manager]
+      @name       = opts[:name]
+
+      raise 'Area name is required' unless @name
+
+      @namespace  = opts[:namespace] || @name
+      @config     = KConfig.configuration(@name)
+    end
+
+    def resource_manager
+      @resource_manager ||= KManager::Resources::ResourceManager.new(self)
+    end
+
+    def_delegators :resource_manager, :resource_changed, :resources, :find_by_uri
+
+    def debug(*sections)
+      log.kv 'Area'           , name
+      log.kv 'Namespace'      , namespace
+
+      resource_manager.debug if sections.include?(:resource) || sections.include?(:resources)
+      config.debug if sections.include?(:config)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def attribute_values(prefix = nil)
+      result = {}
+      result["#{prefix}name".to_sym]                  = name
+      result["#{prefix}namespace".to_sym]             = namespace
+      result["#{prefix}resource_count".to_sym]        = resource_manager.resources.length
+      result["#{prefix}document_count".to_sym]        = resource_manager.resources.sum { |resource| resource.documents.length }
+      result
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/k_manager/cli/base_command.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module KManager
+  module Cli
+    module Commands
+      class BaseCommand < Dry::CLI::Command
+        include KLog::Logging
+
+        option    :log_level,
+                  default: 'none',
+                  aliases: ['-l'],
+                  desc: 'Log level (:none, :debug)'
+
+        private
+
+        def absolute_path(path, base_path)
+          pathname = Pathname.new(path)
+          pathname.absolute? ? path : File.expand_path(path, base_path)
+        end
+      end
+    end
+  end
+end

data/lib/k_manager/cli/commands.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require_relative 'base_command'
+require_relative 'version'
+require_relative 'watch'
+require_relative 'new'
+require_relative 'info'
+
+module KManager
+  module Cli
+    module Commands
+      extend Dry::CLI::Registry
+
+      register 'version'    , Version     , aliases: %w[v -v --version]
+      register 'watch'      , Watch       , aliases: %w[w]
+      register 'new'        , New         , aliases: %w[n]
+      register 'info'       , Info        , aliases: %w[i]
+
+      # register 'generate', aliases: ['g'] do |prefix|
+      #   prefix.register 'config', Generate::Configuration
+      # end
+    end
+  end
+end

data/lib/k_manager/cli/info.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module KManager
+  module Cli
+    module Commands
+      class Info < KManager::Cli::Commands::BaseCommand
+        desc      'Print information about builder, project, and watcher folders'
+
+        argument  :project_folder,
+                  default: '.',
+                  desc: 'Info project folder (defaults to current directory .)'
+
+        option    :builder_folder,
+                  default: '.builders',
+                  desc: 'The builder folder, defaults to (.builders)'
+
+        def call(project_folder:, builder_folder:, **)
+          project_folder  = absolute_path(project_folder, Dir.pwd)
+          # name must be after project_folder
+          name            = File.basename(project_folder)
+          builder_folder  = absolute_path(builder_folder, project_folder)
+
+          log_params(name, project_folder, builder_folder)
+        end
+
+        private
+
+        def log_params(name, project_folder, builder_folder)
+          log.section_heading('Information')
+          log.kv 'Project Name'         , name
+          log.kv 'Project Folder'       , project_folder
+          log.kv 'Builder Folder'       , builder_folder
+          log.kv 'Project File Count'   , project_file_count(project_folder, builder_folder)
+          log.kv 'Builder File Count'   , builder_file_count(builder_folder)
+
+          # log_files(project_folder, project_file_list(project_folder, builder_folder), 'Project Files List')
+          log_files(builder_folder, builder_file_list(builder_folder), 'Builder Files')
+        end
+
+        def log_files(root_folder, files, title)
+          log.section_heading(title)
+          files.each do |file|
+            pathname = Pathname.new(file)
+            puts pathname.relative_path_from(root_folder).to_s
+          end
+        end
+
+        def project_file_count(project_folder, builder_folder)
+          project_file_list(project_folder, builder_folder).length
+        end
+
+        def project_file_list(project_folder, builder_folder)
+          return @project_file_list if defined? @project_file_list
+
+          @project_file_list = begin
+            pattern = '{.[^\.]*,*,**}/**/*'
+
+            result = Dir.chdir(project_folder) do
+              Dir.glob(pattern).map { |f| File.realpath(f) }
+            end
+
+            result - builder_file_list(builder_folder)
+          end
+        end
+
+        def builder_file_count(builder_folder)
+          builder_file_list(builder_folder).length
+        end
+
+        # Dir.glob(".").map(&File.method(:realpath))
+        def builder_file_list(builder_folder)
+          return @builder_file_list if defined? @builder_file_list
+
+          @builder_file_list = Dir.chdir(builder_folder) do
+            Dir.glob('**/*').map { |f| File.realpath(f) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k_manager/cli/new.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module KManager
+  module Cli
+    module Commands
+      class New < KManager::Cli::Commands::BaseCommand
+        desc      'Create a new KManager project'
+
+        argument  :project_folder,
+                  default: '.',
+                  desc: 'New project folder (defaults to current directory .)'
+
+        option    :builder_folder,
+                  default: '.builders',
+                  desc: 'The builder folder, defaults to (.builders)'
+
+        option    :force,
+                  default: false,
+                  aliases: ['-f'],
+                  desc: 'Force even if guard fails'
+
+        option    :template,
+                  default: false,
+                  aliases: ['-t'],
+                  desc: 'Starter template'
+
+        option    :log_level,
+                  default: nil,
+                  desc: 'Log level, use debug for more info'
+
+        example [
+          '                           # Project in current directory - will create a .builders folder and boot file at ./builders/boot.rb',
+          '-b ../config/boot.rb       # Project in current directory - will create a .builders folder and boot file at ./config/boot.rb',
+          '-t ruby_gem                # Use starter template `ruby_gem` to setup the files in .builders/*',
+          'my_project                 # will watch .xmen folder'
+        ]
+
+        # rubocop:disable Metrics/ParameterLists
+        def call(project_folder:, builder_folder:, log_level:, force:, template:, **)
+          project_folder        = absolute_path(project_folder, Dir.pwd)
+          name                  = File.basename(project_folder)
+          builder_folder        = absolute_path(builder_folder, project_folder)
+          template_root_folder  = File.expand_path('~/dev/kgems/k_templates/definitions/starter')
+
+          log_params(name, project_folder, builder_folder, force, log_level, template_root_folder, template) if log_level == 'debug'
+
+          create_project(name, project_folder, builder_folder, template_root_folder, template) if can_create?(force, builder_folder)
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        private
+
+        def create_project(name, project_folder, builder_folder, template_root_folder, template)
+          FileUtils.mkdir_p(project_folder)
+          FileUtils.mkdir_p(builder_folder)
+
+          # handle_main_start_command
+
+          setup_builder_from_template(name, builder_folder, template_root_folder, 'default') unless setup_builder_from_template(name, builder_folder, template_root_folder, template)
+
+          log.info 'Project created'
+        end
+
+        def setup_builder_from_template(name, builder_folder, template_root_folder, template = nil)
+          return false unless template
+
+          # /Users/davidcruwys/dev/kgems/k_templates/definitions/starter/ruby_gem/.starter.json
+          template_folder = File.join(template_root_folder, template)
+          starter_config = template_starter_config(template_folder)
+
+          return false unless starter_config
+
+          builder = get_builder(builder_folder, template_folder)
+
+          return false if starter_config['files'].nil? || starter_config['files'].empty?
+
+          starter_config['files']&.each do |relative_file|
+            builder.add_file(relative_file, template_file: relative_file, name: name)
+          end
+        end
+
+        def template_starter_config(template_folder)
+          starter_file = File.join(template_folder, '.starter.json')
+
+          return nil unless File.exist?(starter_file)
+
+          JSON.parse(File.read(starter_file))
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def get_builder(builder_folder, template_folder)
+          Handlebars::Helpers.configure do |config|
+            config.helper_config_file = File.join(Gem.loaded_specs['handlebars-helpers'].full_gem_path, '.handlebars_helpers.json')
+            config.string_formatter_config_file = File.join(Gem.loaded_specs['handlebars-helpers'].full_gem_path, '.handlebars_string_formatters.json')
+          end
+
+          KConfig.configure(:starter_template) do |config|
+            config.target_folders.add(:builder              , builder_folder)
+            config.template_folders.add(:template           , template_folder)
+          end
+
+          KBuilder::BaseBuilder.init(KConfig.configuration(:starter_template))
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def can_create?(force, builder_folder)
+          return true if force
+          return true unless File.directory?(builder_folder)
+
+          log.error "Project builder folder already exists: #{builder_folder}"
+
+          false
+        end
+
+        # rubocop:disable Metrics/ParameterLists
+        def log_params(name, project_folder, builder_folder, force, log_level, template_root_folder, template)
+          log.section_heading('Create new project')
+          log.kv 'name'                 , name
+          log.kv 'project_folder'       , project_folder
+          log.kv 'builder_folder'       , builder_folder
+          log.kv 'force'                , force
+          log.kv 'log_level'            , log_level
+          log.kv 'template_root_folder' , template_root_folder
+          log.kv 'template'             , template
+        end
+        # rubocop:enable Metrics/ParameterLists
+      end
+    end
+  end
+end

data/lib/k_manager/cli/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KManager
+  module Cli
+    module Commands
+      class Version < Dry::CLI::Command
+        desc 'Print version'
+
+        def call(*)
+          puts KManager::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/k_manager/cli/watch.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module KManager
+  module Cli
+    module Commands
+      class Watch < KManager::Cli::Commands::BaseCommand
+        desc      'Watch folder'
+
+        argument  :builder_folder,
+                  default: '.builders',
+                  desc: 'Folder to watch (aka builder folder), defaults to (.builders)'
+
+        option    :boot_file,
+                  default: 'boot.rb',
+                  aliases: ['-b'],
+                  desc: 'The boot file used for k_manager configuration'
+
+        example [
+          '                           # will watch .builders folder and boot from ./builders/boot.rb',
+          '-b ../config/boot.rb       # will watch .builders folder and boot from ./config/boot.rb',
+          '.xmen                      # will watch .xmen folder'
+        ]
+
+        def call(builder_folder:, boot_file:, log_level: , **)
+          builder_folder = absolute_path(builder_folder, Dir.pwd)
+          boot_file = absolute_path(boot_file, builder_folder)
+
+          log_params(builder_folder, boot_file) if log_level == 'debug'
+
+          # If you do a System Exit (control+c) you can go into a reboot sequence based on options
+          # if the option is not set then system will exit gracefully
+          while keep_watching(builder_folder, boot_file); end
+        end
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+        def keep_watching(builder_folder, boot_file)
+          Dir.chdir(builder_folder) do
+            watcher = KManager::Watcher.new(builder_folder, boot_file)
+            watcher.start
+          end
+          false
+        rescue Interrupt, SystemExit
+          if KManager.opts.reboot_on_kill == true || KManager.opts.reboot_on_kill == 1
+            puts "\nRebooting #{KManager.opts.app_name}..."
+            sleep KManager.opts.reboot_sleep unless KManager.opts.reboot_sleep.zero?
+
+            return true
+          end
+
+          puts "\nExiting..."
+          false
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def log_params(builder_folder, boot_file)
+          log.section_heading('Watch project')
+          log.kv 'builder_folder' , builder_folder
+          log.kv 'boot_file' , boot_file
+        end
+      end
+    end
+  end
+end

data/lib/k_manager/document_factory.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module KManager
+  # Factories for creating common DSL documents quickly
+  #
+  # Example:
+  #
+  #   KManager.csv(file: 'somepath/somefile.csv') do
+  #     load
+  #   end
+  class DocumentFactory
+    include KLog::Logging
+
+    # Create a KDoc::Model instance
+    def action(key = nil, **opts, &block)
+      document = new_document(KDoc::Action, key, **opts, &block)
+
+      attach_to_current_resource(document, change_content_type: :ruby)
+    end
+
+    # Create a KDoc::Model instance
+    def model(key = nil, **opts, &block)
+      document = new_document(KDoc::Model, key, **opts, &block)
+
+      attach_to_current_resource(document, change_content_type: :dsl)
+    end
+
+    # Create a KDoc::CsvDoc instance
+    def csv(key = nil, **opts, &block)
+      document = new_document(KDoc::CsvDoc, key, **opts, &block)
+
+      attach_to_current_resource(document, change_content_type: :dsl)
+    rescue StandardError => e
+      log.error(e)
+    end
+
+    # Create a KDoc::JsonDoc instance
+    def json(key = nil, **opts, &block)
+      document = new_document(KDoc::JsonDoc, key, **opts, &block)
+
+      attach_to_current_resource(document, change_content_type: :dsl)
+    rescue StandardError => e
+      log.error(e)
+    end
+
+    # Create a KDoc::YamlDoc instance
+    def yaml(key = nil, **opts, &block)
+      document = new_document(KDoc::YamlDoc, key, **opts, &block)
+
+      attach_to_current_resource(document, change_content_type: :dsl)
+    rescue StandardError => e
+      log.error(e)
+    end
+
+    private
+
+    # If document gets created dynamically due to class_eval then they
+    # can attach themselves to the currently focussed resource.
+    #
+    # It will throw an error if for_resource has not been called earlier
+    # in the thread lifecycle.
+    def attach_to_current_resource(document, change_content_type: nil)
+      return document unless KManager.current_resource
+
+      KManager.for_current_resource do |resource|
+        resource.attach_document(document, change_content_type: change_content_type)
+      end
+    end
+
+    # Create an instance of a document
+    #
+    # @param [Class<DocumentTaggable>] klass type of document to create
+    def new_document(klass, key = nil, **opts, &block)
+      # Should be able to infer
+      # key = KManager.current_resource.documents.length.zero? ? KManager.current_resource.infer_key : nil
+
+      # klass.new(key, **{ owner: KManager.current_resource }.merge(opts), &block)
+      klass.new(key, **opts, &block)
+    end
+  end
+end