pdfs2pdf 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f61699303fc3242f39bcf101d33b2fa86e799b14
-  data.tar.gz: 5d59dc62ee411712790a4c6a193e922593b165f9
+  metadata.gz: 40d847513b193a6418a3db08e3f1dfdd3f471bc2
+  data.tar.gz: f0be5cded86673ad6e2f9e58cdf0ed30a825299d
 SHA512:
-  metadata.gz: d043ab8c3fd081b43ed26bd6ff5a3e36bf8d0834bee39317008ca4b40bac14b93a530ffe6b044b82819460c9820138825d3076317b0cc2928475c64bc497363f
-  data.tar.gz: d61b0241e377d1ebd04e1bc23b5d91181ae080cb8040d42a51ba1772a8c36d31bea28970e78d095d15a1b24a444032882d9fe05162b20c38567803e2613eae29
+  metadata.gz: 50daef0b58123a77884540813099de323c2c708260af2f68b9f4d371cff795b764c8b85a7e374c0126bddaec69c2ffe9f333119c927f8dc1ff114cfaaaca07b8
+  data.tar.gz: fa12e065db643aaaccf18a616c8a8ce4712ae6347a535f502c70bf0b0706b83f71ddba5b2bb3a37bd17f60c7148fca1f6004cec4da922b51393b249b3c0c1650

data/CHANGELOGS.md

@@ -1,5 +1,15 @@
 ### Changelogs
 
+#### 0.0.7
+
+- Simplify the api by removing some of the options
+  * --inc-words
+  * --exc-words
+  * --ignorecase
+- Rename 'utils.rb' to 'pdfs2pdf.rb'
+- Update gemspec
+- Misc cleanup
+
 #### 0.0.6
 
 - Allow options for wkhtmltopdf to be more customizable

data/README.md

@@ -102,10 +102,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/bin/pdfs2pdf

@@ -1,9 +1,6 @@
 #!/usr/bin/env ruby
 require_relative '../lib/pdfs2pdf'
-
-# The default configuration
 require_relative '../config/initializers/pdfs2pdf'
-Pdfs2Pdf.update_config()
-
+Pdfs2Pdf.update_config
 include Pdfs2Pdf
 Pdfs2Pdf::CLI.start(ARGV)

data/config/initializers/pdfs2pdf.rb

@@ -5,6 +5,7 @@ module Pdfs2Pdf
     # See: ./lib/pdfs2pdf/configuration.rb for available options
     def update_config
       Pdfs2Pdf.configure do |config|
+        # Note: add your custom config here
         # config.wkhtmltopdf     = '/usr/bin/wkhtmltopdf'
         # config.default_options = {
         #   paper_size: 'Letter',

data/lib/pdfs2pdf/cli.rb

@@ -2,8 +2,8 @@
 require 'thor'
 require 'tmpdir'
 require 'fileutils'
+require_relative './pdfs2pdf'
 require_relative '../pdfs2pdf'
-require_relative './utils'
 module Pdfs2Pdf
   include AgileUtils::Options
   include CodeLister
@@ -11,9 +11,6 @@ module Pdfs2Pdf
   class CLI < Thor
     desc 'merge', 'Combine multiple pdfs into one file with bookmarks'
     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
 
@@ -34,10 +31,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
@@ -52,17 +45,17 @@ Combine multiple pdfs into one file with bookmarks
 
     def create_pdfmarks(page_list, base_dir)
       elapsed = AgileUtils::FileUtil.time do
-        Pdfs2Pdf::Utils.create_pdfmarks(page_list, 'pdfmarks', base_dir)
+        Pdfs2Pdf.create_pdfmarks(page_list, 'pdfmarks', base_dir)
       end
       puts "Create pdfmarks took #{elapsed} ms"
     end
 
     def merge_pdfs(pdf_files)
       elapsed = AgileUtils::FileUtil.time do
-        Utils.merge_pdfs(pdf_files, 'pdfmarks', 'final_output.pdf')
+        Pdfs2Pdf.merge_pdfs(pdf_files, 'pdfmarks', 'pdfs2pdf_output.pdf')
       end
       puts "Combine pdf files took #{elapsed} ms"
-      puts "Your combine pdf is available at #{File.absolute_path('final_output.pdf')}"
+      puts "Your combined pdf is available at #{File.absolute_path('pdfs2pdf_output.pdf')}"
     end
   end
 end

data/lib/pdfs2pdf/pdfs2pdf.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'open3'
+require 'fileutils'
+require 'pdf-reader'
+require_relative '../pdfs2pdf'
+require_relative './configuration'
+module Pdfs2Pdf
+  class << self
+    # Create the 'pdfmarks' file for use with 'gs' utility
+    #
+    # @param [Array<String>] pdf_files the input file list (pdf)
+    # @param [String] output_file the output filename default to 'pdfmarks'
+    # @param [String] base_dir the base directory (TODO: review this code!)
+    def create_pdfmarks(pdf_files, pdfmarks_file = 'pdfmarks', base_dir = Dir.pwd)
+      File.open(pdfmarks_file, 'w') do |out_file|
+        out_file.write(Pdfs2Pdf.configuration.pdfmarks_meta)
+        current_page = 1
+        pdf_files.each do |pdf_file|
+          filename = if base_dir
+                       # remove the base_directory from the full path
+                       pdf_file.gsub(base_dir, File.basename(pdf_file))
+                     else
+                       pdf_file
+                     end
+          out_file.write "[ /Page #{current_page} /Title (#{filename}) /OUT pdfmark\n"
+          current_page += page_count(pdf_file)
+        end
+      end
+    end
+
+    # Merge/combine list of pdf files using Ghostscript's `gs` command
+    #
+    # @param [Array<String>] list input file list
+    # @param [String] pdfmarks the pdfmarks file default to 'pdfmarks'
+    # @param [String] output_file the output pdf file
+    def merge_pdfs(list, pdfmarks = 'pdfmarks', output_file = 'output.pdf')
+      paper_size = Pdfs2Pdf.configuration.default_options[:paper_size]
+      _stdin, _stderr, status = Open3.capture3(
+        'gs',
+        '-q',
+        '-dNOPAUSE',
+        '-dBATCH',
+        '-sDEVICE=pdfwrite',
+        "-sPAPERSIZE=#{paper_size}",
+        "-sOutputFile=#{output_file}",
+        *list,
+        pdfmarks)
+      fail 'Problem in merge_pdfs' unless status.success?
+    end
+
+    # Extract pdf page count using pdf-reader
+    #
+    # @return [Fixnum] the page count of the given pdf file
+    def page_count(pdf_file)
+      File.open(pdf_file, 'rb') do |io|
+        reader = PDF::Reader.new(io)
+        return reader.page_count
+      end
+      fail "Problem getting the page count for #{pdf_file}"
+    end
+  end
+end

data/lib/pdfs2pdf/version.rb

@@ -1,4 +1,4 @@
 # coding: utf-8
 module Pdfs2Pdf
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/pdfs2pdf.rb

@@ -3,7 +3,7 @@ require 'agile_utils'
 require 'code_lister'
 require_relative 'pdfs2pdf/version'
 require_relative 'pdfs2pdf/cli'
-require_relative 'pdfs2pdf/utils'
+require_relative 'pdfs2pdf/pdfs2pdf'
 include AgileUtils::Options
 include CodeLister
 include Pdfs2Pdf

data/pdfs2pdf.gemspec

@@ -8,17 +8,25 @@ Gem::Specification.new do |spec|
   spec.version       = Pdfs2Pdf::VERSION
   spec.authors       = ['Burin Choomnuan']
   spec.email         = ['agilecreativity@gmail.com']
-  spec.summary       = %q{Combine multiple pdfs into one pdf with proper bookmarks for easy navigation}
-  spec.description   = %q{Combine multiple pdfs into a single file with bookmarks for easy navigation}
+  spec.summary       = %q(Combine multiple pdfs into one pdf with proper bookmarks for easy navigation)
+  spec.description   = %q(Combine multiple pdfs into a single file with bookmarks for easy navigation)
   spec.homepage      = 'https://github.com/agilecreativity/pdfs2pdf'
   spec.license       = 'MIT'
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = Dir.glob('{bin,lib,config}/**/*') + %w(Gemfile
+                                                              Rakefile
+                                                              pdfs2pdf.gemspec
+                                                              README.md
+                                                              CHANGELOGS.md
+                                                              LICENSE
+                                                              .rubocop.yml
+                                                              .gitignore
+                                                              rubocop-todo.yml)
   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.test_files    = Dir.glob('{test}/**/*')
+  spec.require_paths = ['lib']
   spec.add_runtime_dependency 'thor'
   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_runtime_dependency 'pdf-reader', '~> 1.3.3'
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'gem-ctags', '~> 1.0'

data/rubocop-todo.yml

@@ -1,84 +1,31 @@
 # 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 23:16:45 +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: 7
 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
-
-# Offense count: 18
+# Offense count: 7
 LineLength:
-  Max: 108
+  Max: 123
 
-# Offense count: 8
+# Offense count: 3
 # Configuration parameters: CountComments.
 MethodLength:
-  Max: 30
+  Max: 15
 
 # 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
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-UnreachableCode:
-  Enabled: true
-
-# Offense count: 1
-UselessAssignment:
+UnusedBlockArgument:
   Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-WordArray:
-  MinSize: 2

data/test/lib/pdfs2pdf/test_pdfs2pdf.rb

@@ -1,9 +1,9 @@
 require_relative '../../test_helper'
-describe Pdfs2Pdf::Utils do
+describe Pdfs2Pdf do
   context '#page_count' do
     it 'returns result for valid command' do
       input_file = 'test/fixtures/samples/demo1_xxx.rb.xhtml.pdf'
-      result = Pdfs2Pdf::Utils.page_count(input_file)
+      result = Pdfs2Pdf.page_count(input_file)
       result.must_equal 1
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfs2pdf
 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-06 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -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: pdf-reader
   requirement: !ruby/object:Gem::Requirement
@@ -201,28 +201,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOGS.md
 - Gemfile
-- Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/pdfs2pdf
 - config/initializers/pdfs2pdf.rb
-- demo1.png
-- demo2.png
-- demo3.png
-- demo4.png
-- final_output.png
 - lib/pdfs2pdf.rb
 - lib/pdfs2pdf/cli.rb
 - lib/pdfs2pdf/configuration.rb
-- lib/pdfs2pdf/utils.rb
+- lib/pdfs2pdf/pdfs2pdf.rb
 - lib/pdfs2pdf/version.rb
-- pdfmarks
 - pdfs2pdf.gemspec
 - rubocop-todo.yml
 - test/fixtures/samples/demo1_xxx.rb.xhtml.pdf

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.ruby-version

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

data/Guardfile

@@ -1,13 +0,0 @@
-# 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/lib/pdfs2pdf/utils.rb

@@ -1,64 +0,0 @@
-# coding: utf-8
-require 'open3'
-require 'fileutils'
-require 'pdf-reader'
-require_relative '../pdfs2pdf'
-require_relative './configuration'
-module Pdfs2Pdf
-  class Utils
-    class << self
-      # Create the 'pdfmarks' file for use with 'gs' utility
-      #
-      # @param [Array<String>] pdf_files the input file list (pdf)
-      # @param [String] output_file the output filename default to 'pdfmarks'
-      # @param [String] base_dir the base directory (TODO: review this code!)
-      def create_pdfmarks(pdf_files, pdfmarks_file = 'pdfmarks', base_dir = Dir.pwd)
-        File.open(pdfmarks_file, 'w') do |out_file|
-          out_file.write(Pdfs2Pdf.configuration.pdfmarks_meta)
-          current_page = 1
-          pdf_files.each do |pdf_file|
-            filename = if base_dir
-                         # remove the base_directory from the full path
-                         pdf_file.gsub(base_dir, File.basename(pdf_file))
-                       else
-                         pdf_file
-                       end
-            out_file.write "[ /Page #{current_page} /Title (#{filename}) /OUT pdfmark\n"
-            current_page += page_count(pdf_file)
-          end
-        end
-      end
-
-      # Merge/combine list of pdf files using Ghostscript's `gs` command
-      #
-      # @param [Array<String>] list input file list
-      # @param [String] pdfmarks the pdfmarks file default to 'pdfmarks'
-      # @param [String] output_file the output pdf file
-      def merge_pdfs(list, pdfmarks = 'pdfmarks', output_file = 'output.pdf')
-        paper_size = Pdfs2Pdf.configuration.default_options[:paper_size]
-        _stdin, _stderr, status = Open3.capture3(
-          'gs',
-          '-q',
-          '-dNOPAUSE',
-          '-dBATCH',
-          '-sDEVICE=pdfwrite',
-          "-sPAPERSIZE=#{paper_size}",
-          "-sOutputFile=#{output_file}",
-          *list,
-          pdfmarks)
-        fail 'Problem in merge_pdfs' unless status.success?
-      end
-
-      # Extract pdf page count using pdf-reader
-      #
-      # @return [Fixnum] the page count of the given pdf file
-      def page_count(pdf_file)
-        File.open(pdf_file, 'rb') do |io|
-          reader = PDF::Reader.new(io)
-          return reader.page_count
-        end
-        fail "Problem getting the page count for #{pdf_file}"
-      end
-    end
-  end
-end

data/pdfmarks

@@ -1,8 +0,0 @@
-[ /Title (My Combined Pdf)
-  /Author (Burin Choomnuan)
-  /Keywords (fun, witty, interesting)
-  /DOCINFO pdfmark
-[ /Page 1 /Title (demo1_xxx.rb.xhtml.pdf/demo1_xxx.rb.xhtml.pdf) /OUT pdfmark
-[ /Page 2 /Title (demo2_xxx.rb.xhtml.pdf/demo2_xxx.rb.xhtml.pdf) /OUT pdfmark
-[ /Page 3 /Title (demo3_xxx.rb.xhtml.pdf/sub_dir/demo3_xxx.rb.xhtml.pdf) /OUT pdfmark
-[ /Page 4 /Title (demo4_xxx.rb.xhtml.pdf/sub_dir/demo4_xxx.rb.xhtml.pdf) /OUT pdfmark