rails-diff 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 567e5e325109a4ed6c9daee6dd2c18a8c5bf20de492be9c4399c54347a2091fa
-  data.tar.gz: 6ef46901ce7d1445e0c8651323fdad776e9225223c4f2e4c1d6e506c31d70130
+  metadata.gz: 65e5efcc214d48f2c3d2aac80dfb88c7506b3bd559a74e2c77f31fd1388736f0
+  data.tar.gz: cd3123a08c990c068401869e18e6a8c3ad0fb54867640b42a655357d73b23a01
 SHA512:
-  metadata.gz: 1b5259244a5b576f651c75981c807854bb82d71cf3b7af72074a9ec05dacb30db477af39dc2a2ab1a11a2d328da23cbeb1b9deec62a0c190355785299f1622d5
-  data.tar.gz: 6b037fd06f237a6a48d2b98e4dcd36609b8a2b3ece0a7bada82b38249b63ca20fdcbdb8ee707ecafefa0de40fd5db8d6c18a97be033f2771a620cfb1750d9c42
+  metadata.gz: 1177590a5fa948253de27d6169f567cd75a50dc9f840e4145b45ddc55e7e3f884c8595b0ed2a8a01911290be9eaeab34eaee670212cddd56f412b7ab1a4564ea
+  data.tar.gz: 67c3ff2090a3f81c1ff1d22e1dad2ca549b45e80588021eec5c128d0f8bede276cb8da2ffcd5719fc3a312e0be52fde112ccd37cf6a97398c6725e22dc3c2375

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-03-05
+
+- Respect `~/.railsrc` file when generating new rails apps (PR #4). Thanks [@marcoroth](https://github.com/marcoroth) 🎉
+- Use array version of `system` to avoid command injection.
+- Update cache keys to be shorter.
+- Improve log messages.
+
+## [0.3.0] - 2025-02-23
+
+- Allow passing options to generate the new application
+
+```sh
+rails-diff file Gemfile --new-app-options="--database=postgresql"
+```
+
 ## [0.2.1] - 2025-02-22
 
 - Add missing version command
@@ -30,6 +45,8 @@ M## [0.1.1] - 2025-02-21
 
 - Initial release
 
+[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
 [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

data/README.md

@@ -78,6 +78,16 @@ If this option is specified, the command will exit with a non-zero status code i
 Specify the commit hash you want to compare against. If not provided, the latest
 commit on main will be used by default.
 
+#### --new-app-options <options>
+
+Specify additional options to be used with the `rails new` command. This allows you to customize the generated Rails application, for example, by specifying a different database.
+
+Example:
+
+```bash
+rails-diff file Dockerfile --new-app-options="--database=postgresql"
+```
+
 ## How it works
 
 When you run the diff, it will:

data/lib/rails/diff/version.rb

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

data/lib/rails/diff.rb

@@ -5,25 +5,27 @@ require "rails"
 require "thor"
 require "diffy"
 require "fileutils"
+require "open3"
 
 module Rails
   module Diff
     class Error < StandardError; end
 
     RAILS_REPO = "https://github.com/rails/rails.git"
-    CACHE_DIR = File.expand_path("~/.rails-diff/cache")
+    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)
+      def file(*files, no_cache: false, commit: nil, new_app_options: nil)
         clear_cache if no_cache
-        ensure_template_app_exists(commit)
+        ensure_template_app_exists(commit, new_app_options)
 
         files.filter_map { |it| diff_with_header(it) }.join("\n")
       end
 
-      def generated(generator_name, *args, no_cache: false, skip: [], commit: nil)
+      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)
+        ensure_template_app_exists(commit, new_app_options)
         install_app_dependencies
 
         generated_files(generator_name, *args, skip)
@@ -33,34 +35,56 @@ module Rails
 
       private
 
+      def system!(*cmd)
+        _, stderr, status = Open3.capture3(*cmd)
+
+        unless status.success?
+          puts "\e[1;31mCommand failed:\e[0m #{cmd.join(' ')}"
+          abort stderr
+        end
+
+        true
+      end
+
+      def info(message)
+        puts "\e[1;34minfo:\e[0m #{message}"
+      end
+
       def clear_cache
-        puts "Clearing cache"
+        info "Clearing cache"
         FileUtils.rm_rf(CACHE_DIR)
       end
 
-      def ensure_template_app_exists(commit)
+      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?
 
-        FileUtils.rm_rf(template_app_path)
         create_new_rails_app
       end
 
       def template_app_path
-        @template_app_path ||= File.join(CACHE_DIR, commit, app_name)
+        @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)
-              system("git clone --depth 1 #{RAILS_REPO} #{path} >/dev/null 2>&1")
+              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 = [])
@@ -82,11 +106,10 @@ module Rails
       end
 
       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") }
+          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
@@ -101,9 +124,9 @@ module Rails
 
       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")
+          unless system!("bundle check")
+            info "Installing application dependencies"
+            system!("bundle install")
           end
         end
       end
@@ -112,8 +135,8 @@ module Rails
         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)
+        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(
           rails_file,
@@ -124,14 +147,14 @@ module Rails
       end
 
       def cached_app?
-        File.exist?(template_app_path) && !rails_updated?
+        File.exist?(template_app_path) && !out_of_date_rails?
       end
 
-      def rails_updated?
-        return true if !File.exist?(rails_path)
+      def out_of_date_rails?
+        return true unless File.exist?(rails_path)
 
         Dir.chdir(rails_path) do
-          system("git fetch origin main >/dev/null 2>&1")
+          system!("git fetch origin main")
           current = `git rev-parse HEAD`.strip
           latest = `git rev-parse origin/main`.strip
 
@@ -153,34 +176,58 @@ module Rails
 
       def generate_app
         Dir.chdir("railties") do
-          unless system("bundle check >/dev/null 2>&1")
-            puts "Installing Rails dependencies"
-            system("bundle install >/dev/null 2>&1")
+          unless system!("bundle check")
+            info "Installing Rails dependencies"
+            system!("bundle install")
           end
 
-          puts "Generating new Rails application"
-          system("bundle exec rails new #{template_app_path} --main --skip-bundle --force --skip-test --skip-system-test --quiet")
+          if railsrc_options
+            info "Using default options from #{RAILSRC_PATH}:\n  > #{railsrc_options.join(' ')}"
+          end
+
+          info "Generating new Rails application\n  > #{rails_new_command.join(' ')}"
+          system!(*rails_new_command)
         end
       end
 
       def checkout_rails
-        puts "Checking out Rails (at commit #{commit[0..6]})"
-        system("git checkout #{commit} >/dev/null 2>&1")
+        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"
 
       def self.exit_on_failure? = true
 
@@ -188,7 +235,7 @@ module Rails
       def file(*files)
         abort "Please provide at least one file to compare" if files.empty?
 
-        diff = Rails::Diff.file(*files, no_cache: options[:no_cache], commit: options[:commit])
+        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)
@@ -197,7 +244,7 @@ module Rails
       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)
-        diff = Rails::Diff.generated(generator_name, *args, no_cache: options[:no_cache], skip: options[:skip], commit: options[:commit])
+        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)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-diff
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matheus Richard
 bindir: exe
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Compare Rails-generated files with the ones in your repository
 test_files: []