rename 1.0.11 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9bfc9678104ffa45d1ed46dd77175ec9477dd8ac9d78e2b311312821e93e7c
-  data.tar.gz: 928bd83c721e29792092910a6f40b34215c43a1a7750be1eaf4e39a753a7de42
+  metadata.gz: f9103bd6950e096f966b148dd5a186d10deee5de51b33f659c992e102d7be6f0
+  data.tar.gz: 8cb7182693d49c6197b03cdcacf8081ebf5dbb29c3ed387704c8a58545958603
 SHA512:
-  metadata.gz: 4cdb1e940a996bf0eddf75eaf12bad8542e2af9ced9f468761c72f8ec11dca3dc56b459b99074cb96b9f573df5384e223928a504d15e66db8e202d2810022efa
-  data.tar.gz: 892261fd19eb9228bd0f945c8c2ab035ac7842a20356334df1a6d20c3dc321b507e916e9474aeee90af6c3ddce06ae81c9512542d655071f4320f2baa1ae89c1
+  metadata.gz: d5d6c617e7f321a063e18a3ed2f3e206956f47c606fcbb09d0b1f2fec60b091ebdac9bdcb78587beeaa02a7d3aba4fc1de9db71d59d4c6cbe778412f846cf815
+  data.tar.gz: ef0dcb01aa5d90c5e776e224e2eaec29601758effee2e156eb4c6debc5973584d2a3e2d035575cd4152b6284db4d128fa558f347e9f5b40686d40532513ee196

data/README.md

@@ -2,7 +2,7 @@
 
 This gem allows you to rename your Rails application by using a single command.
 
-Tested up to Ruby 3.2.2 and Rails 7.0.8
+Tested up to Ruby 3.4.5 and Rails 8.0.2
 
 ## Installation
 
@@ -18,6 +18,52 @@ gem 'rename'
 rails g rename:into New-Name
 ```
 
+## Applied
+
+```
+Search and replace exact module name to...
+  Gemfile
+  Gemfile.lock
+  README.md
+  Rakefile
+  config.ru
+  config/application.rb
+  config/boot.rb
+  config/environment.rb
+  config/environments/development.rb
+  config/environments/production.rb
+  config/environments/test.rb
+  config/importmap.rb
+  config/initializers/assets.rb
+  config/initializers/content_security_policy.rb
+  config/initializers/filter_parameter_logging.rb
+  config/initializers/inflections.rb
+  config/initializers/permissions_policy.rb
+  config/puma.rb
+  config/routes.rb
+  config/deploy.yml (Rails 8)
+  app/views/layouts/application.html.erb
+  app/views/layouts/application.html.haml
+  app/views/layouts/application.html.slim
+  app/views/pwa/manifest.json.erb (Rails 8)
+  README.md
+  README.markdown
+  README.mdown
+  README.mkdn
+  Dockerfile (if present)
+Search and replace underscore seperated module name to...
+  config/initializers/session_store.rb (if present)
+  config/database.yml
+  config/database.yml (Rails 8 multi-db: cache, queue, cable)
+  config/database.yml (environment variables)
+  config/cable.yml
+  config/environments/production.rb
+  config/deploy.yml (Rails 8 Kamal service names)
+  package.json
+Removing references...
+  .idea
+Renaming directory...
+```
 
 ## Contributing
 

data/lib/generators/rename/shared/common_methods.rb

@@ -15,7 +15,8 @@ module CommonMethods
     prepare_app_vars
     validate_name_and_path?
     apply_new_module_name
-    change_app_directory
+    remove_references
+    rename_directory
   end
 
   def app_parent
@@ -27,10 +28,17 @@ module CommonMethods
   end
 
   def prepare_app_vars
-    @new_key         = new_name.gsub(/\W/, '_')
     @old_module_name = app_parent
     @old_dir         = File.basename(Dir.getwd)
-    @new_module_name = @new_key.squeeze('_').camelize
+    @old_app_name    = detect_app_name || @old_module_name.underscore
+
+    # Normalize old directory name using ActiveSupport to handle hyphens
+    # If the directory has hyphens, the database name would have underscores
+    @old_app_name_from_dir = @old_dir.parameterize(separator: '_')
+
+    @new_app_name    = new_name.parameterize(separator: '_').gsub('-', '_')
+    @new_module_name = @new_app_name.camelize
+    @new_key         = @new_app_name
     @new_dir         = new_name.gsub(/[&%*@()!{}\[\]'\\\/"]+/, '')
     @new_path        = Rails.root.to_s.split('/')[0...-1].push(@new_dir).join('/')
   end
@@ -46,7 +54,7 @@ module CommonMethods
       raise Thor::Error, '[Error] Please give a name which does not match any of the reserved Rails keywords.'
     elsif Object.const_defined?(@new_module_name)
       raise Thor::Error, "[Error] Constant '#{@new_module_name}' is already in use, please choose another name."
-    elsif file_exist?(@new_path)
+    elsif file_exist?(@new_path) && @new_path != Rails.root.to_s
       raise Thor::Error, "[Error] Folder '#{@new_dir}' already in use, please choose another name."
     end
   end
@@ -54,42 +62,61 @@ module CommonMethods
   # rename_app_to_new_app_module
   def apply_new_module_name
     in_root do
-      puts 'Search and replace module in files...'
-
-      #Search and replace module in to file
-      Dir['*', 'config/**/**/*.rb', '.{rvmrc}'].each do |file|
-        # file = File.join(Dir.pwd, file)
-        replace_into_file(file, /(#{@old_module_name}*)/m, @new_module_name)
+      puts 'Search and replace exact module name...'
+      Dir['*', 'config/**/**/*.{rb,yml}', '.{rvmrc}', 'app/views/pwa/*.json.erb'].each do |file|
+        replace_into_file(file, /#{@old_module_name}/, @new_module_name)
+      end
+      #Application layout
+      %w(erb haml slim).each do |ext|
+        replace_into_file("app/views/layouts/application.html.#{ext}", /#{@old_module_name}/, @new_module_name)
+        replace_into_file("app/views/layouts/application.html.#{ext}", /#{@old_module_name.underscore.humanize}/, @new_module_name.underscore.humanize)
+      end
+      #Readme
+      %w(md markdown mdown mkdn).each do |ext|
+        replace_into_file("README.#{ext}", /#{@old_module_name}/, @new_module_name)
       end
 
-      #Rename session key
-      replace_into_file('config/initializers/session_store.rb', /(('|")_.*_session('|"))/i, "'_#{@new_key}_session'")
-      #Rename database
-      replace_into_file('config/database.yml', /#{@old_module_name.underscore}/i, @new_name.underscore)
-      #Rename into channel and job queue
+      puts 'Search and replace underscore separated module name in files...'
+      #session key
+      safe_replace_into_file('config/initializers/session_store.rb', /(('|")_.*_session('|"))/i, "'_#{@new_key}_session'")
+      #database
+      # Try both the detected app name and the directory-based name (with underscores)
+      replace_into_file('config/database.yml', /#{@old_app_name}/i, @new_app_name)
+      replace_into_file('config/database.yml', /#{@old_app_name_from_dir}/i, @new_app_name) if @old_app_name != @old_app_name_from_dir
+      replace_into_file('config/database.yml', /#{@old_app_name}_(production|development|test)(_cache|_queue|_cable)?/, "#{@new_app_name}_\\1\\2")
+      replace_into_file('config/database.yml', /#{@old_app_name_from_dir}_(production|development|test)(_cache|_queue|_cable)?/, "#{@new_app_name}_\\1\\2") if @old_app_name != @old_app_name_from_dir
+      replace_into_file('config/database.yml', /#{@old_app_name.upcase}_DATABASE_PASSWORD/, "#{@new_app_name.upcase}_DATABASE_PASSWORD")
+      replace_into_file('config/database.yml', /#{@old_app_name_from_dir.upcase}_DATABASE_PASSWORD/, "#{@new_app_name.upcase}_DATABASE_PASSWORD") if @old_app_name != @old_app_name_from_dir
+      #Channel and job queue
       %w(config/cable.yml config/environments/production.rb).each do |file|
-        replace_into_file(file, /#{@old_module_name.underscore}_production/, "#{@new_module_name.underscore}_production")
+        replace_into_file(file, /#{@old_app_name}_production/, "#{@new_app_name}_production")
+        replace_into_file(file, /#{@old_app_name_from_dir}_production/, "#{@new_app_name}_production") if @old_app_name != @old_app_name_from_dir
       end
-      #Application layout
-      %w(erb haml).each do |file|
-        replace_into_file("app/views/layouts/application.html.#{file}", /#{@old_module_name}/, @new_module_name)
-      end
-      # Update package.json name entry
+      # package.json name entry
       old_package_name_regex = /\Wname\W *: *\W(?<name>[-_\p{Alnum}]+)\W *, */i
-      new_package_name = %("name":"#{@new_module_name.underscore}",)
+      new_package_name       = %("name":"#{@new_app_name}",)
       replace_into_file('package.json', old_package_name_regex, new_package_name)
 
-      puts 'Search and replace module in environment variables...'
-      #Rename database
-      replace_into_file('config/database.yml', /#{@old_module_name.underscore.upcase}/, @new_module_name.underscore.upcase)
-    end
-  end
 
-  # rename_app_to_new_app_directory
-  def change_app_directory
-    rename_references
-    remove_references
-    rename_directory
+      # Rails 8 specific files
+      # Kamal deployment configuration
+      safe_replace_into_file('config/deploy.yml', /service: #{@old_app_name}/, "service: #{@new_app_name}")
+      safe_replace_into_file('config/deploy.yml', /service: #{@old_app_name_from_dir}/, "service: #{@new_app_name}") if @old_app_name != @old_app_name_from_dir
+      safe_replace_into_file('config/deploy.yml', /image: (.+)\/#{@old_app_name}/, "image: \\1/#{@new_app_name}")
+      safe_replace_into_file('config/deploy.yml', /image: (.+)\/#{@old_app_name_from_dir}/, "image: \\1/#{@new_app_name}") if @old_app_name != @old_app_name_from_dir
+      safe_replace_into_file('config/deploy.yml', /"#{@old_app_name}_/, "\"#{@new_app_name}_")
+      safe_replace_into_file('config/deploy.yml', /"#{@old_app_name_from_dir}_/, "\"#{@new_app_name}_") if @old_app_name != @old_app_name_from_dir
+      safe_replace_into_file('config/deploy.yml', /#{@old_app_name}-db/, "#{@new_app_name}-db")
+      safe_replace_into_file('config/deploy.yml', /#{@old_app_name_from_dir}-db/, "#{@new_app_name}-db") if @old_app_name != @old_app_name_from_dir
+
+      # PWA manifest
+      safe_replace_into_file('app/views/pwa/manifest.json.erb', /"name": "#{@old_module_name}"/, "\"name\": \"#{@new_module_name}\"")
+      safe_replace_into_file('app/views/pwa/manifest.json.erb', /"description": "#{@old_module_name}/, "\"description\": \"#{@new_module_name}")
+
+      # Dockerfile
+      safe_replace_into_file('Dockerfile', /#{@old_module_name}/, @new_module_name)
+      safe_replace_into_file('Dockerfile', /#{@old_app_name}/, @new_app_name)
+    end
   end
 
   private
@@ -98,18 +125,24 @@ module CommonMethods
     @reserved_names = %w[application destroy benchmarker profiler plugin runner test]
   end
 
-  def file_exist?(name)
-    File.respond_to?(:exist?) ? File.exist?(name) : File.exists?(name)
-  end
+  def detect_app_name
+    return nil unless file_exist?('config/database.yml')
 
-  def rename_references
-    print 'Renaming references...'
+    database_content = File.read('config/database.yml')
 
-    in_root do
-      gem_set_file = '.ruby-gemset'
-      replace_into_file(gem_set_file, @old_dir, @new_dir) if file_exist?(gem_set_file)
+    if match = database_content.match(/^\s*database:\s*(\w+)_development/m)
+      app_name_candidate = match[1]
+
+      if app_name_candidate.camelize == @old_module_name
+        return app_name_candidate
+      end
     end
-    puts 'Done!'
+
+    nil
+  end
+
+  def file_exist?(name)
+    File.respond_to?(:exist?) ? File.exist?(name) : File.exists?(name)
   end
 
   def remove_references
@@ -127,6 +160,8 @@ module CommonMethods
 
     begin
       # FileUtils.mv Dir.pwd, app_path
+      gem_set_file = '.ruby-gemset'
+      replace_into_file(gem_set_file, @old_dir, @new_dir) if file_exist?(gem_set_file)
       File.rename(Rails.root.to_s, @new_path)
       puts 'Done!'
       puts "New application path is '#{@new_path}'"
@@ -144,4 +179,9 @@ module CommonMethods
       puts "Error: #{ex.message}"
     end
   end
+
+  def safe_replace_into_file(file, search_exp, replace)
+    return unless file_exist?(file) && !File.directory?(file)
+    replace_into_file(file, search_exp, replace)
+  end
 end

data/lib/rename/version.rb

@@ -1,3 +1,3 @@
 module Rename
-  VERSION = '1.0.11'
+  VERSION = '1.1.1'
 end

data/tests/hyphen_handling_test.rb

@@ -0,0 +1,126 @@
+require 'test_helper'
+require 'fileutils'
+require 'tmpdir'
+
+class HyphenHandlingTest < ActiveSupport::TestCase
+  def setup
+    @temp_dir = Dir.mktmpdir
+    @original_dir = Dir.pwd
+  end
+
+  def teardown
+    Dir.chdir(@original_dir)
+    FileUtils.rm_rf(@temp_dir)
+  end
+
+  test "handles app names with hyphens correctly" do
+    # Create a mock Rails app structure with hyphenated name
+    app_dir = File.join(@temp_dir, 'api-proxy')
+    FileUtils.mkdir_p(File.join(app_dir, 'config'))
+
+    # Create database.yml with underscore naming (as Rails would)
+    database_yml = <<~YAML
+      default: &default
+        adapter: postgresql
+        encoding: unicode
+        pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+      development:
+        <<: *default
+        database: api_proxy_development
+
+      test:
+        <<: *default
+        database: api_proxy_test
+
+      production:
+        <<: *default
+        database: api_proxy_production
+        username: api_proxy
+        password: <%= ENV["API_PROXY_DATABASE_PASSWORD"] %>
+    YAML
+
+    File.write(File.join(app_dir, 'config', 'database.yml'), database_yml)
+
+    # Create cable.yml
+    cable_yml = <<~YAML
+      production:
+        adapter: redis
+        url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+        channel_prefix: api_proxy_production
+    YAML
+
+    File.write(File.join(app_dir, 'config', 'cable.yml'), cable_yml)
+
+    Dir.chdir(app_dir) do
+      # Simulate the prepare_app_vars method
+      old_dir = File.basename(Dir.getwd)
+      assert_equal 'api-proxy', old_dir
+
+      # Test the normalization
+      old_app_name_from_dir = old_dir.parameterize(separator: '_')
+      assert_equal 'api_proxy', old_app_name_from_dir
+
+      # Verify the fix would work
+      new_app_name = 'citadel'.parameterize(separator: '_')
+      assert_equal 'citadel', new_app_name
+
+      # Read the database.yml and verify it contains the underscore version
+      db_content = File.read(File.join('config', 'database.yml'))
+      assert db_content.include?('api_proxy_development')
+      assert db_content.include?('api_proxy_test')
+      assert db_content.include?('api_proxy_production')
+      assert db_content.include?('API_PROXY_DATABASE_PASSWORD')
+
+      # Read cable.yml
+      cable_content = File.read(File.join('config', 'cable.yml'))
+      assert cable_content.include?('api_proxy_production')
+    end
+  end
+
+  test "handles normal app names without hyphens" do
+    app_dir = File.join(@temp_dir, 'myapp')
+    FileUtils.mkdir_p(File.join(app_dir, 'config'))
+
+    database_yml = <<~YAML
+      development:
+        database: myapp_development
+    YAML
+
+    File.write(File.join(app_dir, 'config', 'database.yml'), database_yml)
+
+    Dir.chdir(app_dir) do
+      old_dir = File.basename(Dir.getwd)
+      assert_equal 'myapp', old_dir
+
+      old_app_name_from_dir = old_dir.parameterize(separator: '_')
+      assert_equal 'myapp', old_app_name_from_dir
+
+      # In this case, old_app_name and old_app_name_from_dir should be the same
+      # So the conditional replacements won't run
+    end
+  end
+
+  test "handles complex app names with multiple hyphens" do
+    app_dir = File.join(@temp_dir, 'my-awesome-api-proxy')
+    FileUtils.mkdir_p(File.join(app_dir, 'config'))
+
+    database_yml = <<~YAML
+      development:
+        database: my_awesome_api_proxy_development
+    YAML
+
+    File.write(File.join(app_dir, 'config', 'database.yml'), database_yml)
+
+    Dir.chdir(app_dir) do
+      old_dir = File.basename(Dir.getwd)
+      assert_equal 'my-awesome-api-proxy', old_dir
+
+      old_app_name_from_dir = old_dir.parameterize(separator: '_')
+      assert_equal 'my_awesome_api_proxy', old_app_name_from_dir
+
+      db_content = File.read(File.join('config', 'database.yml'))
+      assert db_content.include?('my_awesome_api_proxy_development')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rename
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.1.1
 platform: ruby
 authors:
 - Morshed Alam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2026-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,6 +73,7 @@ files:
 - lib/rename.rb
 - lib/rename/version.rb
 - rename.gemspec
+- tests/hyphen_handling_test.rb
 - tests/rename_test.rb
 - tests/test_helper.rb
 homepage: https://github.com/morshedalam/rename
@@ -94,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rename
-rubygems_version: 2.7.11
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Rename your Rails application using a single command.