flickwerk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d2a4d44e16f6ffde47572e6eb07314095fb3699141f86042e612a9c6d096203
-  data.tar.gz: eb5f26ce60eaf28bef486e7985cfcda0d5f818832a6f74c9a62df288984b4eec
+  metadata.gz: a2282cc97b8ee8bb05493ba03cf1ed27690fdffacf62bb8ff203b6db3bf6c36c
+  data.tar.gz: 943a5ae6ec43be5b7139ba5b578335339564cb0ab832a0038250a58e005e46cc
 SHA512:
-  metadata.gz: 073d1b4b045bd85a5916377d562bcc8399e858dbd8a0961cc31a043a48e9a00f73784c1c733369c970d26cae265bbad94b2d92f165e98426a7a93b9f40522298
-  data.tar.gz: 606f5c40e0d1270d2dd3861d2ce3b35918e41973e358c026fc146e10ff5c83b596d8dbaf3d5707af34133491cfc61811a81a89fb9f0276eeb2f30429c41ede24
+  metadata.gz: 7a93c5ffc75887ee60dde2635995ac097b70fe6b068106be82a173106eeb9c8d122e38053f9e42880940434fde943adf6b2bc02fab3965da252819c1880f2a89
+  data.tar.gz: 28891d06643e9cc430a5b793704abe65baa14825af3bf49a52bcc07fa9e4c32bcdce56a97e0b8f16f70ce3b125c9dcf3efaf64d09b8e0cf21e44b18191b3cc5b

data/README.md

@@ -175,6 +175,26 @@ class MyGem::Engine
 end
 ```
 
+## Transitioning from app/decorators to app/patches
+
+Due to the Rails Engine documentation telling people to put their patches in either `app/decorators` or `app/overrides`, that's where a lot of patches currently live. Flickwerk provides a script to help you move your "decorators" or "overrides" to `app/patches` and do the necessary changes in terms of file and constant names.
+
+If your patches currently live in `app/decorators`, run
+
+```sh
+bundle exec flickwerk patchify
+```
+
+Flickwerk will now move your decorators and rename them.
+
+If your patches currently live in `app/overrides`, use an argument:
+
+```sh
+bundle exec flickwerk patchify overrides
+```
+
+Now, run your tests and make sure your patches comply with Flickwerk's requirements.
+
 ## Considerations
 
 ### Aren't patches bad?
@@ -195,7 +215,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/friendlycart/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
 

data/exe/flickwerk

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "flickwerk"
+require "flickwerk/patchify"
+
+case ARGV[0]
+when "patchify"
+  Flickwerk::Patchify.call(ARGV[1])
+else
+  raise ArgumentError, "Unknown command #{ARGV[0]}. Please use `patchify`."
+end

data/lib/flickwerk/patchify.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+
+module Flickwerk
+  class Patchify
+    PATCHES_DIR = "app/patches"
+    def self.call(directory_name)
+      directory_name ||= "decorators"
+      source_dir = "app/#{directory_name}"
+      suffix = directory_name.singularize
+      constant = suffix.camelize
+
+      Dir.glob("#{source_dir}/**/*_#{suffix}.rb").each do |file|
+        relative_path = file.sub(/^#{source_dir}\//, "")
+        target_file = relative_path.sub("_#{suffix}.rb", "_patch.rb")
+        target_path = File.join(PATCHES_DIR, File.dirname(relative_path))
+
+        # Create target directory if it doesn't exist
+        FileUtils.mkdir_p(target_path)
+
+        # Read and modify file content
+        content = File.read(file)
+        modified_content = content.gsub(/(\w+::)*\w+#{constant}\b/) do |match|
+          match.sub(constant, "Patch")
+        end
+
+        # Write to the new file
+        File.write(File.join(target_path, File.basename(target_file)), modified_content)
+
+        # Delete the original file
+        File.delete(file)
+
+        puts "Moved and updated: #{file} -> #{File.join(target_path, File.basename(target_file))}"
+      end
+    end
+  end
+end

data/lib/flickwerk/railtie.rb

@@ -10,13 +10,17 @@ class Flickwerk::Railtie < Rails::Railtie
     end
   end
 
-  initializer "flickwerk.find_patches", after: :setup_main_autoloader do
-    Flickwerk.patch_paths.each do |path|
-      Flickwerk::PatchFinder.new(path).call
+  initializer "flickwerk.find_patches" do |app|
+    app.config.to_prepare do
+      Flickwerk.patch_paths.each do |path|
+        Flickwerk::PatchFinder.new(path).call
+      end
     end
   end
 
-  initializer "flickwerk.add_patches", after: "flickwerk.find_patches" do
-    Flickwerk::PatchLoader.call
+  initializer "flickwerk.add_patches", after: "flickwerk.find_patches" do |app|
+    app.config.to_prepare do
+      Flickwerk::PatchLoader.call
+    end
   end
 end

data/lib/flickwerk/version.rb

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

data/lib/flickwerk.rb

@@ -9,6 +9,7 @@ module Flickwerk
 
   mattr_accessor :patch_paths, default: []
   mattr_accessor :patches, default: Hash.new([])
+  mattr_accessor :aliases, default: {}
 
   def self.included(engine)
     engine.root.glob("app/patches/*").each do |path|
@@ -17,6 +18,7 @@ module Flickwerk
   end
 
   def self.patch(class_name, with:)
-    patches[class_name] += [with]
+    klass_name = aliases[class_name] || class_name
+    patches[klass_name] += [with]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flickwerk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -27,7 +27,8 @@ dependencies:
 description: Support for lazy loading patches in Rails engines
 email:
 - mamhoff@gmail.com
-executables: []
+executables:
+- flickwerk
 extensions: []
 extra_rdoc_files: []
 files:
@@ -37,9 +38,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/flickwerk
 - lib/flickwerk.rb
 - lib/flickwerk/patch_finder.rb
 - lib/flickwerk/patch_loader.rb
+- lib/flickwerk/patchify.rb
 - lib/flickwerk/railtie.rb
 - lib/flickwerk/version.rb
 - sig/flickwerk.rbs