html2pdf 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ba6778d92b10b6f87f16d3a3cb0c22a8c50a3d
-  data.tar.gz: 92f96fde362f8cc2ec4a808d34698ab0ee558210
+  metadata.gz: 2f8f6a51e86e49c276d81ffec9fa0832ceef8b74
+  data.tar.gz: fc555de91188234f96a329805ec8a40e42755cdb
 SHA512:
-  metadata.gz: 06131276e8267087977f5ebbe65fd0f08c13de6d287440bce7fd0232b09a40db645e76fd0016d18fd62b258f330bb64bfb7ced3d8772848d0c6550aafef4ab46
-  data.tar.gz: 377c402bac25aaf905d0893e450295de89259e52557b74087cac7ca0c7b1f8eb177c3d6ca75e34b41bd99a9c1935dfad8fc34e34cb3c5a1ae9f326da59311d43
+  metadata.gz: 57b41fe8ec8866f1215853e7dc9089f1b90d9166f2a885213b0bb3c62ce5e215b82bb4534ce03009f7bf7a7113c2eefa14b69517189cc5f96d2e0470269e9690
+  data.tar.gz: f4a47caeb6143ef96a99eeec6dd37b486251532bdedda5cd0f60e673d4b51d85be1d0b768dfe48869d162c08bfbe45f1e14e2f14ff842eafd9a84527c8c7780c

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 tags
 # Custom ignore files
 html2pdf-output.tar.gz
+.ruby-version

data/.rubocop.yml

@@ -1 +1,95 @@
-inherit_from: rubocop-todo.yml
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+    - bin/*
+    - html2pdf.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 @@
 ### Html2Pdf - Changelogs
 
+#### 0.1.2
+
+- Simplify the CLI
+- Style cleanup with rubocop
+
 #### 0.1.1
 
 - Remove 'ghostscript' from the required software in error message

data/Gemfile

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

data/README.md

@@ -39,7 +39,7 @@ Which should give the following output
 
 ```
 Usage:
-html2pdf export [OPTIONS]
+html2pdf
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
@@ -54,7 +54,7 @@ Options:
 - Convert all `xhtml` and `html` from `test/fixtures/samples` directory
   recursively
 ```
-html2pdf export -b test/fixtures/samples -r
+html2pdf -b test/fixtures/samples -r
 ```
 Before the run
 ```

data/Rakefile

@@ -1,7 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-project_name = 'html2pdf'
+project_name = "html2pdf"
 
 Rake::TestTask.new do |t|
   t.libs << "lib/#{project_name}"
@@ -12,20 +12,20 @@ end
 task default: [:test, :rubocop]
 
 task :pry do
-  require 'pry'
-  require 'awesome_print'
-  require_relative './lib/html2pdf'
+  require "pry"
+  require "awesome_print"
+  require_relative "./lib/html2pdf"
   include Html2Pdf
   ARGV.clear
   Pry.start
 end
 
-require 'rubocop/rake_task'
-desc 'Run RuboCop on the lib directory'
+require "rubocop/rake_task"
+desc "Run RuboCop on the lib directory"
 Rubocop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
+  task.patterns = ["lib/**/*.rb"]
   # only show the files with failures
-  task.formatters = ['files']
+  task.formatters = ["files"]
   # don't abort rake on failure
   task.fail_on_error = false
 end

data/bin/html2pdf

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

data/html2pdf.gemspec

@@ -1,41 +1,40 @@
 # 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 'html2pdf/version'
+require "html2pdf/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'html2pdf'
+  spec.name          = "html2pdf"
   spec.version       = Html2Pdf::VERSION
-  spec.authors       = ['Burin Choomnuan']
-  spec.email         = ['agilecreativity@gmail.com']
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
   spec.summary       = %q(Bulk export list of html or xhtml files to pdfs with 'wkhtmltopdf')
   spec.description   = %q(Export list of html or xhtml files to pdfs with 'wkhtmltopdf')
-  spec.homepage      = 'https://github.com/agilecreativity/html2pdf'
-  spec.license       = 'MIT'
-  spec.files         = Dir.glob('{bin,lib}/**/*') + %w(Gemfile
+  spec.homepage      = "https://github.com/agilecreativity/html2pdf"
+  spec.license       = "MIT"
+  spec.files         = Dir.glob("{bin,lib}/**/*") + %w[Gemfile
                                                        Rakefile
                                                        html2pdf.gemspec
                                                        README.md
-                                                       CHANGELOGS.md
+                                                       CHANGELOG.md
                                                        LICENSE
                                                        .rubocop.yml
-                                                       .gitignore
-                                                       rubocop-todo.yml)
+                                                       .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 'agile_utils', '~> 0.1'
-  spec.add_runtime_dependency 'code_lister', '~> 0.1'
-  spec.add_development_dependency 'awesome_print', '~> 1.2'
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'gem-ctags', '~> 1.0'
-  spec.add_development_dependency 'guard', '~> 2.6'
-  spec.add_development_dependency 'guard-minitest', '~> 2.2'
-  spec.add_development_dependency 'minitest', '~> 5.3'
-  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'rake', '~> 10.1'
-  spec.add_development_dependency 'rubocop', '~> 0.20'
-  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 "agile_utils", "~> 0.1"
+  spec.add_runtime_dependency "code_lister", "~> 0.1"
+  spec.add_development_dependency "awesome_print", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "gem-ctags", "~> 1.0"
+  spec.add_development_dependency "guard", "~> 2.6"
+  spec.add_development_dependency "guard-minitest", "~> 2.2"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rubocop", "~> 0.20"
+  spec.add_development_dependency "yard", "~> 0.8"
 end

data/lib/html2pdf.rb

@@ -1,7 +1,7 @@
-require 'agile_utils'
-require 'code_lister'
-require_relative './html2pdf/html2pdf'
-require_relative './html2pdf/cli'
-require_relative './html2pdf/version'
+require "agile_utils"
+require "code_lister"
+require_relative "./html2pdf/html2pdf"
+require_relative "./html2pdf/cli"
+require_relative "./html2pdf/version"
 include AgileUtils::Options
 include CodeLister

data/lib/html2pdf/cli.rb

@@ -1,10 +1,10 @@
-require 'thor'
-require 'tmpdir'
-require 'fileutils'
-require_relative '../html2pdf'
+require "thor"
+require "tmpdir"
+require "fileutils"
+require_relative "../html2pdf"
 module Html2Pdf
   class CLI < Thor
-    desc 'export', 'export multiple html files to pdfs'
+    desc "export", "export multiple html files to pdfs"
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::RECURSIVE
     method_option *AgileUtils::Options::VERSION
@@ -12,7 +12,7 @@ module Html2Pdf
       opts = options.symbolize_keys
 
       unless Html2Pdf.softwares_installed?
-        fail 'You must have valid `wkhtmltopdf` installation'
+        fail "You must have valid `wkhtmltopdf` installation"
       end
 
       if opts[:version]
@@ -21,25 +21,25 @@ module Html2Pdf
       end
 
       input_files = CodeLister.files base_dir: opts[:base_dir],
-                                     exts: %w(html xhtml),
+                                     exts: %w[html xhtml],
                                      recursive: true
       elapsed = AgileUtils::FileUtil.time do
         Html2Pdf.to_pdfs(input_files)
       end
 
-      generated_files = AgileUtils::FileUtil.add_suffix(input_files, 'pdf')
-      AgileUtils::FileUtil.tar_gzip_files(generated_files, 'html2pdf-output.tar.gz')
+      generated_files = AgileUtils::FileUtil.add_suffix(input_files, "pdf")
+      AgileUtils::FileUtil.tar_gzip_files(generated_files, "html2pdf-output.tar.gz")
       AgileUtils::FileUtil.delete(generated_files)
 
       puts "Convert files to pdfs took #{elapsed} ms"
-      puts "Your final output is #{File.absolute_path('html2pdf-output.tar.gz')}"
+      puts "Your final output is #{File.absolute_path("html2pdf-output.tar.gz")}"
     end
 
-    desc 'usage', 'Display usage information'
+    desc "usage", "Display usage information"
     def usage
       puts <<-EOT
 Usage:
-  html2pdf export [OPTIONS]
+  html2pdf
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory

data/lib/html2pdf/html2pdf.rb

@@ -1,6 +1,6 @@
-require 'open3'
-require 'fileutils'
-require_relative '../html2pdf'
+require "open3"
+require "fileutils"
+require_relative "../html2pdf"
 
 module Html2Pdf
   class << self
@@ -21,29 +21,29 @@ module Html2Pdf
     def to_pdf(filename)
       fail "Invalid input file #{filename}" unless File.exist?(filename)
       command = [
-        'wkhtmltopdf',
-        '--margin-top 4',
-        '--margin-bottom 4',
-        '--margin-left 4',
-        '--margin-right 4',
+        "wkhtmltopdf",
+        "--margin-top 4",
+        "--margin-bottom 4",
+        "--margin-left 4",
+        "--margin-right 4",
         '--header-center "[webpage] :: [page]/[topage]"',
-        '--header-spacing 1',
-        '--header-font-size 8',
-        '--header-line',
-        '--footer-spacing 1',
-        '--footer-font-size 8',
-        '--footer-line',
+        "--header-spacing 1",
+        "--header-font-size 8",
+        "--header-line",
+        "--footer-spacing 1",
+        "--footer-font-size 8",
+        "--footer-line",
         "#{filename}",
         "#{filename}.pdf",
-        '> /dev/null']
-      _stdin, _stderr, status = Open3.capture3(command.join(' '))
+        "> /dev/null"]
+      _stdin, _stderr, status = Open3.capture3(command.join(" "))
       fail "Problem processing #{filename}" unless status.success?
     end
 
     # Check and verify that the proper softwares are available.
     #
     def softwares_installed?
-      AgileUtils::Helper.which('wkhtmltopdf')
+      AgileUtils::Helper.which("wkhtmltopdf")
     end
   end
 end

data/lib/html2pdf/version.rb

@@ -1,3 +1,3 @@
 module Html2Pdf
-  VERSION = '0.1.1'
+  VERSION = "0.1.2"
 end

data/test/fixtures/samples/demo1_xxx.rb

@@ -1,13 +1,13 @@
 # file: spec/fixtures/demo1.rb
 # from: https://github.com/radar/guides/blob/master/gem-development/foodie/lib/foodie/food.rb
-require 'active_support/inflector'
+require "active_support/inflector"
 module Foodie
   class Food
     def self.portray(food)
-      if food.downcase == 'broccoli'
-        'Gross!'
+      if food.downcase == "broccoli"
+        "Gross!"
       else
-        'Delicious!'
+        "Delicious!"
       end
     end
 

data/test/fixtures/samples/demo2_xxx.rb

@@ -1,23 +1,23 @@
 # file: spec/fixtures/demo2.rb
 # from: https://github.com/radar/guides/blob/master/gem-development/foodie/lib/foodie/cli.rb
-require 'thor'
-require 'foodie'
-require 'foodie/generators/recipe'
+require "thor"
+require "foodie"
+require "foodie/generators/recipe"
 
 module Foodie
   class CLI < Thor
-    desc 'portray ITEM', 'Determines if a piece of food is gross or delicious'
+    desc "portray ITEM", "Determines if a piece of food is gross or delicious"
     def portray(name)
       puts Foodie::Food.portray(name)
     end
 
-    desc 'pluralize', 'Pluralizes a word'
+    desc "pluralize", "Pluralizes a word"
     method_option :word, aliases: :word
     def pluralize
       puts Foodie::Food.pluralize(options[:word])
     end
 
-    desc 'recipe', 'Generates a recipe scaffold'
+    desc "recipe", "Generates a recipe scaffold"
     def recipe(group, name)
       Foodie::Generators::Recipe.start([group, name])
     end

data/test/fixtures/samples/sub_dir/demo3_xxx.rb

@@ -1,6 +1,6 @@
 # file: spec/fixtures/sub-dir/demo3.xxx.rb
 # from: https://github.com/radar/guides/blob/master/gem-development/foodie/lib/foodie/generators/recipe.rb
-require 'thor/group'
+require "thor/group"
 module Foodie
   module Generators
     class Recipe < Thor::Group
@@ -9,7 +9,7 @@ module Foodie
       include Thor::Actions
 
       def self.source_root
-        File.dirname(__FILE__) + '/recipe'
+        File.dirname(__FILE__) + "/recipe"
       end
 
       def create_group
@@ -17,7 +17,7 @@ module Foodie
       end
 
       def copy_recipe
-        template('recipe.txt', "#{group}/#{name}.txt")
+        template("recipe.txt", "#{group}/#{name}.txt")
       end
     end
   end

data/test/fixtures/samples/sub_dir/demo4_xxx.rb

@@ -1,6 +1,6 @@
 # file: spec/fixtures/sub-dir/demo3.xxx.rb
 # from: https://github.com/radar/guides/blob/master/gem-development/foodie/lib/foodie.rb
-require 'foodie/food'
+require "foodie/food"
 module Foodie
   # Your code goes here...
 end

data/test/lib/html2pdf/test_html2pdf.rb

@@ -1,14 +1,14 @@
-require_relative '../../test_helper'
+require_relative "../../test_helper"
 describe Html2Pdf do
-  context '#to_pdf' do
-    it 'raises error on invalid input file' do
-      assert_raises(RuntimeError) { Html2Pdf.to_pdf('bad-file-name') }
+  context "#to_pdf" do
+    it "raises error on invalid input file" do
+      assert_raises(RuntimeError) { Html2Pdf.to_pdf("bad-file-name") }
     end
   end
-  context '#softwares_installed?' do
-    it 'raises error if the requirements are not met' do
+  context "#softwares_installed?" do
+    it "raises error if the requirements are not met" do
       assert(Html2Pdf.softwares_installed?,
-             'Must have valid installation of `wkhtmltopdf`')
+             "Must have valid installation of `wkhtmltopdf`")
     end
   end
 end

data/test/test_helper.rb

@@ -1,7 +1,7 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'minitest-spec-context'
-require 'pry'
-require 'awesome_print'
-require_relative '../lib/html2pdf'
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest-spec-context"
+require "pry"
+require "awesome_print"
+require_relative "../lib/html2pdf"
 include Html2Pdf

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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
@@ -216,7 +216,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- CHANGELOGS.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -227,7 +227,6 @@ files:
 - lib/html2pdf/cli.rb
 - lib/html2pdf/html2pdf.rb
 - lib/html2pdf/version.rb
-- rubocop-todo.yml
 - test/fixtures/samples/demo1_xxx.rb
 - test/fixtures/samples/demo1_xxx.rb.xhtml
 - test/fixtures/samples/demo1_xxx.rb.xhtml.pdf

data/rubocop-todo.yml

@@ -1,27 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-05-12 23:39:22 +1000 using RuboCop version 0.21.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 3
-AmbiguousOperator:
-  Enabled: false
-
-# Offense count: 6
-Documentation:
-  Enabled: false
-
-# Offense count: 7
-LineLength:
-  Max: 93
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-MethodLength:
-  Max: 19
-
-# Offense count: 1
-RegexpLiteral:
-  MaxSlashes: 0