freeze_the_lits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd11e050953af220f5cf8e23060c68e4cc857641c0bab81f38bf031db29e8e86
+  data.tar.gz: 24a282e9a2e444ced802a5521d2005ec6ba100a08188e7d654804e9f5bbbcfe3
+SHA512:
+  metadata.gz: 2268fdb71dc02d3284db454b1a46cf6d7ef83c2b3c2c666231ff56201d4e31d756f820a96a5f7363aa1fcfd58a890697a0e6df6cb0ac88f08a563cf915d1cb68
+  data.tar.gz: 8b645210b6b9ef36c3f785372104679c033c8c4dea7d748ec30dd377a16cb6f9eced9a91ed760201c21ca94bf3a39934885945466aa95097bd3c3ccba8511c26

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change log
+
+## master
+
+## 0.1.0 (2023-06-15)
+
+- Initial. ([@palkan][])
+
+[@palkan]: https://github.com/palkan

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2023 Vladimir Dementyev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,65 @@
+[![Gem Version](https://badge.fury.io/rb/freeze_the_lits.svg)](https://rubygems.org/gems/freeze_the_lits)
+[![Build](https://github.com/ruby-next/freeze_the_lits/workflows/Build/badge.svg)](https://github.com/palkan/freeze_the_lits/actions)
+
+# Freeze the Lits ❄️
+
+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)?
+
+FreezeTheLits is a gem that turn 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.
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "freeze_the_lits"
+```
+
+And drop the following line to your application entrypoint (e.g., `config/boot.rb` for Rails):
+
+```ruby
+require "freeze_the_lits/auto"
+```
+
+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:
+
+```ruby
+require "freeze_the_lits"
+
+FreezeTheLits.setup(
+  watch_dirs: ["/path/to/dir1", "/path/to/dir2"]
+)
+```
+
+### Using with Bootsnap
+
+FreezeTheList is compatible with Bootsnap. Just make sure you require it **after** Bootsnap:
+
+```ruby
+# config/boot.rb
+
+require "bootsnap/setup"
+require "freeze_the_lits/auto"
+require "bundler/setup
+```
+
+### Using in tests
+
+Usually, when we load tests we use different entry-points. Thus, we need to require the gem in each of them. For example, in Rails, we need to require it in `test_helper.rb` and `rails_helper.rb`:
+
+```ruby
+require "freeze_the_lits/auto"
+```
+
+### Supported Ruby versions
+
+- Ruby (MRI) >= 2.7.0
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ruby-next/freeze_the_lits](https://github.com/ruby-next/freeze_the_lits).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/freeze_the_lits/auto.rb

@@ -0,0 +1,3 @@
+require "freeze_the_lits"
+
+FreezeTheLits.setup(watch_dirs: [Dir.pwd])

data/lib/freeze_the_lits/iseq_mixin.rb

@@ -0,0 +1,19 @@
+module FreezeTheLits
+  module IseqMixin
+    def load_iseq(path)
+      was_frozen_string_literal = RubyVM::InstructionSequence.compile_option[:frozen_string_literal]
+
+      if FreezeTheLits.watch_dirs.any? { |dir| path.start_with?(dir) }
+        RubyVM::InstructionSequence.compile_option = {frozen_string_literal: true}
+
+        defined?(super) ? super : RubyVM::InstructionSequence.compile_file(path)
+      else
+        defined?(super) ? super : nil
+      end
+    ensure
+      RubyVM::InstructionSequence.compile_option = {frozen_string_literal: was_frozen_string_literal}
+    end
+  end
+end
+
+RubyVM::InstructionSequence.singleton_class.prepend(FreezeTheLits::IseqMixin)

data/lib/freeze_the_lits/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FreezeTheLits # :nodoc:
+  VERSION = "0.1.0"
+end

data/lib/freeze_the_lits.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "freeze_the_lits/version"
+
+module FreezeTheLits
+  class << self
+    attr_accessor :watch_dirs
+
+    def setup(watch_dirs:)
+      self.watch_dirs = watch_dirs.freeze
+      require "freeze_the_lits/iseq_mixin"
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: freeze_the_lits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Example description
+email:
+- Vladimir Dementyev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/freeze_the_lits.rb
+- lib/freeze_the_lits/auto.rb
+- lib/freeze_the_lits/iseq_mixin.rb
+- lib/freeze_the_lits/version.rb
+homepage: https://github.com/ruby-next/freeze_the_lits
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ruby-next/freeze_the_lits/issues
+  changelog_uri: https://github.com/ruby-next/freeze_the_lits/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/ruby-next/freeze_the_lits
+  homepage_uri: https://github.com/ruby-next/freeze_the_lits
+  source_code_uri: https://github.com/ruby-next/freeze_the_lits
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: Example description
+test_files: []