service_interface 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 681eba82b199f64c0ecfa1b6eb91f80afb1b6e46ede30f806e6ce4f7ed5c36c2
+  data.tar.gz: 3066b378767f21467abc262edcf774c422e2083a07dcbe1d3014010f78d30970
+SHA512:
+  metadata.gz: 94d013329c075301ac4ff47947575b214f776b9f6c1595260e5455833ae7d9cf149e753239360e454a5fe4d1ec5a9da48ec1d423d0105a7d16dcad79de07ea77
+  data.tar.gz: fef9b788577ab57772a0c8f9c08f4d7c22908261644eddf6f53ed15bff332fa871491b267dd10d96d7b3a54ae454c74ebfe9151f1566d442d303497e1c43ed48

data/.gitignore

@@ -0,0 +1,3 @@
+/.ruby-gemset
+/Gemfile.lock
+/*.gem

data/.rspec

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

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Glen Crawford
+
+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,64 @@
+# ServiceInterface
+
+A Ruby module that can be included into service classes that provides a strict, boilerplate interface, taking care of defining a class-level `execute` method, instantiating the service and invoking the instance-level `execute` method, and defining and setting the arguments (and default values) of the service (both required and optional).
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```
+gem 'service_interface', git: 'git://github.com/GlenCrawford/service_interface.git'
+```
+
+Then create a service class, include the interface, and define the arguments, like so:
+
+```ruby
+class TestService
+  include ServiceInterface
+
+  arguments :word, count: 5, suffix: nil
+
+  def execute
+    (Array.new(@count, @word) << @suffix).compact.join(', ')
+  end
+end
+```
+
+Then invoke the class like so:
+
+```
+TestService.execute(word: 'Ruby', suffix: 'Yay!')
+=> 'Ruby, Ruby, Ruby, Ruby, Ruby, Yay!'
+```
+
+The equivalent code, written without ServiceInterface, would look something like this:
+
+```ruby
+class TestService
+  def self.execute(word:, count: 5, suffix: nil)
+    new(
+      word: word,
+      count: count,
+      suffix: suffix
+    ).execute
+  end
+
+  def initialize(word:, count:, suffix:)
+    @word = word
+    @count = count
+    @suffix = suffix
+  end
+
+  def execute
+    (Array.new(@count, @word) << @suffix).compact.join(', ')
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GlenCrawford/service_interface.
+
+## 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/service_interface.rb

@@ -0,0 +1,109 @@
+require 'service_interface/version'
+
+require 'active_support'
+require 'active_support/core_ext/object/inclusion'
+
+module ServiceInterface
+  extend ActiveSupport::Concern
+
+  class Argument
+    attr_reader :name, :default_value
+
+    def initialize(name:, required:, default_value: nil)
+      @name = name
+      @required = required
+      @default_value = default_value
+    end
+
+    def required?
+      @required
+    end
+
+    def optional?
+      !@required
+    end
+  end
+
+  class_methods do
+    # Instance methods can't access class-level instance variables (because of the one @, they look for an instance variable), so define a getter method for them to use.
+    def _arguments
+      @_arguments
+    end
+
+    # Build a collection of arguments, with their names and default values, and store it in a class-level instance variable.
+    def arguments(*arguments)
+      optional_arguments_with_default_values = arguments.extract_options!
+      required_arguments = arguments
+
+      @_arguments = []
+
+      required_arguments.each do |name|
+        @_arguments << Argument.new(name: name, required: true)
+      end
+
+      optional_arguments_with_default_values.each do |name, default_value|
+        @_arguments << Argument.new(name: name, required: false, default_value: default_value)
+      end
+    end
+
+    def execute(arguments = {})
+      new(arguments).send(:execute)
+    end
+  end
+
+  # Instance methods.
+  included do
+    def initialize(arguments = {})
+      _raise_error_if_any_undeclared_arguments_specified(arguments)
+      _set_arguments(arguments)
+      _configure_execute_instance_method
+    end
+
+    def _raise_error_if_any_undeclared_arguments_specified(arguments)
+      undeclared_arguments = arguments.reject do |name, value|
+        name.in?(self.class._arguments.map(&:name))
+      end
+
+      raise ArgumentError, "Unrecognized arguments specified: #{undeclared_arguments.keys.join(', ')}" if undeclared_arguments.any?
+    end
+
+    def _set_arguments(arguments)
+      arguments_set = _set_specified_arguments(arguments)
+      arguments_set += _set_default_values_for_optional_arguments(arguments_set)
+      _raise_error_if_any_required_arguments_not_set(arguments_set)
+    end
+
+    def _set_specified_arguments(arguments)
+      arguments.map do |name, value|
+        instance_variable_set("@#{name}", value)
+        name
+      end
+    end
+
+    # Set the values for optional arguments (which have default values) that were not specified at initialization.
+    def _set_default_values_for_optional_arguments(arguments_already_set)
+      self.class._arguments.map do |argument|
+        next if argument.name.in?(arguments_already_set)
+        next unless argument.optional?
+
+        instance_variable_set("@#{argument.name}", argument.default_value)
+        argument.name
+      end.compact
+    end
+
+    def _raise_error_if_any_required_arguments_not_set(arguments_set)
+      required_arguments_not_set = self.class._arguments.select(&:required?).reject do |argument|
+        argument.name.in?(arguments_set)
+      end
+
+      raise ArgumentError, "Required arguments (with no default value) not specified: #{required_arguments_not_set.map(&:name).join(', ')}" if required_arguments_not_set.any?
+    end
+
+    # Mark the execute instance method as private (so no one can initialize the service class manually and call the execute instance method themselves, thereby bypassing the interface).
+    def _configure_execute_instance_method
+      self.class.class_eval do
+        private :execute
+      end
+    end
+  end
+end

data/lib/service_interface/version.rb

@@ -0,0 +1,3 @@
+module ServiceInterface
+  VERSION = '1.0.0'
+end

data/service_interface.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_interface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service_interface'
+  spec.version       = ServiceInterface::VERSION
+  spec.authors       = ['Glen Crawford']
+
+  spec.summary       = 'Ruby module to provide a strict, boilerplate interface for service classes.'
+  spec.homepage      = 'https://github.com/GlenCrawford/service_interface'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |file| file.match(%r{^(spec)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: service_interface
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Glen Crawford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/service_interface.rb
+- lib/service_interface/version.rb
+- service_interface.gemspec
+homepage: https://github.com/GlenCrawford/service_interface
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ruby module to provide a strict, boilerplate interface for service classes.
+test_files: []