k_doc 0.0.10 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc18e7f82a4c59368f6870a693781586d274f21b8a8df64bd568aa6d0c43262
-  data.tar.gz: d2328c38cf349291486d22d46572698817df1e00ce64c628eba90d7451e97ca3
+  metadata.gz: 64615008b76feb26a84e9dd808654495cf3f26bf42f6941b00eaca9013081a76
+  data.tar.gz: e69ccfb764c6dd9df4ee1fe78df56f717726f733184839020d3df968c34fde63
 SHA512:
-  metadata.gz: 0c844d63fc520e5dab619f01214a93df2306d60cc6877b923cda7a0963269bac0e6ba69b28b6f3d26fec4418e821d61fd92e84f58d0555b7f7ee9dd46ad5539b
-  data.tar.gz: 81f55829133fc0f3a2a581da5ec51d370bdc7050fdef00ef2aed7965cb43119ccd182413298894b6b40302848d0fc84eb0e77381676c820a70e2bb8ddd2adcbf
+  metadata.gz: 94d4cd31dddad2f142fa418c24025c866124722e8f93ee3133d1d7c68893640954c7203e5bd5a502eb75f9650c444d7103945af6fa901ece63450a0537b130d3
+  data.tar.gz: f1a6e045702b3e9c94146ae413f573fc281472eaf5927e9b27a819445cff112b2a688863c7f0bf2d2d4e996e703dd3f4f7721c7766ecd621feb4971b24cfddba

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.
@@ -17,27 +25,39 @@ module KDoc
     # Any container can be uniquely identified via it's
     # key, type, namespace and project_key attributes
     #
-    # @param [String|Symbol] name Name of the container
-    # @param [String|Symbol] type Type of the container, defaults to KDoc:: FakeOpinion.new.default_document_type if not set
-    # @param [String|Symbol] namespace Namespace that the container belongs to
-    # @param [String|Symbol] project_key Project that the container belongs to
-    def initialize(key: nil, type: nil, namespace: nil, project_key: nil)
-      @key = key || SecureRandom.alphanumeric(8)
-      @type = type || KDoc.opinion.default_document_type
-      @namespace = namespace || ''
-      @project_key = project_key || ''
-    end
+    # @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_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(4)
+      @type = opts[:type] || '' # KDoc.opinion.default_model_type
+      # @namespace = opts[:namespace] || ''
+      # @project_key = opts[:project_key] || ''
 
-    def unique_key
-      @unique_key ||= KDoc.util.build_unique_key(key, type, namespace, 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) || {}
+      @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 'namespace', namespace
+      # log.kv 'project_key', namespace
+      # log.kv 'error', error
+    end
+
+    attr_writer :data
+
+    def data
+      @data.clone
     end
   end
 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?
 
@@ -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 ||= {}
@@ -82,14 +89,6 @@ module KDoc
     #   KDoc::Builder::Shotstack.new(@data, key, &block)
     # end
 
-    # def set_data(data)
-    #   @data = data
-    # end
-
-    def data
-      @data.clone
-    end
-
     def data_struct
       KUtil.data.to_open_struct(data)
     end
@@ -143,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/util.rb

@@ -10,11 +10,11 @@ module KDoc
     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
+      type ||= KDoc.opinion.default_model_type
 
-      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }
+      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }.map { |k| k.to_s.gsub('_', '-') }
 
-      keys.join('_')
+      keys.join('-')
     end
   end
 end

data/lib/k_doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.16
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-21 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