source2epub 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f299d11976795d47690cece2efa4bc4ea9316ff
+  data.tar.gz: bb336cc7e6ae40e84932e7858ceeb73cbe46336d
+SHA512:
+  metadata.gz: 36bf6a16682d5465af14894c65dff2c8e02213cc215603c094d105b049c2079136b8993e9a13bc34c1e426fca2d73d9424f5569c652f52f641db4177919b991a
+  data.tar.gz: 826b9269ca56d14cf32310a9527e80627ae6d36f405b719c7173e6099e3b8ee709f87a7fe1d1ff7f6dcb45adf6ec3508f082fde6d11e5ad8fc1eabe71b07be64

data/.gitignore

@@ -0,0 +1,20 @@
+*.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 generated files
+.ruby-version
+.epub

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+    - bin/*
+    - source2epub.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
+
+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
+
+# Use spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: 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
+
+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/CHANGELOG.md

@@ -0,0 +1,3 @@
+#### 0.2.0
+
+- Initial public release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,170 @@
+## source2epub
+
+[![Gem Version](https://badge.fury.io/rb/source2epub.svg)][gem]
+[![Dependency Status](https://gemnasium.com/agilecreativity/source2epub.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/agilecreativity/source2epub.png)][codeclimate]
+
+[gem]: http://badge.fury.io/rb/source2epub
+[gemnasium]: https://gemnasium.com/agilecreativity/source2epub
+[codeclimate]: https://codeclimate.com/github/agilecreativity/source2epub
+
+- Export/print content of any git repositores (or local project directory) to single epub file for quick review offline.
+
+- Work with [Github][] or [BitBucket][] project or your own git servers
+
+- Thanks to the power of [eeepub gem][] and `:TOhtml` feature of [Vim][].
+
+- Support by your favourite reading devices that support 'epub' format (computer, phone, tablet, etc) that
+
+- Support unlimited color scheme as it is based on output from [Vim][] editor
+
+- Here is the [sample epub file](/samples/source2epub_default_colorscheme.epub) of [source2epub][] produced by `source2epub`
+
+### Related projects
+
+- [source2pdf][] generate the output of the git or local project to a pdf file
+- [code_rippa][] gererate pdf file with the help of LaTeX
+
+### Requirements
+
+- Valid installation of [Vim][] required by [vim_printer][] gem
+
+### Installation
+
+```
+gem install source2epub
+```
+
+### Synopsis/Usage
+
+```
+
+Usage:
+
+  $source2epub -e, --exts=EXT1 EXT2 EXT3 -u, --url=URL -theme=theme_name
+
+Example:
+
+  # Export the *.rb from the given repository
+
+  $source2epub -u https://github.com/agilecreativity/source2epub.git -e rb
+
+  # Export the *.rb and also 'Gemfile' from a local directory 'source2epub'
+  # Note: must be one directory directly above the current directory
+
+  $source2epub -u source2epub -e rb -f Gemfile
+
+  # Export the *.rb and also 'Gemfile' from a given directory 'source2epub'
+  # using 'solarized' theme
+  # Note: 'source2epub' must be exactly one level above current directory
+
+  $source2epub -u source2epub -e rb -f Gemfile -t solarized
+
+Options:
+
+  -u, --url=URL                   # The full url of the github project to be cloned or local directory name (mandatory)
+                                  # e.g. -u https://github.com/agilecreativity/source2epub
+                                  # Or if used with the project already exist locally
+                                  #      -u source2epub
+
+  -e, --exts=EXT1 EXT2 EXT3 ..    # The list of extension names to be exported (mandatory)
+                                  # e.g. -e md rb
+
+  -f, [--non-exts=one two three]  # The list of file without extension to be exported (optional)
+                                  # e.g. -f Gemfile LICENSE
+
+  -t, [--theme=theme_name]        # The theme to be used with vim_printer see :help :colorscheme from inside Vim
+                                  # default: 'default'
+                                  # e.g. -t solarized
+
+  -p, [--epub-title=title]        # The title of the epub output, if not specified the project_name will be used
+                                  # e.g. -p 'My Cool Project'
+                                  #
+  -s, [--command]                 # Use the input file list from the result of the given shell command
+                                  # Note: the command must return the list of file to be valid
+                                  # e.g. --command 'find . -type f -iname "*.rb" | grep -v test | grep -v _spec'
+
+Export a given github URL or local project directory to an epub file"
+
+```
+
+### Sample Usage:
+
+```shell
+source2epub -u https://github.com/agilecreativity/source2epub.git -e rb
+```
+
+Should result in something similar to this in the console
+
+```
+FYI: list of extensions: ["gem", "gemspec", "lock", "md", "rb"]
+FYI: list of all files : ["./config/initializers/source2epub.rb", "./lib/source2epub.rb", "./lib/source2epub/cli.rb", "./lib/source2epub/configuration.rb", "./lib/source2epub/exporter.rb", "./lib/source2epub/logger.rb", "./lib/source2epub/source2epub.rb", "./lib/source2epub/version.rb", "./test/lib/source2epub/test_source2epub.rb", "./test/test_helper.rb"]
+FYI: process file 1 of 10 : ./config/initializers/source2epub.rb
+FYI: process file 2 of 10 : ./lib/source2epub.rb
+FYI: process file 3 of 10 : ./lib/source2epub/cli.rb
+FYI: process file 4 of 10 : ./lib/source2epub/configuration.rb
+FYI: process file 5 of 10 : ./lib/source2epub/exporter.rb
+FYI: process file 6 of 10 : ./lib/source2epub/logger.rb
+FYI: process file 7 of 10 : ./lib/source2epub/source2epub.rb
+FYI: process file 8 of 10 : ./lib/source2epub/version.rb
+FYI: process file 9 of 10 : ./test/lib/source2epub/test_source2epub.rb
+FYI: process file 10 of 10 : ./test/test_helper.rb
+Your output file is './source2epub/vim_printer_source2epub.tar.gz'
+Your final output is ./source2epub.epub
+```
+
+### Sample Output
+
+#### Using the 'default' theme/colorscheme for Vim
+
+```shell
+source2epub -u https://github.com/agilecreativity/code2epub.git --exts rb
+```
+
+Which generated the following [epub output file](/samples/source2epub_default_colorscheme.epub)
+
+The example screenshot:
+
+![](/samples/source2epub_default_colorscheme.png)
+
+#### Use non-default colorscheme/theme for Vim
+
+Use my personal favourite [seoul256][] colorscheme
+
+```shell
+source2epub -u https://github.com/agilecreativity/source2epub.git --exts rb --theme seoul256
+```
+
+Which generated the following [pdf output file](/samples/source2epub_seoul256_colorscheme.epub)
+
+The example screenshot:
+
+![](/samples/source2epub_seoul256_colorscheme.png)
+
+### 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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[thor]: https://github.com/erikhuda/thor
+[minitest]: https://github.com/seattlerb/minitest
+[yard]: https://github.com/lsegal/yard
+[pry]: https://github.com/pry/pry
+[rubocop]: https://github.com/bbatsov/rubocop
+[grit]: https://github.com/mojombo/grit
+[Ghostscript]: http://todo.com/
+[Wkhtmltopdf]: http://todo.com/
+[Vim]: http://www.vim.org
+[vim_printer]: https://github.com/agilecreativity/vim_printer
+[pdfs2pdf]: https://github.com/agilecreativity/pdfs2pdf
+[html2pdf]: https://github.com/agilecreativity/html2pdf
+[monokai]: https://github.com/lsdr/monokai
+[seoul256]: https://github.com/junegunn/seoul256.vim
+[Github]: http://www.github.com
+[BitBucket]: http://www.bitbucket.org
+[source2pdf]: https://github.com/agilecreativity/source2pdf
+[source2epub]: https://github.com/agilecreativity/source2epub
+[code_rippa]: https://github.com/benjamintanweihao/code_rippa

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+project_name = "source2epub"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib/#{project_name}"
+  t.test_files = FileList["test/lib/#{project_name}/test_*.rb"]
+  t.verbose = true
+end
+
+task default: [:test, :rubocop]
+task :pry do
+  require "pry"
+  require "awesome_print"
+  require_relative "lib/source2epub"
+  include Source2Epub
+  ARGV.clear
+  Pry.start
+end
+
+require "rubocop/rake_task"
+desc "Run RuboCop on the lib directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb"]
+  task.formatters = ["files"]
+  task.fail_on_error = false
+end

data/bin/source2epub

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative "../lib/source2epub"
+require_relative "../config/initializers/source2epub"
+include Source2Epub
+if ARGV.empty?
+  Source2Epub::CLI.start(%w[usage])
+else
+  Source2Epub::CLI.start(%w[export].concat(ARGV))
+end

data/config/initializers/source2epub.rb

@@ -0,0 +1,13 @@
+module Source2Epub
+  class << self
+    # ./lib/source2epub/configuration.rb
+    def update_config
+      Source2Epub.configure do |config|
+        config.creator        = "Burin C"
+        config.publisher      = "Burin C"
+        config.published_date = "2014-06-23" # TODO: get the current date
+        config.identifier     = "https://agilecreativity.com/"
+      end
+    end
+  end
+end

data/lib/source2epub.rb

@@ -0,0 +1,6 @@
+require_relative "source2epub/version"
+require_relative "source2epub/logger"
+require_relative "source2epub/source2epub"
+require_relative "source2epub/exporter"
+require_relative "source2epub/cli"
+include Source2Epub

data/lib/source2epub/cli.rb

@@ -0,0 +1,97 @@
+require "thor"
+require "vim_printer"
+require_relative "source2epub"
+
+module Source2Epub
+  class CLI < Thor
+    desc "export", "Export a given github URL or local project directory to an epub file"
+    method_option "url",
+                  aliases:  "-u",
+                  desc:     "The full url of the github project to be cloned or a directory name (mandtory)",
+                  required: true
+    method_option "exts",
+                  type:     :array,
+                  aliases:  "-e",
+                  desc:     "The list of file extension to be exported",
+                  default: []
+    method_option "non_exts",
+                  type:     :array,
+                  aliases:  "-f",
+                  desc:     "The list of file without extension to be exported",
+                  default: []
+    method_option "theme",
+                  aliases:  "-t",
+                  desc:     "The theme to be used with vim_printer",
+                  default:  "default"
+    method_option "command",
+                  aliases: "-s",
+                  desc: "Use input file list from the result of the given shell command"
+    method_option "epub_title",
+                  aliases: "-p",
+                  desc: "Title to be used for output epub (default to project_name)"
+    def export
+      exporter = Source2Epub::Exporter.new options[:url],
+                                           exts:       options[:exts],
+                                           non_exts:   options[:non_exts],
+                                           theme:      options[:theme],
+                                           command:    options[:command],
+                                           epub_title: options[:epub_title]
+      exporter.export
+    end
+
+    desc "usage", "Display help screen"
+    def usage
+      puts <<-EOS
+Usage:
+
+  $source2epub -u, --url=URL -e, --exts=EXT1 EXT2 EXT3 -t, -theme=theme_name
+
+Example:
+
+  # Export the *.rb from the given repository
+
+  $source2epub -u https://github.com/agilecreativity/source2epub.git -e rb
+
+  # Export the *.rb and also 'Gemfile' from a local directory 'source2epub'
+  # Note: must be one directory directly above the current directory
+
+  $source2epub -u source2epub -e rb -f Gemfile
+
+  # Export the *.rb and also 'Gemfile' from a given directory 'source2epub'
+  # using 'solarized' theme
+  # Note: 'source2epub' must be exactly one level above current directory
+
+  $source2epub -u source2epub -e rb -f Gemfile -t solarized
+
+Options:
+
+  -u, --url=URL                   # The full url of the github project to be cloned or local directory name (mandatory)
+                                  # e.g. -u https://github.com/agilecreativity/source2epub
+                                  # Or if used with the project already exist locally
+                                  #      -u source2epub
+
+  -e, --exts=EXT1 EXT2 EXT3 ..    # The list of extension names to be exported (mandatory)
+                                  # e.g. -e md rb
+
+  -f, [--non-exts=one two three]  # The list of file without extension to be exported (optional)
+                                  # e.g. -f Gemfile LICENSE
+
+  -t, [--theme=theme_name]        # The theme to be used with vim_printer see :help :colorscheme from inside Vim
+                                  # default: 'default'
+                                  # e.g. -t solarized
+
+  -p, [--epub-title=title]        # The title of the epub output, if not specified the project_name will be used
+                                  # e.g. -p 'My Cool Project'
+                                  #
+  -s, [--command]                 # Use the input file list from the result of the given shell command
+                                  # Note: the command must return the list of file to be valid
+                                  # e.g. --command 'find . -type f -iname "*.rb" | grep -v test | grep -v _spec'
+
+Export a given git URL or local project directory to an epub file"
+
+      EOS
+    end
+
+    default_task :usage
+  end
+end

data/lib/source2epub/configuration.rb

@@ -0,0 +1,33 @@
+module Source2Epub
+  class Configuration
+    attr_accessor :creator,
+                  :publisher,
+                  :published_date,
+                  :identifier,
+    def initialize
+      @creator        = "https://github.com/agilecreativity/source2epub"
+      @publisher      = "http://agilecreativity.com"
+      @published_date = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+      @identifier     = "https://agilecreativity.com/"
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure Source2Epub someplace sensible, like
+    #
+    # 'config/initializers/source2epub.rb'
+    #
+    # Source2Epub.configure do |config|
+    #   config.creator = ".."
+    # end
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/source2epub/exporter.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/env ruby
+require "uri"
+require "agile_utils"
+require "eeepub"
+require_relative "../source2epub"
+module Source2Epub
+  TMP_DIR = "source2epub_tmp"
+  class Exporter
+    attr_reader :url,
+                :exts,
+                :non_exts,
+                :theme,
+                :command,
+                :epub_title
+    attr_reader :base_dir,
+                :repo_name,
+                :output_path
+
+    # Constructor for Executor
+    #
+    # @param [String] url the input URL like
+    #        https://github.com/opal/opal.git or just the immediat folder name
+    # @param [Hash<Symbol,Object>] opts the option hash
+    #
+    # @option opts [Array<String>] :exts the list of file extension to be used
+    # @option opts [Array<String>] :non_exts the list of file without extension to be used
+    # @option opts [String]        :theme the theme to use for `vim_printer`
+    def initialize(url, opts = {})
+      @url         = url
+      @base_dir    = Dir.pwd
+      @exts        = opts[:exts]     || []
+      @non_exts    = opts[:non_exts] || []
+      @theme       = opts[:theme]    || "default"
+      @command     = opts[:command]
+      @repo_name   = project_name(url)
+      @epub_title  = opts[:epub_title] || @repo_name
+      @output_path = File.expand_path([base_dir, repo_name].join(File::SEPARATOR))
+    end
+
+    # Print and export the source from a given URL to an epub file
+    def export
+      clone
+      puts "FYI: list of extensions: #{all_extensions}"
+      # Note: if we are using the '--command', it will be empty list by default
+      puts "FYI: list of all files : #{all_files}" unless all_files.empty?
+      files2htmls
+      htmls2epub
+      copy_output
+      cleanup
+    end
+
+  private
+
+    def clone
+      if File.exist?(output_path)
+        puts "The project #{output_path} already exist, no git clone needed!"
+        return
+      end
+      Source2Epub.clone_repository(url, repo_name, base_dir)
+    end
+
+    # List all extensions
+    def all_extensions
+      all_exts = Source2Epub.list_extensions(output_path)
+      # Strip off the '.' in the output if any.
+      all_exts.map! { |e| e.gsub(/^\./, "") }
+      all_exts
+    end
+
+    # List all files base on simple criteria
+    def all_files
+      files = []
+      if input_available?
+        files = Source2Epub.list_files base_dir:  output_path,
+                                       exts:      exts,
+                                       non_exts:  non_exts,
+                                       recursive: true
+      end
+      files
+    end
+
+    # Convert files to htmls
+    def files2htmls
+      if command
+        Source2Epub.files_to_htmls base_dir: output_path,
+                                   theme:    theme,
+                                   command:  command
+      elsif input_available?
+        Source2Epub.files_to_htmls base_dir: output_path,
+                                   exts:     exts,
+                                   non_exts: non_exts,
+                                   theme:    theme
+      end
+    end
+
+    # Convert list of html to list of epub file
+    def htmls2epub
+      input_file = File.expand_path("#{output_path}/vim_printer_#{repo_name}.tar.gz")
+
+      if File.exist?(input_file)
+        FileUtils.mkdir_p output_dir
+        AgileUtils::FileUtil.gunzip input_file, output_dir
+        xhtml_files = CodeLister.files base_dir:  output_dir,
+                                       recursive: true,
+                                       exts:      %w[xhtml],
+                                       non_exts:  []
+        project_dir = File.expand_path(File.dirname(output_dir) + "../../#{Source2Epub::TMP_DIR}/#{repo_name}")
+
+        xhtml_files.map! do |f|
+          File.expand_path(f.gsub(/^\./, project_dir))
+        end
+
+        nav_list = nav_index(xhtml_files, project_dir)
+        # Note: need to assign the local varaiable for this to work
+        title = epub_title
+        epub = EeePub.make do
+          title title
+          creator Source2Epub.configuration.creator
+          publisher Source2Epub.configuration.publisher
+          date Source2Epub.configuration.published_date
+          identifier Source2Epub.configuration.identifier, scheme: "URL"
+          files(xhtml_files)
+          nav nav_list
+        end
+        epub.save(output_filename)
+      end
+    end
+
+    # Create the navigation list from list of file
+    #
+    # @param [Array<String>] files list of input file
+    # @param [String] prefix_dir the prefix directory
+    # @return [List<Hash<Symbol, String>>] list of navigation content hash
+    def nav_index(files = [], prefix_dir)
+      nav_list = []
+      padding = files.size.to_s.length
+      files.each_with_index do |file, index|
+        # still we have "somfile.ext.xhtml" at this point
+        formatted_name = file.gsub("#{prefix_dir}/", "")
+        nav_list << {
+          label:   format("%0#{padding}d : %s", index + 1, File.basename(formatted_name, ".*")),
+          content: File.basename(file)
+        }
+      end
+      nav_list
+    end
+
+    def output_dir
+      File.expand_path("#{base_dir}/#{Source2Epub::TMP_DIR}/#{repo_name}")
+    end
+
+    def output_filename
+      File.expand_path([File.dirname(output_dir), "#{repo_name}.epub"].join(File::SEPARATOR))
+    end
+
+    def input_available?
+      (exts && !exts.empty?) || (non_exts && !non_exts.empty?)
+    end
+
+    # Extract project name from a given URL
+    #
+    # @param [String] uri input uri
+    #  e.g.
+    #  project_name('https://github.com/erikhuda/thor.git') #=> 'thor'
+    #  project_name('https://github.com/erikhuda/thor')     #=> 'thor'
+    def project_name(uri)
+      if uri
+        name = URI(uri).path.split(File::SEPARATOR).last
+        # strip the '.' if any
+        File.basename(name, ".*") if name
+      end
+    end
+
+    def copy_output
+      if File.exist?(output_filename)
+        destination_file = File.expand_path(File.dirname(output_dir) + "../../#{repo_name}.epub")
+        FileUtils.mv output_filename, destination_file
+        puts "Your final output is #{File.expand_path(destination_file)}"
+      end
+    end
+
+    def cleanup
+      FileUtils.rm_rf File.expand_path(File.dirname(output_dir) + "../../#{Source2Epub::TMP_DIR}")
+      # Also remove the 'vim_printer_#{repo_name}.tar.gz' if we have one
+      FileUtils.rm_rf File.expand_path(File.dirname(output_dir) + "../../#{repo_name}/vim_printer_#{repo_name}.tar.gz")
+    end
+  end
+end

data/lib/source2epub/logger.rb

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

data/lib/source2epub/source2epub.rb

@@ -0,0 +1,73 @@
+require "git"
+require "code_lister"
+require_relative "./configuration"
+module Source2Epub
+  CustomError = Class.new(StandardError)
+  class << self
+    # Clone the given repository from github
+    #
+    # @param [String] url the github repository url like 'https://github.com/schacon/ruby-git.git'
+    # @param [String] name the output name to be used
+    # @param [String] path the output directory
+    def clone_repository(url, name, path)
+      puts "git clone #{url} #{File.expand_path(path)}/#{name}"
+      Git.clone url, name, path: File.expand_path(path)
+    end
+
+    def list_extensions(base_dir = ".")
+      extensions = Dir.glob(File.join(File.expand_path(base_dir), "**/*")).reduce([]) do |exts, file|
+        exts << File.extname(file)
+      end
+      extensions.sort.uniq.delete_if { |e| e == "" }
+    end
+
+    def list_files(options = {})
+      CodeLister.files(options)
+    end
+
+    def files_to_htmls(opts)
+      base_dir = base_dir(opts[:base_dir])
+      unless File.exist?(base_dir) && File.directory?(base_dir)
+        fail "Starting directory must be valid, and exist"
+      end
+
+      exts     = opts[:exts]     || []
+      non_exts = opts[:non_exts] || []
+      theme    = opts.fetch(:theme, "default")
+      command  = opts[:command]
+
+      if command
+        args = [
+          "print",
+          "--base-dir",
+          base_dir,
+          "--command",
+          command,
+          "--theme",
+          theme
+        ]
+      else
+        args = [
+          "print",
+          "--base-dir",
+          base_dir,
+          "--exts",
+          exts,
+          "--theme",
+          theme,
+          "--recursive"
+        ]
+        args.concat(["--non-exts"]).concat(non_exts) unless non_exts.empty?
+      end
+      # puts "FYI: input options for vim_printer #{args}"
+      VimPrinter::CLI.start(args)
+    end
+
+  private
+
+    # Always expand the directory name so that '~' or '.' is expanded correctly
+    def base_dir(dir_name)
+      File.expand_path(dir_name)
+    end
+  end
+end

data/lib/source2epub/version.rb

@@ -0,0 +1,3 @@
+module Source2Epub
+  VERSION = "0.2.0"
+end

data/source2epub.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "source2epub/version"
+Gem::Specification.new do |spec|
+  spec.name          = "source2epub"
+  spec.version       = Source2Epub::VERSION
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
+  spec.summary       = %q(Export any project from git repository or local directory to a single epub file)
+  spec.description   = %q{Export any project from git repository or local directory to a single epub file.
+                          Combine useful features of the following ruby gems
+                          (vim_printer, eeepub and others)
+                          to produce a single epub file that can be view by any device where epub is supported.
+                         }
+  spec.homepage      = "https://github.com/agilecreativity/source2epub"
+  spec.license       = "MIT"
+  spec.files         = Dir.glob("{bin,lib,config}/**/*") + %w[Gemfile
+                                                              Rakefile
+                                                              source2epub.gemspec
+                                                              README.md
+                                                              CHANGELOG.md
+                                                              LICENSE
+                                                              .rubocop.yml
+                                                              .gitignore]
+  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.19.1"
+  spec.add_runtime_dependency "git", "~> 1.2.7"
+  spec.add_runtime_dependency "awesome_print", "~> 1.2.0"
+  spec.add_runtime_dependency "agile_utils", "~> 0.2.0"
+  spec.add_runtime_dependency "code_lister", "~> 0.2.0"
+  spec.add_runtime_dependency "vim_printer", "~> 0.2.0"
+  spec.add_runtime_dependency "eeepub", "~> 0.8.1"
+  spec.add_development_dependency "bundler", "~> 1.6.2"
+  spec.add_development_dependency "gem-ctags", "~> 1.0.6"
+  spec.add_development_dependency "guard", "~> 2.6.1"
+  spec.add_development_dependency "guard-minitest", "~> 2.3.0"
+  spec.add_development_dependency "minitest", "~> 5.3.5"
+  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "pry-byebug", "~> 1.3.3"
+  spec.add_development_dependency "rake", "~> 10.3.2"
+  spec.add_development_dependency "rubocop", "~> 0.24.1"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+end

metadata

@@ -0,0 +1,320 @@
+--- !ruby/object:Gem::Specification
+name: source2epub
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Burin Choomnuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: agile_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: code_lister
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: vim_printer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: eeepub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: gem-ctags
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.5
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: "Export any project from git repository or local directory to a single
+  epub file.\n                          Combine useful features of the following ruby
+  gems\n                          (vim_printer, eeepub and others)\n                          to
+  produce a single epub file that can be view by any device where epub is supported.\n
+  \                        "
+email:
+- agilecreativity@gmail.com
+executables:
+- source2epub
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/source2epub
+- config/initializers/source2epub.rb
+- lib/source2epub.rb
+- lib/source2epub/cli.rb
+- lib/source2epub/configuration.rb
+- lib/source2epub/exporter.rb
+- lib/source2epub/logger.rb
+- lib/source2epub/source2epub.rb
+- lib/source2epub/version.rb
+- source2epub.gemspec
+homepage: https://github.com/agilecreativity/source2epub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Export any project from git repository or local directory to a single epub
+  file
+test_files: []
+has_rdoc: