rails-diff 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0a335992f7491133b576710e538fd0adc5d3bde79919e2fa60d145ae3e6055
-  data.tar.gz: f429b3d0d895f23bbda625a29172e3528bc86db2cb1e74fc6803aa7d2105c65e
+  metadata.gz: ff8a56490563255cb68662a1f669ddaa9a0d07071c0216d24e650705f8a76f81
+  data.tar.gz: 8e5a5d304686fd37bdd09fb55906a407642279648ec9c7f582623bcfa6691314
 SHA512:
-  metadata.gz: abe0d4f2ae2cf533aefa251726547b2eda321758edbf14882fc5948314d0e72eab78c054b238661f127df065fa6da0956b3469b07e2d219e35a199442443908e
-  data.tar.gz: 3bba7f7a5c9711601f7dcb11163947913103185f60a31dc3bd7f9e79c0b055fee8fad650a8abbb65c36b69deccec780f36b821c646216363f8a6286fcacb5318
+  metadata.gz: 3bf5a8ac6e8e6c44141f0e7fdd510e8a5d2a34f4325731341b2311a5f01ffe37ae3983f88b5542bc5638396036bb3046269c4e8da60997e76480b0ca1aca7bc9
+  data.tar.gz: 46584a9a3a70f9bbbdbfc1e19727fbc5b56c7de39644d2585efe08edb420e4de89c6b75b1c2092af9af93da4be9b64916446049acb08e9515a28cdecac4514b4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.8.1] - 2026-06-16
+
+- Respect the XDG Base Directory spec for the cache location. Cache now lives at `$XDG_CACHE_HOME/rails-diff` (defaulting to `~/.cache/rails-diff`) instead of `~/.rails-diff/cache`. The old cache directory is no longer used and can be removed (PR #37).
+
+## [0.8.0] - 2026-03-26
+
+- `--ref` now accepts `rails --version` output (e.g., `--ref "Rails 7.2.3"` is converted to `v7.2.3`).
+
 ## [0.7.0] - 2026-03-17
 
 - Replace `diffy` with `difftastic` for better diff output with syntax highlighting.
@@ -76,6 +84,8 @@ M## [0.1.1] - 2025-02-21
 
 - Initial release
 
+[0.8.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.8.1
+[0.8.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.8.0
 [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

data/README.md

@@ -105,6 +105,12 @@ If this option is specified, the command will exit with a non-zero status code i
 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.
 
+You can also pass `rails --version` output directly:
+
+```bash
+rails-diff file Dockerfile --ref "$(rails --version)"
+```
+
 > [!NOTE]
 > When using a commit SHA, the full 40-character SHA is required (short SHAs are not supported).
 

data/lib/rails/diff/rails_app_generator.rb

@@ -3,12 +3,10 @@ require "digest"
 module Rails
   module Diff
     class RailsAppGenerator
-      RAILSRC_PATH = "#{ENV["HOME"]}/.railsrc"
-
-      def initialize(ref: 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, rails_repo: RailsRepo.new(logger:, cache_dir:))
         @new_app_options = new_app_options.to_s.split
-        @rails_repo = RailsRepo.new(logger:, cache_dir:)
-        @ref = ref
+        @rails_repo = rails_repo
+        @ref = normalize_ref(ref)
         @logger = logger
         @cache_dir = cache_dir
         clear_cache if no_cache
@@ -54,12 +52,22 @@ module Rails
 
       attr_reader :new_app_options, :rails_repo, :logger, :cache_dir
 
+      def normalize_ref(ref)
+        if ref&.start_with?("Rails ")
+          "v#{ref.delete_prefix("Rails ")}"
+        else
+          ref
+        end
+      end
+
       def ref = @ref ||= rails_repo.latest_commit
 
       def rails_cache_dir_key = "rails-#{ref.first(10)}"
 
+      def railsrc_path = "#{ENV["HOME"]}/.railsrc"
+
       def railsrc_options
-        @railsrc_options ||= File.exist?(RAILSRC_PATH) ? File.readlines(RAILSRC_PATH) : []
+        @railsrc_options ||= File.exist?(railsrc_path) ? File.readlines(railsrc_path) : []
       end
 
       def app_name = @app_name ||= File.basename(Dir.pwd)
@@ -76,7 +84,7 @@ module Rails
       def generate_app
         rails_repo.install_dependencies
         if railsrc_options.any?
-          logger.info "Using default options from #{RAILSRC_PATH}:\n\t  > #{railsrc_options.join(" ")}"
+          logger.info "Using default options from #{railsrc_path}:\n\t  > #{railsrc_options.join(" ")}"
         end
         rails_repo.new_app(template_app_path, rails_new_options)
       end

data/lib/rails/diff/version.rb

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

data/lib/rails/diff.rb

@@ -13,30 +13,32 @@ require_relative "diff/version"
 
 module Rails
   module Diff
-    CACHE_DIR = File.expand_path("#{ENV["HOME"]}/.rails-diff/cache")
-
     class << self
-      def file(*files, no_cache: false, ref: nil, new_app_options: nil)
-        app_generator = RailsAppGenerator.new(ref:, new_app_options:, no_cache:)
+      def cache_dir
+        xdg = ENV["XDG_CACHE_HOME"]
+        base = (xdg && File.absolute_path?(xdg)) ? xdg : File.join(Dir.home, ".cache")
+
+        File.join(base, "rails-diff")
+      end
+
+      def file(*files, no_cache: false, ref: nil, new_app_options: nil, app_generator: RailsAppGenerator.new(ref:, new_app_options:, no_cache:), differ_class: Difftastic::Differ)
         app_generator.create_template_app
 
         files
-          .filter_map { |it| diff_with_header(it, app_generator.template_app_path) }
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path, differ_class:) }
           .join("\n")
       end
 
-      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:)
+      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:), differ_class: Difftastic::Differ)
         app_generator.create_template_app
         app_generator.install_app_dependencies
 
         app_generator.run_generator(generator_name, *args, skip, only)
-          .filter_map { |it| diff_with_header(it, app_generator.template_app_path) }
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path, differ_class:) }
           .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:)
+      def infra(no_cache: false, skip: [], only: [], ref: nil, new_app_options: nil, app_generator: RailsAppGenerator.new(ref:, new_app_options:, no_cache:), differ_class: Difftastic::Differ)
         app_generator.create_template_app
 
         default_skip = %w[app lib]
@@ -44,28 +46,28 @@ module Rails
 
         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) }
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path, differ_class:) }
           .join("\n\n")
       end
 
       private
 
-      def diff_with_header(file, template_app_path)
-        diff = diff_file(file, template_app_path)
+      def diff_with_header(file, template_app_path, differ_class:)
+        diff = diff_file(file, template_app_path, differ_class:)
         return if diff.empty?
 
         header = "#{file} diff:"
         [header, "=" * header.size, diff].join("\n")
       end
 
-      def diff_file(file, template_app_path)
+      def diff_file(file, template_app_path, differ_class:)
         rails_file = File.join(template_app_path, file)
         repo_file = File.join(Dir.pwd, file)
 
         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)
 
-        differ = Difftastic::Differ.new(
+        differ = differ_class.new(
           color: :always,
           left_label: "Rails File (#{file})",
           right_label: "Repo File (#{file})"
@@ -74,5 +76,7 @@ module Rails
         differ.diff_files(rails_file, repo_file).chomp
       end
     end
+
+    CACHE_DIR = cache_dir
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Matheus Richard