rails-diff 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4068f995c11a16cd755643fa61b93a8ffa219d8c806dc78b9dbe5a1978d9e41c
-  data.tar.gz: 5a46ee3bbfd5182daccd70a46daf471401b48daa0ea3da20cca03ef0d49becba
+  metadata.gz: 567e5e325109a4ed6c9daee6dd2c18a8c5bf20de492be9c4399c54347a2091fa
+  data.tar.gz: 6ef46901ce7d1445e0c8651323fdad776e9225223c4f2e4c1d6e506c31d70130
 SHA512:
-  metadata.gz: eabc76fab91cde4c1f5be6e8ebcfdf5ed6649607532eb67ab0867e4817078cc4eeca6cb270dbd1f89fc26f335fda9a82f0ac826fbe5820af7701be05cb8c48bf
-  data.tar.gz: 1b8fa68bb499cf107179b38168053c63906daf4af363e29bf664f4ecee4b7552caf36156a9e244e962e5c63bedac8116ef4a8cd6df1f59915730029ddb36423a
+  metadata.gz: 1b5259244a5b576f651c75981c807854bb82d71cf3b7af72074a9ec05dacb30db477af39dc2a2ab1a11a2d328da23cbeb1b9deec62a0c190355785299f1622d5
+  data.tar.gz: 6b037fd06f237a6a48d2b98e4dcd36609b8a2b3ece0a7bada82b38249b63ca20fdcbdb8ee707ecafefa0de40fd5db8d6c18a97be033f2771a620cfb1750d9c42

data/CHANGELOG.md

@@ -1,9 +1,36 @@
 ## [Unreleased]
 
-## [0.1.1] - 2025-02-21
+## [0.2.1] - 2025-02-22
+
+- Add missing version command
+- Consistent error messages
+- Ensure rails path exists and dependencies are installed
+
+## [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.1]: https://github.com/matheusrich/rails-diff/releases/tag/v0.2.1
+[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

@@ -37,6 +37,12 @@ rails-diff file Dockerfile Gemfile
 
 # Force regenerate Rails app by clearing 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 build: :spec

data/lib/rails/diff/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module Diff
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

data/lib/rails/diff.rb

@@ -14,41 +14,54 @@ 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(generator_name, *args, skip)
-          .map { |it| diff_generated_file(it) }
+          .map { |it| diff_with_header(it) }
           .join("\n\n")
       end
 
       private
 
-      def app_name
-        @app_name ||= File.basename(Dir.pwd)
+      def clear_cache
+        puts "Clearing cache"
+        FileUtils.rm_rf(CACHE_DIR)
+      end
+
+      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)
+        create_new_rails_app
       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")
+        @rails_path ||= begin
+          File.join(CACHE_DIR, "rails").tap do |path|
+            unless File.exist?(path)
+              system("git clone --depth 1 #{RAILS_REPO} #{path} >/dev/null 2>&1")
+            end
+          end
+        end
       end
 
-      def clear_cache
-        puts "Clearing cache..."
-        FileUtils.rm_rf(CACHE_DIR)
-      end
+      def app_name = @app_name ||= File.basename(Dir.pwd)
 
       def list_files(dir, skip = [])
         Dir.glob("#{dir}/**/*", File::FNM_DOTMATCH).reject do |it|
@@ -74,31 +87,22 @@ module Rails
           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
         Dir.chdir(template_app_path) do
           unless system("bundle check >/dev/null 2>&1")
-            puts "Installing application dependencies..."
+            puts "Installing application dependencies"
             system("bundle install >/dev/null 2>&1")
           end
         end
@@ -112,19 +116,11 @@ 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)
-      end
-
-      def ensure_template_app_exists
-        FileUtils.mkdir_p(CACHE_DIR)
-
-        return if cached_app?
-
-        FileUtils.rm_rf(template_app_path)
-        create_new_rails_app
+          rails_file,
+          repo_file,
+          context: 2,
+          source: 'files'
+        ).to_s(:color).chomp
       end
 
       def cached_app?
@@ -149,42 +145,68 @@ module Rails
       end
 
       def create_new_rails_app
-        unless File.exist?(rails_path)
-          system("git clone --depth 1 #{RAILS_REPO} #{rails_path} >/dev/null 2>&1")
-        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
 
+      def generate_app
+        Dir.chdir("railties") do
           unless system("bundle check >/dev/null 2>&1")
-            puts "Installing Rails dependencies..."
+            puts "Installing Rails dependencies"
             system("bundle install >/dev/null 2>&1")
           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
+          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
+
+      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
+
+      map %w[--version -v] => :__version
+      desc "--version, -v", "print the version"
+      def __version
+        puts VERSION
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 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