Remove activerecord from runtime dependencies (fixes #58)

flash-gordon · mcmire · commit 6e98bd20b488 · 2020-01-15T12:30:22.000-05:00
This removes activerecord from runtime dependencies and runs tests in an AR-free environment to make sure activesupport doesn't interfere with the gem (I removed one `.blank?` usage along the way).
Side note: ruby 2.7 changed the meaning of `.object_id`, it's not related to memory address anymore. Since I locally tested on 2.7, I added a hacky helper to get an object address on the newest ruby version.
diff --git a/.travis.yml b/.travis.yml
@@ -11,6 +11,7 @@ gemfile:
   - gemfiles/rails_5_1.gemfile
   - gemfiles/rails_5_2.gemfile
   - gemfiles/rails_6_0.gemfile
+  - gemfiles/no_rails.gemfile
 matrix:
   exclude:
     - rvm: ruby-2.4.6
diff --git a/Appraisals b/Appraisals
@@ -24,6 +24,9 @@ appraise "rails_5_2" do
   gem "sqlite3", "~> 1.3.6", platform: [:ruby, :mswin, :mingw]
 end
 
+appraise "no_rails" do
+end
+
 if Gem::Requirement.new(">= 2.5.0").satisfied_by?(Gem::Version.new(RUBY_VERSION))
   appraise "rails_6_0" do
     instance_eval(&common_dependencies)
diff --git a/gemfiles/no_rails.gemfile b/gemfiles/no_rails.gemfile
@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "childprocess"
+gem "pry-byebug", platform: :mri
+gem "pry-nav", platform: :jruby
+gem "rake"
+gem "rspec-core", git: "https://github.com/rspec/rspec-core"
+gem "rspec-expectations", git: "https://github.com/rspec/rspec-expectations"
+gem "rspec-mocks", git: "https://github.com/rspec/rspec-mocks"
+gem "rspec-support", git: "https://github.com/rspec/rspec-support"
+gem "rubocop"
+
+gemspec path: "../"
diff --git a/gemfiles/no_rails.gemfile.lock b/gemfiles/no_rails.gemfile.lock
@@ -0,0 +1,95 @@
+GIT
+  remote: https://github.com/rspec/rspec-core
+  revision: 1174cc5e58ae72fb8cdc689a785089889bfdb740
+  specs:
+    rspec-core (3.10.0.pre)
+      rspec-support (= 3.10.0.pre)
+
+GIT
+  remote: https://github.com/rspec/rspec-expectations
+  revision: c085c5a6f0678ae7f88a489996e391e6b661d8a9
+  specs:
+    rspec-expectations (3.10.0.pre)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.10.0.pre)
+
+GIT
+  remote: https://github.com/rspec/rspec-mocks
+  revision: e6057a61d8a15c4638dec116f68579d83fdd5ad5
+  specs:
+    rspec-mocks (3.10.0.pre)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.10.0.pre)
+
+GIT
+  remote: https://github.com/rspec/rspec-support
+  revision: b83b4cecb3bb56300addae89cb0c437f1af906fb
+  specs:
+    rspec-support (3.10.0.pre)
+
+PATH
+  remote: ..
+  specs:
+    super_diff (0.3.0)
+      attr_extras
+      diff-lcs
+      patience_diff
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    attr_extras (6.2.2)
+    byebug (11.0.1)
+    childprocess (3.0.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    patience_diff (1.1.0)
+      trollop (~> 1.16)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    trollop (1.16.2)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  childprocess
+  pry-byebug
+  pry-nav
+  rake
+  rspec-core!
+  rspec-expectations!
+  rspec-mocks!
+  rspec-support!
+  rubocop
+  super_diff!
+
+BUNDLED WITH
+   2.0.2
diff --git a/gemfiles/rails_5_0.gemfile.lock b/gemfiles/rails_5_0.gemfile.lock
@@ -31,7 +31,6 @@ PATH
   remote: ..
   specs:
     super_diff (0.3.0)
-      activerecord (> 4.2, < 7.0)
       attr_extras
       diff-lcs
       patience_diff
diff --git a/gemfiles/rails_5_1.gemfile.lock b/gemfiles/rails_5_1.gemfile.lock
@@ -31,7 +31,6 @@ PATH
   remote: ..
   specs:
     super_diff (0.3.0)
-      activerecord (> 4.2, < 7.0)
       attr_extras
       diff-lcs
       patience_diff
diff --git a/gemfiles/rails_5_2.gemfile.lock b/gemfiles/rails_5_2.gemfile.lock
@@ -31,7 +31,6 @@ PATH
   remote: ..
   specs:
     super_diff (0.3.0)
-      activerecord (> 4.2, < 7.0)
       attr_extras
       diff-lcs
       patience_diff
diff --git a/gemfiles/rails_6_0.gemfile.lock b/gemfiles/rails_6_0.gemfile.lock
@@ -31,7 +31,6 @@ PATH
   remote: ..
   specs:
     super_diff (0.3.0)
-      activerecord (> 4.2, < 7.0)
       attr_extras
       diff-lcs
       patience_diff
diff --git a/lib/super_diff/equality_matchers/default.rb b/lib/super_diff/equality_matchers/default.rb
@@ -34,7 +34,7 @@ def actual_line
       end
 
       def diff_section
-        if diff.blank?
+        if diff.empty?
           ""
         else
           <<~SECTION
diff --git a/spec/integration/rails/active_record_spec.rb b/spec/integration/rails/active_record_spec.rb
@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe "Integration with Rails's ActiveRecord class", type: :integration do
+RSpec.describe "Integration with Rails's ActiveRecord class", type: :integration, active_record: true do
   context "when using 'super_diff/rspec-rails'" do
     include_context "integration with ActiveRecord"
 
diff --git a/spec/integration/rails/hash_with_indifferent_access_spec.rb b/spec/integration/rails/hash_with_indifferent_access_spec.rb
@@ -1,6 +1,6 @@
 require "spec_helper"
 
-RSpec.describe "Integration with Rails's HashWithIndifferentAccess", type: :integration do
+RSpec.describe "Integration with Rails's HashWithIndifferentAccess", type: :integration, active_record: true do
   context "when using 'super_diff/rspec-rails'" do
     include_context "integration with HashWithIndifferentAccess"
 
diff --git a/spec/integration/rspec/eq_matcher_spec.rb b/spec/integration/rspec/eq_matcher_spec.rb
@@ -251,7 +251,7 @@
     end
   end
 
-  context "when comparing two different Time and ActiveSupport::TimeWithZone instances" do
+  context "when comparing two different Time and ActiveSupport::TimeWithZone instances", active_record: true do
     it "produces the correct failure message when used in the positive" do
       as_both_colored_and_uncolored do |color_enabled|
         snippet = <<~RUBY
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -16,17 +16,26 @@
 
 #---
 
-require "active_record"
+begin
+  require "active_record"
+  active_record_available = true
+rescue LoadError
+  active_record_available = false
+end
 
-ActiveRecord::Base.establish_connection(
-  adapter: "sqlite3",
-  database: ":memory:",
-)
+if active_record_available
+  ActiveRecord::Base.establish_connection(
+    adapter: "sqlite3",
+    database: ":memory:",
+  )
 
-$:.unshift(File.expand_path("../lib", __dir__))
-require "super_diff/rspec-rails"
+  require "super_diff/rspec-rails"
+else
+  require "super_diff/rspec"
+end
 
 Dir.glob(File.expand_path("support/**/*.rb", __dir__)).each do |file|
+  next if !active_record_available && file.include?('models/active_record')
   require file
 end
 
@@ -52,6 +61,8 @@
     config.default_formatter = "documentation"
   end
 
+  config.filter_run_excluding active_record: true unless active_record_available
+
   config.order = :random
   Kernel.srand config.seed
 end
diff --git a/spec/support/object_id.rb b/spec/support/object_id.rb
@@ -0,0 +1,26 @@
+require_relative 'ruby_versions'
+
+if !SuperDiff::Test.jruby? && SuperDiff::Test.version_match?('>= 2.7.0')
+  require 'objspace'
+end
+
+module SuperDiff
+  module Test
+    if jruby?
+      def self.object_id_hex(object)
+        # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
+        "0x%x" % object.hash
+      end
+    elsif version_match?('>= 2.7.0')
+      def self.object_id_hex(object)
+        # Sources: <https://bugs.ruby-lang.org/issues/15408> and <https://bugs.ruby-lang.org/issues/15626#Object-ID>
+        address = JSON.parse(ObjectSpace.dump(object))['address']
+        "0x%016x" % Integer(address, 16)
+      end
+    else
+      def self.object_id_hex(object)
+        "0x%016x" % (object.object_id * 2)
+      end
+    end
+  end
+end
diff --git a/spec/support/ruby_versions.rb b/spec/support/ruby_versions.rb
@@ -3,5 +3,9 @@ module Test
     def self.jruby?
       defined?(JRUBY_VERSION)
     end
+
+    def self.version_match?(version_string)
+      Gem::Requirement.new(version_string).satisfied_by?(Gem::Version.new(RUBY_VERSION))
+    end
   end
 end
diff --git a/spec/unit/equality_matcher_spec.rb b/spec/unit/equality_matcher_spec.rb
@@ -1375,13 +1375,13 @@
             if SuperDiff::Test.jruby?
               # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Player:#{"0x%x" % expected.hash} @inventory=["flatline", "purple body shield"], @character="mirage", @handle="martymcfly", @ultimate=0.8, @shields=0.6, @health=0.3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%x" % actual.hash} @inventory=["wingman", "mastiff"], @character="lifeline", @handle="docbrown", @ultimate=0.8, @shields=0.6, @health=0.3>)
+                alpha_line %(Expected: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(expected)} @inventory=["flatline", "purple body shield"], @character="mirage", @handle="martymcfly", @ultimate=0.8, @shields=0.6, @health=0.3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @inventory=["wingman", "mastiff"], @character="lifeline", @handle="docbrown", @ultimate=0.8, @shields=0.6, @health=0.3>)
               end
             else
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Player:#{"0x%016x" % (expected.object_id * 2)} @handle="martymcfly", @character="mirage", @inventory=["flatline", "purple body shield"], @shields=0.6, @health=0.3, @ultimate=0.8>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%016x" % (actual.object_id * 2)} @handle="docbrown", @character="lifeline", @inventory=["wingman", "mastiff"], @shields=0.6, @health=0.3, @ultimate=0.8>)
+                alpha_line %(Expected: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(expected)} @handle="martymcfly", @character="mirage", @inventory=["flatline", "purple body shield"], @shields=0.6, @health=0.3, @ultimate=0.8>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @handle="docbrown", @character="lifeline", @inventory=["wingman", "mastiff"], @shields=0.6, @health=0.3, @ultimate=0.8>)
               end
             end
           }
@@ -1466,13 +1466,13 @@
             if SuperDiff::Test.jruby?
               # Source: <https://github.com/jruby/jruby/blob/master/core/src/main/java/org/jruby/RubyBasicObject.java>
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Item:#{"0x%x" % expected.hash} @name="camera", @quantity=3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%x" % actual.hash} @inventory=["sword"], @character="Jon", @handle="mcmire", @ultimate=true, @shields=11.4, @health=4>)
+                alpha_line %(Expected: #<SuperDiff::Test::Item:#{SuperDiff::Test.object_id_hex(expected)} @name="camera", @quantity=3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @inventory=["sword"], @character="Jon", @handle="mcmire", @ultimate=true, @shields=11.4, @health=4>)
               end
             else
               colored do
-                alpha_line %(Expected: #<SuperDiff::Test::Item:#{"0x%016x" % (expected.object_id * 2)} @name="camera", @quantity=3>)
-                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{"0x%016x" % (actual.object_id * 2)} @handle="mcmire", @character="Jon", @inventory=["sword"], @shields=11.4, @health=4, @ultimate=true>)
+                alpha_line %(Expected: #<SuperDiff::Test::Item:#{SuperDiff::Test.object_id_hex(expected)} @name="camera", @quantity=3>)
+                beta_line  %(  Actual: #<SuperDiff::Test::Player:#{SuperDiff::Test.object_id_hex(actual)} @handle="mcmire", @character="Jon", @inventory=["sword"], @shields=11.4, @health=4, @ultimate=true>)
               end
             end
           }
diff --git a/spec/unit/object_inspection_spec.rb b/spec/unit/object_inspection_spec.rb
@@ -760,7 +760,7 @@
       end
     end
 
-    context "given an ActiveRecord object" do
+    context "given an ActiveRecord object", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
@@ -798,7 +798,7 @@
       end
     end
 
-    context "given an ActiveRecord::Relation object" do
+    context "given an ActiveRecord::Relation object", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the Relation on a single line" do
           SuperDiff::Test::Models::ActiveRecord::Person.create!(
@@ -855,7 +855,7 @@
       end
     end
 
-    context "given a HashWithIndifferentAccess" do
+    context "given a HashWithIndifferentAccess", active_record: true do
       context "given as_single_line: true" do
         it "returns a representation of the object on a single line" do
           inspection = described_class.inspect(
diff --git a/super_diff.gemspec b/super_diff.gemspec
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = Dir["spec/**/*"]
   s.executables   = Dir["exe/**/*"].map { |f| File.basename(f) }
 
-  s.add_dependency "activerecord", "> 4.2", "< 7.0"
   s.add_dependency "attr_extras"
   s.add_dependency "diff-lcs"
   s.add_dependency "patience_diff"
