excom 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f560f7894a0530703e6a5ecb6f472e61b4ae37b
-  data.tar.gz: 764f807e1ccbb3f3daf38dfda5cca89b42a7b22c
+  metadata.gz: cf41e297a57b63652c79c3455846ceef0398f1ea
+  data.tar.gz: 27447ccbbcee3505e65f4a7d78908437f7197d6a
 SHA512:
-  metadata.gz: bf2e04d3f7f91341768d54ce4033041ba3787529e45390beaf4035e2d72bfed4c5454e6fecab3c00cc6ff9f583cc8da0b19863a970a0ad941467ef464cc42670
-  data.tar.gz: 06d5a6496d1a653ac920b51f9712af6a4321235a41624c18931c46170936b953a847ad3e014660df6356f89368ffd2dd470269478d59a6386cf35d20b4d47b27
+  metadata.gz: 3cbfb293d339f11984aab4b78f86ad1b93f70ba0721dbabcaecd4e175a8ec56bc8ffb583fcf88b2256cd85abc83f1e386c9ec5015acb4e6b16a5eff4437689d8
+  data.tar.gz: 994147da0552e012f35bed28e7c19933f06ea1a88e28cef013d8869a8a9d4cbf9bd1b7d3b59c86584ea9b6c62bf3a698bfd8c03f83d63cc6c3267e728ef93e8e

data/README.md

@@ -186,36 +186,36 @@ class Posts::Archive < Excom::Command
 end
 ```
 
-- [`:sentry`](https://github.com/akuzko/excom/wiki/Plugins#sentry) - Allows you to provide Sentry classes
-for commands that use this plugin. Each Sentry class hosts logic responsible for allowing or denying
-corresponding command's execution or related checks. Much like [pundit](https://github.com/elabs/pundit)
-Policies, but more. Where pundit governs only authorization logic, Excom's Sentries can deny execution
-with any reason you find appropriate.
+- [`:sentry`](https://github.com/akuzko/excom/wiki/Plugins#sentry) - Allows you to define sentry logic that
+will allow or deny command's execution or other related checks. This logic can be defined inline in command
+classes or in dedicated Sentry classes. Much like [pundit](https://github.com/elabs/pundit) Policies, but
+more. Where pundit governs only authorization logic, Excom's Sentries can deny execution with any reason
+you find appropriate.
 
 ```rb
 class Posts::Destroy < Excom::Command
   use :context
   use :sentry
+
   args :post
 
   def run
     post.destroy
   end
-end
 
-class Posts::DestroySentry < Excom::Sentry
-  delegate :post, :context, to: :command
-  deny_with :unauthorized
-
-  def execute?
-    # only author can destroy a post
-    post.author_id == context[:current_user].id
-  end
+  sentry delegate: [:context] do
+    deny_with :unauthorized
 
-  deny_with :unprocessable_entity do
     def execute?
-      # disallow to destroy posts that are older than 1 hour
-      (post.created_at + 1.hour).past?
+      # only author can destroy a post
+      post.author_id == context[:current_user].id
+    end
+
+    deny_with :unprocessable_entity do
+      def execute?
+        # disallow to destroy posts that are older than 1 hour
+        (post.created_at + 1.hour).past?
+      end
     end
   end
 end

data/bin/console

@@ -3,11 +3,33 @@
 require "bundler/setup"
 require "excom"
 
-class Command < Excom::Command
+Excom::Sentry.deny_with :unauthorized
+
+class Show < Excom::Command
   use :sentry, class: 'MySentry'
-  use :assertions
   use :caching
 
+  args :foo
+
+  def run
+    {foo: foo}
+  end
+end
+
+class MySentry < Excom::Sentry
+  def execute?
+    foo != 5
+  end
+
+  def save?
+    sentry(:save).execute?
+  end
+end
+
+class Save < Excom::Command
+  use :sentry, delegate: [:threshold]
+  use :assertions
+
   args :foo
   opts :bar, :baz
 
@@ -21,18 +43,24 @@ class Command < Excom::Command
     result ok: foo * 2
     assert { foo > bar }
   end
-end
 
-class MySentry < Excom::Sentry
-  deny_with :unauthorized
-
-  def execute?
-    command.foo != 5
+  def threshold
+    0
   end
 
-  deny_with :unprocessable_entity do
-    def bar?
-      command.bar && command.bar > 0
+  sentry do
+    def execute?
+      foo != 6
+    end
+
+    deny_with :unprocessable_entity do
+      def execute?
+        foo > 0
+      end
+
+      def bar?
+        bar && bar > threshold
+      end
     end
   end
 end

data/lib/excom/plugins/pluggable.rb

@@ -14,7 +14,16 @@ module Excom
         extension.used(self, **opts)
       end
 
+      plugins[name] = Reflection.new(extension, opts)
+
       extension
     end
+
+    def plugins
+      @plugins ||= {}
+    end
+    alias :extensions :plugins
+
+    Reflection = Struct.new(:extension, :options)
   end
 end

data/lib/excom/plugins/sentry/sentinel.rb

@@ -1,6 +1,23 @@
 module Excom
   module Plugins::Sentry
     class Sentinel
+      def self.inherited(sentry_class)
+        return unless self == Sentinel
+
+        sentry_class.denial_reason = denial_reason
+        sentry_class.const_set(:Delegations, Module.new)
+        sentry_class.send(:include, sentry_class::Delegations)
+      end
+
+      def self.command_class=(klass)
+        sentinels.each{ |s| s.command_class = klass }
+        @command_class = klass
+      end
+
+      def self.command_class
+        @command_class
+      end
+
       def self.deny_with(reason)
         return self.denial_reason = reason unless block_given?
 
@@ -35,6 +52,10 @@ module Excom
         @sentinels ||= []
       end
 
+      def self.delegations
+        const_get(:Delegations)
+      end
+
       attr_reader :command
 
       def initialize(command)
@@ -52,13 +73,7 @@ module Excom
       end
 
       def sentry(klass)
-        unless Class === klass
-          klass_name = self.class.name.sub(/[^:]+\Z/, ''.freeze) + "_#{klass}".gsub!(/(_([a-z]))/){ $2.upcase } + 'Sentry'.freeze
-          klass = klass_name.respond_to?(:constantize) ?
-            klass_name.constantize :
-            klass_name.split('::'.freeze).reduce(Object){ |obj, name| obj.const_get(name) }
-        end
-
+        klass = derive_sentry_class(klass) unless Class === klass
         klass.new(command)
       end
 
@@ -82,7 +97,47 @@ module Excom
         end
       end
 
-      def method_missing(name, *)
+      private def derive_sentry_class(klass)
+        constantize(klass, '::Sentry'.freeze)
+      rescue NameError
+        constantize(klass, 'Sentry'.freeze)
+      end
+
+      private def constantize(klass, sentry_name)
+        module_prefix = (inline? ? self.class.command_class.name : self.class.name).sub(/[^:]+\Z/, ''.freeze)
+
+        klass_name = module_prefix + "_#{klass}".gsub!(/(_([a-z]))/){ $2.upcase } + sentry_name
+
+        klass_name.respond_to?(:constantize) ?
+          klass_name.constantize :
+          klass_name.split('::'.freeze).reduce(Object){ |obj, name| obj.const_get(name) }
+      end
+
+      private def inline?
+        self.class.command_class.const_defined?(:Sentry) && self.class.command_class::Sentry == self.class
+      end
+
+      private def define_delegations!
+        delegated_methods = self.class.command_class.arg_methods.instance_methods +
+          Array(self.class.command_class.plugins[:sentry].options[:delegate])
+
+        delegated_methods.each do |name|
+          self.class.delegations.send(:define_method, name) { command.public_send(name) }
+        end
+
+        self.class.instance_variable_set('@delegations_defined'.freeze, true)
+      end
+
+      private def delegations_defined?
+        self.class.instance_variable_get('@delegations_defined'.freeze)
+      end
+
+      def method_missing(name, *args)
+        unless delegations_defined?
+          define_delegations!
+          return send(name, *args) if respond_to?(name)
+        end
+
         if name.to_s.end_with?(??)
           sentinels[1..-1].each do |sentry|
             return sentry.public_send(name) if sentry.respond_to?(name)

data/lib/excom/plugins/sentry.rb

@@ -32,6 +32,10 @@ module Excom
       @sentry ||= self.class.sentry_class.new(self)
     end
 
+    def sentry_hash
+      sentry.to_hash
+    end
+
     module ClassMethods
       attr_writer :_sentry_class
 
@@ -42,21 +46,38 @@ module Excom
 
       def sentry_class(klass = nil)
         return self._sentry_class = klass unless klass.nil?
+        return @sentry_class if defined? @sentry_class
 
-        if _sentry_class.is_a?(String)
-          return _sentry_class.constantize if _sentry_class.respond_to?(:constantize)
+        @sentry_class =
+          if _sentry_class.is_a?(String)
+            return _sentry_class.constantize if _sentry_class.respond_to?(:constantize)
 
-          names = _sentry_class.split('::'.freeze)
-          names.shift if names.first.empty?
-          names.reduce(Object){ |obj, name| obj.const_get(name) }
-        else
-          _sentry_class
-        end
+            names = _sentry_class.split('::'.freeze)
+            names.shift if names.first.empty?
+            names.reduce(Object){ |obj, name| obj.const_get(name) }
+          else
+            _sentry_class
+          end
+
+        @sentry_class.command_class = self
+        @sentry_class
       end
 
       def _sentry_class
         @_sentry_class ||= "#{name}Sentry"
       end
+
+      def sentry(delegate: [], &block)
+        (plugins[:sentry].options[:delegate] ||= []).concat(delegate).uniq!
+
+        if const_defined?(:Sentry)
+          const_get(:Sentry).class_eval(&block)
+        else
+          @_sentry_class = @sentry_class = Class.new(Sentry, &block)
+          @sentry_class.command_class = self
+          const_set(:Sentry, @_sentry_class)
+        end
+      end
     end
   end
 end

data/lib/excom/version.rb

@@ -1,3 +1,3 @@
 module Excom
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excom
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Artem Kuzko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler