Merge pull request #1352 from bf4/railties

Fix generators (@dgynn); load Railtie only with Rails, ensures caching configured

Author: bf4

CHANGELOG.md

@@ -58,6 +58,7 @@ Features:
 
 Fixes:
 
+- [#1352](https://github.com/rails-api/active_model_serializers/pull/1352) Fix generators; Isolate Rails-specifc code in Railties (@dgynn, @bf4)
 - [#1384](https://github.com/rails-api/active_model_serializers/pull/1384)Fix database state leaking across tests (@bf4)
 - [#1297](https://github.com/rails-api/active_model_serializers/pull/1297) Fix `fields` option to restrict relationships as well (@beauby)
 - [#1239](https://github.com/rails-api/active_model_serializers/pull/1239) Fix duplicates in JSON API compound documents (@beauby)

Rakefile

@@ -44,7 +44,32 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task default: [:test, :rubocop]
+desc 'Run isolated tests'
+task isolated: ['test:isolated:railtie']
+namespace :test do
+  namespace :isolated do
+    desc 'Run isolated tests for Railtie'
+    task :railtie do
+      dir = File.dirname(__FILE__)
+      file = "#{dir}/test/active_model_serializers/railtie_test_isolated.rb"
+
+      # https://github.com/rails/rails/blob/3d590add45/railties/lib/rails/generators/app_base.rb#L345-L363
+      _bundle_command = Gem.bin_path('bundler', 'bundle')
+      require 'bundler'
+      Bundler.with_clean_env do
+        command = "-w -I#{dir}/lib -I#{dir}/test #{file}"
+        full_command = %("#{Gem.ruby}" #{command})
+        system(full_command) or fail 'Failures' # rubocop:disable Style/AndOr
+      end
+    end
+  end
+end
+
+if ENV['RAILS_VERSION'].to_s > '4.0' && RUBY_ENGINE == 'ruby'
+  task default: [:isolated, :test, :rubocop]
+else
+  task default: [:test, :rubocop]
+end
 
 desc 'CI test task'
 task :ci => [:default]

docs/general/configuration_options.md

@@ -24,4 +24,4 @@ preferably inside an initializer.
 
 ## Hooks
 
-To run a hook when ActiveModelSerializers is loaded, use `ActiveSupport.on_load(:active_model_serializers) do end`
+To run a hook when ActiveModelSerializers is loaded, use `ActiveSupport.on_load(:action_controller) do end`

lib/active_model/serializer/railtie.rb

@@ -1,33 +1,23 @@
 require 'active_model'
 require 'active_support'
-require 'action_controller'
-require 'action_controller/railtie'
+require 'active_support/core_ext/object/with_options'
 module ActiveModelSerializers
-  mattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
-
-  def self.config
-    ActiveModel::Serializer.config
-  end
-
   extend ActiveSupport::Autoload
   autoload :Model
   autoload :Callbacks
   autoload :Deserialization
   autoload :Logging
   autoload :Test
-end
 
-require 'active_model/serializer'
-require 'active_model/serializable_resource'
-require 'active_model/serializer/version'
+  class << self; attr_accessor :logger; end
+  self.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
 
-require 'action_controller/serialization'
-ActiveSupport.on_load(:action_controller) do
-  ActiveSupport.run_load_hooks(:active_model_serializers, ActiveModelSerializers)
-  include ::ActionController::Serialization
-  ActionDispatch::Reloader.to_prepare do
-    ActiveModel::Serializer.serializers_cache.clear
+  def self.config
+    ActiveModel::Serializer.config
   end
-end
 
-require 'active_model/serializer/railtie'
+  require 'active_model/serializer/version'
+  require 'active_model/serializer'
+  require 'active_model/serializable_resource'
+  require 'active_model_serializers/railtie' if defined?(::Rails)
+end

lib/active_model_serializers.rb

@@ -0,0 +1,36 @@
+require 'rails/railtie'
+require 'action_controller'
+require 'action_controller/railtie'
+require 'action_controller/serialization'
+
+module ActiveModelSerializers
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActiveModel::Serializer.serializers_cache.clear
+    end
+
+    initializer 'active_model_serializers.action_controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include(::ActionController::Serialization)
+      end
+    end
+
+    # This hook is run after the action_controller railtie has set the configuration
+    # based on the *environment* configuration and before any config/initializers are run
+    # and also before eager_loading (if enabled).
+    initializer 'active_model_serializers.set_configs', :after => 'action_controller.set_configs' do
+      ActiveModelSerializers.logger = Rails.configuration.action_controller.logger
+      ActiveModelSerializers.config.cache_store     = Rails.configuration.action_controller.cache_store
+      ActiveModelSerializers.config.perform_caching = Rails.configuration.action_controller.perform_caching
+    end
+
+    generators do
+      require 'generators/rails/resource_override'
+    end
+
+    if Rails.env.test?
+      ActionController::TestCase.send(:include, ActiveModelSerializers::Test::Schema)
+      ActionController::TestCase.send(:include, ActiveModelSerializers::Test::Serializer)
+    end
+  end
+end

lib/active_model_serializers/railtie.rb

@@ -4,9 +4,7 @@
 module Rails
   module Generators
     class ResourceGenerator
-      def add_serializer
-        invoke 'serializer'
-      end
+      hook_for :serializer, default: true, boolean: true
     end
   end
 end

lib/generators/serializer/USAGE renamed to lib/generators/rails/USAGE

@@ -15,11 +15,11 @@ def create_serializer_file
       private
 
       def attributes_names
-        [:id] + attributes.select { |attr| !attr.reference? }.map { |a| a.name.to_sym }
+        [:id] + attributes.reject(&:reference?).map! { |a| a.name.to_sym }
       end
 
       def association_names
-        attributes.select { |attr| attr.reference? }.map { |a| a.name.to_sym }
+        attributes.select(&:reference?).map! { |a| a.name.to_sym }
       end
 
       def parent_class_name
@@ -34,4 +34,3 @@ def parent_class_name
     end
   end
 end
-