k_doc 0.0.26 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43e7408a95cf8bf701922e28ef33115d12dd66dd77af00ca1f8b0e492c0952d
-  data.tar.gz: 74506c87934ece30b1e5e37b111fc6ff347ae277b8085aff50a0dce698946b7c
+  metadata.gz: 13425498035dd9742336c907655e6555a37f7b4293c99443921bea29b38b0db9
+  data.tar.gz: 63ff3b0ad02f17833cc23318d529c80cc1e0165eae4d18fb096db484f331808b
 SHA512:
-  metadata.gz: 92427570dd666fa9d679472fe48dd79771a877209ddd80df4143db1b03cf75ed587af99b1bca3f39e4f039e6ffa4e074c2173f19f8047811a17ca6c7d25cf248
-  data.tar.gz: 553d2c7d0bbf1304b7814e3196b3bf4d90a413c920c2209865918dd3351edabcd6fdad345cb4deb53fb5cb2678b637992caf00a7349218030a37518605071206
+  metadata.gz: d623d3964433ecbd4b33d4c4cce608d5e1923836ab6ffb3ab91c05dc9ae517719d2da2a14ca0ab3c83e5cace4593d2afaad80f24eaa4c8e8e48dd7b6229c886a
+  data.tar.gz: 9557e8c8082bcfed3acb10fea6a4516e7aec04a49cfdf3f99fb3800faf32531937df8f52278db7a0e02f6543b8e22e25bbadef7d472e530a5ccaf6c8ae053081

data/.rubocop.yml

@@ -56,8 +56,7 @@ Style/EmptyMethod:
   Exclude:
     - "**/spec/**/*"
 Style/OpenStructUse:
-  Exclude:
-    - "**/spec/**/*"
+  Enabled: false
 Metrics/ClassLength:
   Enabled: false
 Metrics/ModuleLength:

data/lib/k_doc/container.rb

@@ -25,7 +25,7 @@ module KDoc
 
       initialize_tag(opts)
       initialize_data(opts)
-      initialize_import(opts) if respond_to?(:initialize_import)
+      initialize_import(opts)
       initialize_block(opts, &block)
     end
 
@@ -37,6 +37,10 @@ module KDoc
       @default_data_type ||= Hash
     end
 
+    def os(**opts)
+      OpenStruct.new(opts)
+    end
+
     def debug
       debug_taggable
       debug_block_processor

data/lib/k_doc/mixins/block_processor.rb

@@ -21,7 +21,8 @@ module KDoc
       @block_state == :actioned
     end
 
-    def execute_block(run_actions: nil)
+    def execute_block(run_importer: nil, run_actions: nil)
+      run_on_import if run_importer
       eval_block
       run_on_action if run_actions
     end

data/lib/k_doc/mixins/importable.rb

@@ -6,47 +6,22 @@ module KDoc
   module Importable
     include KLog::Logging
 
-    attr_reader :importer
+    # Proc/Handler to be called when importing data
+    attr_reader :on_import
+
+    # OpenStruct to be populated with data from import
     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)
+      @on_import = opts.delete(:on_import)
       @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 run_on_import
+      return unless on_import
 
-    def debug_importable
-      # log.kv 'class type' , self.class.name   , debug_pad_size
+      instance_eval(&on_import)
     end
   end
 end

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)

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.26'
+  VERSION = '0.0.27'
 end

metadata

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