k_doc 0.0.8 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f42e0aaa27cf50c5ee0fa56385d3cc492f7b8b01cb7abe9877300a785fa6313
-  data.tar.gz: 27c280e4d65360589f0c52a95fc4f43c1dfc88ab60e20685502f9b18a7ab5de0
+  metadata.gz: 6b4d2d8600ef139ecfe4ebc33df2a6fec04f28d014b92dde485bd03c3f50fc9a
+  data.tar.gz: 6395ffd44207e6d247ca612a5af8c610856185e1d6dc8d4034cfb9f4be5104e7
 SHA512:
-  metadata.gz: 7e40236d4c57ff7cdf5dfa782f2380c53cf8744b84253f18ba49c9a486be97b75f9d28396cfb07649ec7b8fc6d7b0f30967ceee65039d05b1c491ca97e552aca
-  data.tar.gz: 6068509f1ec674f7a0d71a7ca7e919ee302d5b4805507ebf89efab4f92ede36074de4a5ce9749c266c56020fe86199618482818839219f66ec1281a0471b688b
+  metadata.gz: 6698d8bd459a9bc19ed6f3882258851a7779bf4be4eab13fed6cfd19870f2311b5f60ec618b1ddd6619e154c16da15f21f80bb4b4a5527d7e42d4ac71c254a02
+  data.tar.gz: d5bb18b0271b810a1f795537d6a9ae430dc8f7d82f940be5cfbb6c1dc28b7916c0d7f279ccd8f42be4d35f53a2822d6e43b2280dfc1e7fe8a2f2fe35b8d0f47c

data/CODE_OF_CONDUCT.md

@@ -11,7 +11,7 @@ orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
+Examples of behaviour that contributes to creating a positive environment
 include:
 
 - Using welcoming and inclusive language
@@ -20,7 +20,7 @@ include:
 - Focusing on what is best for the community
 - Showing empathy towards other community members
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behaviour by participants include:
 
 - The use of sexualized language or imagery and unwelcome sexual attention or
   advances
@@ -34,13 +34,13 @@ Examples of unacceptable behavior by participants include:
 ## Our Responsibilities
 
 Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
 that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
+permanently any contributor for other behaviours that they deem inappropriate,
 threatening, offensive, or harmful.
 
 ## Scope
@@ -54,7 +54,7 @@ further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
 reported by contacting the project team at david.cruwys@bugcrowd.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is

data/README.md

@@ -68,10 +68,8 @@ Aaa::Bbb::Program.execute()
 To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ```bash
-gem build
-gem push rspec-usecases-?.?.??.gem
-# or push the latest gem
-ls *.gem | sort -r | head -1 | xargs gem push
+rake publish
+rake clean
 ```
 
 ## Contributing

data/STORIES.md

@@ -10,22 +10,27 @@ As a Developer, I need flexible data structures defined in DSL, so can model ric
 
 As a Developer, I need flexible data structures defined in DSL, so can model rich documents
 
-### Tasks next on list
+## Stories and tasks
 
-Setup RubyGems and RubyDoc
+### Stories - completed
 
-- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_doc)
-- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/k_doc/master)
+As a Domain Modeler, I can define flexible tabular structures, so I can access dynamic tabular arrays
 
-Setup GitHub Action (test and lint)
+- add DSL for table with columns and rows
+- add support for data decorators
 
-- Setup Rspec action
-- Setup RuboCop action
+As a Domain Modeler, I can define flexible key/value stores, so I can access settings data
 
-## Stories and tasks
+- add DSL for key/value settings
+- add support for data decorators
 
 ### Tasks - completed
 
+Setup RubyGems and RubyDoc
+
+- Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_doc)
+- Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/k_doc/master)
+
 Setup project management, requirement and SCRUM documents
 
 - Setup readme file
@@ -33,6 +38,11 @@ Setup project management, requirement and SCRUM documents
 - Setup a project backlog
 - Setup an examples/usage document
 
+Setup GitHub Action (test and lint)
+
+- Setup Rspec action
+- Setup RuboCop action
+
 Setup new Ruby GEM
 
 - Build out a standard GEM structure

data/ToDo.md

@@ -0,0 +1,91 @@
+# K Doc
+
+> KDoc provides a document in the form a DSL that contains flexible key/value and tabular data
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_doc'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install k_doc
+```
+
+## Stories
+
+### Main Story
+
+As a Developer, I need flexible data structures defined in DSL, so can model rich documents
+
+See all [stories](./STORIES.md)
+
+## Usage
+
+See all [usage examples](./USAGE.md)
+
+### Basic Example
+
+#### Basic example
+
+Description for a basic example to be featured in the main README.MD file
+
+```ruby
+class SomeRuby; end
+```
+
+## Development
+
+Checkout the repo
+
+```bash
+git clone klueless-io/k_doc
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+```bash
+bin/console
+
+Aaa::Bbb::Program.execute()
+# => ""
+```
+
+`k_doc` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
+
+To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+```bash
+gem build
+gem push rspec-usecases-?.?.??.gem
+# or push the latest gem
+ls *.gem | sort -r | head -1 | xargs gem push
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/k_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the K Doc project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/k_doc/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

data/k_doc.gemspec

@@ -38,7 +38,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_doc/extconf.rb']
 
+  spec.add_dependency 'activesupport'         , '~> 6'
+  spec.add_dependency 'k_decor'               , '~> 0.0.0'
   spec.add_dependency 'k_log'                 , '~> 0.0.0'
+  spec.add_dependency 'k_type'                , '~> 0.0.0'
   spec.add_dependency 'k_util'                , '~> 0.0.0'
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

data/lib/k_doc.rb

@@ -2,31 +2,34 @@
 
 require 'securerandom'
 
-require 'logger'
 require 'table_print'
 require 'k_log'
+require 'k_type'
 require 'k_util'
-require 'k_log/log_formatter'
-require 'k_log/log_helper'
-require 'k_log/log_util'
+require 'k_decor'
 
 require 'k_doc/version'
-require 'k_doc/document'
+require 'k_doc/container'
+# 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'
+
 module KDoc
   # raise KDoc::Error, 'Sample message'
   class Error < StandardError; end
 
   class << self
-    # Factory method to create a new document
-    def doc(key = nil, **options, &block)
-      doc = KDoc::Document.new(key, **options, &block)
-      doc.execute_block
-      doc
+    # 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
@@ -42,5 +45,5 @@ if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
   namespace = 'KDoc::Version'
   file_path = $LOADED_FEATURES.find { |f| f.include?('k_doc/version') }
   version   = KDoc::VERSION.ljust(9)
-  puts "#{namespace.ljust(40)} : #{version.ljust(9)} : #{file_path}"
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
 end

data/lib/k_doc/container.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module KDoc
+  # 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
+
+    # Move this up to k_manager
+    # attr_reader :namespace
+    # attr_reader :project_key
+    attr_reader :error
+
+    # Create container for storing data/documents.
+    #
+    # Any container can be uniquely identified via it's
+    # key, type, namespace and project_key attributes
+    #
+    # @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
+    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] || ''
+
+      # 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
+    end
+
+    attr_writer :data
+
+    def data
+      @data.clone
+    end
+  end
+end

data/lib/k_doc/decorators/settings_decorator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This could move into KDecor
+module KDoc
+  module Decorators
+    class SettingsDecorator < KDecor::BaseDecorator
+      def initialize
+        super(KDoc::Settings)
+      end
+
+      # def update(target, behaviour)
+      #   update_settings(target, target.internal_data) if %i[all default].include?(behaviour)
+
+      #   target
+      # end
+
+      # # What responsibility will this SettingsDecorator take on?
+      # def update(target, **_opts)
+      #   def update_settings(_target, _settings)
+      #   log.warn('Override this method in your descendant implementation')
+      # end
+    end
+  end
+end

data/lib/k_doc/decorators/table_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module KDoc
+  module Decorators
+    class TableDecorator < KDecor::BaseDecorator
+      def initialize
+        super(KDoc::Table)
+
+        self.implemented_behaviours = %i[update_fields update_rows]
+      end
+
+      def update(target, **opts)
+        behaviour = opts[:behaviour]
+
+        update_fields(target, target.get_fields)  if %i[all update_fields].include?(behaviour)
+        update_rows(target, target.get_rows)      if %i[all update_rows].include?(behaviour)
+
+        target
+      end
+
+      # What responsibility will this TableDecorator take on?
+      # Update fields/columns, or/and
+      def update_fields(_target, _fields)
+        raise KType::Error, 'Update fields not implement, you need to implement this method and '
+      end
+
+      # Update row values/structure
+      def update_rows(_target, _rows); end
+    end
+  end
+end

data/lib/k_doc/fake_opinion.rb

@@ -10,7 +10,7 @@ module KDoc
     attr_accessor :default_settings_key
     attr_accessor :default_table_key
 
-    attr_accessor :document_class
+    # attr_accessor :document_class
     attr_accessor :settings_class
     attr_accessor :table_class
 
@@ -19,7 +19,7 @@ module KDoc
       @default_settings_key = :settings
       @default_table_key = :table
 
-      @document_class = KDoc::Document
+      # @document_class = KDoc::Document
       @table_class = KDoc::Table
       @settings_class = KDoc::Settings
     end

data/lib/k_doc/{document.rb → model.rb}

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 module KDoc
-  # General purpose document DSL
+  # Model is a DSL for modeling general purpose data objects
   #
-  # Made up of 0 or more setting groups and table groups
-  class Document
+  # 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
@@ -12,23 +17,21 @@ module KDoc
     # include KType::NamedFolder
     # include KType::LayeredFolder
 
-    attr_reader :key
-    attr_reader :type
-    attr_reader :namespace
     attr_reader :options
-    attr_reader :error
 
     # 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 default: Default value (using named params), as above
-    def initialize(key = SecureRandom.alphanumeric(8), **options, &block)
-      initialize_attributes(key, **options)
+    def initialize(key = nil, **options, &block)
+      super(key: key, type: options[: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?
 
@@ -57,14 +60,15 @@ 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 ||= {}
 
-      opts = {}.merge(@options) # Document Options
+      opts = {}.merge(@options) # Data Options
                .merge(options)  # Settings Options
                .merge(parent: self)
 
@@ -85,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
@@ -116,6 +112,7 @@ module KDoc
     end
 
     # Removes any meta data eg. "fields" from a table and just returns the raw data
+    # REFACTOR: IT MAY BE BEST TO MOVE raw_data into each of the node_types
     def raw_data
       # REFACT, what if this is CSV, meaning it is just an array?
       #         add specs
@@ -145,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|
@@ -167,18 +162,12 @@ module KDoc
 
     private
 
-    def initialize_attributes(key = nil, **options)
-      @key = key
-
+    def initialize_attributes(**options)
       @options    = options || {}
-      @type       = slice_option(:type) || KDoc.opinion.default_document_type
-      @namespace  = slice_option(:namespace) || ''
       @parent     = slice_option(:parent)
 
       # Most documents live within a hash, some tabular documents such as CSV will use an []
       @data       = slice_option(:default_data) || {}
-
-      @error = nil
     end
 
     def settings_instance(data, key, **options, &block)

data/lib/k_doc/settings.rb

@@ -7,9 +7,11 @@ module KDoc
   # and applies them to a key coded node on the hash
   class Settings
     include KLog::Logging
+    # include KDoc::Decorators
 
     attr_reader :parent
     attr_reader :key
+    attr_reader :decorators
 
     alias kp parent
 
@@ -19,6 +21,9 @@ module KDoc
       # Need a way to find out the line number for errors and report it correctly
       begin
         instance_eval(&block) if block_given?
+
+        run_decorators
+
         # rubocop:disable Style/RescueStandardError
       rescue => e
         # rubocop:enable Style/RescueStandardError
@@ -28,27 +33,19 @@ module KDoc
       end
     end
 
-    def my_data
+    # Return these settings which are attached to a data container using :key
+    # internal_data is a bad name, but it is unlikely to interfere with any setting names
+    # Maybe I rename this to raw_data
+    def internal_data
       @data[@key]
     end
 
-    # def run_decorators(opts)
-    #   decorators = KDoc::Decorator.decorate.decorators(opts[:decorators])
-
-    #   return if decorators.empty?
-
-    #   decorators.each do |decorator|
-    #     decorator.send(:update, my_data) if decorator.respond_to?(:update)
-    #     decorator.send(:call, my_data) if decorator.respond_to?(:call)
-    #   end
-    # end
-
     def respond_to_missing?(name, *_args, &_block)
       # puts 'respond_to_missing?'
       # puts "respond_to_missing: #{name}"
       n = name.to_s
       n = n[0..-2] if n.end_with?('=')
-      my_data.key?(n.to_s) || (!@parent.nil? && @parent.respond_to?(name, true)) || super
+      internal_data.key?(n.to_s) || (!@parent.nil? && @parent.respond_to?(name, true)) || super
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -106,26 +103,39 @@ module KDoc
         define_method("#{name}=") do |value|
           # log.progress(4, 'add_setter_method')
           # log.kv 'value', value
-          my_data[name.to_s] = value
+          internal_data[name.to_s] = value
         end
       end
     end
 
     def get_value(name)
-      my_data[name.to_s]
+      internal_data[name.to_s]
     end
 
     def debug
-      puts JSON.pretty_generate(my_data)
+      puts JSON.pretty_generate(internal_data)
     end
 
     private
 
+    # This method can move into decorator helpers
+    def run_decorators
+      decorators.each { |decorator| decorator.decorate(self, :settings) }
+    end
+
     def initialize_attributes(data, key = nil, **options)
       @data = data
       @key = (key || FakeOpinion.new.default_settings_key).to_s
 
-      @parent = options[:parent] if !options.nil? && options.key?(:parent)
+      @parent = options[:parent] if options.key?(:parent)
+
+      decorator_list = options[:decorators].nil? ? [] : options[:decorators]
+
+      # This code needs to work differently, it needs to support the 3 different types
+      # Move the query into helpers
+      @decorators = decorator_list
+                    .map(&:new)
+                    .select { |decorator| decorator.compatible?(self) }
 
       @data[@key] = {}
     end

data/lib/k_doc/table.rb

@@ -3,16 +3,33 @@
 module KDoc
   # Build rows (aka DataTable) with field definitions and rows of data
   class Table
+    include KLog::Logging
+
     attr_reader :parent
     attr_reader :name
+    attr_reader :decorators
 
     def initialize(data, name = nil, **options, &block)
       initialize_attributes(data, name, **options)
 
+      @has_executed_field_decorators = false
+      @has_executed_row_decorators = false
+
       instance_eval(&block) if block_given?
+
+      run_decorators(:update_rows)
     end
 
-    def fields(field_definitions)
+    # Pass fields in using the following format
+    #   fields :name, f(:type, :string), :db_type
+    #
+    # The older format of an array is supported via a splat conversion
+    def fields(*field_definitions)
+      if field_definitions.length == 1 && field_definitions[0].is_a?(Array)
+        log.warn('avoid supplying field definitions with array. *Splat fields is the preferred technique.')
+        field_definitions = *field_definitions[0]
+      end
+
       fields = @data[@name]['fields']
 
       field_definitions.each do |fd|
@@ -22,15 +39,18 @@ module KDoc
                     fd
                   end
       end
+
+      run_decorators(:update_fields)
     end
 
     # rubocop:disable Metrics/AbcSize
     def row(*args, **named_args)
       fields = @data[@name]['fields']
 
-      raise "To many values for row, argument #{i}" if args.length > fields.length
+      raise KType::Error, "To many values for row, argument #{args.length}" if args.length > fields.length
 
       # Apply column names with defaults
+
       row = fields.each_with_object({}) do |f, hash|
         hash[f['name']] = f['default']
       end
@@ -60,6 +80,10 @@ module KDoc
     end
     # rubocop:enable Naming/AccessorMethodName
 
+    def internal_data
+      @data[@name]
+    end
+
     def find_row(key, value)
       @data[@name]['rows'].find { |r| r[key] == value }
     end
@@ -91,16 +115,45 @@ module KDoc
     end
     alias f field
 
+    def debug
+      log.o(KUtil.data.to_open_struct(internal_data))
+    end
+
     private
 
+    # This method can move into decorator helpers
+    # Run decorators a maximum of once for each behaviour
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def run_decorators(behaviour)
+      return if behaviour == :update_fields && @has_executed_field_decorators
+      return if behaviour == :update_rows && @has_executed_row_decorators
+
+      @has_executed_field_decorators = true if behaviour == :update_fields
+
+      @has_executed_rows_decorators = true if behaviour == :update_rows
+
+      decorators.each { |decorator| decorator.decorate(self, behaviour) }
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    # rubocop:disable Metrics/AbcSize
     def initialize_attributes(data, name = nil, **options)
       @data = data
       @name = (name || FakeOpinion.new.default_table_key.to_s).to_s
 
       @parent = options[:parent] if !options.nil? && options.key?(:parent)
 
+      # This code needs to work differently, it needs to support the 3 different types
+      # Move the query into helpers
+      decorator_list = options[:decorators].nil? ? [] : options[:decorators]
+
+      @decorators = decorator_list
+                    .map(&:new)
+                    .select { |decorator| decorator.compatible?(self) }
+
       @data[@name] = { 'fields' => [], 'rows' => [] }
     end
+    # rubocop:enable Metrics/AbcSize
 
     def respond_to_missing?(name, *_args, &_block)
       (!@parent.nil? && @parent.respond_to?(name, true)) || super

data/lib/k_doc/util.rb

@@ -3,12 +3,18 @@
 module KDoc
   # Utility helper methods for KDoc
   class Util
-    def build_unique_key(key, type = nil, namespace = nil)
+    # 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
 
-      namespace.nil? || namespace.empty? ? "#{key}_#{type}" : "#{namespace}_#{key}_#{type}"
+      keys = [project_key, namespace, key, type].reject { |k| k.nil? || k == '' }.map { |k| k.to_s.gsub('_', '-') }
+
+      keys.join('-')
     end
   end
 end

data/lib/k_doc/version.rb

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

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: k_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.15
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: k_decor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: k_log
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: k_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: k_util
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +99,7 @@ files:
 - README.md
 - Rakefile
 - STORIES.md
+- ToDo.md
 - USAGE.md
 - bin/console
 - bin/k
@@ -67,8 +110,11 @@ files:
 - hooks/update-version
 - k_doc.gemspec
 - lib/k_doc.rb
-- lib/k_doc/document.rb
+- lib/k_doc/container.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