pragma-operation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd7b34ba403c8aad5674258122033c1792ebf363
-  data.tar.gz: 488a5d9a12741ba168620bd8100a27eca403f96e
+  metadata.gz: a0e4b70a6dbf00fc017919c4a20a4fcab1314caf
+  data.tar.gz: 10bd799eabb43d6f76a9d29f80a737df2c2902e0
 SHA512:
-  metadata.gz: ade359f43ad4529a9e7715eaec67b4504fea489c78bdd22471d9f8fe311bbf1b164aa2a64d127ddfe415ca18d0db164e80a83ac1b3fc8961e4dfd76fa386accc
-  data.tar.gz: 2eb8b22c599a80b226730d226073711a52002e0577b35dbefc9c69e8c04c425210743c581a60b43bdf3168daaa18628a7ba923284e539d3588619f5654125936
+  metadata.gz: ff8e629a189aa67af574569fbf2fa2db77e65e753d553f4d6ae2fc3d8b892693060a223a0f69a6112f8e9ba6ba0479fc44b77550616a9a97e7567f0565ca36a1
+  data.tar.gz: 5db34e59a55d5251eb05d0f33283bb83f26027afe491c8150094076eee53af092f0d20fd0f345381f1dfa7c879643f2e9868611b4f6b0b6cbe0f827a94bd1418

data/lib/pragma/operation/authorization.rb

@@ -1,33 +1,38 @@
 # frozen_string_literal: true
 module Pragma
   module Operation
+    # Provides integration with {https://github.com/pragmarb/pragma-policy Pragma::Policy}.
+    #
+    # @author Alessandro Desantis
     module Authorization
       def self.included(base)
         base.extend ClassMethods
         base.include InstanceMethods
       end
 
-      module ClassMethods
-        # Sets the contract to use for validating this operation.
+      module ClassMethods # :nodoc:
+        # Sets the policy to use for authorizing this operation.
         #
-        # @param klass [Class] a subclass of +Pragma::Contract::Base+
-        def contract(klass)
-          @contract = klass
+        # @param klass [Class] a subclass of +Pragma::Policy::Base+
+        def policy(klass)
+          @policy = klass
         end
 
-        # Builds the contract for the given resource, using the previous defined contract class.
+        # Builds the policy for the given user and resource, using the previous defined policy
+        # class.
         #
+        # @param user [Object]
         # @param resource [Object]
         #
-        # @return [Pragma::Contract::Base]
+        # @return [Pragma::Policy::Base]
         #
-        # @see #contract
-        def build_contract(resource)
-          @contract.new(resource)
+        # @see #policy
+        def build_policy(user:, resource:)
+          @policy.new(user: user, resource: resource)
         end
       end
 
-      module InstanceMethods
+      module InstanceMethods # :nodoc:
         # Builds the policy for the current user and the given resource, using the previously
         # defined policy class.
         #

data/lib/pragma/operation/validation.rb

@@ -1,35 +1,36 @@
 # frozen_string_literal: true
 module Pragma
   module Operation
+    # Provides integration with {https://github.com/pragmarb/pragma-contract Pragma::Contract}.
+    #
+    # @author Alessandro Desantis
     module Validation
       def self.included(base)
         base.extend ClassMethods
         base.include InstanceMethods
       end
 
-      module ClassMethods
-        # Sets the policy to use for authorizing this operation.
+      module ClassMethods # :nodoc:
+        # Sets the contract to use for validating this operation.
         #
-        # @param klass [Class] a subclass of +Pragma::Policy::Base+
-        def policy(klass)
-          @policy = klass
+        # @param klass [Class] a subclass of +Pragma::Contract::Base+
+        def contract(klass)
+          @contract = klass
         end
 
-        # Builds the policy for the given user and resource, using the previous defined policy
-        # class.
+        # Builds the contract for the given resource, using the previous defined contract class.
         #
-        # @param user [Object]
         # @param resource [Object]
         #
-        # @return [Pragma::Policy::Base]
+        # @return [Pragma::Contract::Base]
         #
-        # @see #policy
-        def build_policy(user:, resource:)
-          @policy.new(user: user, resource: resource)
+        # @see #contract
+        def build_contract(resource)
+          @contract.new(resource)
         end
       end
 
-      module InstanceMethods
+      module InstanceMethods # :nodoc:
         # Builds the contract for the given resource, using the previously defined contract class.
         #
         # This is just an instance-level alias of {.build_contract}. You should use this from inside
@@ -51,11 +52,13 @@ module Pragma
         #
         # @return [Boolean] whether the operation is valid
         def validate(validatable)
+          # rubocop:disable Metrics/LineLength
           contract = if defined?(Pragma::Contract::Base) && validatable.is_a?(Pragma::Contract::Base)
             validatable
           else
             build_contract(validatable)
           end
+          # rubocop:enable Metrics/LineLength
 
           contract.validate(params)
         end
@@ -65,11 +68,13 @@ module Pragma
         #
         # @param validatable [Object|Pragma::Contract::Base] contract or resource
         def validate!(validatable)
+          # rubocop:disable Metrics/LineLength
           contract = if defined?(Pragma::Contract::Base) && validatable.is_a?(Pragma::Contract::Base)
             validatable
           else
             build_contract(validatable)
           end
+          # rubocop:enable Metrics/LineLength
 
           return if validate(contract)
 

data/lib/pragma/operation/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Pragma
   module Operation
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragma-operation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alessandro Desantis