flickwerk 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e651efd8959c74f5444b298eee3a2cd6025be555990fab13877af551bfb23c3
-  data.tar.gz: a204baaa6ca697496c95cb17afa877c1be9c68f2e7bd8160ee68c94ddd41bfb3
+  metadata.gz: f5e0ab83481440a9b1050a5de6178a3b70d6f82745e0615f41cd467c3dea954c
+  data.tar.gz: 654d07fc6f2765164142c002dacfbebb73517f8a90c3ff5a42b57ed036f30c32
 SHA512:
-  metadata.gz: e05aeceb1d30f4763a4f0fe31d064c3eed9251a51da3a8498ec2cdb92d1ebd658017ea39204b7553c2734d8f254b9a9fed19703e9c309b508e2bfc930789e0ba
-  data.tar.gz: c960be6af80cf1d42b710c20c3815284197b93fad2ec1a688730dd2f058f5386c6d2416f4ba5a4ec45e6203538be2cfbcb8eb2d7defede7ea4c290ec163be5e9
+  metadata.gz: 3902ae52304b8d83e36ef895955d6425dd14594d8e871baa7497ceef02f7b8287aa0c5283823773c937bfb783dbf0b68390f971936750b59fdfec4fafdc0c470
+  data.tar.gz: 821e7be27c93ba058af9c262cb131bba535ad1c4d6041dae60e13f063853ffcb881d313260d7d8ea083810b21b4405f149852921b37e4779eb4f8960e4c5c35d

data/README.md

@@ -129,7 +129,7 @@ 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"
+    Flickwerk.patch(Spree.class_variable_get(:@@user_class), "MyGem::UserClassPatch")
   end
 end
 ```
@@ -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,10 +10,13 @@ class Flickwerk::Railtie < Rails::Railtie
     end
   end
 
-  initializer "flickwerk.add_patches", after: :setup_main_autoloader do
+  initializer "flickwerk.find_patches", after: :setup_main_autoloader do
     Flickwerk.patch_paths.each do |path|
       Flickwerk::PatchFinder.new(path).call
     end
+  end
+
+  initializer "flickwerk.add_patches", after: "flickwerk.find_patches" do
     Flickwerk::PatchLoader.call
   end
 end

data/lib/flickwerk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flickwerk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-16 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