k_doc 0.0.16 → 0.0.22

data/lib/k_doc/yaml_doc.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module KDoc
+  # YamlDoc is a DSL for modeling YAML data objects
+  class YamlDoc < KDoc::Container
+    attr_reader :file
+
+    # Create YAML document
+    #
+    # @param [String|Symbol] name Name of the document
+    # @param args[0] Type of the document, defaults to KDoc:: FakeOpinion.new.default_csv_type if not set
+    # @param default: Default value (using named params), as above
+    def initialize(key = nil, **opts, &block)
+      super(**{ key: key }.merge(opts))
+
+      initialize_file
+
+      @block = block if block_given?
+    end
+
+    # Load data from file
+    #
+    # @param [Symbol] load_action The load_action to take if data has already been loaded
+    # @param [:once] load_action :once will load the data from content source on first try only
+    # @param [:reload] load_action :reload will reload from content source each time
+    # @param [Symbol] data_action The data_action to take when setting data, defaults to :replace
+    # @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 load(load_action: :once, data_action: :replace)
+      return if load_action == :once && loaded?
+
+      content = File.read(file)
+      hash = YAML.safe_load(content)
+
+      set_data(hash, data_action: data_action)
+
+      @loaded = true
+
+      log_any_messages
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    private
+
+    def initialize_file
+      @file ||= opts.delete(:file) || ''
+      @loaded = false
+    end
+
+    def default_data_type
+      Hash
+    end
+
+    def default_container_type
+      :yaml
+    end
+  end
+end

data/lib/k_doc.rb

@@ -3,19 +3,27 @@
 require 'securerandom'
 
 require 'table_print'
+require 'forwardable'
 require 'k_log'
 require 'k_type'
 require 'k_util'
 require 'k_decor'
 
 require 'k_doc/version'
+require 'k_doc/mixins/guarded'
+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/container'
 # require 'k_doc/data'
+require 'k_doc/csv_doc'
+require 'k_doc/json_doc'
+require 'k_doc/yaml_doc'
 require 'k_doc/model'
 require 'k_doc/fake_opinion'
 require 'k_doc/settings'
 require 'k_doc/table'
-require 'k_doc/util'
 
 require 'k_doc/decorators/settings_decorator'
 require 'k_doc/decorators/table_decorator'
@@ -25,20 +33,48 @@ module KDoc
   class Error < StandardError; end
 
   class << self
-    # Factory method to create a new model
     def model(key = nil, **options, &block)
       model = KDoc::Model.new(key, **options, &block)
       model.execute_block
       model
     end
 
+    # These need to be registerable
+    def document(key = nil, **options, &block)
+      model(key, **{ type: :document }.merge(**options), &block)
+    end
+
+    def bootstrap(key = nil, **options, &block)
+      model(key, **{ type: :bootstrap }.merge(**options), &block)
+    end
+
+    def app_settings(key = nil, **options, &block)
+      model(key, **{ type: :app_settings }.merge(**options), &block)
+    end
+
+    def csv(key = nil, **options, &block)
+      doc = KDoc::CsvDoc.new(key, **options, &block)
+      doc.execute_block
+      doc
+    end
+
+    def json(key = nil, **options, &block)
+      doc = KDoc::JsonDoc.new(key, **options, &block)
+      doc.execute_block
+      doc
+    end
+
+    def yaml(key = nil, **options, &block)
+      doc = KDoc::YamlDoc.new(key, **options, &block)
+      doc.execute_block
+      doc
+    end
+
     attr_accessor :opinion
-    attr_accessor :util
     attr_accessor :log
   end
 
   KDoc.opinion = KDoc::FakeOpinion.new
-  KDoc.util = KDoc::Util.new
 end
 
 if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.22
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/directors/_.rb"
+- ".builders/directors/build_actions.rb"
+- ".builders/directors/design_pattern_director.rb"
+- ".builders/directors/director.rb"
+- ".builders/directors/klue_director.rb"
+- ".builders/initializers/_.rb"
+- ".builders/initializers/configure_builder.rb"
+- ".builders/initializers/handlebars_helpers.rb"
+- ".builders/setup.rb"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -111,21 +120,27 @@ files:
 - k_doc.gemspec
 - lib/k_doc.rb
 - lib/k_doc/container.rb
+- lib/k_doc/csv_doc.rb
 - lib/k_doc/decorators/settings_decorator.rb
 - lib/k_doc/decorators/table_decorator.rb
 - lib/k_doc/fake_opinion.rb
+- lib/k_doc/json_doc.rb
+- lib/k_doc/mixins/block_processor.rb
+- lib/k_doc/mixins/composable_components.rb
+- lib/k_doc/mixins/datum.rb
+- lib/k_doc/mixins/guarded.rb
+- lib/k_doc/mixins/taggable.rb
 - lib/k_doc/model.rb
+- lib/k_doc/model_backup.rb
 - lib/k_doc/settings.rb
 - lib/k_doc/table.rb
-- lib/k_doc/util.rb
 - lib/k_doc/version.rb
+- lib/k_doc/yaml_doc.rb
 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:

data/lib/k_doc/util.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module KDoc
-  # Utility helper methods for KDoc
-  class Util
-    # Build a unique key so that resources of the same key do not conflict with
-    # one another across projects, namespaces or types
-    #
-    # @param [String] param_name Param description
-    def build_unique_key(key, type = nil, namespace = nil, project_key = nil)
-      raise KDoc::Error, 'key is required when generating unique key' if key.nil? || key.empty?
-
-      type ||= KDoc.opinion.default_model_type
-
-      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }.map { |k| k.to_s.gsub('_', '-') }
-
-      keys.join('-')
-    end
-  end
-end