rename_gem 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb56e690b1f73635ebedd262913cbcc537ed65002444943f037db4bdbf853b93
-  data.tar.gz: db1dea49877e57cb3b84c2a604a036a535c97a2d9901366e2486172addb12484
+  metadata.gz: d94c4504bc60d9df94db95f491c1c305504b62ccdbe81b855d7e5239423a41a8
+  data.tar.gz: 2aaaab3e85bb4fd5be9a83d91dced99f44f2b2deb418ad4bb87944c3ca5f8efe
 SHA512:
-  metadata.gz: 7d4bba51b8f0b8ba519ab8c7ea340e072531d7df11b12246990f774de4632fb8ccd9147a74798fc882cb7b1bd34c1dfadc5ad42aca2b216f11131e4e267a6c28
-  data.tar.gz: aa4df0369ff656cfacf26153c51d800077843dfe98d27332201df0814b6b93bf7c5472c88893b621df198f39c2f637570b180a61c1ff60288923d022b085466d
+  metadata.gz: 31827b02f7039de9904e09b0414956184e5854a36e194354478fb14eba3701cc1da6a2efd812270b5533e1cc9c1f7171a22e84c435c7a396daf92db52dad26f2
+  data.tar.gz: b3066e038a12fcf962418c29b43c4960aac1d37342bfdfd57433f7c2e78910788c625ec60d998eaf998fdc0fc78256cd017265636a9df317f29cca3be70f3419

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.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rename_gem/renamer'
+require 'rename_gem/cli'
+
+# Base/top module
+module RenameGem
+end

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,22 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rename_gem/renamer/directory_handler'
+require 'rename_gem/renamer/entity'
+require 'rename_gem/renamer/file_handler'
+require 'rename_gem/renamer/modifier'
+require 'rename_gem/renamer/path'
+require 'rename_gem/renamer/possession'
+require 'rename_gem/renamer/runner'
+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,32 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    class DirectoryHandler
+      EXCLUDED_DIRS = ['.git'].freeze
+
+      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) unless excluded_directory?(sub_directory)
+        end
+      end
+
+      private
+
+      def excluded_directory?(dir)
+        EXCLUDED_DIRS.include? dir.path.filename
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/entity.rb

@@ -0,0 +1,60 @@
+# 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
+
+        file_handler.change(modifier) if path.file?
+        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
+
+        path.rename(new_path)
+
+        modifier = Modifier.new
+      rescue Modifier::ReplacementNotFound => e
+        # nothing
+      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,39 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    require 'tempfile'
+
+    class FileHandler
+      attr_reader :path, :file, :possession, :changes
+
+      def initialize(path)
+        @path = path
+        @file = File.new(path.to_s)
+        @possession = Possession.new(file)
+        @changes = false
+      end
+
+      def change(modifier)
+        temp_file = Tempfile.new(path.filename)
+
+        file.each_line do |line|
+          temp_file.puts modifier.replacement(line)
+          @changes = true
+        rescue Modifier::ReplacementNotFound
+          temp_file.puts line
+        end
+
+        temp_file.close
+
+        if @changes
+          FileUtils.mv(temp_file.path, path.to_s)
+          possession.update(file)
+          puts "Edit #{path}"
+        end
+
+        temp_file.unlink
+      end
+    end
+  end
+end

data/lib/rename_gem/renamer/modifier.rb

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

data/lib/rename_gem/renamer/path.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RenameGem
+  module Renamer
+    require 'pathname'
+
+    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
+
+        puts "Rename #{self} -> #{self.class.new(new_path).filename}"
+        @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.2.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rename_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rónán Duddy
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -188,13 +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