bulldoze_renamer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 810a46d0c33d974031e0ec0aad18faa747f24bbc1b64d759103ac2c46987d7d1
+  data.tar.gz: f97652392e76b61b2f4b2ef228ec141cddc12c36209b120c5c3a31baf82d0916
+SHA512:
+  metadata.gz: b0d7863a26ffeb3293c4612dee705fedaef80cd65a89c5a69be0d71600fff259545e5d2906ae4c8c35695165b4a38b22b01ccaf0dc0342750a6dbc9e22167a78
+  data.tar.gz: b062a5af199faae684d5908a4d2313b096b74f03a1e8752b3342996e596994db4f6ec00c972f4146d312120986429a7e5b08ef98d394b464b866416be17215a9

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [tomtt]
+patreon: tomtt

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+dummy

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bulldoze_renamer.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "simplecov"
+gem "pry-byebug"
+gem "guard-rspec"
+gem "webmock"
+gem "sinatra"

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'rspec', failed_mode: :keep do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/support/(.+)\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,85 @@
+# Bulldoze Renamer
+
+Bulldoze Renamer is a tool to rename things in a code project.
+
+Suppose you have an object that you called PoohBear but you want to now rename it to HoneyBear.
+
+That means that everywhere in your project you want to replace `PoohBear -> HoneyBear`.
+But also `pooh_bear -> honey_bear`. Any there may be some constant `POOH_BEAR_ACTIONS ->
+HONEY_BEAR_ACTIONS` somewhere. And maybe the class is defined in `lib/bears/pooh_bear/pooh_bear.rb`
+and so that file should be renamed `lib/bears/pooh_bear -> lib/bears/honey_bear` and
+`lib/bears/pooh_bear/pooh_bear.rb -> lib/bears/honey_bear/honey_bear.rb`.
+
+This tool aims to do all those replacements for you in the entire project in one go.
+
+## Installation
+
+Install by installing the gem:
+
+    $ gem install bulldoze_renamer
+
+## Usage
+
+It runs like so: `bulldoze_rename target_directory PoohBear HoneyBear`
+
+It will only check files that are known to the git repo of the target_directory.
+
+Invoked like this it will only show an overview of the changes that will take place.
+The output looks like this:
+
+    underscore : pooh_bear -> honey_bear
+    camelize   : PoohBear  -> HoneyBear
+    dasherize  : pooh-bear -> honey-bear
+    upcase     : POOH_BEAR -> HONEY_BEAR
+    js_camelize: poohBear  -> honeyBear
+
+    camelize
+      | upcase
+      |   | filename
+      |   |   |
+      _   _   1 lib/bears/pooh_bear
+      1   1   1 lib/bears/pooh_bear/pooh_bear.rb
+
+The first section shows the possible mappings it looks for in the target_directory.
+The section below that shows which of those actually occur in which files. Files
+that will need to be renamed also have a value for `filename`.
+
+To actually perform the substitutions, add the `-p` option to the earlier command.
+Then it will print out the filenames as they are being updated. That looks like
+this:
+
+    Performing:
+    R lib/bears/pooh_bear/pooh_bear.rb -> lib/bears/pooh_bear/honey_bear.rb
+    d lib/bears/pooh_bear -> lib/bears/honey_bear
+
+Where the first character denotes:
+- f: substituted value in file
+- r: only renamed the file
+- R: renamed file and substituted values in it
+- d: directory which was moved
+
+### Warning
+
+As suggested by the name `bulldozer`, this tool is rather crude. Undesirable things
+can happen, especially if it is not clear from the original value or target value
+what type of format it should be.
+
+For example for `pooh_bear` it is clear that it is in underscore format, but if it
+were just `pooh` it could also be in js_camelize format.
+
+Therefore there should be no issue if both original and new values have multiple words.
+When replacing a single word with another single word, there should also be no issue.
+
+But when you replace single word with multiple words it will be ambiguous which format to
+use.
+
+When you replace multiple words with a single word, that will work fine, but afterwards
+renaming it again may be problematic.
+
+Always ensure by checking changes in git that they are all correct.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bulldoze_renamer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bulldoze_renamer.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/bulldoze_renamer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bulldoze_renamer"
+  spec.version       = BulldozeRenamer::VERSION
+  spec.authors       = ["Tom ten Thij"]
+  spec.email         = ["code@tomtenthij.nl"]
+
+  spec.summary       = %q{A gem environment to learn code in}
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency('activesupport', '>= 6')
+  spec.add_dependency('ruby-filemagic', '~> 0.7.2')
+end

data/exe/bulldoze_rename

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+PROJECT_PATH="$( cd "$(dirname "$0")/.." >/dev/null 2>&1 ; pwd -P )"
+
+BUNDLE_GEMFILE=$PROJECT_PATH/Gemfile $PROJECT_PATH/exe/bulldoze_rename_rb $*

data/exe/bulldoze_rename_rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env bundle exec ruby
+# This script can only be run from elsewhere if BUNDLE_GEMFILE of this project
+# has been set.
+
+require 'bulldoze_renamer'
+BulldozeRenamer::Shell.start(ARGV)

data/lib/bulldoze_renamer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Encoding.default_external = 'UTF-8'
+
+require "bulldoze_renamer/version"
+
+module BulldozeRenamer
+  class LinesNotFoundError < IOError; end
+
+  def self.root
+    Pathname.new(File.absolute_path(File.join(File.dirname(__FILE__), '..')))
+  end
+
+  autoload :FileContentSubstitutor , 'bulldoze_renamer/file_content_substitutor'
+  autoload :FileFinder , 'bulldoze_renamer/file_finder'
+  autoload :RenamingOrchestrator , 'bulldoze_renamer/renaming_orchestrator'
+  autoload :Shell , 'bulldoze_renamer/shell'
+  autoload :StringInflector , 'bulldoze_renamer/string_inflector'
+end

data/lib/bulldoze_renamer/file_content_substitutor.rb

@@ -0,0 +1,46 @@
+require 'tmpdir'
+require 'fileutils'
+
+module BulldozeRenamer
+  class FileContentSubstitutor
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def full_path(path)
+      File.join(@dir, path)
+    end
+
+    def with_content_written_to_temporary_file(original_path, content)
+      Dir.mktmpdir do |dir|
+        filename = File.join(dir, 'replaced_content')
+
+        # First copy original file to preserve permissions, even though we will overwrite
+        FileUtils.cp_r(File.join(@dir, original_path), filename, preserve: true)
+
+        File.open(filename, 'w') do |f|
+          f.print content
+        end
+        yield(filename)
+      end
+    end
+
+    def move_directory(original_path, new_path)
+      FileUtils.mv(full_path(original_path), full_path(new_path))
+    end
+
+    def substitute_in(original_path, new_path, mappings)
+      content = File.read(full_path(original_path))
+      mappings.each do |m|
+        content.gsub!(m[0], m[1])
+      end
+
+      with_content_written_to_temporary_file(original_path, content) do |f|
+        FileUtils.cp_r(f, full_path(new_path), preserve: true)
+        if new_path != original_path
+          FileUtils.rm(full_path(original_path))
+        end
+      end
+    end
+  end
+end

data/lib/bulldoze_renamer/file_finder.rb

@@ -0,0 +1,60 @@
+require 'find'
+require 'filemagic'
+
+module BulldozeRenamer
+  class FileFinder
+    def self.file_magic
+      @@file_magic ||= FileMagic.new
+    end
+
+    def self.file_excluded?(file)
+      file.include?(".git/") ||
+      file.include?("node_modules") ||
+      File.basename(file) == '.git' ||
+      file == '.'
+    end
+
+    def self.file_considered?(file)
+      return true if FileTest.directory?(file)
+
+      fm = file_magic.file(file)
+      fm.include?('text') ||
+      fm.include?('JSON')
+    end
+
+    # Using git ls-files has many advantages but it does not
+    # return directories. This method extracts all directories
+    # as present for the files found.
+    def self.extract_directories(files)
+      result = Set.new
+      files.each do |f|
+        dir = File.dirname(f)
+
+        # File.dirname('foo') => "."
+        # File.dirname('/foo') => "/"
+        while(dir != '.' && dir != '/' && !result.include?(dir))
+          result << dir
+          dir = File.dirname(dir)
+        end
+      end
+      result.to_a.sort
+    end
+
+    def self.find(path)
+      files = []
+      Dir.chdir(path) do
+        files = `git ls-files`.split
+        files = (files + extract_directories(files)).sort
+
+        if block_given?
+          files.select { |f| yield(f) }
+        else
+          files.select do |p|
+            !file_excluded?(p) &&
+            file_considered?(p)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bulldoze_renamer/renaming_orchestrator.rb

@@ -0,0 +1,190 @@
+require 'pp'
+
+module BulldozeRenamer
+  class RenamingOrchestrator
+    def initialize(path:, current_name:, target_name:, perform: nil)
+      @path = path
+      @current_name = current_name
+      @target_name = target_name
+      @perform = perform
+    end
+
+    def count_in_content(target, content)
+      ('~' + content + '~').split(target).size - 1
+    end
+
+    def find_occurences(file, mappings)
+      result = {}
+      Dir.chdir @path do
+        occurs_in_filename =
+        mappings[:inflections][:underscore] &&
+        File.basename(file).include?(mappings[:inflections][:underscore][:current])
+        occurs_in_filename ||=
+        mappings[:inflections][:dasherize] &&
+        File.basename(file).include?(mappings[:inflections][:dasherize][:current])
+        result[:filename] = occurs_in_filename ? 1 : 0
+
+        unless FileTest.directory?(file)
+          mappings[:inflections].each do |inflection, values|
+            result[inflection] = count_in_content(values[:current], File.read(file))
+          end
+        end
+      end
+      result
+    end
+
+    def was_found(occ)
+      occ.values.sum > 0
+    end
+
+    def format_number(number)
+      number && number > 0 ? "%4d" % number : '   _'
+    end
+
+    def inflections_mapping
+      @inflections_mapping ||= StringInflector.new(@current_name, @target_name).mappings
+    end
+
+    def files
+      @files ||= FileFinder.find(@path)
+    end
+
+    def file_occurences
+      return @file_occurences if @file_occurences
+
+      result = {}
+
+      files.each do |file|
+        result[file] = find_occurences(file, inflections_mapping)
+      end
+
+      @file_occurences = result
+    end
+
+    def inflections_that_are_present
+      @inflections_that_are_present ||=
+        StringInflector.inflections + [:filename] &
+        file_occurences.values.inject({}) { |a,h| h.each { |k,v| v > 0 && (a[k] ||= 0 ; a[k] += v) };a }.keys
+    end
+
+    def report_header_file_occurences
+      result = ""
+      inflections_that_are_present.each_with_index do |inflection, index|
+        result += ("   |" * index + ' ' + inflection.to_s + "\n")[1..-1]
+      end
+      result += ("   |" * inflections_that_are_present.size + "\n")[1..-1]
+      result
+    end
+
+    def report_file_occurences_line(file)
+      result = ""
+      inflections_that_are_present.each_with_index do |inflection, index|
+        result += format_number(file_occurences[file][inflection])
+      end
+      result + ' ' + file + "\n"
+    end
+
+    def files_that_have_occurences
+      files.select { |f| was_found(file_occurences[f]) }
+    end
+
+    def report_file_occurences
+      result = ""
+      files_that_have_occurences.each do |f|
+        result += report_file_occurences_line(f)[1..-1]
+      end
+      result
+    end
+
+    def report_inflections_mapping
+      longest_current = inflections_mapping[:inflections].values.map { |v| v[:current].size }.max
+
+      result = ""
+      inflections_mapping[:inflections].each do |i, v|
+        result += "%-11s: %-#{longest_current}s -> %s\n" % [i, v[:current], v[:target]]
+      end
+      result + "\n"
+    end
+
+    def reports_for_files
+      report_header_file_occurences +
+      report_file_occurences
+    end
+
+    def new_filename_for(filename)
+      dirname = File.dirname(filename)
+      basename = File.basename(filename)
+      inflections_mapping[:inflections].each do |m, v|
+        if basename.include?(v[:current])
+          return File.join(dirname, basename.gsub(v[:current], v[:target]))
+        end
+      end
+      filename
+    end
+
+    def perform_directory!(dirname, out)
+      new_dirname = new_filename_for(dirname)
+      out.puts "d #{dirname} -> #{new_dirname}"
+      FileContentSubstitutor.new(@path).move_directory(dirname, new_dirname)
+    end
+
+    def perform_file!(filename, occurences, out)
+       new_filename = if occurences[:filename] > 0
+         x = new_filename_for(filename)
+         mode = 'r'
+         unless occurences.select { |k,v| k != :filename && v > 0 }.empty?
+           mode = 'R'
+         end
+
+         out.puts "#{mode} #{filename} -> #{x}"
+         x
+       else
+         out.puts "f #{filename}"
+         filename
+       end
+
+       present_mappings = occurences.select { |k,v| k != :filename && v > 0 }
+       mappings = present_mappings.map do |m,c|
+         inflections_mapping[:inflections][m].values
+       end
+
+       FileContentSubstitutor.new(@path).
+       substitute_in(filename, new_filename, mappings)
+    end
+
+    def perform!(out:)
+      out.puts "Performing:"
+      directories = []
+      files_that_have_occurences.each do |filename|
+        occurences = file_occurences[filename]
+        if FileTest.directory?(File.join(@path, filename))
+          directories << filename
+        else
+          perform_file!(filename, occurences, out)
+        end
+      end
+
+      directories.reverse.each do |dir|
+        perform_directory!(dir, out)
+      end
+
+    end
+
+    def self.rename_with_options(options, out:, err:)
+      orch = RenamingOrchestrator.new(options)
+      out.puts orch.report_inflections_mapping
+
+      if orch.files_that_have_occurences.empty?
+        out.puts "'#{options[:current_name]}' can not be found in any of the files in '#{options[:path]}'"
+      else
+        out.puts orch.reports_for_files
+        if options[:perform]
+          puts
+          orch.perform!(out: out)
+        else
+          out.puts "\nThis is an overview of changes that would be made\nRun same command with -p option to perform"
+        end
+      end
+    end
+  end
+end

data/lib/bulldoze_renamer/shell.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+
+module BulldozeRenamer
+  class Shell
+    BANNER = <<"EOT"
+usage: #{$0} path CurrentNameInCamelCase TargetName
+
+Will do a crude renaming of everything in the current directory. It
+uses `git ls-files` to find the files so only things checked into
+git are subject to change.
+
+This script is still potentially dangerous, use with caution.
+
+By default only an overview is shown of what changes will be made
+in what files. To actually perform those changes, pass the '-p'
+option.
+EOT
+
+    def self.usage(err: STDERR)
+      err.puts BANNER
+      exit 1
+    end
+
+    def self.start(argv, out: STDOUT, err: STDERR)
+      options = {
+        current_name: nil,
+        target_name: nil,
+        perform: false
+      }
+
+      OptionParser.new do |parser|
+        parser.banner = BANNER
+
+        parser.on("-p", "--perform", "Perform the substitutions on the files") do |perform|
+          options[:perform] = perform
+        end
+      end.parse! argv
+
+      unless argv.size == 3
+        self.usage(err: err)
+      end
+
+      options[:path] = argv[0]
+      options[:current_name] = argv[1]
+      options[:target_name] = argv[2]
+
+      RenamingOrchestrator.rename_with_options(options, out: out, err: err)
+    end
+  end
+end

data/lib/bulldoze_renamer/string_inflector.rb

@@ -0,0 +1,81 @@
+require "active_support"
+require "forwardable"
+
+module BulldozeRenamer
+  class StringInflector
+    class StringDoesNotInflectToItselfError < ArgumentError; end
+
+    extend Forwardable
+
+    def self.active_support_inflections
+      [:underscore, :camelize]
+    end
+
+    def self.inflections
+      active_support_inflections + [:dasherize, :upcase, :js_camelize]
+    end
+
+    def_delegators ActiveSupport::Inflector, *StringInflector.active_support_inflections
+
+    def initialize(current, target)
+      @current = current
+      @target = target
+    end
+
+    def upcase(w)
+      underscore(w).upcase
+    end
+
+    def dasherize(w)
+      ActiveSupport::Inflector.dasherize(underscore(w))
+    end
+
+    def js_camelize(w)
+      c = camelize(w).dup
+      c[0] = c[0].downcase
+      c
+    end
+
+    def mappings
+      result = {
+        current_inflection: nil,
+        target_inflection: nil,
+        inflections: {}
+      }
+      StringInflector.inflections.each do |i|
+        unless result[:current_inflection]
+          if @current == send(i, @current)
+            result[:current_inflection] = i
+          end
+        end
+
+        unless result[:target_inflection]
+          if @target == send(i, @target)
+            result[:target_inflection] = i
+          end
+        end
+
+        mapping = {
+          current: send(i, @current),
+          target: send(i, @target)
+        }
+
+        unless result[:inflections].
+          values.
+          map { |i| i[:current] }.
+          include?(mapping[:current])
+          result[:inflections][i] = mapping
+        end
+      end
+
+      unless result[:current_inflection]
+        raise StringDoesNotInflectToItselfError.new(@current)
+      end
+
+      unless result[:target_inflection]
+        raise StringDoesNotInflectToItselfError.new(@target)
+      end
+      result
+    end
+  end
+end

data/lib/bulldoze_renamer/version.rb

@@ -0,0 +1,3 @@
+module BulldozeRenamer
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: bulldoze_renamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom ten Thij
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+description:
+email:
+- code@tomtenthij.nl
+executables:
+- bulldoze_rename
+- bulldoze_rename_rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bulldoze_renamer.gemspec
+- exe/bulldoze_rename
+- exe/bulldoze_rename_rb
+- lib/bulldoze_renamer.rb
+- lib/bulldoze_renamer/file_content_substitutor.rb
+- lib/bulldoze_renamer/file_finder.rb
+- lib/bulldoze_renamer/renaming_orchestrator.rb
+- lib/bulldoze_renamer/shell.rb
+- lib/bulldoze_renamer/string_inflector.rb
+- lib/bulldoze_renamer/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A gem environment to learn code in
+test_files: []