git-gsub 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4bb2c9e366b42ad834a11590b47beebf6d866b1
-  data.tar.gz: 12fa7b4d29e60e241eaf46e7f7f0f56016a5902b
+  metadata.gz: 83807335e80f98fadabfb3952e2791973f3402fc
+  data.tar.gz: 8cb9229c0bfdc60b580fafc80269424f33fe041c
 SHA512:
-  metadata.gz: 91991a9c7329b9dcb883c5270577fa7779bb6a6f680dfd840aacdcac00fc79745a58a6c55744f2e1cad730fa39ddf6fc8e30876fbe4ad896b43b48cf852233b8
-  data.tar.gz: 4b3e90f5d4706c5a47720f49448ee1f5cae3ac19af372b5f612add9507855ac31af1c2476a1432002d4020dfd3757a0af05e7484569db112ceef659d975c3b00
+  metadata.gz: 6e26c83eb04af98873ef2b479f408eea7b29ee997ac38a835cb58f918a3c1a3f4924f8238b2f9d03de000e71247104276265c400ab7a41b8a8de589e165f83a0
+  data.tar.gz: 806e3d07a225082419864df8fd74a1dc3d0b0aa37c47f6363c93a27298e874b826efe16fe39a2acffba8ec49e95f362306dd0eaec98e853261c779710a9e3a0f

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.0.6]
+### Added
+- Add option to substitute in camel/kebab/snake case
+- Add option to rename files
+### Changed
+- Do substitution with Perl, not sed to reduce platform issues
+- No escape required to command line arguments
+
 ## [0.0.5] - 2017-05-23
 ### Fixed
 - Fix bug on assigning target directories

data/README.md

@@ -4,13 +4,25 @@ A Git subcommand to do gsub in a repository
 
 ## Usage
 
-To substitute `Git` with `Subversion`, run
+```
+Usage: git gsub [options] FROM TO [PATHS]
+    -v, --version                    Print version
+        --snake                      Experimental: substitute snake-cased expressions
+        --camel                      Experimental: substitute camel-cased expressions
+        --kebab                      Experimental: substitute kebab-cased expressions
+        --rename                     Rename files along with substitution
+        --dry-run                    Print commands to be run
+```
+
+## Example
+
+To substitute `Git` with `Subversion`:
 
 ```
 $ git gsub Git Subversion
 ```
 
-Then you will get
+Result:
 
 ```diff
 diff --git a/README.md b/README.md
@@ -35,25 +47,74 @@ index c30f093..03b7c4c 100755
 +Subversion::Gsub.run
 ```
 
-## Installation
+## Experimental features
+To substitute `CommonLisp` with `VisualBasic` with case-awareness:
 
 ```
-$ gem install git-gsub
+$ git gsub CommonLisp VisualBasic --kebab --snake --camel
+```
+
+Result:
+
+```diff
+diff --git a/README.md b/README.md
+index 2185dbf..393dbc6 100644
+--- a/README.md
++++ b/README.md
+@@ -1,4 +1,4 @@
+-# CommonLisp common_lisp common-lisp
++# VisualBasic visual_basic visual-basic
+```
+
+Substitute and rename file:
+
 ```
+$ git gsub ruby haskell --rename --camel
+```
+
+Result:
 
-## Escaping special characters
+```diff
+diff --git a/haskell.hs b/haskell.hs
+new file mode 100644
+index 0000000..ae86ce3
+--- /dev/null
++++ b/haskell.hs
+@@ -0,0 +1 @@
++putStrLn "Haskell"
+diff --git a/haskell.rb b/haskell.rb
+new file mode 100644
+index 0000000..9f363d3
+--- /dev/null
++++ b/haskell.rb
+@@ -0,0 +1 @@
++puts "haskell"
+diff --git a/ruby.hs b/ruby.hs
+deleted file mode 100644
+index 70db14d..0000000
+--- a/ruby.hs
++++ /dev/null
+@@ -1 +0,0 @@
+-putStrLn "Ruby"
+diff --git a/ruby.rb b/ruby.rb
+deleted file mode 100644
+index 966eb68..0000000
+--- a/ruby.rb
++++ /dev/null
+@@ -1 +0,0 @@
+```
 
-`git-gsub` uses `sed` internally, so escaping is same as it.
+Caution: Case conversion is done with [ActiveSupport/Inflector](http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html) , which substitutes `::` with `/`. This may cause unexpected result in the language other than Ruby.
 
-If you want to replace `git/gsub` with `svn/gsub`, the command will be
+## Installation
 
 ```
-$ git gsub "git\/gsub" "svn\/gsub"
+$ gem install git-gsub
 ```
 
 ## Supported platforms
 
-Maybe on many *nix like OS which has sed/gsed.
+Maybe on many *nix like OS which has Perl and sed.
 
 ## Contributing
 

data/bin/git-gsub

@@ -1,4 +1,4 @@
 #! /usr/bin/env ruby
 
 require 'git/gsub'
-Git::Gsub.run
+Git::Gsub.run(ARGV)

data/git-gsub.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.add_dependency "activesupport", "~> 4"
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"

data/lib/git/gsub.rb

@@ -1,14 +1,63 @@
-require "git/gsub/version"
+require 'git/gsub/version'
+require 'active_support/inflector'
+require 'optparse'
 require 'shellwords'
+require 'English'
 
 module Git
   module Gsub
-    def self.run
-      case ARGV.first
-      when '-v', '--version'
+    def self.run(argv)
+      opts = OptionParser.new
+
+      self.class.module_eval do
+        define_method(:usage) do |msg = nil|
+          puts opts.to_s
+          puts "error: #{msg}" if msg
+          exit 1
+        end
+      end
+
+      options = {}
+      opts.on('-v', '--version', 'Print version') do |_v|
+        options[:version] = true
+      end
+
+      opts.on('--snake', 'Experimental: substitute snake-cased expressions') do |_v|
+        options[:snake] = true
+      end
+
+      opts.on('--camel', 'Experimental: substitute camel-cased expressions') do |_v|
+        options[:camel] = true
+      end
+
+      opts.on('--kebab', 'Experimental: substitute kebab-cased expressions') do |_v|
+        options[:kebab] = true
+      end
+
+      opts.on('--rename', 'Rename files along with substitution') do |_v|
+        options[:rename] = true
+      end
+
+      opts.on('--dry-run', 'Print commands to be run') do |_v|
+        options[:dry] = true
+      end
+
+      opts.banner = 'Usage: git gsub [options] FROM TO [PATHS]'
+
+      begin
+        args = opts.parse(argv)
+      rescue OptionParser::InvalidOption => e
+        usage e.message
+      end
+
+      if options[:version]
         version
       else
-        gsub *ARGV
+        from, to, *paths = args
+        usage 'No FROM given' unless from
+        usage 'No TO given' unless to
+        Commands::Gsub.new(from, to, paths, options).run
+        Commands::Rename.new(from, to, paths, options).run if options[:rename]
       end
     end
 
@@ -16,29 +65,64 @@ module Git
       puts Git::Gsub::VERSION
     end
 
-    def self.gsub *args
-      from, to, *paths = args.map do |arg|
-        Shellwords.escape arg if arg
-      end
+    module Commands
+      class Command
+        attr_accessor :from, :to, :paths, :options
+
+        def initialize(from, to, paths = [], options = {})
+          @from = from
+          @to = to
+          @paths = paths
+          @options = options
+        end
+
+        def run_commands(commands)
+          if options[:dry]
+            commands.each { |c| puts c }
+          else
+            commands.each { |c| system c }
+          end
+        end
 
-      if to.nil?
-        abort "No argument to gsub was given"
+        def args
+          args = []
+          args << [from, to]
+          args << [from.camelcase, to.camelcase] if options[:camel]
+          args << [from.underscore, to.underscore] if options[:snake]
+          args << [from.underscore.dasherize, to.underscore.dasherize] if options[:kebab]
+
+          args.compact
+        end
       end
 
-      target_files = (`git grep -l #{from} #{paths.join ' '}`).each_line.map(&:chomp).join ' '
+      class Gsub < Command
+        def run
+          commands = args.map { |from, to| build_command(from, to, paths) }.compact
+          run_commands commands
+        end
 
-      if system_support_gsed?
-        system %|gsed -i s/#{from}/#{to}/g #{target_files}|
-      else
-        system %|sed -i "" -e s/#{from}/#{to}/g #{target_files}|
+        def build_command(from, to, paths = [], _options = {})
+          from, to, *paths = [from, to, *paths].map { |s| Shellwords.escape s }
+
+          target_files = `git grep -l #{from} #{paths.join ' '}`.each_line.map(&:chomp).join ' '
+          return if target_files.empty?
+
+          %(perl -pi -e 's{#{from}}{#{to}}g' #{target_files})
+        end
       end
-    end
 
-    private
+      class Rename < Command
+        def run
+          commands = args.map { |from, to| build_command(from, to, paths) }
+          run_commands commands
+        end
+
+        def build_command(from, to, paths = [], _options = {})
+          from, to, *paths = [from, to, *paths].map { |s| Shellwords.escape s }
 
-    def self.system_support_gsed?
-      `which gsed`
-      $?.success?
+          %[for f in $(git ls-files #{paths.join ' '} | grep #{from}); do mkdir -p $(dirname $(echo $f | sed 's/#{from}/#{to}/g')); git mv $f $(echo $f | sed 's/#{from}/#{to}/g') 2>/dev/null; done]
+        end
+      end
     end
   end
 end

data/lib/git/gsub/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Gsub
-    VERSION = "0.0.5"
+    VERSION = '0.0.6'.freeze
   end
 end

data/spec/git_gsub_spec.rb

@@ -4,51 +4,79 @@ require 'git/gsub'
 require 'pry'
 
 describe 'git-gsub' do
-  def run_in_directory_with_a_file content
+  def run_in_directory_with_a_file(filename, content)
     Dir.mktmpdir do |dir|
-      filename = "FOO"
       Dir.chdir dir do
+        dirname = File.dirname(filename)
+        FileUtils.mkdir_p(dirname) unless File.exists?(dirname)
         File.open(filename, 'w') { |f| f << content }
         `git init`
         `git config --local user.email "you@example.com"`
         `git config --local user.name "Your Name"`
         `git add .`
         `git commit -m init`
-        yield filename
+        yield
       end
     end
   end
 
   it 'should substitute files' do
-    run_in_directory_with_a_file "Git Subversion Bzr" do |filename|
-      Git::Gsub.gsub "Bzr", "Mercurial"
-      file = File.read(filename).chomp
-      expect(file).to eq "Git Subversion Mercurial"
+    run_in_directory_with_a_file 'README.md', 'Git Subversion Bzr' do
+      Git::Gsub.run %w[Bzr Mercurial]
+      expect(File.read('README.md')).to eq 'Git Subversion Mercurial'
     end
   end
 
-  it 'should escape well' do
-    run_in_directory_with_a_file %|<h1 class="foo">| do |filename|
-      Git::Gsub.gsub %|<h1 class="foo">|, %|<h1 class="bar">|
-      file = File.read(filename).chomp
-      expect(file).to eq %|<h1 class="bar">|
+  it 'should substitute files with case conversion' do
+    run_in_directory_with_a_file 'README.md', 'GitGsub git_gsub git-gsub' do
+      Git::Gsub.run %w[GitGsub SvnGsub --camel --kebab --snake]
+      expect(File.read('README.md')).to eq 'SvnGsub svn_gsub svn-gsub'
     end
   end
 
-  it 'should raise error if second argument wasn\'t given' do
-    run_in_directory_with_a_file "Git Subversion Bzr" do |filename|
-      begin
-        Git::Gsub.gsub "Bzr"
-      rescue SystemExit => e
-        expect(e.message).to match /No argument/
-      end
+  it 'should escape well' do
+    run_in_directory_with_a_file 'README.md', %(<h1 class="foo">) do
+      Git::Gsub.run [%(<h1 class="foo">), %(<h1 class="bar">)]
+      expect(File.read('README.md')).to eq %(<h1 class="bar">)
+    end
+
+    run_in_directory_with_a_file 'README.md', %(git/gsub) do
+      Git::Gsub.run [%(git/gsub), %(svn/sub)]
+      expect(File.read('README.md')).to eq %(svn/sub)
+    end
+
+    run_in_directory_with_a_file 'README.md', %({git{svn}) do
+      Git::Gsub.run [%({git{svn}), %({hg{svn})]
+      expect(File.read('README.md')).to eq %({hg{svn})
     end
   end
 
   it 'should not create backup file' do
-    run_in_directory_with_a_file "Git Subversion Bzr" do |filename|
-      Git::Gsub.gsub "Bzr", "Darcs"
-      expect(`ls`).to eql "FOO\n"
+    run_in_directory_with_a_file 'README.md', 'Git Subversion Bzr' do
+      Git::Gsub.run %w[Bzr Darcs]
+      expect(`ls`).to eql "README.md\n"
+    end
+  end
+
+  it 'should rename with --rename' do
+    run_in_directory_with_a_file 'README-git_gsub.md', 'GitGsub git_gsub git-gsub' do
+      Git::Gsub.run %w[GitGsub SvnGsub --snake --rename]
+      expect(`ls`).to eql "README-svn_gsub.md\n"
+      expect(File.read('README-svn_gsub.md')).to eq 'SvnGsub svn_gsub git-gsub'
+    end
+
+    run_in_directory_with_a_file 'lib/git.rb', 'puts "Git"' do
+      Git::Gsub.run %w[git svn --camel --rename]
+      expect(`ls lib`).to eql "svn.rb\n"
+      expect(File.read('lib/svn.rb')).to eq 'puts "Svn"'
+    end
+  end
+
+  it 'should do nothing if no file found' do
+    run_in_directory_with_a_file 'README-git_gsub.md', 'GitGsub git_gsub git-gsub' do
+      expect {
+        Git::Gsub.run %w[Atlanta Chicago --snake --rename]
+      }.not_to raise_error
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: git-gsub
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Fujimura Daisuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement