rename_gem 0.0.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21c5895ebd74b4eef18e8b97c4afba25be91187de1efda55b4a90fd9f1b8071
-  data.tar.gz: 43a4b99202463cbc76e5ff24169a41953c8c29630e09a01e4d7ff6f483e2a9bf
+  metadata.gz: '0109bc475b09108b0483e11ecd1f516b8e3f16fd8460dcabdf879f2f67fce7e7'
+  data.tar.gz: 4f605e4c61a0d66cec240067fbe9d9edc7ffa72a7b4b0425438398c07ee17102
 SHA512:
-  metadata.gz: '01328de7d3bd8854c309c2141fa5639e10d874c85a161ef94abf6d201dc90195d0d79f6be5ccc0f522be969ba796c3a3429300f4c9b60ff95e860b80454b1e5a'
-  data.tar.gz: dc803ed935dcd48eed74264674a2904311f017cf7ef28a69d67f5782875871ac858be9aa759335e113dbd71fe97106d7000ec217ed30178f47c06918376648f9
+  metadata.gz: a75d6b664d64edda37b0aa02e6ba07f2f6b7da522fd29b82626c07178b6d7f2ca388d8c5ae4791e9ac7fd7537f07c807c7b97a451e549e65de329a7a7cbbe37d
+  data.tar.gz: e1ffced29709254c4f90220170b501e3c7823e541aea396913c45550c0ef1dd94635d7939e29c491679c08fc2d18b9be5f8e44120c79fa43edf1f6bf3534c999

data/README.md

@@ -0,0 +1,43 @@
+# Rename Gem
+
+This Ruby Gem is a work in progress, its goal is to be able to rename gems.
+
+[![Build Status](https://travis-ci.org/ronanduddy/Ruby-Gem-Renamer.svg?branch=master)](https://travis-ci.org/ronanduddy/Ruby-Gem-Renamer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rename_gem'
+```
+
+And then execute:
+
+```Shell
+bundle install
+```
+
+Or install it yourself as:
+
+```Shell
+gem install rename_gem
+```
+
+## Usage
+
+```Shell
+bundle exec rename_gem rename -f project_name -t foo_bar -p project
+```
+
+## Development
+
+Run `make test` to run all the tests or `make guard` to use guard for testing. You can also run `make irb` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ronanduddy/Ruby-Gem-Renamer. Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

data/lib/rename_gem/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RenameGem
+  require 'thor'
+  require 'rename_gem/renamer'
+
+  class CLI < Thor
+    desc 'rename', 'rename all instances of FROMs to TO for a given file'
+    option :from, type: :string, aliases: '-f', required: true, desc: 'the original name'
+    option :to, type: :string, aliases: '-t', required: true, desc: 'the new name'
+    option :path, type: :string, aliases: '-p', required: true, desc: 'the path to run the renaming'
+    def rename
+      Renamer.run(options)
+    end
+  end
+end

data/lib/rename_gem/renamer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rename_gem/renamer/context'
+require 'rename_gem/renamer/directory_handler'
+require 'rename_gem/renamer/file_handler'
+require 'rename_gem/renamer/path'
+require 'rename_gem/renamer/possession'
+require 'rename_gem/renamer/reporter'
+require 'rename_gem/renamer/runner'
+require 'rename_gem/renamer/string_replacer'
+
+module RenameGem
+  module Renamer
+    def self.run(options)
+      Runner.new(options).run
+    end
+  end
+end

data/lib/rename_gem/renamer/context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Context
+      attr_reader :from, :to, :pwd, :path
+
+      def initialize(pwd, path, from, to)
+        @pwd = pwd
+        @path = path
+        @from = from
+        @to = to
+      end
+
+      def using(new_path)
+        self.class.new(pwd, new_path, from, to)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/directory_handler.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class DirectoryHandler
+      attr_reader :context, :path, :results
+
+      def initialize(context)
+        @context = context
+        @path = Path.new(context.path, context.pwd)
+        @results = []
+      end
+
+      def change_files
+        path.files.each do |pathname|
+          file_handler = FileHandler.new(pathname)
+          results << "Edit #{pathname.path}" if file_handler.edit(context.from, context.to)
+          results << "Rename #{pathname.path} -> #{file_handler.path.filename}" if file_handler.rename(context.from,
+                                                                                                       context.to)
+        end
+      end
+
+      def rename
+        built_path = path.build(replacement(path.filename))
+
+        FileUtils.mv(path.to_s, built_path.to_s)
+
+        results << "Rename #{path.path} -> #{built_path.filename}"
+        @path = built_path
+
+        true
+      rescue StringReplacer::NoMatchError
+        false
+      end
+
+      def directories
+        path.directories.map do |directory_path|
+          self.class.new(context.using(directory_path.path))
+        end
+      end
+
+      private
+
+      def replacement(text)
+        replacer = StringReplacer.new(text)
+        replacer.replace(context.from).with(context.to)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/file_handler.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    require 'tempfile'
+
+    class FileHandler
+      attr_reader :path, :file, :possession
+
+      def initialize(path)
+        @path = path
+        @file = File.new(path.to_s)
+        @possession = Possession.new(file)
+      end
+
+      def edit(from, to)
+        temp_file = Tempfile.new(path.filename)
+        changes = false
+
+        file.each_line do |line|
+          temp_file.puts replacement(line, from, to)
+
+          changes = true
+        rescue StringReplacer::NoMatchError
+          temp_file.puts line
+        end
+
+        temp_file.close
+
+        if changes
+          FileUtils.mv(temp_file.path, path.to_s)
+          possession.update(file)
+        end
+
+        temp_file.unlink
+
+        changes
+      end
+
+      def rename(from, to)
+        new_filename = replacement(path.filename, from, to)
+        built_path = path.build(new_filename)
+
+        File.rename(path.to_s, built_path.to_s)
+        @path = built_path
+
+        true
+      rescue StringReplacer::NoMatchError
+        false
+      end
+
+      private
+
+      def replacement(text, from, to)
+        replacer = StringReplacer.new(text)
+        replacer.replace(from).with(to)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/path.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    require 'pathname'
+
+    class Path
+      attr_reader :path, :pwd
+
+      def initialize(path, pwd)
+        @path = Pathname.new(path)
+        @pwd = Pathname.new(pwd)
+      end
+
+      def to_s
+        absolute_path.to_s
+      end
+
+      def filename
+        absolute_path.basename.to_s
+      end
+
+      def build(new_path)
+        pathname = path.dirname.join(new_path)
+        self.class.new(pathname, pwd)
+      end
+
+      def directories
+        absolute_path.children.select(&:directory?).sort.map do |pathname|
+          self.class.new(relative_path(pathname), pwd)
+        end
+      end
+
+      def files
+        absolute_path.children.select(&:file?).sort.map do |pathname|
+          self.class.new(relative_path(pathname), pwd)
+        end
+      end
+
+      def file?
+        absolute_path.file?
+      end
+
+      def directory?
+        absolute_path.directory?
+      end
+
+      private
+
+      def absolute_path
+        pwd.join(path)
+      end
+
+      def relative_path(pathname)
+        pathname.relative_path_from(pwd)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/possession.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Possession
+      attr_reader :mode, :uid, :gid
+
+      def initialize(file)
+        @mode = file.stat.mode
+        @uid = file.stat.uid
+        @gid = file.stat.gid
+      end
+
+      def update(file)
+        file.chmod(mode)
+        file.chown(uid, gid)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/reporter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Reporter
+      attr_reader :results
+
+      def initialize
+        @results = []
+      end
+
+      def <<(list)
+        results << list
+      end
+
+      def print
+        results.empty? ? puts('No results, nothing edited or renamed') : puts(results.flatten)
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/runner.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Runner
+      EXCLUDED_DIRS = ['.git'].freeze
+
+      attr_reader :options, :reporter, :context
+
+      def initialize(options)
+        @options = options
+        @reporter = Reporter.new
+        @context = Context.new(Dir.pwd, options[:path], options[:from], options[:to])
+      end
+
+      def run
+        directory = DirectoryHandler.new(context)
+        recurse!(directory)
+
+        reporter.print
+      end
+
+      private
+
+      def recurse!(directory)
+        directory.change_files unless excluded_directory?(directory.path)
+
+        directory.directories.each do |sub_directory|
+          recurse!(sub_directory)
+
+          sub_directory.rename unless excluded_directory?(sub_directory.path)
+        end
+
+        reporter << directory.results
+      end
+
+      def excluded_directory?(path)
+        EXCLUDED_DIRS.include? path.filename
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/string_replacer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class StringReplacer
+      ChainError = Class.new(StandardError)
+      NoMatchError = Class.new(StandardError)
+
+      attr_reader :content, :target
+
+      def initialize(content)
+        @content = content
+      end
+
+      def replace(target)
+        @target = target
+
+        self
+      end
+
+      def with(replacement)
+        raise ChainError, "Usage: replacer.replace('x').with('y')" if target.nil? || replacement.nil?
+        raise NoMatchError, "#{target} not found in #{content}" unless exists?(target)
+
+        content.gsub(target, replacement).gsub(pascal_case(target), pascal_case(replacement))
+      end
+
+      private
+
+      def exists?(target)
+        content.include?(target) || content.include?(pascal_case(target))
+      end
+
+      def pascal_case(snake_case)
+        snake_case.split('_').map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/rename_gem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RenameGem
+  VERSION = '0.3.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rename_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.3.1
 platform: ruby
 authors:
 - Rónán Duddy
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2020-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -188,14 +188,28 @@ dependencies:
         version: '1.9'
 description: Have a hard time renaming Gems, find it annoying? Hopefully this should
   help!
-email: []
+email:
+- dev@ronanduddy.xyz
 executables:
 - rename_gem
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- bin/rename_gem
+- README.md
+- exe/rename_gem
 - lib/rename_gem.rb
+- lib/rename_gem/cli.rb
+- lib/rename_gem/renamer.rb
+- lib/rename_gem/renamer/context.rb
+- lib/rename_gem/renamer/directory_handler.rb
+- lib/rename_gem/renamer/file_handler.rb
+- lib/rename_gem/renamer/path.rb
+- lib/rename_gem/renamer/possession.rb
+- lib/rename_gem/renamer/reporter.rb
+- lib/rename_gem/renamer/runner.rb
+- lib/rename_gem/renamer/string_replacer.rb
+- lib/rename_gem/version.rb
 homepage: https://github.com/ronanduddy/Ruby-Gem-Renamer
 licenses:
 - MIT