rails-diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5049aad3c07aafb46e197ad4a1e57655615d1c0b577ab07939a13cb0a28cce9
+  data.tar.gz: 589d63e3f324dc0a86b9816586d88517146f9e2dc84f71c4b10c7b414e4de054
+SHA512:
+  metadata.gz: cf848b14e60228991ee6f6091f17a49ad30e69fe3efd1fdbddf9a069826a6ba4af0460ec4e6e9891bd1dfcd5762a6b457e7c68c115972229ca18a64f375ef5ae
+  data.tar.gz: f72083a3b5329062e0939ad04c7dc3745262d755550197a4e8e5e814a9561705e9c9cee45a9e010a5d323698fe8987240e33a8d1cb7dd8555431ca1fa7d98a44

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-21
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Matheus Richard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Rails::Diff
+
+Compare your Rails application files with the ones generated by Rails main
+branch. This helps you keep track of changes between your customized files and
+the latest Rails templates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-diff'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rails-diff
+```
+
+## Usage
+
+### Compare specific files
+
+```bash
+# Compare a single file
+rails-diff file config/routes.rb
+
+# Compare multiple files
+rails-diff file config/routes.rb config/application.rb
+
+# Force regenerate Rails app by clearing cache
+rails-diff file config/routes.rb --clear-cache
+```
+
+### Compare generator files
+
+```bash
+# Compare files that would be created by a generator
+rails-diff generated authentication
+
+# Compare files with generator arguments
+rails-diff generated scaffold Post title:string body:text
+
+# Force regenerate Rails app by clearing cache
+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
+```
+
+## How it works
+
+When you run the diff, it will:
+
+1. Clone the latest Rails from main branch
+1. Generate a new Rails app with the same name as yours
+1. Show you a colored diff between your file and the generated one
+
+### Cache
+
+The gem caches the generated Rails application to avoid regenerating it on every run. The cache is automatically invalidated when:
+- Rails has new commits on main
+- The cache directory doesn't exist
+
+You can also force clear the cache by using the `--no-cache` option (or its alias `--clear-cache`) with any command.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/matheusrich/rails-diff.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/rails-diff

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+require "rails/diff"
+
+Rails::Diff::CLI.start(ARGV)

data/lib/rails/diff/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module Diff
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/diff.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require_relative "diff/version"
+require "rails"
+require "thor"
+require "diffy"
+require "fileutils"
+
+module Rails
+  module Diff
+    class Error < StandardError; end
+
+    RAILS_REPO = "https://github.com/rails/rails.git"
+    CACHE_DIR = File.expand_path("~/.rails-diff/cache")
+
+    class << self
+      def file(*files, no_cache: false)
+        clear_cache if no_cache
+        ensure_template_app_exists
+
+        files.map { |file| diff_with_header(file) }.join("\n")
+      end
+
+      def generated(generator_name, *args, no_cache: false, skip: [])
+        clear_cache if no_cache
+        ensure_template_app_exists
+        install_app_dependencies
+
+        generated_files(skip)
+          .map { |it| diff_generated_file(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)
+      end
+
+      def rails_path
+        @rails_path ||= File.join(CACHE_DIR, "rails")
+      end
+
+      def clear_cache
+        puts "Clearing cache..."
+        FileUtils.rm_rf(CACHE_DIR)
+      end
+
+      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(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") }
+        end
+      end
+
+      def diff_with_header(file)
+        header = "#{file} diff:"
+        [
+          header,
+          "=" * header.size,
+          diff_file(file)
+        ].join("\n")
+      end
+
+      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")
+      end
+
+      def install_app_dependencies
+        Dir.chdir(template_app_path) do
+          unless system("bundle check >/dev/null 2>&1")
+            puts "Installing application dependencies..."
+            system("bundle install >/dev/null 2>&1")
+          end
+        end
+      end
+
+      def diff_file(file)
+        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)
+
+        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
+      end
+
+      def cached_app?
+        File.exist?(template_app_path) && !rails_updated?
+      end
+
+      def rails_updated?
+        return true if !File.exist?(rails_path)
+
+        Dir.chdir(rails_path) do
+          system("git fetch origin main >/dev/null 2>&1")
+          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
+        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]})"
+
+          unless system("bundle check >/dev/null 2>&1")
+            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
+        end
+      end
+    end
+
+    class CLI < Thor
+      class_option :no_cache, type: :boolean, desc: "Clear cache before running", aliases: ["--clear-cache"]
+      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])
+      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])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails-diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matheus Richard
+bindir: exe
+cert_chain: []
+date: 2025-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: rails-diff helps you compare files generated by Rails (like Dockerfile,
+  .gitignore, etc) with the ones in your repository, making it easier to keep track
+  of changes and updates.
+email:
+- matheusrichardt@gmail.com
+executables:
+- rails-diff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/rails-diff
+- lib/rails/diff.rb
+- lib/rails/diff/version.rb
+homepage: https://github.com/matheusrich/rails-diff
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/matheusrich/rails-diff
+  source_code_uri: https://github.com/matheusrich/rails-diff
+  changelog_uri: https://github.com/matheusrich/rails-diff/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Compare Rails-generated files with the ones in your repository
+test_files: []