rename-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 631d72108be39543d3d3f40400e9d306d92c04f96d77a80a8664a9ad87f528a7
+  data.tar.gz: fc3dd19e44e55e47d37e3a3f9f291167af6f02da2d0b05a48c8294e748164d9d
+SHA512:
+  metadata.gz: b8e7406078cd5073f70111cbc4e30b2217021d9da5ff54a380551924fd9b579ba917687722207e92ac00d1ed92cee070db0771b25719385148d28d280e875038
+  data.tar.gz: 0ceb8bec89186fc0a2dfcd0377a771187866de558834745ee2c7e3174f5457f06e66d6ffcd478697e79c4a4254bd1b8af8ad8b0302a3d090a8c267ef2cc3adab

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rename.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+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,36 @@
+rename-rails
+============
+
+This gem allows you to rename your Rails application by using a single command.
+
+Fork of [rename][rename] by [@morshedalam][], with updates for Rails 6 provided by [@rlogwood][].
+
+[rename]: https://github.com/morshedalam/rename
+[@morshedalam]: https://github.com/morshedalam
+[@rlogwood]: https://github.com/rlogwood
+
+
+Installation
+------------
+
+Add the following to your Rails app's `Gemfile` and `bundle install`:
+
+```ruby
+gem "rename"
+```
+
+Usage
+-----
+
+```sh
+$ rails generate rename:into NewAppName
+```
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/lib/generators/rename_rails/app_to/USAGE

@@ -0,0 +1 @@
+rails generate rename:app_to NewAppName

data/lib/generators/rename_rails/app_to/app_to_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require File.expand_path("../shared/common_methods", File.dirname(__FILE__))
+
+module RenameRails
+  module Generators
+    class AppToGenerator < Rails::Generators::Base
+      include CommonMethods
+
+      def app_to
+        warn "[DEPRECATION] `app_to` is deprecated.  Please use `into` instead."
+        perform
+      end
+    end
+  end
+end

data/lib/generators/rename_rails/into/USAGE

@@ -0,0 +1 @@
+rails g rename:into NewName

data/lib/generators/rename_rails/into/into_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require File.expand_path("../shared/common_methods", File.dirname(__FILE__))
+
+module RenameRails
+  module Generators
+    class IntoGenerator < Rails::Generators::Base
+      include CommonMethods
+
+      def into
+        perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module CommonMethods
+  extend ActiveSupport::Concern
+
+  included do
+    desc "Rename your Rails application"
+
+    argument :new_name, type: :string, default: ""
+  end
+
+  protected
+
+  def perform
+    prepare_app_vars
+    validate_name_and_path?
+    apply_new_module_name
+    change_app_directory
+  end
+
+  def app_parent
+    if Rails::VERSION::MAJOR >= 6
+      Rails.application.class.module_parent.name
+    else
+      Rails.application.class.parent.name
+    end
+  end
+
+  def prepare_app_vars
+    @new_key         = new_name.gsub(/\W/, "_")
+    @old_module_name = app_parent
+    @new_module_name = @new_key.squeeze("_").camelize
+    @new_dir         = new_name.gsub(%r{[&%*@()!{}\[\]'\\/"]+}, "")
+    @new_path        = Rails.root.to_s.split("/")[0...-1].push(@new_dir).join("/")
+  end
+
+  def validate_name_and_path?
+    if new_name.blank?
+      raise Thor::Error, "[Error] Application name can't be blank."
+    elsif /^\d/.match?(new_name)
+      raise Thor::Error, "[Error] Please give a name which does not start with numbers."
+    elsif @new_module_name.empty?
+      raise Thor::Error, "[Error] Please enter at least one alphabet."
+    elsif reserved_names.include?(@new_module_name.downcase)
+      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)
+      raise Thor::Error, "[Error] Already in use, please choose another name."
+    end
+  end
+
+  # rename_app_to_new_app_module
+  def apply_new_module_name
+    in_root do
+      puts "Search and replace module in..."
+
+      # 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)
+      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)
+
+      # Update package.json name entry
+      old_package_name_regex = /\Wname\W *: *\W(?<name>[-_\p{Alnum}]+)\W *, */i
+      new_package_name = %("name":"#{@new_module_name.underscore}",)
+      replace_into_file("package.json", old_package_name_regex, new_package_name)
+
+      # Update app/views/layouts/application.html.erb title
+      replace_into_file("app/views/layouts/application.html.erb", "<title>#{@old_module_name}</title>",
+                        "<title>#{@new_module_name}</title>")
+
+      # Update channel prefix config/cable.yml
+      replace_into_file("config/cable.yml", "#{@old_module_name.underscore}_production",
+                        "#{@new_module_name.underscore}_production")
+
+      # Update config/environments/production.rb  # config.active_job.queue_name_prefix = "(myapp)_production"
+      replace_into_file("config/environments/production.rb", "#{@old_module_name.underscore}_production",
+                        "#{@new_module_name.underscore}_production")
+
+      # config/database.yml capitalize environment variable
+      replace_into_file("config/database.yml", "ENV['#{@new_module_name.underscore}_DATABASE_PASSWORD']",
+                        "ENV['#{@new_module_name.underscore.upcase}_DATABASE_PASSWORD']")
+    end
+  end
+
+  # rename_app_to_new_app_directory
+  def change_app_directory
+    rename_references
+    rename_directory
+  end
+
+  private
+
+  def reserved_names
+    @reserved_names = %w[application destroy benchmarker profiler plugin runner test]
+  end
+
+  def rename_references
+    puts "Renaming references..."
+    old_basename = File.basename(Dir.getwd)
+
+    in_root do
+      Dir.glob(".idea/*", File::FNM_DOTMATCH).each do |file|
+        replace_into_file(file, old_basename, @new_dir)
+      end
+
+      gem_set_file = ".ruby-gemset"
+      replace_into_file(gem_set_file, old_basename, @new_dir) if File.exist?(gem_set_file)
+    end
+  end
+
+  def rename_directory
+    print "Renaming directory..."
+
+    begin
+      # FileUtils.mv Dir.pwd, app_path
+      File.rename(Rails.root.to_s, @new_path)
+      puts "Done!"
+      puts "New application path is '#{@new_path}'"
+    rescue StandardError => e
+      puts "Error:#{e.inspect}"
+    end
+  end
+
+  def replace_into_file(file, search_exp, replace)
+    return if File.directory?(file)
+
+    begin
+      gsub_file file, search_exp, replace
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+    end
+  end
+end

data/lib/rename_rails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RenameRails
+  autoload :VERSION, "active_admin/version"
+end

data/lib/rename_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RenameRails
+  VERSION = "1.0.0"
+end

data/rename_rails.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/rename_rails/version", __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name = "rename-rails"
+  gem.version = RenameRails::VERSION
+  gem.licenses = ["MIT"]
+  gem.summary = "Rename your Rails application using a single command."
+  gem.authors = ["Morshed Alam", "Richard Logwood", "Jake Romer"]
+  gem.email = "jake@jmromer.org"
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = "https://github.com/jmromer/rename-rails"
+  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = %w[lib]
+
+  gem.required_ruby_version = "~> 3.0"
+  gem.add_dependency "rails", "~> 6.1"
+  gem.add_dependency "thor", "~> 1.1"
+  gem.add_runtime_dependency "activesupport", "~> 6.1"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rename-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Morshed Alam
+- Richard Logwood
+- Jake Romer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description:
+email: jake@jmromer.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/rename_rails/app_to/USAGE
+- lib/generators/rename_rails/app_to/app_to_generator.rb
+- lib/generators/rename_rails/into/USAGE
+- lib/generators/rename_rails/into/into_generator.rb
+- lib/generators/rename_rails/shared/common_methods.rb
+- lib/rename_rails.rb
+- lib/rename_rails/version.rb
+- rename_rails.gemspec
+homepage: https://github.com/jmromer/rename-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Rename your Rails application using a single command.
+test_files: []