vim_printer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307a4175693abcee3e60440a46e3d8cb223e9748
-  data.tar.gz: 00e7d3dd10f1e2d68cdef51546488daf2effff5a
+  metadata.gz: c66a1dad19aee97afbab376c433324fc873e3093
+  data.tar.gz: 56d10c7c5ef09d38e94fd78f29ffc6e2e658cb0c
 SHA512:
-  metadata.gz: 2ec0fac91f63bcaf6f5253baddc192ee9eca2ce351e38357040df6b100da437f1abff8a6349a7141e4741eddbbe5fe5fed776fe6ded2f228b6b14424a1b725ee
-  data.tar.gz: fcf2714715b12c563692619b3c2e3a55e22069600cac78f5c43e2810141ba98465be3524b466ab748b0089f8c42a57ad22d1880df0427c54cedde1ebd6982151
+  metadata.gz: 014b47117c42528e5f84e19400a85cb8fab77e02bc74d1411d6c1189194b287d7ad83f5480a36d7ce7255261d9efde8679db9dade3f3b295e74c8bad7714521c
+  data.tar.gz: 17662a26f001304382dc23d6883d73ccd3025bbf566e4d4e122722f729d81e88a4abd5831866cea7af47b1a728aa3449a9e9d8ea36ceb89db4ccd88ac1259b8b

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 # Custom ignore files
 vim_printer_output.tar.gz
+.ruby-version

data/.rubocop.yml

@@ -1 +1,96 @@
-inherit_from: rubocop-todo.yml
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+    - bin/*
+    - vim_printer.gemspec
+    - lib/**/*.rb
+    - test/**/*.rb
+
+# Avoid long parameter lists
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 4
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  Enabled: true
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+# Enforce outdenting of access modifiers (i.e. public, private, protected)
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+DoubleNegation:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/{CHANGELOGS.md → CHANGELOG.md}

@@ -1,5 +1,10 @@
 ### Changelog
 
+#### 0.1.3
+
+- Simplify the CLI interface
+- Cleanup style with rubocop
+
 #### 0.1.2
 
 - Minor code cleanup

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ebook_renamer.gemspec
 gemspec

data/README.md

@@ -40,19 +40,13 @@ The html output as renderd in the browser
 - Any decent `~/.vimrc` should do
 
   * There are so many great vim dotfiles in github repos.
-
   * [NeoBundle][] is a very good start if you are new to Vim.
-
   * If you like you can use [my dotvim][] which is based on the [NeoBundle][].
-
   * Use any [vim colorschemes][] if not the `default` colorscheme will be used.
-
     My personal favourite are [seoul256.vim][] and [Tomorrow-Theme][]
 
 - Any valid file types that are supported by Vim will be shown proper color in the output.
-
   * By default Vim comes with supported for major languages so you should see the proper syntax with color in the output.
-
   * On newer language like [Elixir][], you may have to first install [vim-elixir][] to see the proper syntax in the output.
     If this is not installed then you will get the output but will not have the beautiful color syntax.
 
@@ -61,7 +55,7 @@ The html output as renderd in the browser
 - Run with the sample fixture files
 
 ```sh
-vim_printer print -b test/fixtures/inputs -e rb java -r
+vim_printer -b test/fixtures/inputs -e rb java -r
 ```
 
 Will produce the file `output.tar.gz` with the following result on the screen.
@@ -100,9 +94,9 @@ The following command will print out all java, and ruby files recursively
 using the `solarized` colorscheme.
 
 ```sh
-vim_printer print --base-dir ./test/fixtures \
-                  --exts rb \
-                  --theme solarized
+vim_printer --base-dir ./test/fixtures \
+            --exts rb \
+            --theme solarized
 ```
 
 Your output will be saved to the default `output.tar.gz` in the directory where you run this command.
@@ -118,10 +112,10 @@ tar zxvf vim_printer_output.tar.gz
 - Print only files that contain the word `xxx` in the title
 
 ```sh
-vim_printer print --base-dir ./test/fixtures \
-                  --exts java \
-                  --theme solarized \
-                  --n xxx
+vim_printer --base-dir ./test/fixtures \
+            --exts java \
+            --theme solarized \
+            --n xxx
 ```
 
 - For help in using the gem just type `vim_printer` without any parameter
@@ -129,7 +123,7 @@ You should see something like the following:
 
 ```
 Usage:
-  vim_printer print [OPTIONS]
+  vim_printer
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory

data/Rakefile

@@ -1,15 +1,15 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 Rake::TestTask.new do |t|
-  t.libs << 'lib/vim_printer'
-  t.test_files = FileList['test/lib/vim_printer/test_*.rb']
+  t.libs << "lib/vim_printer"
+  t.test_files = FileList["test/lib/vim_printer/test_*.rb"]
   t.verbose = true
 end
 task default: :test
 task :pry do
-  require 'pry'
-  require 'awesome_print'
-  require 'vim_printer'
+  require "pry"
+  require "awesome_print"
+  require "vim_printer"
   include VimPrinter
   ARGV.clear
   Pry.start

data/bin/vim_printer

@@ -1,4 +1,8 @@
 #!/usr/bin/env ruby
-require_relative '../lib/vim_printer'
+require_relative "../lib/vim_printer"
 include VimPrinter
-VimPrinter::CLI.start(ARGV)
+if ARGV.empty?
+  VimPrinter::CLI.start(%w[usage])
+else
+  VimPrinter::CLI.start(%w[print].concat(ARGV))
+end

data/lib/vim_printer.rb

@@ -1,6 +1,6 @@
-require 'thor'
-require 'agile_utils'
-require 'code_lister'
-require_relative 'vim_printer/version'
-require_relative 'vim_printer/logger'
-require_relative 'vim_printer/cli'
+require "thor"
+require "agile_utils"
+require "code_lister"
+require_relative "vim_printer/version"
+require_relative "vim_printer/logger"
+require_relative "vim_printer/cli"

data/lib/vim_printer/cli.rb

@@ -1,15 +1,13 @@
-require 'agile_utils'
-require 'code_lister'
-require 'index_html'
-require 'fileutils'
-require_relative '../vim_printer'
-
+require "agile_utils"
+require "code_lister"
+require "index_html"
+require "fileutils"
+require_relative "../vim_printer"
 module VimPrinter
   include AgileUtils
 
   class CLI < Thor
-    desc 'print', 'Print the list of files'
-
+    desc "print", "Print the list of files"
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::EXTS
     method_option *AgileUtils::Options::NON_EXTS
@@ -18,11 +16,10 @@ module VimPrinter
     method_option *AgileUtils::Options::IGNORE_CASE
     method_option *AgileUtils::Options::RECURSIVE
     method_option *AgileUtils::Options::VERSION
-
     method_option :theme,
-                  aliases: '-t',
-                  desc: 'Vim colorscheme to use',
-                  default: 'default'
+                  aliases: "-t",
+                  desc: "Vim colorscheme to use",
+                  default: "default"
     def print
       opts = options.symbolize_keys
       if opts[:version]
@@ -32,11 +29,11 @@ module VimPrinter
       execute(opts)
     end
 
-    desc 'usage', 'Display help screen'
+    desc "usage", "Display help screen"
     def usage
       puts <<-EOS
 Usage:
-  vim_printer print [OPTIONS]
+  vim_printer
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
@@ -59,7 +56,7 @@ Print the list of files
 
     default_task :usage
 
-    private
+  private
 
     # Main entry point to export the code
     #
@@ -79,7 +76,7 @@ Print the list of files
         "#{f}.xhtml"
       end
 
-      index_file = './index.html'
+      index_file = "./index.html"
 
       IndexHtml.htmlify generated_files,
                         base_dir: options[:base_dir],
@@ -88,14 +85,14 @@ Print the list of files
       # Add the missing index file
       generated_files << index_file
 
-      AgileUtils::FileUtil.tar_gzip_files(generated_files, 'vim_printer_output.tar.gz')
+      AgileUtils::FileUtil.tar_gzip_files(generated_files, "vim_printer_output.tar.gz")
 
       AgileUtils::FileUtil.delete(generated_files)
 
       # Remove the extra index.html file
       FileUtils.rm_rf(index_file)
 
-      puts "Your output file is #{File.absolute_path('vim_printer_output.tar.gz')}"
+      puts "Your output file is #{File.absolute_path("vim_printer_output.tar.gz")}"
     end
 
     # convert multiple files to 'html'
@@ -109,15 +106,15 @@ Print the list of files
 
     def to_html(filename, options = {})
       opts = {
-        theme: 'seoul256-light'
+        theme: "seoul256-light"
       }.merge(options)
 
       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'"
@@ -132,10 +129,9 @@ Print the list of files
         "-c 'w'",
         "-c 'qa!'",
         "#{filename}",
-        '> /dev/null'
+        "> /dev/null"
       ]
-
-      system(command.concat(args).join(' '))
+      system(command.concat(args).join(" "))
     end
   end
 end

data/lib/vim_printer/logger.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 module VimPrinter
   class << self
     attr_writer :logger

data/lib/vim_printer/version.rb

@@ -1,3 +1,3 @@
 module VimPrinter
-  VERSION = '0.1.2'
+  VERSION = "0.1.3"
 end

data/test/lib/vim_printer/test_cli.rb

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

data/test/test_helper.rb

@@ -1,6 +1,6 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'minitest-spec-context'
-require 'awesome_print'
-require 'pry'
-require_relative '../lib/vim_printer'
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest-spec-context"
+require "awesome_print"
+require "pry"
+require_relative "../lib/vim_printer"

data/vim_printer.gemspec

@@ -1,42 +1,41 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'vim_printer/version'
-
+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(Batch convert multiple files to htmls using the power of Vim editor)
   spec.summary       = %q(Batch convert multiple files to htmls using the power of Vim.
                           Work will any languages that can be open with Vim e.g. any non-binary files.)
-  spec.homepage      = 'https://github.com/agilecreativity/vim_printer'
-  spec.license       = 'MIT'
-  spec.files         = Dir.glob('{bin,lib}/**/*') + %w(Gemfile
+  spec.homepage      = "https://github.com/agilecreativity/vim_printer"
+  spec.license       = "MIT"
+  spec.files         = Dir.glob("{bin,lib}/**/*") + %w[Gemfile
                                                        Rakefile
                                                        vim_printer.gemspec
                                                        README.md
-                                                       CHANGELOGS.md
+                                                       CHANGELOG.md
                                                        LICENSE
                                                        .rubocop.yml
-                                                       .gitignore)
+                                                       .gitignore]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = Dir.glob('{test}/**/*')
-  spec.require_paths = ['lib']
-  spec.add_runtime_dependency 'thor', '~> 0.19'
-  spec.add_runtime_dependency 'code_lister', '~> 0.1'
-  spec.add_runtime_dependency 'index_html', '~> 0.1'
-  spec.add_runtime_dependency 'agile_utils', '~> 0.1'
-  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', '~> 5.3'
-  spec.add_development_dependency 'guard', '~> 2.6'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'rubocop', '~> 0.20'
-  spec.add_development_dependency 'gem-ctags', '~> 1.0'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.test_files    = Dir.glob("{test}/**/*")
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "code_lister", "~> 0.1"
+  spec.add_runtime_dependency "index_html", "~> 0.1"
+  spec.add_runtime_dependency "agile_utils", "~> 0.1"
+  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", "~> 5.3"
+  spec.add_development_dependency "guard", "~> 2.6"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rubocop", "~> 0.20"
+  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.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -230,7 +230,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- CHANGELOGS.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -250,6 +250,7 @@ files:
 - test/fixtures/inputs/java/demo4.yyy.java
 - test/fixtures/inputs/noexts1_zzz
 - test/fixtures/inputs/noexts2_zzz
+- test/fixtures/inputs/vim_printer_output.tar.gz
 - test/fixtures/outputs/demo1.xxx.rb.xhtml
 - test/fixtures/outputs/demo1.yyy.rb.xhtml
 - test/fixtures/outputs/demo2.xxx.rb.xhtml
@@ -287,24 +288,25 @@ specification_version: 4
 summary: Batch convert multiple files to htmls using the power of Vim. Work will any
   languages that can be open with Vim e.g. any non-binary files.
 test_files:
-- test/lib/vim_printer/test_cli.rb
-- test/test_helper.rb
-- test/fixtures/outputs/demo1.xxx.rb.xhtml
-- test/fixtures/outputs/java/demo3.xxx.java.xhtml
-- test/fixtures/outputs/java/demo4.yyy.java.xhtml
-- test/fixtures/outputs/java/demo3.yyy.java.xhtml
-- test/fixtures/outputs/java/demo4.xxx.java.xhtml
-- test/fixtures/outputs/demo2.xxx.rb.xhtml
-- test/fixtures/outputs/demo1.yyy.rb.xhtml
-- test/fixtures/outputs/demo2.yyy.rb.xhtml
-- test/fixtures/inputs/noexts2_zzz
+- test/fixtures/inputs/demo1.xxx.rb
+- test/fixtures/inputs/demo1.yyy.rb
+- test/fixtures/inputs/demo2.xxx.rb
+- test/fixtures/inputs/demo2.yyy.rb
 - test/fixtures/inputs/java/demo3.xxx.java
-- test/fixtures/inputs/java/demo4.xxx.java
 - test/fixtures/inputs/java/demo3.yyy.java
+- test/fixtures/inputs/java/demo4.xxx.java
 - test/fixtures/inputs/java/demo4.yyy.java
-- test/fixtures/inputs/demo2.yyy.rb
-- test/fixtures/inputs/demo1.yyy.rb
-- test/fixtures/inputs/demo2.xxx.rb
 - test/fixtures/inputs/noexts1_zzz
-- test/fixtures/inputs/demo1.xxx.rb
+- test/fixtures/inputs/noexts2_zzz
+- test/fixtures/inputs/vim_printer_output.tar.gz
+- test/fixtures/outputs/demo1.xxx.rb.xhtml
+- test/fixtures/outputs/demo1.yyy.rb.xhtml
+- test/fixtures/outputs/demo2.xxx.rb.xhtml
+- test/fixtures/outputs/demo2.yyy.rb.xhtml
+- test/fixtures/outputs/java/demo3.xxx.java.xhtml
+- test/fixtures/outputs/java/demo3.yyy.java.xhtml
+- test/fixtures/outputs/java/demo4.xxx.java.xhtml
+- test/fixtures/outputs/java/demo4.yyy.java.xhtml
+- test/lib/vim_printer/test_cli.rb
+- test/test_helper.rb
 has_rdoc: