vim_printer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e5a86cef7010bb8114f742c4591e7b6067aed22
+  data.tar.gz: 7d275164d3fe3e242ad70e5bb190e3f9de84d198
+SHA512:
+  metadata.gz: 681876c8a44e88a6611020a5b040acf27697736bb96557322f2f20bfe78db2e9aeb47d16f41b35b9765ae3240fbba04e309d55866d6c7c490b181faa30e529bd
+  data.tar.gz: ac5e1c4c46079a4a893bcfeccc2f6f07f8a0c19eda485f1e0d9426cb3dd5927c33b43ae465968117f7c51a89452eba2b90f5cb7d351192d4ccf65a7314b8315a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Custom ignore files
+TODOs.md
+output.tar.gz
+output.tgz

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+    - 2.1.1

data/.yardopts

@@ -0,0 +1,2 @@
+# see: http://rubydoc.info/gems/yard/file/README.md
+--no-private --protected lib/**/*.rb - README.md LICENSE

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ebook_renamer.gemspec
+gemspec
+
+gem 'code_lister', '~> 0.0.6'
+gem 'minitar'

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'minitest' do
+
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Burin Choomnuan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,192 @@
+## vim_printer
+
+Print any files to html using the power of Vim. Output will be saved to `output.tar.gz` and ready for
+extract and viewing in your favourite browser.
+
+- Unlimited support for [vim colorschemes][] if enabled, or `default` colorscheme that comes with Vim.
+- Can print any files in any languages that you can open with Vim.
+- Use the power of [Vim][] to print the code without any other tools.
+- Tested in Linux/OSX and should also works with Windows.
+
+[![Gem Version](https://badge.fury.io/rb/vim_printer.svg)](http://badge.fury.io/rb/vim_printer)
+
+### Example Outputs:
+
+- The original input using [seoul256.vim][] colorscheme in Vim
+
+![](https://github.com/agilecreativity/vim_printer/raw/master/01-seoul256-input.png)
+
+The html output as rendered in the browser
+
+![](https://github.com/agilecreativity/vim_printer/raw/master/01-seoul256-output.png)
+
+- The original input using `Tomorrow-Night` colorscheme from [Tomorrow-theme][] in Vim
+
+![](https://github.com/agilecreativity/vim_printer/raw/master/02-Tomorrow-Night-input.png)
+
+The html output as renderd in the browser
+
+![](https://github.com/agilecreativity/vim_printer/raw/master/02-Tomorrow-Night-output.png)
+
+### Requirements
+
+- [Vim][] - any recent version should be ok.
+
+- 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` scheme 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.
+
+### Sample session
+
+- Run with the sample fixture files
+
+```sh
+vim_printer print -b test/fixtures/inputs -e rb java -r
+```
+
+Will produce the file `output.tar.gz` with the following result on the screen.
+
+```
+FYI: your options {:base_dir=>"test/fixtures/inputs/", :exts=>["rb", "java"], :non_exts=>[], :inc_words=>[], :exc_words=>[], :ignore_case=>true, :recursive=>true, :version=>false, :theme=>"default"}
+
+FYI: process file 1 of 8 : test/fixtures/inputs/demo1.xxx.rb
+FYI: process file 2 of 8 : test/fixtures/inputs/demo1.yyy.rb
+FYI: process file 3 of 8 : test/fixtures/inputs/demo2.xxx.rb
+FYI: process file 4 of 8 : test/fixtures/inputs/demo2.yyy.rb
+FYI: process file 5 of 8 : test/fixtures/inputs/java/demo3.xxx.java
+FYI: process file 6 of 8 : test/fixtures/inputs/java/demo3.yyy.java
+FYI: process file 7 of 8 : test/fixtures/inputs/java/demo4.xxx.java
+FYI: process file 8 of 8 : test/fixtures/inputs/java/demo4.yyy.java
+
+Your result should be available at `output.tar.gz`
+
+```
+
+### Usage
+
+- Install the gem for your version of ruby
+
+e.g. for rbenv your session will be something like
+
+```sh
+rbenv local 2.1.1 # or whatever the version of you ruby
+rbenv rehash
+gem install vim_printer
+```
+- Print any files using the gem
+
+```sh
+vim_printer
+```
+- Print any files that you like using the simple command
+
+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
+```
+
+Your output will be saved to the default `output.tar.gz` in the directory where you run this command.
+To see the output in your browser just type:
+
+```sh
+mkdir -p ~/Desktop/vim_printer
+mv output.tar.gz ~/Desktop/vim_printer
+cd ~/Desktop/vim_printer
+tar zxvf 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
+```
+
+- For help in using the gem just type `vim_printer` without any parameter
+You should see something like the following:
+
+```
+Usage:
+  vim_printer print [OPTIONS]
+
+Options:
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # 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
+  -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
+
+Print the list of files
+```
+
+### Development/Testing
+
+```sh
+git clone https://github.com/agilecreativity/vim_printer.git
+cd vim_printer
+bundle
+# run default test
+rake
+```
+### Known Issues
+
+- Will be listed here if any.
+
+### Disclaimers
+
+- This is still early release of the gem, I may make several changes to the API.
+- If you find any issues please let me know.
+- Pull request is always welcome.
+
+### Changelog
+
+#### 0.0.1
+
+- Initial release
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Make sure that you add the tests and ensure that all tests are passed
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+[NeoBundle]: https://github.com/Shougo/neobundle.vim
+[Vim]: https://www.vim.org
+[my dotvim]: https://github.com/agilecreativity/dotvim
+[Elixir]: http://elixir-lang.org
+[vim-elixir]: https://github.com/elixir-lang/vim-elixir
+[vim colorschemes]: https://github.com/flazz/vim-colorschemes/tree/master/colors
+[seoul256.vim]: https://github.com/junegunn/seoul256.vim
+[Tomorrow-theme]: https://github.com/ChrisKempson/Tomorrow-Theme

data/Rakefile

@@ -0,0 +1,19 @@
+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.verbose = true
+end
+
+task :default => :test
+
+task :pry do
+  require 'pry'
+  require 'awesome_print'
+  require 'vim_printer'
+  include VimPrinter
+  ARGV.clear
+  Pry.start
+end

data/bin/vim_printer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/vim_printer'
+include VimPrinter
+VimPrinter::CLI.start(ARGV)

data/lib/vim_printer/cli.rb

@@ -0,0 +1,119 @@
+require 'code_lister'
+require_relative '../vim_printer'
+
+module VimPrinter
+
+  class CLI < CodeLister::BaseCLI
+
+    desc 'print', 'Print the list of files'
+
+    shared_options
+
+    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"
+    def usage
+      puts <<-EOS
+Usage:
+  vim_printer print
+
+Options:
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: /home/bchoomnuan/Dropbox/spikes/vim_printer
+  -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
+  -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
+
+Print the list of files
+      EOS
+    end
+
+    default_task :usage
+
+    private
+
+    # @param args [Hash<Symbol, Object>] options argument
+    def execute(options = {})
+
+      input_files = CodeLister.files(options)
+
+      if input_files.empty?
+        puts "No file found for your option: #{options}"
+        return
+      end
+      to_htmls(input_files, options)
+
+      # search for files that we created
+      generated_files = VimPrinter::Utility.find(options[:base_dir])
+
+      # tar.gzip them for user
+      VimPrinter::Utility.tar_gzip_files(generated_files, 'output.tar.gz')
+
+      # cleanup after ourself
+      VimPrinter::Utility.delete(generated_files)
+
+      # report the result
+      puts "Your result should be available at `output.tar.gz`"
+    end
+
+    # convert multiple files to 'html'
+    def to_htmls(files, options = {})
+      files.each_with_index do |file, index|
+        puts "FYI: process file #{index + 1} of #{files.size} : #{file}"
+        to_html(file, options)
+      end
+    end
+
+    def to_html(filename, options = {})
+      opts = {
+        theme: 'seoul256-light'
+      }.merge(options)
+
+      raise "Invalid input file #{filename}" unless File.exists?(filename)
+
+      # sensible argument, see :help :TOhtml (from Vim)
+      command = [
+        "vim",
+        "-E",
+        "-c 'let g:html_expand_tabs = 1'",
+        "-c 'let g:html_use_css = 1'",
+        "-c 'let g:html_no_progress = 1'"
+      ]
+
+      # set the colorscheme for the output
+      command.push("-c 'colorscheme #{opts[:theme]}'")
+
+      # closing arguments
+      args = [
+        "-c 'TOhtml'",
+        "-c 'w'",
+        "-c 'qa!'",
+        "#{filename}",
+        "> /dev/null"
+      ]
+
+      # Note: have to run as system only
+      system(command.concat(args).join(" "))
+    end
+  end
+end

data/lib/vim_printer/core_ext/hash.rb

@@ -0,0 +1,56 @@
+class Hash
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb
+  #
+  # hash = { name: 'Rob', age: '28' }
+  # hash.transform_keys{ |key| key.to_s.upcase }
+  # => { "NAME" => "Rob", "AGE" => "28" }
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def transform_keys!(&block)
+    keys.each do |key|
+      value = delete(key)
+      self[yield(key)] = value.is_a?(Hash) ? value.transform_keys!(&block) : value
+    end
+    self
+  end
+
+  # hash = { 'name' => 'Rob', 'age' => '28' }
+  # hash.symbolize_keys
+  # => { name: "Rob", age: "28" }
+  def symbolize_keys
+    transform_keys{ |key| key.to_sym rescue key }
+  end
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb, line 135
+  def symbolize_keys!
+    transform_keys!{ |key| key.to_sym rescue key }
+  end
+
+  # Merges the caller into +other_hash+. For example,
+  #
+  #   options = options.reverse_merge(size: 25, velocity: 10)
+  #
+  # is equivalent to
+  #
+  #   options = { size: 25, velocity: 10 }.merge(options)
+  #
+  # This is particularly useful for initializing an options hash
+  # with default values.
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+
+  # Destructive +reverse_merge+.
+  def reverse_merge!(other_hash)
+    # right wins if there is no left
+    merge!(other_hash) { |key,left,right| left }
+  end
+
+end

data/lib/vim_printer/logger.rb

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

data/lib/vim_printer/utility.rb

@@ -0,0 +1,87 @@
+require 'zlib'
+require 'stringio'
+require 'find'
+require 'fileutils'
+require 'archive/tar/minitar'
+
+module VimPrinter
+
+  include Archive::Tar
+  include Archive::Tar::Minitar
+
+  module Utility
+
+    # @todo use me when you have to!
+    CustomError = Class.new(StandardError)
+
+    class << self
+
+      # Find list of files based on certain extension
+      # @param [String] bas_dir the starting directory
+      # @param [String] extension the file extension to search for
+      #
+      # @return [Array<String>] list of matching files or empty list
+      def find(base_dir, extension = 'xhtml')
+        file_paths = []
+        Find.find(base_dir) do |path|
+          file_paths << path if path =~ /.*\.#{extension}$/
+        end
+        file_paths || []
+      end
+
+      # Tar and gzip list of files
+      #
+      # @param [Array<String>] files list of input files
+      # @param [String] output the output file in .tar.gz format
+      def tar_gzip_files(files, output = 'output.tar.gz')
+        begin
+          sgz = Zlib::GzipWriter.new(File.open(output, 'wb'))
+          tar = Minitar::Output.new(sgz)
+          files.each do |file|
+            Minitar.pack_file(file, tar)
+          end
+        ensure
+          # Closes both tar and sgz.
+          tar.close unless tar.nil?
+          tar = nil
+        end
+      end
+
+      # Delete the files from the given list
+      def delete(files)
+        # Note: should we remove the files and be done with it?
+        files.each do |file|
+          #puts "FYI: about to delete file #{file}"
+          FileUtils.rm_rf(file)
+        end
+      end
+
+      # Add suffix to each extensions
+      #
+      # @param [Array<String>] extension list of extension
+      # @param [String] suffix the suffix string
+      #
+      # @return [Array<String>] new list with the suffix added to each element
+      def add_suffix(extensions = %w(rb pdf), suffix)
+        extensions.map {|e| "#{e}.#{suffix}" }
+      end
+
+      # Time the operation before and after the operation for tuning purpose
+      def time
+        beg_time = Time.now
+        yield
+        end_time = Time.now
+        end_time - beg_time
+      end
+
+    end
+  end
+end
+
+if __FILE__ == $0
+  include VimPrinter::Utility
+  include Archive::Tar
+  include Archive::Tar::Minitar
+  files = VimPrinter::Utility.find('test/fixtures/inputs')
+  VimPrinter::Utility.tar_gzip_files(files, 'test/fixtures/output.tar.gz')
+end

data/lib/vim_printer/version.rb

@@ -0,0 +1,3 @@
+module VimPrinter
+  VERSION = "0.0.1"
+end

data/lib/vim_printer.rb

@@ -0,0 +1,7 @@
+require 'thor'
+require 'code_lister'
+require_relative 'vim_printer/core_ext/hash'
+require_relative 'vim_printer/version'
+require_relative 'vim_printer/logger'
+require_relative 'vim_printer/utility'
+require_relative 'vim_printer/cli'

data/test/fixtures/inputs/demo1.xxx.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo1.xxx.rb

data/test/fixtures/inputs/demo1.yyy.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo1.yyy.rb

data/test/fixtures/inputs/demo2.xxx.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo2.xxx.rb

data/test/fixtures/inputs/demo2.yyy.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo2.yyy.rb

data/test/fixtures/inputs/java/demo3.xxx.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo3.xxx.java

data/test/fixtures/inputs/java/demo3.yyy.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo3.yyy.java

data/test/fixtures/inputs/java/demo4.xxx.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo4.xxx.java

data/test/fixtures/inputs/java/demo4.yyy.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo4.yyy.java

data/test/fixtures/inputs/noexts1_zzz

@@ -0,0 +1 @@
+# file: spec/fixtures/noexts1_zzz

data/test/fixtures/inputs/noexts2_zzz

@@ -0,0 +1 @@
+# file: spec/fixtures/noexts2_zzz