freezolite 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d38f192f8ba9768ac96058e43921c5e86cbf790c7fb909fddc615f78c1e089
-  data.tar.gz: f90cbf1ee37aeaa829654314d01d5d1faac1fcd55190aafbcbff566888c3e31d
+  metadata.gz: 2bed25358ffb5313cf2816282bc8a2e38516a283d7373987808c17d476962a07
+  data.tar.gz: 70c3a3a89ebbb11d3d8c81f40450124c0edfc20026e3deae1456ecde3bd09812
 SHA512:
-  metadata.gz: ead24d9fd71f4bd68d47a46abf142e41d73db823eacdd9200821b603050f71260c1a80b6a5045f928511ce8f3278076be965bbb6ad111e133fd1bf512e644f4c
-  data.tar.gz: 51200097eeb7bc815312a9cc13c9690a828ce33deb0be85c51553e9cd9a97c28dabd8a61255dd4f14af82bdd87507d33b1ef590b8742e89241b7d5c38a481d37
+  metadata.gz: c41594c8e976f6df02aa30854ac9dc3dab9b601fe73e648946704d3107b046dee1c2e10a072e1bed5d35b6782e783e45e23a4b43ee0de1606a3c549b8c99605b
+  data.tar.gz: 8739d41c3cca71d36ff559de8e6ce5f25b51208af997ff2555ceaeb088bd47e2a2f404db7fe5f682e6c1699a7940d65a4d6faf205133072e842882a81be22ffa

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 0.3.0 (2023-07-19)
+
+- Ignore `./vendor` by default when using `freezolite/auto`. ([@palkan][])
+
+- Replace `watch_dirs` with `patterns` and `exclude_patterns`. ([@palkan][])
+
 ## 0.2.0 (2023-07-14)
 
 - Change name from `freeze_the_lits` to `freezolite`. ([@palkan][])

data/README.md

@@ -15,10 +15,17 @@ Add the gem to your Gemfile:
 gem "freezolite"
 ```
 
-And drop the following line to your application entrypoint (e.g., `config/boot.rb` for Rails):
+And drop the following line to your application entry-point **after loading dependencies** and before loading your application code. For example, in Rails, you can put it to `config/application.rb` after the `Bundler.require(...)` call:
 
 ```ruby
+# config/application.rb
+
+#...
+Bundler.require(*Rails.groups)
+
 require "freezolite/auto"
+
+# <application configuration>
 ```
 
 By default, the gem uses `Dir.pwd` to determine the project root. If you want to use a different directory or multiple directories, configure the gem like this:
@@ -27,43 +34,17 @@ By default, the gem uses `Dir.pwd` to determine the project root. If you want to
 require "freezolite"
 
 Freezolite.setup(
-  watch_dirs: ["/path/to/dir1", "/path/to/dir2"]
+  # You must pass a list of glob patterns
+  patterns: ["/path/to/dir1/*.rb", "/path/to/dir2/*.rb"],
+  exclude_patterns: ["/path/to/dir1/vendor/*"]
 )
 ```
 
-### Using with Bootsnap
-
-FreezeTheList is compatible with Bootsnap. Just make sure you require it **after** Bootsnap:
-
-```ruby
-# config/boot.rb
-
-require "bootsnap/setup"
-require "freezolite/auto"
-require "bundler/setup"
-```
-
-### Using in tests
+**NOTE**: When using auto mode, the `<project-root>/vendor/bundle` folder is excluded automatically. In manual mode, you may want to exclude it yourself.
 
-Usually, when we load tests we use different entry-points. Thus, we need to load `freezolite` differently if we want to enable auto-freezing for test files, too. 
-
-#### RSpec
-
-Put the following line to `spec_helper.rb`:
-
-```ruby
-require "freezolite/auto"
-```
-
-Make sure you have `spec_helper.rb` _preloaded_ by RSpec by putting the following to the `.rspec` file:
-
-```txt
---require spec_helper
-```
-
-#### Minitest
+### Using with Bootsnap
 
-🤷‍♂️
+Freezolite is compatible with Bootsnap. Just make sure you require it **after** Bootsnap. No manual cache invalidation required.
 
 ### Supported Ruby versions
 

data/lib/freezolite/auto.rb

@@ -1,3 +1,6 @@
 require "freezolite"
 
-Freezolite.setup(watch_dirs: [Dir.pwd])
+Freezolite.setup(
+  patterns: [File.join(Dir.pwd, "*.rb")],
+  exclude_patterns: [File.join(Dir.pwd, "vendor", "*")]
+)

data/lib/freezolite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Freezolite # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/freezolite.rb

@@ -4,14 +4,17 @@ require "freezolite/version"
 
 module Freezolite
   class << self
-    attr_accessor :watch_dirs
+    attr_accessor :patterns, :exclude_patterns
+
+    def setup(patterns:, exclude_patterns: nil)
+      self.patterns = patterns
+      self.exclude_patterns = exclude_patterns
 
-    def setup(watch_dirs:)
-      self.watch_dirs = watch_dirs.freeze
       require "require-hooks/setup"
 
       ::RequireHooks.around_load do |path, &block|
-        next block.call unless watch_dirs.any? { |dir| path.start_with?(dir) }
+        next block.call unless patterns.any? { |pattern| File.fnmatch?(pattern, path) }
+        next block.call if exclude_patterns&.any? { |pattern| File.fnmatch?(pattern, path) }
 
         begin
           was_frozen_string_literal = ::RubyVM::InstructionSequence.compile_option[:frozen_string_literal]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freezolite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require-hooks