hexx-services 0.0.1

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 5

data/config/metrics/metric_fu.yml

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5

data/config/metrics/rubocop.yml

@@ -0,0 +1,72 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  4
+error_cyclo: 6

data/config/metrics/simplecov.yml

@@ -0,0 +1,8 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: # The list of groups to be shown in the coverage report
+  Libraries: "lib/"
+  Application: "app/"

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/hexx-services.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "hexx-services/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name        = "hexx-services"
+  gem.version     = Hexx::Services::VERSION.dup
+  gem.author      = "Andrew Kozin"
+  gem.email       = "andrew.kozin@gmail.com"
+  gem.homepage    = "https://github.com/nepalez/hexx-services"
+  gem.summary     = "Service Objects for application domain layer"
+  gem.license     = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = Dir["spec/**/*.rb"]
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
+  gem.require_paths    = ["lib"]
+
+  gem.required_ruby_version = "~> 2.1"
+
+  gem.add_runtime_dependency "attestor", "~> 2.2"
+  gem.add_runtime_dependency "eigindir", "~> 0.0"
+  gem.add_runtime_dependency "informator", "~> 0.0"
+
+  gem.add_development_dependency "hexx-rspec", "~> 0.4"
+
+end # Gem::Specification

data/lib/hexx-services.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require "attestor"
+require "eigindir"
+require "informator"
+
+# Shared namespace for hexx gems collections
+#
+module Hexx
+
+  # Defines the base class for domain service objects
+  #
+  module Services
+
+    require_relative "hexx-services/patches.rb"
+    require_relative "hexx-services/translation_dsl"
+    require_relative "hexx-services/execution_dsl"
+    require_relative "hexx-services/dependencies_dsl"
+    require_relative "hexx-services/base"
+
+  end # module Services
+
+end # module Hexx

data/lib/hexx-services/base.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Hexx::Services
+
+  # The base class for domain service object
+  #
+  class Base
+
+    extend  DependenciesDSL
+    include Eigindir, Attestor::Validations, TranslationDSL, ExecutionDSL
+
+    private_class_method :depends_on
+    private_class_method :attribute, :attribute_reader, :attribute_writer
+    private_class_method :validate, :validates
+
+    public :subscribe, :call
+
+    private :execute
+    private :remember, :publish, :publish!
+    private :attributes, :attributes=
+    private :validate, :validate!, :invalid
+    private :translate
+
+  end # class Base
+
+end # class Hexx::Services

data/lib/hexx-services/dependencies_dsl.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Hexx::Services
+
+  # The module provides features to declare dependencies of
+  # service objects from other service objects.
+  #
+  # @example
+  #   class MyService
+  #     extend DSL::DependenciesDSL
+  #     depends_on :get_item, GetItem
+  #   end
+  #
+  #   service = MyService.new
+  #   service.get_item             # => GetItem
+  #   service.get_item = FindItem  # => FindItem
+  #   service.get_item = nil       # => GetItem
+  #
+  module DependenciesDSL
+
+    using Patches
+
+    # Declare the dependency with a default value
+    #
+    # @param [Symbol, String] name The name of the dependency
+    # @param [Class] default The default implementation for the dependency
+    #
+    # @raise [TypeError] if default is set to class that is not a service
+    #
+    # @return [Symbol] the name of the dependency
+    #
+    def depends_on(name, default = nil)
+      if default.nil?
+        attr_accessor(name)
+      elsif default.kind_of_service_class?
+        define_method(name) { instance_variable_get(:"@#{ name }") || default }
+        attr_writer name
+      else
+        fail TypeError.new "The #{ default.inspect } is not a service"
+      end
+
+      self
+    end
+
+  end # module DependenciesDSL
+
+end # module Hexx::Services

data/lib/hexx-services/execution_dsl.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Hexx::Services
+
+  # Module ExecutionDSL includes Informator and provides [#execute] and [#call]
+  # methods on top of it.
+  #
+  # @example
+  #   class MyService
+  #     include ExecutionDSL
+  #
+  #     def execute
+  #       publish! :something
+  #     end
+  #   end
+  #
+  module ExecutionDSL
+    include Informator
+
+    # The method executes the service object catches `:published` and returns
+    # its results. When nothing was published it publishes `:success` event
+    # by itself.
+    #
+    # @return [<type>] <description>
+    #
+    def call
+      events = Array(catch(:published) { execute })
+      return events if events.first.instance_of? Event
+      publish :success
+    end
+
+    # @abstract
+    #
+    # Defines the sequence of commands provided by the service object
+    #
+    # @return [undefined]
+    #
+    def execute
+    end
+
+  end # module DependenciesDSL
+
+end # module Hexx::Services

data/lib/hexx-services/patches.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Hexx::Services
+
+  # Module contains local monkey-patches (refinements) to Ruby core classes
+  #
+  module Patches
+
+    refine Class do
+
+      # Converts the name of the class to the conventional pathname
+      #
+      # @example
+      #   Test::MyClassName.pathname # => "test/my_class_name"
+      #
+      # @return [String]
+      #
+      def pathname
+        convert = -> item { item.gsub(/([a-z])([A-Z])/, '\1_\2').downcase }
+        name.split("::").map(&convert).join("/")
+      end
+
+    end # refine Class
+
+    refine Object do
+
+      # Checks if an object is kind of service class
+      #
+      # @return [Boolean]
+      #
+      def kind_of_service_class?
+        is_a?(Class) && ancestors.include?(Hexx::Services::Base)
+      end
+
+    end # refine Object
+
+  end # module Patches
+
+end # module Hexx::Services

data/lib/hexx-services/translation_dsl.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Hexx::Services
+
+  # The module provides features to do translations in the current service's
+  # scope
+  #
+  # @example
+  #   class MyService
+  #     include TranslationDSL
+  #   end
+  #
+  #   service = MyService.new
+  #   service.translate :foo
+  #   # => "translation missing: en.services.my_service.foo"
+  #
+  module TranslationDSL
+
+    using Patches
+
+    # Translates a name in the scope of the current service
+    #
+    # @overload translate(name, options)
+    #   Translates a symbolic argument with given options
+    #
+    #   @param [Symbol] name
+    #   @param [Hash] options
+    #
+    #   @return [String]
+    #
+    # @overload translate(name, *)
+    #   Stringifies non-symbolic argument
+    #
+    #   @param [#to_s] name
+    #
+    #   @return [String]
+    #
+    def translate(name, **options)
+      return name.to_s unless name.instance_of? Symbol
+      I18n.t name, options.merge(scope: [:services, self.class.pathname.to_sym])
+    end
+
+  end # module TranslationDSL
+
+end # module Hexx::Services