isolator 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3330be0a90b276b54420aa7a44a79417cacb5c55edb2fc59bc1f6fa85774d5d3
-  data.tar.gz: d97281da4ea2e8f8cfb92703035b76e1e47969477fb1f462c9f382183439ce7d
+  metadata.gz: 1f375e040a8810bf83286b3bd78172a5b3e17504c21dc71d74dcc09b6313427d
+  data.tar.gz: faf57a3cc344a2fb889cc0ba87a1b47b33514330247b5d44574cf765e763c451
 SHA512:
-  metadata.gz: 7e74da7cd7c11f149b3e2d80f1b23ea6ee605de8219d9ae54576019bb42ef010f53f185e648dae4fe1fc007e7f38d3dd2ad19b1fdf6542266ff2f03f50cc6cdd
-  data.tar.gz: 91ab7e065521a8a0ebb001528fbf31e6df2008089b0e9f544a4c2c128278f321f652bde932d0e3c46eb79f8121289de763946f012946f57eba72ba6a027b1616
+  metadata.gz: 4136572ecead2ed8eaef576958c317ef2ff42d8502a9caa04c974ca1ce5e5661231c42dfa83039e81d6cca45e13926115709c61223d381e42e83bf24f8ca9395
+  data.tar.gz: 42de6787f0c17d7b5da48be6b465479a37b4e20e7590cafaf261edf5f0ca29a9a341d451dfb6293aacb7e9958d0e47cf3aefcd53c77c900fe5ff3e04de15de6e

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.4.0 (2018-06-15)
+
+- [PR [#13](https://github.com/palkan/isolator/pull/13)] Allow load ignored offences from YML file using `load_ignore_config`. ([@DmitryTsepelev][])
+
 ## 0.3.0 (2018-04-02)
 
 - Add support for the [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner) gem. ([@Envek][])
@@ -42,3 +46,4 @@
 [@TheSmartnik]: https://github.com/TheSmartnik
 [@dsalahutdinov]: https://github.com/dsalahutdinov
 [@Envek]: https://github.com/Envek
+[@DmitryTsepelev]: https://github.com/DmitryTsepelev

data/README.md

@@ -131,6 +131,10 @@ Isolator.adapters.http.disable!
 Isolator.adapters.http.enable!
 ```
 
+### Fix Offenses
+
+For the actions that should be executed only after successful transaction commit (which is mostly always so), you can try to use the `after_commit` callback from [after_commit_everywhere] gem (or use native AR callback in models if it's applicable).
+
 ### Ignore Offenses
 
 Since Isolator adapter is just a wrapper over original code, it may lead to false positives when there is another library patching the same behaviour. In that case you might want to ignore some offenses.
@@ -145,6 +149,22 @@ Isolator.adapters.sidekiq.ignore_if { Thread.current[:sidekiq_postpone] }
 
 You can add as many _ignores_ as you want, the offense is registered iff all of them return false.
 
+### Using with legacy Rails codebases
+
+If you already have a huge Rails project it can be a tricky to turn Isolator on because you'll immediately get a lot of failed specs. If you want to fix detected issues one by one, you can list all of them in the special file `.isolator_todo.yml` in a following way:
+
+```
+sidekiq:
+  - app/models/user.rb:20
+  - app/models/sales/**/*.rb
+```
+
+All the exceptions raised in the listed lines will be ignored.
+
+### Using with legacy Ruby codebases
+
+If you are not using Rails, you'll have to load ignores from file manually, using `Isolator#load_ignore_config`, for instance `Isolator.load_ignore_config("./config/.isolator_todo.yml")`
+
 ## Custom Adapters
 
 An adapter is just a combination of a _method wrapper_ and lifecycle hooks.
@@ -157,10 +177,10 @@ Suppose that you have a class `Danger` with a method `#explode`, which is not sa
 #
 # The second argument is the method owner and
 # the third one is a method name.
-Isolotar.isolate :danger, Danger, :explode, **options
+Isolator.isolate :danger, Danger, :explode, options
 
 # NOTE: if you want to isolate a class method, use signleton_class instead
-Isolator.isolate :danger, Danger.singleton_class, :explode, **options
+Isolator.isolate :danger, Danger.singleton_class, :explode, options
 ```
 
 Possible `options` are:
@@ -189,3 +209,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 [Sniffer]: https://github.com/aderyabin/sniffer
 [uniform_notifier]: https://github.com/flyerhzm/uniform_notifier
+[after_commit_everywhere]: https://github.com/Envek/after_commit_everywhere

data/isolator.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails", "~> 3.0"
   spec.add_development_dependency "minitest", "~> 5.10.0"
-  spec.add_development_dependency "rubocop", "~> 0.51"
+  spec.add_development_dependency "rubocop", "~> 0.56.0"
   spec.add_development_dependency "rubocop-md", "~> 0.2"
 
   spec.add_development_dependency "uniform_notifier", "~> 1.11"

data/lib/isolator/ignorer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Isolator
+  # Add .load_ignore_config function for ignoring patterns from file
+  module Ignorer
+    def load_ignore_config(path)
+      return unless File.exist?(path)
+
+      todos = YAML.load_file(path)
+
+      adapters.each do |id, adapter|
+        ignored_paths = todos.fetch(id, [])
+        configure_adapter(adapter, ignored_paths)
+      end
+    end
+
+    private
+
+    def configure_adapter(adapter, ignored_paths)
+      ignores = build_ignore_list(ignored_paths)
+      return if ignores.blank?
+
+      regex = Regexp.new("^.*(#{ignores.join('|')}):.*$")
+      adapter.ignore_if { caller.any? { |row| regex =~ row } }
+    end
+
+    def build_ignore_list(ignored_paths)
+      ignored_paths.each_with_object([]) do |path, result|
+        ignored_files = Dir[path]
+
+        if ignored_files.blank?
+          result << path.to_s
+        else
+          result.concat(ignored_files)
+        end
+      end
+    end
+  end
+end

data/lib/isolator/isolate.rb

@@ -5,7 +5,7 @@ module Isolator
   module Isolate
     def isolate(id, **options)
       raise "Adapter already registered: #{id}" if Isolator.adapters.key?(id.to_s)
-      adapter = AdapterBuilder.call(**options)
+      adapter = AdapterBuilder.call(options)
       Isolator.adapters[id.to_s] = adapter
     end
   end

data/lib/isolator/railtie.rb

@@ -7,6 +7,8 @@ module Isolator
       # (when all deps are likely to be loaded).
       load File.join(__dir__, "adapters.rb")
 
+      Isolator.load_ignore_config(Rails.root.join(".isolator_todo.yml"))
+
       next unless Rails.env.test?
 
       if defined?(::ActiveRecord::TestFixtures)

data/lib/isolator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Isolator
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/isolator.rb

@@ -6,6 +6,7 @@ require "isolator/adapter_builder"
 require "isolator/notifier"
 require "isolator/errors"
 require "isolator/simple_hashie"
+require "isolator/ignorer"
 
 require "isolator/callbacks"
 require "isolator/isolate"
@@ -105,6 +106,7 @@ module Isolator
 
     include Isolator::Isolate
     include Isolator::Callbacks
+    include Isolator::Ignorer
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isolator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sniffer
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 0.56.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -290,6 +290,7 @@ files:
 - lib/isolator/database_cleaner_support.rb
 - lib/isolator/errors.rb
 - lib/isolator/ext/thread_fetch.rb
+- lib/isolator/ignorer.rb
 - lib/isolator/isolate.rb
 - lib/isolator/notifier.rb
 - lib/isolator/orm_adapters.rb
@@ -319,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Detect non-atomic interactions within DB transactions