refactor: Improve Env-based specs setup

Author: Lokideos

README.md

@@ -213,6 +213,14 @@ If it concerns you, you may configure Logidze to store history data in a separat
 bundle exec rails logidze:model Post --detached
 ```
 
+You can also configure Logidze to always store history data in a separate table for all models:
+
+```ruby
+# config/initializers/logidze.rb
+
+Logidze.log_data_placement = :detached
+```
+
 **IMPORTANT:** Using `--detached` mode for storing historic data slightly decreases performance. Check [bench results] for the details.
 
 ## Usage

lib/generators/logidze/model/model_generator.rb

@@ -63,9 +63,11 @@ def inject_logidze_to_model
         return if update?
 
         indents = "  " * (class_name.scan("::").count + 1)
-        macros_name = (detached? && !Logidze.treat_models_as_detached) ? "has_logidze detached: true\n" : "has_logidze\n"
+        macros_name = detached? ? "has_logidze detached: true\n" : "has_logidze\n"
 
-        inject_into_class(model_file_path, class_name.demodulize, indents + macros_name)
+        if File.readlines("#{destination_root}/#{model_file_path}").grep(/has_logidze/).empty?
+          inject_into_class(model_file_path, class_name.demodulize, indents + macros_name)
+        end
       end
 
       no_tasks do
@@ -97,7 +99,7 @@ def backfill?
         end
 
         def detached?
-          options[:detached]
+          options[:detached] || Logidze.detached_log_placement?
         end
 
         def only_trigger?

lib/generators/logidze/model/templates/migration.rb.erb

@@ -58,7 +58,6 @@ class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::M
     end
 <%- end -%>
 <%- if backfill? -%>
-
     reversible do |dir|
       dir.up do
         <%- if detached?  %>

lib/logidze.rb

@@ -30,9 +30,12 @@ class << self
     attr_accessor :sort_triggers_by_name
     # Determines what Logidze should do when upgrade is needed (:raise | :warn | :ignore)
     attr_reader :on_pending_upgrade
-    # Determines if we should treat all models as detached regardless of the +detached: true+ macros presence
-    # Usable for gem specs setup
-    attr_accessor :treat_models_as_detached
+    # Determines where to store +log_data+:
+    # - +:inline+ - force Logidze to store it in the origin table in the +log_data+ column
+    # - +:detached+ - force Logidze to  store it in the +logidze_data+ table in the +log_data+ column
+    #
+    # By default we do not set +log_data_placement+ value and rely on `has_logidze` macros
+    attr_accessor :log_data_placement
 
     # Temporary disable DB triggers.
     #
@@ -57,6 +60,14 @@ def on_pending_upgrade=(mode)
       @on_pending_upgrade = mode
     end
 
+    def detached_log_placement?
+      @log_data_placement == :detached
+    end
+
+    def inline_log_placement?
+      @log_data_placement == :inline
+    end
+
     private
 
     def with_logidze_setting(name, value)
@@ -75,5 +86,5 @@ def with_logidze_setting(name, value)
   self.return_self_if_log_data_is_empty = true
   self.on_pending_upgrade = :ignore
   self.sort_triggers_by_name = false
-  self.treat_models_as_detached = false
+  self.log_data_placement = nil
 end

lib/logidze/has_logidze.rb

@@ -9,10 +9,10 @@ module HasLogidze
 
     module ClassMethods # :nodoc:
       # Include methods to work with history.
-      def has_logidze(ignore_log_data: Logidze.ignore_log_data_by_default, detached: false)
+      def has_logidze(ignore_log_data: Logidze.ignore_log_data_by_default, detached: Logidze.detached_log_placement?)
         include Logidze::IgnoreLogData
         include Logidze::Model
-        if detached || Logidze.treat_models_as_detached
+        if detached && !Logidze.inline_log_placement?
           # Adds needed behavior to models and alters behavior of some methods from +Logidze::Model+ to
           # work with detached table for `log_data`
           include Logidze::Detachable

spec/dummy/config/application.rb

@@ -28,7 +28,7 @@
 # Store all table log data separately or in the origin table depending on the ENV variable.
 # Used to simplify testing
 LOGIDZE_DETACHED = ENV["LOGIDZE_DETACHED"] == "true"
-Logidze.treat_models_as_detached = LOGIDZE_DETACHED
+Logidze.log_data_placement = LOGIDZE_DETACHED ? :detached : :inline
 
 if AFTER_TRIGGER
   require "generators/logidze/model/model_generator"

spec/generators/model_generator_spec.rb

@@ -64,13 +64,6 @@ class User < ActiveRecord::Base
       context "with detached" do
         let(:base_args) { ["user", "--no-after-trigger", "--detached"] }
 
-        around(:example) do |example|
-          old_value = Logidze.treat_models_as_detached
-          Logidze.treat_models_as_detached = false
-          example.run
-          Logidze.treat_models_as_detached = old_value
-        end
-
         it "creates migration w/o `log_data` column and with correct arguments", :aggregate_failures do
           is_expected.to be_a_file
           is_expected.to contain(/execute procedure logidze_logger\(null, 'updated_at', null, null, null, 'User', #{Logidze::LogidzeData.quoted_table_name}\);/i)

spec/integration/debounce_time_spec.rb

@@ -7,7 +7,7 @@
 
   before(:all) do
     Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
-      successfully "rails generate logidze:model post --debounce_time=5000 #{LOGIDZE_DETACHED ? " --detached" : ""}"
+      successfully "rails generate logidze:model post --debounce_time=5000"
       successfully "rake db:migrate"
 
       # Close active connections to handle db variables

spec/integration/filtering_spec.rb

@@ -6,7 +6,7 @@
   it "cannot be used with both only and except options" do
     Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
       unsuccessfully "rails generate logidze:model post " \
-                     "--only=title --except=created_at #{LOGIDZE_DETACHED ? " --detached" : ""}"
+                     "--only=title --except=created_at"
     end
   end
 
@@ -18,7 +18,7 @@
 
       Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
         successfully "rails generate logidze:model post " \
-                     "--except=#{@except.join(" ")} #{LOGIDZE_DETACHED ? " --detached" : ""}"
+                     "--except=#{@except.join(" ")}"
         successfully "rake db:migrate"
 
         # Close active connections to handle db variables
@@ -73,8 +73,7 @@
       @only = %w[title meta]
 
       Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
-        successfully "rails generate logidze:model post " \
-                     "--only=#{@only.join(" ")} #{LOGIDZE_DETACHED ? " --detached" : ""}"
+        successfully "rails generate logidze:model post --only=#{@only.join(" ")}"
         successfully "rake db:migrate"
 
         # Close active connections to handle db variables
@@ -128,8 +127,7 @@
       @only = %w[title rating]
 
       Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
-        successfully "rails generate logidze:model post " \
-                     "--only=#{@only.join(" ")} #{LOGIDZE_DETACHED ? " --detached" : ""}"
+        successfully "rails generate logidze:model post --only=#{@only.join(" ")}"
         successfully "rake db:migrate"
 
         # Close active connections to handle db variables
@@ -150,8 +148,7 @@
       ActiveRecord::Base.connection_pool.disconnect!
 
       Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
-        successfully "rails generate logidze:model post --except=updated_at #{LOGIDZE_DETACHED ? " --detached" : ""} " \
-                     "--update"
+        successfully "rails generate logidze:model post --except=updated_at --update"
         successfully "rake db:migrate"
 
         ActiveRecord::Base.connection_pool.disconnect!

spec/integration/meta_spec.rb

@@ -7,7 +7,7 @@
 
   before(:all) do
     Dir.chdir("#{File.dirname(__FILE__)}/../dummy") do
-      successfully "rails generate logidze:model user --only-trigger --limit=5 #{LOGIDZE_DETACHED ? " --detached" : ""}"
+      successfully "rails generate logidze:model user --only-trigger --limit=5"
       successfully "rake db:migrate"
 
       # Close active connections to handle db variables