actioninteractor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b9d6bcadf157aa9c5cf6b53013d202c56d6c491f28e6c67b147a159f8e22691
+  data.tar.gz: 9128ef16b78b62df8fb9559439473ce6d6de454fd37e2ff2d0b25bbedd8d3a3e
+SHA512:
+  metadata.gz: 5190327cabe972bb1d4b0642a49f70846bb4dde510961cec0915962f99cf17c95558214612aeadce3f3c7ef150cb64345c75f8e5e7a1a321832b66494ceb3f05
+  data.tar.gz: c46c01ec2ed63e45585bfb5e53f95d6b4df086c6e455aa72feed0ba4af61afbebf76df05218042d1829d1e2c6ac98f79662eaac20fc72397d500d975f54c1b2a

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+
+desc "Default Task"
+task default: [ :test ]
+
+task :package
+
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+  t.verbose = true
+  t.ruby_opts = ["--dev"] if defined?(JRUBY_VERSION)
+}
+
+namespace :test do
+  task :isolated do
+    Dir.glob("test/**/*_test.rb").all? do |file|
+      sh(Gem.ruby, "-w", "-Ilib:test", file)
+    end || raise("Failures")
+  end
+end

data/actioninteractor.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+version = File.read(File.expand_path("../LIGHTRAILS_VERSION", __dir__)).strip
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "actioninteractor"
+  s.version     = version
+  s.date        = "2018-10-03"
+  s.summary     = "Action Interactor provides a simple interface for performing operations (part of Lightrails)."
+  s.description = "Action Interactor provides a simple interface for performing operations like Service Object / Command pattern."
+
+  s.required_ruby_version     = ">= 2.2.2"
+  s.required_rubygems_version = ">= 1.8.11"
+
+  s.license       = "MIT"
+
+  s.authors     = ["Ryo Hashimoto"]
+  s.email       = "ryohashimoto@gmail.com"
+  s.homepage    = "https://github.com/ryohashimoto/lightrails"
+
+  s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(/^test/)
+
+  s.add_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake", "~> 0"
+end

data/lib/base.rb

@@ -0,0 +1,64 @@
+module ActionInteractor
+  class Base
+    attr_reader :params, :result
+
+    def initialize(params)
+      @params = params
+      reset!
+    end
+
+    def execute
+      return if completed?
+      finish!
+    end
+
+    def completed?
+      @completed
+    end
+
+    def success?
+      @success
+    end
+
+    def failure?
+      !success?
+    end
+
+    def reset!
+      @result = {}
+      fail!
+      incomplete!
+    end
+
+    def finish!
+      success!
+      complete!
+    end
+
+    def success!
+      @success = true
+    end
+
+    def fail!
+      @success = false
+    end
+
+    def complete!
+      @completed = true
+    end
+
+    def incomplete!
+      @completed = false
+    end
+
+    def add_result(key, value)
+      @result[key] = value
+    end
+
+    class << self
+      def execute(params)
+        new(params).tap(&:execute)
+      end
+    end
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,33 @@
+require "test/unit"
+require_relative "../lib/base.rb"
+
+class BaseTest < Test::Unit::TestCase
+  test ".execute does not raise error" do
+    params = {}
+    assert_nothing_raised { ActionInteractor::Base.execute(params) }
+  end
+
+  test ".execute returns an ActionInteractor::Base instance" do
+    params = {}
+    interactor = ActionInteractor::Base.execute(params)
+    assert_instance_of(ActionInteractor::Base, interactor)
+  end
+
+  test "the result is an empty hash" do
+    params = {}
+    interactor = ActionInteractor::Base.execute(params)
+    assert_equal({}, interactor.result)
+  end
+
+  test "#success? is true" do
+    params = {}
+    interactor = ActionInteractor::Base.execute(params)
+    assert interactor.success?
+  end
+
+  test "#completed? is true" do
+    params = {}
+    interactor = ActionInteractor::Base.execute(params)
+    assert interactor.completed?
+  end
+end

data/test/inheritance_test.rb

@@ -0,0 +1,56 @@
+require "test/unit"
+require_relative "../lib/base.rb"
+
+class User
+  attr_accessor :name
+
+  def initialize(params)
+    @name = params[:name]
+  end
+end
+
+class RegistrationInteractor < ActionInteractor::Base
+  def execute
+    return unless params[:name]
+    add_result(:user, User.new(name: params[:name]))
+    finish!
+  end
+end
+
+class InheritanceTest < Test::Unit::TestCase
+  test ".execute does not raise error" do
+    params = { name: 'John'}
+    assert_nothing_raised { RegistrationInteractor.execute(params) }
+  end
+
+  test ".execute returns an RegistrationInteractor instance" do
+    params = { name: 'John'}
+    interactor = RegistrationInteractor.execute(params)
+    assert_instance_of(RegistrationInteractor, interactor)
+  end
+
+  test "the result contains a user" do
+    params = { name: 'John'}
+    interactor = RegistrationInteractor.execute(params)
+    assert_instance_of(User, interactor.result[:user])
+  end
+
+  test "the result user name is John" do
+    params = { name: 'John'}
+    interactor = RegistrationInteractor.execute(params)
+    user = interactor.result[:user]
+    assert_equal(user.name, 'John')
+  end
+
+  test "#success? is true" do
+    params = { name: 'John'}
+    interactor = RegistrationInteractor.execute(params)
+    assert interactor.success?
+  end
+
+  test "#completed? is true" do
+    params = { name: 'John'}
+    interactor = RegistrationInteractor.execute(params)
+    assert interactor.completed?
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: actioninteractor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Action Interactor provides a simple interface for performing operations
+  like Service Object / Command pattern.
+email: ryohashimoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- actioninteractor.gemspec
+- lib/base.rb
+- test/base_test.rb
+- test/inheritance_test.rb
+homepage: https://github.com/ryohashimoto/lightrails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Action Interactor provides a simple interface for performing operations (part
+  of Lightrails).
+test_files:
+- test/base_test.rb
+- test/inheritance_test.rb