sq 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9011404522da6bbfe9174b817f01f042951082c
-  data.tar.gz: 099d846bd7e759e5b75cc55fcb5204bb310c40f4
+  metadata.gz: aeab6710743c4e7c1d05af7282c199a21e882be6
+  data.tar.gz: dcc24a5f930eed920f52df8069a82e9aa0800e4a
 SHA512:
-  metadata.gz: 5f06843d84adfaaa51d122872dc863a587bfd840f97dbe0c3e4867f544d4124063d3081dd89df1cb7b71db422f77ef09ef67523805e42f786101d4e4646085e0
-  data.tar.gz: a0154949e8708283ce6cf4c6d0014459fee5e70a3284ffebfe2a3a1729e7955e109dbe210ff3c80664d95f7bed860346a1ba39b2813ae2033a943fb8685b6ef9
+  metadata.gz: 10a8027f10d94fb2d4f5d37e45a85b8d528047ff57c2706c6031850054ceefc44793f8666733a9779349268ca2ee62efb305acd47f8b1d43dbeda687ef6226cd
+  data.tar.gz: ee670820c2729551505f23058ed9ee19884ad8b52dcda566b1a3dc416ce1027a73a84555732597dc0f75fce70ca36bf05e3378acf5f75395274c053ae8216cbc

data.tar.gz.sig

@@ -0,0 +1 @@
+��Mr�`?)mC����ƒa�V$Bg�����3���E<K��'����)����	#�k�Hә�9����Z8�"��T�+�5�L?~��s�2���3�$�s���47�������ݤ�!v<�q�?���(��`��9"���=����D.h�p��K�IH���4L���x~�:��\d��c�+z]��!��S!lP}�?#~��{���p�~������vz�>%k��t,*��|77�b�ʆ
�ƛ�"��;�H�m���

data/bin/sq

@@ -33,7 +33,7 @@ is '%s.pdf'.
   %n - PDF number, starting at 0
   %N - PDF number, starting at 1
   %z - same as %n, but zero-padded
-  %Z - same as %Z, but zero-padded
+  %Z - same as %N, but zero-padded
   %c - total number of PDFs
   %s - name of the PDF, extracted from its URI, without `.pdf`
   %S - name of the PDF, extracted from the link text

data/lib/sq.rb

@@ -7,26 +7,37 @@ require 'fileutils'
 require 'ruby-progressbar'
 require File.expand_path(File.dirname __FILE__) + '/version'
 
+# This module provide some tools to bulk-download a set of PDF documents, all
+# linked in one HTML page.
 module SQ
   class << self
-    # return the user-agent used by SQ
+    # @return [String] the user-agent used by SQ
     def user_agent
       "SQ/#{version} +github.com/bfontaine/sq"
     end
 
-    # query an URI and return a list of PDFs. Each PDF is an hash with three
+    # Query an URI and return a list of PDFs. Each PDF is an hash with three
     # keys: +:uri+ is its absolute URI, +:name+ is its name (last part of its
     # URI), and +:text+ is each link text.
-    # @uri [String]
-    # @regex [Regexp]
+    # @param uri [String]
+    # @param regex [Regexp]
+    # @return [Array<Hash>]
     def query(uri, regex=/./)
       uri = 'http://' + uri unless uri =~ /^https?:\/\//
 
       doc = Nokogiri::HTML(open(uri, 'User-Agent' => user_agent))
       links = doc.css('a[href]')
 
-      uris = links.map { |a| [a.text, URI.join(uri, a.attr('href'))] }
-      uris.select! { |_,u| u.path =~ /\.pdf$/i && u.to_s =~ regex }
+      uris = links.map do |a|
+        full = begin
+                 URI.join(uri, a.attr('href'))
+               rescue
+                 nil
+               end
+
+        [a.text, full]
+      end
+      uris.select! { |_,u| u && u.path =~ /\.pdf$/i && u.to_s =~ regex }
 
       uris.map do |text,u|
         {
@@ -38,9 +49,12 @@ module SQ
     end
 
     # Output a formatted filename.
-    # @doc [Hash]   as returned from +SQ.query+.
-    # @fmt [String]
-    # @opts [Hash] additional info.
+    # @param doc [Hash] as returned from +SQ.query+.
+    # @param fmt [String] format. See the project's README for more info on
+    #                     available format options
+    # @param opts [Hash] additional info. Supported keys include: +:number+
+    #                    (the current number), +:count+ (total files count).
+    # @return [String]
     def format(doc, fmt='%s.pdf', opts={})
       opts[:number] ||= 0
       opts[:count]  ||= 0
@@ -63,15 +77,14 @@ module SQ
       end
     end
 
-    # query an URI and download all PDFs which match the regex. It returns the
-    # number of downloaded PDFs.
-    # @uri   [String]
-    # @regex [Regexp] Regex to use to match PDF URIs
-    # @opts  [Hash]   Supported options: +:verbose+, +:directory+ (specify the
-    #                 directory to use for output instead of the current one),
-    #                 and +:format+ the output format. See the README for
-    #                 details.
-    #
+    # Query an URI and download all PDFs which match the regex.
+    # @param uri [String]
+    # @param regex [Regexp] Regex to use to match PDF URIs
+    # @param opts  [Hash] Supported options: +:verbose+, +:directory+
+    #                     (specify the directory to use for output instead of
+    #                     the current one), and +:format+ the output format.
+    #                     See the README for details.
+    # @return [Integer] number of downloaded PDFs.
     def process(uri, regex=/./, opts={})
       uris = self.query(uri, regex)
       count = uris.count

data/lib/version.rb

@@ -2,8 +2,10 @@
 
 module SQ
   class << self
+
+    # @return [String] current gem's version
     def version
-      '0.1.3'
+      '0.1.4'
     end
   end
 end

data/tests/query_tests.rb

@@ -50,4 +50,8 @@ class SQ_query_test < Test::Unit::TestCase
     assert_equal(pdfs, SQ.query("#{@url}/malformed3", /./))
   end
 
+  def test_issue_5
+    assert_equal([], SQ.query("#{@url}/issue5", /./))
+  end
+
 end

data/tests/tests.rb

@@ -1,12 +1,16 @@
 #! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'test/unit'
 require 'simplecov'
 
 test_dir = File.expand_path( File.dirname(__FILE__) )
 
-SimpleCov.start { add_filter '/tests/' } if ENV['COVERAGE']
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start { add_filter '/tests/' }
 
 require 'sq'
 

metadata

@@ -1,113 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: sq
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Baptiste Fontaine
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDaDCCAlCgAwIBAgIBATANBgkqhkiG9w0BAQUFADA9MRAwDgYDVQQDDAdiYXRp
+  Zm9uMRUwEwYKCZImiZPyLGQBGRYFeWFob28xEjAQBgoJkiaJk/IsZAEZFgJmcjAe
+  Fw0xNDA4MjQxMTM5NTJaFw0xNTA4MjQxMTM5NTJaMD0xEDAOBgNVBAMMB2JhdGlm
+  b24xFTATBgoJkiaJk/IsZAEZFgV5YWhvbzESMBAGCgmSJomT8ixkARkWAmZyMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn3uOgWl+FwXIjDdCay28i6cK
+  FxHWhHoS/mH9pkXzSGVctEKP2fulie6MkIvrLCP5M6TpByeaBjcJjZPadrou1FIc
+  Yc/O14jYjaKTqfMxpzgNfGzDdBgBo0QZ9rcHjORetdIZdUSDaZjPtI1aGS6eBMsh
+  W2X6GxL4UQ1kH0Lyg7iPYAH5RHnD3+G+S28iOPFfRLFzm4fwJp1k7URiiSyOHTDp
+  B0ZehKKrW/ibCaRMYp2VoCamcim4de1VA6CTOaYSShueqThE18n1HM6aprihziyM
+  04yIpo80/unO6JxlsUFdBjsb5d7oJSqPJ6/OfcFnyXa/VRm+Ed9d6PTwZvL7YwID
+  AQABo3MwcTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUWyH3xMx1
+  8I5NLncgNEC0ZlDRKegwGwYDVR0RBBQwEoEQYmF0aWZvbkB5YWhvby5mcjAbBgNV
+  HRIEFDASgRBiYXRpZm9uQHlhaG9vLmZyMA0GCSqGSIb3DQEBBQUAA4IBAQAaTVya
+  CGgojxBwUoadCCIsFheGsXvSFhikkXYNXy0VxEYr8BaTfGwzYh9c9T5N+Y5Mu5MW
+  WegqwIwRhIu6Rg7huqJ7TK50pVDF0yrZcsxvWjOfd3clblBHjKGQx5Mbu7LVNGKE
+  +QNdTAwYVTAA8wXHpxk200cHb9xz4e9ANpb4lonGuPz8jKmb/A7Z1M5QD6zStG8l
+  sTlVAhA/LZiC9gL9LtW8Iq7o7xRFhxNPKWHu6JVThH9i16eli+JignOJbGna7C40
+  QnOQb8zHyNL+gq2m/mnZGrSehx+6AujokjOfHbmivYMfDATOQQx0eIBI18IhacZm
+  42WxhhIV2bwDtd77
+  -----END CERTIFICATE-----
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Download all PDFs linked in a Web page
 email: batifon@yahoo.fr
 executables:
@@ -115,13 +151,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/sq
 - lib/sq.rb
 - lib/version.rb
 - tests/format_tests.rb
 - tests/process_tests.rb
 - tests/query_tests.rb
 - tests/tests.rb
-- bin/sq
 homepage: https://github.com/bfontaine/sq
 licenses:
 - MIT
@@ -132,17 +168,17 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Bulk PDFs downloader
@@ -151,3 +187,4 @@ test_files:
 - tests/process_tests.rb
 - tests/query_tests.rb
 - tests/tests.rb
+has_rdoc: