cmd_tools 1.1.1 → 2.0.0

data/README.rdoc

@@ -1,26 +1,7 @@
 = CmdTools
 == What is this?
 Simple small command line utilities.
-== Executables
-=== +tsh+
-*rm* alternative. Move files and directories into ~/.myTrash with +TIME_NOW+. prefix.
-==== Usage
-  tsh file1 file2 *~ dir1 dir2 1206??_photo
-=== +bak+
-Back up files and directories within current directory into ./bak_since_SOME_NUMBERES directory with bak.+TIME_NOW+. prefix.
-==== Usage
-  bak file1 file2 *~ dir1 dir2 1206??_photo
-=== +cmd_tools_emacs_launcher_for_alternate_editor_of_emacsclient+
-Deleted: please use +emacs_launcher_(g|c)ui+.
-=== +emacs_launcher_(g|c)ui+
-Launch emacs in (G|C)UI mode.
-1. If emacs daemon is not running, start a new daemon.
-2. If GUI mode and no frame exist, create a new frame.
-3. Open +files+ by emacsclient in (G|C)UI mode.
-==== Usage
-  alias em='emacs_launcher_gui'
-  alias e='emacs_launcher_cui'
-=== +emacs_launcher_stop+
-Stop emacs daemon launched by +emacs_launcher_(g|c)ui+.
-==== Usage
-  emacs_launcher_stop
+== Usage
+Please type
+  cmd_tools help
+on a command line to see usages.

data/bin/cmd_tools

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'cmd_tools'
+::CmdTools::Runner.start

data/cmd_tools.gemspec

@@ -12,21 +12,21 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'ruby_patch', '~> 0.3'
   s.author = 'kshramt'
   s.description = <<-EOS
-Command line tools:
-  tsh: mv files to ~/.myTrash.
-  bak: backup files.
-  emacs_launcher_(g|c)ui: launch emacsclient and daemon (if necessary).
+Command line tools. Please type
+
+$ cmd_tools help
+
+to see details.
   EOS
-  s.executables << 'bak'
-  s.executables << 'tsh'
-  s.executables << 'emacs_launcher_gui'
-  s.executables << 'emacs_launcher_cui'
-  s.executables << 'emacs_launcher_stop'
+  s.executables << 'cmd_tools'
   s.post_install_message = <<-EOS
 
 # CmdTools.
-alias em='emacs_launcher_gui'
-alias e='emacs_launcher_cui'
+alias bak='cmd_tools backup'
+alias tsh='cmd_tools trash'
+alias em='cmd_tools emacs_launch --mode=gui'
+alias e='cmd_tools emacs_launch --mode=cui'
+alias emacs_stop=''cmd_tools emacs_stop'
 
   EOS
   s.required_ruby_version = '~> 1.9'

data/lib/cmd_tools/command/backup.rb

@@ -0,0 +1,60 @@
+module ::CmdTools::Command::Backup
+  require 'fileutils'
+  require 'find'
+  require 'ruby_patch'
+  extend ::RubyPatch::AutoLoad
+
+  BAK_DIR_HEAD = "bak_since_"
+  BAK_DIR_REG = /(\A|\/)#{BAK_DIR_HEAD}\d{12}\z/
+  BAK_PREFIX = 'bak.'
+
+  # Back up files and directories to <tt>bak_dir</tt>.
+  # @param [Array<String>] files Files and directories to be backed up.
+  def self.run(*files)
+    time_stamp = Time.now.ymdhms
+    bak_dir = get_bak_dir(time_stamp)
+    nested_bak_dir_reg = /\A#{bak_dir}\/.*#{BAK_DIR_HEAD}\d{12}\z/
+    FileUtils.mkdir_p(bak_dir)
+    (files.flatten.map{|f| f.chomp('/')} - ['.', '..', bak_dir])\
+      .select{|f| File.exist?(f)}\
+      .each{|f|
+      dest = get_dest(bak_dir, f, time_stamp)
+      begin
+        FileUtils.cp_r(f, dest)
+      rescue
+        warn "WARN: Failed to back up #{f}."
+      end
+
+      delete_nested_bak_dir(dest, nested_bak_dir_reg) if(File.directory?(dest))
+    }
+  end
+
+  private
+
+  def self.get_bak_dir(time_stamp)
+    Dir.foreach('.')\
+      .select{|f| File.directory?(f)}\
+      .select{|f| f =~ BAK_DIR_REG}\
+      .first\
+    or BAK_DIR_HEAD + time_stamp
+  end
+
+  def self.get_dest(bak_dir, file, time_stamp)
+    ext = File.extname(file)
+    File.join(bak_dir, [BAK_PREFIX, file, '.', time_stamp, ext].join)
+  end
+
+  def self.delete_nested_bak_dir(dest, nested_bak_dir_reg)
+    Find.find(dest){|f| # I did not used #select method chain style to use Find.prune.
+      next unless File.directory?(f)
+      next unless f =~ nested_bak_dir_reg
+
+      $stdout.puts "Delete #{f}? [y/N]"
+      if $stdin.gets.strip =~ /\Ay/i
+        $stdout.puts "Deleting: #{f}"
+        FileUtils.rm_rf(f)
+        Find.prune
+      end
+    }
+  end
+end

data/lib/cmd_tools/command/emacs_launch.rb

@@ -0,0 +1,42 @@
+module ::CmdTools::Command::EmacsLaunch
+  require 'ruby_patch'
+  extend ::RubyPatch::AutoLoad
+
+  # Open +files+ by +mode+ (:gui/:cui) mode.
+  # Launch emacs daemon if necessary.
+  # Create new frame if necessary.
+  # You can edit ~/.config/cmd_tools/config.yaml to specify an emacs executable.
+  # For example, if you are a Mac user who uses MacPorts, following modification will be useful.
+  #   - :emacs: emacs
+  #   + :emacs: /Applications/MacPorts/Emacs.app/Contents/MacOS/Emacs
+  def self.run(mode, *files)
+    system "#{::CmdTools::Config.emacs} --daemon" unless self.daemon_running?
+
+    files = files.flatten.join(' ')
+    case mode
+    when :gui
+      if self.number_of_frames <= 1 # emacs daemon has one (invisible) frame.
+        exec "emacsclient -c -n #{files}"
+      else
+        exec "emacsclient -n #{files}"
+      end
+    when :cui
+      exec "emacsclient -t #{files}"
+    else
+      raise ArgumentError, "Expected :gui or :cui, but got #{mode}."
+    end
+  end
+
+  # Stop emacs daemon.
+  def self.stop
+    exec "emacsclient -e '(kill-emacs)'"
+  end
+
+  def self.daemon_running?
+    system "emacsclient -e '()' > /dev/null 2>&1"
+  end
+
+  def self.number_of_frames
+    `emacsclient -e "(length (visible-frame-list))"`.to_i
+  end
+end

data/lib/cmd_tools/command/trash.rb

@@ -0,0 +1,24 @@
+module ::CmdTools::Command::Trash
+  require 'fileutils'
+  require 'ruby_patch'
+  extend ::RubyPatch::AutoLoad
+
+  TRASH_DIR = File.join(ENV['HOME'], '.myTrash')
+
+  # Move files and directories into <tt>TRASH_DIR</tt>.
+  # @param [Array<String>] files Files and directories to be moved into <tt>TRASH_DIR</tt>.
+  def self.run(*files)
+    FileUtils.mkdir_p(TRASH_DIR)
+    time = Time.now.ymdhms
+    prefix = File.join(TRASH_DIR, time) + '.'
+    (files.flatten - ['.', '..'])\
+      .select{|f| File.exist?(f)}\
+      .each{|f|
+      begin
+        FileUtils.mv(f, prefix + File.basename(f))
+      rescue
+        warn "WARN: Failed to discard #{f}."
+      end
+    }
+  end
+end

data/lib/cmd_tools/command.rb

@@ -0,0 +1,4 @@
+module ::CmdTools::Command
+  require 'ruby_patch'
+  extend ::RubyPatch::AutoLoad
+end

data/lib/cmd_tools/runner.rb

@@ -0,0 +1,37 @@
+require 'thor'
+
+class ::CmdTools::Runner < Thor
+  require 'ruby_patch'
+  extend ::RubyPatch::AutoLoad
+
+  desc "backup FILE1 FILE2 ...", "Backup files and directories."
+  def backup(*files)
+    puts ::CmdTools::Command::Backup.run(*files).join("\t")
+  end
+
+  desc "trash FILE1 FILE2 ...", "Move files and directories to ~/.myTrash"
+  def trash(*files)
+    puts ::CmdTools::Command::Trash.run(*files).join("\t")
+  end
+
+  desc "emacs_launch FILE1 FILE2 ...", "Launch emacs in MODE mode."
+  long_desc <<-EOS
+Launch emacs in (G|C)UI mode.
+
+1. If emacs daemon is not running, start a new daemon.
+
+2. If GUI mode and no frame exist, create a new frame.
+
+3. Open files by emacsclient in (G|C)UI mode.
+  EOS
+  method_option :mode, type: :string, required: true, desc: "MODE should be 'gui' or 'cui'."
+  def emacs_launch(*files)
+    mode = options['mode'].to_sym
+    ::CmdTools::Command::EmacsLaunch.run(mode, *files)
+  end
+
+  desc "emacs_stop", "Stop emacs daemon."
+  def emacs_stop
+    ::CmdTools::Command::EmacsLaunch.stop
+  end
+end

data/lib/cmd_tools/version.rb

@@ -1,3 +1,3 @@
 module CmdTools
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmd_tools
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_patch
-  requirement: &75179250 !ruby/object:Gem::Requirement
+  requirement: &69899570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,32 +21,33 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *75179250
-description: ! "Command line tools:\n  tsh: mv files to ~/.myTrash.\n  bak: backup
-  files.\n  emacs_launcher_(g|c)ui: launch emacsclient and daemon (if necessary).\n"
+  version_requirements: *69899570
+description: ! 'Command line tools. Please type
+
+
+  $ cmd_tools help
+
+
+  to see details.
+
+'
 email: 
 executables:
-- bak
-- tsh
-- emacs_launcher_gui
-- emacs_launcher_cui
-- emacs_launcher_stop
+- cmd_tools
 extensions: []
 extra_rdoc_files: []
 files:
 - README.rdoc
-- bin/bak
-- bin/emacs_launcher_cui
-- bin/emacs_launcher_gui
-- bin/emacs_launcher_stop
-- bin/tsh
+- bin/cmd_tools
 - cmd_tools.gemspec
 - lib/cmd_tools.rb
 - lib/cmd_tools/bin.rb
-- lib/cmd_tools/bin/bak.rb
-- lib/cmd_tools/bin/emacs_launcher.rb
-- lib/cmd_tools/bin/tsh.rb
+- lib/cmd_tools/command.rb
+- lib/cmd_tools/command/backup.rb
+- lib/cmd_tools/command/emacs_launch.rb
+- lib/cmd_tools/command/trash.rb
 - lib/cmd_tools/config.rb
+- lib/cmd_tools/runner.rb
 - lib/cmd_tools/version.rb
 homepage: 
 licenses: []
@@ -54,9 +55,15 @@ post_install_message: ! '
 
   # CmdTools.
 
-  alias em=''emacs_launcher_gui''
+  alias bak=''cmd_tools backup''
+
+  alias tsh=''cmd_tools trash''
+
+  alias em=''cmd_tools emacs_launch --mode=gui''
+
+  alias e=''cmd_tools emacs_launch --mode=cui''
 
-  alias e=''emacs_launcher_cui''
+  alias emacs_stop=''''cmd_tools emacs_stop''
 
 
 '
@@ -82,3 +89,4 @@ signing_key:
 specification_version: 3
 summary: Command line tools.
 test_files: []
+has_rdoc: 

data/bin/bak

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-if ARGV.empty?
-  puts "bak file1 file2 ..."
-
-  exit
-end
-
-require "cmd_tools"
-puts ::CmdTools::Bin::Bak.run(ARGV).join("\t")

data/bin/emacs_launcher_cui

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-require "cmd_tools"
-::CmdTools::Bin::EmacsLauncher.run(:cui, ARGV)

data/bin/emacs_launcher_gui

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-require "cmd_tools"
-::CmdTools::Bin::EmacsLauncher.run(:gui, ARGV)

data/bin/emacs_launcher_stop

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-require "cmd_tools"
-::CmdTools::Bin::EmacsLauncher.stop

data/bin/tsh

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-if ARGV.empty?
-  puts "tsh fileOrDir1 fileOrDir2 ..."
-
-  exit
-end
-
-require 'cmd_tools'
-puts ::CmdTools::Bin::Tsh.run(ARGV).join("\t")

data/lib/cmd_tools/bin/bak.rb

@@ -1,66 +0,0 @@
-module CmdTools
-  module Bin
-
-    # bak is an abbreviation of backup.
-    module Bak
-      require 'fileutils'
-      require 'find'
-      require 'ruby_patch'
-      extend ::RubyPatch::AutoLoad
-
-      BAK_DIR_HEAD = "bak_since_"
-      BAK_DIR_REG = /(\A|\/)#{BAK_DIR_HEAD}\d{12}\z/
-      BAK_PREFIX = 'bak.'
-
-      # Back up files and directories to <tt>bak_dir</tt>.
-      # @param [Array<String>] files Files and directories to be backed up.
-      def self.run(*files)
-        time_stamp = Time.now.ymdhms
-        bak_dir = get_bak_dir(time_stamp)
-        nested_bak_dir_reg = /\A#{bak_dir}\/.*#{BAK_DIR_HEAD}\d{12}\z/
-        FileUtils.mkdir_p(bak_dir)
-        (files.flatten.map{|f| f.chomp('/')} - ['.', '..', bak_dir])\
-          .select{|f| File.exist?(f)}\
-          .each{|f|
-          dest = get_dest(bak_dir, f, time_stamp)
-          begin
-            FileUtils.cp_r(f, dest)
-          rescue
-            warn "WARN: Failed to back up #{f}."
-          end
-
-          delete_nested_bak_dir(dest, nested_bak_dir_reg) if(File.directory?(dest))
-        }
-      end
-
-      private
-
-      def self.get_bak_dir(time_stamp)
-        Dir.foreach('.')\
-          .select{|f| File.directory?(f)}\
-          .select{|f| f =~ BAK_DIR_REG}\
-          .first\
-        or BAK_DIR_HEAD + time_stamp
-      end
-
-      def self.get_dest(bak_dir, file, time_stamp)
-        ext = File.extname(file)
-        File.join(bak_dir, [BAK_PREFIX, file, '.', time_stamp, ext].join)
-      end
-
-      def self.delete_nested_bak_dir(dest, nested_bak_dir_reg)
-        Find.find(dest){|f| # I did not used #select method chain style to use Find.prune.
-          next unless File.directory?(f)
-          next unless f =~ nested_bak_dir_reg
-
-          $stdout.puts "Delete #{f}? [y/N]"
-          if $stdin.gets.strip =~ /\Ay/i
-            $stdout.puts "Deleting: #{f}"
-            FileUtils.rm_rf(f)
-            Find.prune
-          end
-        }
-      end
-    end
-  end
-end

data/lib/cmd_tools/bin/emacs_launcher.rb

@@ -1,46 +0,0 @@
-module CmdTools
-  module Bin
-    module EmacsLauncher
-      require 'ruby_patch'
-      extend ::RubyPatch::AutoLoad
-
-      # Open +files+ by +mode+ (:gui/:cui) mode.
-      # Launch emacs daemon if necessary.
-      # Create new frame if necessary.
-      # You can edit ~/.config/cmd_tools/config.yaml to specify an emacs executable.
-      # For example, if you are a Mac user who uses MacPorts, following modification will be useful.
-      #   - :emacs: emacs
-      #   + :emacs: /Applications/MacPorts/Emacs.app/Contents/MacOS/Emacs
-      def self.run(mode, *files)
-        system "#{::CmdTools::Config.emacs} --daemon" unless self.daemon_running?
-
-        files = files.flatten.join(' ')
-        case mode
-        when :gui
-          if self.number_of_frames <= 1 # emacs daemon has one (invisible) frame.
-            exec "emacsclient -c -n #{files}"
-          else
-            exec "emacsclient -n #{files}"
-          end
-        when :cui
-          exec "emacsclient -t #{files}"
-        else
-          raise ArgumentError, "Unknown mode: #{mode}"
-        end
-      end
-
-      # Stop emacs daemon.
-      def self.stop
-        exec "emacsclient -e '(kill-emacs)'"
-      end
-
-      def self.daemon_running?
-        system "emacsclient -e '()' > /dev/null 2>&1"
-      end
-
-      def self.number_of_frames
-        `emacsclient -e "(length (visible-frame-list))"`.to_i
-      end
-    end
-  end
-end

data/lib/cmd_tools/bin/tsh.rb

@@ -1,30 +0,0 @@
-module CmdTools
-  module Bin
-
-    # tsh is an abbreviation of trash.
-    module Tsh
-      require 'fileutils'
-      require 'ruby_patch'
-      extend ::RubyPatch::AutoLoad
-
-      TRASH_DIR = File.join(ENV['HOME'], '.myTrash')
-
-      # Move files and directories into <tt>TRASH_DIR</tt>.
-      # @param [Array<String>] files Files and directories to be moved into <tt>TRASH_DIR</tt>.
-      def self.run(*files)
-        FileUtils.mkdir_p(TRASH_DIR)
-        time = Time.now.ymdhms
-        prefix = File.join(TRASH_DIR, time) + '.'
-        (files.flatten - ['.', '..'])\
-          .select{|f| File.exist?(f)}\
-          .each{|f|
-          begin
-            FileUtils.mv(f, prefix + File.basename(f))
-          rescue
-            warn "WARN: Failed to discard #{f}."
-          end
-        }
-      end
-    end
-  end
-end