freezolite 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +25 -3
- data/lib/freezolite/version.rb +1 -1
- data/lib/freezolite.rb +16 -0
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18bc2494d538e458f1ae9c25fd383df2d9b4c552b00d20680ada3c6ef0ad1b4b
|
4
|
+
data.tar.gz: b7adf7bff785d8a2968706f3229f60fdb2aefc59bfe5ce9c59aa165eb6f7410a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f1636d49db0a5fb812f1f95580ea4fec4742a96093e0bd14fa5b74567e15115190b1e0a23cb0d0666a639c8d01fcc16bcbf7f1a05b34fbc4e542fdf39a1cd535
|
7
|
+
data.tar.gz: 072207d396781631046c8bde02109528ecda9534475593950b7b18703344658efd560d79e931be1c9261f07111284d88f6a35089c35887b4cc1a55c416dff69c
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -5,7 +5,11 @@
|
|
5
5
|
|
6
6
|
Tired of adding `# frozen_string_literals: true` to every file in your project or running `rubocop -A` to make it do that for you? What if I told you that you can just add a single gem to your project and activate this option **for the project's files** automatically (without enabling it globally)?
|
7
7
|
|
8
|
-
Freezolite is a gem that
|
8
|
+
Freezolite is a gem that turns the `frozen_string_literal` compile option on only for the specified files. Thus it's like running Ruby with `--enable=frozen-string-literal` but only for the files you own.
|
9
|
+
|
10
|
+
> 📖 Read more about the motivation behind this project in ["Freezolite: the magic gem for keeping Ruby literals safely frozen"](https://evilmartians.com/chronicles/freezolite-the-magic-gem-for-keeping-ruby-literals-safely-frozen) post.
|
11
|
+
|
12
|
+
Freezolite also comes with experimental support for [freezing constants](#freezing-constants).
|
9
13
|
|
10
14
|
## Usage
|
11
15
|
|
@@ -15,7 +19,7 @@ Add the gem to your Gemfile:
|
|
15
19
|
gem "freezolite"
|
16
20
|
```
|
17
21
|
|
18
|
-
And drop the following line
|
22
|
+
And drop the following line into your application entry-point **after loading dependencies** and before loading your application code. For example, in Rails, you can put it in `config/application.rb` after the `Bundler.require(...)` call:
|
19
23
|
|
20
24
|
```ruby
|
21
25
|
# config/application.rb
|
@@ -40,12 +44,30 @@ Freezolite.setup(
|
|
40
44
|
)
|
41
45
|
```
|
42
46
|
|
43
|
-
|
47
|
+
> [!NOTE]
|
48
|
+
> When using auto mode, the `<project-root>/vendor/bundle` folder is excluded automatically. In manual mode, you may want to exclude it yourself.
|
44
49
|
|
45
50
|
### Using with Bootsnap
|
46
51
|
|
47
52
|
Freezolite is compatible with Bootsnap. Just make sure you require it **after** Bootsnap. No manual cache invalidation required.
|
48
53
|
|
54
|
+
### Freezing constants
|
55
|
+
|
56
|
+
Ruby 3 introduced a new pragma—[`# shareable_constant_value: ...`](https://bugs.ruby-lang.org/issues/17273). It's meant to be used with Ractor-driven applications to easily turn constants into Ractor-shareable objects within a source file. Making Ractor-shareable implies **deep freezing**, thus, we can leverage this pragma to automatically freeze constants!
|
57
|
+
|
58
|
+
Freezolite can automatically inject this pragma for you (only for matching files, similarly to frozen literals). You need to opt-in to enable this feature:
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
require "freezolite"
|
62
|
+
# You can also specify specific values, such as literal, experimental_copy, etc.
|
63
|
+
# Setting to `true` is equal to the `literal` value.
|
64
|
+
Freezolite.experimental_freeze_constants = true
|
65
|
+
require "freezolite/auto" # or setup manually
|
66
|
+
```
|
67
|
+
|
68
|
+
> [!NOTE]
|
69
|
+
> This feature is considered experimental for the following reasons: 1) the pragma itself is not widely used and we still need to learn how to use it in our applications; 2) unlike `# frozen_string_literal`, this setting is not a compiler option but a parser context switch; thus, we have to use source transform here, and literally add a line to the source file, thus, breaking the line numbers in your stack traces, etc.
|
70
|
+
|
49
71
|
### Supported Ruby versions
|
50
72
|
|
51
73
|
- Ruby (MRI) >= 2.7.0
|
data/lib/freezolite/version.rb
CHANGED
data/lib/freezolite.rb
CHANGED
@@ -4,6 +4,12 @@ require "freezolite/version"
|
|
4
4
|
|
5
5
|
module Freezolite
|
6
6
|
class << self
|
7
|
+
attr_reader :experimental_freeze_constants
|
8
|
+
|
9
|
+
def experimental_freeze_constants=(val)
|
10
|
+
@experimental_freeze_constants = (val == true) ? :literal : val
|
11
|
+
end
|
12
|
+
|
7
13
|
def setup(patterns:, exclude_patterns: nil)
|
8
14
|
require "require-hooks/setup"
|
9
15
|
|
@@ -14,6 +20,16 @@ module Freezolite
|
|
14
20
|
ensure
|
15
21
|
::RubyVM::InstructionSequence.compile_option = {frozen_string_literal: was_frozen_string_literal}
|
16
22
|
end
|
23
|
+
|
24
|
+
if experimental_freeze_constants
|
25
|
+
val = experimental_freeze_constants
|
26
|
+
RequireHooks.source_transform(patterns: patterns, exclude_patterns: exclude_patterns) do |path, source|
|
27
|
+
source ||= File.read(path)
|
28
|
+
"# shareable_constant_value: #{val}\n#{source}"
|
29
|
+
end
|
30
|
+
end
|
17
31
|
end
|
18
32
|
end
|
33
|
+
|
34
|
+
self.experimental_freeze_constants = false
|
19
35
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: freezolite
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Vladimir Dementyev
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-04-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: require-hooks
|
@@ -88,7 +88,7 @@ metadata:
|
|
88
88
|
documentation_uri: https://github.com/ruby-next/freezolite
|
89
89
|
homepage_uri: https://github.com/ruby-next/freezolite
|
90
90
|
source_code_uri: https://github.com/ruby-next/freezolite
|
91
|
-
post_install_message:
|
91
|
+
post_install_message:
|
92
92
|
rdoc_options: []
|
93
93
|
require_paths:
|
94
94
|
- lib
|
@@ -103,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
103
103
|
- !ruby/object:Gem::Version
|
104
104
|
version: '0'
|
105
105
|
requirements: []
|
106
|
-
rubygems_version: 3.4.
|
107
|
-
signing_key:
|
106
|
+
rubygems_version: 3.4.19
|
107
|
+
signing_key:
|
108
108
|
specification_version: 4
|
109
109
|
summary: Example description
|
110
110
|
test_files: []
|