faire 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bb2a13cbd53ef37d79d7eb3b446af1f9891e8be
+  data.tar.gz: 8da189e4f4c2db7f23a9e6e0f8dc538e31db2b5d
+SHA512:
+  metadata.gz: 84d58898a6fa8eec92fa28826277a25f178df523608b61619a958f4a7ace7c05ec5f3d48ece582e697c0078c59b60eba07c66e5d3993d3c558d6ea958236e07e
+  data.tar.gz: 7009651f627620ade4429679e6b9d5d819983d1f6b7120655d26784689987fa0563a293e58554e1d5cef5377b53eec97703a3d0abbc0b7b808a6712806904a4a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faire.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michal Krzyzanowski
+
+MIT License
+
+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 @@
+# Faire
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faire'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faire
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/faire.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faire"
+  spec.version       = Faire::VERSION
+  spec.authors       = ["Michal Krzyzanowski"]
+  spec.email         = ["michal.krzyzanowski+github@gmail.com"]
+  spec.description   = %q{Manage application logic with Interactors}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/chaps-io/faire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", "~> 1.0.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.8.1"
+end

data/lib/faire.rb

@@ -0,0 +1,18 @@
+require "virtus"
+require "faire/version"
+require "faire/input"
+require "faire/interactor"
+require "faire/runner"
+require "faire/attributes"
+require "faire/error"
+require "faire/validator"
+
+module Faire
+  def self.included(base)
+    base.include(Virtus.model)
+    base.include(Validator)
+
+    base.extend(Attributes)
+    base.extend(Runner)
+  end
+end

data/lib/faire/attributes.rb

@@ -0,0 +1,44 @@
+module Faire
+  module Attributes
+    def required_inputs
+      inputs.select(&:required?)
+    end
+
+    def inputs
+      @inputs ||= []
+    end
+
+    def defaults
+      { nullify_blank: true, required: true }.freeze
+    end
+
+    def string(name, attributes = {})
+      input(name, String, attributes)
+    end
+
+    def object(name, klass, attributes = {})
+      klass.include(Virtus.model)
+
+      input(name, klass, attributes)
+    end
+
+    def input(name, klass, attributes)
+      attrs = defaults.merge(attributes)
+
+      self.inputs << Input.new(name, String, attrs)
+      self.attribute(name, klass, attrs)
+    end
+
+    def integer(name, attributes = {})
+      input(name, Integer, attributes)
+    end
+
+    def float(name, attributes = {})
+      input(name, Float, attributes)
+    end
+
+    def date(name, attributes = {})
+      input(name, Date, attributes)
+    end
+  end
+end

data/lib/faire/error.rb

@@ -0,0 +1,6 @@
+module Faire
+  module Error
+    RequiredParametersMissing = Class.new(StandardError)
+    CoercionError = Class.new(StandardError)
+  end
+end

data/lib/faire/input.rb

@@ -0,0 +1,15 @@
+module Faire
+  class Input
+    attr_reader :name
+
+    def initialize(name, klass, **attributes)
+      @name = name
+      @attributes = attributes
+      @required = attributes.fetch(:required, false)
+    end
+
+    def required?
+      @required == true
+    end
+  end
+end

data/lib/faire/interactor.rb

@@ -0,0 +1,33 @@
+module Faire
+  class Interactor
+    extend Forwardable
+    attr_reader :object
+
+    def_delegators :object, :validate, :execute, :valid?
+
+    def initialize(object)
+      @object = object
+    end
+
+    def validate_and_execute
+      validate
+      result
+    end
+
+    def result
+      @result ||= execute if valid?
+    end
+
+    def errors
+      @errors ||= object.errors
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def fail?
+      errors.any?
+    end
+  end
+end

data/lib/faire/runner.rb

@@ -0,0 +1,14 @@
+module Faire
+  module Runner
+    def run(input = {})
+      object = new(input)
+      Interactor.new(object).tap(&:validate_and_execute)
+    end
+
+    def run!(input = {})
+      interactor = new(input)
+      interactor.validate!
+      interactor.execute
+    end
+  end
+end

data/lib/faire/validator.rb

@@ -0,0 +1,15 @@
+module Faire
+  module Validator
+    def validate!
+      validate || (raise Error::RequiredParametersMissing, "required parameters missing")
+    end
+
+    def validate
+      @valid = self.class.required_inputs.all?{|object| self.public_send(object.name) }
+    end
+
+    def valid?
+      @valid == true
+    end
+  end
+end

data/lib/faire/version.rb

@@ -0,0 +1,3 @@
+module Faire
+  VERSION = "0.0.1"
+end

data/test/faire_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+class FaireTest < MiniTest::Test
+  def test_run_returns_output_if_input_is_correct
+    interactor = SampleInteraction.run!(name: "asd", bill: { name: "ZOMG" }, other: 123)
+    assert_equal Bill, interactor.class
+  end
+
+  def test_run_raises_error_if_input_is_incorrect
+    assert_raises Faire::Error::RequiredParametersMissing do
+      SampleInteraction.run!(bill: { name: "ZOMG" }, other: 123)
+    end
+  end
+
+  def test_run_returns_interactor_class_if_output_is_correct
+    interactor = SampleInteraction.run(name: "asd", bill: { name: "ZOMG" }, other: 123)
+    assert_equal Faire::Interactor, interactor.class
+    assert_equal "ZOMG", interactor.result.name
+  end
+end

data/test/support/sample_interaction.rb

@@ -0,0 +1,17 @@
+class Bill
+  include Virtus.model
+
+  attribute :name
+end
+
+class SampleInteraction
+  include Faire
+
+  integer :name, nullify_blank: true
+  string :other, required: false
+  object :bill, Bill
+
+  def execute
+    bill
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "faire"
+require "minitest/autorun"
+require_relative "support/sample_interaction"

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: faire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michal Krzyzanowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.1
+description: Manage application logic with Interactors
+email:
+- michal.krzyzanowski+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faire.gemspec
+- lib/faire.rb
+- lib/faire/attributes.rb
+- lib/faire/error.rb
+- lib/faire/input.rb
+- lib/faire/interactor.rb
+- lib/faire/runner.rb
+- lib/faire/validator.rb
+- lib/faire/version.rb
+- test/faire_test.rb
+- test/support/sample_interaction.rb
+- test/test_helper.rb
+homepage: https://github.com/chaps-io/faire
+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.4.8
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/faire_test.rb
+- test/support/sample_interaction.rb
+- test/test_helper.rb