flickwerk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e651efd8959c74f5444b298eee3a2cd6025be555990fab13877af551bfb23c3
+  data.tar.gz: a204baaa6ca697496c95cb17afa877c1be9c68f2e7bd8160ee68c94ddd41bfb3
+SHA512:
+  metadata.gz: e05aeceb1d30f4763a4f0fe31d064c3eed9251a51da3a8498ec2cdb92d1ebd658017ea39204b7553c2734d8f254b9a9fed19703e9c309b508e2bfc930789e0ba
+  data.tar.gz: c960be6af80cf1d42b710c20c3815284197b93fad2ec1a688730dd2f058f5386c6d2416f4ba5a4ec45e6203538be2cfbcb8eb2d7defede7ea4c290ec163be5e9

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Martin Meyerhoff
+
+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,206 @@
+# Flickwerk
+
+A Railtie for loading autoloadable patches using Zeitwerk. This speeds up Rails bootup and reload time considerable, because other solutions out there load the patches and the associated classes on application bootup, and this gem defers loading the patches until the patched classes are autoloaded.
+
+## Installation
+
+```bash
+bundle add flickwerk
+```
+
+## Usage
+
+Include Flickwerk in your `application.rb` or `engine.rb` file, depending on whether you want to add patches to external libraries from an engine or from your host app.
+
+```rb
+# config/application.rb
+# ...
+class MyApplication < Rails::Application
+  include Flickwerk
+
+  # ...
+end
+```
+
+Then, add patches to `app/patches/models` or `app/patches/controllers` that can be autoloaded.
+
+```rb
+# app/patches/models/user_patch.rb
+module UserPatch
+  def name
+    "Engelbert Humperdinck"
+  end
+
+  User.prepend self
+end
+```
+
+Now, all your users will have Engelbert Humperdinck's name.
+
+You can use Ruby's `prepended` hook in order to run class methods. That's useful for adding scopes or ActiveRecord relationships.
+
+```rb
+# app/patches/models/spree_order_patch.rb
+
+module SpreeOrderPatch
+  def self.prepended(base)
+    base.has_many :goodies
+  end
+
+  Spree::Order.prepend self
+end
+```
+
+If you application now has a class `Goodie` with a foreign key to the `spree_orders` table, you can check on those goodies using the familiar `order.goodies` in your application.
+
+
+### Using Flickwerk in Engines
+
+You can also include Flickwerk in your `engine.rb` file and add patches to your gem.
+
+```rb
+# lib/my_gem/engine.rb
+
+class MyGem::Engine < Rails::Engine
+  include Flickwerk
+  # ...
+end
+```
+
+It's advisable to namespace your patches so they do not conflict with patches added elsewhere:
+
+```rb
+# app/patches/modes/my_engine/spree_order_patch.rb
+module MyEngine::SpreeOrderPatch
+  def self.prepended(base)
+    base.scope :with_goodies, -> { joins(:goodies).where.not(goodie_id: nil) }
+  end
+
+  Spree::Order.prepend self
+end
+```
+
+### Using `super`
+
+Sometimes you want to modify the original result of a method dynamically rather than just overwrite it. Because your patches use `Module.prepend`, this can be easily accomplished, even if you want to modify class methods:
+
+```rb
+# app/models/spree_order_patch.rb
+
+module SpreeOrderPatch
+  module ClassMethods
+    def ransackable_associations
+      super + ["goodies"]
+    end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  def total
+    super - goodies.sum(&:amount)
+  end
+
+  Spree::Order.prepend self
+end
+```
+
+### Manual patches
+
+Flickwerk will look for the string `.prepend` in your patches in order to know which class should be patched. In some circumstances, the name of the class being patched is the result of a method call though, as in the case of patching Solidus' configurable user class. In these cases, you'll have to register the patch with Flickwerk manually:
+
+```rb
+# app/patches/models/my_gem/user_class_patch.rb
+
+module MyGem::UserClassPatch
+  def name
+    "Dr. #{super}"
+  end
+end
+```
+
+```rb
+# lib/my_gem/engine.rb
+
+require "flickwerk"
+
+class MyGem::Engine < Rails::Engine
+  include Flickwerk
+
+  initializer "my_gem.patch_user_class", before: "flickwerk.add_patches" do
+    Flickwerk.patch(Spree.class_variable_get(:@@user_class), "MyGem::UserClassPatch"
+  end
+end
+```
+
+
+### Patching non-autoloadable classes
+
+Classes that are not autoloaded (very generally, that's everything in the `lib` folder) cannot be loaded using the mechanism Flickwerk provides. Put any patches you have for these into your own `lib` folder and `require` them at your discretion:
+
+```rb
+# lib/my_gem/spree_patch.rb
+
+module MyGem::SpreePatch
+  module ClassMethods
+    def river_name
+      "Havel"
+    end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  Spree.prepend self
+end
+```
+
+Require these in a config.to_prepare block in your application
+
+```rb
+# lib/my_gem/engine.rb
+
+class MyGem::Engine
+  # ...
+  initializer "load_lib_patches" do
+    config.to_prepare do
+      root.join("lib/patches").glob("**/*.rb").each do |f|
+        require f
+      end
+    end
+  end
+  # ...
+end
+```
+
+## Considerations
+
+### Aren't patches bad?
+
+Patches are often not the ideal solution. It's often preferable to fix any bugs upstream, or to use a specialized object just in those contexts where necessary. However, in some ecosystems, like the Spree/Solidus ones, core classes are extended in extension gems, and especially things like adding associations can be impossible on anything than the correct ActiveRecord class.
+
+Choose your patches carefully, and always look for better solutions than a patch. Sometimes, they're a good, pragmatic solution though.
+
+### Why don't you call these monkey patches?
+
+Because there are no monkeys involved in writing them - to my knowledge, this is all the work of human beings.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flickwerk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/flickwerk/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Flickwerk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/flickwerk/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/flickwerk/patch_finder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Flickwerk
+  class PatchFinder
+    DECORATED_CLASS_PATTERN = /(?:::)?(?<decorated_class>[\w.:]+)\.prepend[\s(]/
+
+    attr_reader :path, :autoloader
+
+    def initialize(path, autoloader: Rails.autoloaders.main)
+      @autoloader = autoloader
+      @path = path
+    end
+
+    def call
+      path.glob("**/*_patch.rb") do |patch_path|
+        # Match all the classes that are prepended in the file
+        matches = File.read(patch_path).scan(DECORATED_CLASS_PATTERN).flatten
+
+        # Don't do a thing if there's no prepending.
+        raise Flickwerk::Error, "No classes prepended in #{patch_path}" if matches.empty?
+
+        # For each unique match, make sure we load the decorator when the base class is loaded
+        matches.uniq.each do |decorated_class|
+          # Zeitwerk tells us which constant it expects a file to provide.
+          decorator_constant = autoloader.cpath_expected_at(patch_path)
+          Flickwerk.patch(decorated_class, with: decorator_constant)
+        end
+      end
+    end
+  end
+end

data/lib/flickwerk/patch_loader.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Flickwerk
+  class PatchLoader
+    def self.call(autoloader: Rails.autoloaders.main)
+      Flickwerk.patches.each do |class_name, decorators|
+        autoloader.on_load(class_name) do
+          decorators.each(&:constantize)
+        end
+      end
+    end
+  end
+end

data/lib/flickwerk/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "flickwerk/patch_finder"
+require "flickwerk/patch_loader"
+
+class Flickwerk::Railtie < Rails::Railtie
+  initializer "flickwerk.add_paths", before: :set_autoload_paths do |app|
+    Flickwerk.patch_paths.each do |path|
+      app.config.autoload_paths << path
+    end
+  end
+
+  initializer "flickwerk.add_patches", after: :setup_main_autoloader do
+    Flickwerk.patch_paths.each do |path|
+      Flickwerk::PatchFinder.new(path).call
+    end
+    Flickwerk::PatchLoader.call
+  end
+end

data/lib/flickwerk/version.rb

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

data/lib/flickwerk.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "flickwerk/version"
+require "active_support/core_ext/module/attribute_accessors"
+require "flickwerk/railtie" if defined?(Rails)
+
+module Flickwerk
+  class Error < StandardError; end
+
+  mattr_accessor :patch_paths, default: []
+  mattr_accessor :patches, default: Hash.new([])
+
+  def self.included(engine)
+    engine.root.glob("app/patches/*").each do |path|
+      engine.patch_paths << path
+    end
+  end
+
+  def self.patch(class_name, with:)
+    patches[class_name] += [with]
+  end
+end

data/sig/flickwerk.rbs

@@ -0,0 +1,4 @@
+module Flickwerk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: flickwerk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Meyerhoff
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Support for lazy loading patches in Rails engines
+email:
+- mamhoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/flickwerk.rb
+- lib/flickwerk/patch_finder.rb
+- lib/flickwerk/patch_loader.rb
+- lib/flickwerk/railtie.rb
+- lib/flickwerk/version.rb
+- sig/flickwerk.rbs
+homepage: https://github.com/friendlycart/flickwerk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/friendlycart/flickwerk
+  source_code_uri: https://github.com/friendlycart/flickwerk
+  changelog_uri: https://github.com/friendlycart/flickwerk/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Support for lazy loading patches in Rails engines
+test_files: []