renamespace 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: baab242cddf012fa2783d62426cafaeb4ed1787f1f00f0008cc4363f0e26c3f2
+  data.tar.gz: f82d644df34a4c2741780ebf3bdb12be61c9ea25a9827183aedad091527cbd99
+SHA512:
+  metadata.gz: 18e11ce64cfbf8bf2fe94561bd768a34c8118a037fe41fe78c07bcddb628297ccfce174b81654a9e11a654763799f77beef47f450fb89e1a45d96fee23194843
+  data.tar.gz: 73e4d9277f5812e7e011411c0af72715381a0be7b7bcd4704d2348dcb987c84fae9234d6cbc02fd128d0d915dc25459f29a3b2ebdc107f026fd48548330f8e76

data/README.md

@@ -0,0 +1,130 @@
+# Renamespace
+
+[![Build status](https://badge.buildkite.com/96fe2532aa6c155b7efc6adc355a6aa58c704c29df1a739df2.svg?branch=master)](https://buildkite.com/gs/renamespace)
+
+A command-line tool to help Ruby developers refactor class/module namespacing.
+
+## Contents
+
+<!-- MarkdownTOC autolink=true -->
+
+- [Intro](#intro)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Example](#example)
+- [More usage info](#more-usage-info)
+- [Development](#development)
+  - [Pre-push hook](#pre-push-hook)
+  - [Release](#release)
+
+<!-- /MarkdownTOC -->
+
+## Intro
+
+Renamespaces a Ruby source file:
+
+- Moves the file
+- Updates, to match the new location, the name of the class/module within the file, including its namespacing
+- Updates usages of the class/module
+- Updates the path to the file in all requires
+- Moves the associated spec file
+
+Class/module namespaces are derived from the paths provided.
+
+If you change the number of namespaces, expect to have to run RuboCop autocorrect afterwards to clean up formatting.
+
+The namespace replacing is not super smart yet, so it might get it wrong sometimes. If it does, see `renamespace --help` for some options that might help.
+
+## Installation
+
+The executable is distributed as a gem. You can install it from GitHub Packages directly like so:
+
+```bash
+$ gem install renamespace
+```
+
+And then if you're using rbenv:
+
+```bash
+$ rbenv rehash
+```
+
+## Usage
+
+```bash
+$ renamespace SOURCE_FILE_PATH DESTINATION_FILE_PATH
+```
+
+## Example
+
+With:
+
+```ruby
+# lib/my_app/models/site.rb
+
+module MyApp
+  module Models
+    class Site < BaseModel
+    end
+  end
+end
+```
+
+Run:
+
+```bash
+$ renamespace lib/my_app/models/site.rb lib/my_app/sites/model.rb
+```
+
+Result:
+
+```ruby
+# lib/my_app/sites/model.rb
+
+module MyApp
+  module Sites
+    class Model < Models::BaseModel
+    end
+  end
+end
+```
+
+## More usage info
+
+See:
+
+```bash
+$ renamespace --help
+```
+
+## Development
+
+### Pre-push hook
+
+This hook runs style checks and tests.
+
+To set up the pre-push hook:
+
+```bash
+$ echo -e "#\!/bin/bash\n\$(dirname \$0)/../../auto/pre-push-hook" > .git/hooks/pre-push
+chmod +x .git/hooks/pre-push
+```
+
+### Release
+
+First, [make sure your credentials are set up for GitHub Package Registry according to the Handbook](https://handbook.greensync.org/product/intro/getting-started/#github-package-registry-and-ruby-gems).
+
+To release a new version:
+
+```bash
+$ auto/release/update-version && auto/release/tag && auto/release/publish
+```
+
+This takes care of the whole process:
+
+- Incrementing the version number (the patch number by default)
+- Tagging & pushing commits
+- Publishing the gem to GitHub Packages
+- Creating a draft GitHub release
+
+To increment the minor or major versions instead of the patch number, run `auto/release/update-version` with `--minor` or `--major`.

data/exe/renamespace

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'clamp'
+
+require 'renamespace'
+
+Clamp.allow_options_after_parameters = true
+
+Clamp do # rubocop:disable Metrics/BlockLength
+  self.description = <<~TEXT
+    Renamespaces a Ruby source file:
+
+    - Moves the file
+    - Updates, to match the new location, the name of the class/module within the file, including its namespacing
+    - Updates usages of the class/module
+    - Updates the path to the file in all requires
+    - Moves the associated spec file
+
+    Class/module namespaces are derived from the paths provided.
+
+    If you change the number of namespaces, expect to have to run RuboCop autocorrect afterwards to clean up formatting.
+  TEXT
+
+  parameter 'SOURCE_FILE_PATH', 'The current path of the Ruby source code file to renamespace'
+  parameter 'DESTINATION_FILE_PATH', 'The desired desination path of the file'
+
+  option ['-o', '--can-omit-prefixes'], 'COUNT',
+    'How many levels of namespacing to omit up to when replacing usages of the class/module. ' \
+    'Too low, and some cases may be missed; too high, and some incorrect replacements are likely to occur',
+    default: 0, &method(:Integer)
+
+  option '--no-superclass-prefixing', :flag, "Don't prefix superclasses with their previous namespace"
+
+  option '--version', :flag, 'Show version' do
+    puts Renamespace::VERSION
+    exit 0
+  end
+
+  def execute
+    Renamespace.new(
+      source_file_path: source_file_path,
+      destination_file_path: destination_file_path,
+      can_omit_prefixes_count: can_omit_prefixes,
+      no_superclass_prefixing: no_superclass_prefixing?,
+    ).call
+  end
+end

data/lib/renamespace.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require 'facets/string/camelcase'
+require 'rainbow'
+
+require_relative 'renamespace/directories'
+require_relative 'renamespace/expand_relative_requires_within_all_files'
+require_relative 'renamespace/move_and_renamespace_source_file'
+require_relative 'renamespace/move_spec_file'
+require_relative 'renamespace/rename_within_all_files'
+require_relative 'renamespace/paths'
+require_relative 'renamespace/version'
+
+class Renamespace
+  def initialize(source_file_path:, destination_file_path:, can_omit_prefixes_count:, no_superclass_prefixing:)
+    @paths = Renamespace::Paths.new(
+      source: source_file_path,
+      destination: destination_file_path,
+    )
+    @can_omit_prefixes_count = can_omit_prefixes_count
+    @no_superclass_prefixing = no_superclass_prefixing
+  end
+
+  def call
+    move_and_renamespace_source_file
+    move_spec_file
+    expand_relative_requires_within_all_files
+    rename_within_all_files
+    remove_empty_dirs
+  end
+
+  private
+
+  attr_reader :paths, :can_omit_prefixes_count, :no_superclass_prefixing
+
+  def move_and_renamespace_source_file
+    Renamespace::MoveAndRenamespaceSourceFile.new(
+      paths: paths,
+      no_superclass_prefixing: no_superclass_prefixing,
+    ).call
+  end
+
+  def move_spec_file
+    Renamespace::MoveSpecFile.new(paths: paths).call
+  end
+
+  def expand_relative_requires_within_all_files
+    Renamespace::ExpandRelativeRequiresWithinAllFiles.new.call
+  end
+
+  def rename_within_all_files
+    Renamespace::RenameWithinAllFiles.new(paths: paths, can_omit_prefixes_count: can_omit_prefixes_count).call
+  end
+
+  def remove_empty_dirs
+    Renamespace::Directories.remove_empty_dirs
+  end
+end

data/lib/renamespace/directories.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Renamespace
+  module Directories
+    def self.create_directories_to_file(file_path)
+      FileUtils.mkdir_p(dir_for_file_path(file_path))
+    end
+
+    def self.dir_for_file_path(file_path)
+      file_path.sub(%r{/[^/]+$}, '')
+    end
+
+    def self.remove_empty_dirs
+      Dir['**/'].reverse_each { |d| Dir.rmdir(d) if Dir.empty?(d) }
+    end
+  end
+end

data/lib/renamespace/expand_relative_requires_in_file_content.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+require_relative 'directories'
+require_relative 'paths'
+
+class Renamespace
+  class ExpandRelativeRequiresInFileContent
+    def initialize(content:, path:)
+      @content = content
+      @path = path
+    end
+
+    def call
+      content
+        .gsub(/require_relative '([^']+)'/) do
+          "require '%s'" % expanded_require_path($1)
+        end
+    end
+
+    private
+
+    attr_reader :content, :path
+
+    def expanded_require_path(relative_require_path)
+      joined_path = File.join(require_dir, relative_require_path)
+      Pathname.new(joined_path).cleanpath
+    end
+
+    def require_dir
+      dir = Renamespace::Directories.dir_for_file_path(path)
+      Renamespace::Paths.require_for_path(dir)
+    end
+  end
+end

data/lib/renamespace/expand_relative_requires_within_all_files.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'expand_relative_requires_in_file_content'
+
+class Renamespace
+  class ExpandRelativeRequiresWithinAllFiles
+    def call
+      all_suitable_ruby_file_paths.each do |path|
+        content_orig = File.read(path)
+        content_new = expand_in_file(content_orig, path)
+        File.write(path, content_new) unless content_orig == content_new
+      end
+    end
+
+    private
+
+    def expand_in_file(content_orig, path)
+      Renamespace::ExpandRelativeRequiresInFileContent.new(content: content_orig, path: path).call
+    end
+
+    def all_suitable_ruby_file_paths
+      Renamespace::Paths.all_ruby_file_paths - exclusions
+    end
+
+    def exclusions
+      %w[
+        spec/spec_helper.rb
+        renamespace_spec.rb
+        lib/bootstrap.rb
+      ]
+    end
+  end
+end

data/lib/renamespace/move_and_renamespace_source_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'directories'
+require_relative 'renamespace_file_content'
+
+class Renamespace
+  class MoveAndRenamespaceSourceFile
+    def initialize(paths:, no_superclass_prefixing:)
+      @paths = paths
+      @no_superclass_prefixing = no_superclass_prefixing
+    end
+
+    def call
+      log_source_and_destination_namespaces
+      write_new_file
+      delete_old_file
+    end
+
+    private
+
+    attr_reader :paths, :no_superclass_prefixing
+
+    def log_source_and_destination_namespaces
+      puts '%s -> %s' % [paths.source_namespace, paths.destination_namespace]
+    end
+
+    def write_new_file
+      Renamespace::Directories.create_directories_to_file(paths.destination)
+      File.write(paths.destination, renamespaced_file_content)
+    end
+
+    def delete_old_file
+      File.delete(paths.source) unless paths.same?
+    end
+
+    def renamespaced_file_content
+      content = File.read(paths.source)
+      Renamespace::RenamespaceFileContent.new(
+        paths: paths,
+        no_superclass_prefixing: no_superclass_prefixing,
+      ).call(content)
+    end
+  end
+end

data/lib/renamespace/move_spec_file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'directories'
+
+class Renamespace
+  class MoveSpecFile
+    def initialize(paths:)
+      @paths = paths
+    end
+
+    def call
+      move unless missing? || paths.same?
+    end
+
+    private
+
+    attr_reader :paths
+
+    def move
+      Renamespace::Directories.create_directories_to_file(destination_spec_path)
+      FileUtils.mv(source_spec_path, destination_spec_path)
+    end
+
+    def warn_missing
+      puts Rainbow("Warning: spec file missing for #{destination_spec_path}").orange
+    end
+
+    def missing?
+      !(File.exist?(source_spec_path) || warn_missing)
+    end
+
+    def source_spec_path
+      spec_path(paths.source)
+    end
+
+    def destination_spec_path
+      spec_path(paths.destination)
+    end
+
+    def spec_path(path)
+      path
+        .sub('.rb', '_spec.rb')
+        .sub(/^lib/, specs_dir)
+    end
+
+    def specs_dir
+      Dir.exist?('spec/lib') ? 'spec/lib' : 'spec'
+    end
+  end
+end

data/lib/renamespace/paths.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Renamespace
+  Paths = Struct.new(:source, :destination, keyword_init: true) do
+    def self.namespace_for_path(path)
+      namespace_elements_for_path(path).join('::')
+    end
+
+    def self.require_for_path(path)
+      path_elements_for_require(path).join('/')
+    end
+
+    def self.namespace_elements_for_path(path)
+      path_elements_for_require(path)
+        .map(&method(:namespace_element_from_path_element))
+    end
+
+    def self.path_elements_for_require(path)
+      path.sub(%r{^lib/}, '').chomp('.rb').split('/')
+    end
+
+    def self.namespace_element_from_path_element(path_element)
+      custom_camelcasings.fetch(path_element) { path_element.upper_camelcase }
+    end
+
+    def self.custom_camelcasings
+      {
+        'greensync' => 'GreenSync',
+      }
+    end
+
+    def self.all_ruby_file_paths
+      (Dir.glob('**/*.rb') - %w[invert_namespaces.rb renamespace.rb])
+    end
+
+    def source_namespace
+      self.class.namespace_for_path(source)
+    end
+
+    def destination_namespace
+      self.class.namespace_for_path(destination)
+    end
+
+    def source_namespace_elements
+      self.class.namespace_elements_for_path(source)
+    end
+
+    def destination_namespace_elements
+      self.class.namespace_elements_for_path(destination)
+    end
+
+    def source_require_path
+      self.class.require_for_path(source)
+    end
+
+    def destination_require_path
+      self.class.require_for_path(destination)
+    end
+
+    def same?
+      source == destination
+    end
+  end
+end

data/lib/renamespace/rename_within_all_files.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'paths'
+require_relative 'rename_within_file_content'
+require_relative 'replacements_logger'
+
+class Renamespace
+  class RenameWithinAllFiles
+    def initialize(paths:, can_omit_prefixes_count:)
+      @paths = paths
+      @can_omit_prefixes_count = can_omit_prefixes_count
+    end
+
+    def call
+      Renamespace::Paths.all_ruby_file_paths.each do |path|
+        content_orig = File.read(path)
+        content_new = rename_within_file_content(content_orig)
+        File.write(path, content_new) unless content_orig == content_new
+      end
+    end
+
+    attr_reader :can_omit_prefixes_count
+
+    private
+
+    def rename_within_file_content(content)
+      Renamespace::RenameWithinFileContent.new(
+        paths: paths,
+        content: content,
+        replacements_logger: replacements_logger,
+        can_omit_prefixes_count: can_omit_prefixes_count,
+      ).call
+    end
+
+    def replacements_logger
+      @replacements_logger ||= Renamespace::ReplacementsLogger.new
+    end
+
+    attr_reader :paths
+  end
+end

data/lib/renamespace/rename_within_file_content.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'paths'
+
+class Renamespace
+  class RenameWithinFileContent
+    def initialize(paths:, content:, can_omit_prefixes_count:, replacements_logger:)
+      @paths = paths
+      @content_orig = content
+      @can_omit_prefixes_count = can_omit_prefixes_count
+      @replacements_logger = replacements_logger
+    end
+
+    def call
+      content_orig
+        .then(&method(:replace_require_paths))
+        .then(&method(:replace_references))
+    end
+
+    def replace_require_paths(content)
+      content.gsub(paths.source_require_path, paths.destination_require_path)
+    end
+
+    def replace_references(content)
+      (1 + can_omit_prefixes_count).times do
+        replacements_logger.log(search_str, replace_str)
+        content = content.gsub(search_str, replace_str)
+        namespace_elements_source.shift
+        namespace_elements_dest.shift
+      end
+      content
+    end
+
+    def search_str
+      namespace_elements_source.join('::')
+    end
+
+    def replace_str
+      namespace_elements_dest.join('::')
+    end
+
+    def namespace_elements_source
+      @namespace_elements_source ||= paths.source_namespace_elements
+    end
+
+    def namespace_elements_dest
+      @namespace_elements_dest ||= paths.destination_namespace_elements
+    end
+
+    private
+
+    attr_reader :paths, :content_orig, :can_omit_prefixes_count, :replacements_logger
+  end
+end

data/lib/renamespace/renamespace_file_content.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class Renamespace
+  class RenamespaceFileContent
+    def initialize(paths:, no_superclass_prefixing:)
+      @paths = paths
+      @no_superclass_prefixing = no_superclass_prefixing
+    end
+
+    def call(content) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      content = content.dup
+      source, dest = source_and_dest_namespace_elements_without_common_prefix
+      namespace_element_replacements = dest.reverse.zip(source.reverse)
+      namespace_element_replacements.each_with_index do |(namespace_element_new, namespace_element_old), i|
+        old_parent_namespace = namespace_element_replacements.last(i + 1).map(&:last).reverse.join('::')
+        old_parent_namespace += '::' unless old_parent_namespace.empty?
+        if namespace_element_old
+          # Replacing existing namespace
+          content.sub!(/(class|module) #{namespace_element_old}\b( < (\S+))?/) do
+            klass_line = "#{Regexp.last_match(1)} RENAMESPACED_#{namespace_element_new}"
+            Regexp.last_match(3)&.tap do |superclass_orig|
+              klass_line += ' < '
+              klass_line += old_parent_namespace unless superclass_orig.start_with?('::') || no_superclass_prefixing?
+              klass_line += superclass_orig
+            end
+            klass_line
+          end
+        else
+          # Adding new namespace
+          previous_new_namespace_element = namespace_element_replacements[i - 1].first
+          content.sub!(
+            /((class|module) RENAMESPACED_#{previous_new_namespace_element})/,
+            "module RENAMESPACED_#{namespace_element_new}; \\1",
+          )
+          content.sub!(/^(end)/, "\\1\nend")
+        end
+      end
+      content.gsub!('RENAMESPACED_', '')
+      content
+    end
+
+    private
+
+    attr_reader :paths
+
+    def source_and_dest_namespace_elements_without_common_prefix
+      source = paths.source_namespace_elements
+      dest = paths.destination_namespace_elements
+      source.each do
+        break if source.first != dest.first
+
+        source.shift
+        dest.shift
+      end
+      [source, dest]
+    end
+
+    def no_superclass_prefixing?
+      @no_superclass_prefixing
+    end
+  end
+end

data/lib/renamespace/replacements_logger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Renamespace
+  class ReplacementsLogger
+    def initialize
+      @logged_replacements = []
+    end
+
+    def log(search_str, replace_str)
+      return if logged_replacements.include?([search_str, replace_str])
+
+      logged_replacements << [search_str, replace_str]
+      puts Rainbow('%s -> %s' % [search_str, replace_str]).blue
+    end
+
+    private
+
+    attr_accessor :logged_replacements
+  end
+end

data/lib/renamespace/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Renamespace
+  VERSION = '0.1.5'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: renamespace
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Brendan Weibrecht
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description:
+email:
+- brendan@weibrecht.net.au
+executables:
+- renamespace
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/renamespace
+- lib/renamespace.rb
+- lib/renamespace/directories.rb
+- lib/renamespace/expand_relative_requires_in_file_content.rb
+- lib/renamespace/expand_relative_requires_within_all_files.rb
+- lib/renamespace/move_and_renamespace_source_file.rb
+- lib/renamespace/move_spec_file.rb
+- lib/renamespace/paths.rb
+- lib/renamespace/rename_within_all_files.rb
+- lib/renamespace/rename_within_file_content.rb
+- lib/renamespace/renamespace_file_content.rb
+- lib/renamespace/replacements_logger.rb
+- lib/renamespace/version.rb
+homepage: https://github.com/ZimbiX/renamespace
+licenses:
+- GPL-3.0
+metadata:
+  homepage_uri: https://github.com/ZimbiX/renamespace
+  source_code_uri: https://github.com/ZimbiX/renamespace
+  changelog_uri: https://github.com/ZimbiX/renamespace/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: A command-line tool to help Ruby developers refactor class/module namespacing
+test_files: []