k_doc 0.0.28 → 0.0.36

data/lib/k_doc/mixins/block_processor.rb

@@ -1,41 +1,151 @@
 # frozen_string_literal: true
 
 module KDoc
+  # Provide data load events, dependency and import management
+  #
   # A container acts a base data object for any data that requires tagging
   # such as unique key, type and namespace.
-  # Rename: BlockProcessor
+  #
+  # example usage of the container using model as the basis:
+  #   KDoc.model do
+  #     init do
+  #       context.some_data = :xmen
+  #     end
+  #     settings do
+  #       name context.some_data
+  #     end
+  #     action
+  #       puts context.some_data
+  #     end
+  #   end
   module BlockProcessor
-    attr_accessor :block
-    attr_accessor :block_state
+    include KLog::Logging
 
-    # Proc/Handler to be called before evaluating when importing data
-    attr_reader :on_init
+    attr_reader :block
+    attr_reader :block_state
 
-    def initialize_block(opts, &block)
+    attr_reader :init_block
+    attr_reader :action_block
+    attr_reader :children
+
+    # TODO: Can dependencies be extracted to their own module?
+    attr_reader :depend_on_tags
+    attr_reader :dependents
+
+    def initialize_block_processor(_opts, &block)
       @block = block if block_given?
       @block_state = :new
-      @on_init = opts.delete(:on_init)
+
+      @init_block = nil
+      @action_block = nil
+      @children = []
+
+      @depend_on_tags = []
+      @dependents = {}
+      @block_executed = false
+    end
+
+    def depend_on(*document_tags)
+      document_tags.each do |document_tag|
+        @depend_on_tags << document_tag
+      end
+    end
+
+    def resolve_dependency(document)
+      @dependents[document.tag] = document
+    end
+
+    def import(tag)
+      @dependents[tag]
+    end
+
+    def import_data(tag, as: :document)
+      doc = import(tag)
+
+      return nil unless doc&.data
+
+      # log.error 'about to import'
+      doc.debug(include_header: true)
+
+      return KUtil.data.to_open_struct(doc.data) if %i[open_struct ostruct].include?(as)
+
+      doc.data
+    end
+
+    def dependencies_met?
+      depend_on_tags.all? { |tag| dependents[tag] }
+    end
+
+    def execute_block(run_actions: false)
+      block_execute
+      fire_action if run_actions
+    end
+
+    def block_execute
+      return if @block_executed
+
+      # Evaluate the main block of code
+      fire_eval # aka primary eval
+
+      return unless dependencies_met?
+
+      # Call the block of code attached to the init method
+      fire_init
+
+      # Call the each block in the child array of blocks in the order of creation (FIFO)
+      fire_children
+
+      @block_executed = true
     end
 
+    # The underlying container is created and in the case of k_manager, registered
+    def new?
+      @block_state == :new
+    end
+
+    # The main block has been evaluated, but child blocks are still to be processed
     def evaluated?
-      @block_state == :evaluated || @block_state == :actioned
+      @block_state == :evaluated || initialized?
+    end
+
+    # Has the init block been called?
+    def initialized?
+      @block_state == :initialized || children_evaluated?
     end
 
+    # The block and the data it represents has been evaluated.
+    def children_evaluated?
+      @block_state == :children_evaluated || actioned?
+    end
+
+    # The on_action method has been called.
     def actioned?
       @block_state == :actioned
     end
 
-    def execute_block(run_actions: nil)
-      run_on_init
+    def fire_eval
+      return unless new?
 
-      # return unless dependencies_met?
+      instance_eval(&block) if block
 
-      eval_block
-      run_on_action if run_actions
+      @block_state = :evaluated
+    rescue StandardError => e
+      log.error('Standard error in document')
+      # puts "key #{unique_key}"
+      # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
+      log.error(e.message)
+      @error = e
+      raise
+    end
+
+    def init(&block)
+      @init_block = block
     end
 
-    def run_on_init
-      instance_eval(&on_init) if on_init
+    def fire_init
+      return unless evaluated?
+
+      instance_eval(&init_block) if init_block
 
       @block_state = :initialized
     rescue StandardError => e
@@ -47,24 +157,50 @@ module KDoc
       raise
     end
 
-    def eval_block
-      instance_eval(&block) if block
+    def add_child(block)
+      @children << block
+    end
 
-      @block_state = :evaluated
+    # Run blocks associated with the children
+    #
+    # A child can follow one of three patterns:
+    # 1. A block that is evaluated immediately against the parent class
+    # 2. A class that has its own custom block evaluation
+    # 3. A class that has a block which will be evaluated immediately against the child class
+    # rubocop:disable Metrics/AbcSize
+    def fire_children
+      return unless initialized?
+
+      children.each do |child|
+        if child.is_a?(Proc)
+          instance_eval(&child)
+        elsif child.respond_to?(:fire_eval)
+          child.fire_eval
+        elsif child.respond_to?(:block)
+          child.instance_eval(&child.block)
+        end
+      end
+
+      @block_state = :children_evaluated
     rescue StandardError => e
-      log.error('Standard error in document')
+      log.error('Standard error in document with one of the child blocks')
       # puts "key #{unique_key}"
       # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
       log.error(e.message)
       @error = e
       raise
     end
+    # rubocop:enable Metrics/AbcSize
+
+    def action(&block)
+      @action_block = block
+    end
 
-    def run_on_action
-      return unless block
+    def fire_action
+      return unless children_evaluated?
 
-      if respond_to?(:on_action)
-        on_action
+      if action_block
+        instance_eval(&action_block)
         @block_state = :actioned
       end
     rescue StandardError => e
@@ -76,10 +212,14 @@ module KDoc
       raise
     end
 
+    # rubocop:disable Metrics/AbcSize
     def debug_block_processor
-      log.kv 'block_state', block_state       , debug_pad_size if respond_to?(:block_state)
-      log.kv 'evaluated'  , evaluated?        , debug_pad_size if respond_to?(:evaluated?)
-      log.kv 'actioned'   , actioned?         , debug_pad_size if respond_to?(:actioned?)
+      log.kv 'block_state'        , block_state         , debug_pad_size
+      log.kv 'new'                , new?                , debug_pad_size
+      log.kv 'evaluated'          , evaluated?          , debug_pad_size
+      log.kv 'children_evaluated' , children_evaluated? , debug_pad_size
+      log.kv 'actioned'           , actioned?           , debug_pad_size
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/k_doc/mixins/guarded.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module KDoc
-  # Guarded provides parameter waring and guarding
+  # Guarded provides parameter warning and guarding
   #
   # TODO: this could be moved into KType or KGuard
   module Guarded

data/lib/k_doc/mixins/taggable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module KDoc
+  # Provide tagging functionality to the underlying model
+  #
   # A container acts a base data object for any data that requires tagging
   # such as unique key, type and namespace.
   module Taggable

data/lib/k_doc/model.rb

@@ -23,20 +23,18 @@ module KDoc
 
     # Need to look at Director as an alternative to this technique
     def settings(key = nil, **setting_opts, &block)
-      # TODO: add test
       if block.nil?
         log.warn 'You cannot call settings without a block. Did you mean to call data[:settings] or odata.settings?'
         return
       end
 
-      setting_opts ||= {}
-
-      setting_opts = {}.merge(opts) # Container options
+      setting_opts = {}.merge(opts)         # Container options
                        .merge(setting_opts) # Settings setting_opts
                        .merge(parent: self)
 
-      settings_instance(data, key, **setting_opts, &block)
-      # settings.run_decorators(opts)
+      child = KDoc::Settings.new(self, data, key, **setting_opts, &block)
+
+      add_child(child)
     end
 
     def table(key = :table, **opts, &block)
@@ -45,9 +43,9 @@ module KDoc
         return
       end
 
-      # NEED to add support for run_decorators I think
-      opts.merge(parent: self)
-      table_instance(data, key, **opts, &block)
+      child = KDoc::Table.new(self, data, key, **opts, &block)
+
+      add_child(child)
     end
     alias rows table
 
@@ -86,6 +84,11 @@ module KDoc
 
       raise KDoc::Error, "Node not found: #{node_name}" if node_data.nil?
 
+      if node_data.is_a?(Array)
+        puts 'why is this?'
+        return nil
+      end
+
       if node_data.keys.length == 2 && (node_data.key?('fields') && node_data.key?('rows'))
         :table
       else
@@ -138,15 +141,5 @@ module KDoc
         log.kv key, opts[key]
       end
     end
-
-    private
-
-    def settings_instance(data, key, **opts, &block)
-      KDoc.opinion.settings_class.new(data, key, **opts, &block)
-    end
-
-    def table_instance(data, key, **opts, &block)
-      KDoc.opinion.table_class.new(data, key, **opts, &block)
-    end
   end
 end

data/lib/k_doc/settings.rb

@@ -1,40 +1,41 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module KDoc
   # Builds up key/value settings from the block
-  # and applies them to a key coded node on the hash
+  #
   class Settings
     include KLog::Logging
-    # include KDoc::Decorators
 
     attr_reader :parent
     attr_reader :key
     attr_reader :decorators
+    attr_reader :block
 
-    alias kp parent
-
-    def initialize(data, key = nil, **options, &block)
-      initialize_attributes(data, key, **options)
+    def initialize(parent, data, key = nil, **opts, &block)
+      @parent = parent
+      @data = data
+      @key = (key || FakeOpinion.new.default_settings_key).to_s
+      @data[@key] = {}
+      @decorators = build_decorators(opts) # TODO: add tests for decorators
+      @block = block
+    end
 
-      # Need a way to find out the line number for errors and report it correctly
-      begin
-        instance_eval(&block) if block_given?
+    def fire_eval
+      return unless block
 
-        run_decorators
+      instance_eval(&block)
+      run_decorators
 
-        # rubocop:disable Style/RescueStandardError
-      rescue => e
-        # rubocop:enable Style/RescueStandardError
-        puts "Invalid code block in settings_dsl: #{@key}"
-        puts e.message
-        raise
-      end
+      # rubocop:disable Style/RescueStandardError
+    rescue => e
+      # rubocop:enable Style/RescueStandardError
+      log.error("Standard error while running settings for key: #{@key}")
+      log.error(e.message)
+      raise
     end
 
-    def imports
-      parent.imports
+    def context
+      parent.context
     end
 
     # Return these settings which are attached to a data container using :key
@@ -58,7 +59,7 @@ module KDoc
       # puts "args.length   : #{args.length}"
 
       if name != :type && !@parent.nil? && @parent.respond_to?(name)
-        puts "NAME: #{name}"
+        puts "Settings.method_missing - NAME: #{name}"
         return @parent.public_send(name, *args, &block)
       end
       raise KDoc::Error, 'Multiple setting values is not supported' if args.length > 1
@@ -127,21 +128,11 @@ module KDoc
       decorators.each { |decorator| decorator.decorate(self, :settings) }
     end
 
-    def initialize_attributes(data, key = nil, **options)
-      @data = data
-      @key = (key || FakeOpinion.new.default_settings_key).to_s
-
-      @parent = options[:parent] if options.key?(:parent)
+    def build_decorators(opts)
+      decorator_list = opts[:decorators].nil? ? [] : opts[:decorators]
 
-      decorator_list = options[:decorators].nil? ? [] : options[:decorators]
-
-      # This code needs to work differently, it needs to support the 3 different types
-      # Move the query into helpers
-      @decorators = decorator_list
-                    .map(&:new)
+      decorator_list.map(&:new)
                     .select { |decorator| decorator.compatible?(self) }
-
-      @data[@key] = {}
     end
   end
 end

data/lib/k_doc/table.rb

@@ -6,22 +6,38 @@ module KDoc
     include KLog::Logging
 
     attr_reader :parent
-    attr_reader :name
+    attr_reader :key # used to be called name
     attr_reader :decorators
+    attr_reader :block
 
-    def initialize(data, name = nil, **options, &block)
-      initialize_attributes(data, name, **options)
+    def initialize(parent, data, key = nil, **opts, &block)
+      @parent = parent
+      @data = data
+      @key = (key || FakeOpinion.new.default_table_key).to_s
+      @data[@key] = { 'fields' => [], 'rows' => [] }
+      @decorators = build_decorators(opts)
+      @block = block
+    end
+
+    def fire_eval
+      return unless block
+
+      instance_eval(&block)
 
       @has_executed_field_decorators = false
       @has_executed_row_decorators = false
 
-      instance_eval(&block) if block_given?
-
       run_decorators(:update_rows)
+
+      # rubocop:disable Style/RescueStandardError
+    rescue => e
+      # rubocop:enable Style/RescueStandardError
+      log.error("Table error for key: #{@key} - #{e.message}")
+      raise
     end
 
-    def imports
-      parent.imports
+    def context
+      parent.context
     end
 
     # Pass fields in using the following format
@@ -31,7 +47,7 @@ module KDoc
     def fields(*field_definitions)
       field_definitions = *field_definitions[0] if field_definitions.length == 1 && field_definitions[0].is_a?(Array)
 
-      fields = @data[@name]['fields']
+      fields = @data[@key]['fields']
 
       field_definitions.each do |fd|
         fields << if fd.is_a?(String) || fd.is_a?(Symbol)
@@ -46,7 +62,7 @@ module KDoc
 
     # rubocop:disable Metrics/AbcSize
     def row(*args, **named_args)
-      fields = @data[@name]['fields']
+      fields = @data[@key]['fields']
 
       raise KType::Error, "To many values for row, argument #{args.length}" if args.length > fields.length
 
@@ -63,31 +79,31 @@ module KDoc
       end
 
       # Override with named args
-      named_args.each_key do |key|
-        row[key.to_s] = named_args[key] # KUtil.data.clean_symbol(named_args[key])
+      named_args.each_key do |arg_name|
+        row[arg_name.to_s] = named_args[arg_name] # KUtil.data.clean_symbol(named_args[key])
       end
 
-      @data[@name]['rows'] << row
+      @data[@key]['rows'] << row
       row
     end
     # rubocop:enable Metrics/AbcSize
 
     # rubocop:disable Naming/AccessorMethodName
     def get_fields
-      @data[@name]['fields']
+      @data[@key]['fields']
     end
 
     def get_rows
-      @data[@name]['rows']
+      @data[@key]['rows']
     end
     # rubocop:enable Naming/AccessorMethodName
 
     def internal_data
-      @data[@name]
+      @data[@key]
     end
 
     def find_row(key, value)
-      @data[@name]['rows'].find { |r| r[key] == value }
+      @data[@key]['rows'].find { |r| r[key] == value }
     end
 
     # Field definition
@@ -138,24 +154,12 @@ module KDoc
     end
     # rubocop:enable Metrics/CyclomaticComplexity
 
-    # rubocop:disable Metrics/AbcSize
-    def initialize_attributes(data, name = nil, **options)
-      @data = data
-      @name = (name || FakeOpinion.new.default_table_key.to_s).to_s
-
-      @parent = options[:parent] if !options.nil? && options.key?(:parent)
+    def build_decorators(opts)
+      decorator_list = opts[:decorators].nil? ? [] : opts[:decorators]
 
-      # This code needs to work differently, it needs to support the 3 different types
-      # Move the query into helpers
-      decorator_list = options[:decorators].nil? ? [] : options[:decorators]
-
-      @decorators = decorator_list
-                    .map(&:new)
+      decorator_list.map(&:new)
                     .select { |decorator| decorator.compatible?(self) }
-
-      @data[@name] = { 'fields' => [], 'rows' => [] }
     end
-    # rubocop:enable Metrics/AbcSize
 
     def respond_to_missing?(name, *_args, &_block)
       (!@parent.nil? && @parent.respond_to?(name, true)) || super

data/lib/k_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDoc
-  VERSION = '0.0.28'
+  VERSION = '0.0.36'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.36
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,14 +88,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/_.rb"
+- ".builders/boot.rb"
 - ".builders/directors/_.rb"
 - ".builders/directors/build_actions.rb"
 - ".builders/directors/design_pattern_director.rb"
 - ".builders/directors/director.rb"
 - ".builders/directors/klue_director.rb"
-- ".builders/initializers/_.rb"
-- ".builders/initializers/configure_builder.rb"
-- ".builders/initializers/handlebars_helpers.rb"
+- ".builders/generators/domain_diagram.rb"
+- ".builders/generators/project_plan.rb"
 - ".builders/setup.rb"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -115,6 +116,16 @@ files:
 - bin/kgitsync
 - bin/khotfix
 - bin/setup
+- docs/class-diagram-dsl.png
+- docs/class-diagram.png
+- docs/domain-custom.drawio
+- docs/domain-custom.svg
+- docs/domain-modal.md
+- docs/domain.drawio
+- docs/domain_model.svg
+- docs/project-plan.drawio
+- docs/project-plan.md
+- docs/project_in_progress.svg
 - hooks/pre-commit
 - hooks/update-version
 - k_doc.gemspec
@@ -132,7 +143,6 @@ files:
 - lib/k_doc/mixins/guarded.rb
 - lib/k_doc/mixins/taggable.rb
 - lib/k_doc/model.rb
-- lib/k_doc/model_backup.rb
 - lib/k_doc/settings.rb
 - lib/k_doc/table.rb
 - lib/k_doc/version.rb

data/.builders/initializers/_.rb

@@ -1,7 +0,0 @@
-require 'k_log'
-require 'k_util'
-
-include KLog::Logging
-
-require_relative './configure_builder'
-require_relative './handlebars_helpers'

data/.builders/initializers/configure_builder.rb

@@ -1,38 +0,0 @@
-KBuilder.reset(:gem)
-KConfig.configure(:gem) do |config|
-  # config.template_folders.add(:global     , '~/dev/kgems/k_templates/definitions/genesis')
-  config.target_folders.add(:root         , File.expand_path('..', Dir.getwd))
-  config.target_folders.add(:lib          , :root, 'lib', 'k_doc')
-  config.target_folders.add(:spec         , :root, 'spec', 'k_doc')
-end
-
-KBuilder.reset(:design_patterns)
-KConfig.configure(:design_patterns) do |config|
-  config.template_folders.add(:global     , '~/dev/kgems/k_templates/templates/ruby_design_patterns')
-  config.target_folders.add(:root         , File.expand_path('..', Dir.getwd))
-  config.target_folders.add(:lib          , :root, 'lib', 'k_doc')
-  config.target_folders.add(:spec         , :root, 'spec', 'k_doc')
-end
-
-# KConfig.configuration(:gem).debug
-
-# def builder
-#   @builder ||= KBuilder::BaseBuilder.init
-# end
-
-puts ':)'
-
-# Setup.configure(:microapp) do |config|
-#   config.template_folders.add(:microapp   , '~/dev/kgems/k_templates/definitions/microapp')
-#   config.target_folders.add(:root         , Dir.getwd)
-# end
-
-# Setup.configure(:data) do |config|
-#   # config.template_folders.add(:microapp   , '~/dev/kgems/k_templates/definitions/microapp')
-#   config.target_folders.add(:root         , File.expand_path('..', Dir.getwd), '.data')
-# end
-
-# Setup.configure(:actual_app) do |config|
-#   # config.template_folders.add(:microapp   , '~/dev/kgems/k_templates/definitions/microapp')
-#   config.target_folders.add(:root         , File.expand_path('..', Dir.getwd))
-# end