k_doc 0.0.21 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39ec448d9de5183b86d1ee4e4d45cf529db22669bf10567efd9c35151aaf79c
-  data.tar.gz: 5d2388c614eeedec80cc2a1b2a587d94763102983b3ffdf64b04906a7efcc8ea
+  metadata.gz: 2a629e6b0524e5610debb6b933e7473cf122518a9e7b0d86a8627e4d1e23380e
+  data.tar.gz: bac4ddc4e068b3c975ed51fcb2c93c6bbbdd7b2c9da6d82dc7706432b803b4f1
 SHA512:
-  metadata.gz: 9dd44d107a8b053afadace454dec1b650a9bb92b5f24451ff77dec479000a270904938d925efc9639c10a955c605995b3608465437d46b670c687fd595915564
-  data.tar.gz: b27b655fcd670d9db544f52b2b998fbf7adbbe00572cfec09c3e80d14518a403e1101826197c2d580e55768452c7791c6420f048ecafeeca59e0906ef2d1fbe0
+  metadata.gz: 1bf61c53b8f3c75e315bf9ca05473c0c0c7b08c371ca62135297a66e5f96f8991f34df27cb3e7a75244b6037dde8023ad33cff7c98435415024c49392f18c666
+  data.tar.gz: 5f3c9aa53fdcf7022285818d5a857374050aad58523a74b1cb06c42a2bb603589d23745d0b36a018f2b8477b6aec666ed92be219cde9fd9e9a167766decb90da

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/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/k_doc.gemspec

@@ -44,4 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'k_type'                , '~> 0.0.0'
   spec.add_dependency 'k_util'                , '~> 0.0.0'
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

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

@@ -14,7 +14,7 @@ module KDoc
 
     # TODO: Owner/Owned need to be in a module and tested
     attr_accessor :owner
-    
+
     def owned?
       @owner != nil
     end
@@ -31,8 +31,8 @@ module KDoc
       :container
     end
 
-    def default_data_value
-      {}
+    def default_data_type
+      @default_data_type ||= Hash
     end
 
     def debug

data/lib/k_doc/csv_doc.rb

@@ -53,8 +53,8 @@ module KDoc
       @loaded = false
     end
 
-    def default_data_value
-      []
+    def default_data_type
+      Array
     end
 
     def default_container_type

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

@@ -47,8 +47,8 @@ module KDoc
       @loaded = false
     end
 
-    def default_data_value
-      @default_data_value ||= {}
+    def default_data_type
+      Hash
     end
 
     def default_container_type

data/lib/k_doc/mixins/datum.rb

@@ -8,17 +8,14 @@ module KDoc
     attr_reader :data
 
     def initialize_data(opts)
-      @default_data_value = opts.delete(:default_data_value) if opts.key?(:default_data_value)
-      @data = opts.delete(:data) || opts.delete(:default_data) || default_data_value
+      @default_data_type = opts.delete(:default_data_type) if opts.key?(:default_data_type)
+      @data = opts.delete(:data) || opts.delete(:default_data) || default_data_type.new
 
-      return if data.is_a?(default_data_value.class)
-
-      warn("Incompatible data type - #{default_data_value.class} is incompatible with #{data.class}")
-      @data = default_data_value
+      warn("Incompatible data type - #{default_data_type} is incompatible with #{data.class} in constructor") unless data.is_a?(default_data_type)
     end
 
-    def default_data_value
-      raise 'Implement default_data_value in container' unless @default_data_value
+    def default_data_type
+      raise 'Implement default_data_type in container' unless @default_data_type
     end
 
     # Write data object
@@ -28,7 +25,7 @@ module KDoc
     # @param [:replace] data_action :replace will replace the existing data instance with the incoming data value
     # @param [:append] data_action :append will keep existing data and then new value data over the top
     def set_data(value, data_action: :replace)
-      return warn("Incompatible data type - #{default_data_value.class} is incompatible with #{value.class}") unless value.is_a?(default_data_value.class)
+      warn("Incompatible data type - #{default_data_type} is incompatible with #{value.class} in set data") unless value.is_a?(default_data_type)
 
       case data_action
       when :replace

data/lib/k_doc/mixins/guarded.rb

@@ -5,12 +5,14 @@ module KDoc
   #
   # TODO: this could be moved into KType or KGuard
   module Guarded
-    def guard(message)
-      errors << OpenStruct.new(type: :guard, message: message)
+    Guard = Struct.new(:type, :message)
+
+    def guard(message, log: false)
+      errors << Guard.new(:guard, message)
     end
 
     def warn(message)
-      errors << OpenStruct.new(type: :warning, message: message)
+      errors << Guard.new(:warning, message)
     end
     alias warning warn
 
@@ -19,11 +21,30 @@ module KDoc
     end
 
     def error_messages
-      @errors.map(&:message)
+      errors.map(&:message)
+    end
+
+    def error_hash
+      errors.map(&:to_h)
     end
 
+    # TODO: Add these predicates
+    # def errors?
+    # def warnings?
+
     def valid?
-      @errors.length.zero?
+      errors.length.zero?
+    end
+
+    def log_any_messages
+      errors.each do |error|
+        log.warn error.message if error.type == :warning
+        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

@@ -44,6 +44,7 @@ module KDoc
       @type ||= @tag_options.delete(:type) || default_container_type
     end
 
+    # TODO: rename to area (or area root namespace)
     # Project name
     #
     # Examples
@@ -88,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
@@ -107,8 +109,8 @@ module KDoc
       values = []
       values << project if project
       values += namespace
-      values << type if type
       values << key
+      values << type if type
       values -= [nil, '']
       @tag = values.join('_').to_sym
     end

data/lib/k_doc/version.rb

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

data/lib/k_doc/yaml_doc.rb

@@ -37,6 +37,8 @@ module KDoc
       set_data(hash, data_action: data_action)
 
       @loaded = true
+
+      log_any_messages
     end
 
     def loaded?
@@ -50,8 +52,8 @@ module KDoc
       @loaded = false
     end
 
-    def default_data_value
-      @default_data_value ||= {}
+    def default_data_type
+      Hash
     end
 
     def default_container_type

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.21
+  version: 0.0.25
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2022-02-12 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
@@ -140,9 +141,7 @@ homepage: http://appydave.com/gems/k-doc
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://appydave.com/gems/k-doc
-  source_code_uri: https://github.com/klueless-io/k_doc
-  changelog_uri: https://github.com/klueless-io/k_doc/commits/master
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -158,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