service_base 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9c9ee7f7424ddd348b82d0708fa79703e7869771284b7018f7e3cb41828770b
-  data.tar.gz: 92032edd435bc81747cbd0a15670e3210716cefd51d8fc7598f7fca5194f5127
+  metadata.gz: 79ca15b6d1d305ea1dea4ab6633e63725de9f5d5f951c4221b9b59bef38b03ab
+  data.tar.gz: 3bb44ec63bd53452ac09c3fc0f531bf25218dcbb1434b5e8bd0a1dc3f8f75be0
 SHA512:
-  metadata.gz: a95dd087bca43238c0ed3e6c94773f61e05758def00c38e9ac4bfd0f258f0eb3514092e404c9f1fd14a9dc47f6f08b4529869d8fa5e489967848396b57347910
-  data.tar.gz: a524e1751b728e6cce6fd723c78b3f5ccb7369e8db0f27a412b42d9be6d4cb35a17e7b6926bae291300ed56e5585b5a97b12dea4b3fdc5efa01f88c86a8be007
+  metadata.gz: 4a730fb152af189eb68c07bf5a55a31529605af58a4a8980afbf3369769ec0d3dcf81ab3e6d89ade5b9903dd547fa3f06b2db62edb9621d4ef8edfbab46c2d81
+  data.tar.gz: 2f666d22c5368a817de07145a1e27eb32faf98b326128c9b6c8192fa48eecda9d3d0dd6d36b0eaf8848c7f9c5340b770e726777c4e7f78f2550e0393208ffe94

data/README.md

@@ -165,13 +165,10 @@ The positional name and type arguments are required, the other options
 are as follows.
 `argument(:name, String, optional: true, description: "The User's name")`
 
-If an argument is optional and has a default value, simply set
-`default: your_value` but do not also specify
-`optional: true`. Doing so will raise an
-`ArgumentError`. Additionally, be sure to
-`.freeze` any mutable default values, ie.
-`default: {}.freeze`. Failure to do so will raise an
-`ArgumentError`.
+If an argument is optional and has a default value, simply set `default: your_value` but do not also specify `optional: true`.
+Doing so will raise an `ArgumentError`.
+Additionally, be sure to `.freeze` any mutable default values, ie.  `default: {}.freeze`.
+Failure to do so will raise an `ArgumentError`.
 
 Empty strings attempted to coerce into integers will throw an error.
 See [https://github.com/dry-rb/dry-types/issues/344#issuecomment-518743661](https://github.com/dry-rb/dry-types/issues/344#issuecomment-518743661)
@@ -187,32 +184,53 @@ class MyService < ServiceBase::Service
 end
 ```
 
-To get the full hash of `argument`s passed into a service,
-use `attributes`. This is a very useful technique for
+To get the full hash of `argument`'s keys and values passed into a service,
+use `arguments`. This is a very useful technique for
 services that update an object. For example
 
 ```ruby
 class User::UpdateService < ServiceBase::Service
+  argument(:name, String)
+
   def call
-    user.update(attributes)
+    user.update(arguments)
   end
 end
 ```
 
-### ApplicationRecord Args
+## Types
+
+Argument types come from, [Dry.rb’s Types](https://dry-rb.org/gems/dry-types/1.2/built-in-types/), which can be extended.
+You may also add custom types as outlined in [Dry.rb Custom Types](https://dry-rb.org/gems/dry-types/1.2/custom-types/).
+
+It is recommended that you define your own `Type` module and include it in your `ServiceBase` subclass, as so.
+
+```rb
+# app/models/types.rb
+module Types
+  ApplicationRecord = Types.Instance(ApplicationRecord)
+  ControllerParams = ServiceBase::Types.Instance(ActionController::Parameters)
+end
 
-If you add `ApplicationRecord = Types.Instance(ApplicationRecord)` in a Rails project, you can accept any `ApplicationRecord` via
+# app/services/application_service.rb
+class ApplicationService < ServiceBase::Service
+  include Types
+end
 
-`argument(:my_record, ApplicationRecord)`
+# app/services/example_service.rb
+class ExampleService < ApplicationService
+  argument(:user, ApplicationRecord, description: "The user to update")
+  argument(:params, ControllerParams, description: "The attributes to update")
+end
+```
 
-You can also limit the type of AR record via
+You can also limit the type of `ApplicationRecord` record via
 
-`argument(:my_record, Types.Instance(MyRecord))`
+`argument(:user, Types.Instance(User))`
 
-## Types
+Or defining `User = Types.Instance(User)`
 
-Argument types are defined in Types, which can be extended, ie. app/models/types.rb, and are an extension of [Dry.rb’s
-Types](https://dry-rb.org/gems/dry-types/1.2/built-in-types/). In order to access constants outside of the dry.rb namespace,
+Note: In order to access constants outside of the dry.rb namespace,
 or to access a type that collides with one of our defined types, you
 must include `::` to allow a global constant search.
 
@@ -222,11 +240,9 @@ Ie. `::ApplicationRecord...`
 powerful and recommended for automatic parsing of inputs, ie. controller
 parameters.
 
-For example `argument(:number, Params::Integer)` will
-convert `"12"` ⇒ `12`
+For example `argument(:number, Params::Integer)` will convert `"12"` ⇒ `12`.
 
-Entire hash structures may also be validated and automatically
-parsed, for example:
+Entire hash structures may also be validated and automatically parsed, for example:
 
 ```ruby
 argument(

data/lib/service_base/argument_type_annotations.rb

@@ -7,10 +7,6 @@ module ServiceBase
         if !klass.is_a?(Class) || !klass.ancestors.include?(Dry::Struct)
           raise(TypeError, "#{name} should be extended on a Dry::Struct subclass")
         end
-
-        # `Types` overrides default types to help shorthand Type::String.
-        # To access Ruby's native types within a service, use `::`, ie. `::String`
-        klass.include(Types)
       end
 
       def included(klass)

data/lib/service_base/service.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'dry-matcher'
-require 'dry-struct'
-require 'dry/matcher/result_matcher'
 require 'dry/monads'
 require 'dry/monads/do'
+require 'dry/matcher/result_matcher'
+require 'dry-types'
+require 'dry-struct'
+require 'dry-matcher'
 require 'memery'
 
 module ServiceBase
@@ -12,6 +13,7 @@ module ServiceBase
     extend Dry::Monads::Result::Mixin::Constructors
     include Dry::Monads::Do.for(:call)
     include Dry::Monads[:result, :do]
+    include Dry.Types()
 
     extend ArgumentTypeAnnotations
     include Memery
@@ -95,24 +97,16 @@ module ServiceBase
       end
     end
 
+    # Returns a hash of all arguments and their values
+    def arguments
+      attributes
+    end
+
     private
 
     # The call method that must be defined by every inheriting service class
     def call
       raise(NotImplementedError)
     end
-
-    # A locale lookup helper that uses the name of the service
-    def locale(selector, args = {})
-      class_name = self.class.name.gsub('::', '.').underscore
-      I18n.t(".#{selector}", scope: "services.#{class_name}", **args)
-    end
-
-    # Structured Monad Result Failure type for returning a ResponseError
-    class ResponseFailure < Dry::Monads::Result::Failure
-      def initialize(message, code, trace = Dry::Monads::RightBiased::Left.trace_caller)
-        super(ResponseError.new(message: message, code: code), trace)
-      end
-    end
   end
 end

data/lib/service_base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceBase
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/service_base.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'service_base/version'
-require_relative 'service_base/types'
 require_relative 'service_base/argument_type_annotations'
 require_relative 'service_base/service'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_base
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - James Klein
@@ -94,7 +94,6 @@ files:
 - lib/service_base/rspec.rb
 - lib/service_base/rspec/service_support.rb
 - lib/service_base/service.rb
-- lib/service_base/types.rb
 - lib/service_base/version.rb
 homepage: https://github.com/kleinjm/service_base
 licenses:

data/lib/service_base/types.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# Defines Dry Types. These Types are included in the ServiceBase for type
-# enforcement when defining `argument`s.
-#
-# For example, you may want to add `ApplicationRecord = Types.Instance(ApplicationRecord)`
-#
-# Add custom types as outlined in
-# https://dry-rb.org/gems/dry-types/1.2/custom-types/
-
-require 'dry-types'
-
-module ServiceBase
-  module Types
-    include Dry.Types()
-
-    UpCasedString = Types::String.constructor(&:upcase)
-    Boolean = Bool # alias the built in type, Bool
-  end
-end