rails-diff 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 282714f27151e8626a70a7a5d583dd16d5f623b5bd6dc5a18b0bd3799972c9b0
-  data.tar.gz: 97096cefae2cadbd8708d19cb1d6bfa448a3f324d85b1fa406196de6cc776494
+  metadata.gz: 3b0a335992f7491133b576710e538fd0adc5d3bde79919e2fa60d145ae3e6055
+  data.tar.gz: f429b3d0d895f23bbda625a29172e3528bc86db2cb1e74fc6803aa7d2105c65e
 SHA512:
-  metadata.gz: 3aac33eb6514f976ef2d69b98b9a9afcbaf488b4dd10966f7895296cbec5035800851c6ce274a1bbd4dfdd09bda75c95474bb4aa1c441611ff52513e4acc4ccd
-  data.tar.gz: 12c2327650881b2de7fcecd7b154106b1445794d8088b12f23f6c0fa2a528d9026c434a4ed6e3b056ccf1bc5d037a7e4c7a958ffa77f74b1ed039fd319e13e3e
+  metadata.gz: abe0d4f2ae2cf533aefa251726547b2eda321758edbf14882fc5948314d0e72eab78c054b238661f127df065fa6da0956b3469b07e2d219e35a199442443908e
+  data.tar.gz: 3bba7f7a5c9711601f7dcb11163947913103185f60a31dc3bd7f9e79c0b055fee8fad650a8abbb65c36b69deccec780f36b821c646216363f8a6286fcacb5318

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.7.0] - 2026-03-17
+
+- Replace `diffy` with `difftastic` for better diff output with syntax highlighting.
+- Add `--ref` option to compare against a specific tag, branch, or commit SHA (`--commit` is kept as an alias).
+- [BUGFIX] `--commit` (now `--ref`) failed with shallow clones when the ref wasn't locally available.
+
 ## [0.6.0] - 2025-07-25
 
 - Add `--only` option to only include specific files or directories in the diff.
@@ -70,6 +76,7 @@ M## [0.1.1] - 2025-02-21
 
 - Initial release
 
+[0.7.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.7.0
 [0.6.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.6.0
 [0.5.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.5.0
 [0.4.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.4.1

data/README.md

@@ -41,8 +41,8 @@ rails-diff file Dockerfile --clear-cache
 # Fail if there are differences (useful for CI)
 rails-diff file Dockerfile --fail-on-diff
 
-# Compare a specific commit
-rails-diff file Dockerfile --commit 7df1b8
+# Compare a specific ref (tag, branch, or commit SHA)
+rails-diff file Dockerfile --ref v8.0.0
 ```
 
 ### Compare generator files
@@ -63,8 +63,8 @@ rails-diff generated scaffold Post --skip app/views app/helpers
 # Fail if there are differences (useful for CI)
 rails-diff generated scaffold Post --fail-on-diff
 
-# Compare a specific commit
-rails-diff generated authentication --commit 7df1b8
+# Compare a specific ref (tag, branch, or commit SHA)
+rails-diff generated authentication --ref v8.0.0
 ```
 
 ### Compare dotfiles (configuration files)
@@ -74,16 +74,39 @@ rails-diff generated authentication --commit 7df1b8
 rails-diff dotfiles
 ```
 
+### Compare infrastructure files
+
+Compare all Rails-generated infrastructure files at once. This includes everything except `app/` and `lib/` (your application code): `bin/`, `config/`, `db/`, `public/`, `Dockerfile`, `Gemfile`, `Rakefile`, dotfiles, and more.
+
+```bash
+# Compare all infrastructure files
+rails-diff infra
+
+# Compare only specific directories
+rails-diff infra --only bin config
+
+# Skip additional directories
+rails-diff infra --skip db
+
+# Fail if there are differences (useful for CI)
+rails-diff infra --fail-on-diff
+```
+
 ### Global Options
 
+These options can be used with any of the commands above.
+
 #### --fail-on-diff
 
 If this option is specified, the command will exit with a non-zero status code if there are any differences between your files and the generated ones. This can be particularly useful when using the gem in Continuous Integration (CI) environments.
 
-#### --commit <commit_hash>
+#### --ref <ref>
+
+Specify a tag, branch, or commit SHA to compare against. If not provided, the
+latest commit on main will be used by default. `--commit` is kept as an alias.
 
-Specify the commit hash you want to compare against. If not provided, the latest
-commit on main will be used by default.
+> [!NOTE]
+> When using a commit SHA, the full 40-character SHA is required (short SHAs are not supported).
 
 #### --new-app-options <options>
 
@@ -148,7 +171,7 @@ The gem caches the generated Rails application to avoid regenerating it on every
 - 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 use `--ref` with a different ref
 
 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/cli.rb

@@ -5,7 +5,7 @@ module Rails
     class CLI < Thor
       class_option :no_cache, type: :boolean, desc: "Clear cache before running", aliases: ["--clear-cache"]
       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 :ref, type: :string, desc: "Compare against a specific ref (tag, branch, or commit SHA)", aliases: ["--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"]
 
@@ -19,7 +19,7 @@ module Rails
         diff = Rails::Diff.file(
           *files,
           no_cache: options[:no_cache],
-          commit: options[:commit],
+          ref: options[:ref],
           new_app_options: options[:new_app_options]
         )
         return if diff.empty?
@@ -45,7 +45,24 @@ module Rails
           no_cache: options[:no_cache],
           skip: options[:skip],
           only: options[:only],
-          commit: options[:commit],
+          ref: options[:ref],
+          new_app_options: options[:new_app_options]
+        )
+        return if diff.empty?
+
+        options[:fail_on_diff] ? abort(diff) : puts(diff)
+      end
+
+      desc "infra", "Compare non-application files in your repository (everything except app/ and lib/) with the ones generated by Rails"
+      option :skip, type: :array, desc: "Additional files or directories to skip", aliases: ["-s"], default: []
+      option :only, type: :array, desc: "Only include specific files or directories", aliases: ["-o"], default: []
+      def infra
+        ENV["DEBUG"] = "true" if options[:debug]
+        diff = Rails::Diff.infra(
+          no_cache: options[:no_cache],
+          skip: options[:skip],
+          only: options[:only],
+          ref: options[:ref],
           new_app_options: options[:new_app_options]
         )
         return if diff.empty?

data/lib/rails/diff/file_tracker.rb

@@ -2,29 +2,20 @@
 
 module Rails
   module Diff
-    class FileTracker
-      def initialize(base_dir, skip = [], only = [])
-        @base_dir = base_dir
-        @skip = skip
-        @only = only
-      end
+    module FileTracker
+      DEFAULT_EXCLUSIONS = %w[.git tmp log test].freeze
 
-      def new_files
-        files_before = list_files(@base_dir)
+      def self.new_files(base_dir, only:, skip: [])
+        files_before = list_files(base_dir)
         yield
-        files_after = list_files(@base_dir, @skip, @only)
+        files_after = list_files(base_dir, skip:, only:)
         files_after - files_before
       end
 
-      private
-
-      def list_files(dir, skip = [], only = [])
+      def self.list_files(dir, skip: [], only: [], exclusions: DEFAULT_EXCLUSIONS)
         files = Dir.glob("#{dir}/**/*", File::FNM_DOTMATCH).reject do |it|
           File.directory?(it) ||
-            it.start_with?("#{dir}/.git") ||
-            it.start_with?("#{dir}/tmp") ||
-            it.start_with?("#{dir}/log") ||
-            it.start_with?("#{dir}/test") ||
+            exclusions.any? { |e| it.start_with?("#{dir}/#{e}") } ||
             skip.any? { |s| it.start_with?("#{dir}/#{s}") }
         end
 

data/lib/rails/diff/rails_app_generator.rb

@@ -5,10 +5,10 @@ module Rails
     class RailsAppGenerator
       RAILSRC_PATH = "#{ENV["HOME"]}/.railsrc"
 
-      def initialize(commit: nil, new_app_options: nil, no_cache: false, logger: Logger, cache_dir: Rails::Diff::CACHE_DIR)
+      def initialize(ref: nil, new_app_options: nil, no_cache: false, logger: Logger, cache_dir: Rails::Diff::CACHE_DIR)
         @new_app_options = new_app_options.to_s.split
         @rails_repo = RailsRepo.new(logger:, cache_dir:)
-        @commit = commit
+        @ref = ref
         @logger = logger
         @cache_dir = cache_dir
         clear_cache if no_cache
@@ -44,8 +44,8 @@ module Rails
           Shell.run!("bin/rails", "destroy", generator_name, *args, logger:)
           logger.info "Running generator: rails generate #{generator_name} #{args.join(" ")}"
 
-          FileTracker.new(template_app_path, skip, only)
-            .new_files { Shell.run!("bin/rails", "generate", generator_name, *args, logger:) }
+          FileTracker
+            .new_files(template_app_path, skip:, only:) { Shell.run!("bin/rails", "generate", generator_name, *args, logger:) }
             .map { |it| it.delete_prefix("#{template_app_path}/") }
         end
       end
@@ -54,9 +54,9 @@ module Rails
 
       attr_reader :new_app_options, :rails_repo, :logger, :cache_dir
 
-      def commit = @commit ||= rails_repo.latest_commit
+      def ref = @ref ||= rails_repo.latest_commit
 
-      def rails_cache_dir_key = "rails-#{commit.first(10)}"
+      def rails_cache_dir_key = "rails-#{ref.first(10)}"
 
       def railsrc_options
         @railsrc_options ||= File.exist?(RAILSRC_PATH) ? File.readlines(RAILSRC_PATH) : []
@@ -69,7 +69,7 @@ module Rails
       end
 
       def create_new_rails_app
-        checkout_rails_commit
+        checkout_rails_ref
         generate_app
       end
 
@@ -81,7 +81,7 @@ module Rails
         rails_repo.new_app(template_app_path, rails_new_options)
       end
 
-      def checkout_rails_commit = rails_repo.checkout(commit)
+      def checkout_rails_ref = rails_repo.checkout(ref)
 
       def rails_new_options
         @rails_new_options ||= (new_app_options + railsrc_options).compact

data/lib/rails/diff/rails_repo.rb

@@ -9,10 +9,13 @@ module Rails
         @rails_repo = rails_repo
       end
 
-      def checkout(commit)
+      def checkout(ref)
         on_rails_dir do
-          logger.info "Checking out Rails (at commit #{commit[0..6]})"
-          Shell.run!("git", "checkout", commit, logger:)
+          logger.info "Checking out Rails (at #{ref})"
+          unless Shell.run!("git", "checkout", ref, abort: false, logger:)
+            Shell.run!("git", "fetch", "--depth", "1", "origin", ref, logger:)
+            Shell.run!("git", "checkout", "FETCH_HEAD", logger:)
+          end
         end
       end
 

data/lib/rails/diff/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Diff
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

data/lib/rails/diff.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "rails"
-require "diffy"
+require "difftastic"
 require "fileutils"
 require_relative "diff/cli"
 require_relative "diff/file_tracker"
@@ -16,8 +16,8 @@ module Rails
     CACHE_DIR = File.expand_path("#{ENV["HOME"]}/.rails-diff/cache")
 
     class << self
-      def file(*files, no_cache: false, commit: nil, new_app_options: nil)
-        app_generator = RailsAppGenerator.new(commit:, new_app_options:, no_cache:)
+      def file(*files, no_cache: false, ref: nil, new_app_options: nil)
+        app_generator = RailsAppGenerator.new(ref:, new_app_options:, no_cache:)
         app_generator.create_template_app
 
         files
@@ -25,13 +25,26 @@ module Rails
           .join("\n")
       end
 
-      def generated(generator_name, *args, no_cache: false, skip: [], only: [], commit: nil, new_app_options: nil)
-        app_generator = RailsAppGenerator.new(commit:, new_app_options:, no_cache:)
+      def generated(generator_name, *args, no_cache: false, skip: [], only: [], ref: nil, new_app_options: nil)
+        app_generator = RailsAppGenerator.new(ref:, new_app_options:, no_cache:)
         app_generator.create_template_app
         app_generator.install_app_dependencies
 
         app_generator.run_generator(generator_name, *args, skip, only)
-          .map { |it| diff_with_header(it, app_generator.template_app_path) }
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path) }
+          .join("\n\n")
+      end
+
+      def infra(no_cache: false, skip: [], only: [], ref: nil, new_app_options: nil)
+        app_generator = RailsAppGenerator.new(ref:, new_app_options:, no_cache:)
+        app_generator.create_template_app
+
+        default_skip = %w[app lib]
+        effective_skip = (default_skip + skip).uniq
+
+        FileTracker.list_files(app_generator.template_app_path, skip: effective_skip, only:)
+          .map { |f| f.delete_prefix("#{app_generator.template_app_path}/") }
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path) }
           .join("\n\n")
       end
 
@@ -52,12 +65,13 @@ module Rails
         return "File not found in the Rails template" unless File.exist?(rails_file)
         return "File not found in your repository" unless File.exist?(repo_file)
 
-        Diffy::Diff.new(
-          rails_file,
-          repo_file,
-          context: 2,
-          source: "files"
-        ).to_s(:color).chomp
+        differ = Difftastic::Differ.new(
+          color: :always,
+          left_label: "Rails File (#{file})",
+          right_label: "Repo File (#{file})"
+        )
+
+        differ.diff_files(rails_file, repo_file).chomp
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Matheus Richard
@@ -24,19 +24,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: diffy
+  name: difftastic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement