Rename OperationProcessor to Processor

Author: lgebhardt

README.md

@@ -1118,9 +1118,9 @@ Callbacks can be defined for the following `JSONAPI::Resource` events:
 - `:remove_to_one_link`
 - `:replace_fields`
 
-##### `JSONAPI::OperationProcessor` Callbacks
+##### `JSONAPI::Processor` Callbacks
 
-Callbacks can also be defined for `JSONAPI::OperationProcessor` events:
+Callbacks can also be defined for `JSONAPI::Processor` events:
 - `:operation`: Any individual operation.
 - `:find`: A `find` operation is being processed.
 - `:show`: A `show` operation is being processed.
@@ -1141,8 +1141,8 @@ See [Operation Processors] (#operation-processors) for details on using Operatio
 ##### `JSONAPI::OperationsProcessor` Callbacks (a removed feature)
 
 Note: The `JSONAPI::OperationsProcessor` has been removed and replaced with the `JSONAPI::OperationDispatcher`
-and `OperationProcessor` classes per resource. The callbacks have been renamed and moved to the
-`OperationProcessor`s, with the exception of the `operations` callback which is now on the controller.
+and `Processor` classes per resource. The callbacks have been renamed and moved to the
+`Processor`s, with the exception of the `operations` callback which is now on the controller.
 
 ### Controllers
 
@@ -1385,10 +1385,10 @@ end
 
 Operation Processors are called to perform the operation(s) that make up a request. The controller (through the `OperationDispatcher`), creates an `OperatorProcessor` to handle each operation. The processor is created based on the resource name, including the namespace. If a processor does not exist for a resource (namespace matters) the default operation processor is used instead. The default processor can be changed by a configuration setting.
 
-Defining a custom `OperationProcessor` allows for custom callback handling of each operation type for each resource type. For example:
+Defining a custom `Processor` allows for custom callback handling of each operation type for each resource type. For example:
 
 ```ruby
-class Api::V4::BookOperationProcessor < JSONAPI::OperationProcessor
+class Api::V4::BookProcessor < JSONAPI::Processor
   after_find do
     unless @results.is_a?(JSONAPI::ErrorsOperationResult)
       @result.meta[:total_records_found] = @result.record_count
@@ -1402,7 +1402,7 @@ feature only for example purposes), if there wasn't an error in the operation.
 `find` method as well if a different behavior is needed, for example:
 
 ```ruby
-class Api::V4::BookOperationProcessor < JSONAPI::OperationProcessor
+class Api::V4::BookProcessor < JSONAPI::Processor
   def find
     filters = params[:filters]
     include_directives = params[:include_directives]
@@ -1861,9 +1861,9 @@ JSONAPI.configure do |config|
   #:underscored_route, :camelized_route, :dasherized_route, or custom
   config.route_format = :dasherized_route
 
-  # Default OperationProcessor, used if a resource specific one is not defined.
+  # Default Processor, used if a resource specific one is not defined.
   # Must be a class
-  config.default_operation_processor_klass = JSONAPI::OperationProcessor
+  config.default_processor_klass = JSONAPI::Processor
 
   #:integer, :uuid, :string, or custom (provide a proc)
   config.resource_key_type = :integer

lib/jsonapi-resources.rb

@@ -15,7 +15,7 @@
 require 'jsonapi/error_codes'
 require 'jsonapi/request'
 require 'jsonapi/operation_dispatcher'
-require 'jsonapi/operation_processor'
+require 'jsonapi/processor'
 require 'jsonapi/relationship'
 require 'jsonapi/include_directives'
 require 'jsonapi/operation_result'

lib/jsonapi/configuration.rb

@@ -1,5 +1,5 @@
 require 'jsonapi/formatter'
-require 'jsonapi/operation_processor'
+require 'jsonapi/processor'
 require 'concurrent'
 
 module JSONAPI
@@ -14,7 +14,7 @@ class Configuration
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
-                :default_operation_processor_klass,
+                :default_processor_klass,
                 :use_text_errors,
                 :top_level_links_include_pagination,
                 :top_level_meta_include_record_count,
@@ -78,7 +78,7 @@ def initialize
 
       # The default Operation Processor to use if one is not defined specifically
       # for a Resource.
-      self.default_operation_processor_klass = JSONAPI::OperationProcessor
+      self.default_processor_klass = JSONAPI::Processor
 
       # Formatter Caching
       # Set to false to disable caching of string operations on keys and links.
@@ -148,8 +148,8 @@ def exception_class_whitelisted?(e)
       @exception_class_whitelist.flatten.any? { |k| e.class.ancestors.include?(k) }
     end
 
-    def default_operation_processor_klass=(default_operation_processor_klass)
-      @default_operation_processor_klass = default_operation_processor_klass
+    def default_processor_klass=(default_processor_klass)
+      @default_processor_klass = default_processor_klass
     end
 
     attr_writer :allow_include, :allow_sort, :allow_filter

lib/jsonapi/operation.rb

@@ -9,7 +9,7 @@ def initialize(operation_type, resource_klass, options)
     end
 
     def transactional
-      JSONAPI::OperationProcessor._operation_processor_from_resource_type(resource_klass).transactional(operation_type)
+      JSONAPI::Processor._processor_from_resource_type(resource_klass).transactional(operation_type)
     end
 
     def process
@@ -18,7 +18,7 @@ def process
 
     private
     def processor
-      JSONAPI::OperationProcessor.operation_processor_instance_for(resource_klass, operation_type, options)
+      JSONAPI::Processor.processor_instance_for(resource_klass, operation_type, options)
     end
   end
 end

lib/jsonapi/operation_processor.rb lib/jsonapi/processor.rblib/jsonapi/operation_processor.rb renamed to lib/jsonapi/processor.rb

@@ -1,5 +1,5 @@
 module JSONAPI
-  class OperationProcessor
+  class Processor
     include Callbacks
     define_jsonapi_resources_callbacks :find,
                                        :show,
@@ -18,17 +18,17 @@ class OperationProcessor
                                        :operation
 
     class << self
-      def operation_processor_instance_for(resource_klass, operation_type, params)
-        _operation_processor_from_resource_type(resource_klass).new(resource_klass, operation_type, params)
+      def processor_instance_for(resource_klass, operation_type, params)
+        _processor_from_resource_type(resource_klass).new(resource_klass, operation_type, params)
       end
 
-      def _operation_processor_from_resource_type(resource_klass)
-        operation_processor = resource_klass.name.gsub(/Resource$/,'OperationProcessor').safe_constantize
-        if operation_processor.nil?
-          operation_processor = JSONAPI.configuration.default_operation_processor_klass
+      def _processor_from_resource_type(resource_klass)
+        processor = resource_klass.name.gsub(/Resource$/,'Processor').safe_constantize
+        if processor.nil?
+          processor = JSONAPI.configuration.default_processor_klass
         end
 
-        operation_processor
+        processor
       end
 
       def transactional(operation_type)

test/controllers/controller_test.rb

@@ -17,7 +17,7 @@ def test_index
 
   def test_exception_class_whitelist
     original_config = JSONAPI.configuration.dup
-    $PostOperationProcessorRaisesErrors = true
+    $PostProcessorRaisesErrors = true
     # test that the operations dispatcher rescues the error when it
     # has not been added to the exception_class_whitelist
     get :index
@@ -28,14 +28,14 @@ def test_exception_class_whitelist
     get :index
     assert_response 403
   ensure
-    $PostOperationProcessorRaisesErrors = false
+    $PostProcessorRaisesErrors = false
     JSONAPI.configuration = original_config
   end
 
   def test_on_server_error_block_callback_with_exception
     original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.exception_class_whitelist = []
-    $PostOperationProcessorRaisesErrors = true
+    $PostProcessorRaisesErrors = true
 
     @controller.class.instance_variable_set(:@callback_message, "none")
     BaseController.on_server_error do
@@ -49,14 +49,14 @@ def test_on_server_error_block_callback_with_exception
     assert_equal "Internal Server Error", json_response['errors'][0]['title']
     assert_equal "Internal Server Error", json_response['errors'][0]['detail']
   ensure
-    $PostOperationProcessorRaisesErrors = false
+    $PostProcessorRaisesErrors = false
     JSONAPI.configuration = original_config
   end
 
   def test_on_server_error_method_callback_with_exception
     original_config = JSONAPI.configuration.dup
     JSONAPI.configuration.exception_class_whitelist = []
-    $PostOperationProcessorRaisesErrors = true
+    $PostProcessorRaisesErrors = true
 
     #ignores methods that don't exist
     @controller.class.on_server_error :set_callback_message, :a_bogus_method
@@ -68,7 +68,7 @@ def test_on_server_error_method_callback_with_exception
     # test that it renders the default server error response
     assert_equal "Internal Server Error", json_response['errors'][0]['title']
   ensure
-    $PostOperationProcessorRaisesErrors = false
+    $PostProcessorRaisesErrors = false
     JSONAPI.configuration = original_config
   end
 
@@ -84,7 +84,7 @@ def test_on_server_error_callback_without_exception
     # test that it does not render error
     assert json_response.key?('data')
   ensure
-    $PostOperationProcessorRaisesErrors = false
+    $PostProcessorRaisesErrors = false
   end
 
   def test_index_filter_with_empty_result
@@ -3387,13 +3387,13 @@ def test_not_whitelisted_error_in_controller
 
   def test_whitelisted_error_in_controller
     original_config = JSONAPI.configuration.dup
-    $PostOperationProcessorRaisesErrors = true
+    $PostProcessorRaisesErrors = true
     JSONAPI.configuration.exception_class_whitelist = [PostsController::SubSpecialError]
     assert_raises PostsController::SubSpecialError do
       get :show, params: {id: '1'}
     end
   ensure
     JSONAPI.configuration = original_config
-    $PostOperationProcessorRaisesErrors = false
+    $PostProcessorRaisesErrors = false
   end
 end

test/fixtures/active_record.rb

@@ -1573,8 +1573,8 @@ class FlatPostResource < JSONAPI::Resource
 class FlatPostsController < JSONAPI::ResourceController
 end
 
-# CustomOperationProcessors
-class Api::V4::BookOperationProcessor < JSONAPI::OperationProcessor
+# CustomProcessors
+class Api::V4::BookProcessor < JSONAPI::Processor
   after_find do
     unless @results.is_a?(JSONAPI::ErrorsOperationResult)
       @result.meta[:total_records] = @result.record_count
@@ -1583,9 +1583,9 @@ class Api::V4::BookOperationProcessor < JSONAPI::OperationProcessor
   end
 end
 
-class PostOperationProcessor < JSONAPI::OperationProcessor
+class PostProcessor < JSONAPI::Processor
   def find
-    if $PostOperationProcessorRaisesErrors
+    if $PostProcessorRaisesErrors
       raise PostsController::SubSpecialError
     end
     # puts("In custom Operations Processor without Namespace")
@@ -1602,9 +1602,9 @@ def find
 
 module Api
   module V7
-    class CategoryOperationProcessor < JSONAPI::OperationProcessor
+    class CategoryProcessor < JSONAPI::Processor
       def show
-        if $PostOperationProcessorRaisesErrors
+        if $PostProcessorRaisesErrors
           raise PostsController::SubSpecialError
         end
         # puts("In custom Operations Processor without Namespace")
@@ -1616,7 +1616,7 @@ def show
 
 module Api
   module V1
-    class PostOperationProcessor < JSONAPI::OperationProcessor
+    class PostProcessor < JSONAPI::Processor
       def show
         # puts("In custom Operations Processor with Namespace")
         super