rails_use_case 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccdc9b039ad948018925576475a8857da769828aef5f58f2426901b6cca77c3
-  data.tar.gz: 5ed1d23accbd83dda0428d7fc3f959366e49e5a2cb29e95ec1e641f1063d8942
+  metadata.gz: d9cd28e7a8c4f8f88597a7047a12e3b342a88256798572c55fbc8f30407af566
+  data.tar.gz: 4a2a7d0e5779aaabbf3a6a172b5f88a1cfd4faf4b6a58fab1b581c76f3d7012c
 SHA512:
-  metadata.gz: 931eb6a75e1d92604c5f1e33140a3ddd3c20f6cbad225814f4d6e75e801e95f09d3a738d778643221f29b82f2c188c2c007e4449313297bacfee4eacd41bacd2
-  data.tar.gz: aa4cc82f951293c672211129cdf27968bca51a218305982c55929b13ba5cafd9b60edcce5b89824b6ba4108ad0c8ec8dc3dbed6d06cc841ea04d0a4ed4b2aa1d
+  metadata.gz: 5135d55bdab90e5d8cf0c454d90712afe87726b575e49a81d9b477b204f01f05b1b7f2366542b101fa9a62742e4403e8a7846be1d6e77289ca0038bc27b60af0
+  data.tar.gz: c77c6b87d683be50c54e5a3c3235738e144addc3df07292954e4aca7a209ddf1bef017dfa1dc5bcb07b5bb35f2610e5d11162032aa35fa0d641717411247a58f

data/README.md

@@ -31,6 +31,9 @@ save that record or raises an exception. Also the `@record` will automatically p
 
 The params should always passed as hash and are automatically assigned to instance variables.
 
+Use Cases should be placed in the `app/use_cases/` directory and the file and class name should start with a verb like `create_blog_post.rb`.
+
+
 ### Example UseCase
 
 ```ruby
@@ -81,14 +84,55 @@ puts result.inspect
 ```
 
 
+## Behavior
+
+A behavior is simply a module that contains methods to share logic between use cases and to keep them DRY.
+
+To use a behavior in a use case, use the `with` directive, like `with BlogPosts`.
+
+Behaviors should be placed in the `app/behaviors/` directory and the file and module name should named in a way it can be prefixed with `with`, like `blog_posts.rb` (with blog posts).
+
+
+### Example Behavior
+
+Definition:
+
+```ruby
+module BlogPosts
+  def notify_subscribers
+    # ... send some mails ...
+  end
+end
+```
+
+Usage:
+
+```ruby
+class CreateBlogPost < Rails::UseCase
+  with BlogPosts
+
+  # ...
+
+  step :build_post
+  step :save!
+  step :notify_subscribers, unless: -> { skip_notifications }
+
+  # ...
+end
+```
+
+
+
 ## Service
 
 The purpose of a Service is to contain low level non-domain code like communication with a API,
-generating an export, upload via FTP or generating a PDF. It takes params, has it's own configuration
-and writes a log file.
+generating an export, upload via FTP or generating a PDF. It takes params, has it's own configuration and writes a log file.
 
 It comes with call style invocation: `PDFGenerationService.(some, params)`
 
+Services should be placed in the `app/services/` directory and the name should end with `Service` like `PDFGenerationService` or `ReportUploadService`.
+
+
 ### Example Service
 
 ```ruby

data/lib/rails/use_case.rb

@@ -42,6 +42,13 @@ module Rails
     end
 
 
+    # DSL to include a behavior.
+    # @param mod [Module]
+    def self.with(mod)
+      include mod
+    end
+
+
     # Will run the steps of the use case.
     def process
       self.class.steps.each do |step|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_use_case
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Benjamin Klein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties