rails-diff 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38eec723e013294fcf65e9e7ca0d87bbb5a47247d1ac981e5636919c8ec23ab3
-  data.tar.gz: a94ae7dfea382c293363a14bea0e26170527d8c09aa6d152fd14c3fb207a267d
+  metadata.gz: 282714f27151e8626a70a7a5d583dd16d5f623b5bd6dc5a18b0bd3799972c9b0
+  data.tar.gz: 97096cefae2cadbd8708d19cb1d6bfa448a3f324d85b1fa406196de6cc776494
 SHA512:
-  metadata.gz: ff731b2ca714546421d437c6b9c2dd43560e3db9f3ca4eeaba846547e2f50763786d0e466cb0a44dec9fd40f7631c888117b3c8f6f5ae0500b08243231164a40
-  data.tar.gz: 1459938e4540dcbbce30cfa9214386d092c1081425419c9224f14e9a426556df62c0d09a46a206ab6f3c6c2900a2f0a8309ec6b8c07faee5694c496b95ecc26f
+  metadata.gz: 3aac33eb6514f976ef2d69b98b9a9afcbaf488b4dd10966f7895296cbec5035800851c6ce274a1bbd4dfdd09bda75c95474bb4aa1c441611ff52513e4acc4ccd
+  data.tar.gz: 12c2327650881b2de7fcecd7b154106b1445794d8088b12f23f6c0fa2a528d9026c434a4ed6e3b056ccf1bc5d037a7e4c7a958ffa77f74b1ed039fd319e13e3e

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 
-## [0.4.2] - 2025-03-10
+## [0.6.0] - 2025-07-25
+
+- Add `--only` option to only include specific files or directories in the diff.
+- Add `rails-diff dotfiles` to compare dotfiles (configuration files) in the repository.
+- [BUGFIX] --fail-on-diff wasn't aborting with errors on diff.
+
+## [0.5.0] - 2025-03-10
 
 - Don't abort process on bundle check failure.
 - Add optional debug logs.
@@ -64,6 +70,9 @@ M## [0.1.1] - 2025-02-21
 
 - Initial release
 
+[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
 [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

data/README.md

@@ -67,7 +67,14 @@ rails-diff generated scaffold Post --fail-on-diff
 rails-diff generated authentication --commit 7df1b8
 ```
 
-### Options
+### Compare dotfiles (configuration files)
+
+```bash
+# Compare configuration files like .gitignore, .rspec, .rubocop.yml
+rails-diff dotfiles
+```
+
+### Global Options
 
 #### --fail-on-diff
 
@@ -96,6 +103,14 @@ Skip specific files or directories during the diff.
 rails-diff generated scaffold Post --skip app/views app/helpers
 ```
 
+#### --only <files/directories>
+
+Only include specific files or directories in the diff.
+
+```bash
+rails-diff generated scaffold Post --only app/models app/controllers
+```
+
 #### --clear-cache/--no-cache
 
 Clear the cache directory to force cloning Rails and regenerating the Rails template app.

data/lib/rails/diff/cli.rb

@@ -0,0 +1,63 @@
+require "thor"
+
+module Rails
+  module Diff
+    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 :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?
+
+        options[:fail_on_diff] ? abort(diff) : puts(diff)
+      end
+
+      desc "dotfiles", "Compare dotfiles in your repository with the ones generated by Rails"
+      def dotfiles
+        dotfiles = `git ls-files --cached --others --exclude-standard -- '.*'`.split("\n")
+
+        file(*dotfiles)
+      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: []
+      option :only, type: :array, desc: "Only include specific files or directories", aliases: ["-o"], 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],
+          only: options[:only],
+          commit: options[:commit],
+          new_app_options: options[:new_app_options]
+        )
+        return if diff.empty?
+
+        options[:fail_on_diff] ? abort(diff) : puts(diff)
+      end
+
+      map %w[--version -v] => :__version
+      desc "--version, -v", "print the version"
+      def __version
+        puts VERSION
+      end
+    end
+  end
+end

data/lib/rails/diff/file_tracker.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Rails
+  module Diff
+    class FileTracker
+      def initialize(base_dir, skip = [], only = [])
+        @base_dir = base_dir
+        @skip = skip
+        @only = only
+      end
+
+      def new_files
+        files_before = list_files(@base_dir)
+        yield
+        files_after = list_files(@base_dir, @skip, @only)
+        files_after - files_before
+      end
+
+      private
+
+      def list_files(dir, skip = [], only = [])
+        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") ||
+            skip.any? { |s| it.start_with?("#{dir}/#{s}") }
+        end
+
+        if only.any?
+          files.select { |it| only.any? { |o| it.start_with?("#{dir}/#{o}") } }
+        else
+          files
+        end
+      end
+    end
+  end
+end

data/lib/rails/diff/logger.rb

@@ -0,0 +1,21 @@
+module Rails
+  module Diff
+    module Logger
+      extend self
+
+      def info(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 error(label, message)
+        warn "\e[1;31m#{label}\e[0m #{message}"
+      end
+    end
+  end
+end

data/lib/rails/diff/rails_app_generator.rb

@@ -0,0 +1,95 @@
+require "digest"
+
+module Rails
+  module Diff
+    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)
+        @new_app_options = new_app_options.to_s.split
+        @rails_repo = RailsRepo.new(logger:, cache_dir:)
+        @commit = commit
+        @logger = logger
+        @cache_dir = cache_dir
+        clear_cache if no_cache
+      end
+
+      def clear_cache
+        logger.info "Clearing cache"
+        FileUtils.rm_rf(cache_dir, secure: true)
+        FileUtils.mkdir_p(cache_dir)
+      end
+
+      def create_template_app
+        return if cached_app?
+
+        create_new_rails_app
+      end
+
+      def template_app_path
+        @template_app_path ||= File.join(cache_dir, rails_cache_dir_key, rails_new_options_hash, app_name)
+      end
+
+      def install_app_dependencies
+        Dir.chdir(template_app_path) do
+          unless Shell.run!("bundle check", abort: false, logger:)
+            logger.info "Installing application dependencies"
+            Shell.run!("bundle install", logger:)
+          end
+        end
+      end
+
+      def run_generator(generator_name, *args, skip, only)
+        Dir.chdir(template_app_path) do
+          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:) }
+            .map { |it| it.delete_prefix("#{template_app_path}/") }
+        end
+      end
+
+      private
+
+      attr_reader :new_app_options, :rails_repo, :logger, :cache_dir
+
+      def commit = @commit ||= rails_repo.latest_commit
+
+      def rails_cache_dir_key = "rails-#{commit.first(10)}"
+
+      def railsrc_options
+        @railsrc_options ||= File.exist?(RAILSRC_PATH) ? File.readlines(RAILSRC_PATH) : []
+      end
+
+      def app_name = @app_name ||= File.basename(Dir.pwd)
+
+      def cached_app?
+        File.exist?(template_app_path) && rails_repo.up_to_date?
+      end
+
+      def create_new_rails_app
+        checkout_rails_commit
+        generate_app
+      end
+
+      def generate_app
+        rails_repo.install_dependencies
+        if railsrc_options.any?
+          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
+
+      def checkout_rails_commit = rails_repo.checkout(commit)
+
+      def rails_new_options
+        @rails_new_options ||= (new_app_options + railsrc_options).compact
+      end
+
+      def rails_new_options_hash
+        Digest::MD5.hexdigest(rails_new_options.join(" "))
+      end
+    end
+  end
+end

data/lib/rails/diff/rails_repo.rb

@@ -0,0 +1,89 @@
+module Rails
+  module Diff
+    class RailsRepo
+      RAILS_REPO = "https://github.com/rails/rails.git"
+
+      def initialize(logger:, cache_dir: Rails::Diff::CACHE_DIR, rails_repo: RAILS_REPO)
+        @logger = logger
+        @cache_dir = cache_dir
+        @rails_repo = rails_repo
+      end
+
+      def checkout(commit)
+        on_rails_dir do
+          logger.info "Checking out Rails (at commit #{commit[0..6]})"
+          Shell.run!("git", "checkout", commit, logger:)
+        end
+      end
+
+      def latest_commit
+        @latest_commit ||= on_rails_dir do
+          Shell.run!("git fetch origin main", logger:)
+          `git rev-parse origin/main`.strip
+        end
+      end
+
+      def up_to_date?
+        File.exist?(rails_path) && on_latest_commit?
+      end
+
+      def install_dependencies
+        within "railties" do
+          unless Shell.run!("bundle check", abort: false, logger:)
+            logger.info "Installing Rails dependencies"
+            Shell.run!("bundle", "config", "set", "--local", "without", "db", logger:)
+            Shell.run!("bundle", "install", logger:)
+          end
+        end
+      end
+
+      def new_app(name, options)
+        within "railties" do
+          command = rails_new_command(name, options)
+          logger.info "Generating new Rails application\n\t  > #{command.join(" ")}"
+          Shell.run!(*command, logger:)
+        end
+      end
+
+      def within(dir, &block) = on_rails_dir { Dir.chdir(dir, &block) }
+
+      private
+
+      attr_reader :logger, :cache_dir, :rails_repo
+
+      def rails_path
+        File.join(cache_dir, "rails")
+      end
+
+      def on_latest_commit?
+        if current_commit == latest_commit
+          true
+        else
+          remove_repo
+          false
+        end
+      end
+
+      def on_rails_dir(&block)
+        clone_repo unless File.exist?(rails_path)
+        Dir.chdir(rails_path, &block)
+      end
+
+      def current_commit = on_rails_dir { `git rev-parse HEAD`.strip }
+
+      def remove_repo = FileUtils.rm_rf(rails_path, secure: true)
+
+      def clone_repo
+        logger.info "Cloning Rails repository"
+        Shell.run!("git", "clone", "--depth", "1", rails_repo, rails_path, logger:)
+      end
+
+      def rails_new_command(name, options)
+        [
+          "bundle", "exec", "rails", "new", name,
+          "--main", "--skip-bundle", "--force", "--quiet", *options
+        ]
+      end
+    end
+  end
+end

data/lib/rails/diff/shell.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Rails
+  module Diff
+    module Shell
+      extend self
+
+      def run!(*cmd, logger:, abort: true)
+        _, stderr, status = Open3.capture3(*cmd)
+        logger.debug(cmd.join(" "))
+        if status.success?
+          true
+        elsif abort
+          logger.error("Command failed:", cmd.join(" "))
+          abort stderr
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rails/diff/version.rb

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

data/lib/rails/diff.rb

@@ -1,147 +1,51 @@
 # frozen_string_literal: true
 
-require_relative "diff/version"
 require "rails"
-require "thor"
 require "diffy"
 require "fileutils"
-require "open3"
+require_relative "diff/cli"
+require_relative "diff/file_tracker"
+require_relative "diff/logger"
+require_relative "diff/shell"
+require_relative "diff/rails_app_generator"
+require_relative "diff/rails_repo"
+require_relative "diff/version"
 
 module Rails
   module Diff
-    class Error < StandardError; end
-
-    RAILS_REPO = "https://github.com/rails/rails.git"
     CACHE_DIR = File.expand_path("#{ENV["HOME"]}/.rails-diff/cache")
-    RAILSRC_PATH = "#{ENV["HOME"]}/.railsrc"
 
     class << self
       def file(*files, no_cache: false, commit: nil, new_app_options: nil)
-        clear_cache if no_cache
-        ensure_template_app_exists(commit, new_app_options)
+        app_generator = RailsAppGenerator.new(commit:, new_app_options:, no_cache:)
+        app_generator.create_template_app
 
-        files.filter_map { |it| diff_with_header(it) }.join("\n")
+        files
+          .filter_map { |it| diff_with_header(it, app_generator.template_app_path) }
+          .join("\n")
       end
 
-      def generated(generator_name, *args, no_cache: false, skip: [], commit: nil, new_app_options: nil)
-        clear_cache if no_cache
-        ensure_template_app_exists(commit, new_app_options)
-        install_app_dependencies
+      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:)
+        app_generator.create_template_app
+        app_generator.install_app_dependencies
 
-        generated_files(generator_name, *args, skip)
-          .map { |it| diff_with_header(it) }
+        app_generator.run_generator(generator_name, *args, skip, only)
+          .map { |it| diff_with_header(it, app_generator.template_app_path) }
           .join("\n\n")
       end
 
       private
 
-      def system!(*cmd, abort: true)
-        _, stderr, status = Open3.capture3(*cmd)
-
-        debug cmd.join(" ")
-
-        if status.success?
-          true
-        elsif abort
-          $stderr.puts "\e[1;31mCommand failed:\e[0m #{cmd.join(' ')}"
-          abort stderr
-        else
-          false
-        end
-      end
-
-      def info(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
-        info "Clearing cache"
-        FileUtils.rm_rf(CACHE_DIR)
-      end
-
-      def ensure_template_app_exists(commit, new_app_options)
-        FileUtils.mkdir_p(CACHE_DIR)
-        @new_app_options = new_app_options
-        @commit = commit || latest_commit
-        return if cached_app?
-
-        create_new_rails_app
-      end
-
-      def template_app_path
-        @template_app_path ||= File.join(CACHE_DIR, "rails-#{commit.first(10)}", rails_new_options_hash, app_name)
-      end
-
-      def rails_path
-        @rails_path ||= begin
-          File.join(CACHE_DIR, "rails").tap do |path|
-            unless File.exist?(path)
-              info "Cloning Rails repository"
-              system!("git", "clone", "--depth", "1", RAILS_REPO, path)
-            end
-          end
-        end
-      end
-
-      def railsrc_options
-        return @railsrc_options if defined?(@railsrc_options)
-
-        @railsrc_options = File.read(RAILSRC_PATH).lines if File.exist?(RAILSRC_PATH)
-      end
-
-      def app_name = @app_name ||= File.basename(Dir.pwd)
-
-      def list_files(dir, skip = [])
-        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") ||
-            skip.any? { |s| it.start_with?("#{dir}/#{s}") }
-        end
-      end
-
-      def track_new_files(skip)
-        files_before = list_files(template_app_path)
-        yield
-        files_after = list_files(template_app_path, skip)
-        files_after - files_before
-      end
-
-      def generated_files(generator_name, *args, skip)
-        Dir.chdir(template_app_path) do
-          system!("bin/rails", "destroy", generator_name, *args)
-          info "Running generator: rails generate #{generator_name} #{args.join(' ')}"
-          track_new_files(skip) { system!("bin/rails", "generate", generator_name, *args) }
-            .map { |it| it.delete_prefix("#{template_app_path}/") }
-        end
-      end
-
-      def diff_with_header(file)
-        diff = diff_file(file)
+      def diff_with_header(file, template_app_path)
+        diff = diff_file(file, template_app_path)
         return if diff.empty?
 
         header = "#{file} diff:"
         [header, "=" * header.size, diff].join("\n")
       end
 
-      def install_app_dependencies
-        Dir.chdir(template_app_path) do
-          unless system!("bundle check", abort: false)
-            info "Installing application dependencies"
-            system!("bundle install")
-          end
-        end
-      end
-
-      def diff_file(file)
+      def diff_file(file, template_app_path)
         rails_file = File.join(template_app_path, file)
         repo_file = File.join(Dir.pwd, file)
 
@@ -152,122 +56,9 @@ module Rails
           rails_file,
           repo_file,
           context: 2,
-          source: 'files'
+          source: "files"
         ).to_s(:color).chomp
       end
-
-      def cached_app?
-        File.exist?(template_app_path) && !out_of_date_rails?
-      end
-
-      def out_of_date_rails?
-        return true unless File.exist?(rails_path)
-
-        Dir.chdir(rails_path) do
-          system!("git fetch origin main")
-          current = `git rev-parse HEAD`.strip
-          latest = `git rev-parse origin/main`.strip
-
-          if current != latest
-            FileUtils.rm_rf(rails_path)
-            return true
-          end
-        end
-
-        false
-      end
-
-      def create_new_rails_app
-        Dir.chdir(rails_path) do
-          checkout_rails
-          generate_app
-        end
-      end
-
-      def generate_app
-        Dir.chdir("railties") do
-          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\t  > #{railsrc_options.join(' ')}"
-          end
-
-          info "Generating new Rails application\n\t  > #{rails_new_command.join(' ')}"
-          system!(*rails_new_command)
-        end
-      end
-
-      def checkout_rails
-        info "Checking out Rails (at commit #{commit[0..6]})"
-        system!("git", "checkout", commit)
-      end
-
-      def commit = @commit
-
-      def new_app_options = @new_app_options
-
-      def latest_commit
-        Dir.chdir(rails_path) do
-          `git rev-parse origin/main`.strip
-        end
-      end
-
-      def rails_new_command = @rails_new_command ||= [
-          "bundle",
-          "exec",
-          "rails",
-          "new",
-          template_app_path,
-          "--main",
-          "--skip-bundle",
-          "--force",
-          "--quiet",
-          *rails_new_options
-        ]
-
-      def rails_new_options = @rails_new_options ||= [*new_app_options, *railsrc_options].compact
-
-      def rails_new_options_hash = Digest::MD5.hexdigest(rails_new_options.join(" "))
-    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"
-      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?
-
-        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)
-        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?
-
-        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
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Matheus Richard
 bindir: exe
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,12 @@ files:
 - Rakefile
 - exe/rails-diff
 - lib/rails/diff.rb
+- lib/rails/diff/cli.rb
+- lib/rails/diff/file_tracker.rb
+- lib/rails/diff/logger.rb
+- lib/rails/diff/rails_app_generator.rb
+- lib/rails/diff/rails_repo.rb
+- lib/rails/diff/shell.rb
 - lib/rails/diff/version.rb
 homepage: https://github.com/matheusrich/rails-diff
 licenses:
@@ -92,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Compare Rails-generated files with the ones in your repository
 test_files: []