vim_printer 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf94e1504753731437a2895e6a335a7df773c1fb
-  data.tar.gz: 3573098d508d822a609f978e6f9596c1e1fc8bc6
+  metadata.gz: 5db6c8f84609703178fb48f9917034197fe3a0f3
+  data.tar.gz: 7e764609c4a0860849ac65cfb9e57e2195886439
 SHA512:
-  metadata.gz: 7c092273c740770e119028ad783c4a0eaed523fd167ccf3bd73c67c02b03cf22c63f398b5ef9dd1170a29f4fc61a5be3d11ae92481db7d3e3615634897d1925c
-  data.tar.gz: b1295ce482b28db558fab1ab11340b6b3c5c8d56d8e1500c2309b8cef8504718c57ffa5efdc234568ab2bff5874f3c01b9f5a440065261e7d01f3b52e69ec435
+  metadata.gz: ee03cbf46d41b1e06a9d3d0c92532471f663de84fd06c038f72872e64c75d84a2078d0305a349c466895a486c065ae842d621f54a7c344b3f9a3d74f46fb3556
+  data.tar.gz: 38485f6aec3fd9f5340804b71fcb9d370c258bc4ab6d07d6dd7adeb015abde08319912042f59a0d1b9d8ad29c9db6e9f13c810cbe53bc7efc6afca38ea200c73

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+#### 0.1.9
+
+- Add advance `--shell_command` option to get the input file list from the the shell command [New]
+
 #### 0.1.8
 
 - Add `configuration.rb` for easy customization of options to `:TOhtml` [New]

data/README.md

@@ -155,7 +155,11 @@ Options:
                                            # Default: 'default'
   -c, [--index], [--no-index]              # Generate the index.html file for the result (optional)
                                            # Default: --index
-
+  -s, [--shell-command]                    # Use the input file list from the result of the given shell command (optional)
+                                           # Note: the command must be result in the list of files
+                                           # This option ignore any of the following options -e, -f, -n, -x, -i if specified
+                                           # e.g. --shell-command 'git diff --name-only HEAD~2 | grep -v test'
+                                           # e.g. --shell-command 'find . -type f -iname "*.rb" | grep -v test'
 Print files to (x)html using Vim
 ```
 

data/lib/vim_printer/cli.rb

@@ -26,6 +26,10 @@ module VimPrinter
                   desc:    "Generate the index.html file for the result",
                   type:    :boolean,
                   default: true
+    method_option :shell_command,
+                  aliases: "-s",
+                  desc: "Use input file list from the result of the given shell command",
+                  type: :string
     def print
       opts = options.symbolize_keys
       if opts[:version]
@@ -63,7 +67,11 @@ Options:
                                            # Default: 'default'
   -c, [--index], [--no-index]              # Generate the index.html file for the result (optional)
                                            # Default: --index
-
+  -s, [--shell-command]                    # Use the input file list from the result of the given shell command (optional)
+                                           # Note: the command must be result in the list of files
+                                           # This option ignore any of the following options -e, -f, -n, -x, -i if specified
+                                           # e.g. --shell-command 'git diff --name-only HEAD~2 | grep -v test'
+                                           # e.g. --shell-command 'find . -type f -iname "*.rb" | grep -v test | grep -v _spec'
 Print files to (x)html using Vim
       EOS
     end
@@ -73,12 +81,61 @@ Print files to (x)html using Vim
 
   private
 
+    # Get the appropriate input from the options
+    #
+    # @param [Hash<Symbol, Object>] args the input options
+    # @option args [String] :shell_input the shell input string if any
+    # @return [Array<String>] list of files in the format
+    #
+    #   ["./Gemfile", "./lib/vim_printer/cli.rb", ..]
+    def get_input_files(args = {})
+      shell_command = args.fetch(:shell_command, nil)
+      if shell_command.nil?
+        # use other options if we don't use the '--shell-input' option
+        CodeLister.files(args)
+      else
+        files_from_shell_command(shell_command, args[:base_dir])
+      end
+    end
+
+    # Execute the command in the shell and return the output list for use
+    # e.g. `git diff --name-only HEAD~1` is getting the list of files that have been
+    # updated in the last commit
+    #
+    # @param [String] shell_input the input command to be executed in the shell
+    # @param [String] base_dir the starting directory
+    # @return [Array<String>] file list or empty list if the shell command is not valid
+    def files_from_shell_command(command, base_dir)
+      files = AgileUtils::Helper.shell(command.split(" ")).split(/\n/)
+      # Adapt the result and make sure that it start with "./"
+      # like the result from 'CodeLister.files()' method
+      files.map! do |file|
+        if file =~ /^\.\//
+          # skip if the file start with './' string
+          file
+        else
+          # add './' to the one that does not already have one
+          "./#{file}"
+        end
+      end
+      # Note: this make sure that it work with deleted file when use
+      # this with 'git diff --name-only HEAD~2'
+      files.delete_if { |file| !File.exist?(file.gsub(/^\./, base_dir)) }
+    rescue RuntimeError => e
+      # just return the empty list, if the user specified invalid command for 'shell_input' option
+      return []
+    end
+
     # Main entry point to export the code
     #
     # @param [Hash<Symbol, Object>] options the options argument
     def execute(options = {})
-      input_files = CodeLister.files(options)
-      input_files.delete_if { |file| File.binary?(file.gsub(/^\./, options[:base_dir])) }
+      input_files = get_input_files(options)
+      # we want to avoid printing the binary file
+      input_files.delete_if do |file|
+        File.binary?(file.gsub(/^\./, options[:base_dir]))
+      end
+
       if input_files.empty?
         puts "No file found for your option: #{options}"
         return

data/lib/vim_printer/version.rb

@@ -1,3 +1,3 @@
 module VimPrinter
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vim_printer
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor