granite 0.17.1 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e0ea5a4829a8f42ea8d86fa3ad0c8ae3e0e15bf4b0b92824b2268bc4be9489b
-  data.tar.gz: a40be02b1b8cef2bfa329c1f33415b78142d497a9d20f10d4ae7b3adc060bdf5
+  metadata.gz: a3e1ba1452b79b7af5130326fb9fd4b11399bf8c23d2bdcbb3cf7a3d54a81c6f
+  data.tar.gz: dbc6e24fa6d5e22710bed7a24f0ff9bde67d91bc6672bb0af89477601ec1b199
 SHA512:
-  metadata.gz: 37d3fe242ac9ea96ec2b4bf4aa8f55e97086a12634600e3d474558319a143cbe0a718bbd1f76a77514a9ca98fac39c0ae39439ede746ead6a8c08f3ec2e85b1e
-  data.tar.gz: 34a452491cc98a5c650ffb513684e5f8ab1dd12407cddaadcc7a3905ece4eaab5dc40c27ab93ee99ae3f55381ebee9f510abf8a31e2d3d1d9929ab695b743aeb
+  metadata.gz: cfff687bb585d2ddff0fc504e08a849e3f148c13cfb9bb6d48a016dca0a83a57008cdce581753ccacb18005a5c9cac46ad49ebcacc3e615f14c9a7af4fc7aa90
+  data.tar.gz: 77fa6fd1b0c27b045cca42ec681ae51e3042fa89c45c602bdd509f78126920da694d85582089805cf753ce9792aef21177ee9cfe745e268bd36e6be62b0094b5

data/app/controllers/granite/controller/translations.rb

@@ -1,6 +1,6 @@
 module Granite
   class Controller
-    module Translations
+    module Translations # :nodoc:
       def i18n_scopes
         Granite::Translations.combine_paths(projector.i18n_scopes, [*action_name, nil])
       end

data/app/controllers/granite/controller.rb

@@ -1,7 +1,7 @@
 require 'action_controller'
 
 module Granite
-  class Controller < Granite.base_controller_class
+  class Controller < Granite.base_controller_class # :nodoc:
     include Controller::Translations
     helper Controller::Translations
 

data/lib/generators/granite/install_controller_generator.rb

@@ -2,7 +2,7 @@ require 'rails/generators/base'
 
 module Granite
   module Generators
-    class InstallControllerGenerator < Rails::Generators::Base
+    class InstallControllerGenerator < Rails::Generators::Base # :nodoc:
       source_root File.expand_path('../../..', __dir__)
 
       desc 'Creates a Granite::Controller for further customization'

data/lib/generators/granite_generator.rb

@@ -1,4 +1,4 @@
-class GraniteGenerator < Rails::Generators::NamedBase
+class GraniteGenerator < Rails::Generators::NamedBase # :nodoc:
   source_root File.expand_path('templates', __dir__)
 
   argument :projector, type: :string, required: false
@@ -6,7 +6,10 @@ class GraniteGenerator < Rails::Generators::NamedBase
 
   def create_action
     template 'granite_action.rb.erb', "apq/actions/#{file_path}.rb"
-    template 'granite_business_action.rb.erb', "apq/actions/#{class_path.join('/')}/business_action.rb" unless options.collection?
+    unless options.collection?
+      template 'granite_business_action.rb.erb',
+               "apq/actions/#{class_path.join('/')}/business_action.rb"
+    end
     template 'granite_base_action.rb.erb', 'apq/actions/base_action.rb', skip: true
     template 'granite_action_spec.rb.erb', "spec/apq/actions/#{file_path}_spec.rb"
     empty_directory "apq/actions/#{file_path}/#{projector}" if projector

data/lib/granite/action/error.rb

@@ -2,7 +2,7 @@ require 'granite/error'
 
 module Granite
   class Action
-    class Error < Granite::Error
+    class Error < Granite::Error # :nodoc:
       attr_reader :action
 
       def initialize(message, action = nil)

data/lib/granite/action/exceptions_handling.rb

@@ -1,6 +1,6 @@
 module Granite
   class Action
-    module ExceptionsHandling
+    module ExceptionsHandling # :nodoc:
       extend ActiveSupport::Concern
 
       included do
@@ -10,7 +10,7 @@ module Granite
         protected :_exception_handlers
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         # Register default handler for exceptions thrown inside execute_perform! and after_commit methods.
         # @param klass Exception class, could be parent class too [Class]
         # @param block [Block<Exception>] with default behavior for handling specified
@@ -28,11 +28,11 @@ module Granite
         _exception_handlers.keys
       end
 
-      def handle_exception(e)
-        klass = e.class.ancestors.detect do |ancestor|
+      def handle_exception(exception)
+        klass = exception.class.ancestors.detect do |ancestor|
           ancestor <= Exception && _exception_handlers[ancestor]
         end
-        instance_exec(e, &_exception_handlers[klass]) if klass
+        instance_exec(exception, &_exception_handlers[klass]) if klass
       end
     end
   end

data/lib/granite/action/instrumentation.rb

@@ -1,6 +1,6 @@
 module Granite
   class Action
-    module Instrumentation
+    module Instrumentation # :nodoc:
       def perform!(*, **)
         instrument_perform(:perform!) { super }
       end

data/lib/granite/action/performing.rb

@@ -25,9 +25,9 @@ module Granite
         define_callbacks :execute_perform
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         def perform(*)
-          fail 'Perform block declaration was removed! Please declare `private def execute_perform!(*)` method'
+          raise 'Perform block declaration was removed! Please declare `private def execute_perform!(*)` method'
         end
       end
 
@@ -36,13 +36,16 @@ module Granite
       # database transaction. Returns the result of execute_perform! method execution
       # or true if method execution returned false or nil
       #
+      # @deprecated Use {#perform!} or {#try_perform!} instead
       # @param context [Symbol] can be optionally provided to define which
       #   validations to test against (the context is defined on validations
       #   using `:on`)
       # @return [Object] result of execute_perform! method execution or false in case of errors
       def perform(context: nil, **options)
+        Granite.deprecator.warn('Granite::Action#perform is deprecated, use #perform! or #try_perform! instead')
+
         transaction do
-          fail Rollback unless valid?(context)
+          raise Rollback unless valid?(context)
 
           perform_action(**options)
         end
@@ -110,7 +113,7 @@ module Granite
       end
 
       def execute_perform!(**_options)
-        fail NotImplementedError, "BA perform body MUST be defined for #{self}"
+        raise NotImplementedError, "BA perform body MUST be defined for #{self}"
       end
     end
   end

data/lib/granite/action/policies.rb

@@ -5,7 +5,7 @@ require 'granite/action/policies/required_performer_strategy'
 
 module Granite
   class Action
-    class NotAllowedError < Error
+    class NotAllowedError < Error # :nodoc:
       def initialize(action)
         performer_id = "##{action.performer.id}" if action.performer.respond_to?(:id) && action.performer.id.present?
 
@@ -30,7 +30,7 @@ module Granite
         self._policies_strategy = AnyStrategy
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         # The simplies policy. Takes block and executes it returning
         # boolean result. Multiple policies are reduced with ||
         #
@@ -80,7 +80,7 @@ module Granite
       # Raises Granite::Action::NotAllowedError if action is not allowed
       #
       def authorize!
-        fail Granite::Action::NotAllowedError, self unless allowed?
+        raise Granite::Action::NotAllowedError, self unless allowed?
 
         self
       end

data/lib/granite/action/precondition.rb

@@ -1,6 +1,6 @@
 module Granite
   class Action
-    class Precondition < BasicObject
+    class Precondition < BasicObject # :nodoc:
       UNDEFINED = ::Object.new.freeze
 
       def self.description(text = UNDEFINED)
@@ -17,7 +17,7 @@ module Granite
       end
 
       def call(*)
-        fail NotImplementedError, "#call method must be implemented for #{self.class}"
+        raise NotImplementedError, "#call method must be implemented for #{self.class}"
       end
 
       def method_missing(method_name, *args, &blk)

data/lib/granite/action/preconditions/base_precondition.rb

@@ -1,7 +1,7 @@
 module Granite
   class Action
     module Preconditions
-      class BasePrecondition
+      class BasePrecondition # :nodoc:
         def initialize(*args, &block)
           @options = args.extract_options!
           @args = args

data/lib/granite/action/preconditions/object_precondition.rb

@@ -3,7 +3,7 @@ require 'granite/action/preconditions/base_precondition'
 module Granite
   class Action
     module Preconditions
-      class ObjectPrecondition < BasePrecondition
+      class ObjectPrecondition < BasePrecondition # :nodoc:
         private
 
         def _execute(context)

data/lib/granite/action/preconditions.rb

@@ -13,7 +13,7 @@ module Granite
     module Preconditions
       extend ActiveSupport::Concern
 
-      class PreconditionsCollection
+      class PreconditionsCollection # :nodoc:
         include Enumerable
 
         delegate :each, to: :@preconditions
@@ -36,7 +36,7 @@ module Granite
         self._preconditions = PreconditionsCollection.new
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         # Define preconditions for current action.
         #
         # @param options [Hash] hash with
@@ -61,7 +61,7 @@ module Granite
           key = key.to_s.camelize
           Granite.precondition_namespaces.reduce(nil) do |memo, ns|
             memo || "#{ns.to_s.camelize}::#{key}Precondition".safe_constantize
-          end || fail(NameError, "No precondition class for #{key}Precondition")
+          end || raise(NameError, "No precondition class for #{key}Precondition")
         end
 
         def add_preconditions_hash(*args, **options)

data/lib/granite/action/projectors.rb

@@ -1,9 +1,9 @@
 module Granite
   class Action
-    module Projectors
+    module Projectors # :nodoc:
       extend ActiveSupport::Concern
 
-      class ProjectorsCollection
+      class ProjectorsCollection # :nodoc:
         def initialize(action_class)
           @action_class = action_class
           @storage = {}
@@ -40,9 +40,7 @@ module Granite
           redefine_const(projector_name, projector)
           redefine_const(controller_name, projector.controller_class)
 
-          blocks.each do |block|
-            projector.class_eval(&block)
-          end
+          blocks.each { |block| projector.class_eval(&block) }
 
           projector
         end
@@ -72,7 +70,7 @@ module Granite
         end
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         def _projectors
           @_projectors ||= ProjectorsCollection.new(self)
         end

data/lib/granite/action/subject.rb

@@ -1,25 +1,25 @@
 module Granite
   class Action
-    class SubjectNotFoundError < ArgumentError
+    class SubjectNotFoundError < ArgumentError # :nodoc:
       def initialize(action_class)
         super("Unable to initialize #{action_class} without subject provided")
       end
     end
 
-    class SubjectTypeMismatchError < ArgumentError
+    class SubjectTypeMismatchError < ArgumentError # :nodoc:
       def initialize(action_class, candidate, expected)
         super("Unable to initialize #{action_class} with #{candidate} as subject, expecting instance of #{expected}")
       end
     end
 
-    module Subject
+    module Subject # :nodoc:
       extend ActiveSupport::Concern
 
       included do
         class_attribute :_subject
       end
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         def subject(name, *args, &block)
           reflection = reflect_on_association(name)
           reflection ||= references_one name, *args, &block
@@ -65,7 +65,7 @@ module Granite
         assign_attributes(attributes)
 
         self.subject = args.first unless args.empty?
-        fail SubjectNotFoundError, self.class unless subject
+        raise SubjectNotFoundError, self.class unless subject
       rescue Granite::Form::AssociationTypeMismatch
         raise SubjectTypeMismatchError.new(self.class, args.first.class.name, reflection.klass)
       end

data/lib/granite/action/transaction.rb

@@ -2,7 +2,7 @@ require 'granite/action/transaction_manager'
 
 module Granite
   class Action
-    module Transaction
+    module Transaction # :nodoc:
       extend ActiveSupport::Concern
 
       included do

data/lib/granite/action/transaction_manager/transactions_stack.rb

@@ -21,7 +21,7 @@ module Granite
         end
 
         def add_callback(callback)
-          fail 'Start a transaction before you add callbacks on it' if depth.zero?
+          raise 'Start a transaction before you add callbacks on it' if depth.zero?
 
           @callbacks.last << callback
         end
@@ -46,7 +46,7 @@ module Granite
         end
 
         def finish_current(result)
-          fail ArgumentError, 'No current transaction' if @depth.zero?
+          raise ArgumentError, 'No current transaction' if @depth.zero?
 
           @depth -= 1
 
@@ -58,7 +58,6 @@ module Granite
             @callbacks.pop
           end
         end
-
       end
     end
   end

data/lib/granite/action/transaction_manager.rb

@@ -5,7 +5,7 @@ module Granite
     class Rollback < defined?(ActiveRecord) ? ActiveRecord::Rollback : StandardError
     end
 
-    module TransactionManager
+    module TransactionManager # :nodoc:
       class << self
         # Runs a block in a transaction
         # It will open a new transaction or append a block to the current one if it exists
@@ -23,7 +23,7 @@ module Granite
         def after_commit(listener = nil, &block)
           callback = listener || block
 
-          fail 'Block or object is required to register after_commit hook!' unless callback
+          raise 'Block or object is required to register after_commit hook!' unless callback
 
           transactions_stack.add_callback callback
         end
@@ -70,12 +70,13 @@ module Granite
           return unless collected_errors.any?
 
           log_errors(collected_errors[1..])
-          fail collected_errors.first
+          raise collected_errors.first
         end
 
         def log_errors(errors)
           errors.each do |error|
-            Granite::Form.config.logger.error "Unhandled error in callback: #{error.inspect}\n#{error.backtrace.join("\n")}"
+            message = "Unhandled error in after_commit callback: #{error.inspect}\n#{error.backtrace.join("\n")}"
+            Granite::Form.config.logger.error message
           end
         end
       end

data/lib/granite/action/translations.rb

@@ -1,9 +1,9 @@
 module Granite
   class Action
-    module Translations
+    module Translations # :nodoc:
       extend ActiveSupport::Concern
 
-      module ClassMethods
+      module ClassMethods # :nodoc:
         def i18n_scope
           :granite_action
         end

data/lib/granite/action.rb

@@ -15,13 +15,16 @@ require 'granite/action/subject'
 require 'granite/action/translations'
 
 module Granite
-  class Action
-    class ValidationError < Error
+  class Action # :nodoc:
+    class ValidationError < Error # :nodoc:
       delegate :errors, to: :action
 
       def initialize(action)
         errors = action.errors.full_messages.join(', ')
-        super(I18n.t(:"#{action.class.i18n_scope}.errors.messages.action_invalid", action: action.class, errors: errors, default: :'errors.messages.action_invalid'), action)
+        super(I18n.t(:"#{action.class.i18n_scope}.errors.messages.action_invalid",
+                     action: action.class,
+                     errors: errors,
+                     default: :'errors.messages.action_invalid'), action)
       end
     end
 
@@ -102,7 +105,7 @@ module Granite
     protected
 
     def raise_validation_error(original_error = nil)
-      fail ValidationError, self, original_error&.backtrace
+      raise ValidationError, self, original_error&.backtrace
     end
   end
 end

data/lib/granite/assign_data.rb

@@ -1,5 +1,5 @@
 module Granite
-  module AssignData
+  module AssignData # :nodoc:
     DataAssignment = Struct.new(:method, :options) # rubocop:disable Lint/StructNewOverride
 
     extend ActiveSupport::Concern
@@ -14,7 +14,7 @@ module Granite
       assign_data :sync_attributes
     end
 
-    module ClassMethods
+    module ClassMethods # :nodoc:
       # Defines a callback to call when assigning data from business action to model.
       # @param methods [Array<Symbol>] list of methods to call
       # @param block [Proc] a block to call

data/lib/granite/config.rb

@@ -2,7 +2,7 @@ require 'singleton'
 require 'active_support/core_ext/object/try'
 
 module Granite
-  class Config
+  class Config # :nodoc:
     include Singleton
 
     attr_accessor :base_controller

data/lib/granite/context.rb

@@ -1,7 +1,7 @@
 require 'singleton'
 
 module Granite
-  class Context
+  class Context # :nodoc:
     include Singleton
 
     def view_context

data/lib/granite/context_proxy.rb

@@ -7,7 +7,7 @@ module Granite
   module ContextProxy
     extend ActiveSupport::Concern
 
-    module ClassMethods
+    module ClassMethods # :nodoc:
       PROXY_CONTEXT_KEY = :granite_proxy_context
 
       def with(data)

data/lib/granite/dispatcher.rb

@@ -1,64 +1,67 @@
 require 'memoist'
 require 'action_controller/metal/exceptions'
 
-class Granite::Dispatcher
-  extend Memoist
+module Granite
+  class Dispatcher # :nodoc:
+    extend Memoist
 
-  # Make dispatcher object pristine, clean memoist cache.
-  def reset!
-    unmemoize_all
-  end
+    # Make dispatcher object pristine, clean memoist cache.
+    def reset!
+      unmemoize_all
+    end
 
-  def call(*)
-    # Pretend to be a Rack app, however we are still dispatcher, so this method should never be called
-    # see lib/granite/routing/mapping.rb for more info.
-    fail 'Dispatcher can\'t be used as a Rack app.'
-  end
+    def call(*)
+      # Pretend to be a Rack app, however we are still dispatcher, so this method should never be called
+      # see lib/granite/routing/mapping.rb for more info.
+      raise 'Dispatcher can\'t be used as a Rack app.'
+    end
 
-  def serve(req)
-    controller, action = detect_controller_class_and_action_name(req)
-    controller.action(action).call(req.env)
-  end
+    def serve(req)
+      controller, action = detect_controller_class_and_action_name(req)
+      controller.action(action).call(req.env)
+    end
 
-  def constraints
-    [->(req) { detect_controller_class_and_action_name(req).all?(&:present?) }]
-  end
+    def constraints
+      [->(req) { detect_controller_class_and_action_name(req).all?(&:present?) }]
+    end
 
-  def controller(params, *_args)
-    projector(*params.values_at(:granite_action, :granite_projector))&.controller_class
-  end
+    def controller(params, *_args)
+      projector(*params.values_at(:granite_action, :granite_projector))&.controller_class
+    end
 
-  def prepare_params!(params, *_args)
-    params
-  end
+    def prepare_params!(params, *_args)
+      params
+    end
 
-  private
+    private
 
-  def detect_controller_class_and_action_name(req)
-    [
-      controller(req.params),
-      action_name(
-        req.request_method_symbol,
-        *req.params.values_at(:granite_action, :granite_projector, :projector_action)
-      )
-    ]
-  end
+    def detect_controller_class_and_action_name(req)
+      [
+        controller(req.params),
+        action_name(
+          req.request_method_symbol,
+          *req.params.values_at(:granite_action, :granite_projector, :projector_action)
+        )
+      ]
+    end
 
-  memoize def action_name(request_method_symbol, granite_action, granite_projector, projector_action)
-    projector = projector(granite_action, granite_projector)
-    return unless projector
+    memoize def action_name(request_method_symbol, granite_action, granite_projector, projector_action)
+      projector = projector(granite_action, granite_projector)
+      return unless projector
 
-    projector.action_for(request_method_symbol, projector_action.to_s)
-  end
+      projector.action_for(request_method_symbol, projector_action.to_s)
+    end
 
-  memoize def projector(granite_action, granite_projector)
-    action = business_action(granite_action)
+    memoize def projector(granite_action, granite_projector)
+      action = business_action(granite_action)
 
-    action.public_send(granite_projector) if action.respond_to?(granite_projector)
-  end
+      action.public_send(granite_projector) if action.respond_to?(granite_projector)
+    end
 
-  memoize def business_action(granite_action)
-    granite_action.camelize.safe_constantize ||
-      fail(ActionController::RoutingError, "Granite action '#{granite_action}' is mounted but class '#{granite_action.camelize}' can't be found")
+    memoize def business_action(granite_action)
+      granite_action.camelize.safe_constantize ||
+      raise(ActionController::RoutingError,
+            "Granite action '#{granite_action}' is mounted but class '#{granite_action.camelize}' can't be found")
+    end
   end
 end

data/lib/granite/projector/controller_actions.rb

@@ -2,7 +2,7 @@ require 'action_dispatch/routing'
 
 module Granite
   class Projector
-    module ControllerActions
+    module ControllerActions # :nodoc:
       extend ActiveSupport::Concern
 
       included do
@@ -16,8 +16,8 @@ module Granite
         end
       end
 
-      module ClassMethods
-        def action(name, options = {}, &block)
+      module ClassMethods # :nodoc:
+        def action(name, options = {}, &block) # rubocop:disable Metrics/MethodLength
           if block
             self.controller_actions = controller_actions.merge(name.to_sym => options)
             controller_class.__send__(:define_method, name, &block)

data/lib/granite/projector/error.rb

@@ -2,7 +2,7 @@ require 'granite/error'
 
 module Granite
   class Projector
-    class Error < Granite::Error
+    class Error < Granite::Error # :nodoc:
       attr_reader :projector
 
       def initialize(message, projector = nil)

data/lib/granite/projector/helpers.rb

@@ -2,14 +2,14 @@ require 'granite/projector/error'
 
 module Granite
   class Projector
-    class ActionNotMountedError < Error
+    class ActionNotMountedError < Error # :nodoc:
       def initialize(projector)
         super("Seems like #{projector.class} was not mounted. \
 Do you have #{projector.action_name}##{projector.projector_name} declared in routes?", projector)
       end
     end
 
-    module Helpers
+    module Helpers # :nodoc:
       extend ActiveSupport::Concern
 
       def view_context
@@ -35,7 +35,7 @@ Do you have #{projector.action_name}##{projector.projector_name} declared in rou
 
       def required_params
         corresponding_route.required_parts
-          .to_h { |name| [name, action.public_send(name)] }
+                           .to_h { |name| [name, action.public_send(name)] }
       end
 
       def corresponding_route
@@ -51,7 +51,7 @@ Do you have #{projector.action_name}##{projector.projector_name} declared in rou
       end
 
       def fetch_corresponding_route
-        Rails.application.routes.routes.granite_cache[*route_id] || fail(ActionNotMountedError, self)
+        Rails.application.routes.routes.granite_cache[*route_id] || raise(ActionNotMountedError, self)
       end
     end
   end

data/lib/granite/projector/translations.rb

@@ -1,6 +1,6 @@
 module Granite
   class Projector
-    module Translations
+    module Translations # :nodoc:
       include ActionView::Helpers::TranslationHelper
 
       def i18n_scopes

data/lib/granite/projector.rb

@@ -5,7 +5,7 @@ require 'granite/projector/translations'
 require 'granite/context_proxy'
 
 module Granite
-  class Projector
+  class Projector # :nodoc:
     include ContextProxy
     include ControllerActions
     include Helpers

data/lib/granite/routing/cache.rb

@@ -1,6 +1,6 @@
 module Granite
   module Routing
-    class Cache
+    class Cache # :nodoc:
       attr_reader :routes
 
       def initialize(routes)

data/lib/granite/routing/caching.rb

@@ -2,7 +2,7 @@ require 'granite/routing/cache'
 
 module Granite
   module Routing
-    module Caching
+    module Caching # :nodoc:
       def granite_cache
         @granite_cache ||= Cache.new(self)
       end

data/lib/granite/routing/declarer.rb

@@ -1,6 +1,6 @@
 module Granite
   module Routing
-    module Declarer
+    module Declarer # :nodoc:
       class << self
         def declare(routing, route, **options)
           routing.match route.path,

data/lib/granite/routing/mapper.rb

@@ -3,7 +3,7 @@ require 'granite/routing/route'
 
 module Granite
   module Routing
-    module Mapper
+    module Mapper # :nodoc:
       def granite(projector_path, **options)
         route = Route.new(projector_path, **options.extract!(:path, :as, :projector_prefix))
         Declarer.declare(self, route, **options)

data/lib/granite/routing/mapping.rb

@@ -1,6 +1,6 @@
 module Granite
   module Routing
-    module Mapping
+    module Mapping # :nodoc:
       # Override the `ActionDispatch::Routing::Mapper::Mapping#app` method to
       # be able to mount custom Dispatcher objects. Otherwise, the only way to
       # point a dispatcher to business actions is to mount it as a Rack app

data/lib/granite/routing/route.rb

@@ -1,6 +1,6 @@
 module Granite
   module Routing
-    class Route
+    class Route # :nodoc:
       attr_reader :projector_path, :action_path, :projector_name
 
       def initialize(projector_path, path: nil, as: nil, projector_prefix: false)

data/lib/granite/rspec/action_helpers.rb

@@ -1,8 +1,12 @@
-module Granite::ActionHelpers
-  extend ActiveSupport::Concern
+module Granite
+  module ActionHelpers # :nodoc:
+    extend ActiveSupport::Concern
 
-  delegate :perform!, to: :subject
+    delegate :perform!, to: :subject
+  end
 end
 
-RSpec.configuration.define_derived_metadata(file_path: %r{spec/apq/actions/}) { |metadata| metadata[:type] ||= :granite_action }
+RSpec.configuration.define_derived_metadata(file_path: %r{spec/apq/actions/}) do |metadata|
+  metadata[:type] ||= :granite_action
+end
 RSpec.configuration.include Granite::ActionHelpers, type: :granite_action

data/lib/granite/rspec/perform_action.rb

@@ -1,4 +1,4 @@
-RSpec::Matchers.define :perform_action do |klass|
+RSpec::Matchers.define :perform_action do |klass| # rubocop:disable Metrics/BlockLength
   chain :using do |using|
     @using = using
   end

data/lib/granite/rspec/projector_helpers.rb

@@ -1,54 +1,59 @@
-module Granite::ProjectorHelpers
-  extend ActiveSupport::Concern
-  include RSpec::Rails::ControllerExampleGroup
+module Granite
+  module ProjectorHelpers # :nodoc:
+    extend ActiveSupport::Concern
+    include RSpec::Rails::ControllerExampleGroup
 
-  included do
-    before { Granite::Routing::Declarer.dispatcher.unmemoize_all }
-  end
+    included do
+      before { Granite::Routing::Declarer.dispatcher.unmemoize_all }
+    end
 
-  module ClassMethods
-    def draw_routes(&block)
-      before(:all) do
-        routes = Rails.application.routes
-        routes.disable_clear_and_finalize = true
-        routes.draw(&block)
+    module ClassMethods # :nodoc:
+      def draw_routes(&block)
+        before(:all) do
+          routes = Rails.application.routes
+          routes.disable_clear_and_finalize = true
+          routes.draw(&block)
+        end
+
+        after(:all) do
+          Rails.application.routes.disable_clear_and_finalize = false
+          Rails.application.reload_routes!
+          Rails.application.routes.routes.clear_cache!
+        end
       end
 
-      after(:all) do
-        Rails.application.routes.disable_clear_and_finalize = false
-        Rails.application.reload_routes!
-        Rails.application.routes.routes.clear_cache!
+      def projector(&block)
+        setup_controller
+        setup_view_context
+        let(:projector_class, &block)
+        let(:projector) { controller.projector }
       end
-    end
 
-    def projector(&block)
-      setup_controller
-      setup_view_context
-      let(:projector_class, &block)
-      let(:projector) { controller.projector }
-    end
+      private
 
-    private
+      def setup_controller
+        define_method :setup_controller_request_and_response do
+          @controller ||= projector_class.controller_class.new
+          super()
+        end
+      end
 
-    def setup_controller
-      define_method :setup_controller_request_and_response do
-        @controller ||= projector_class.controller_class.new
-        super()
+      def setup_view_context
+        before { Granite.view_context = controller.view_context }
+        after { Granite.view_context = nil }
       end
     end
 
-    def setup_view_context
-      before { Granite.view_context = controller.view_context }
-      after { Granite.view_context = nil }
+    # Overrides ActionController::TestCase::Behavior#process to include granite_action and granite_projector
+    def process(action, **options)
+      projector_params = { granite_action: projector_class.action_name,
+                           granite_projector: projector_class.projector_name }
+      super(action, **options, params: projector_params.reverse_merge(options[:params] || {}))
     end
   end
-
-  # Overrides ActionController::TestCase::Behavior#process to include granite_action and granite_projector
-  def process(action, **options)
-    projector_params = {granite_action: projector_class.action_name, granite_projector: projector_class.projector_name}
-    super(action, **options, params: projector_params.reverse_merge(options[:params] || {}))
-  end
 end
 
-RSpec.configuration.define_derived_metadata(file_path: %r{spec/apq/projectors/}) { |metadata| metadata[:type] ||= :granite_projector }
+RSpec.configuration.define_derived_metadata(file_path: %r{spec/apq/projectors/}) do |metadata|
+  metadata[:type] ||= :granite_projector
+end
 RSpec.configuration.include Granite::ProjectorHelpers, type: :granite_projector

data/lib/granite/rspec/raise_validation_error.rb

@@ -38,13 +38,9 @@ RSpec::Matchers.define :raise_validation_error do
     expected
   end
 
-  failure_message do
-    "expected to #{description}"
-  end
+  failure_message { "expected to #{description}" }
 
-  failure_message_when_negated do
-    "expected not to #{description}"
-  end
+  failure_message_when_negated { "expected not to #{description}" }
 
   supports_block_expectations
 end

data/lib/granite/rspec/satisfy_preconditions.rb

@@ -16,13 +16,13 @@
 # ```ruby
 # # assuming subject is business action
 # it { is_expected.to satisfy_preconditions }
-# it { is_expected.not_to satisfy_preconditions.with_message('Tax form has not been signed') }
-# it { is_expected.not_to satisfy_preconditions.with_messages(/^Tax form has not been signed by/', 'Signature required') }
-# it { is_expected.not_to satisfy_preconditions.with_message_of_kind(:relevant_portfolio_items_needed) }
-# it { is_expected.not_to satisfy_preconditions.with_messages_of_kinds(:relevant_portfolio_items_needed, :relevant_education_needed) }
+# it { is_expected.not_to satisfy_preconditions.with_message('Form has not been signed') }
+# it { is_expected.not_to satisfy_preconditions.with_messages(/^Form has not been signed by/', 'Signature required') }
+# it { is_expected.not_to satisfy_preconditions.with_message_of_kind(:portfolio_needed) }
+# it { is_expected.not_to satisfy_preconditions.with_messages_of_kinds(:portfolio_needed, :relevant_education_needed) }
 # ```
 #
-RSpec::Matchers.define :satisfy_preconditions do
+RSpec::Matchers.define :satisfy_preconditions do # rubocop:disable Metrics/BlockLength
   chain(:with_message) do |message|
     @expected_messages = [message]
   end
@@ -44,7 +44,7 @@ RSpec::Matchers.define :satisfy_preconditions do
   end
 
   match do |object|
-    fail '"with_messages" method chain is not supported for positive matcher' if @expected_messages
+    raise '"with_messages" method chain is not supported for positive matcher' if @expected_messages
 
     object.satisfy_preconditions?
   end

data/lib/granite/translations.rb

@@ -1,5 +1,5 @@
 module Granite
-  class Translations
+  class Translations # :nodoc:
     class << self
       def combine_paths(paths1, paths2)
         paths1.flat_map do |path1|

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.17.1'.freeze
+  VERSION = '0.17.2'.freeze
 end

data/lib/granite.rb

@@ -6,7 +6,7 @@ require 'granite/version'
 require 'granite/config'
 require 'granite/context'
 
-module Granite
+module Granite # :nodoc:
   def self.config
     Granite::Config.instance
   end
@@ -15,6 +15,10 @@ module Granite
     Granite::Context.instance
   end
 
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('1.0.0', 'Granite')
+  end
+
   singleton_class.delegate(*Granite::Config.delegated, to: :config)
   singleton_class.delegate(*Granite::Context.delegated, to: :context)
 end

data/lib/rubocop/granite/inject.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
 # See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
 module RuboCop
@@ -11,7 +9,7 @@ module RuboCop
         path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.load_file(path)
         config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
+        Rails.logger.debug { "configuration from #{path}" } if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(config, path)
         ConfigLoader.instance_variable_set(:@default_configuration, config)
       end

data/lib/rubocop/granite.rb

@@ -1,5 +1,5 @@
 module RuboCop
-  module Granite
+  module Granite # :nodoc:
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'rubocop-default.yml').freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze

data/lib/rubocop-granite.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'rubocop'
 
 require_relative 'rubocop/granite'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.2
 platform: ruby
 authors:
 - Toptal Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -31,39 +31,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: granite-form
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: granite-form
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.2'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: memoist
   requirement: !ruby/object:Gem::Requirement
@@ -233,75 +233,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.63.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.63.5
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: 2.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: 2.25.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 2.29.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 2.29.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -392,7 +392,8 @@ files:
 homepage: https://github.com/toptal/granite
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -401,14 +402,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.10
 signing_key: 
 specification_version: 4
 summary: Another business actions architecture for Rails apps