k_doc 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64615008b76feb26a84e9dd808654495cf3f26bf42f6941b00eaca9013081a76
-  data.tar.gz: e69ccfb764c6dd9df4ee1fe78df56f717726f733184839020d3df968c34fde63
+  metadata.gz: f5d1fec58551c4d2c72de3c9629c0b90847352c38b2d491a021dfce0d72afac6
+  data.tar.gz: 7f38b815def0fdcabd801daf8e9e569c36213f306f28781d8956f8bfa12b0be7
 SHA512:
-  metadata.gz: 94d4cd31dddad2f142fa418c24025c866124722e8f93ee3133d1d7c68893640954c7203e5bd5a502eb75f9650c444d7103945af6fa901ece63450a0537b130d3
-  data.tar.gz: f1a6e045702b3e9c94146ae413f573fc281472eaf5927e9b27a819445cff112b2a688863c7f0bf2d2d4e996e703dd3f4f7721c7766ecd621feb4971b24cfddba
+  metadata.gz: d2ec5f47f7f5dd3cf295bb430615768149724233451b0aaa09aaecca56752292b167948714ea4f146f8050488a7019a2b90ab7d824c6e540dcfc0de0831af5bb
+  data.tar.gz: bc816e70fc04faaf6109e4abe57528b48df868b48bee93eecbc152aa782d22c44a98304eef09f8cbd9bbbbd4ec6ab7dc7ab50b16f73f98b915dae24326928c40

data/lib/k_doc.rb

@@ -15,7 +15,6 @@ 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,6 +24,7 @@ module KDoc
   class Error < StandardError; end
 
   class << self
+    # Is this needed
     # Factory method to create a new model
     def model(key = nil, **options, &block)
       model = KDoc::Model.new(key, **options, &block)
@@ -33,12 +33,10 @@ module KDoc
     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

@@ -6,15 +6,22 @@ module KDoc
   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
+    # Name of the document (required)
+    #
+    # Examples: user, account, country
     attr_reader :key
 
-    # NOTE: This should not be using an opinion in this project
+    # 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_writer :data
+
     # Move this up to k_manager
     # attr_reader :namespace
     # attr_reader :project_key
@@ -32,30 +39,15 @@ 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_model_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) || {}
+      @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/model.rb

@@ -50,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
@@ -60,11 +60,6 @@ module KDoc
       @run_actions = nil
     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 ||= {}
 
@@ -164,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.16'
+  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.16
+  version: 0.0.17
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,7 +117,6 @@ files:
 - 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_model_type
-
-      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }.map { |k| k.to_s.gsub('_', '-') }
-
-      keys.join('-')
-    end
-  end
-end