rails-diff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5049aad3c07aafb46e197ad4a1e57655615d1c0b577ab07939a13cb0a28cce9
-  data.tar.gz: 589d63e3f324dc0a86b9816586d88517146f9e2dc84f71c4b10c7b414e4de054
+  metadata.gz: 1597a0a52bb69e722c40bdd8714a79d6ab42fcef23a844484c91ca70496d7e4b
+  data.tar.gz: 92e9120a9d970073725b002ea0ae8a2144bfdc075b30ba02e637ce86fdcebee8
 SHA512:
-  metadata.gz: cf848b14e60228991ee6f6091f17a49ad30e69fe3efd1fdbddf9a069826a6ba4af0460ec4e6e9891bd1dfcd5762a6b457e7c68c115972229ca18a64f375ef5ae
-  data.tar.gz: f72083a3b5329062e0939ad04c7dc3745262d755550197a4e8e5e814a9561705e9c9cee45a9e010a5d323698fe8987240e33a8d1cb7dd8555431ca1fa7d98a44
+  metadata.gz: 55149e9e567a6a63d6f0b6af85351d29a26af4c48ca16a8053cf46768cb883bfc16c8a908ab89e8047897194802ded032145b58d185f62772d5e81ca308d5120
+  data.tar.gz: 716c754d1e4ff11ba617007aceb4de23fdea5cae49daaeedf794f3c497ad307e02d1827c48944d3fc4621b74427e6dba76c48089d878f36141f17e15f1c7a87b

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-02-21
+
+- Allow comparing a specific commit
+```sh
+rails-diff file Dockerfile --commit 3e7640
+```
+
+- Allow failing the command when there are diffs
+
+```sh
+rails-diff file Dockerfile --fail-on-diff
+```
+
+- Return no output when there's no diff
+
+M## [0.1.1] - 2025-02-21
+
+- Fix generator differ
+
 ## [0.1.0] - 2025-02-21
 
 - Initial release
+
+[0.2.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.2.0
+[0.1.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.1.1
+[0.1.0]: https://github.com/matheusrich/rails-diff/releases/tag/v0.1.0

data/README.md

@@ -30,13 +30,19 @@ $ gem install rails-diff
 
 ```bash
 # Compare a single file
-rails-diff file config/routes.rb
+rails-diff file Dockerfile
 
 # Compare multiple files
-rails-diff file config/routes.rb config/application.rb
+rails-diff file Dockerfile Gemfile
 
 # Force regenerate Rails app by clearing cache
-rails-diff file config/routes.rb --clear-cache
+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 generator files
@@ -53,8 +59,25 @@ rails-diff generated scaffold Post --clear-cache
 
 # Skip specific files or directories during the diff
 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
 ```
 
+### Options
+
+#### --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>
+
+Specify the commit hash you want to compare against. If not provided, the latest
+commit on main will be used by default.
+
 ## How it works
 
 When you run the diff, it will:

data/Rakefile

@@ -6,3 +6,4 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+task release: :spec

data/lib/rails/diff/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Diff
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rails/diff.rb

@@ -14,37 +14,35 @@ module Rails
     CACHE_DIR = File.expand_path("~/.rails-diff/cache")
 
     class << self
-      def file(*files, no_cache: false)
+      def file(*files, no_cache: false, commit: nil)
         clear_cache if no_cache
-        ensure_template_app_exists
+        ensure_template_app_exists(commit)
 
-        files.map { |file| diff_with_header(file) }.join("\n")
+        files.filter_map { |it| diff_with_header(it) }.join("\n")
       end
 
-      def generated(generator_name, *args, no_cache: false, skip: [])
+      def generated(generator_name, *args, no_cache: false, skip: [], commit: nil)
         clear_cache if no_cache
-        ensure_template_app_exists
+        ensure_template_app_exists(commit)
         install_app_dependencies
 
-        generated_files(skip)
-          .map { |it| diff_generated_file(it) }
+        generated_files(generator_name, *args, skip)
+          .map { |it| diff_with_header(it) }
           .join("\n\n")
       end
 
       private
 
-      def app_name
-        @app_name ||= File.basename(Dir.pwd)
-      end
-
       def template_app_path
-        @template_app_path ||= File.join(CACHE_DIR, app_name)
+        @template_app_path ||= File.join(CACHE_DIR, commit, app_name)
       end
 
       def rails_path
         @rails_path ||= File.join(CACHE_DIR, "rails")
       end
 
+      def app_name = @app_name ||= File.basename(Dir.pwd)
+
       def clear_cache
         puts "Clearing cache..."
         FileUtils.rm_rf(CACHE_DIR)
@@ -68,31 +66,22 @@ module Rails
         files_after - files_before
       end
 
-      def generated_files(skip)
+      def generated_files(generator_name, *args, skip)
         command = "#{generator_name} #{args.join(' ')}"
         Dir.chdir(template_app_path) do
           system("bin/rails destroy #{command} >/dev/null 2>&1")
           puts "Running generator: rails generate #{command}"
           track_new_files(skip) { system("bin/rails generate #{command} > /dev/null 2>&1") }
+            .map { |it| it.delete_prefix("#{template_app_path}/") }
         end
       end
 
       def diff_with_header(file)
-        header = "#{file} diff:"
-        [
-          header,
-          "=" * header.size,
-          diff_file(file)
-        ].join("\n")
-      end
+        diff = diff_file(file)
+        return if diff.empty?
 
-      def diff_generated_file(file)
-        relative_path = file.delete_prefix("#{template_app_path}/")
-        [
-          "#{relative_path} diff:",
-          "=" * (10 + relative_path.length),
-          diff_file(relative_path)
-        ].join("\n")
+        header = "#{file} diff:"
+        [header, "=" * header.size, diff].join("\n")
       end
 
       def install_app_dependencies
@@ -112,15 +101,16 @@ module Rails
         return "#{file} not found in your repository" unless File.exist?(repo_file)
 
         Diffy::Diff.new(
-          File.read(rails_file),
-          File.read(repo_file),
-          context: 2
-        ).to_s(:color)
+          rails_file,
+          repo_file,
+          context: 2,
+          source: 'files'
+        ).to_s(:color).chomp
       end
 
-      def ensure_template_app_exists
+      def ensure_template_app_exists(commit)
         FileUtils.mkdir_p(CACHE_DIR)
-
+        @commit = commit || latest_commit
         return if cached_app?
 
         FileUtils.rm_rf(template_app_path)
@@ -154,37 +144,56 @@ module Rails
         end
 
         Dir.chdir(rails_path) do
-          commit = `git rev-parse HEAD`.strip
-          puts "Using Rails edge (commit #{commit[0..6]})"
+          checkout_rails
+          generate_app
+        end
+      end
 
-          unless system("bundle check >/dev/null 2>&1")
-            puts "Installing Rails dependencies..."
-            system("bundle install >/dev/null 2>&1")
-          end
+      def generate_app
+        Dir.chdir("railties") do
+          puts "Generating new Rails application..."
+          system("bundle exec rails new #{template_app_path} --main --skip-bundle --force --skip-test --skip-system-test --quiet")
+        end
+      end
 
-          Dir.chdir("railties") do
-            puts "Generating new Rails application..."
-            system("bundle exec rails new #{template_app_path} --main --skip-bundle --force --skip-test --skip-system-test --quiet")
-          end
+      def checkout_rails
+        puts "Checking out Rails (at commit #{commit[0..6]})"
+        system("git checkout #{commit} >/dev/null 2>&1")
+      end
+
+      def commit = @commit
+
+      def latest_commit
+        Dir.chdir(rails_path) do
+          `git rev-parse origin/main`.strip
         end
       end
     end
 
     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"
+
       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?
 
-        puts Rails::Diff.file(*files, no_cache: options[:no_cache])
+        diff = Rails::Diff.file(*files, no_cache: options[:no_cache], commit: options[:commit])
+        return if diff.empty?
+
+        options[:fail] ? abort(diff) : puts(diff)
       end
 
       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)
-        puts Rails::Diff.generated(generator_name, *args, no_cache: options[:no_cache], skip: options[:skip])
+        diff = Rails::Diff.generated(generator_name, *args, no_cache: options[:no_cache], skip: options[:skip], commit: options[:commit])
+        return if diff.empty?
+
+        options[:fail] ? abort(diff) : puts(diff)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matheus Richard
 bindir: exe
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Compare Rails-generated files with the ones in your repository
 test_files: []