k_doc 0.0.12 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1bb7261302051361f705cc9c726702f02722e7f55c028e07acf8a84b55ee168
-  data.tar.gz: 7d3a27cd2a16cfc2bbc513d29d02aff1faa0d9ca9844a45e86b30bf2d417cdd3
+  metadata.gz: 28959da3b25b7817899193c0b0057e42750783a561e8190de4f6af82be5116c9
+  data.tar.gz: c55996060304324b439d6a02d3a0993279a9f76dee8468802486a9e92cf958e3
 SHA512:
-  metadata.gz: 0b6602d011acb3d1f3763618cd87452a35ea9835c89f86c985fb34100b3c084d40b08e08f04e8c25e20c5034fc10c1b352579c16cbf1febe70ec8d5cb29d09ca
-  data.tar.gz: 3381001de7214affe1298bf398c2e19749fa22d098f39f4c2c24f09a4ed14158e981c8654bfa478ea3d6e5c06ea0f29c832c6987fdeaf63c996b57a19216eb53
+  metadata.gz: e5c7303c8d1d9f0b6b90c1071c46d20852ed7796ba3410e2267f5fc42af55dc9ac7d20ff43d1c9a228f6779b67a1e9da0ecdde0b0fffe42b2b87811571af7d72
+  data.tar.gz: e464b9117c83fdd72fc25a1bb17815ff62cf58a74b6e4f197c070eccf588ecd45e99ca25ff7985b06b1dd889e0fa62c1fd7adffc29c6b3bc2b50870ae13e88eb

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,27 @@
 # 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
+
     attr_reader :error
 
     # Create container for storing data/documents.
@@ -19,35 +31,18 @@ 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] namespace Namespace that the container belongs to
-    # @option opts [String|Symbol] project_key Project that the container belongs to
+    # @option opts [String|Symbol] type Type of the container, defaults to KDoc:: FakeOpinion.new.default_model_type if not set
     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
+      log.kv 'key'  , key   , 15
+      log.kv 'type' , type  , 15
     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 'error', error
+      log.kv 'key'    , key   , 15
+      log.kv 'type'   , type  , 15
+      # log.kv 'namespace', namespace
+      log.kv 'error'  , error , 15
 
       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/table.rb

@@ -55,14 +55,15 @@ module KDoc
         hash[f['name']] = f['default']
       end
 
+      # TODO: clean_symbol should be an option that is turned on or off for the table
       # Override with positional arguments
       args.each_with_index do |arg, i|
-        row[fields[i]['name']] = KUtil.data.clean_symbol(arg)
+        row[fields[i]['name']] = arg # KUtil.data.clean_symbol(arg)
       end
 
       # Override with named args
       named_args.each_key do |key|
-        row[key.to_s] = named_args[key]
+        row[key.to_s] = named_args[key] # KUtil.data.clean_symbol(named_args[key])
       end
 
       @data[@name]['rows'] << row

data/lib/k_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.18
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-05-20 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 == '' }.map { |k| k.to_s.gsub('_', '-') }
-
-      keys.join('-')
-    end
-  end
-end