k_manager 0.0.13

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hooks/pre-commit

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'English'
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/pre-commit
+
+exit 0 if ARGV.include?('--no-verify')
+
+warning_keywords = %w[console.log]
+keywords = %w[binding.pry console.dir byebug debugger]
+files_changed = `git diff-index --name-only HEAD --`.split
+
+# puts '----------------------------------------------------------------------'
+# puts remove files changed from the pre-commit checking if they are one of the following files
+# puts '----------------------------------------------------------------------'
+# files_changed = files_changed - ['hooks/pre-commit']
+# files_changed = files_changed - ['hooks/update-version']
+
+# byebug may need to be in these files
+files_changed -= ['Gemfile']
+files_changed -= ['Gemfile.lock']
+files_changed -= ['.gitignore']
+files_changed -= ['README.md']
+
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.json') }
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.yml') }
+
+# ignore files from specific folders
+
+file_groups = files_changed.select do |item|
+  item.start_with?('hooks') # ||
+  # item.start_with?('lib/generators')
+end
+
+files_changed -= file_groups
+
+# remove files that are changed because they are deleted
+files_changed = files_changed.select { |filename| File.file?(filename) }
+
+# puts '----------------------------------------------------------------------'
+# puts 'Files Changed'
+# puts '----------------------------------------------------------------------'
+# puts files_changed
+# puts '----------------------------------------------------------------------'
+
+unless files_changed.length.zero?
+  # puts "#{keywords.join('|')}"
+  # puts "#{files_changed.join(' ')}"
+
+  `git grep -q -E "#{warning_keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      warning_keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "WARNING:\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+  end
+
+  `git grep -q -E "#{keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "ERROR  :\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+    puts '# Force commit with --no-verify'
+    exit 1
+  end
+end

data/hooks/update-version

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/update-version
+
+exit 1 if ARGV.empty?
+
+version = ARGV[0]
+version = version[1..-1] # revoke 'v' character, e.g. v0.1.1 becomes 0.1.1
+
+namespaces = %w[KManager]
+
+indent = 0
+output = ['# frozen_string_literal: true', '']
+
+namespaces.each do |namespace|
+  output.push "#{'  ' * indent}module #{namespace}"
+  indent += 1
+end
+
+output.push "#{'  ' * indent}VERSION = \'#{version}'"
+indent -= 1
+
+namespaces.each do
+  output.push "#{'  ' * indent}end"
+  indent -= 1
+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")) }

data/k_manager.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/k_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version  = '>= 2.5'
+  spec.name                   = 'k_manager'
+  spec.version                = KManager::VERSION
+  spec.authors                = ['David Cruwys']
+  spec.email                  = ['david@ideasmen.com.au']
+
+  spec.summary                = 'K Manager provides a managed host for documents, resources and code generator execution'
+  spec.description            = <<-TEXT
+    K Manager provides a managed host for documents, resources and code generator execution
+  TEXT
+  spec.homepage               = 'http://appydave.com/gems/k-manager'
+  spec.license                = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  # spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/klueless-io/k_manager'
+  spec.metadata['changelog_uri'] = 'https://github.com/klueless-io/k_manager/commits/master'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the RubyGem files that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  # spec.extensions    = ['ext/k_manager/extconf.rb']
+
+  spec.add_dependency 'k_builder', '~> 0.0.0'
+  spec.add_dependency 'k_doc', '~> 0.0.0'
+  spec.add_dependency 'k_ext-github', '~> 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'
+end

data/lib/k_manager.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'k_doc'
+require 'k_builder'
+require 'k_ext/github'
+require 'k_log'
+
+require 'k_manager/create_document'
+require 'k_manager/version'
+require 'k_manager/configuration/project_config'
+require 'k_manager/documents/document_taggable'
+require 'k_manager/documents/basic_document'
+require 'k_manager/documents/model_document'
+require 'k_manager/documents/builder_document'
+require 'k_manager/resources/base_resource'
+require 'k_manager/resources/file_resource'
+require 'k_manager/resources/csv_file_resource'
+require 'k_manager/resources/json_file_resource'
+require 'k_manager/resources/ruby_file_resource'
+require 'k_manager/resources/yaml_file_resource'
+require 'k_manager/resources/unknown_file_resource'
+require 'k_manager/project'
+
+module KManager
+  extend CreateDocument
+
+  # raise KManager::Error, 'Sample message'
+  class Error < StandardError; end
+
+  class << self
+    def new_project_config(&block)
+      config = KManager::Configuration::ProjectConfig.new
+      block.call(config) if block_given?
+      config
+    end
+
+    # Instance of the currently focused resource
+    # if document get created dynamically due to class_eval then they
+    # can attach themselves to the currently focussed resource via
+    # KManager.target_resource.add_document(document)
+    attr_accessor :target_resource
+  end
+end
+
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'KManager::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('k_manager/version') }
+  version = KManager::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end

data/lib/k_manager/configuration/project_config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KManager
+  module Configuration
+    # Project configuration class for KManager
+    #
+    # This configuration contains template and target folders as used
+    # by all k_builders, it also has additional configuration that makes
+    # sense for a project, such as the GitHub repository configuration
+    class ProjectConfig < KBuilder::Configuration
+      attach_to(KExt::Github::Configuration, self, :github)
+    end
+  end
+end

data/lib/k_manager/create_document.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module KManager
+  module CreateDocument
+    def model(key = nil, **opts)
+      opts = { key: key }.merge(opts) unless key.nil?
+      document = new_document(KManager::Documents::ModelDocument, **opts)
+
+      attach_to_resource(document, change_resource_type: :dsl)
+    end
+
+    def attach_to_resource(document, change_resource_type: :dsl)
+      KManager.target_resource&.attach_document(document, change_resource_type: :dsl)
+      document
+    end
+
+    # Create an instance of a document
+    #
+    # @param [Class<DocumentTaggable>] klass type of document to create
+    def new_document(klass, **opts)
+      key = KManager.target_resource.documents.length.zero? ? KManager.target_resource.infer_key : nil
+
+      opts = {
+        resource: KManager.target_resource,
+        key: key
+      }.merge(opts)
+
+      klass.new(**opts)
+    end
+  end
+end

data/lib/k_manager/documents/basic_document.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KManager
+  module Documents
+    # A basic document stores a simple data object with tags for
+    # unique key, type, namespace and project.
+    class BasicDocument < KDoc::Container
+      include KLog::Logging
+      include KManager::Documents::DocumentTaggable
+
+      def initialize(**opts)
+        super(**opts)
+        initialize_document_tags(**opts)
+      end
+
+      def default_document_type
+        :basic
+      end
+    end
+  end
+end

data/lib/k_manager/documents/builder_document.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KManager
+  module Documents
+    class BuilderDocument
+      include KLog::Logging
+      include KManager::Documents::DocumentTaggable
+
+      def initialize(**opts)
+        initialize_document_tags(**opts)
+      end
+
+      # def default_document_type
+      #   nil
+      # end
+    end
+  end
+end

data/lib/k_manager/documents/document_taggable.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module KManager
+  module Documents
+    # Tag a document with attributes that can be used to uniquely identify
+    # a document within a project or namespace
+    #
+    # Examples:
+    #   User DSL could be tagged user_entity
+    #   Blue print DSL for building a data layer User could be tagged user_blueprint
+    #   Users.csv file could be tagged data_files_users_csv
+    #   Account DSL in the CRM project could be tagged crm_account_entity
+    #   AccountController DSL in the CRM project could be tagged crm_controllers_account_controller
+    module DocumentTaggable
+      # Name of the document (required)
+      #
+      # Examples: user, account, country
+      attr_reader :key
+
+      # Type of document (optional, but will set to :default_document_type if not provided)
+      #
+      # Examples by data type
+      #   :csv, :yaml, :json, :xml
+      #
+      # Examples by shape of the data in a DSL
+      #   :entity, :microapp, blueprint
+      attr_reader :type
+
+      # Namespace of the document (optional, '' if not set)
+      #
+      # When using a data file, this should be based on the relative file path
+      # When using a DSL data file, this will be manually configured
+      attr_reader :namespace
+
+      # Resource that this document belongs to (optional)
+      attr_accessor :resource
+
+      # Project that this document belongs to (optional)
+      attr_reader :project
+
+      # Project key is inferred from the attached project ('' if project not set)
+      attr_reader :project_key
+
+      # Errors in documents can be stored against the document
+      #
+      # This helps debugging invalid DSL's and data documents
+      attr_reader :error
+
+      def initialize_document_tags(**opts)
+        @key = opts[:key] || SecureRandom.alphanumeric(4)
+        @type = opts[:type] || default_document_type
+        @namespace = opts[:namespace] || ''
+        @resource = opts[:resource]
+        @project = @resource&.project
+        @project_key = project&.infer_key
+      end
+
+      # This method should be implemented on the document class
+      # generally it will return a :symbol
+      # def default_document_type; end;
+
+      # The unique key on resources provides a way to prevent conflicts
+      # between resource names, resource types, local namespaces and projects.
+      def unique_key
+        return @unique_key if defined? @unique_key
+
+        @unique_key = begin
+          raise KDoc::Error, 'key is required when generating unique key' if key.nil? || key.empty?
+
+          [project_key, namespace, key, type]
+            .reject { |k| k.nil? || k == '' }
+            .map { |k| k.to_s.gsub('_', '-') }
+            .join('-')
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def debug
+        log.section_heading(self.class.name)
+
+        log.kv 'unique_key'   , unique_key  , 15
+        log.kv 'key'          , key         , 15
+        log.kv 'type'         , type        , 15
+        log.kv 'namespace'    , namespace   , 15
+        # log.kv 'resource'     , resource    , 15
+        # log.kv 'project'      , project     , 15
+        log.kv 'project_key'  , project_key , 15
+        log.kv 'data'         , data.nil? ? '' : data.to_s[0..100].gsub("\n", '\n'), 15
+        log.kv 'error'        , error       , 15
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/k_manager/documents/model_document.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KManager
+  module Documents
+    class ModelDocument < KDoc::Model
+      include KLog::Logging
+      include KManager::Documents::DocumentTaggable
+
+      def initialize(**opts)
+        super(**opts)
+        initialize_document_tags(**opts)
+      end
+
+      def default_document_type
+        KDoc.opinion.default_model_type
+      end
+    end
+  end
+end

data/lib/k_manager/project.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module KManager
+  require 'handlebars/helpers/string_formatting/dasherize'
+
+  # A project represents all the DSL and Data resources that are available, it keeps a track of
+  # the in memory state of the resources, are they loaded into memory or not.
+  class Project
+    # Project name
+    attr_reader :name
+
+    # Project namespace, aka namespace root
+    attr_reader :namespace
+
+    # Configuration for this project
+    attr_reader :config
+
+    # List of resources attached to this project
+    attr_reader :resources
+
+    def initialize(name, config = nil, **opts)
+      raise KType::Error, 'Provide a project name' unless name.is_a?(String) || name.is_a?(Symbol)
+
+      @name = name
+      @config = config || KManager::Configuration::ProjectConfig.new
+      @resources = []
+
+      initialize_opts(opts)
+    end
+
+    def add_resource(resource)
+      # Need to check if this and resource.attach_project need to delegate to each other
+      # Need to check that resources can't be added twice
+      # Tests are required
+      @resources << resource
+    end
+
+    # Infer key is the project name stored in dash-case
+    def infer_key
+      Handlebars::Helpers::StringFormatting::Dasherize.new.parse(name.to_s.gsub('_', '-'))
+    end
+
+    private
+
+    def initialize_opts(opts)
+      # project name is often a good default for the namespace
+      @namespace = opts[:namespace] || name
+    end
+  end
+end