active_interactor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a761bddc4060235798798e1a3b7001e7e8fc902285f01acf79b76bb31864e9e
+  data.tar.gz: 654e5b1c3172279542b10287b06012d18dec61a5bdd3effbebf28da828a0c198
+SHA512:
+  metadata.gz: 63ce5b912ecf04f716a319eab43ca3434619bc4d6c330da8522a2c23db06f0f3d9e6c74e8005d9a7d88c65c9e76016cec7a04637353c124c7e46e3a90612a5c8
+  data.tar.gz: c7a11cb8f47b9e10d9023b432433ae574e6e8be67b6e29d73e48a3ac202eb76bc218dc3d13caff0cb579377dd22a846d1323487da2b9afd4e943fff4d34508fc

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tags
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3
+notifications:
+  email: false
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake spec
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## 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.
+
+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,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at taka84u9@gmail.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
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_interactor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Increments Inc.
+
+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,173 @@
+# ActiveInteractor
+
+[![Gem](https://img.shields.io/gem/v/active_interactor.svg)](https://rubygems.org/gems/active_interactor)
+[![Build Status](https://travis-ci.org/increments/active_interactor.svg?branch=master)](https://travis-ci.org/increments/active_interactor)
+[![Code Climate](https://codeclimate.com/github/increments/active_interactor/badges/gpa.svg)](https://codeclimate.com/github/increments/active_interactor)
+[![Test Coverage](https://codeclimate.com/github/increments/active_interactor/badges/coverage.svg)](https://codeclimate.com/github/increments/active_interactor/coverage)
+[![license](https://img.shields.io/github/license/increments/active_interactor.svg)](https://github.com/increments/active_interactor/blob/master/LICENSE)
+
+Simple use case interactor for Rails apps based on ActiveModel.
+
+It is heavily inspired by [Hanami::Interactor](http://hanamirb.org/guides/1.2/architecture/interactors/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_interactor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_interactor
+
+## Usage
+
+Include `ActiveInteractor` into a class to define your interactor. It must implement `#call` method
+and may declare which instance variables to be exposed:
+
+```rb
+class CreateProduct
+  include ActiveInteractor
+
+  expose :product
+
+  def initialize(repository: ProductRepository)
+    @repository = repository
+  end
+
+  def call(attributes)
+    @product = @repository.create(attributes)
+  end
+end
+```
+
+Calling an interactor instance returns a `ActiveInteractor::Result`. It has success or failure state:
+
+```rb
+result = CreateProduct.new.call(params)
+result.is_a? ActiveInteractor::Result #=> true
+result.success? # `true` or `false`. In this case `true`
+result.failure? # opposite of #success?
+```
+
+It responds to the exposed messages above:
+
+```rb
+result.product #=> The object returned by `@repository.create`
+result.repository #=> NeMethodError
+```
+
+You may use the interactor in your controllers:
+
+```rb
+class ProductsController < ApplicationController
+  def create
+    result = CreateProduct.new.call(product_params)
+    if result.success?
+      redirect_to result.product
+    else
+      @errors = result.errors
+      render :edit
+    end
+  end
+
+  private
+
+  def product_params
+    params.require(:product).permit(:name)
+  end
+end
+```
+
+### Failure
+
+Adding a message to `#errors` causes failure result.
+
+```rb
+def call(*)
+  errors.add(:base, 'fail')
+end
+```
+
+```rb
+result = FailureInteractor.new.call
+
+result.success? #=> false
+result.errors.full_messages_for(:base) #=> ['fail']
+```
+
+You can use `#merge_errors` utility to merge another `ActiveModel::Errors` into `#errors`:
+
+```rb
+def call(params)
+  @product = @repository.create(params)
+  # Return failure result if @product is invalid
+  merge_errors(@product.errors) if @product.invalid?
+end
+```
+
+### Validation
+
+```rb
+class CreateProduct
+  include ActiveInteractor
+
+  # Declare all key names
+  validations(:name) do
+    # Write your validation rules with Rails DSL    
+    validates :name, presence: true
+  end
+
+  call(params)
+    # You can assume `params` pass the validations described above.
+    # If some validation fails, this method isn't invoked.
+  end
+end
+```
+
+```rb
+result = CreateProduct.new.call(name: nil)
+result.success? #=> false
+result.errors.full_messages_for(:name) #=> ["name can't be blank"]
+```
+
+### I18n
+
+```yaml
+ja:
+  activeinteractor:
+    models:
+      create_product: :activerecord:models:product
+    attributes:
+      create_product: :activerecord:attributes:product
+    errors:
+      models:
+        create_product:
+          attributes:
+            name:
+              blank: を入力してください
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/increments/active_interactor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveInteractor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/increments/active_interactor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/active_interactor.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_interactor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_interactor'
+  spec.version       = ActiveInteractor::VERSION
+  spec.authors       = ['Yuku TAKAHASHI']
+  spec.email         = ['yuku@qiita.com']
+
+  spec.summary       = 'Simple use case interactor for Rails apps based on ActiveModel'
+  spec.homepage      = 'https://github.com/yuku/active_interactor'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '~> 5.0'
+  spec.add_dependency 'activesupport', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.29'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_interactor'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_interactor/version.rb

@@ -0,0 +1,3 @@
+module ActiveInteractor
+  VERSION = '0.1.0'.freeze
+end

data/lib/active_interactor.rb

@@ -0,0 +1,215 @@
+require 'active_support'
+require 'active_model'
+
+require 'active_interactor/version'
+
+# ActiveInteractor.
+#
+# @example
+#   class CreateProduct
+#     include ActiveInteractor
+#
+#     expose :product
+#
+#     validations(:name, :price) do
+#       validates :name, presence: true, length: { maximum: 50 }
+#       validates :price, presence: true, numericality: { only_integer: true }
+#     end
+#
+#     def initialize(repository)
+#       @repository = repository
+#     end
+#
+#     def call(attributes)
+#       @product = @repository.create(attributes)
+#     end
+#   end
+module ActiveInteractor
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Configure {.validator_class}
+    #
+    # @param attribute_names [Array<Symbol>] list of
+    # @yield
+    # @return [void]
+    def validations(*attribute_names, &block)
+      @validation_attribute_names = attribute_names
+      validator_class.class_eval do
+        attr_accessor(*attribute_names)
+      end
+      validator_class.class_eval(&block)
+    end
+
+    # @return [Class]
+    def validator_class
+      @validator_class ||= build_validator_class
+    end
+
+    # Expose local instance variables into the returning value of {#call}
+    #
+    # @param instance_variable_names [Array<Symbol>]
+    def expose(*instance_variable_names)
+      instance_variable_names.each do |name|
+        exposures[name.to_sym] = "@#{name}"
+      end
+    end
+
+    # @return [Hash]
+    def exposures
+      @exposures ||= {}
+    end
+
+    # @return [Array<Symbol>]
+    def validation_attribute_names
+      @validation_attribute_names || []
+    end
+
+    # @return [Boolean]
+    def validation_required?
+      validation_attribute_names.present?
+    end
+
+    private
+
+    # @return [Class]
+    def build_validator_class
+      klass = Class.new do
+        include ActiveModel::AttributeAssignment
+        include ActiveModel::Validations
+        extend ActiveModel::Translation
+
+        # @note {ActiveModel::Translation} expects anonymous class to implement {.name}
+        cattr_accessor :name
+
+        # @note Override {ActiveModel::Translation::ClassMethods#i18n_scope}
+        def self.i18n_scope
+          :activeinteractor
+        end
+      end
+      klass.name = name || 'ActiveInteractor' # Fallback for anonymous classes
+      klass
+    end
+  end
+
+  included do
+    prepend ActiveInteractor::Interface
+    attr_reader :errors
+  end
+
+  # Interactor interface.
+  module Interface
+    # rubocop:disable all
+
+    # @param args [Array<(nil)>, Array<(Hash)>]
+    # @return [ActiveInteractor::Result]
+    def call(*args)
+      raise ArgumentError if args.size > 1
+      raise ArgumentError if args.size == 1 && !args.first.is_a?(Hash)
+
+      params = args.extract_options!
+      validator = self.class.validator_class.new
+
+      if params.empty? && !self.class.validation_required?
+        @errors = validator.errors
+        super
+      else
+        params = sanitize(params)
+        @errors = validate(params)
+        super(params) if @errors.empty?
+      end
+
+      Result.new(result_payload, @errors)
+    end
+
+    # rubocop:enable all
+  end
+
+  # Result of an operation.
+  class Result
+    # @return [ActiveModel::Errors]
+    attr_reader :errors
+
+    # Concrete methods
+    #
+    # @see ActiveInteractor::Result#respond_to_missing?
+    METHODS = Set.new(%i[initialize success? failure?])
+
+    # @param payload [Hash]
+    # @param errors [ActiveModel::Errors]
+    def initialize(payload, errors)
+      @payload = payload.symbolize_keys
+      @errors = errors
+    end
+
+    # @return [Boolean]
+    def success?
+      !failure?
+    end
+
+    # @return [Boolean]
+    def failure?
+      errors.present?
+    end
+
+    private
+
+    def method_missing(method_name, *)
+      @payload.fetch(method_name) { super }
+    end
+
+    def respond_to_missing?(method_name, _include_all)
+      method_name = method_name.to_sym
+      METHODS.include?(method_name) || @payload.key?(method_name)
+    end
+  end
+
+  def call(*)
+    raise NotImplementedError
+  end
+
+  # Merge the given errors into {#errors}.
+  #
+  # @param additional_errors [ActiveModel::Errors]
+  # @return [void]
+  def merge_errors(additional_errors)
+    additional_errors.full_messages.each do |message|
+      errors.add(:base, message)
+    end
+  end
+
+  private # rubocop:disable Lint/UselessAccessModifier
+
+  # @return [Hash] a hash representing a payload for {ActiveInteractor::Result}
+  def result_payload
+    Hash[].tap do |result|
+      self.class.exposures.each do |name, ivar|
+        result[name] = instance_variable_defined?(ivar) ? instance_variable_get(ivar) : nil
+      end
+    end
+  end
+
+  # @param args [Hash]
+  # @return [ActiveModel::Errors]
+  def validate(params)
+    validator = self.class.validator_class.new
+    if self.class.validation_required?
+      validator.assign_attributes(params)
+      validator.valid?
+    end
+    validator.errors
+  end
+
+  # Remove undeclared keys from the given params.
+  #
+  # @param params [Hash]
+  # @return [Hash]
+  def sanitize(params)
+    return params unless self.class.validation_required?
+    Hash[].tap do |result|
+      self.class.validation_attribute_names.each do |name|
+        result[name] = params[name]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: active_interactor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuku TAKAHASHI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: 
+email:
+- yuku@qiita.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_interactor.gemspec
+- bin/console
+- bin/setup
+- lib/active_interactor.rb
+- lib/active_interactor/version.rb
+homepage: https://github.com/yuku/active_interactor
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple use case interactor for Rails apps based on ActiveModel
+test_files: []