rails-diff 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 453cfc382c12f3289040c2a737433d727ca411912da3302f772f55bf0b18ce11
-  data.tar.gz: b93d35f857877e7b4d15cdb2f4387ec8d527708db106b0a9dbb9a370fb2ede73
+  metadata.gz: 38eec723e013294fcf65e9e7ca0d87bbb5a47247d1ac981e5636919c8ec23ab3
+  data.tar.gz: a94ae7dfea382c293363a14bea0e26170527d8c09aa6d152fd14c3fb207a267d
 SHA512:
-  metadata.gz: 0bc0bd3b39bb5b82b770f5b599d93a6c3cd7566561d587e69974b3fcfbf5ae53736ce49f49a79edf3c7db2fa5352f4586a94ad13e18300950414bbd9fa27ac57
-  data.tar.gz: 7aac8160f88f3842a2d1074bcc0e98b88bfaa1cfdb87ead3b4f45d6e78a854cc27914a41b9b1057e8ffcb18ee2ae4012342020aaeffc3ed03816e7ffabe8559f
+  metadata.gz: ff731b2ca714546421d437c6b9c2dd43560e3db9f3ca4eeaba846547e2f50763786d0e466cb0a44dec9fd40f7631c888117b3c8f6f5ae0500b08243231164a40
+  data.tar.gz: 1459938e4540dcbbce30cfa9214386d092c1081425419c9224f14e9a426556df62c0d09a46a206ab6f3c6c2900a2f0a8309ec6b8c07faee5694c496b95ecc26f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.4.2] - 2025-03-10
+
+- Don't abort process on bundle check failure.
+- Add optional debug logs.
+
+```sh
+rails-diff file Gemfile --debug
+```
+
+or
+
+```sh
+DEBUG=1 rails-diff file Gemfile
+```
+
 ## [0.4.1] - 2025-03-05
 
 - Bump `rack` and `uri` minor versions.
@@ -49,6 +64,7 @@ M## [0.1.1] - 2025-02-21
 
 - Initial release
 
+[0.4.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.4.1
 [0.4.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.4.0
 [0.3.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.3.0
 [0.2.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.2.1

data/README.md

@@ -88,6 +88,36 @@ Example:
 rails-diff file Dockerfile --new-app-options="--database=postgresql"
 ```
 
+#### --skip <files/directories>
+
+Skip specific files or directories during the diff.
+
+```bash
+rails-diff generated scaffold Post --skip app/views app/helpers
+```
+
+#### --clear-cache/--no-cache
+
+Clear the cache directory to force cloning Rails and regenerating the Rails template app.
+
+```bash
+rails-diff file Dockerfile --clear-cache
+```
+
+#### --debug
+
+Print debug information.
+
+```sh
+rails-diff file Gemfile --debug
+```
+
+or with an environment variable:
+
+```sh
+DEBUG=1 rails-diff file Gemfile
+```
+
 ## How it works
 
 When you run the diff, it will:
@@ -100,7 +130,10 @@ When you run the diff, it will:
 
 The gem caches the generated Rails application to avoid regenerating it on every run. The cache is automatically invalidated when:
 - Rails has new commits on main
-- The cache directory doesn't exist
+- The cache directory doesn't exist (or is cleared with the `--clear-cache` option)
+- You use `--new-app-options` with different options
+- You change your `~/.railsrc` file
+- You use `--commit` with a different commit
 
 You can also force clear the cache by using the `--no-cache` option (or its alias `--clear-cache`) with any command.
 

data/lib/rails/diff/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Diff
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/rails/diff.rb

@@ -35,19 +35,29 @@ module Rails
 
       private
 
-      def system!(*cmd)
+      def system!(*cmd, abort: true)
         _, stderr, status = Open3.capture3(*cmd)
 
-        unless status.success?
-          puts "\e[1;31mCommand failed:\e[0m #{cmd.join(' ')}"
+        debug cmd.join(" ")
+
+        if status.success?
+          true
+        elsif abort
+          $stderr.puts "\e[1;31mCommand failed:\e[0m #{cmd.join(' ')}"
           abort stderr
+        else
+          false
         end
-
-        true
       end
 
       def info(message)
-        puts "\e[1;34minfo:\e[0m #{message}"
+        puts "\e[1;34minfo:\e[0m\t#{message}"
+      end
+
+      def debug(message)
+        return unless ENV["DEBUG"]
+
+        puts "\e[1;33mdebug:\e[0m\t#{message}"
       end
 
       def clear_cache
@@ -124,7 +134,7 @@ module Rails
 
       def install_app_dependencies
         Dir.chdir(template_app_path) do
-          unless system!("bundle check")
+          unless system!("bundle check", abort: false)
             info "Installing application dependencies"
             system!("bundle install")
           end
@@ -176,16 +186,16 @@ module Rails
 
       def generate_app
         Dir.chdir("railties") do
-          unless system!("bundle check")
+          unless system!("bundle check", abort: false)
             info "Installing Rails dependencies"
             system!("bundle install")
           end
 
           if railsrc_options
-            info "Using default options from #{RAILSRC_PATH}:\n  > #{railsrc_options.join(' ')}"
+            info "Using default options from #{RAILSRC_PATH}:\n\t  > #{railsrc_options.join(' ')}"
           end
 
-          info "Generating new Rails application\n  > #{rails_new_command.join(' ')}"
+          info "Generating new Rails application\n\t  > #{rails_new_command.join(' ')}"
           system!(*rails_new_command)
         end
       end
@@ -228,12 +238,14 @@ module Rails
       class_option :fail_on_diff, type: :boolean, desc: "Fail if there are differences"
       class_option :commit, type: :string, desc: "Compare against a specific commit"
       class_option :new_app_options, type: :string, desc: "Options to pass to the rails new command"
+      class_option :debug, type: :boolean, desc: "Print debug information", aliases: ["-d"]
 
       def self.exit_on_failure? = true
 
       desc "file FILE [FILE ...]", "Compare one or more files from your repository with Rails' generated version"
       def file(*files)
         abort "Please provide at least one file to compare" if files.empty?
+        ENV["DEBUG"] = "true" if options[:debug]
 
         diff = Rails::Diff.file(*files, no_cache: options[:no_cache], commit: options[:commit], new_app_options: options[:new_app_options])
         return if diff.empty?
@@ -244,6 +256,7 @@ module Rails
       desc "generated GENERATOR [args]", "Compare files that would be created by a Rails generator"
       option :skip, type: :array, desc: "Skip specific files or directories", aliases: ["-s"], default: []
       def generated(generator_name, *args)
+        ENV["DEBUG"] = "true" if options[:debug]
         diff = Rails::Diff.generated(generator_name, *args, no_cache: options[:no_cache], skip: options[:skip], commit: options[:commit], new_app_options: options[:new_app_options])
         return if diff.empty?
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Matheus Richard
 bindir: exe
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails