sebastian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de693a44f27ac0fef9f80d070dbd78ff25539d449649de9da9851751f7928c9a
+  data.tar.gz: afaa439a236276acc8b8abcfb1d3f3378bbfeaa1e1d1845d4beefb3051f872f7
+SHA512:
+  metadata.gz: e32393427345236bdbfdd5cd2b13bd301f9bf80084899837a3b9667fcd0ba076898058b43d1bd746554c37af2f61de57a8d8ab1e69bc2122546134e0db84ecf8
+  data.tar.gz: 8ce143e656e546682d45dd50635c05c926974f891f4da5307a952b31eabe209b3b68f2b8cc95104b478ff71a98db273f61f05d276304767cb7dda005e04e9ee0

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.4
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+Style/FrozenStringLiteralComment:
+  Description: 'Ruby 3.0 transition for frozen string literals'
+  Enabled: false
+Style/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Documentation:
+  Exclude:
+    - 'spec/**/*.rb'

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 PayPro
+
+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,94 @@
+# Sebastian
+
+Sebastian makes it easy for you to have service objects in Ruby. It gives you a place to put your business logic.
+It also helps you write safer code by validating that your inputs conform to your expectations.
+
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'sebastian'
+```
+
+Or install it manually:
+```
+$ gem install sebastian
+```
+## Usage
+
+To define a service object, create a subclass of Sebastian::Base. Then you need to do two things:
+
+1. **Define your attributes.**
+2. **Define your business logic.** Do this by implementing the #execute method. Each attribute you defined will be available. If any of the attributes are invalid, `#execute` won't be run.
+
+That covers the basics. Let's put it all together into a simple example that squares a number.
+
+```ruby
+class CreatePayment < Sebastian::Base
+  attr_accessor :amount
+  attr_accessor :email
+
+  validates :amount, numericality: { only_integer: true }
+
+  private
+
+  def execute
+    'payment_created' if create_payment
+    errors.add(:payment)
+  end
+
+  def create_payment
+    Payment.create!(customer: create_customer, amount: amount)
+  end
+
+  def create_customer
+    Customer.create!(email: email)
+  end
+end
+```
+
+Call `.perform` on your service to execute it. You must pass a single hash to `.perform`. It will return an instance of your service. By convention, we call this an result. You can use the `#ok?` method to ask the result if it's ok. If it's not ok, take a look at its errors with `#errors`. When `#ok?`, the value returned from `#execute` will be stored in `#value`.
+
+```ruby
+result = CreatePayment.perform(email: 'ciel@phantomhive.com', amount: 500)
+result.ok?
+# => true
+result.value
+# => "payment_created"
+
+result = CreatePayment.perform(amount: 500)
+result.ok?
+# => false
+result.errors.messages
+# => {:payment=>["is not a valid"]}
+result.value
+# => Sebastian::ResultHasErrorsError: Cannot call value while the service has errors, you should call #ok? first to check
+```
+
+### Validations
+
+These validations aren't provided by Sebastian. They're from ActiveModel. You can also use any custom validations you wrote yourself in your services.
+
+```ruby
+result = CreatePayment.perform(email: 'ciel@phantomhive.com', amount: '5,00')
+result.ok?
+# => false
+result.errors.messages
+# => {:amount=>["is not a number"]}
+```
+
+## 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/paypronl/sebastian.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sebastian'
+
+# 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/sebastian/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sebastian
+  # Provides service functionality. Subclass this to create an service.
+  #
+  # Example:
+  #   class ExampleService < Sebastian::Base
+  #     # Required
+  #     attr_accessor :foo
+  #     attr_accessor :bar
+  #
+  #     def execute
+  #       foo + bar
+  #     end
+  #   end
+  #
+  #   result = ExampleService.perform(foo: 10, bar: 5)
+  #   if result.ok?
+  #     result.value
+  #   else
+  #     result.errors
+  #   end
+  class Base
+    include ActiveModel::AttributeAssignment
+    include ActiveModel::Validations
+    extend ActiveModel::Translation
+
+    class << self
+      def perform(params = {})
+        new(params).perform
+      end
+    end
+
+    def initialize(params = {})
+      assign_attributes(params)
+    end
+
+    def perform
+      Result.new(value: valid? ? execute : nil, errors: errors)
+    end
+
+    protected
+
+    def execute
+      raise NotImplementedError, "Must implement #execute in #{self.class} to make the service work"
+    end
+
+    def ok?
+      errors.empty?
+    end
+  end
+end

data/lib/sebastian/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sebastian
+  # Top-level error class. All other errors subclass this.
+  Error = Class.new(StandardError)
+
+  # Raised if execute is not implemented on subclass.
+  NotImplementedError = Class.new(Error)
+
+  # Raised if value is called while there are errors.
+  ResultHasErrorsError = Class.new(Error)
+end

data/lib/sebastian/result.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sebastian
+  # Invokes the supplied block and wraps the return value in a Sebastian::Result object.
+  #
+  # Example:
+  #   result = Sebastian::Result.new(value: 'foo')
+  #   result.ok?
+  #     # => true
+  #   result.value
+  #     # => 'foo'
+  #
+  #   result = Sebastian::Result.new(value: 'foo', errors: ['bar'])
+  #   result.ok?
+  #     # => false
+  #   result.value
+  #     # => Sebastian::ServiceReturnedErrorsError
+  class Result
+    attr_reader :errors
+
+    def initialize(value:, errors:)
+      @value = value
+      @errors = errors
+    end
+
+    def ok?
+      @errors.empty?
+    end
+
+    def value
+      return @value if ok?
+      raise(
+        ResultHasErrorsError,
+        'Cannot call value while the service has errors, you should call #ok? first to check'
+      )
+    end
+
+    def to_s
+      if ok?
+        "#<Sebastian::Result value: #{@value.inspect}>"
+      else
+        "#<Sebastian::Result errors: #{@errors.details.inspect}>"
+      end
+    end
+
+    alias inspect to_s
+  end
+end

data/lib/sebastian/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sebastian
+  VERSION = '0.1.0'.freeze
+end

data/lib/sebastian.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+# Demon Butler
+module Sebastian
+end
+
+require 'sebastian/version'
+require 'sebastian/errors'
+
+require 'sebastian/result'
+require 'sebastian/base'

data/sebastian.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sebastian/version'
+
+Gem::Specification.new do |gem|
+  gem.name     = 'sebastian'
+  gem.version  = Sebastian::VERSION
+  gem.authors  = ['Sander Tuin']
+  gem.email    = ['sander@paypro.nl']
+
+  gem.summary  = 'Your personal demon butler at your services.'
+  gem.homepage = 'https://github.com/paypronl/sebastian'
+  gem.license  = 'MIT'
+
+  gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 2.2.2'
+
+  gem.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  gem.add_dependency 'activemodel', '>= 4', '< 6'
+
+  gem.add_development_dependency 'bundler', '~> 1.16'
+  gem.add_development_dependency 'pry', '~> 0.11'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: sebastian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sander Tuin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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'
+description: 
+email:
+- sander@paypro.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sebastian.rb
+- lib/sebastian/base.rb
+- lib/sebastian/errors.rb
+- lib/sebastian/result.rb
+- lib/sebastian/version.rb
+- sebastian.gemspec
+homepage: https://github.com/paypronl/sebastian
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Your personal demon butler at your services.
+test_files: []