k_doc 0.0.23 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c113abcf9cd5dd3c9a8518c45503afc2fb545e3365b9d0c1ae75dcef02da7c5
-  data.tar.gz: 1c4edfea6d0e82b5f300946a38880bbb3ee85a7ebb8f3979378bd8e755394028
+  metadata.gz: 13425498035dd9742336c907655e6555a37f7b4293c99443921bea29b38b0db9
+  data.tar.gz: 63ff3b0ad02f17833cc23318d529c80cc1e0165eae4d18fb096db484f331808b
 SHA512:
-  metadata.gz: 5f35384ccc40360f2fe92f99a994933b5a9060c0b1fcd5cd4a2e67dba4f17b49c2ed07ffeca9844510487aeddbe72afd585dd68b57306dccdc2f666e235f998f
-  data.tar.gz: 594e5175236bdc19405e5ad7d00dc8326d25902dd92e8698e06a778b430172ef6baeb5bf15b0ebcb9a0bcd044fc92ad7e18ffc9bacc7ee5428666d931eac909c
+  metadata.gz: d623d3964433ecbd4b33d4c4cce608d5e1923836ab6ffb3ab91c05dc9ae517719d2da2a14ca0ab3c83e5cace4593d2afaad80f24eaa4c8e8e48dd7b6229c886a
+  data.tar.gz: 9557e8c8082bcfed3acb10fea6a4516e7aec04a49cfdf3f99fb3800faf32531937df8f52278db7a0e02f6543b8e22e25bbadef7d472e530a5ccaf6c8ae053081

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/action.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KDoc
+  # Action is a DSL for modeling JSON data objects
+  class Action < KDoc::Container
+    attr_reader :file
+
+    # Simple Ruby Action
+    #
+    # @param [String|Symbol] name Name of the document
+    # @param args[0] Type of the document, defaults to KDoc:: FakeOpinion.new.default_action_type if not set
+    # @param default: Default value (using named params), as above
+    # @param [Proc] block The block is stored and accessed different types in the document loading workflow.
+    def initialize(key = nil, **opts, &_block)
+      super(**{ key: key }.merge(opts))
+    end
+
+    private
+
+    def default_data_type
+      String
+    end
+
+    def default_container_type
+      :action
+    end
+  end
+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)
       initialize_block(opts, &block)
     end
 
@@ -32,11 +34,16 @@ module KDoc
     end
 
     def default_data_type
-      Hash
+      @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/fake_opinion.rb

@@ -7,6 +7,7 @@ module KDoc
   # how I want to implement this
   # Need to look at the configuration patterns, this is really a configuration
   class FakeOpinion
+    attr_accessor :default_action_type
     attr_accessor :default_model_type
     attr_accessor :default_csv_type
     attr_accessor :default_json_type
@@ -19,7 +20,9 @@ module KDoc
     attr_accessor :table_class
 
     def initialize
-      @default_model_type = :entity
+      # @default_model_type = :entity
+      @default_action_type = :action
+      @default_model_type = :kdoc
       @default_csv_type = :csv
       @default_json_type = :json
       @default_yaml_type = :yaml

data/lib/k_doc/mixins/block_processor.rb

@@ -6,12 +6,23 @@ 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 execute_block(run_actions: nil)
+    def evaluated?
+      @block_state == :evaluated || @block_state == :actioned
+    end
+
+    def actioned?
+      @block_state == :actioned
+    end
+
+    def execute_block(run_importer: nil, run_actions: nil)
+      run_on_import if run_importer
       eval_block
       run_on_action if run_actions
     end
@@ -20,6 +31,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 +44,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 +56,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/guarded.rb

@@ -7,7 +7,7 @@ module KDoc
   module Guarded
     Guard = Struct.new(:type, :message)
 
-    def guard(message)
+    def guard(message, log: false)
       errors << Guard.new(:guard, message)
     end
 
@@ -42,5 +42,9 @@ module KDoc
         log.error error.message if error.type == :guard
       end
     end
+
+    def clear_errors
+      errors.clear
+    end
   end
 end

data/lib/k_doc/mixins/importable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module KDoc
+  # Alow documents to import data from other sources (usually other documents)
+
+  module Importable
+    include KLog::Logging
+
+    # Proc/Handler to be called when importing data
+    attr_reader :on_import
+
+    # OpenStruct to be populated with data from import
+    attr_reader :imports
+
+    def initialize_import(opts)
+      # log.error 'initialize_import'
+      @on_import = opts.delete(:on_import)
+      @imports = OpenStruct.new
+    end
+
+    def run_on_import
+      return unless on_import
+
+      instance_eval(&on_import)
+    end
+  end
+end

data/lib/k_doc/mixins/taggable.rb

@@ -67,39 +67,22 @@ 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
-      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?
-      log.kv 'key'      , key       , debug_pad_size
-      log.kv 'type'     , type      , debug_pad_size
+    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?
+      log.kv 'key'        , key               , debug_pad_size
+      log.kv 'type'       , type              , debug_pad_size
+      log.kv 'class type' , self.class.name   , debug_pad_size
       # log.kv 'error'    , error     , debug_kv_pad_size
     end
     # rubocop:enable Metrics/AbcSize
 
     def debug_pad_size
-      @debug_pad_size ||= @tag_options.delete(:debug_pad_size) || 15
+      @debug_pad_size ||= @tag_options.delete(:debug_pad_size) || 20
     end
 
     private

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

data/lib/k_doc.rb

@@ -15,8 +15,10 @@ 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'
 require 'k_doc/csv_doc'
 require 'k_doc/json_doc'
 require 'k_doc/yaml_doc'
@@ -52,6 +54,12 @@ module KDoc
       model(key, **{ type: :app_settings }.merge(**options), &block)
     end
 
+    def action(key = nil, **options, &block)
+      doc = KDoc::Action.new(key, **options, &block)
+      doc.execute_block
+      doc
+    end
+
     def csv(key = nil, **options, &block)
       doc = KDoc::CsvDoc.new(key, **options, &block)
       doc.execute_block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.27
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,7 @@ files:
 - hooks/update-version
 - k_doc.gemspec
 - lib/k_doc.rb
+- lib/k_doc/action.rb
 - lib/k_doc/container.rb
 - lib/k_doc/csv_doc.rb
 - lib/k_doc/decorators/settings_decorator.rb
@@ -129,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
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: KDoc provides a document in the form a DSL that contains flexible key/value