k_doc 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c5aa8cc7a7c428e9e15b9a705b9783cfb977b7d49706d3faf95ef17137b2042
-  data.tar.gz: 794988e7fb3451fc307659e6b790cff4b5903bdd708d8172886eaa906bbed716
+  metadata.gz: 6b4d2d8600ef139ecfe4ebc33df2a6fec04f28d014b92dde485bd03c3f50fc9a
+  data.tar.gz: 6395ffd44207e6d247ca612a5af8c610856185e1d6dc8d4034cfb9f4be5104e7
 SHA512:
-  metadata.gz: 9f3ba7e70149ad585bdd2c8c615a6d21d5dca3b0004c1b9a50b974f2eeeb36637fab456fa9cdc15cf416122864e55ef5f871d2eafaff6f2b1f38ec7b7a606ea7
-  data.tar.gz: 6cd090ae8c0d409e76d830b9370ab292a8678e434c7e13ef49ab24e7aea500a68fab99ac72fac132dd962cf6b1b4a0eb809e8fca79f5e6506f21fb2656842107
+  metadata.gz: 6698d8bd459a9bc19ed6f3882258851a7779bf4be4eab13fed6cfd19870f2311b5f60ec618b1ddd6619e154c16da15f21f80bb4b4a5527d7e42d4ac71c254a02
+  data.tar.gz: d5bb18b0271b810a1f795537d6a9ae430dc8f7d82f940be5cfbb6c1dc28b7916c0d7f279ccd8f42be4d35f53a2822d6e43b2280dfc1e7fe8a2f2fe35b8d0f47c

data/lib/k_doc.rb

@@ -10,7 +10,8 @@ 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'
@@ -24,11 +25,11 @@ 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
+    # 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

data/lib/k_doc/container.rb

@@ -1,15 +1,23 @@
 # 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
 
+    # Seems like there is way too much data here
+    # Firstly it should probably be in an interface
+    # Secondly some of this (namespace, project_key, error) belongs in k_manager
+    # So container would be better off just being key, type, data
     attr_reader :key
+
+    # NOTE: This should not be using an opinion in this project
     attr_reader :type
-    attr_reader :namespace
-    attr_reader :project_key
+
+    # Move this up to k_manager
+    # attr_reader :namespace
+    # attr_reader :project_key
     attr_reader :error
 
     # Create container for storing data/documents.
@@ -24,9 +32,9 @@ module KDoc
     # @option opts [String|Symbol] project_key Project that the container belongs to
     def initialize(**opts)
       @key = opts[:key] || SecureRandom.alphanumeric(4)
-      @type = opts[:type] || KDoc.opinion.default_document_type
-      @namespace = opts[:namespace] || ''
-      @project_key = opts[:project_key] || ''
+      @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 []
@@ -34,16 +42,16 @@ module KDoc
       @data = opts[:data] || {}
     end
 
-    def unique_key
-      @unique_key ||= KDoc.util.build_unique_key(key, type, namespace, project_key)
-    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 'namespace', namespace
+      # log.kv 'project_key', namespace
+      # log.kv 'error', error
     end
 
     attr_writer :data

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
@@ -26,6 +31,7 @@ module KDoc
       @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?
 
@@ -54,9 +60,10 @@ module KDoc
       @run_actions = nil
     end
 
-    def unique_key
-      @unique_key ||= KDoc.util.build_unique_key(key, type, namespace)
-    end
+    # Move this up to k_manager
+    # def unique_key
+    #   @unique_key ||= KDoc.util.build_unique_key(key, type, namespace)
+    # end
 
     def settings(key = nil, **options, &block)
       options ||= {}
@@ -135,19 +142,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|

data/lib/k_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,10 +111,10 @@ 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