html2pdf 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7477b49881238ef957e71d7a61cf27fdbbfa38f8
-  data.tar.gz: 3ff70b4a6aeddfaf081793b5449e3b5a1704dca1
+  metadata.gz: a66264ef9c9544f757a96c15ab564a7d5cd43382
+  data.tar.gz: e1544c387847a14833443310b54196b5bf5336cf
 SHA512:
-  metadata.gz: 59d359154a59830d99b40e376005bec32041aa22691856fb4f602a5f881439289349871c2d5a3df69e4ba969b144b6be2a30d87c70c6510128775dfd1a16abab
-  data.tar.gz: 307ed5f8b36f5002b09438a642de6933ab331fc304dc1ecb688821b8f59cb641c37b7753fbe1006e162a105ee733a5d08bbc29e54490cc8554ed50576868d593
+  metadata.gz: db1950e020e7f3586b2b58f9d64d654c716b2f7c2accb80a4d9fc1c0d66c352fb6f3104e22add52dd056d60a0c04c9cfe38ba6710eba4311b6a2b76c140224d0
+  data.tar.gz: 2e7f43e76cf9205875c4c35906fd8da47b44d75a07e4f4dcd001b107cf9d083e07680a404556958093088ec42d6368d0d871f8dbbe1895ae9ad2bab46c9ee309

data/.gitignore

@@ -18,5 +18,4 @@ tmp
 # ctags
 tags
 # Custom ignore files
-output.tar.gz
 html2pdf-output.tar.gz

data/CHANGELOGS.md

@@ -1,5 +1,10 @@
 ### Html2Pdf - Changelogs
 
+#### 0.0.7
+
+- Code cleanup
+- Simplify the CLI by remove some options
+
 #### 0.0.6
 
 - Remove the need to have 'Ghostscript' installation

data/README.md

@@ -1,17 +1,20 @@
 ## Html2Pdf
 
-[![Gem Version](https://badge.fury.io/rb/html2pdf.svg)](http://badge.fury.io/rb/html2pdf)
-[![Dependency Status](https://gemnasium.com/agilecreativity/html2pdf.png)](https://gemnasium.com/agilecreativity/html2pdf)
-[![Code Climate](https://codeclimate.com/github/agilecreativity/html2pdf.png)](https://codeclimate.com/github/agilecreativity/html2pdf)
-[![Endorse](https://api.coderwall.com/agilecreativity/endorsecount.png)](https://coderwall.com/agilecreativity)
+[![Gem Version](https://badge.fury.io/rb/html2pdf.svg)][gem]
+[![Dependency Status](https://gemnasium.com/agilecreativity/html2pdf.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/agilecreativity/html2pdf.png)][codeclimate]
 
-Convert multiple html or xhtml files to pdfs using the power of [Wkhtmltopdf][].
+[gemnasium]: https://gemnasium.com/agilecreativity/html2pdf
+[codeclimate]: https://codeclimate.com/github/agilecreativity/html2pdf
+[gem]: http://badge.fury.io/rb/html2pdf
+
+Convert multiple html or xhtml files to pdfs using the power of [wkhtmltopdf][].
 
 ### Installation
 
 ### Mandatory Requirement
 
-- [Wkhtmltopdf][] - please follow the simple instruction on [https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF][]
+- [wkhtmltopdf][] - please see [wkhtmltopdf installation][] for detail
 
 ### Dependencies
 
@@ -39,10 +42,6 @@ html2pdf export [OPTIONS]
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
                                            # Default: . (current directory)
-  -n, [--inc-words=one two three]          # List of words to be included in the result
-  -x, [--exc-words=one two three]          # List of words to be excluded from the result
-  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
-                                           # Default: true
   -r, [--recursive], [--no-recursive]      # Search for files recursively
                                            # Default: true
   -v, [--version], [--no-version]          # Display version information
@@ -53,7 +52,7 @@ Options:
 - Convert all `xhtml` and `html` from `test/fixtures/samples` directory
   recursively
 ```
-html2pdf -b test/fixtures/samples -r
+html2pdf export -b test/fixtures/samples -r
 ```
 Before the run
 ```
@@ -92,15 +91,14 @@ the pdf version of it.
 
 ### Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/code_exporter/fork )
+1. Fork it ( http://github.com/agilecreativity/html2pdf/fork )
 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
 
-[Wkhtmltopdf]: http://wkhtmltopdf.org/
 [vim_printer]: https://github.com/agilecreativity/vim_printer
 [pdfs2pdf]: https://github.com/agilecreativity/pdfs2pdf
-[gemnasium]: https://gemnasium.com/agilecreativity/html2pdf
-[codeclimate]: https://codeclimate.com/github/agilecreativity/html2pdf
-[https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF]: https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF
+[wkhtmltopdf]: http://wkhtmltopdf.org/
+[wkhtmltopdf installation]: https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF
+

data/html2pdf.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Html2Pdf::VERSION
   spec.authors       = ['Burin Choomnuan']
   spec.email         = ['agilecreativity@gmail.com']
-  spec.summary       = %q(Export html or xhtml file to pdfs with using the power of 'wkhtmltopdf')
-  spec.description   = %q(Export html or xhtml file to pdfs with 'wkhtmltopdf')
+  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
@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
                                                        rubocop-todo.yml)
   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'
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
   spec.add_runtime_dependency 'agile_utils', '~> 0.0.9'
-  spec.add_runtime_dependency 'code_lister', '~> 0.0.8'
+  spec.add_runtime_dependency 'code_lister', '~> 0.0.9'
   spec.add_development_dependency 'awesome_print', '~> 1.2'
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'gem-ctags', '~> 1.0'

data/lib/html2pdf.rb

@@ -1,6 +1,6 @@
 require 'agile_utils'
 require 'code_lister'
-require_relative './html2pdf/utils'
+require_relative './html2pdf/html2pdf'
 require_relative './html2pdf/cli'
 require_relative './html2pdf/version'
 include AgileUtils::Options

data/lib/html2pdf/cli.rb

@@ -5,18 +5,13 @@ require_relative '../html2pdf'
 module Html2Pdf
   class CLI < Thor
     desc 'export', 'export multiple html files to pdfs'
-
     method_option *AgileUtils::Options::BASE_DIR
-    method_option *AgileUtils::Options::INC_WORDS
-    method_option *AgileUtils::Options::EXC_WORDS
-    method_option *AgileUtils::Options::IGNORE_CASE
     method_option *AgileUtils::Options::RECURSIVE
     method_option *AgileUtils::Options::VERSION
-
     def export
       opts = options.symbolize_keys
 
-      unless Html2Pdf::Utils.softwares_installed?
+      unless Html2Pdf.softwares_installed?
         fail 'You must have valid `wkhtmltopdf` and `ghostscript` installation'
       end
 
@@ -29,7 +24,7 @@ module Html2Pdf
                                      exts: %w(html xhtml),
                                      recursive: true
       elapsed = AgileUtils::FileUtil.time do
-        Html2Pdf::Utils.to_pdfs(input_files)
+        Html2Pdf.to_pdfs(input_files)
       end
 
       generated_files = AgileUtils::FileUtil.add_suffix(input_files, 'pdf')
@@ -49,10 +44,6 @@ Usage:
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
                                            # Default: . (current directory)
-  -n, [--inc-words=one two three]          # List of words to be included in the result
-  -x, [--exc-words=one two three]          # List of words to be excluded from the result
-  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
-                                           # Default: true
   -r, [--recursive], [--no-recursive]      # Search for files recursively
                                            # Default: true
   -v, [--version], [--no-version]          # Display version information

data/lib/html2pdf/html2pdf.rb

@@ -0,0 +1,49 @@
+require 'open3'
+require 'fileutils'
+require_relative '../html2pdf'
+
+module Html2Pdf
+  class << self
+    # Batch convert to pdf using `wkhtmltopdf` tool
+    #
+    # @param [Array<String>] files the input file list
+    # @param [String] base_dir the base directory
+    def to_pdfs(files)
+      files.each_with_index do |file, index|
+        puts "Convert file #{index + 1} of #{files.size} : #{file}"
+        to_pdf(file)
+      end
+    end
+
+    # Convert '*.xhtml' or '*.html' to pdf
+    #
+    # @param filename input filename
+    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',
+        '--header-center "[webpage] :: [page]/[topage]"',
+        '--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(' '))
+      fail "Problem processing #{filename}" unless status.success?
+    end
+
+    # Check and verify that the proper softwares are available.
+    #
+    def softwares_installed?
+      AgileUtils::Helper.which('wkhtmltopdf')
+    end
+  end
+end

data/lib/html2pdf/version.rb

@@ -1,3 +1,3 @@
 module Html2Pdf
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/rubocop-todo.yml

@@ -1,84 +1,39 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-04-23 20:34:48 +1000 using RuboCop version 0.20.1.
+# on 2014-05-11 21:52:58 +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: 9
+# Offense count: 3
 AmbiguousOperator:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredMethods.
-CollectionMethods:
-  Enabled: false
-
-# Offense count: 1
-CyclomaticComplexity:
-  Max: 7
-
-# Offense count: 5
+# Offense count: 6
 Documentation:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-EmptyLinesAroundBody:
-  Enabled: true
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 HashSyntax:
-  Enabled: true
-
-# Offense count: 4
-# Cop supports --auto-correct.
-LeadingCommentSpace:
-  Enabled: true
+  Enabled: true`
 
-# Offense count: 18
+# Offense count: 7
 LineLength:
-  Max: 108
+  Max: 93
 
-# Offense count: 8
+# Offense count: 2
 # Configuration parameters: CountComments.
 MethodLength:
-  Max: 30
+  Max: 19
 
 # Offense count: 1
-# Cop supports --auto-correct.
-SpaceAfterComma:
-  Enabled: true
+RegexpLiteral:
+  MaxSlashes: 0
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-SpaceInsideBlockBraces:
-  Enabled: true
-
-# Offense count: 1
-# Cop supports --auto-correct.
-SpecialGlobalVars:
-  Enabled: true
-
-# Offense count: 16
+# Offense count: 10
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-UnreachableCode:
   Enabled: true
-
-# Offense count: 1
-UselessAssignment:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-WordArray:
-  MinSize: 2

data/test/fixtures/samples/demo1_xxx.rb

@@ -4,10 +4,10 @@ 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

@@ -6,18 +6,18 @@ 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"
-    method_option :word, :aliases => :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/lib/html2pdf/test_html2pdf.rb

@@ -0,0 +1,14 @@
+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') }
+    end
+  end
+  context '#softwares_installed?' do
+    it 'raises error if the requirements are not met' do
+      assert(Html2Pdf.softwares_installed?,
+             'Must have valid installation of `wkhtmltopdf`')
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: agile_utils
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Export html or xhtml file to pdfs with 'wkhtmltopdf'
+description: Export list of html or xhtml files to pdfs with 'wkhtmltopdf'
 email:
 - agilecreativity@gmail.com
 executables:
@@ -225,7 +225,7 @@ files:
 - html2pdf.gemspec
 - lib/html2pdf.rb
 - lib/html2pdf/cli.rb
-- lib/html2pdf/utils.rb
+- lib/html2pdf/html2pdf.rb
 - lib/html2pdf/version.rb
 - rubocop-todo.yml
 - test/fixtures/samples/demo1_xxx.rb
@@ -240,7 +240,7 @@ files:
 - test/fixtures/samples/sub_dir/demo4_xxx.rb
 - test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml
 - test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml.pdf
-- test/lib/html2pdf/test_utils.rb
+- test/lib/html2pdf/test_html2pdf.rb
 - test/test_helper.rb
 homepage: https://github.com/agilecreativity/html2pdf
 licenses:
@@ -265,20 +265,20 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Export html or xhtml file to pdfs with using the power of 'wkhtmltopdf'
+summary: Bulk export list of html or xhtml files to pdfs with 'wkhtmltopdf'
 test_files:
-- test/lib/html2pdf/test_utils.rb
-- test/test_helper.rb
+- test/fixtures/samples/demo1_xxx.rb
 - test/fixtures/samples/demo1_xxx.rb.xhtml
+- test/fixtures/samples/demo1_xxx.rb.xhtml.pdf
 - test/fixtures/samples/demo2_xxx.rb
-- test/fixtures/samples/demo2_xxx.rb.xhtml.pdf
 - test/fixtures/samples/demo2_xxx.rb.xhtml
+- test/fixtures/samples/demo2_xxx.rb.xhtml.pdf
+- test/fixtures/samples/sub_dir/demo3_xxx.rb
 - test/fixtures/samples/sub_dir/demo3_xxx.rb.xhtml
-- test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml.pdf
 - test/fixtures/samples/sub_dir/demo3_xxx.rb.xhtml.pdf
-- test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml
 - test/fixtures/samples/sub_dir/demo4_xxx.rb
-- test/fixtures/samples/sub_dir/demo3_xxx.rb
-- test/fixtures/samples/demo1_xxx.rb
-- test/fixtures/samples/demo1_xxx.rb.xhtml.pdf
+- test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml
+- test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml.pdf
+- test/lib/html2pdf/test_html2pdf.rb
+- test/test_helper.rb
 has_rdoc: 

data/lib/html2pdf/utils.rb

@@ -1,51 +0,0 @@
-require 'open3'
-require 'fileutils'
-require_relative '../html2pdf'
-
-module Html2Pdf
-  module Utils
-    class << self
-      # Batch convert to pdf using `wkhtmltopdf` tool
-      #
-      # @param [Array<String>] files the input file list
-      # @param [String] base_dir the base directory
-      def to_pdfs(files)
-        files.each_with_index do |file, index|
-          puts "Convert file #{index + 1} of #{files.size} : #{file}"
-          to_pdf(file)
-        end
-      end
-
-      # Convert '*.xhtml' or '*.html' to pdf
-      #
-      # @param filename input filename
-      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',
-          '--header-center "[webpage] :: [page]/[topage]"',
-          '--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(' '))
-        fail "Problem processing #{filename}" unless status.success?
-      end
-
-      # Check and verify that the proper softwares are available.
-      #
-      def softwares_installed?
-        AgileUtils::Helper.which('wkhtmltopdf')
-      end
-    end
-  end
-end

data/test/lib/html2pdf/test_utils.rb

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