sebastian 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a35d63983f5e2eaedd683ffc4b2c9c3d98a957e8d8e444ba443dcad89d46f08e
-  data.tar.gz: 30d960204eed664fd943d4836db07dec49dea38704f94ff104d93a22e83ad967
+  metadata.gz: 9ab2d8d9e8a7fbc7a094400734528428bf2a8e9892b3ebaecdf8294d16ee4228
+  data.tar.gz: 3e15780d1c06f21f3e02d81c500d86d05f66f7feb7fe6712139b8d5f64965ad5
 SHA512:
-  metadata.gz: 884b593eddc3e221cdeb10d2e3fe4c2b60b74a6c7199ce6d764e64d0d9e4c5e02b744406ab46d0d2a96e26e55890bfe47bcec8aa410e8429a4f47654d1c07304
-  data.tar.gz: 43bb1ebdf5e098af0e2ebc2d85e3ac433277f1e7954c599eb8f2fb68af29815239940c57c69f69d798b66cbdd0e8d6bc79fc10622adb72a61e785dd5b6ae8390
+  metadata.gz: fafc2308d0dfa6fa55da5ab486953941f202d5ba004fc2e0c648146227e66a8281e171371b33e99f4d77603dc28e137253db1fd71a91a572c1262e9ee8b5f4de
+  data.tar.gz: 89c012ce7d31517d427d995ccee0eb3b1654e8e89e4e928923fefaef13c25856d52c84dba100f963be2ab2845ef4aefb7b8aa9631328d6694921329d8c9309eb

data/README.md

@@ -30,8 +30,8 @@ That covers the basics. Let's put it all together into a simple example that squ
 
 ```ruby
 class CreatePayment < Sebastian::Base
-  attr_accessor :amount
-  attr_accessor :email
+  param :amount
+  param :email
 
   validates :amount, numericality: { only_integer: true }
 
@@ -43,11 +43,11 @@ class CreatePayment < Sebastian::Base
   end
 
   def create_payment
-    Payment.create!(customer: create_customer, amount: amount)
+    Payment.create(customer: create_customer, amount: amount)
   end
 
   def create_customer
-    Customer.create!(email: email)
+    Customer.create(email: email)
   end
 end
 ```
@@ -66,8 +66,17 @@ 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
+result.value!
+# => Sebastian::InvalidResultError: Payment is not valid
+```
+
+You can also use `.perform!` to execute. It's like `.perform` but more dangerous. It doesn't return an result. If the result would be invalid, it will instead raise an error. But if the result would be valid, it simply returns the value.
+
+```ruby
+CreatePayment.perform!(email: 'ciel@phantomhive.com', amount: 500)
+# => "payment_created"
+CreatePayment.perform!(amount: 500)
+# =>
 ```
 
 ### Validations
@@ -75,11 +84,22 @@ result.value
 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')
+class ValidatePayment < Sebastian::Validation
+  params :amount, :email
+
+  validates :email, presence: true
+  validates :amount, numericality: { only_integer: true }
+end
+```
+
+This works the same as `Sebastian::Base` except that it is not needed to specify `#execute`.
+
+```ruby
+result = ValidatePayment.perform(amount: '5,00')
 result.ok?
 # => false
 result.errors.messages
-# => {:amount=>["is not a number"]}
+# => {{:email=>["can't be blank"], :amount=>["is not a number"]}
 ```
 
 ## Development

data/lib/sebastian/base.rb

@@ -29,6 +29,13 @@ module Sebastian
       def perform(params = {})
         new(params).perform
       end
+
+      def perform!(params = {})
+        new(params).perform!
+      end
+
+      alias params attr_accessor
+      alias param params
     end
 
     def initialize(params = {})
@@ -39,6 +46,10 @@ module Sebastian
       Result.new(value: valid? ? execute : nil, errors: errors)
     end
 
+    def perform!
+      perform.value!
+    end
+
     protected
 
     def execute

data/lib/sebastian/errors.rb

@@ -8,5 +8,5 @@ module Sebastian
   NotImplementedError = Class.new(Error)
 
   # Raised if value is called while there are errors.
-  ResultHasErrorsError = Class.new(Error)
+  InvalidResultError = Class.new(Error)
 end

data/lib/sebastian/result.rb

@@ -13,10 +13,10 @@ module Sebastian
   #   result = Sebastian::Result.new(value: 'foo', errors: ['bar'])
   #   result.ok?
   #     # => false
-  #   result.value
+  #   result.value!
   #     # => Sebastian::ServiceReturnedErrorsError
   class Result
-    attr_reader :errors
+    attr_reader :errors, :value
 
     def initialize(value:, errors:)
       @value = value
@@ -27,12 +27,9 @@ module Sebastian
       @errors.empty?
     end
 
-    def value
+    def value!
       return @value if ok?
-      raise(
-        ResultHasErrorsError,
-        'Cannot call value while the service has errors, you should call #ok? first to check'
-      )
+      raise InvalidResultError, errors.full_messages.join(', ')
     end
 
     def to_s

data/lib/sebastian/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sebastian
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sander Tuin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel