k_decor 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b15a205ba61fec4f4099603d274333c9832a4a10726522c0e424cff8d64f767
-  data.tar.gz: ad770756eff0cb95f67c0b58217bebbd65fdc44a31df695b1c8769e900c90710
+  metadata.gz: 4895a5e41e46f0010305f1a7702b5b733595eec102fabd4655458687f918473e
+  data.tar.gz: 3a2af2a33aca215f12237a712452bb11679bb298ee2093d5c4e8bb4bfd2f630f
 SHA512:
-  metadata.gz: 854f3a3ea40f8fc5dbad8e704cacd84af85f32b161fba5d4e4d76f80db7e8a7f839324a4b63d0c41a118fad0f1ceec6364895430652fd1294302cef64dd3c40a
-  data.tar.gz: bfbdd4b5a65ce3a24d8c1f2f00429ed0127a26690593dd6ebc1af79b1640dd46d4cef0fa9746b9e263667733d59929ae295a45c1b50588a0e0d919f21c504971
+  metadata.gz: cc546d4fb93297ccc148d243dc9f8b6e7bdb3e2015bb39bce0a9920ec7499a36bfdc6dd23b4dfabebeac0758cd6b13eceaa4fee595fe581418d06078a51bbae2
+  data.tar.gz: 92929c85592e1581dc8563c4a547c29fcf43c70d793ecb514546f321d5bac8c220c2a2366bee86a7b18d9273bcc5b2c64605b447a569c5ac65e9001a5d3620d3

data/.rubocop.yml

@@ -44,6 +44,9 @@ Layout/LineLength:
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
+Style/Documentation:
+  Enabled: false
+
 Style/BlockComments:
   Enabled: false
   Include:

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/Guardfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+guard :bundler, cmd: 'bundle install' do
+  watch('Gemfile')
+  watch('k_decor.gemspec')
+end
+
+group :green_pass_then_cop, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec -f doc' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+    watch(%r{^lib/k_decor/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch(%r{^lib/k_decor/commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
+    watch(%r{^spec/mocks/(.+)\.rb$}) { |_m| 'spec/k_decor/base_decorator_spec.rb' }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+    watch(/{.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/k_decor.gemspec

@@ -38,5 +38,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_decor/extconf.rb']
 
-  # spec.add_dependency 'tty-box',         '~> 0.5.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'
 end

data/lib/k_decor.rb

@@ -1,10 +1,41 @@
 # frozen_string_literal: true
 
+require 'k_log'
+require 'k_type'
+
 require 'k_decor/version'
+require 'k_decor/base_decorator'
+require 'k_decor/resolve_instance'
+require 'k_decor/configuration'
+require 'k_decor/decorator_hash'
+require 'k_decor/helper'
 
 module KDecor
   # raise KDecor::Error, 'Sample message'
   class Error < StandardError; end
 
-  # Your code goes here...
+  class << self
+    attr_accessor :decorate
+
+    def configuration
+      @configuration ||= KDecor::Configuration.new
+    end
+
+    def reset
+      @configuration = KDecor::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  KDecor.decorate = KDecor::Helper.new
+end
+
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'KDecor::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('k_decor/version') }
+  version   = KDecor::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
 end

data/lib/k_decor/base_decorator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module KDecor
+  # Base decorator
+  class BaseDecorator
+    include KLog::Logging
+
+    # Compatible type will store the Object Type that this decorator
+    # is suitable for processing
+    attr_accessor :compatible_type
+
+    # What are the specific behaviours available on this decorator
+    #
+    # If you wish to use a decorator to run against a compatible data
+    # type you do not need individual behaviours then set
+    # implemented_behaviours to [:default]
+    #
+    # But if this decorator type only targets certain behaviours then give it a
+    # list of specific :behaviour to perform. e.g. [:update_fields, :update_rows]
+    attr_accessor :implemented_behaviours
+
+    def initialize(compatible_type)
+      @compatible_type = compatible_type
+      @implemented_behaviours = []
+    end
+
+    # Does the decorator implement the behaviour
+    # , any = false)
+    def behaviour?(behaviour)
+      behaviour == :all || implemented_behaviours.include?(behaviour)
+    end
+
+    def compatible?(target)
+      target.is_a?(compatible_type)
+    end
+
+    def decorate(target, **opts)
+      raise KType::Error, "#{self.class} is incompatible with data object" unless compatible?(target)
+      raise KType::Error, "#{self.class} has not implemented an update method" unless respond_to?(:update)
+
+      update(target, **opts)
+    end
+  end
+end

data/lib/k_decor/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KDecor
+  # Configuration class for KDecor
+  class Configuration
+    attr_accessor :decorators
+
+    def initialize
+      @decorators = KDecor::DecoratorHash.new
+    end
+
+    def register_decorator(key, decorator)
+      decorators.add(key, decorator)
+    end
+
+    def get_decorator(key)
+      decorators[key]
+    end
+  end
+end

data/lib/k_decor/decorator_hash.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module KDecor
+  # Decorator set will hold a set of instantiated decorators with lookup keys
+  class DecoratorHash < Hash
+    include KDecor::ResolveInstance
+    include KLog::Logging
+
+    # Add a keyed decorator to the store.
+    #
+    # @param [Symbol] key lookup key that can be used when retrieving the decorator
+    def add(key, decorator)
+      if key?(key)
+        log.warn("Decorator with this key '#{key}' already in the stored")
+        return
+      end
+
+      self[key] = resolve_decorator_instance(decorator)
+      nil
+    end
+
+    # def decorators(decorators)
+    #   return [] if decorators.nil?
+
+    #   decorators.map do |decorator|
+    #     if decorator.is_a?(Class)
+    #       handle_class(decorator)
+    #     elsif decorator.is_a?(Symbol)
+    #       handle_symbol(decorator)
+    #     else
+    #       decorator
+    #     end
+    #   end.compact
+    # end
+
+    # def decorator_instance(decorator)
+    #   if decorator.is_a?(Class)
+    #     return decorator.new if decorator.ancestors.include?(KDecor::BaseDecorator)
+
+    #     raise KType::Error, 'Class type is not a KDecor::BaseDecorator'
+    #   end
+
+    #   raise KType::Error, 'Class instance is not a KDecor::BaseDecorator' unless decorator.is_a?(KDecor::BaseDecorator)
+
+    #   decorator
+    # end
+
+    # def handle_symbol(decorator)
+    #   result = KDsl.config.get_decorator(decorator)&.new
+    #   result = nil unless result.respond_to?(:update)
+    #   result
+    # end
+  end
+end

data/lib/k_decor/helper.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module KDecor
+  # KDoc.settings :x, decorators: [Class, Class.instance, :class] do
+  #   #
+  # end
+
+  class Helper
+    include KDecor::ResolveInstance
+
+    # Resolve decorator instances by evaluating a list of decorators in the format
+    # :symbol, class or :class_instance
+    #
+    # :symbol will be looked up from pre-configured decorators
+    # :class will be instantiated
+    # :class_instance will be returned as is
+    #
+    # @example Sample of how decorators can be passed
+    #
+    #   decorators(:uppercase, PeopleModelDecorator, PluralizeModelDecorator.new('Person' => 'People') })
+    #
+    # @param [Array<Symbol,Class<BaseDecorator>|Instance<BaseDecorator>>] decorators provide a list of
+    # decorators as either Class or Instances or pre-configured symbols
+    def resolve_decorators(decorators)
+      decorators.map do |decorator|
+        if decorator.is_a?(Symbol)
+          KDecor.configuration.get_decorator(decorator)
+        else
+          resolve_decorator_instance(decorator)
+        end
+      end.compact
+    end
+
+    # Run a list of decorators against the data
+    def decorate(data, *decorators, behaviour: :default, behaviours: [])
+      if behaviours.length.zero?
+        decorators.map do |decorator|
+          decorator.decorate(data, behaviour: behaviour)
+        end
+      else
+        behaviours.each do |behave|
+          decorators.map do |decorator|
+            decorator.decorate(data, behaviour: behave)
+          end
+        end
+      end
+      data
+    end
+
+    # decorate(data, [](:plural, PluralizeModelDecorator)
+    # config.register_decorator(:plural_configured, PluralizeModelDecorator.new('Person' => 'People'))
+    # config.register_decorator(:people, PeopleModelDecorator)
+  end
+end

data/lib/k_decor/resolve_instance.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KDecor
+  # Decorator set will hold a set of instantiated decorators with lookup keys
+  module ResolveInstance
+    # Decorator instance will accept a decorator in the form of Class or Instance
+    #
+    # @param [Class<BaseDecorator>|Instance<BaseDecorator>] decorator as either a class type or an instance that extends from BaseDecorator
+    def resolve_decorator_instance(decorator)
+      if decorator.is_a?(Class)
+        return decorator.new if decorator.ancestors.include?(KDecor::BaseDecorator)
+
+        raise KType::Error, 'Class type is not a KDecor::BaseDecorator'
+      end
+
+      raise KType::Error, 'Class instance is not a KDecor::BaseDecorator' unless decorator.is_a?(KDecor::BaseDecorator)
+
+      decorator
+    end
+  end
+end

data/lib/k_decor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDecor
-  VERSION = '0.0.1'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: k_decor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
-dependencies: []
+date: 2021-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: k_log
+  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_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
 description: "    KDecor provides decorators and management for applying data decoration
   to data objects\n"
 email:
@@ -24,6 +52,7 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -36,6 +65,11 @@ files:
 - hooks/update-version
 - k_decor.gemspec
 - lib/k_decor.rb
+- lib/k_decor/base_decorator.rb
+- lib/k_decor/configuration.rb
+- lib/k_decor/decorator_hash.rb
+- lib/k_decor/helper.rb
+- lib/k_decor/resolve_instance.rb
 - lib/k_decor/version.rb
 homepage: http://appydave.com/gems/k-decor
 licenses: