arx 0.3.2 → 1.2.1

data/lib/arx/inspector.rb

@@ -2,6 +2,7 @@ module Arx
 
   # Restricts +inspect+ to dump a whitelist of methods on an object.
   # It will always provide `object_id` at a minimum.
+  #
   # @private
   module Inspector
 
@@ -24,6 +25,7 @@ module Arx
       end
 
       # Defines helper +inspector_fields+ instance variable & method, and +inspector+ instance method on the target object.
+      #
       # @param [Object] source An arbitrary object (the object that +includes+ the +Inspector+ module).
       def included(source)
         inspected << source

data/lib/arx/query/query.rb

@@ -22,14 +22,8 @@ module Arx
       and_not: 'ANDNOT'
     }
 
-    # Logical connective method names.
-    CONNECTIVE_METHODS = {
-      '&': :and,
-      '!': :and_not,
-      '|': :or
-    }
-
     # Supported fields for the search queries made to the arXiv search API.
+    #
     # @see https://arxiv.org/help/prep arXiv metadata fields
     # @see https://arxiv.org/help/api/user-manual#query_details arXiv user manual (query details)
     FIELDS = {
@@ -73,35 +67,38 @@ module Arx
 
       ids.flatten!
       unless ids.empty?
-        ids.map! {|id| extract_id id}
-        Validate.ids ids
+        ids.map! {|id| Cleaner.extract_id(id, version: true)}
         @query << "&#{PARAMS[:id_list]}=#{ids * ','}"
       end
 
       yield self if block_given?
     end
 
-    # @!method &
+    # @!method and
     # Logical conjunction (+AND+) of subqueries.
+    #
     # @see https://arxiv.org/help/api/user-manual#query_details arXiv user manual
     # @return [self]
 
-    # @!method !
+    # @!method and_not
     # Logical negated conjunction (+ANDNOT+) of subqueries.
+    #
     # @see https://arxiv.org/help/api/user-manual#query_details arXiv user manual
     # @return [self]
 
-    # @!method |
+    # @!method or
     # Logical disjunction (+OR+) of subqueries.
+    #
     # @see https://arxiv.org/help/api/user-manual#query_details arXiv user manual
     # @return [self]
 
-    CONNECTIVE_METHODS.each do |symbol, connective|
-      define_method(symbol) { add_connective connective }
+    CONNECTIVES.keys.each do |connective|
+      define_method(connective) { add_connective connective }
     end
 
     # @!method title(*values, exact: true, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#title title}.
+    #
     # @param values [Array<String>] Title(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the title(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -109,6 +106,7 @@ module Arx
 
     # @!method author(*values, exact: true, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#author author}.
+    #
     # @param values [Array<String>] Author(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the author's name(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -116,6 +114,7 @@ module Arx
 
     # @!method abstract(*values, exact: true, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#abstract abstract}.
+    #
     # @param values [Array<String>] Abstract(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the abstract(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -123,6 +122,7 @@ module Arx
 
     # @!method comment(*values, exact: true, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#comments comment}.
+    #
     # @param values [Array<String>] Comment(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the comment(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -130,6 +130,7 @@ module Arx
 
     # @!method journal(*values, exact: true, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#journal journal reference}.
+    #
     # @param values [Array<String>] Journal reference(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the journal refernece(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -137,18 +138,21 @@ module Arx
 
     # @!method category(*values, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#category category}.
+    #
     # @param values [Array<String>] Category(s) of papers to search for.
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
     # @return [self]
 
     # @!method report(*values, connective: :and)
     # Search for papers by {https://arxiv.org/help/prep#report report number}.
+    #
     # @param values [Array<String>] Report number(s) of papers to search for.
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
     # @return [self]
 
     # @!method all(*values, exact: true, connective: :and)
     # Search for papers by all fields (see {FIELDS}).
+    #
     # @param values [Array<String>] Field value(s) of papers to search for.
     # @param exact [Boolean] Whether to search for an exact match of the comment(s).
     # @param connective [Symbol] The logical connective to use (see {CONNECTIVES}). Only applies if there are multiple values.
@@ -181,6 +185,20 @@ module Arx
       end
     end
 
+    # Creates a nested subquery (grouped statements with parentheses).
+    #
+    # @return [self]
+    def group
+      add_connective :and unless end_with_connective?
+      @query << (search_query? ? '+' : "&#{PARAMS[:search_query]}=")
+
+      @query << CGI.escape('(')
+      yield
+      @query << CGI.escape(')')
+
+      self
+    end
+
     # Returns the query string.
     #
     # @return [String]
@@ -196,8 +214,9 @@ module Arx
     # @param connective [Symbol] The symbol of the logical connective to add.
     # @return [self]
     def add_connective(connective)
-      return unless search_query?
-      @query << "+#{CONNECTIVES[connective]}" unless ends_with_connective?
+      if search_query?
+        @query << "+#{CONNECTIVES[connective]}" unless end_with_connective? || start_of_group?
+      end
       self
     end
 
@@ -205,13 +224,10 @@ module Arx
     #
     # @param subquery [String] The subquery to add.
     def add_subquery(subquery)
+      add_connective :and unless end_with_connective?
+
       if search_query?
-        if ends_with_connective?
-          @query << "+#{subquery}"
-        else
-          add_connective :and
-          @query << "+#{subquery}"
-        end
+        @query << (start_of_group? ? "#{subquery}" : "+#{subquery}")
       else
         @query << "&#{PARAMS[:search_query]}=#{subquery}"
       end
@@ -229,10 +245,17 @@ module Arx
     #
     # @see CONNECTIVES
     # @return [Boolean]
-    def ends_with_connective?
+    def end_with_connective?
       CONNECTIVES.values.any? &@query.method(:end_with?)
     end
 
+    # Whether the query string ends in a start-of-group character '('.
+    #
+    # @return [Boolean]
+    def start_of_group?
+      @query.end_with? CGI.escape('(')
+    end
+
     # Parenthesizes a string with CGI-escaped parentheses.
     #
     # @param string [String] The string to parenthesize.
@@ -248,18 +271,5 @@ module Arx
     def enquote(string)
       CGI.escape("\"") + string + CGI.escape("\"")
     end
-
-    # Attempt to extract an ID from an arXiv URL.
-    #
-    # @param url [String] The URL to extract the ID from.
-    # @return [String] The extracted ID if successful, otherwise the original string.
-    def extract_id(url)
-      prefix = %r"^(https?\:\/\/)?(www.)?arxiv\.org\/abs\/"
-      if %r"#{prefix}.*$".match? url
-        url.sub(prefix, '').sub(%r"\/$", '')
-      else
-        url
-      end
-    end
   end
 end

data/lib/arx/query/validate.rb

@@ -1,6 +1,7 @@
 module Arx
 
   # Validations for arXiv search query fields and identifier schemes.
+  #
   # @private
   module Validate
     class << self
@@ -94,7 +95,9 @@ module Arx
       # @see NEW_IDENTIFIER_FORMAT
       # @see OLD_IDENTIFIER_FORMAT
       def id?(id)
-        NEW_IDENTIFIER_FORMAT.match?(id) || OLD_IDENTIFIER_FORMAT.match?(id)
+        return true if NEW_IDENTIFIER_FORMAT.match? id
+        return true if OLD_IDENTIFIER_FORMAT.match?(id) && Arx::CATEGORIES.keys.include?(id.split('/').first)
+        false
       end
     end
   end

data/lib/arx/version.rb

@@ -4,9 +4,9 @@ module Arx
 
   # The current version of Arx.
   VERSION = {
-    major: 0,
-    minor: 3,
-    patch: 2,
+    major: 1,
+    minor: 2,
+    patch: 1,
     meta: nil,
   }.compact.values.join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Edwin Onuonga
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-30 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -42,44 +42,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.20.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: 
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+description:
 email:
-- ed@mail.eonu.net
+- ed@eonu.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -128,13 +162,13 @@ metadata:
   documentation_uri: https://www.rubydoc.info/github/eonu/arx/master/toplevel
   bug_tracker_uri: https://github.com/eonu/arx/issues
   changelog_uri: https://github.com/eonu/arx/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -143,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A Ruby interface for querying academic papers on the arXiv search API.
 test_files: []