remotable 0.6.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc89a5dd898f5030f0ced00996be9fe97cf9f56f4817b664feff997b45be1eb
-  data.tar.gz: 317441824b1507700cd77f17a8a623a472145ee458a3aa6fc68e820f2a0ae1c9
+  metadata.gz: 63584474c5b00a857f670dee818ce28a13afc86ab2cb5aaf6a57bac41bc307d9
+  data.tar.gz: f8737d89d220a3055f48e46b664da8faba882fee0e24532cc2895bf44f3ab32f
 SHA512:
-  metadata.gz: 69072c80830b9bad844d0d1e2347875577c9de503edc8c0b5c28898e2f9612d5697e089365bd8e554e4dc53375445ba6a813d3c2d8df4619873c72ae327dc1cf
-  data.tar.gz: 8b5c7e8760947917691c089d19004b8c665f9fa5abaa35873fe9d203247a832f882ee10e7c39059f249aa34133cf8e79140c745aaf3c2bf082e43495d3187583
+  metadata.gz: ff131813baeba52877f45c3ce493ec219d0e31583eb0571622f96e6a4c29f350cf4a582c8b6cb06848e9e463e49731fdb27cacbdd6df1dd2a1d49396be1e8e1b
+  data.tar.gz: 38f6a48221d360eb17026c128ce70f1e6db301c73540055b9a50c28b4049bd5c3e6ca6c8e9efed9c87103e055243a75e8d80d041607e31706d61125632191c2d

data/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: Tests
+on: [push]
+jobs:
+  rails:
+    name: Rails Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, "3.0"]
+        gemfile: ["gemfiles/rails_6.0.gemfile", "gemfiles/rails_6.1.gemfile"]
+      fail-fast: false
+    env:
+      GEM_HOME: $HOME/.gem
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: 2.2.14
+          bundler-cache: true
+
+      - name: Clean appraisals
+        run: bundle exec appraisal clean
+
+      # We'll let appraisal generate our gemfiles
+      - name: Generate gemfiles
+        run: bundle exec appraisal generate
+
+      # We'll only install the gems for our non-rails-edge tests, those can be run locally
+      # This will overwrite the Gemfile.lock in the root app directory, with the gem versions we need for the test
+      - name: Install gemfile dependencies
+        run: BUNDLE_GEMFILE=${{ matrix.gemfile }} bundle install
+
+      - name: Run the tests
+        id: tests
+        run: bundle exec rake test

data/Appraisals

@@ -1,23 +1,13 @@
-appraise "rails-5.0" do
-  gem "activerecord", "~> 5.0.0"
-  gem "sqlite3", "~> 1.3.6"
-end
-
-appraise "rails-5.1" do
-  gem "activerecord", "~> 5.1.0"
-  gem "sqlite3", "~> 1.3.6"
-end
-
-appraise "rails-5.2" do
-  gem "activerecord", "~> 5.2.0"
-  gem "sqlite3", "~> 1.3.6"
-end
-
 appraise "rails-6.0" do
   gem "activerecord", "~> 6.0.0"
   gem "sqlite3", "~> 1.4.0"
 end
 
+appraise "rails-6.1" do
+  gem "activerecord", "~> 6.1"
+  gem "sqlite3", "~> 1.4.0"
+end
+
 appraise "rails-edge" do
   gem "rails", git: "https://github.com/rails/rails.git", branch: "master", require: "activerecord"
   gem "sqlite3", "~> 1.4.0"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 0.7.0
+* **Bugfix** Ensured ActiveRecord models were using Nosync's `ClassMethods` instead of the non-threadsafe `InstanceMethods`
+
+### 0.6.4
+* **Feature** Added `Remotable.unsafe_nosync!` method to set `nosync` globally using a class variable. As the method name indicates, this is not threadsafe and should only be used for testing or other situations where thread safety is not an issue.
+* **Bugfix** Stopped deferring to `Thread.main` if `nosync` was unset on the current thread; while convenient for tests (see above), it ended up allowing requests to leak state if they were handled on the main thread.
+
+
 ### 0.6.3
 * **Fix** Replaced deprecated calls to URI.escape
 

data/gemfiles/{rails_5.0.gemfile → rails_6.1.gemfile}

@@ -2,7 +2,7 @@
 
 source "http://rubygems.org"
 
-gem "activerecord", "~> 5.0.0"
-gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "~> 6.1"
+gem "sqlite3", "~> 1.4.0"
 
 gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -2,7 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", git: "https://github.com/rails/rails.git", branch: "master", require: "activerecord"
 gem "sqlite3", "~> 1.4.0"
 
 gemspec path: "../"

data/lib/remotable/active_record_extender.rb

@@ -17,6 +17,16 @@ module Remotable
 
 
     included do
+      extend Nosync
+
+      # Has to be re-defined _after_ Nosync is extended, which cannot
+      # be done as part of the ClassMethods module
+      def self.nosync?
+        return true if remote_model.nil?
+        return super if nosync_value?
+        Remotable.nosync?
+      end
+
       before_update   :update_remote_resource,  :unless => :nosync?
       before_create   :create_remote_resource,  :unless => :nosync?
       before_destroy  :destroy_remote_resource, :unless => :nosync?
@@ -41,16 +51,10 @@ module Remotable
 
 
     module ClassMethods
-      include Nosync
 
       attr_accessor :_remote_attribute_map, :_local_attribute_routes, :_expires_after,
         :_remote_timeout, :remotable_skip_validation_on_sync
 
-      def nosync?
-        return true if remote_model.nil?
-        return super if nosync_value?
-        Remotable.nosync?
-      end
 
       # Sets the key with which a resource is identified remotely.
       # If no remote key is set, the remote key is assumed to be :id.
@@ -606,7 +610,7 @@ module Remotable
 
     def merge_remote_errors(errors)
       Remotable.logger.debug "[remotable:#{self.class.name.underscore}:merge_remote_errors](#{fetch_value.inspect}) #{errors.inspect}"
-      errors.each do |attribute, messages|
+      errors.to_h.each do |attribute, messages|
         Array.wrap(messages).each do |message|
           self.errors.add(local_attribute_name(attribute), message)
         end

data/lib/remotable/nosync.rb

@@ -50,8 +50,14 @@ module Remotable
     module ClassMethods
       include InstanceMethods
 
+      def unsafe_nosync!
+        nosync!
+        @_unsafe_nosync = true
+      end
+
       def reset_nosync!
         self.nosync = nil
+        remove_instance_variable :@_unsafe_nosync if instance_variable_defined? :@_unsafe_nosync
       end
 
       def nosync=(val)
@@ -62,7 +68,7 @@ module Remotable
 
       def _nosync
         return Thread.current.thread_variable_get "remotable.nosync.#{self.object_id}" if nosync_defined_on?(Thread.current)
-        return Thread.main.thread_variable_get "remotable.nosync.#{self.object_id}" if nosync_defined_on?(Thread.main)
+        @_unsafe_nosync if instance_variable_defined?(:@_unsafe_nosync)
       end
 
       def _nosync=(value)

data/lib/remotable/version.rb

@@ -1,3 +1,3 @@
 module Remotable
-  VERSION = "0.6.3"
+  VERSION = "0.9.0"
 end

data/remotable.gemspec

@@ -11,13 +11,13 @@ Gem::Specification.new do |s|
   s.summary     = %q{Binds an ActiveRecord model to a remote resource and keeps the two synchronized}
   s.description = %q{Remotable keeps a locally-stored ActiveRecord synchronized with a remote resource.}
 
-  s.add_dependency "activeresource", ">= 3.2"
+  s.add_dependency "activeresource", ">= 5.1.1"
   s.add_dependency "activerecord"
   s.add_dependency "activesupport"
 
   s.add_development_dependency "appraisal"
   s.add_development_dependency "rake"
-  s.add_development_dependency "minitest", "~> 5.10.3"
+  s.add_development_dependency "minitest", "~> 5.14.4"
   s.add_development_dependency "minitest-reporters"
   s.add_development_dependency "minitest-reporters-turn_reporter"
   s.add_development_dependency "pry"

data/test/bespoke_test.rb

@@ -176,7 +176,7 @@ class BespokeTest < ActiveSupport::TestCase
 
     assert_difference "BespokeTenant.count", -1 do
       @tenant = BespokeTenant.find_by_slug(@tenant.slug)
-      assert_equal nil, @tenant
+      assert_nil @tenant
     end
   end
 

data/test/nosync_test.rb

@@ -48,11 +48,9 @@ class NoSyncTest < ActiveSupport::TestCase
     assert_equal true, Tenant.nosync?
   end
 
-  test "nosync? should defer to the main thread's value if set there but not on the current thread" do
+  test "nosync? should not defer to the main thread's value if set there but not on the current thread" do
     Remotable.nosync!
     subthread = Thread.new do
-      assert Remotable.nosync?
-      Remotable.reset_nosync!
       refute Remotable.nosync?
       Thread.stop
     end
@@ -60,6 +58,16 @@ class NoSyncTest < ActiveSupport::TestCase
     assert Remotable.nosync?
   end
 
+  test "unsafe_nosync! should coerce nosync? to true across threads" do
+    Remotable.unsafe_nosync!
+    subthread = Thread.new do
+      assert Remotable.nosync?
+      Thread.stop
+    end
+    sleep 0.1 while subthread.status != "sleep"
+    assert Remotable.nosync?
+  end
+
 
 
   # ========================================================================= #

data/test/remotable_test.rb

@@ -52,7 +52,7 @@ class RemotableTest < ActiveSupport::TestCase
   test "should support setting remote_model to nil" do
     Tenant.with_remote_model(nil) do
       Tenant.remote_model
-      assert_equal nil, Tenant.remote_model, "remote_model didn't get set to nil"
+      assert_nil Tenant.remote_model, "remote_model didn't get set to nil"
       Tenant.create!(:name => "Test 1", :slug => "test-1")
       assert_not_nil Tenant.find_by_name("Test 1"), "new tenant was not found"
     end
@@ -68,6 +68,13 @@ class RemotableTest < ActiveSupport::TestCase
 
     concurrently do
       assert_nil BespokeTenant.find_by_slug(first_slug), "Expected not to find the first model initially"
+      # If the second thread attempts the above lookup after the first thread
+      # has already run the lookup below, the lookup above will find the
+      # _local_ record in the database, which is not what this test is trying
+      # to test -- whether we successfully switch models temporarily in a
+      # mult-threaded situation. The extra sleep call ensures that the first
+      # call completes on both before moving on to the rest of the lookups.
+      sleep rand
       assert_not_nil BespokeTenant.with_remote_model(BespokeModel2.new) {
         BespokeTenant.find_by_slug(first_slug)
         sleep rand
@@ -94,7 +101,7 @@ class RemotableTest < ActiveSupport::TestCase
       :slug => "test-1",
       :remote_id => nil,
       :expires_at => 1.day.ago ) }
-    assert_equal nil, tenant.remote_id
+    assert_nil tenant.remote_id
 
     # Fetching this tenant, Remotable will want to
     # refresh it, but it shouldn't because it can't.
@@ -106,11 +113,11 @@ class RemotableTest < ActiveSupport::TestCase
       :name => "Test 1",
       :slug => "test-1",
       :remote_id => nil ) }
-    assert_equal nil, tenant.remote_id
+    assert_nil tenant.remote_id
 
     # Updating this tenatn, Remotable will want to
     # sync it, but it shouldn't because it can't.
-    assert_equal true, tenant.update_attributes(:name => "Test 2"), "The tenant was not updated (errors: #{tenant.errors.full_messages.join(", ")})"
+    assert_equal true, tenant.update(name: "Test 2"), "The tenant was not updated (errors: #{tenant.errors.full_messages.join(", ")})"
   end
 
 
@@ -170,4 +177,17 @@ class RemotableTest < ActiveSupport::TestCase
   end
 
 
+
+  # ========================================================================= #
+  # ActiveRecordExtender                                                      #
+  # ========================================================================= #
+
+  test "should extend an ActiveRecord subclass with Nosync class methods" do
+    class Example5 < ActiveRecord::Base; self.table_name = "tenants"; end
+    Example5.remote_model BespokeModel.new
+    # Method is _only_ on the class version
+    assert Example5.respond_to?(:unsafe_nosync!)
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotable
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Robert Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 5.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.3
+        version: 5.14.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.3
+        version: 5.14.4
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -228,19 +228,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".simplecov"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.mdown
 - Rakefile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/remotable.rb
 - lib/remotable/active_record_extender.rb

data/.travis.yml

@@ -1,31 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.5
-  - 2.6
-
-gemfile:
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_edge.gemfile
-
-jobs:
-  exclude:
-  - rvm: 2.3
-    gemfile: gemfiles/rails_6.0.gemfile
-  - rvm: 2.3
-    gemfile: gemfiles/rails_edge.gemfile
-  - rvm: 2.4
-    gemfile: gemfiles/rails_6.0.gemfile
-  - rvm: 2.4
-    gemfile: gemfiles/rails_edge.gemfile
-  allow_failures:
-  - gemfile: gemfiles/rails_edge.gemfile
-
-script: bundle exec rake test
-
-# To stop Travis from running tests for a new commit,
-# add the following to your commit message: [ci skip]
-# You should add this when you edit documentation or comments, etc.

data/gemfiles/rails_5.1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activerecord", "~> 5.1.0"
-gem "sqlite3", "~> 1.3.6"
-
-gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activerecord", "~> 5.2.0"
-gem "sqlite3", "~> 1.3.6"
-
-gemspec path: "../"