auto_freeze 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 627d69c77fff17254fa24464b518fa8ec96208cf5e330766aa3025c15ec0fcfe
+  data.tar.gz: 729dba1b2e421a9ff38fffe62e3e5e2099aa327a8a27ac54fd0102e6a9dbc5ad
+SHA512:
+  metadata.gz: 5c5a8111c77a08e754dd5a06f7bac526bfe6ae3deeda2e00f4b4cf83e7a60463af03a7945ebac9030549486edb51fe8417af67c1276782a52c4a3b0ea0d1a70e
+  data.tar.gz: cc0acbff2058d2b184e64ec3b7dd8bea8286a9d2d48c9252519463645bdcd2d861b4866357deecee1d5b72711a9fc1a884501ace6026336343e570b82b64ddc1

data/README.md

@@ -0,0 +1,60 @@
+# AutoFreeze
+
+Sets the `frozen_string_literal` compile option for your gems.
+
+## Installation
+
+1. In your Gemfile, add this:
+
+```
+gem 'auto_freeze'
+```
+
+2. Run `bundle install` as normal.
+
+## Usage
+
+Before the `Bundler.require` in your application, configure the gems to be
+required with the `frozen_string_literal` compile option set to true.
+By default, all gems are required with frozen strings.
+
+```ruby
+AutoFreeze.setup!
+Bundler.require(*Rails.groups)
+```
+
+You can exclude certain gems:
+
+```ruby
+exclude_gems = %w[
+  arr-pm-0.0.12
+  email_reply_trimmer-0.1.6
+  method_source-1.0.0
+  seed-fu-2.3.9
+  unicode_utils-1.4.0
+].freeze
+AutoFreeze.setup!(excluded_gems: exclude_gems)
+Bundler.require(*Rails.groups)
+```
+
+To only freeze gems you specify, pass an array into `auto_freeze` option:
+
+```ruby
+AutoFreeze.setup!(auto_freeze: %w[httpclient-2.9.0])
+Bundler.require(*Rails.groups)
+```
+
+AutoFreeze will automatically set `frozen_string_literal` compile option to be
+`true` when that gem is required by Bundler.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Thanks
+
+Thanks to
+<https://evilmartians.com/chronicles/freezolite-the-magic-gem-for-keeping-ruby-literals-safely-frozen>
+for the research showing that it was possible to dynamically enable the `frozen_string_literal` option.

data/lib/auto_freeze/version.rb

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

data/lib/auto_freeze.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "auto_freeze/version"
+require 'freezolite'
+
+# Set frozen_string_literals: true when requiring gems.
+module AutoFreeze
+  class << self
+    def setup!(auto_freeze: true, excluded_gems: [])
+      # Freezolite uses File.fnmatch for its patterns.
+      # It also uses load_iseq(<absolute_path>) callback for its around hook.
+      # So to freeze gem, we need to find the absolute path using `Gem.path`.
+      include_patterns = if auto_freeze.is_a?(Array)
+        auto_freeze.flat_map do |gem|
+          Gem::Specification.find_by_full_name(gem).full_require_paths.map do |require_path|
+            File.join(require_path, "*.rb")
+          end
+        end
+      else
+        Gem.path.map { |path| File.join(path, "*.rb") }
+      end
+
+      exclude_patterns = excluded_gems.map { |gem_name| File.join("**", gem_name, "**") }
+
+      freezolite_setup(
+        patterns: include_patterns,
+        exclude_patterns: exclude_patterns
+      )
+    end
+
+    private
+
+    def freezolite_setup(**kwargs)
+      Freezolite.setup(**kwargs)
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: auto_freeze
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thong Kuah
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: freezolite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+description: Allows you to select specific gems to be required with `frozen_string_literal`
+  set to true.
+email:
+- tkuah@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/auto_freeze.rb
+- lib/auto_freeze/version.rb
+homepage: https://gitlab.com/gitlab-org/gitlab/-/tree/master/gems/auto_freeze
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Sets the `frozen_string_literal` compile option for your gems.
+test_files: []