k_doc 0.0.11 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3a22296c27473f92f9012c2c58c341cd622041f4f54b853cd098e667e2bd861
-  data.tar.gz: 1a39ea8f5f79db0a05204f18b6e070f2083d1bbd756b17ca24de7e0c77208c43
+  metadata.gz: f5d1fec58551c4d2c72de3c9629c0b90847352c38b2d491a021dfce0d72afac6
+  data.tar.gz: 7f38b815def0fdcabd801daf8e9e569c36213f306f28781d8956f8bfa12b0be7
 SHA512:
-  metadata.gz: d66c94012e5dfed8899f89abdfaf8fd2ae13c3a35b8c31e77b45555d1ce539b66f88ca61fd56b42db6d2c9184c58d6df7cfc14949a40d30e5238e15e9bb5fa42
-  data.tar.gz: cb190abbb8f67ad7421a72474245ddaaa44901c70d6f4fd09cdfe7b325b759ff353fd30199396680751b2025a9a6f364a1043480c32551b885038dc7d101ad40
+  metadata.gz: d2ec5f47f7f5dd3cf295bb430615768149724233451b0aaa09aaecca56752292b167948714ea4f146f8050488a7019a2b90ab7d824c6e540dcfc0de0831af5bb
+  data.tar.gz: bc816e70fc04faaf6109e4abe57528b48df868b48bee93eecbc152aa782d22c44a98304eef09f8cbd9bbbbd4ec6ab7dc7ab50b16f73f98b915dae24326928c40

data/lib/k_doc.rb

@@ -10,11 +10,11 @@ require 'k_decor'
 
 require 'k_doc/version'
 require 'k_doc/container'
-require 'k_doc/data'
+# require 'k_doc/data'
+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'
@@ -24,20 +24,19 @@ module KDoc
   class Error < StandardError; end
 
   class << self
-    # Factory method to create a new data
-    def data(key = nil, **options, &block)
-      data = KDoc::Data.new(key, **options, &block)
-      data.execute_block
-      data
+    # Is this needed
+    # 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
 
     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'

data/lib/k_doc/container.rb

@@ -1,15 +1,30 @@
 # frozen_string_literal: true
 
 module KDoc
-  # A container acts a base data object for any data requires tagging such as
+  # A data acts a base data object for any data requires tagging such as
   # unique key, type and namespace.
   class Container
     # include KLog::Logging
 
+    # Name of the document (required)
+    #
+    # Examples: user, account, country
     attr_reader :key
+
+    # Type of data
+    #
+    # Examples by data type
+    #   :csv, :yaml, :json, :xml
+    #
+    # Examples by shape of the data in a DSL
+    #   :entity, :microapp, blueprint
     attr_reader :type
-    attr_reader :namespace
-    attr_reader :project_key
+
+    attr_writer :data
+
+    # Move this up to k_manager
+    # attr_reader :namespace
+    # attr_reader :project_key
     attr_reader :error
 
     # Create container for storing data/documents.
@@ -19,35 +34,20 @@ module KDoc
     #
     # @param [Hash] **opts The options
     # @option opts [String|Symbol] name Name of the container
-    # @option opts [String|Symbol] type Type of the container, defaults to KDoc:: FakeOpinion.new.default_document_type if not set
+    # @option opts [String|Symbol] type Type of the container, defaults to KDoc:: FakeOpinion.new.default_model_type if not set
     # @option opts [String|Symbol] namespace Namespace that the container belongs to
     # @option opts [String|Symbol] project_key Project that the container belongs to
     def initialize(**opts)
-      @key = opts[:key] || SecureRandom.alphanumeric(8)
-      @type = opts[:type] || KDoc.opinion.default_document_type
-      @namespace = opts[:namespace] || ''
-      @project_key = opts[:project_key] || ''
-
-      # Old name is default_data, wonder if I still need that idea?
-      # Most documents live within a hash, some tabular documents such as CSV will use an []
-      # @data       = slice_option(:default_data) || {}
+      @key = opts[:key] || SecureRandom.alphanumeric(4)
+      @type = opts[:type] || ''
       @data = opts[:data] || {}
     end
 
-    def unique_key
-      @unique_key ||= KDoc.util.build_unique_key(key, type, namespace, project_key)
-    end
-
     def debug_header
       log.kv 'key', key
       log.kv 'type', type
-      log.kv 'namespace', namespace
-      log.kv 'project_key', namespace
-      log.kv 'error', error
     end
 
-    attr_writer :data
-
     def data
       @data.clone
     end

data/lib/k_doc/fake_opinion.rb

@@ -6,7 +6,7 @@ module KDoc
   # This is called fake opinion because I have not figured out
   # how I want to implement this
   class FakeOpinion
-    attr_accessor :default_document_type
+    attr_accessor :default_model_type
     attr_accessor :default_settings_key
     attr_accessor :default_table_key
 
@@ -15,7 +15,7 @@ module KDoc
     attr_accessor :table_class
 
     def initialize
-      @default_document_type = :entity
+      @default_model_type = :entity
       @default_settings_key = :settings
       @default_table_key = :table
 

data/lib/k_doc/{data.rb → model.rb}

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 module KDoc
-  # General purpose data DSL
+  # Model is a DSL for modeling general purpose data objects
   #
-  # Made up of 0 or more setting groups and table groups
-  class Data < KDoc::Container
+  # A mode can have
+  #  - 0 or more named setting groups each with their key/value pairs
+  #  - 0 or more named table groups each with their own columns and rows
+  #
+  # A settings group without a name will default to name: :settings
+  # A table group without a name will default to name: :table
+  class Model < KDoc::Container
     include KLog::Logging
 
     # include KType::Error
@@ -17,15 +22,16 @@ module KDoc
     # Create document
     #
     # @param [String|Symbol] name Name of the document
-    # @param args[0] Type of the document, defaults to KDoc:: FakeOpinion.new.default_document_type if not set
+    # @param args[0] Type of the document, defaults to KDoc:: FakeOpinion.new.default_model_type if not set
     # @param default: Default value (using named params), as above
     def initialize(key = nil, **options, &block)
-      super(key: key, type: options[:type], namespace: options[:namespace], project_key: options[:project_key])
+      super(key: key, type: options[:type] || KDoc.opinion.default_model_type) # , namespace: options[:namespace], project_key: options[:project_key])
       initialize_attributes(**options)
 
       @block = block if block_given?
     end
 
+    # NOTE: Can this be moved out of the is object?
     def execute_block(run_actions: nil)
       return if @block.nil?
 
@@ -44,7 +50,7 @@ module KDoc
     #   raise
     rescue StandardError => e
       log.error('Standard error in document')
-      puts "key #{unique_key}"
+      # puts "key #{unique_key}"
       # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
       log.error(e.message)
       @error = e
@@ -54,10 +60,6 @@ module KDoc
       @run_actions = nil
     end
 
-    def unique_key
-      @unique_key ||= KDoc.util.build_unique_key(key, type, namespace)
-    end
-
     def settings(key = nil, **options, &block)
       options ||= {}
 
@@ -135,19 +137,17 @@ module KDoc
       log.o(raw_data_struct)
     end
 
-    # rubocop:disable Metrics/AbcSize
     def debug_header
       log.heading self.class.name
       log.kv 'key', key
       log.kv 'type', type
-      log.kv 'namespace', namespace
+      # log.kv 'namespace', namespace
       log.kv 'error', error
 
       debug_header_keys
 
       log.line
     end
-    # rubocop:enable Metrics/AbcSize
 
     def debug_header_keys
       options&.keys&.reject { |k| k == :namespace }&.each do |key|
@@ -159,6 +159,7 @@ module KDoc
 
     def initialize_attributes(**options)
       @options    = options || {}
+      # Is parent a part of model, or is it part of k_manager::document_taggable
       @parent     = slice_option(:parent)
 
       # Most documents live within a hash, some tabular documents such as CSV will use an []

data/lib/k_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.17
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,13 +111,12 @@ files:
 - k_doc.gemspec
 - lib/k_doc.rb
 - lib/k_doc/container.rb
-- lib/k_doc/data.rb
 - lib/k_doc/decorators/settings_decorator.rb
 - lib/k_doc/decorators/table_decorator.rb
 - lib/k_doc/fake_opinion.rb
+- lib/k_doc/model.rb
 - lib/k_doc/settings.rb
 - lib/k_doc/table.rb
-- lib/k_doc/util.rb
 - lib/k_doc/version.rb
 homepage: http://appydave.com/gems/k-doc
 licenses:

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_document_type
-
-      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }
-
-      keys.join('_')
-    end
-  end
-end