k_doc 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b82733202ef286cfa4fb0d07f46da4b6b6979361b17174f737e5e8e677fa04
-  data.tar.gz: cadbc6795fc6816aae37fdab6155aedb87b3088674fed43fbce7c1d295a7f20c
+  metadata.gz: a09106429335b14c4ee45ec10c378f620261b22f086e45065fa37a2e797c9246
+  data.tar.gz: d9ceb85d7df7c168579258624328a096cdf664d00d007b4fc71aa2d611d78531
 SHA512:
-  metadata.gz: 4490d6fdbd9e74ad5bafe67107eede6f0585df1a2971fcb11a55ac273f17abab111731ebdd2bc4c7588f19374bc4f5a46b8e2f25e2bd72a5b0f00bec9a9e9d61
-  data.tar.gz: df71d4889f44ec61a235862392bb2dbc5c83ad2f750295c03f5b267df308cb9cd7f6ae53d24180f8343597b4481855586d6519c07089616f9678d36c436d47ec
+  metadata.gz: 41e58349fd4b47312ac209c0d70afd49ee66b5370ab97e4bf5cc4615bd35461f8e3f8fb6849001bf655851fe266a2ea1f0ef997a1ac8b292a56fa13c2397dc65
+  data.tar.gz: 78ca5c98f0f1d25a7d5148dd28dfb477cedad276f44a49177bd9b8e5e4508daa1138f995bfef49ab337c4d67f9674b1130cc9e8c381b075cef8b20fd1b14dc49

data/lib/k_doc.rb

@@ -11,7 +11,7 @@ require 'k_log/log_helper'
 require 'k_log/log_util'
 
 require 'k_doc/version'
-require 'k_doc/data'
+require 'k_doc/logging'
 require 'k_doc/document'
 require 'k_doc/fake_opinion'
 require 'k_doc/settings'
@@ -37,18 +37,6 @@ module KDoc
 
   KDoc.opinion = KDoc::FakeOpinion.new
   KDoc.util = KDoc::Util.new
-
-  # Need to move this into a KLog factory
-  def self.configure_logger
-    logger = Logger.new($stdout)
-    logger.level = Logger::DEBUG
-    logger.formatter = KLog::LogFormatter.new
-    KLog::LogUtil.new(logger)
-  end
-
-  # KDoc.log = configure_logger
 end
 
-L = KDoc.configure_logger
-
 puts "KDoc::Version: #{KDoc::VERSION}" if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'

data/lib/k_doc/document.rb

@@ -5,6 +5,8 @@ module KDoc
   #
   # Made up of 0 or more setting groups and table groups
   class Document
+    include KDoc::Logging
+
     attr_reader :key
     attr_reader :type
     attr_reader :namespace
@@ -39,12 +41,12 @@ module KDoc
     #   @error = e
     #   raise
     rescue StandardError => e
-      L.error('Standard error in document')
+      log.error('Standard error in document')
       puts "key #{unique_key}"
       # puts "file #{KUtil.data.console_file_hyperlink(resource.file, resource.file)}"
-      L.error(e.message)
+      log.error(e.message)
       @error = e
-      # L.exception exception2
+      # log.exception exception2
       raise
     ensure
       @run_actions = nil
@@ -132,24 +134,26 @@ module KDoc
 
       # tp dsls.values, :k_key, :k_type, :state, :save_at, :last_at, :data, :last_data, :source, { :file => { :width => 150 } }
       # puts JSON.pretty_generate(data)
-      L.o(raw_data_struct)
+      log.o(raw_data_struct)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def debug_header
-      L.heading self.class.name
-      L.kv 'key', key
-      L.kv 'type', type
-      L.kv 'namespace', namespace
-      L.kv 'error', error
+      log.heading self.class.name
+      log.kv 'key', key
+      log.kv 'type', type
+      log.kv 'namespace', namespace
+      log.kv 'error', error
 
       debug_header_keys
 
-      L.line
+      log.line
     end
+    # rubocop:enable Metrics/AbcSize
 
     def debug_header_keys
       options&.keys&.reject { |k| k == :namespace }&.each do |key|
-        L.kv key, options[key]
+        log.kv key, options[key]
       end
     end
 

data/lib/k_doc/logging.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'k_log'
+module KDoc
+  module Logging
+    def log
+      @log ||= KLog.logger
+    end
+  end
+end

data/lib/k_doc/settings.rb

@@ -6,6 +6,8 @@ module KDoc
   # Builds up key/value settings from the block
   # and applies them to a key coded node on the hash
   class Settings
+    include Logging
+
     attr_reader :parent
     attr_reader :key
 
@@ -73,14 +75,14 @@ module KDoc
     # object.my_name
     # object.my_name('david')
     def add_getter_or_param_method(name)
-      # L.progress(1, 'add_getter_or_param_method')
+      # log.progress(1, 'add_getter_or_param_method')
       self.class.class_eval do
-        # L.progress(2, 'add_getter_or_param_method')
+        # log.progress(2, 'add_getter_or_param_method')
         name = name.to_s.gsub(/=$/, '')
-        # L.progress(3, 'add_getter_or_param_method')
+        # log.progress(3, 'add_getter_or_param_method')
         define_method(name) do |*args|
-          # L.progress(4, 'add_getter_or_param_method')
-          # L.kv 'add_getter_or_param_method', name
+          # log.progress(4, 'add_getter_or_param_method')
+          # log.kv 'add_getter_or_param_method', name
           raise KDoc::Error, 'Multiple setting values is not supported' if args.length > 1
 
           if args.length.zero?
@@ -95,15 +97,15 @@ module KDoc
     # Handles Setter method
     # object.my_name = 'david'
     def add_setter_method(name)
-      # L.progress(1, 'add_setter_method')
+      # log.progress(1, 'add_setter_method')
       self.class.class_eval do
-        # L.progress(2, 'add_setter_method')
+        # log.progress(2, 'add_setter_method')
         name = name.to_s.gsub(/=$/, '')
-        # L.progress(3, 'add_setter_method')
-        # L.kv 'add_setter_method', name
+        # log.progress(3, 'add_setter_method')
+        # log.kv 'add_setter_method', name
         define_method("#{name}=") do |value|
-          # L.progress(4, 'add_setter_method')
-          # L.kv 'value', value
+          # log.progress(4, 'add_setter_method')
+          # log.kv 'value', value
           my_data[name.to_s] = value
         end
       end

data/lib/k_doc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - David Cruwys
@@ -67,9 +67,9 @@ files:
 - hooks/update-version
 - k_doc.gemspec
 - lib/k_doc.rb
-- lib/k_doc/data.rb
 - lib/k_doc/document.rb
 - lib/k_doc/fake_opinion.rb
+- lib/k_doc/logging.rb
 - lib/k_doc/settings.rb
 - lib/k_doc/table.rb
 - lib/k_doc/util.rb

data/lib/k_doc/data.rb

@@ -1,258 +0,0 @@
-# frozen_string_literal: true
-
-# module KDoc
-#   # TODO
-#   # Missing tests around errors
-#   # Make sure that error writes to resource or document appropriately
-#   # Puts errors onto a project manager pipeline so that they can be be printed out after the documents
-#   #
-#   # General purpose document DSL
-#   #
-#   # Made up of 0 or more setting groups and table groups
-#   class Data
-#     extend Forwardable
-
-#     attr_reader :key
-#     attr_reader :type
-#     attr_reader :namespace
-#     attr_reader :options
-#     attr_reader :error
-
-#     # State of document
-#     # - :initializing
-#     # - :initialized
-#     # - :loading
-#     # - :loaded
-#     # - :executing
-#     # - :executed
-#     attr_reader :state
-
-#     # Shortcut to formatter
-#     attr_reader :f
-
-#     attr_accessor :resource
-
-#     def_delegator :resource, :project
-
-#     def state=(state)
-#       @state = state
-#       # if [:initialized, :loaded, :executed].include?(state) &&
-#       #   (project.nil? || project.name == 'k_dsl')
-#       #   # pname = project.nil? ? '' : "#{project&.name} "
-#       #   L.kv "#{unique_key} - state", state
-#       # end
-#       @state
-#     end
-
-#     # Create document
-#     #
-#     # @param [String|Symbol] name Name of the document
-#     # @param args[0] Type of the document, defaults to KDsl.config.default_document_type if not set
-#     # @param default: Default value (using named params), as above
-#     def initialize(key = SecureRandom.alphanumeric(8), *args, **options, &block)
-#       @key = key
-#       @type = args.length.positive? ? args[0] || KDsl.config.default_document_type : KDsl.config.default_document_type
-
-#       @options = options || {}
-#       @namespace = options[:namespace] || ''
-#       default_data = options[:default_data] || {}
-
-#       @namespace = @namespace.to_s
-#       @error = nil
-
-#       self.state = :initializing
-
-#       # Most documents live within a hash, some tabular documents such as
-#       # CSV will use an []
-#       set_data(default_data)
-
-#       @f = KDsl::Util.format
-
-#       @block = block if block_given?
-
-#       self.state = :initialized
-#     end
-
-#     def execute_block(run_actions: nil)
-#       return if @block.nil?
-
-#       # The DSL actions method will only run on run_actions: true
-#       @run_actions = run_actions
-
-#       # if unique_key == 'template_options_entity'
-#       #   L.kv '2:CLASS_ID', object_id
-#       # end
-#       if initialized?
-#         self.state = :loading
-#         instance_eval(&@block)
-#         self.state = :loaded
-#       end
-#       # if unique_key == 'template_options_entity'
-#       #   L.kv '3:CLASS_ID', resource_document.object_id
-#       # end
-
-#       if loaded? && run_actions && respond_to?(:on_action)
-#         @state = :executed
-#         on_action
-#       end
-#     rescue KDsl::Error => e
-#       L.error('KDsl::Error in document')
-#       L.kv 'key', unique_key
-#       L.kv 'file', KDsl::Util.data.console_file_hyperlink(resource.file, resource.file)
-#       L.error(e.message)
-#       @error = e
-#       # L.heading "Invalid code block in document_dsl during registration: #{k_key}"
-#       # L.exception exception
-#       raise
-#     rescue StandardError => e
-#       L.error('Standard error in document')
-#       L.kv 'key', unique_key
-#       L.kv 'file', KDsl::Util.data.console_file_hyperlink(resource.file, resource.file)
-#       L.error(e.message)
-#       @error = e
-#       # L.exception exception2
-#       raise
-#     ensure
-#       @run_actions = nil
-#       return
-#     end
-
-#     def initialized?
-#       @state == :initialized
-#     end
-
-#     def loaded?
-#       @state == :loaded
-#     end
-
-#     def executed?
-#       @state == :executed
-#     end
-
-#     def unique_key
-#       @unique_key ||= KDsl::Util.dsl.build_unique_key(key, type, namespace)
-#     end
-
-#     def settings(key = nil, **options, &block)
-#       options ||= {}
-
-#       opts = {}.merge(@options) # Document Options
-#                .merge(options)  # Settings Options
-
-#       settings = settings_instance(@data, key, parent: self, &block)
-#       settings.run_decorators(opts)
-#       settings
-#     end
-
-#     def table(key = :table, &block)
-#       # NEED to add support for run_decorators I think
-#       table_instance(@data, key, parent: self, &block)
-#     end
-#     alias rows table
-
-#     # Sweet add-on would be builders
-#     # def builder(key, &block)
-#     #   # example
-#     #   KDsl::Builder::Shotstack.new(@data, key, &block)
-#     # end
-
-#     def set_data(data)
-#       @data = data
-#     end
-
-#     def data
-#       @data.clone
-#     end
-
-#     def data_struct
-#       KDsl::Util.data.to_struct(data)
-#     end
-#     alias d data_struct
-
-#     def raw_data_struct
-#       KDsl::Util.data.to_struct(raw_data)
-#     end
-
-#     def get_node_type(node_name)
-#       node_name = KDsl::Util.data.clean_symbol(node_name)
-#       node_data = @data[node_name]
-
-#       raise KDsl::Error, "Node not found: #{node_name}" if node_data.nil?
-
-#       if node_data.keys.length == 2 && (node_data.key?('fields') && node_data.key?('rows'))
-#         :table
-#       else
-#         :settings
-#       end
-#     end
-
-#     # Removes any meta data eg. "fields" from a table and just returns the raw data
-#     def raw_data
-#       # REFACT, what if this is CSV, meaning it is just an array?
-#       #         add specs
-#       result = data
-
-#       result.each_key do |key|
-#         # ANTI: get_node_type uses @data while we are using @data.clone here
-#         data[key] = if get_node_type(key) == :table
-#                       result[key].delete('fields')
-#                     else
-#                       result[key]
-#                     end
-#       end
-
-#       data
-#     end
-
-#     # Move this out to the logger function when it has been refactor
-#     def debug(include_header = false)
-#       debug_header if include_header
-
-#       # tp dsls.values, :k_key, :k_type, :state, :save_at, :last_at, :data, :last_data, :source, { :file => { :width => 150 } }
-#       # puts JSON.pretty_generate(data)
-#       L.o(raw_data_struct)
-#     end
-
-#     def debug_header
-#       L.heading self.class.name
-#       L.kv 'key', key
-#       L.kv 'type', type
-#       L.kv 'namespace', namespace
-#       L.kv 'error', error
-#       L.kv 'state', state
-#       L.kv 'respond_to?(:on_import)', respond_to?(:on_import)
-#       L.kv 'respond_to?(:david)', respond_to?(:david)
-#       david if respond_to?(:david)
-#       # L.kv 'INITALIZED', resource_document.initialized?
-#       # L.kv 'EXECUTED', resource_document.executed?
-
-#       options&.keys.reject { |k| k == :namespace }&.each do |key|
-#         L.kv key, options[key]
-#       end
-
-#       L.line
-#     end
-
-#     # Helpers that often get called by extensions
-
-#     def project
-#       project ||= resource&.project
-#     end
-
-#     # Warning message
-#     def warn(message)
-#       L.warn message
-#       nil
-#     end
-
-#     private
-
-#     def settings_instance(data, key, **options, &block)
-#       KDsl.config.settings_class.new(data, key, **options, &block)
-#     end
-
-#     def table_instance(data, key, **options, &block)
-#       KDsl.config.table_class.new(data, key, **options, &block)
-#     end
-#   end
-# end