rename_gem 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a21c5895ebd74b4eef18e8b97c4afba25be91187de1efda55b4a90fd9f1b8071
-  data.tar.gz: 43a4b99202463cbc76e5ff24169a41953c8c29630e09a01e4d7ff6f483e2a9bf
+  metadata.gz: 0d8afa9f2c90d25b3b98a7583336250643d30f4850dc2f851e330b94bfe1ed40
+  data.tar.gz: f5058a8d2c17a5664823669744382061852c8b3b43e82869d60a47a4733a48db
 SHA512:
-  metadata.gz: '01328de7d3bd8854c309c2141fa5639e10d874c85a161ef94abf6d201dc90195d0d79f6be5ccc0f522be969ba796c3a3429300f4c9b60ff95e860b80454b1e5a'
-  data.tar.gz: dc803ed935dcd48eed74264674a2904311f017cf7ef28a69d67f5782875871ac858be9aa759335e113dbd71fe97106d7000ec217ed30178f47c06918376648f9
+  metadata.gz: 3d43b5cc99b4d23e6c170e477c17667ab1aa3da442991f919ad0e7218194a7bf504243fb508a28c30726596f76eae96ba1febe7b83f6fc192b8bccfe1fb5589d
+  data.tar.gz: f52eacf8f1b0565bd732e712c594d56f944214f83845e2878b32d7729ea6b18a5890407f450c075eb8443a96a36df14b79e2098d2b948d3b9c2af8cdca44a917

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 hello_world -t foo_bar -p spec/fixtures/
+```
+
+## 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,21 @@
+# frozen_string_literal: true
+
+require 'rename_gem/renamer/runner'
+require 'rename_gem/renamer/entity'
+require 'rename_gem/renamer/path'
+require 'rename_gem/renamer/file_handler'
+require 'rename_gem/renamer/directory_handler'
+require 'rename_gem/renamer/modifier'
+require 'rename_gem/renamer/possession'
+require 'rename_gem/renamer/string_replacer'
+
+module RenameGem
+  module Renamer
+    def self.run(options)
+      path = Pathname.new(Dir.pwd).join(options[:path]).to_s
+      entity = Entity.new(path, nil)
+      runner = RenameGem::Renamer::Runner.new(options[:from], options[:to])
+      runner.run(entity)
+    end
+  end
+end

data/lib/rename_gem/renamer/directory_handler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class DirectoryHandler
+      attr_reader :name, :new_name
+
+      def initialize(name, new_name)
+        @name = name
+        @new_name = new_name
+      end
+
+      def recurse!(directory)
+        directory.files.each { |file| file.change(name).to(new_name) }
+
+        directory.directories.each do |sub_directory|
+          sub_directory.change(name).to(new_name)
+
+          recurse!(sub_directory)
+        end
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/entity.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Entity
+      ChainError = Class.new(StandardError)
+
+      attr_reader :path, :file_handler, :modifier
+
+      def initialize(path, file_handler)
+        @path = Path.new(path)
+        @file_handler = file_handler
+        @modifier = Modifier.new
+      end
+
+      def change(from)
+        modifier.from = from
+
+        self
+      end
+
+      def to(to)
+        modifier.to = to
+
+        validate_chaining
+
+        rename
+      end
+
+      def directories
+        path.directories.map do |directory_path|
+          self.class.new(directory_path.to_s, nil)
+        end
+      end
+
+      def files
+        path.files.map do |file_path|
+          self.class.new(file_path.to_s, FileHandler.new(file_path))
+        end
+      end
+
+      private
+
+      def rename
+        new_path = path.build(modifier.replacement(path.filename)).to_s
+
+        unless path.to_s == new_path
+          file_handler.change(modifier) if path.file?
+
+          path.rename(new_path)
+          puts "rename #{path} to #{new_path}"
+
+          modifier = Modifier.new
+        end
+      rescue Modifier::ReplacementNotFound => e
+        puts "ignoring #{e.message}"
+      end
+
+      def validate_chaining
+        raise ChainError, "Usage: object.change('x').to('y')" unless modifier.valid?
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/file_handler.rb

@@ -0,0 +1,35 @@
+# 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 change(modifier)
+        temp_file = Tempfile.new(path.filename)
+
+        file.each_line do |line|
+          temp_file.puts modifier.replacement(line)
+        rescue Modifier::ReplacementNotFound
+          temp_file.puts line
+        end
+
+        temp_file.close
+        FileUtils.mv(temp_file.path, path.to_s) if modifier.times_replaced.positive?
+        temp_file.unlink
+
+        possession.update(file)
+
+        puts "#{modifier.times_replaced} lines changed in #{path}"
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/modifier.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Modifier
+      ReplacementNotFound = Class.new(StandardError)
+
+      attr_accessor :from, :to
+      attr_reader :times_replaced
+
+      def initialize(from = nil, to = nil)
+        @from = from
+        @to = to
+        @times_replaced = 0
+      end
+
+      def valid?
+        return false if from.nil? || to.nil?
+
+        true
+      end
+
+      def replacement(string)
+        replacer = StringReplacer.new(string)
+        content = replacer.replace(from).with(to)
+        @times_replaced += 1
+
+        content
+      rescue StringReplacer::NoMatchError => e
+        raise ReplacementNotFound, e.message
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/path.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Path
+      RenameError = Class.new(StandardError)
+
+      def initialize(path)
+        @pathname = Pathname.new(path)
+      end
+
+      def to_s
+        @pathname.to_s
+      end
+
+      def filename
+        @pathname.basename.to_s
+      end
+
+      def build(new_path)
+        self.class.new(dirname.join(new_path))
+      end
+
+      def directories
+        @pathname.children.select(&:directory?).map do |pathname|
+          self.class.new(pathname.to_s)
+        end
+      end
+
+      def files
+        @pathname.children.select(&:file?).map do |pathname|
+          self.class.new(pathname.to_s)
+        end
+      end
+
+      def rename(new_path)
+        if file?
+          File.rename(to_s, new_path)
+        elsif directory?
+          FileUtils.mv(to_s, new_path)
+        else
+          raise RenameError, "#{self} must be a file or a directory"
+        end
+
+        @pathname = Pathname.new(new_path)
+      end
+
+      def file?
+        @pathname.file?
+      end
+
+      def directory?
+        @pathname.directory?
+      end
+
+      private
+
+      def dirname
+        @pathname.dirname
+      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/runner.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class Runner
+      attr_reader :name, :new_name
+
+      def initialize(name, new_name)
+        @name = name
+        @new_name = new_name
+      end
+
+      def run(entity)
+        if entity.path.file?
+          file = Entity.new(entity.to_s, FileHandler.new(entity.path))
+          file.change(name).to(new_name)
+          return
+        end
+
+        DirectoryHandler.new(name, new_name).recurse!(entity)
+      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.0.5'
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: rename_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Rónán Duddy
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
@@ -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/directory_handler.rb
+- lib/rename_gem/renamer/entity.rb
+- lib/rename_gem/renamer/file_handler.rb
+- lib/rename_gem/renamer/modifier.rb
+- lib/rename_gem/renamer/path.rb
+- lib/rename_gem/renamer/possession.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