polist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3ccf0f8d1e783625a5f9b9c7f812e199fd965daba514a26e24dd17579d1324
-  data.tar.gz: 00c5fd25949bcbadcd391f526ed744428e82d657454c173a3598c196ffa50df5
+  metadata.gz: ec034ec38c89c8f5446e20a9513c12e9778e485123bbcd56fc088d11e73baf26
+  data.tar.gz: d52d341772a6e1a312198d3b6e5c0caac885a27c6dca12c02464729aca643a72
 SHA512:
-  metadata.gz: d037d246cbb437c7c33e58cc54f682ceaeb0a041d03e8d70f81cb8d994725d5295069dd53507af0f3e01f0d4e39356e911c578c3fd9217a53e6c127db60ac6b9
-  data.tar.gz: 657941a65cf0e2d806967663d7fd32949c96e41d35da152a9e2a95218ec4ecf374605db9df7b3584a810a897bcb7d4db84eb755bd834d81c2a81c845a8284bb2
+  metadata.gz: f33e028799cfd4b9c2da407ba407a50c3f298bd51bc5841db63e677b4a38c3b589f1736fb2ca2aba3525111cc1c28b783607d086d5432f068af48cd2077a5b17
+  data.tar.gz: 063a1f4aad8ac26b9458a79d7abc808d1031a1a3730b84e3b6395858614bc3a8f6c125114de692ee936ca80f1cd20c8ea6bbb5b065d5b4a7085e9c5b0ba95c5c

data/.rubocop.yml

@@ -4,3 +4,6 @@ inherit_gem:
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/CHANGELOG.md

@@ -2,11 +2,17 @@
 
 ## [Unreleased]
 
+## [1.1.0] - 2019-02-03
+
+### Added
+
+- Middlewares support ([@nesaulov]) [#2]
+
 ## [1.0.0] - 2019-02-03
 
 ### Added
 
-- Add `Polist::Struct` and `Polist::Builder` ([@tycooon]) [#3]
+- `Polist::Struct` and `Polist::Builder` ([@tycooon]) [#3]
 
 ## [0.4.0] - 2017-10-31
 
@@ -14,8 +20,11 @@
 
 [0.4.0]: https://github.com/umbrellio/polist/tree/v0.4.0
 [1.0.0]: https://github.com/umbrellio/polist/compare/v0.4.0...v1.0.0
-[Unreleased]: https://github.com/umbrellio/polist/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/umbrellio/polist/compare/v1.0.0...v1.1.0
+[Unreleased]: https://github.com/umbrellio/polist/compare/v1.1.0...HEAD
 
+[@nesaulov]: https://github.com/nesaulov
 [@tycooon]: https://github.com/tycooon
 
+[#2]: https://github.com/umbrellio/polist/pull/2
 [#3]: https://github.com/umbrellio/polist/pull/3

data/README.md

@@ -54,7 +54,7 @@ rescue Polist::Service::Failure => error
 end
 ```
 
-Note that `.run` and `.call` are just shortcuts for `MyService.new(...).run` and `MyService.new(...).call` with the only difference that they always return the service instance instead of the result of `#run` or `#call`. Unlike `#call` though, `#run` is not intended to be owerwritten in subclasses.
+Note that `.run` and `.call` are just shortcuts for `MyService.new(...).run` and `MyService.new(...).call` with the only difference that they always return the service instance instead of the result of `#run` or `#call`. Unlike `#call` though, `#run` is not intended to be overwritten in subclasses.
 
 ### Using Form objects
 
@@ -169,6 +169,40 @@ c.x # => 15
 c.y # => nil
 ```
 
+### Using Middlewares
+
+If you have some common things to be done in more than one service, you can define a middleware and register it inside the said services.
+Every middleware takes the service into it's constructor and executes `#call`. Thus every middleware has to implement `#call` method and has a `#service` attribute reader.
+Middlewares delegate `#success!`, `#fail!`, `#error!`, `#form`, `#form_attributes` to the service class they are registered in.
+Every middleware should be a subclass of `Polist::Service::Middleware`. Middlewares are run before the service itself is run.
+
+To register a middleware one should use `.register_middleware` class method on a service. More than one middleware can be registered for one service.
+
+For example:
+```ruby
+class MyMiddleware < Polist::Service::Middleware
+  def call
+    fail!(code: :not_cool) if service.fail_on_middleware?
+  end
+end
+
+class MyService < Polist::Service
+  register_middleware MyMiddleware
+
+  def call
+    success!(code: :cool)
+  end
+  
+  def fail_on_middleware?
+    true
+  end  
+end
+
+service = MyService.run
+service.success? #=> false
+service.response #=> { code: :not_cool }
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/polist.

data/lib/polist.rb

@@ -2,5 +2,6 @@
 
 require "polist/builder"
 require "polist/service"
+require "polist/service/middleware"
 require "polist/struct"
 require "polist/version"

data/lib/polist/service.rb

@@ -20,10 +20,20 @@ module Polist
       include ActiveModel::Validations
     end
 
+    module MiddlewareCaller
+      def call
+        call_middlewares
+        super
+      end
+    end
+
+    MiddlewareError = Class.new(StandardError)
+
     attr_accessor :params
 
     def self.inherited(klass)
       klass.const_set(:Failure, Class.new(klass::Failure))
+      klass.prepend MiddlewareCaller
     end
 
     def self.build(*args)
@@ -44,6 +54,23 @@ module Polist
       end
     end
 
+    def self.__polist_middlewares__
+      @__polist_middlewares__ ||= []
+    end
+
+    def self.register_middleware(klass)
+      unless klass < Polist::Service::Middleware
+        raise MiddlewareError,
+              "Middleware #{klass} should be a subclass of Polist::Service::Middleware"
+      end
+
+      __polist_middlewares__ << klass
+    end
+
+    def self.__clear_middlewares__
+      @__polist_middlewares__ = []
+    end
+
     def initialize(params = {})
       self.params = params
     end
@@ -76,6 +103,12 @@ module Polist
 
     private
 
+    def call_middlewares
+      self.class.__polist_middlewares__.each do |middleware|
+        middleware.new(self).call
+      end
+    end
+
     def form
       @form ||= self.class::Form.new(form_attributes.to_snake_keys)
     end

data/lib/polist/service/middleware.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Polist::Service::Middleware
+  def initialize(service)
+    @service = service
+  end
+
+  # Should be implemented in subclasses
+  def call; end
+
+  private
+
+  attr_reader :service
+
+  %i[fail! error! success! form form_attributes].each do |service_method|
+    define_method(service_method) do |*args|
+      service.send(service_method, *args)
+    end
+  end
+end

data/lib/polist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polist
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -169,6 +169,7 @@ files:
 - lib/polist.rb
 - lib/polist/builder.rb
 - lib/polist/service.rb
+- lib/polist/service/middleware.rb
 - lib/polist/struct.rb
 - lib/polist/version.rb
 - polist.gemspec
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A gem for creating simple service classes and more.