vg-service_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0e1fea1a0c6d0cf6f8804325d01e1d29f0569db7090b659eeaceb5ee00f83cf
+  data.tar.gz: d428f22186c6d9130ee76245efc58181c708656ef0e7f8e265ba0d817357e9b1
+SHA512:
+  metadata.gz: 23103f62225bff2207d1d3a15a06d1da1b64c82491ba0c97c85f72b8ef62c547d83cc817cc6db0a2014b9835e0de94eb73e2d58f8314bf4949b3ece650ee1a8e
+  data.tar.gz: 7f962005ba8ce5d78304726bfd7ec8c8d8fa28f36fe2363f6246785d44a21fe794322c6c3a62d53901720e85c9066c2165ec6b7c7e0fe7dce278a5774ff03139

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/lib/bundler/man/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/rdoc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+.rspec_status
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Gem's dependencies are specified in .gemspec file
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    vg-service_object (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.6.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    shellany (0.0.1)
+    thor (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.7)
+  pry
+  rspec (~> 3.2)
+  vg-service_object!
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,13 @@
+
+# More info at https://github.com/guard/guard#readme
+
+directories %w(lib config spec)
+
+guard :rspec, cmd: "rspec --format d" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})            { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")         { "spec" }
+  watch("spec/dummy_objects.rb")       { "spec" }
+  watch("spec/shared_examples.rb")     { "spec" }
+  watch("spec/helpers.rb")             { "spec" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vladimir Gorodulin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ServiceObject pattern
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vg-service_object'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vg-service_object
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gorodulin/service_object.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/vg.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module VG
+  require_relative "vg/service_object"
+  require_relative "vg/s_o"
+  #autoload(:ServiceObject, 'v_g/service_object')
+  #autoload(:SO, 'v_g/s_o')
+end

data/lib/vg/s_o.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    autoload(:GenerateIncludableModule,   'vg/s_o/generate_includable_module')
+    autoload(:GenerateSlugFromModuleName, 'vg/s_o/generate_slug_from_module_name')
+    autoload(:InjectRegistrationMethods,  'vg/s_o/inject_registration_methods')
+    autoload(:ServiceObjectModuleInheritance,   'vg/s_o/service_object_module_inheritance')
+    autoload(:ServiceObjectRegistrationMethods, 'vg/s_o/service_object_registration_methods')
+  end
+end

data/lib/vg/s_o/generate_includable_module.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    module GenerateIncludableModule
+
+      def self.call(so_module_name, as: nil)
+        method_name = as || GenerateSlugFromModuleName.call(so_module_name)
+        Module.new do
+          class_eval <<~RUBY
+            def self.included(base)
+              InjectRegistrationMethods.call(base)
+              base.register_service_object(:#{method_name}, ::#{so_module_name})
+            end
+
+            def #{method_name}_fn
+              self.class.registered_service_objects[:#{method_name}].callable
+            end
+
+            def #{method_name}(...)
+              send("#{method_name}_fn").call(...)
+            end
+
+            def self.extended(_base)
+              raise "Do not extend ::#{so_module_name}, use include!"
+            end
+          RUBY
+        end
+      end
+
+    end # ... GenerateIncludableModule
+  end # ... SO
+end # ... VG

data/lib/vg/s_o/generate_slug_from_module_name.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    module GenerateSlugFromModuleName
+
+      def self.call(module_name)
+        regex = /(?:::)*([A-Za-z0-9]+)$/
+        module_name.match(regex)[1]
+          .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .downcase.to_sym
+      end
+
+    end # ... GenerateSlugFromModuleName
+  end # ... SO
+end # ... VG

data/lib/vg/s_o/inject_registration_methods.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    module InjectRegistrationMethods
+
+      def self.call(base)
+        base.include(ServiceObjectModuleInheritance)
+        base.include(ServiceObjectRegistrationMethods)
+      end
+
+      def self.included(_base)
+        raise "Do not include, use #call instead"
+      end
+
+    end # ... InjectRegistrationMethods
+  end # ... SO
+end # ... VG

data/lib/vg/s_o/service_object_module_inheritance.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    module ServiceObjectModuleInheritance
+
+      module ClassMethods
+        def included(base)
+          puts "-- #{self.name}#included call (including into #{base})"
+          InjectRegistrationMethods.call(base)
+          base.register_service_objects(registered_service_objects)
+          
+          super(base)
+        end
+      end
+
+      def self.included(base)
+        return unless base.instance_of?(Module)
+        return if base.singleton_class.included_modules.include?(ClassMethods)
+
+        puts "-- prepend #{base.name}#included with ServiceObjectModuleInheritance#included"
+        base.singleton_class.prepend ClassMethods
+      end
+
+    end # ... ServiceObjectModuleInheritance
+  end # ... SO
+end # ... VG

data/lib/vg/s_o/service_object_registration_methods.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VG
+  module SO
+    module ServiceObjectRegistrationMethods
+      module ClassMethods
+        def registered_service_objects
+          @registered_service_objects ||= {}
+        end
+        
+        def register_service_objects(hash)
+          hash.each { |name, so| register_service_object(name, so) }
+        end
+
+        def register_service_object(name, so)
+          registered_service_objects[name.to_sym]&.tap do |registered_so|
+            return if so == registered_so
+            raise "#{so} clashes with #{registered_so} in #{self}" if so != registered_so
+          end
+          
+          puts "--- register #{self.name}##{name} => #{so}#call"
+          registered_service_objects[name.to_sym] = so
+        end
+      end
+
+      def self.included(base)
+        return if base.singleton_class.included_modules.include?(ClassMethods)
+
+        puts "-- #{base.name}: extend with ServiceObjectRegistrationMethods"
+        base.extend ClassMethods
+      end
+
+    end # ... ServiceObjectRegistrationMethods
+  end # ... SO
+end # ... VG

data/lib/vg/service_object.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module VG
+  module ServiceObject
+
+    module ClassSingletonMethods
+      def call(...)
+        callable.call(...)
+      end
+    
+      def callable
+        @callable ||= self.new
+      end
+
+      def as_so(method_name = nil)
+        ::VG::SO::GenerateIncludableModule.call(self.name, as: method_name)
+      end
+    end
+
+    module ModuleSingletonMethods
+      def call(...)
+        callable.call(...)
+      end
+    
+      def callable
+        @callable ||= self::Action.new
+      end
+
+      def as_so(method_name = nil)
+        ::VG::SO::GenerateIncludableModule.call(self.name, as: method_name)
+      end
+    end
+
+    def self.included(so)
+      methods = so.is_a?(Class) ? ClassSingletonMethods : ModuleSingletonMethods
+      return if so.singleton_class.included_modules.include?(methods)
+      so.extend methods
+      
+      so.singleton_class.instance_eval do
+        define_method(:included) { |_base| raise "Can't be included. Use #as_so method instead" }
+      end if so.instance_of?(Module)
+    end
+
+  end # ... ServiceObject
+end # ... VG

data/lib/vg/service_object/version.rb

@@ -0,0 +1,5 @@
+module VG
+  module ServiceObject
+    VERSION = "0.1.0"
+  end
+end

data/vg-service_object.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/vg"
+require_relative "lib/vg/service_object/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vg-service_object"
+  spec.version       = VG::ServiceObject::VERSION
+  spec.authors       = ["Vladimir Gorodulin"]
+  spec.email         = ["ru.hostmaster@gmail.com"]
+  spec.summary       = %q{Service Object pattern}
+  spec.description   = %q{Service Object pattern as includable behavior}
+  spec.homepage      = "https://github.com/gorodulin/service_object"
+  spec.license       = "MIT"
+  
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata = {
+    "changelog_uri"     => "https://github.com/gorodulin/service_object/CHANGELOG.md",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => "https://github.com/gorodulin/service_object",
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec|config|tmp)/}) }
+  end
+  
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: vg-service_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Gorodulin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: Service Object pattern as includable behavior
+email:
+- ru.hostmaster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vg.rb
+- lib/vg/s_o.rb
+- lib/vg/s_o/generate_includable_module.rb
+- lib/vg/s_o/generate_slug_from_module_name.rb
+- lib/vg/s_o/inject_registration_methods.rb
+- lib/vg/s_o/service_object_module_inheritance.rb
+- lib/vg/s_o/service_object_registration_methods.rb
+- lib/vg/service_object.rb
+- lib/vg/service_object/version.rb
+- vg-service_object.gemspec
+homepage: https://github.com/gorodulin/service_object
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/gorodulin/service_object/CHANGELOG.md
+  homepage_uri: https://github.com/gorodulin/service_object
+  source_code_uri: https://github.com/gorodulin/service_object
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Service Object pattern
+test_files: []