k_doc 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a629e6b0524e5610debb6b933e7473cf122518a9e7b0d86a8627e4d1e23380e
-  data.tar.gz: bac4ddc4e068b3c975ed51fcb2c93c6bbbdd7b2c9da6d82dc7706432b803b4f1
+  metadata.gz: e43e7408a95cf8bf701922e28ef33115d12dd66dd77af00ca1f8b0e492c0952d
+  data.tar.gz: 74506c87934ece30b1e5e37b111fc6ff347ae277b8085aff50a0dce698946b7c
 SHA512:
-  metadata.gz: 1bf61c53b8f3c75e315bf9ca05473c0c0c7b08c371ca62135297a66e5f96f8991f34df27cb3e7a75244b6037dde8023ad33cff7c98435415024c49392f18c666
-  data.tar.gz: 5f3c9aa53fdcf7022285818d5a857374050aad58523a74b1cb06c42a2bb603589d23745d0b36a018f2b8477b6aec666ed92be219cde9fd9e9a167766decb90da
+  metadata.gz: 92427570dd666fa9d679472fe48dd79771a877209ddd80df4143db1b03cf75ed587af99b1bca3f39e4f039e6ffa4e074c2173f19f8047811a17ca6c7d25cf248
+  data.tar.gz: 553d2c7d0bbf1304b7814e3196b3bf4d90a413c920c2209865918dd3351edabcd6fdad345cb4deb53fb5cb2678b637992caf00a7349218030a37518605071206

data/.rubocop.yml

@@ -44,15 +44,20 @@ Layout/LineLength:
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
-Style/Documentation:
+Style/AccessorGrouping:
   Enabled: false
-
 Style/BlockComments:
   Enabled: false
   Include:
     - "**/spec/*"
-
-# My Preferences - Start
+Style/Documentation:
+  Enabled: false
+Style/EmptyMethod:    
+  Exclude:
+    - "**/spec/**/*"
+Style/OpenStructUse:
+  Exclude:
+    - "**/spec/**/*"
 Metrics/ClassLength:
   Enabled: false
 Metrics/ModuleLength:
@@ -63,23 +68,14 @@ Naming/MemoizedInstanceVariableName:
 Naming/VariableNumber:
   Exclude:
     - "**/spec/**/*"
-Style/EmptyMethod:    
-  Exclude:
-    - "**/spec/**/*"
 Metrics/ParameterLists:
   Exclude:
     - "**/spec/**/*"
 Layout/EmptyLineBetweenDefs:
   Exclude:
     - "**/spec/**/*"
-
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "**/spec/**/*"
-
-Style/AccessorGrouping:
-  Enabled: false
-
 Layout/SpaceBeforeComma:
   Enabled: false
-# My Preferences - End

data/lib/k_doc/container.rb

@@ -9,6 +9,7 @@ module KDoc
     include KDoc::Taggable
     include KDoc::Datum
     include KDoc::BlockProcessor
+    include KDoc::Importable
 
     attr_reader :opts
 
@@ -24,6 +25,7 @@ module KDoc
 
       initialize_tag(opts)
       initialize_data(opts)
+      initialize_import(opts) if respond_to?(:initialize_import)
       initialize_block(opts, &block)
     end
 
@@ -36,7 +38,8 @@ module KDoc
     end
 
     def debug
-      debug_container
+      debug_taggable
+      debug_block_processor
       debug_errors
     end
 

data/lib/k_doc/mixins/block_processor.rb

@@ -6,9 +6,19 @@ module KDoc
   # Rename: BlockProcessor
   module BlockProcessor
     attr_accessor :block
+    attr_accessor :block_state
 
     def initialize_block(_opts, &block)
       @block = block if block_given?
+      @block_state = :initial
+    end
+
+    def evaluated?
+      @block_state == :evaluated || @block_state == :actioned
+    end
+
+    def actioned?
+      @block_state == :actioned
     end
 
     def execute_block(run_actions: nil)
@@ -20,6 +30,7 @@ module KDoc
       return if @block.nil?
 
       instance_eval(&@block)
+      @block_state = :evaluated
     rescue StandardError => e
       log.error('Standard error in document')
       # puts "key #{unique_key}"
@@ -32,7 +43,10 @@ module KDoc
     def run_on_action
       return if @block.nil?
 
-      on_action if respond_to?(:on_action)
+      if respond_to?(:on_action)
+        on_action
+        @block_state = :actioned
+      end
     rescue StandardError => e
       log.error('Standard error while running actions')
       # puts "key #{unique_key}"
@@ -41,5 +55,11 @@ module KDoc
       @error = e
       raise
     end
+
+    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?)
+    end
   end
 end

data/lib/k_doc/mixins/importable.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module KDoc
+  # Alow documents to import data from other sources (usually other documents)
+
+  module Importable
+    include KLog::Logging
+
+    attr_reader :importer
+    attr_reader :imports
+
+    # Imports are provided via an options hash, these imports are remove from the hash as they are read
+    #
+    # Any container can import data from an existing container via the import options
+    # rubocop:disable Style/OpenStructUse
+    def initialize_import(opts)
+      # log.error 'initialize_import'
+      @importer = opts.delete(:importer)
+      @imports = OpenStruct.new
+    end
+    # rubocop:enable Style/OpenStructUse
+
+    def call_importer
+      return unless importer
+
+      importer.call(self)
+    end
+
+    # def import(tag)
+    #   KManager.find_document(tag)
+    # end
+
+    # def import_data(tag, as: :document)
+    #   doc = KManager.find_document(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
+
+    protected
+
+    def debug_importable
+      # log.kv 'class type' , self.class.name   , debug_pad_size
+    end
+  end
+end

data/lib/k_doc/mixins/taggable.rb

@@ -67,28 +67,10 @@ module KDoc
       @namespace = ns.is_a?(Array) ? ns : [ns]
     end
 
-    # # Internal data object
-    # def data
-    #   @data ||= @tag_options.delete(:data) || @tag_options.delete(:default_data) || default_data_value
-    #   # Settings and Table on Model needed access to @data for modification, I don't think this should be a clone
-    #   # never return the original data object, but at the same time
-    #   # do not re-clone it every time this accessor is called.
-    #   # @clone_data ||= @data.clone
-    # end
-
-    # Implement in container
-    # def default_container_type
-    # :container
-    # end
-
-    # def default_data_value
-    #   {}
-    # end
-
     protected
 
     # rubocop:disable Metrics/AbcSize
-    def debug_container
+    def debug_taggable
       log.kv 'tag'        , tag               , debug_pad_size
       log.kv 'project'    , project           , debug_pad_size unless project.nil? || project.empty?
       log.kv 'namespace'  , namespace         , debug_pad_size unless namespace.nil? || namespace.empty?

data/lib/k_doc/model.rb

@@ -115,7 +115,8 @@ module KDoc
 
     def debug_header
       log.heading self.class.name
-      debug_container
+      debug_taggable
+      debug_block_processor
       debug_header_keys
 
       log.line

data/lib/k_doc/version.rb

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

data/lib/k_doc.rb

@@ -15,6 +15,7 @@ require 'k_doc/mixins/taggable'
 require 'k_doc/mixins/datum'
 require 'k_doc/mixins/block_processor'
 require 'k_doc/mixins/composable_components'
+require 'k_doc/mixins/importable'
 require 'k_doc/container'
 # require 'k_doc/data'
 require 'k_doc/action'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ files:
 - lib/k_doc/mixins/composable_components.rb
 - lib/k_doc/mixins/datum.rb
 - lib/k_doc/mixins/guarded.rb
+- lib/k_doc/mixins/importable.rb
 - lib/k_doc/mixins/taggable.rb
 - lib/k_doc/model.rb
 - lib/k_doc/model_backup.rb