modname 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db801b72d84bfda8d0aea8c3fbfc0f0954605f4b
-  data.tar.gz: 67668d19c866e0c6399a91e3c834744cae05cd93
+SHA256:
+  metadata.gz: a75ac155dd3255d8cebd50ec9e01e629a9f64aa0b17090e482db22978baf8832
+  data.tar.gz: 29414f4677355f27ddda53fbfd857241adf1550c28709c955da4e2165b71d1c6
 SHA512:
-  metadata.gz: 5854fa779812fab689e2b56cc94ec320734801312baebe5c411459f1ab091d3eb92999cc3eac0f3d44e86dd140a2a98e26a9c17e5a85f8e247a7eb14b28fb5cd
-  data.tar.gz: 72c46d7f40051dd48b6e1077697255f68d36dc9a8a781452c6002afbeed0fd040b479225168a13deca6038fda7c8260d40b3cfd3bbddf4d7444ed80fbd6024a5
+  metadata.gz: 2ea30c66c31f07b5b5f928cb49c0fd8cbddd6d765042b7b3f1cdd7c08e746d0085f7dd916e32488424b3c9a594a46a9c7ccd1fe769d663b0217b49b60216e6f6
+  data.tar.gz: 39b3a3d68f4462308713223c71b6fc7a7b307f333f452e1b1c4cf7e9509698e075c7ab2023dd6adcc25581e87dbecceb1dde56cf62b7022b29f1c5abbdb2eed8

data/bin/modname

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "modname"
+require 'modname'
 
 # modname by jeremy warner
 # easily rename files/extensions with ruby regex.
 
 Modname.run(ARGV)
-

data/lib/modname/banner.rb

@@ -1,39 +1,39 @@
-module Modname end
+# frozen_string_literal: true
 
+# Modname is a versatile file naming tool for renaming groups of files
+module Modname end
 
-Modname::HelpBanner = <<-HELP
-#{'Usage:'.cyan} modname [options] <match> [transform]
+Modname::HELP_BANNER = <<~HELP.freeze
+  #{'Usage:'.cyan} modname [options] <match> [transform]
 
-#{'modname | rename files, fast'.cyan}
-#{'--------┼----------------------------'.cyan}
-     -e #{'|'.cyan} change file extensions
-     -f #{'|'.cyan} force run; don't pre-check
-     -r #{'|'.cyan} run modname recursively
-     -h #{'|'.cyan} show more help, examples
+  #{'modname | rename files, fast'.cyan}
+  #{'--------┼----------------------------'.cyan}
+       -e #{'|'.cyan} change file extensions
+       -f #{'|'.cyan} force run; don't pre-check
+       -r #{'|'.cyan} run modname recursively
+       -h #{'|'.cyan} show more help, examples
 HELP
 
+Modname::V_HELP_BANNER = <<~VHELP.freeze
+  #{Modname::HELP_BANNER}
+  #{'commands'.cyan}
+    file names
+      [match] [trans] => modify a pattern in filenames
+      [match] => delete a pattern from filenames
 
-Modname::VHelpBanner = <<-VHELP
-#{Modname::HelpBanner}
-#{'commands'.cyan}
-  file names
-    [match] [trans] => modify a pattern in filenames
-    [match] => delete a pattern from filenames
+    extensions (-e)
+      [old] [new] => move file extensions, <old> to <new>
+      [ext] => lowercase one extension type (EXT => ext)
+      nil => move all extensions to lower case
 
-  extensions (-e)
-    [old] [new] => move file extensions, <old> to <new>
-    [ext] => lowercase one extension type (EXT => ext)
-    nil => move all extensions to lower case
+  #{'examples'.cyan}
+    file names
+      modname hello => deletes 'hello' from all filenames
+      modname hello byebye => replace 'hello' with byebye
 
-#{'examples'.cyan}
-  file names
-    modname hello => deletes 'hello' from all filenames
-    modname hello byebye => replace 'hello' with byebye
+    extensions (-e)
+      modname -e txt md => move all txt files to markdown
+      modname -e mov mp4 => move all mov files to mp4
 
-  extensions (-e)
-    modname -e txt md => move all txt files to markdown
-    modname -e mov mp4 => move all mov files to mp4
-
-#{'Note:'.cyan} <required> [optional]
+  #{'Note:'.cyan} <required> [optional]
 VHELP
-

data/lib/modname/modder.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
+
 # modder, the modname helper
 # generally: o-old, n-new
 
-
 # any module including modder should implement:
 # @transfer => hash of file transfers to occur
 # @options => hash with :recurse and :force
 
-
 # extensions
 module Modder
-
   # rename files based on regular expressions
   def regex(args = [])
     match, trans = Modder.parse args
 
     Modder.files(@options[:recurse]).each do |file|
-      new = file.sub Regexp.new(match), trans
+      new = Modder.rename_base(file) do |base|
+        result = base.sub Regexp.new(match), trans
+        result.empty? ? base : result # no changes
+      end
 
-      next if (new == file || new == "") # no changes
+      next if new.nil?
 
       @transfer[file] = new
     end
 
-    Modder.finish @transfer, @options[:force]
+    Modder.finish @transfer, force: @options[:force]
   end
 
-
   # change one file extension to another's type
   def exts(args = [])
     match, trans = Modder.parse args
@@ -38,41 +39,39 @@ module Modder
 
     else # move match extension to targeted
       Modder.files(@options[:recurse]).each do |file|
-        new = file.sub(/#{match}$/, trans)
+        new = Modder.rename_base(file) { |base| base.sub(/#{match}$/, trans) }
 
-        next if new == file # no changes
+        next if new.nil?
 
         @transfer[file] = new
       end
 
-      Modder.finish @transfer, @options[:force]
+      Modder.finish @transfer, force: @options[:force]
     end
   end
 
   # top level wrapper for exts
-  def undercase_ext(ext = "")
+  def undercase_ext(ext = '')
     transfer = Modder.undercase_ext_get ext, @options[:recurse]
     Modder.undercase_ext_set ext, transfer, @options[:force]
   end
 end
 
-
 # module methods
 class << Modder
-
   # return appropriate args, repairing if undefined
   def parse(args)
     match = args.shift
     trans = args.shift
-    match = "" if match.nil?
-    trans = "" if trans.nil?
-    return match, trans
+    match = '' if match.nil?
+    trans = '' if trans.nil?
+    [match, trans]
   end
 
   # double check transformations
   def confirm?
-    print "Are these changes ok? [yN] "
-    ($stdin.gets.chomp!).downcase[0] == "y"
+    print 'Are these changes ok? [yN] '
+    $stdin.gets.chomp.downcase[0] == 'y'
   end
 
   # return a list of files to examine
@@ -84,66 +83,73 @@ class << Modder
     end
   end
 
+  # apply a transformation to a file's basename only, preserving its directory.
+  # the block receives the basename and returns a new basename; returning it
+  # unchanged means no rename should happen, in which case nil is returned
+  def rename_base(file)
+    dir, base = File.split(file)
+    new_base = yield base
+
+    return nil if new_base == base
+
+    dir == '.' ? new_base : File.join(dir, new_base)
+  end
 
   # show the status of current files
   def status(transfer)
     if transfer.empty?
-      puts "No matches found.".yellow
+      puts 'No matches found.'.yellow
     else
-      puts "Planned file actions:".green
+      puts 'Planned file actions:'.green
       transfer.each { |o, n| puts "\t#{o} -> #{n.green}" }
     end
   end
 
   # rename all files
-  def execute(transfer, force=false)
+  def execute(transfer, force: false)
     transfer.each { |o, n| Modder.rename o, n, force }
   end
 
-
   # finish up execution, highest level wrapper
-  def finish(transfer, force=false)
-
+  def finish(transfer, force: false)
     # print changes, return if none
     Modder.status transfer
     return if transfer.empty?
 
     if force || Modder.confirm?
-      Modder.execute transfer, force
-      puts "Modifications complete."
+      Modder.execute transfer, force: force
+      puts 'Modifications complete.'
     else
-      puts "No modifications done."
+      puts 'No modifications done.'
     end
   end
 
   # try to rename a given file
-  def rename(o, n, force)
-    begin
-      exist = "#{'Error:'.red} target file |#{n.green}| already exists"
-
-      # only overwrite when forced
-      if (!force) && File.exist?(n)
-        raise(exist)
-      else
-        File.rename(o, n)
-      end
+  def rename(old, new, force)
+    exist = "#{'Error:'.red} target file |#{new.green}| already exists"
 
-    rescue => e
-      puts "#{'Error:'.red} could not move |#{o.red}| to |#{n.green}|"
-      puts e.message
-    end
-  end
+    # only overwrite when forced
+    raise(exist) if (!force) && File.exist?(new)
 
+    File.rename(old, new)
+  rescue StandardError => e
+    puts "#{'Error:'.red} could not move |#{old.red}| to |#{new.green}|"
+    puts e.message
+  end
 
   # get all extensions to change
   def undercase_ext_get(ext, recurse)
-    transfer = Hash.new
+    transfer = {}
     allexts = ext.empty?
     Modder.files(recurse).each do |file|
-      ext = file.split(".").last if allexts
+      new = Modder.rename_base(file) do |base|
+        cur_ext = allexts ? base.split('.').last : ext
+        next base if cur_ext == base # no extension to change
 
-      new = file.sub(/#{ext}$/i, ext.downcase)
-      next if new == file || ext == file # no changes or extension
+        base.sub(/#{cur_ext}$/i, cur_ext.downcase)
+      end
+
+      next if new.nil?
 
       transfer[file] = new
     end
@@ -156,7 +162,7 @@ class << Modder
   # not case sensitive and therefore wont distiniguish between HI and hi.
   # to get around this, we can set HI to HI.hash, then set HI.hash to hi
   def undercase_ext_set(ext, transfer, force)
-    puts "Lowering extension: ".green + (ext.empty?? "*" : ext)
+    puts 'Lowering extension: '.green + (ext.empty? ? '*' : ext)
 
     Modder.status transfer
     return if transfer.empty?
@@ -175,10 +181,9 @@ class << Modder
 
       Modder.execute temp
       Modder.execute final
-      puts "Modifications complete."
+      puts 'Modifications complete.'
     else
-      puts "No modifications done."
+      puts 'No modifications done.'
     end
   end
 end
-

data/lib/modname/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Modname
-  Version = "0.2.3"
+  VERSION = '1.0.0'
 end

data/lib/modname.rb

@@ -1,75 +1,76 @@
-# parse modname's command line args
-
+# frozen_string_literal: true
 
-require "colored"
-require "modname/banner"
-require "modname/modder"
-require "modname/version"
+# parse modname's command line args
 
+require 'colored'
+require_relative 'modname/banner'
+require_relative 'modname/modder'
+require_relative 'modname/version'
 
+# Modname is a versatile file naming tool for renaming groups of files
 module Modname
-  class << self # defining Modname.run
-    def run(x) Driver.new.run x end
+  # defining Modname.run
+  class << self
+    def run(args) = Driver.new.run(args)
   end
-end
-
 
-class Modname::Driver
-  include Modder
+  # Driver class handles command-line argument parsing and execution
+  class Driver
+    include Modder
 
-  attr_reader :options
+    attr_reader :options
 
-  def initialize
-    @options = {:force => false, :recurse => false}
-    @transfer = {}
-  end
+    def initialize
+      @options = { force: false, recurse: false }
+      @transfer = {}
+    end
 
-  # parse user arguments
-  def run(args)
-    if args.empty?
-      puts Modname::HelpBanner
-    else
-      opts = parse args
-      cmd = opts[:cmd]
+    # parse user arguments
+    def run(args)
+      if args.empty?
+        puts Modname::HELP_BANNER
+      else
+        opts = parse args
+        cmd = opts[:cmd]
 
-      case cmd
-      when "file"
-        regex opts[:args]
+        case cmd
+        when 'file'
+          regex opts[:args]
 
-      when "ext"
-        exts opts[:args]
+        when 'ext'
+          exts opts[:args]
 
-      when "help"
-        puts Modname::VHelpBanner
+        when 'help'
+          puts Modname::V_HELP_BANNER
 
-      when "version"
-        puts Modname::Version
+        when 'version'
+          puts Modname::VERSION
+        end
       end
     end
-  end
-
-  # parse out arguments
-  def parse(args)
-    opts = {:cmd => "file", :args => []}
 
-    args.each do |opt|
-      case opt
-      when "-f"
-        @options[:force] = true
-      when "-r"
-        @options[:recurse] = true
-      when "-e", "--ext"
-        opts[:cmd] = "ext"
-      when "-h", "--help"
-        opts[:cmd] = "help"
-      when "-v", "--version"
-        opts[:cmd] = "version"
-      else # command argument
-        opts[:args] << opt
+    # parse out arguments
+    def parse(args)
+      opts = { cmd: 'file', args: [] }
+
+      args.each do |opt|
+        case opt
+        when '-f'
+          @options[:force] = true
+        when '-r'
+          @options[:recurse] = true
+        when '-e', '--ext'
+          opts[:cmd] = 'ext'
+        when '-h', '--help'
+          opts[:cmd] = 'help'
+        when '-v', '--version'
+          opts[:cmd] = 'version'
+        else # command argument
+          opts[:args] << opt
+        end
       end
-    end
 
-    opts
+      opts
+    end
   end
 end
-

data/readme.md

@@ -3,8 +3,6 @@ modname
 
 
 [![Gem Version](https://badge.fury.io/rb/modname.svg)](https://badge.fury.io/rb/modname)
-[![Build Status](https://travis-ci.org/jeremywrnr/modname.svg?branch=master)](https://travis-ci.org/jeremywrnr/modname)
-[![Code Climate](https://codeclimate.com/github/jeremywrnr/modname/badges/gpa.svg)](https://codeclimate.com/github/jeremywrnr/modname)
 [![MIT](https://img.shields.io/npm/l/alt.svg?style=flat)](http://jeremywrnr.com/mit-license)
 
 
@@ -54,6 +52,12 @@ examples
 Note: <required> [optional]
 ```
 
+### examples
+
+    modname -e jpeg jpg # change all jpeg file exts to jpg
+    modname -e # change all file extensions to lowercase
+    modname '(.*)' 'jeremy \1' # use grouping to prepend string
+
 
 ## development / testing
 
@@ -66,16 +70,15 @@ try running `gem install bundler`. Once that is done:
 Now, we should be able to build the gem locally. This will build the local
 modname gem and link it in your path, so you can playing around with `modname`.
 
-    rake build
+    just build
 
-This uses `rspec` and `rake` to run a suite of unit tests. To run the suite:
+This uses `rspec` and `just` to run a suite of unit tests. To run the suite:
 
-    rake
+    just spec
 
 
 ## todos
 
-- only try to rename filenames, not folders on recursive calls
 - figure out whats up with the extension globbing
 - apply optionally to directories as well
 

metadata

@@ -1,45 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: modname
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeremy Warner
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ronn
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +52,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
 description: easily rename groups of files with regex replacements.
 email: jeremywrnr@gmail.com
 executables:
@@ -97,7 +82,6 @@ homepage: http://github.com/jeremywrnr/modname
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -112,10 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: a versatile file naming tool.
 test_files: []
-has_rdoc: