k_doc 0.0.28 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f303cce0d48fa08ea50ce2e14a4c5d935fe927c2e634c03db0f2d909cb6a01a6
-  data.tar.gz: 5bffef8ae688894faf79e73c6fc04725315793d75795d784a3875563c7e6b1be
+  metadata.gz: 627b725f7a57a7eed231bac5a00c2409cdaaf1e5bf5c9610b15c63725cae0fbc
+  data.tar.gz: 3da6428f327fcf696cf7af358bca4db24f894e52d526e7b096fbf42d1fbdaddd
 SHA512:
-  metadata.gz: def580541db16a31f6c80759f7387da8a38f4e1ffbf4545d65ae14da72498fcc86e274b207931347937f55b4d78b9009443f6321b74a8b1a5224cc74127c28c4
-  data.tar.gz: e4cddb3891b5d4bc785833aa0d9de6efc19fd8d58f1525b99ca20b13407aa0a509ac4808fd70604093d9d7c67d0ffa64b9083af20ec45fba8a052dbd3dd29a5b
+  metadata.gz: be14c2081ea3656f0d52cad2aef871bd8f31f474ebc2b7f6a004d02a2f9198e79c52fe4b5c9bcf86ad022fc43e2cb7d1373e72cba6d0317e7ff2b40bd163a8e2
+  data.tar.gz: 46ba2d4f053d7548006317c8e5398379ab8a8167cd7e1d02ae9aa8eda988dce8eac42f207e2aa9e7fb7957c7cd91349dda1f5e30df63b320ec0e7b09d43e364a

data/lib/k_doc/container.rb

@@ -29,7 +29,7 @@ module KDoc
 
       initialize_tag(opts)
       initialize_data(opts)
-      initialize_block(opts, &block)
+      initialize_block_processor(opts, &block)
     end
 
     def default_container_type

data/lib/k_doc/fake_opinion.rb

@@ -28,10 +28,6 @@ module KDoc
       @default_yaml_type = :yaml
       @default_settings_key = :settings
       @default_table_key = :table
-
-      # @document_class = KDoc::Document
-      @table_class = KDoc::Table
-      @settings_class = KDoc::Settings
     end
   end
 end

data/lib/k_doc/mixins/block_processor.rb

@@ -3,39 +3,100 @@
 module KDoc
   # 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
+
+    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 = []
+    end
+
+    def execute_block(run_actions: false)
+      # Evaluate the main block of code
+      fire_eval # aka primary eval
+
+      # 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
+
+      # Call the block of code attached to the action method
+      fire_action if run_actions
+    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
+
+      @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
 
-      eval_block
-      run_on_action if run_actions
+    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 +108,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 +163,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/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,40 @@
 # 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 +58,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 +127,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.32'
 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.32
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,7 +132,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/lib/k_doc/model_backup.rb

@@ -1,191 +0,0 @@
-# frozen_string_literal: true
-
-# module KDoc
-#   # Model is a DSL for modeling general purpose data objects
-#   #
-#   # A model can have
-#   #  - 0 or more named setting groups each with their key/value pairs
-#   #  - 0 or more named table groups each with their own columns and rows
-#   #
-#   # A settings group without a name will default to name: :settings
-#   # A table group without a name will default to name: :table
-#   class Model < KDoc::Container
-#     include KLog::Logging
-
-#     # include KType::Error
-#     # include KType::ManagedState
-#     # include KType::NamedFolder
-#     # include KType::LayeredFolder
-
-#     attr_reader :options
-
-#     # Create document
-#     #
-#     # @param [String|Symbol] name Name of the document
-#     # @param args[0] Type of the document, defaults to KDoc:: FakeOpinion.new.default_model_type if not set
-#     # @param default: Default value (using named params), as above
-#     def initialize(key = nil, **options, &block)
-#       super(key: key, type: options[:type] || KDoc.opinion.default_model_type) # , namespace: options[:namespace], project_key: options[:project_key])
-#       initialize_attributes(**options)
-
-#       @block = block if block_given?
-#     end
-
-#     # NOTE: Can this be moved out of the is object?
-#     def execute_block(run_actions: nil)
-#       return if @block.nil?
-
-#       # The DSL actions method will only run on run_actions: true
-#       @run_actions = run_actions
-
-#       instance_eval(&@block)
-
-#       on_action if run_actions && respond_to?(:on_action)
-#     # rescue KDoc::Error => e
-#     #   puts('KDoc::Error in document')
-#     #   puts "key #{unique_key}"
-#     #   # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
-#     #   puts(e.message)
-#     #   @error = e
-#     #   raise
-#     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
-#       # log.exception exception2
-#       raise
-#     ensure
-#       @run_actions = nil
-#     end
-
-#     def settings(key = nil, **options, &block)
-#       options ||= {}
-
-#       opts = {}.merge(@options) # Data Options
-#                .merge(options)  # Settings Options
-#                .merge(parent: self)
-
-#       settings_instance(@data, key, **opts, &block)
-#       # settings.run_decorators(opts)
-#     end
-
-#     def table(key = :table, **options, &block)
-#       # NEED to add support for run_decorators I think
-#       options.merge(parent: self)
-#       table_instance(@data, key, **options, &block)
-#     end
-#     alias rows table
-
-#     # Sweet add-on would be builders
-#     # def builder(key, &block)
-#     #   # example
-#     #   KDoc::Builder::Shotstack.new(@data, key, &block)
-#     # end
-
-#     # Need to move this down to container
-#     # Need to use some sort of cache invalidation to know if the internal data has been altered
-#     def odata
-#       @odata ||= data_struct
-#     end
-
-#     def oraw
-#       @oraw ||= raw_data_struct
-#     end
-
-#     def data_struct
-#       KUtil.data.to_open_struct(data)
-#     end
-#     # alias d data_struct
-
-#     def raw_data_struct
-#       KUtil.data.to_open_struct(raw_data)
-#     end
-
-#     def get_node_type(node_name)
-#       node_name = KUtil.data.clean_symbol(node_name)
-#       node_data = @data[node_name]
-
-#       raise KDoc::Error, "Node not found: #{node_name}" if node_data.nil?
-
-#       if node_data.keys.length == 2 && (node_data.key?('fields') && node_data.key?('rows'))
-#         :table
-#       else
-#         :settings
-#       end
-#     end
-
-#     # Removes any meta data eg. "fields" from a table and just returns the raw data
-#     # REFACTOR: IT MAY BE BEST TO MOVE raw_data into each of the node_types
-#     def raw_data
-#       # REFACT, what if this is CSV, meaning it is just an array?
-#       #         add specs
-#       result = data
-
-#       result.each_key do |key|
-#         # ANTI: get_node_type uses @data while we are using @data.clone here
-#         result[key] = if get_node_type(key) == :table
-#                         # Old format was to keep the rows and delete the fields
-#                         # Now the format is to pull the row_value up to the key and remove rows and fields
-#                         # result[key].delete('fields')
-#                         result[key]['rows']
-#                       else
-#                         result[key]
-#                       end
-#       end
-
-#       result
-#     end
-
-#     # Move this out to the logger function when it has been refactor
-#     def debug(include_header: false)
-#       debug_header if include_header
-
-#       # tp dsls.values, :k_key, :k_type, :state, :save_at, :last_at, :data, :last_data, :source, { :file => { :width => 150 } }
-#       # puts JSON.pretty_generate(data)
-#       log.o(raw_data_struct)
-#     end
-
-#     def debug_header
-#       log.heading self.class.name
-#       debug_container
-#       debug_header_keys
-
-#       log.line
-#     end
-
-#     def debug_header_keys
-#       options&.keys&.reject { |k| k == :namespace }&.each do |key|
-#         log.kv key, options[key]
-#       end
-#     end
-
-#     private
-
-#     def initialize_attributes(**options)
-#       @options    = options || {}
-#       # Is parent a part of model, or is it part of k_manager::document_taggable (NOT SURE IF IT IS USED YET)
-#       @parent     = slice_option(:parent)
-
-#       # Most documents live within a hash, some tabular documents such as CSV will use an []
-#       @data       = slice_option(:default_data) || {}
-#     end
-
-#     def settings_instance(data, key, **options, &block)
-#       KDoc.opinion.settings_class.new(data, key, **options, &block)
-#     end
-
-#     def table_instance(data, key, **options, &block)
-#       KDoc.opinion.table_class.new(data, key, **options, &block)
-#     end
-
-#     def slice_option(key)
-#       return nil unless @options.key?(key)
-
-#       result = @options[key]
-#       @options.delete(key)
-#       result
-#     end
-#   end
-# end