light_service_object 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100d278a461065875533bd01459a32689b7b9decf705b9cd4400675a056ad441
-  data.tar.gz: 7d7bf77c96b317568ad5ddc612f1edf7c864a0cc7970842b5649c3e954a9dccf
+  metadata.gz: 6a4e68067319da840f48462ed29d2fdb32314e14c78c543f6e978b345d2d87b7
+  data.tar.gz: 0fb567f252a98e5bef84d9d2b7db469e86b6b9bdce13038dd701f703c5be474d
 SHA512:
-  metadata.gz: 7ce179e98cee24693c5b9e74645cfa4cb028ed4bd48f0375ce04848323172651033d2878b010ccaa697e371eef97f4f01696c60d12df978785c39a1fc3784a9e
-  data.tar.gz: fca061f22fd49eba170a38486c2a4debe4c2d9e725d01587866c1d69308b828e9680d186406fb1293e29c617117254b23e2b6cea8fbb12ea9853bfdf8d011836
+  metadata.gz: edb266a2036ce57aba328e8c7fe3925b1955accd7537c4cdf7ff8ea14111eaa1234c33c974d611909031869998a648277abff83f4e3431e4391e14443da172f3
+  data.tar.gz: 9e6faf7bd3f116726ab2260401f7d5e9b03c41135c377bf46f37a498ad6c57026928590c147feb442c3b681cbf8c755e4207dbc00b2981869bb70a7ccafb20e0

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    light_service_object (0.1.6)
+      dry-initializer (~> 2.0)
+      dry-monads (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-initializer (2.5.0)
+    dry-monads (1.3.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  light_service_object!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -14,15 +14,59 @@ And then execute:
 
     $ bundle
 
-## Usage
+## A Light Service Object with a Contract
 
-TODO: Write usage instructions here
+Service objects are a great way to encapsulate business/domain functionality in a Rails app.
 
-## Development
+### The Old Way
 
-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.
+They typically wrap some functionality up in a `call` method, with an initializer for setting parameters.
+
+```
+class TypicalServiceObject
+  def initialize(date, number)
+    @date = date
+    @number = number
+  end
+
+  def call
+    @date = Date.parse(@date) if @date.is_a?(String)
+    If @date - Date.today < 7 then
+      @number += 10
+    else
+      raise ArgumentError.new("Date is too far away")
+    end
+    @number
+  end
+end
+```
+
+This service object has a few problems:
+- No indication of what it's "contract" is with the outside world
+- No way to indicate failure other than Exceptions
+- Manual conversion of data into the expected form
+
+### The New Way
+
+```
+class NewServiceObject < LightServiceObject::Base
+  required :date, ensure: Date
+  optional :number
+
+  def perform
+    fail!("Date is too far away") if date - Date.today >= 7 
+    
+    number + 10
+  end
+end
+```
+
+- date is required, a failure will be returned with the error message
+- date will be transformed into a Date if it isn't one already `ensure: Date`
+- `fail!(message)` causes the service to return a failure and message
+- the last thing evaluated will be returned as the result `number + 10`
+- one side note: all parameters are immutable by default
 
-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
 

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/light_service_object/version.rb

@@ -1,3 +1,3 @@
 module LightServiceObject
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/light_service_object.rb

@@ -36,37 +36,55 @@ module LightServiceObject
 
 
     ## — CLASS METHODS
-    def self.result_class
-      @result_class
-    end
+    class << self
+      def result_class
+        @result_class
+      end
 
-    def self.param(key, **options)
-      raise Error.new("Do not use param in a service object")
-    end
+      def param(key, **options)
+        raise Error.new("Do not use param in a service object")
+      end
 
-    def self.required(key, **options)
-      option key, **options
-    end
+      def option(*args, **opts, &block)
+        if opts.delete(:mutable)
+          self.send("attr_writer", args.first)
+        end
+        super(*args, **opts, &block)
+      end
 
-    def self.optional(key, **options)
-      options[:optional] = true
-      option(key, **options)
-    end
+      def required(key, **options)
+        options[:private] = true
+        option(key, **options)
+      end
 
-    def self.expected_result_class(klass)
-      @result_class = klass
-      @result_class = klass.constantize if klass.is_a?(String)
-    end
+      def optional(key, **options)
+        options[:optional] = true
+        options[:private] = true
+        option(key, **options)
+      end
 
-    def self.call(**options)
-      obj = self.new(**options)
+      def expected_result_class(klass)
+        @result_class = klass
+        @result_class = klass.constantize if klass.is_a?(String)
+      end
 
-      # Identify incoming params that weren't specified
-      # set_params = obj.instance_variables.map{|e| e.to_s.tr("@","").to_sym }
-      # unknown_params = (options.keys - set_params)
-      # ap("#{self.name} > Unknown Parameters #{unknown_params}") if unknown_params.present?
+      def call(**options)
+        begin
+          obj = self.new(**options)
+        rescue KeyError => e
+          return  Dry::Monads.Failure(e.message)
+        end
+
+        # Identify incoming params that weren't specified
+        # set_params = obj.instance_variables.map{|e| e.to_s.tr("@","").to_sym }
+        # unknown_params = (options.keys - set_params)
+        # ap("#{self.name} > Unknown Parameters #{unknown_params}") if unknown_params.present?
+
+        result = obj.call
+      end
+    end
 
-      result = obj.call
+    def self.failed(error)
     end
 
     ## — INSTANCE METHODS
@@ -76,7 +94,7 @@ module LightServiceObject
 
     def call
       result = self.perform
-      if self.result_class.present?
+      if self.result_class
         if !result.is_a?(self.result_class)
           a_name = "#{self.result_class}"
           a_name = %w[a e i o u y].include?(a_name.first.downcase) ? "an #{a_name}" : "a #{a_name}"
@@ -86,19 +104,19 @@ module LightServiceObject
       end
       Dry::Monads.Success(result)
     rescue StandardError => error
-      reason = self.error_reason(error)
-      self.class.failed(error)
-      Dry::Monads.Failure(reason)
+      fail!(error)
     end
 
     def fail!(error)
       error = ::StandardError.new(error.to_s) if !error.is_a?(::StandardError)
-      raise error
+      reason = self.error_reason(error)
+      self.class.failed(error)
+      Dry::Monads.Failure(reason)
     end
 
     def error_reason(error)
       # Give subclasses a chance to see errors first
-      "#{self.class}: #{error}"
+      "[#{self.class}] #{error}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light_service_object
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ben Sharpe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,10 +92,12 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - lib/light_service_object.rb
 - lib/light_service_object/version.rb
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A lightweight base service object for Rails/Ruby