smart_core 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48849feae93285cc47dffdf7ded564e285a9294c85f33c12f46cca3f8ce2f0ac
-  data.tar.gz: 8c4bb987bea2d13d68bef46d9c8e571e7ab05a4ec845e1066db83e5427dfb0b2
+  metadata.gz: da28c0f798db1236c70e630dc0f036260075038c6089d0640deec903ab72063b
+  data.tar.gz: b0bf5ff34eece47159f43acf3d7c870adcbcfc10c1f526a16a6c851587cbacb9
 SHA512:
-  metadata.gz: 6bdc6cd853dbc1feef51a6f37609c529381aa2a8a9e36484f961648fe167459397a3068a33adafc7f7f80a6c291e9ea81e91dd3580a917b810d85d45115a0534
-  data.tar.gz: d3938950ef78da94e8866870e7d1f08b6d122947507d7876d817a9e19788e89c98af040dfd05a3a917758e32142a3ac0af7ad902afa56fd1eb365d20bc2b4aa1
+  metadata.gz: 998f834b2631eb097b3824b00154cdea38103b488de00ae6022f29bddb2d012cfdd2b2039963d7663781e260a4bc841122ceaafaf26540b3dd18c77ac7d0a3fe
+  data.tar.gz: 838c859715897c223c11a6104efcb8110ff00a08f9897cc3e927ac8440a704528cc980262c0554628f967dd8980f6309648256f0b2199e20e7864315360b89db

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
 
 AllCops:
   UseCache: true
-  TargetRubyVersion: 2.6.0
+  TargetRubyVersion: 2.6.3
   Include:
     - bin/console
     - lib/**/*.rb
@@ -14,6 +14,6 @@ AllCops:
     - Rakefile
     - smart_core.gemspec
 
-# NOTE: support for oldes ruby versions
+# NOTE: support for old ruby versions
 Style/RedundantBegin:
   Enabled: false

data/.travis.yml

@@ -6,9 +6,9 @@ matrix:
   fast_finish: true
   include:
   - rvm: 2.3.8
-  - rvm: 2.4.5
-  - rvm: 2.5.3
-  - rvm: 2.6.0
+  - rvm: 2.4.6
+  - rvm: 2.5.5
+  - rvm: 2.6.3
   - rvm: ruby-head
   - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2019-06-02
+### PRE-RELEASE
+
 ## [0.4.0] - 2019-01-27
 ### Added
 - **Valdiator**

data/Gemfile

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in smart_core.gemspec
 gemspec

data/README.md

@@ -24,39 +24,11 @@ require 'smart_core'
 
 #### Completed abstractions:
 
-- [**Operation Object**](#operation-object) (aka `Service Object`) (`SmartCore::Operation`)
-  - attribute definition DSL (`param`, `option`, `params`, `options`);
-  - yieldable result object abstraction (`Success`, `Failure`, `Fatal`, `#success?`, `#failure?`, `#fatal?`);
-  - yieldable `#call` (and `.call`);
-  - inheritance works as expected `:)`;
-  - no dependencies;
-
-- [**Validation Object**](#validation-object) (`SmartCore::Validator`)
-  - support for nested validations;
-  - inheritance works as expected `:)`;
-  - `#error` - adds an error code;
-  - `#fatal` - adds an error code and stops the current method execution flow;
-  - command-style DSL;
-  - thread-safe;
-  - no dependencies;
-
----
-
-#### Operation Object
-
-```ruby
-class Service < SmartCore::Operation
-  # soon...
-end
-```
-
-#### Validation Object
-
-```ruby
-class Validator < SmartCore::Validator
-  # soon...
-end
-```
+- Service Object (Operation, Functional Object);
+- Initializer (DSL);
+- Validator (Validation Layer);
+- Dependency Container;
+- (Soon) Schema;
 
 ---
 

data/Rakefile

@@ -4,6 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop'
 require 'rubocop-rspec'
+require 'rubocop-performance'
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
@@ -11,6 +12,7 @@ RuboCop::RakeTask.new(:rubocop) do |t|
 
   t.options = ['--config', config_path]
   t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
 end
 
 RSpec::Core::RakeTask.new(:rspec)

data/lib/smart_core/container/command_definer.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Container
+  class CommandDefiner
+    # @param container_klass [Class<SmartCore::Container>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def initialize(container_klass)
+      @container_klass = container_klass
+      @access_lock = Mutex.new
+    end
+
+    # @param namespace_name [String, Symbol]
+    # @param dependency_definitions [Proc]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def append_namespace(namespace_name, dependency_definitions)
+      thread_safe do
+        command = build_namespace_command(namespace_name, dependency_definitions)
+        prevent_dependency_overlap!(command)
+        append_command(command)
+      end
+    end
+
+    # @param dependency_name [String, Symbol]
+    # @param dependency_definition [Proc]
+    # @param options [Hash<Symbol,Any>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def append_register(dependency_name, dependency_definition, options)
+      thread_safe do
+        command = build_register_command(dependency_name, dependency_definition, options)
+        prevent_namespace_overlap!(command)
+        append_command(command)
+      end
+    end
+
+    private
+
+    # @return [Class<SmartCore::Container>]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :container_klass
+
+    # @param namespace_name [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def prevent_dependency_overlap(namespace_name)
+      DependencyCompatability::CommandSet.prevent_dependency_overlap!(
+        container_klass, namespace_name
+      )
+    end
+
+    # @param dependency_name [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def prevent_namespace_overlap(dependency_name)
+      DependencyCompatability::CommandSet.prevent_namespace_overlap!(
+        container_klass, dependency_name
+      )
+    end
+
+    # @param namespace_name [String]
+    # @param dependency_definitions [Proc]
+    # @return [SmartCore::Container::Commands::Namespace]
+    #
+    # @api private
+    # @since 0.5.0
+    def build_namespace_command(namespace_name, dependency_definitions)
+      SmartCore::Container::Commands::Namespace.new(
+        namespace_name, dependency_definitions
+      )
+    end
+
+    # @param dependency_name [String]
+    # @param dependency_definition [Proc]
+    # @param option [Hash<Symbol,Any>]
+    # @return [SmartCore::Container::Commands::Register]
+    #
+    def build_register_command(dependency_name, dependency_definition, options)
+      SmartCore::Container::Commands::Register.new(
+        dependency_name, dependency_definition, **options
+      )
+    end
+
+    # @param command [SmartCore::Container::Commands::Base]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def append_command(command)
+      container_klass.__commands__.add_command(command)
+    end
+
+    # @param block [Block]
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.5.0
+    def thread_safe(&block)
+      @access_lock.synchronize(&block)
+    end
+  end
+end

data/lib/smart_core/container/command_set.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Container::CommandSet
+  # @since 0.5.0
+  include Enumerable
+
+  # @return [Array<SmartCore::Container::Commands::Base>]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :commands
+
+  # @api private
+  # @since 0.5.0
+  def initialize
+    @commands = []
+    @access_lock = Mutex.new
+  end
+
+  # @param command [SmartCore::Container::Commands::Base]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def add_command(command)
+    thread_safe { commands << command }
+  end
+  alias_method :<<, :add_command
+
+  # @yield [SmartCore::Container::Commands::Base]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.5.0
+  def each(&block)
+    thread_safe { block_given? ? commands.each(&block) : commands.each }
+  end
+
+  # @param command_set [SmartCore::Container::CommandSet]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def concat(command_set)
+    thread_safe { commands.concat(command_set.dup.commands) }
+  end
+
+  # @return [SmartCore::Operation::AttributeSet]
+  #
+  # @api private
+  # @since 0.2.0
+  def dup
+    thread_safe do
+      self.class.new.tap do |duplicate|
+        commands.each do |command|
+          duplicate.add_command(command.dup)
+        end
+      end
+    end
+  end
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def clear
+    thread_safe { commands.clear }
+  end
+
+  private
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.5.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/smart_core/container/commands/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Container::Commands::Base
+  # @param regsitry [SmartCore::Container::Registry]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.5.0
+  def call(registry); end
+end

data/lib/smart_core/container/commands/namespace.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module SmartCore::Container::Commands
+  # @api private
+  # @since 0.5.0
+  class Namespace < Base
+    # @return [String, Symbol]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :namespace_name
+
+    # @param namespace_name [String, Symbol]
+    # @param dependency_definitions [Proc]
+    # @return [void]
+    #
+    # @see [SmartCore::Container::KeyGuard]
+    #
+    # @api private
+    # @since 0.5.0
+    def initialize(namespace_name, dependency_definitions)
+      SmartCore::Container::KeyGuard.indifferently_accessable_key(namespace_name).tap do |name|
+        @namespace_name = name
+        @dependency_definitions = dependency_definitions
+      end
+    end
+
+    # @param registry [SmartCore::Container::Registry]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def call(registry)
+      registry.namespace(namespace_name, &dependency_definitions)
+    end
+
+    # @return [SmartCore::Container::Commands::Namespace]
+    #
+    # @api private
+    # @since 0.5.0
+    def dup
+      self.class.new(namespace_name, dependency_definitions)
+    end
+
+    private
+
+    # @return [Proc]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :dependency_definitions
+  end
+end

data/lib/smart_core/container/commands/register.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SmartCore::Container::Commands
+  # @api private
+  # @since 0.5.0
+  class Register < Base
+    # @return [String, Symbol]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :dependency_name
+
+    # @param dependency_name [String, Symbol]
+    # @param options [Hash<Symbol,Any>]
+    # @param dependency_definition [Proc]
+    # @option memoize [Boolean]
+    # @return [void]
+    #
+    # @todo option list
+    # @see [SmartCore::Container::KeyGuard]
+    #
+    # @api private
+    # @since 0.5.0
+    def initialize(dependency_name, dependency_definition, **options)
+      SmartCore::Container::KeyGuard.indifferently_accessable_key(dependency_name).tap do |name|
+        @dependency_name = name
+        @options = options
+        @dependency_definition = dependency_definition
+      end
+    end
+
+    # @param registry [SmartCore::Container::Registry]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def call(registry)
+      registry.register(dependency_name, **options, &dependency_definition)
+    end
+
+    # @return [SmartCore::Container::Commands::Register]
+    #
+    # @api private
+    # @since 0.5.0
+    def dup
+      self.class.new(dependency_name, dependency_definition, **options)
+    end
+
+    private
+
+    # @return [Proc]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :dependency_definition
+
+    # @return [Hash<Symbol,Any>]
+    #
+    # @api private
+    # @since 0.5.0
+    attr_reader :options
+  end
+end

data/lib/smart_core/container/commands.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+module SmartCore::Container::Commands
+  require_relative 'commands/base'
+  require_relative 'commands/namespace'
+  require_relative 'commands/register'
+end

data/lib/smart_core/container/definition_dsl.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+module SmartCore::Container::DefinitionDSL
+  class << self
+    # @param base_klass [Class<SmartCore::Container>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def included(base_klass)
+      base_klass.instance_variable_set(:@__commands__, SmartCore::Container::CommandSet.new)
+      base_klass.singleton_class.send(:attr_reader, :__commands__)
+      base_klass.extend(ClassMethods)
+      base_klass.singleton_class.prepend(ClassInheritance)
+    end
+  end
+
+  # @api private
+  # @since 0.5.0
+  module ClassInheritance
+    # @param child_klass [Class<SmartCore::Container>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.5.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(:@__commands__, SmartCore::Container::CommandSet.new)
+      child_klass.__commands__.concat(__commands__)
+      child_klass.singleton_class.prepend(ClassInheritance)
+      super
+    end
+  end
+
+  # @api private
+  # @since 0.5.0
+  module ClassMethods
+    # @param namespace_name [String, Symbol]
+    # @param dependency_definitions [Block]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.5.0
+    def namespace(namespace_name, &dependency_definitions)
+      __commands__ << SmartCore::Container::Commands::Namespace.new(
+        namespace_name, dependency_definitions
+      )
+    end
+
+    # @param dependency_name [String, Symbol]
+    # @param options [Hash<Symbol,Any>]
+    # @param dependency_definition [Proc]
+    # @return [void]
+    #
+    # @todo option list
+    #
+    # @api public
+    # @since 0.5.0
+    def register(dependency_name, **options, &dependency_definition)
+      __commands__ << SmartCore::Container::Commands::Register.new(
+        dependency_name, dependency_definition, **options
+      )
+    end
+  end
+end

data/lib/smart_core/container/dependency.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Container::Dependency < SmartCore::Container::Entity
+  # @param dependency_definition [Proc]
+  # @param options [Hash<Symbol,Any>]
+  # @return [void]
+  #
+  # @todo option list
+  #
+  # @api private
+  # @since 0.5.0
+  def initialize(external_name, dependency_definition, **options)
+    @dependency_definition = dependency_definition
+    @access_lock = Mutex.new
+    super(external_name)
+  end
+
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.5.0
+  def call
+    thread_safe { dependency_definition.call }
+  end
+
+  private
+
+  # @return [Proc]
+  #
+  # @api private
+  # @since 0.5.0
+  attr_reader :dependency_definition
+
+  # @param block [Proc]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.5.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/smart_core/container/dependency_builder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+module SmartCore::Container::DependencyBuilder
+  class << self
+    # @param external_name [String]
+    # @param dependency_definition [Proc]
+    # @option memoize [Boolean]
+    # @return [SmartCore::Container::Dependency, SmartCore::Container::MemoizedDependency]
+    #
+    # @api private
+    # @since 0.5.0
+    def build(external_name, dependency_definition, memoize: false, **options)
+      # @todo: raise an error if memoize is not a boolean
+
+      if memoize
+        build_memoized_dependency(external_name, dependency_definition, **options)
+      else
+        build_dependency(external_name, dependency_definition, **options)
+      end
+    end
+
+    private
+
+    # @param external_name [String]
+    # @param dependency_definition [Proc]
+    # @param options [Hash<Symbol,Any>]
+    # @return [SmartCore::Container::MemoizedDependency]
+    #
+    # @api private
+    # @since 0.5.0
+    def build_memoized_dependency(external_name, dependency_definition, **options)
+      SmartCore::Container::MemoizedDependency.new(external_name, dependency_definition, **options)
+    end
+
+    # @param external_name [String]
+    # @param dependency_definition [Proc]
+    # @param options [Hash<Symbol,Any>]
+    # @return [SmartCore::Container::Dependency]
+    #
+    # @api private
+    # @since 0.5.0
+    def build_dependency(external_name, dependency_definition, **options)
+      SmartCore::Container::Dependency.new(external_name, dependency_definition, **options)
+    end
+  end
+end

data/lib/smart_core/container/dependency_compatability/abstract.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.5.0
+class SmartCore::Container::DependencyCompatability::Abstract
+  class << self
+    # @param dependency_root [Any]
+    # @param dependency_name [String]
+    # @return [void]
+    #
+    # @raise [SmartCore::Container::NamespaceOverlapError]
+    #
+    # @api private
+    # @since 0.5.0
+    def prevent_namespace_overlap!(dependency_root, dependency_name)
+      raise(
+        SmartCore::Container::NamespaceOverlapError,
+        "Trying to overlap already registered :#{dependency_name} " \
+        "namespace with :#{dependency_name} dependency!"
+      ) if potential_namespace_overlap?(dependency_root, dependency_name)
+    end
+
+    # @param dependency_root [Any]
+    # @param namespace_name [String]
+    # @return [void]
+    #
+    # @raise [SmartCore::Container::DependencyOverlapError]
+    #
+    # @api private
+    # @since 0.5.0
+    def prevent_dependency_overlap!(dependency_root, namespace_name)
+      raise(
+        SmartCore::Container::DependencyOverlapError,
+        "Trying to overlap already registered :#{namespace_name} " \
+        "dependency with :#{namespace_name} namespace!"
+      ) if potential_dependency_overlap?(dependency_root, namespace_name)
+    end
+
+    # @param dependency_root [Any]
+    # @param dependency [Any]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.5.0
+    def potential_namespace_overlap?(dependency_root, dependency)
+      raise NoMethodError
+    end
+
+    # @param dependency_root [Any]
+    # @param namespace [Any]
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.5.0
+    def potential_dependency_overlap?(dependency_root, namespace)
+      raise NoMethodError
+    end
+  end
+end