k_doc 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c113abcf9cd5dd3c9a8518c45503afc2fb545e3365b9d0c1ae75dcef02da7c5
-  data.tar.gz: 1c4edfea6d0e82b5f300946a38880bbb3ee85a7ebb8f3979378bd8e755394028
+  metadata.gz: 62acce8bfac2c242082dd6cf050db2d7e6c535bc6af229f50b4185aec7573261
+  data.tar.gz: 23b23c0dffa5da8de05f88c0f470aa63dbdfe3f734582872debf0a74edd1c8fc
 SHA512:
-  metadata.gz: 5f35384ccc40360f2fe92f99a994933b5a9060c0b1fcd5cd4a2e67dba4f17b49c2ed07ffeca9844510487aeddbe72afd585dd68b57306dccdc2f666e235f998f
-  data.tar.gz: 594e5175236bdc19405e5ad7d00dc8326d25902dd92e8698e06a778b430172ef6baeb5bf15b0ebcb9a0bcd044fc92ad7e18ffc9bacc7ee5428666d931eac909c
+  metadata.gz: 3762d2ab76f5d4128a2330ea7ad84db2234bea4a56bec313ade497691a46df0f0e20aec4445268647b49d2d68279c3c5730d0ebdecd0b2dba0e48d15b7d77ded
+  data.tar.gz: 8e9054976e5e0fbe40e9a27cb3e5244cbd451b5d67c30246d874348b75fd17877774ac0dd819da017db8a3c02439e7fe70aa1fee9887c292d4d0c8997187fad6

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

@@ -32,7 +32,7 @@ module KDoc
     end
 
     def default_data_type
-      Hash
+      @default_data_type ||= Hash
     end
 
     def debug

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

@@ -89,17 +89,18 @@ module KDoc
 
     # 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
+      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/version.rb

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

data/lib/k_doc.rb

@@ -17,6 +17,7 @@ require 'k_doc/mixins/block_processor'
 require 'k_doc/mixins/composable_components'
 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 +53,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.24
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2021-12-20 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
@@ -156,7 +157,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