k_doc 0.0.24 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62acce8bfac2c242082dd6cf050db2d7e6c535bc6af229f50b4185aec7573261
-  data.tar.gz: 23b23c0dffa5da8de05f88c0f470aa63dbdfe3f734582872debf0a74edd1c8fc
+  metadata.gz: f303cce0d48fa08ea50ce2e14a4c5d935fe927c2e634c03db0f2d909cb6a01a6
+  data.tar.gz: 5bffef8ae688894faf79e73c6fc04725315793d75795d784a3875563c7e6b1be
 SHA512:
-  metadata.gz: 3762d2ab76f5d4128a2330ea7ad84db2234bea4a56bec313ade497691a46df0f0e20aec4445268647b49d2d68279c3c5730d0ebdecd0b2dba0e48d15b7d77ded
-  data.tar.gz: 8e9054976e5e0fbe40e9a27cb3e5244cbd451b5d67c30246d874348b75fd17877774ac0dd819da017db8a3c02439e7fe70aa1fee9887c292d4d0c8997187fad6
+  metadata.gz: def580541db16a31f6c80759f7387da8a38f4e1ffbf4545d65ae14da72498fcc86e274b207931347937f55b4d78b9009443f6321b74a8b1a5224cc74127c28c4
+  data.tar.gz: e4cddb3891b5d4bc785833aa0d9de6efc19fd8d58f1525b99ca20b13407aa0a509ac4808fd70604093d9d7c67d0ffa64b9083af20ec45fba8a052dbd3dd29a5b

data/.builders/directors/director.rb

@@ -180,6 +180,6 @@ class Director
 
     return if @builder
 
-    @builder = KBuilder::BaseBuilder.init(KBuilder.configuration(opts[:builder_config_name]))
+    @builder = KBuilder::BaseBuilder.init(KConfig.configuration(opts[:builder_config_name]))
   end
 end

data/.builders/initializers/configure_builder.rb

@@ -1,5 +1,5 @@
 KBuilder.reset(:gem)
-KBuilder.configure(:gem) do |config|
+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')
@@ -7,14 +7,14 @@ KBuilder.configure(:gem) do |config|
 end
 
 KBuilder.reset(:design_patterns)
-KBuilder.configure(:design_patterns) do |config|
+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
 
-# KBuilder.configuration(:gem).debug
+# KConfig.configuration(:gem).debug
 
 # def builder
 #   @builder ||= KBuilder::BaseBuilder.init

data/.rubocop.yml

@@ -44,15 +44,19 @@ 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:
+  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/ModuleLength:
@@ -63,23 +67,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/README.md

@@ -52,17 +52,6 @@ Checkout the repo
 git clone klueless-io/k_doc
 ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
-
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-```bash
-bin/console
-
-Aaa::Bbb::Program.execute()
-# => ""
-```
-
 `k_doc` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
 
 To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/k_doc/container.rb

@@ -10,6 +10,10 @@ module KDoc
     include KDoc::Datum
     include KDoc::BlockProcessor
 
+    # OpenStruct to be populated with context data, this can be used inside the on_init
+    attr_reader :context
+
+    # Opts that are passed to the container. Some options will be removed when evaluated by different plugins (Taggable, BlockProcessor)
     attr_reader :opts
 
     # TODO: Owner/Owned need to be in a module and tested
@@ -20,6 +24,7 @@ module KDoc
     end
 
     def initialize(**opts, &block)
+      @context = OpenStruct.new
       @opts = opts
 
       initialize_tag(opts)
@@ -35,8 +40,13 @@ module KDoc
       @default_data_type ||= Hash
     end
 
+    def os(**opts)
+      OpenStruct.new(opts)
+    end
+
     def debug
-      debug_container
+      debug_taggable
+      debug_block_processor
       debug_errors
     end
 

data/lib/k_doc/mixins/block_processor.rb

@@ -6,20 +6,51 @@ module KDoc
   # Rename: BlockProcessor
   module BlockProcessor
     attr_accessor :block
+    attr_accessor :block_state
 
-    def initialize_block(_opts, &block)
+    # Proc/Handler to be called before evaluating when importing data
+    attr_reader :on_init
+
+    def initialize_block(opts, &block)
       @block = block if block_given?
+      @block_state = :new
+      @on_init = opts.delete(:on_init)
+    end
+
+    def evaluated?
+      @block_state == :evaluated || @block_state == :actioned
+    end
+
+    def actioned?
+      @block_state == :actioned
     end
 
     def execute_block(run_actions: nil)
+      run_on_init
+
+      # return unless dependencies_met?
+
       eval_block
       run_on_action if run_actions
     end
 
+    def run_on_init
+      instance_eval(&on_init) if on_init
+
+      @block_state = :initialized
+    rescue StandardError => e
+      log.error('Standard error in document on_init')
+      # puts "key #{unique_key}"
+      # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
+      log.error(e.message)
+      @error = e
+      raise
+    end
+
     def eval_block
-      return if @block.nil?
+      instance_eval(&block) if block
 
-      instance_eval(&@block)
+      @block_state = :evaluated
     rescue StandardError => e
       log.error('Standard error in document')
       # puts "key #{unique_key}"
@@ -30,9 +61,12 @@ module KDoc
     end
 
     def run_on_action
-      return if @block.nil?
+      return unless block
 
-      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 +75,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/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

@@ -23,6 +23,12 @@ 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
@@ -34,6 +40,11 @@ module KDoc
     end
 
     def table(key = :table, **opts, &block)
+      if block.nil?
+        log.warn 'You cannot call table without a block. Did you mean to call data[:table] or odata.table?'
+        return
+      end
+
       # NEED to add support for run_decorators I think
       opts.merge(parent: self)
       table_instance(data, key, **opts, &block)
@@ -115,7 +126,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/settings.rb

@@ -33,6 +33,10 @@ module KDoc
       end
     end
 
+    def imports
+      parent.imports
+    end
+
     # Return these settings which are attached to a data container using :key
     # internal_data is a bad name, but it is unlikely to interfere with any setting names
     # Maybe I rename this to raw_data

data/lib/k_doc/table.rb

@@ -20,6 +20,10 @@ module KDoc
       run_decorators(:update_rows)
     end
 
+    def imports
+      parent.imports
+    end
+
     # Pass fields in using the following format
     #   fields :name, f(:type, :string), :db_type
     #

data/lib/k_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.28
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport