dryer_services 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e8da1d4f76f45004b8f9e2e815abc712cd4489a81b9f5d9f0edcb4b90b094d
-  data.tar.gz: 85ee11f54acb826d9a0b8f5ff1de144de45e88f7d813000ad7ff8012636aa526
+  metadata.gz: ba13ef8192d27da5fda2b291efb698e4fc11638b2e46e8faad4108aeba7129fa
+  data.tar.gz: 6624e849a4b7c36ae41900bf41aee44d5303fb1443f0654d49a13b3bce60450d
 SHA512:
-  metadata.gz: bb3db4e4444fa4fa9e566227cbe2b6f56a08bcfad58a404b3b283acfebb421b0460b987dd86f2602b97b73190b16bd5d8e797a83f72cdb4044d95b41f77f7457
-  data.tar.gz: 2cd1e93e893bd0955baa20abe72e40a45d19998aaaab2bfa4ad1ae570cc16aa620a3f126ae6793d48963f1cc20eccbe5ab123e1651b8bf236ed5d1fefa70fe4f
+  metadata.gz: d01980e96ed796b2b0c292fd1763a579daddb0aaf03f5ad74ddcf6d25a76109c9481d49b9cd00aa6c1496df95d13d6d6addd4d6784dff33cdbdced444275f028
+  data.tar.gz: 5a9447e7d141ba65dc7398e55ba22a35f47330d8c4b6f70f9ec12619aa513e472167eda4142a77f7dc421781d58bdef12dbe66339e2d0d7108d982102a236fa0

data/README.md

@@ -1 +1,92 @@
 # Dryer Services
+A gem providing base classes for composable service object that leverages the
+[dry-monads](https://dry-rb.org/gems/dry-monads/1.6/) gem for error handling.
+
+## Installation
+add the following to you gemfile
+```
+gem "dryer_services"
+```
+
+## Usage
+This gem provides two base classes, `SimpleService` and `ResultService`.
+
+Both classes provide a single class method `call`, and require the inheriting class to
+define the instance methods `initialize` and `call`
+
+`SimpleService` is meant to be used for operations that have no failure modes,
+while `ResultsService` is meant to be used for operations that may fail.
+
+### SimpleService Example
+
+```
+class Add < Dryer::Services::SimpleService
+    def initialize(a, b)
+        @a = a
+        @b = b
+    end
+
+    def call
+        a + b
+    end
+
+    private
+    attr_reader :a, :b
+end
+
+Add.call(1,2) # returns 3
+```
+
+### ResultService Example
+
+Result Service wraps the value returned from `call` in a `Dry::Monad::Result`.
+If the return value is an Error, it will return a Failure. If the return value
+is already a `Dry::Monad::Result`, it will not wrap the result, otherwise it
+will wrap the result in a `Dry::Monads::Success`
+
+```
+class Divide < Dryer::Services::ResultService
+    def initialize(a, b)
+        @a = a
+        @b = b
+    end
+
+    def call
+        if b == 0
+            StandError.new("Can not divide by zero")
+        else
+            a/b
+        end
+    end
+
+    private
+    attr_reader :a, :b
+end
+
+Add.call(4,2) # returns Dry::Monads::Success(2)
+Add.call(4,0) # returns Dry::Monads::Failure("Can not divide by zero")
+```
+
+## Advantages
+Using the Service pattern can help to make code more modular, and make it easier
+to separate data modeling from transformations.
+
+# Development
+This gem is set up to be developed using [Nix](https://nixos.org/)
+Once you have nix installed you can run
+`make env`
+to enter the development environment. Then run `make` to see other available
+commands
+
+If you don't want to use nix, all the scripts can be run directly from the
+`scripts` directory.
+
+## Contributing
+Please create a github issue to report any problems using the Gem.
+Thanks for your help in making testing easier for everyone!
+
+## Versioning
+Dryer Services follows Semantic Versioning 2.0 as defined at https://semver.org.
+
+## License
+This code is free to use under the terms of the MIT license.

data/dryer_services.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                  = 'dryer_services'
-  spec.version               = "1.0.0"
+  spec.version               = "1.1.0"
   spec.authors               = ['John Bernier']
   spec.email                 = ['john.b.bernier@gmail.com']
   spec.summary               = 'A service object leveraging the dry-monads gem'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dryer_services
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Bernier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads