html2pdf 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1558eb0b691dbc0d701b5deb1ef3e6dd34de627
-  data.tar.gz: c8c19bd55f2a00b1912b4b60d7a8d7ce5a698be6
+  metadata.gz: 19a61c7bd4f22b786d9777df4ee6c4a8e4472909
+  data.tar.gz: 072d2a948be11cebe5db643191ef944c3c5c9b98
 SHA512:
-  metadata.gz: f976f3e348cc3b0e08e0544212a6cf5fe143993875a76c8a58b1726645757357a32984324fc489b1e161487cec968fba0a490063809a69ad57dda2ad3c4a7083
-  data.tar.gz: d9204c0d1b265740950a242b24075cf4a4e1c4da2fe04d9757a7a6d9bb130a9214c2d6f07eefebd553a0b5765f87893c20037da5567c9ea09f3b88fbce8f5792
+  metadata.gz: 4e87aee9d33e577da87392e304044d9dcc254979029d660f6c7c791262968a37106709e067f3f5506a5dbe6fd52321e165bc7a7efd4281531a77d546d6361e65
+  data.tar.gz: bad0571fd68a34029d11ba3a1759918a7da89f6584d53c1bc7e3c3b13a0cecf7b578f250347df7d5d63b3ebdf6231ad42939dc57b153bb44ca4dc0ab751ffb0d

data/.gitignore

@@ -17,5 +17,7 @@ test/version_tmp
 tmp
 # ctags
 tags
-# generated file
+# Custom ignore files
 output.tar.gz
+html2pdf-output.tar.gz
+changelogs.txt

data/README.md

@@ -32,7 +32,9 @@ For list of usage type
 ```sh
 html2pdf
 ```
+
 Which should give the following options
+
 ```
 Usage:
 html2pdf export [OPTIONS]
@@ -48,12 +50,13 @@ Options:
                                            # Default: true
   -v, [--version], [--no-version]          # Display version information
 ```
+
 ### Example Usage
 
 - Convert all `xhtml` and `html` from `test/fixtures/samples` directory
   recursively
 ```
-html2pdf -b test/fixtures/samples -e html xhtml -r
+html2pdf -b test/fixtures/samples -r
 ```
 Before the run
 ```
@@ -65,16 +68,16 @@ test/fixtures/samples/
     └── demo4_xxx.rb.xhtml
 ```
 After the above command is executed:
+
+You should get the output `html2pdf-output.tar.gz`
+which contain the pdf version of the input files above.
+e.g.
+
 ```
-test/fixtures/samples/
-├── demo1_xxx.rb.xhtml
 ├── demo1_xxx.rb.xhtml.pdf
-├── demo2_xxx.rb.xhtml
 ├── demo2_xxx.rb.xhtml.pdf
 └── sub_dir
-    ├── demo3_xxx.rb.xhtml
     ├── demo3_xxx.rb.xhtml.pdf
-    ├── demo4_xxx.rb.xhtml
     └── demo4_xxx.rb.xhtml.pdf
 ```
 
@@ -92,9 +95,18 @@ the pdf version of it.
 
 ### Changelogs
 
+#### 0.0.3
+
+- Update [agile_utils][] to 0.0.8
+- Update [code_lister][] to 0.0.7
+- Compress generated pdf files to one single tar.gzip file
+- Fix bug in softwares_installed? method
+- Remove the TODOs.md
+
 #### 0.0.2
 
 - Use [agile_utils][] to 0.0.5
+
 - Fix minor error when using --version
 
 #### 0.0.1

data/html2pdf.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'agile_utils', '~> 0.0.5'
-  spec.add_runtime_dependency 'code_lister', '~> 0.0.6'
+  spec.add_runtime_dependency 'agile_utils', '~> 0.0.8'
+  spec.add_runtime_dependency 'code_lister', '~> 0.0.7'
 
   spec.add_development_dependency 'awesome_print', '~> 1.2'
   spec.add_development_dependency 'bundler', '~> 1.5'

data/lib/html2pdf/cli.rb

@@ -4,7 +4,7 @@ require 'fileutils'
 require_relative '../html2pdf'
 module Html2Pdf
   class CLI < Thor
-    desc 'export', 'export html files to pdfs'
+    desc 'export', 'export multiple html files to pdfs'
 
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::INC_WORDS
@@ -16,7 +16,7 @@ module Html2Pdf
     def export
       opts = options.symbolize_keys
 
-      unless Html2Pdf::Utils.required_softwares?
+      unless Html2Pdf::Utils.softwares_installed?
         fail 'You must have valid `wkhtmltopdf` and `ghostscript` installation'
       end
 
@@ -31,7 +31,13 @@ module Html2Pdf
       elapsed = AgileUtils::FileUtil.time do
         Html2Pdf::Utils.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')
+      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')}"
     end
 
     desc 'usage', 'Display usage information'
@@ -51,7 +57,7 @@ Options:
                                            # Default: true
   -v, [--version], [--no-version]          # Display version information
 
-export html files to pdfs
+export multiple html files to pdfs
       EOT
     end
 

data/lib/html2pdf/utils.rb

@@ -20,10 +20,6 @@ module Html2Pdf
       #
       # @param filename input filename
       def to_pdf(filename)
-        # see: http://madalgo.au.dk/~jakobt/wkhtmltoxdoc/wkhtmltopdf_0.10.0_rc2-doc.html#Footers And Headers
-        #  - may be only allow "*.html" and "*.xhtml"
-        #  - allow the options to be passed in so that we can use different theme
-        #    '--no-background'
         fail "Invalid input file #{filename}" unless File.exist?(filename)
         command = [
           'wkhtmltopdf',
@@ -31,16 +27,10 @@ module Html2Pdf
           '--margin-bottom 4',
           '--margin-left 4',
           '--margin-right 4',
-          # Note: working correctly but long URL
           '--header-center "[webpage] :: [page]/[topage]"',
-          # header section
-          # TODO: not yet working properly
-          # "--header-center #{filename.gsub(base_dir,File.basename(base_dir))} \"[page]/[topage]\"",
-          # "--header-center #{filename} \"[page]/[topage]\"",
           '--header-spacing 1',
           '--header-font-size 8',
           '--header-line',
-          # footer section
           '--footer-spacing 1',
           '--footer-font-size 8',
           '--footer-line',
@@ -48,15 +38,13 @@ module Html2Pdf
           "#{filename}.pdf",
           '> /dev/null']
         _stdin, _stderr, status = Open3.capture3(command.join(' '))
-        # puts "FYI: to_pdf command: #{command.join(' ')}"
-        # Note: may be log it and continue
         fail "Problem processing #{filename}" unless status.success?
       end
 
       # Check and verify that the proper softwares are available.
       #
-      def required_softwares?
-        AgileUtils::Helper.which('gs') && AgileUtils::Helper.which('gs')
+      def softwares_installed?
+        AgileUtils::Helper.which('wkhtmltopdf') && AgileUtils::Helper.which('gs')
       end
     end
   end

data/lib/html2pdf/version.rb

@@ -1,3 +1,3 @@
 module Html2Pdf
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/lib/html2pdf/test_utils.rb

@@ -5,10 +5,10 @@ describe Html2Pdf::Utils do
       assert_raises(RuntimeError) { Html2Pdf::Utils.to_pdf('bad-file-name') }
     end
   end
-  context '#have_required_softwares' do
+  context '#softwares_installed?' do
     it 'raises error if the requirements are not met' do
-      assert(Html2Pdf::Utils.required_softwares?,
-            'Must have valid installation of `wkhtmltopdf` and `ghostscript`')
+      assert(Html2Pdf::Utils.softwares_installed?,
+             'Must have valid installation of `wkhtmltopdf` and `ghostscript`')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: code_lister
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +236,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODOs.md
 - bin/html2pdf
 - html2pdf.gemspec
 - lib/html2pdf.rb

data/TODOs.md

@@ -1,13 +0,0 @@
-### TODOs
-
-- Remove the options that need to be default
-  e.g. `--exts xhtml html` should be default and should not be changed by user.
-
-- Find minitest related to file-system test so that the code can be hooked to
-  [TravisCI][]
-
-- Add test using [minitest-filesystem][]
-
-- Add more tests
-
-[minitest-filesystem]: https://github.com/stefanozanella/minitest-filesystem