vim_printer 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7ef6d1e0db8517896394fe80a2036465e245935
-  data.tar.gz: 3c71aa32e2383276078b518b2bd2dc4456eb4d56
+  metadata.gz: e4da665f351436c68b1e1e2c7500b49f15131740
+  data.tar.gz: 62ff7b2472057f1dc9689507045a0526de774975
 SHA512:
-  metadata.gz: 4d1d8341564158a4e8aa96d9ad7ef7ea7455f43bdbb8ead615179ca92692352f9903d8ef8da56036f6813dafbca4211860e00d6926c278dafd9f48b0ff6a0809
-  data.tar.gz: 7ea497584135d9dbd07387c06a2703a201162131a8e61213ed215341ffd8617c736028662ddf776107687dcb8b51df9c6aeade47c0b8ca35df82893276cdf0c4
+  metadata.gz: 6a139ffe7f1ca9729a8be68a51a1c375d7f6fc0826e0b060049057887d1f94af8d811fb4e82654666d26b0ae1ad912c0079c785a0c7543a4db8215581e757cd8
+  data.tar.gz: 81557cd9c34d5bb8f3aaf46bdf75a9e21cff155d2921f259d33c49de6d455387811ca45c9994ce3689c5024d320edd2cc52ae13e49069f78de13079d1d601315

data/README.md

@@ -169,11 +169,19 @@ rake
 
 ### Changelog
 
+#### 0.0.4
+
+- Fix the output path of 'index.html' to root directory to make links valid.
+
+- Update [agile_utils][] to '0.0.4'
+
+- Code cleanup using rubocop
+
 #### 0.0.3
 
 - Use generic functions from [agile_utils][] gem
 
-- Update [index_html][] gem from 0.0.5 to 0.0.7
+- Update [index_html][] gem to 0.0.7
 
 - Fix the bug in generated 'index.html' due to bug from index_html gem
 

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'lib/vim_printer'
@@ -7,7 +7,7 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task default: :test
 
 task :pry do
   require 'pry'

data/lib/vim_printer/cli.rb

@@ -7,45 +7,47 @@ module VimPrinter
   include AgileUtils
 
   class CLI < CodeLister::BaseCLI
-
     desc 'print', 'Print the list of files'
 
-    shared_options
+    method_option *AgileUtils::Options::BASE_DIR
+    method_option *AgileUtils::Options::EXTS
+    method_option *AgileUtils::Options::NON_EXTS
+    method_option *AgileUtils::Options::INC_WORDS
+    method_option *AgileUtils::Options::EXC_WORDS
+    method_option *AgileUtils::Options::IGNORE_CASE
+    method_option *AgileUtils::Options::RECURSIVE
+    method_option *AgileUtils::Options::THEME
+    method_option *AgileUtils::Options::VERSION
 
-    method_option :theme,
-                  aliases: "-t",
-                  desc: "Vim colorscheme to use",
-                  default: "default"
     def print
       opts = options.symbolize_keys
       if opts[:version]
         puts "You are using VimPrinter version #{VimPrinter::VERSION}"
         exit
       end
-      puts "FYI: your options #{opts}"
       execute(opts)
     end
 
-    desc "usage", "Display help screen"
+    desc 'usage', 'Display help screen'
     def usage
       puts <<-EOS
 Usage:
-  vim_printer print
+  vim_printer print [OPTIONS]
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
-                                           # Default: /home/bchoomnuan/Dropbox/spikes/vim_printer
+                                           # Default: . (current directory)
   -e, [--exts=one two three]               # List of extensions to search for
-  -f, [--non-exts=one two three]           # List of files without extension to search for
-  -n, [--inc-words=one two three]          # List of words to be included in the result if any
-  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
+  -f, [--non-exts=one two three]           # List of extensions to search for
+  -n, [--inc-words=one two three]          # List of words to be included in the result
+  -n, [--exc-words=one two three]          # List of words to be included in the result
   -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
                                            # Default: true
   -r, [--recursive], [--no-recursive]      # Search for files recursively
                                            # Default: true
-  -v, [--version], [--no-version]          # Display version information
   -t, [--theme=THEME]                      # Vim colorscheme to use
                                            # Default: default
+  -v, [--version], [--no-version]          # Display version information
 
 Print the list of files
       EOS
@@ -55,10 +57,10 @@ Print the list of files
 
     private
 
+    # Main entry point to export the code
     #
     # @param [Hash<Symbol, Object>] options the options argument
     def execute(options = {})
-
       input_files = CodeLister.files(options)
 
       if input_files.empty?
@@ -69,24 +71,27 @@ Print the list of files
       to_htmls(input_files, options)
 
       # Search for files that we created
+      # TODO: may be use the CodeLister.files(..) instead?
       generated_files = AgileUtils::FileUtil.find(options[:base_dir])
 
       # Generate the 'index.html' file
       index_file = "#{options[:base_dir]}/index.html"
+
       IndexHtml.htmlify generated_files,
                         base_dir: options[:base_dir],
                         output: index_file
 
       # Add the missing index file
       generated_files << index_file
+
       AgileUtils::FileUtil.tar_gzip_files(generated_files, 'output.tar.gz')
+
       AgileUtils::FileUtil.delete(generated_files)
 
       # Remove the extra index.html file
       FileUtils.rm_rf(index_file)
 
-      # report the result
-      puts "Your result should be available at #{File.absolute_path('output.tar.gz')}"
+      puts "Your output file is #{File.absolute_path('output.tar.gz')}"
     end
 
     # convert multiple files to 'html'
@@ -102,12 +107,12 @@ Print the list of files
         theme: 'seoul256-light'
       }.merge(options)
 
-      raise "Invalid input file #{filename}" unless File.exists?(filename)
+      fail "Invalid input file #{filename}" unless File.exist?(filename)
 
       # sensible argument, see :help :TOhtml (from Vim)
       command = [
-        "vim",
-        "-E",
+        'vim',
+        '-E',
         "-c 'let g:html_expand_tabs = 1'",
         "-c 'let g:html_use_css = 1'",
         "-c 'let g:html_no_progress = 1'"
@@ -122,11 +127,11 @@ Print the list of files
         "-c 'w'",
         "-c 'qa!'",
         "#{filename}",
-        "> /dev/null"
+        '> /dev/null'
       ]
 
       # Note: have to run as system only
-      system(command.concat(args).join(" "))
+      system(command.concat(args).join(' '))
     end
   end
 end

data/lib/vim_printer/logger.rb

@@ -2,9 +2,9 @@ require 'logger'
 module VimPrinter
   class << self
     attr_writer :logger
-      # @return [Logger] the Logger for the project
-      def logger
-        @logger ||= Logger.new STDOUT
-      end
+    # @return [Logger] the Logger for the project
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
   end
 end

data/lib/vim_printer/version.rb

@@ -1,3 +1,3 @@
 module VimPrinter
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/lib/vim_printer.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'agile_utils'
 require 'code_lister'
 require_relative 'vim_printer/core_ext/hash'
 require_relative 'vim_printer/version'

data/test/lib/vim_printer/test_cli.rb

@@ -2,7 +2,7 @@ require_relative '../../test_helper'
 describe VimPrinter do
   context '#dummy_test' do
     it 'must work' do
-      "text".wont_be_empty
+      'text'.wont_be_empty
     end
   end
 end

data/vim_printer.gemspec

@@ -4,32 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vim_printer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "vim_printer"
+  spec.name          = 'vim_printer'
   spec.version       = VimPrinter::VERSION
-  spec.authors       = ["Burin Choomnuan"]
-  spec.email         = ["agilecreativity@gmail.com"]
+  spec.authors       = ['Burin Choomnuan']
+  spec.email         = ['agilecreativity@gmail.com']
   spec.description   = %q{Print/export files to html using the power of Vim editor}
   spec.summary       = %q{Print/export files to html using the power of Vim}
-  spec.homepage      = "https://github.com/agilecreativity/vim_printer"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/agilecreativity/vim_printer'
+  spec.license       = 'MIT'
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "thor", "~> 0.18"
-  spec.add_runtime_dependency "code_lister", "~> 0.0.6"
-  spec.add_runtime_dependency "index_html", "~> 0.0.7"
-  spec.add_runtime_dependency "agile_utils", "~> 0.0.2"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "awesome_print", "~> 1.2"
-  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
-  spec.add_development_dependency "guard-minitest", "~> 2.2"
-  spec.add_development_dependency "minitest", "~> 4.2"
-  spec.add_development_dependency "guard", "~> 2.6"
-  spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "gem-ctags", "~> 1.0"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'thor', '~> 0.18'
+  spec.add_runtime_dependency 'code_lister', '~> 0.0.6'
+  spec.add_runtime_dependency 'index_html', '~> 0.0.7'
+  spec.add_runtime_dependency 'agile_utils', '~> 0.0.4'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'awesome_print', '~> 1.2'
+  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
+  spec.add_development_dependency 'guard-minitest', '~> 2.2'
+  spec.add_development_dependency 'minitest', '~> 4.2'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'gem-ctags', '~> 1.0'
+  spec.add_development_dependency 'yard', '~> 0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vim_printer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement