arx 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 060171d105d65f9380f65232ebc4ba838c88c0ea83a1019f07b7ee54c5156cd6
-  data.tar.gz: e8253d7a61f2954f1b5522b7ed98cabd1103973bb85d29bf7f4ace357e2739ea
+  metadata.gz: 292c64f4c39d1d5a1d20ea803f98bd2f02f9830af51babcb1d8a2048ca06b403
+  data.tar.gz: 75ad806933191bcbb3d84c6aad20bcc73f18c559c0c122ca57d49e23f3f7757a
 SHA512:
-  metadata.gz: 3c7ca66790bd3688556174120132e6eae5618202a32d05fe4b9c10c07892ca5e92f9bf71da3adf8f17cbc9a94a05550ed194c85a4dda69217920f2eda230daff
-  data.tar.gz: 8cf1b676f6f18494a1b8b91678b2668ef110114b9987204e92a0ddc6d38001c9bcaa8ae3c065562329c806069a25cfd4ff2ce1ffba28838b27e6e46708f87c55
+  metadata.gz: 6b77f4ada7df3953695822feef7ca7e1f0feeb3d2a5375e3a37b9ae3a6db2d5c03db7979f19a19b6483e74226ca91113324052778a86a12b3f426e5689098b6a
+  data.tar.gz: 419f468c377406c8459528c8755330986b8c3c0545788a9efb99f0f1ee9902a9fc618f4dc760b7b083c9988180f8877cf7cc03ed1e0be8d725552105d7e72044

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 0.3.1
+
+#### Major changes
+
+- Add `.yardopts` for document generation configuration. ([#26](https://github.com/eonu/arx/pull/26))
+- Namespace errors in `Arx::Error` module and remove `Error` prefix from error classes. ([#26](https://github.com/eonu/arx/pull/26))
+- Move identifier format regular expression constant definitions from `Arx::Validate` to top-level namespace `Arx`. ([#26](https://github.com/eonu/arx/pull/26))
+
+#### Minor changes
+
+- Rename `lib/arx/exceptions.rb` to `lib/arx/errors.rb`. ([#26](https://github.com/eonu/arx/pull/26))
+- Make `Arx::Cleaner`, `Arx::Validate`, `Arx::Inspector`, `Arx::Link` private (hidden from `yard` documentation). ([#26](https://github.com/eonu/arx/pull/26))
+
 # 0.3.0
 
 #### Major changes

data/README.md

@@ -287,13 +287,13 @@ paper.revision?
 paper.comment?
 #=> false
 paper.comment
-#=> Arx::MissingFieldError (This arXiv paper is missing the `comment` field)
+#=> Arx::Error::MissingField (This arXiv paper is missing the `comment` field)
 
 # Paper's journal reference
 paper.journal?
 #=> false
 paper.journal
-#=> Arx::MissingFieldError (This arXiv paper is missing the `journal` field)
+#=> Arx::Error::MissingField (This arXiv paper is missing the `journal` field)
 
 # Paper's PDF URL
 paper.pdf?

data/lib/arx.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
+require 'cgi'
 require 'nokogiri'
 require 'open-uri'
+require 'happymapper'
 require 'arx/version'
+require 'arx/cleaner'
+require 'arx/inspector'
 require 'arx/categories'
-require 'arx/query/query'
+require 'arx/error'
 require 'arx/query/validate'
+require 'arx/query/query'
 require 'arx/entities/author'
 require 'arx/entities/category'
+require 'arx/entities/link'
 require 'arx/entities/paper'
 
 # A Ruby interface for querying academic papers on the arXiv search API.
@@ -16,6 +22,26 @@ module Arx
   # The arXiv search API endpoint.
   ENDPOINT = 'http://export.arxiv.org/api/query?'
 
+  # The current arxiv paper identifier scheme (1 April 2007 and onwards).
+  #   The last block of digits can either be five digits (if the paper was published after 1501 - January 2015),
+  #   or four digits (if the paper was published before 1501).
+  #
+  # @see https://arxiv.org/help/arxiv_identifier#new arXiv identifier (new)
+  # @example
+  #   1501.00001
+  #   1705.01662v1
+  #   1412.0135
+  #   0706.0001v2
+  NEW_IDENTIFIER_FORMAT = %r"^\d{4}\.\d{4,5}(v\d+)?$"
+
+  # The legacy arXiv paper identifier scheme (before 1 April 2007).
+  #
+  # @see https://arxiv.org/help/arxiv_identifier#old arXiv identifier (old)
+  # @example
+  #   math/0309136v1
+  #   cond-mat/0211034
+  OLD_IDENTIFIER_FORMAT = %r"^[a-z]+(\-[a-z]+)?\/\d{7}(v\d+)?$"
+
   class << self
 
     # Performs a search query for papers on the arXiv search API.
@@ -37,7 +63,7 @@ module Arx
       document = Nokogiri::XML(open ENDPOINT + query.to_s + '&max_results=10000').remove_namespaces!
 
       results = Paper.parse(document, single: false).reject {|paper| paper.id.empty?}
-      raise MissingPaper.new(ids.first) if results.empty? && ids.size == 1
+      raise Error::MissingPaper.new(ids.first) if results.empty? && ids.size == 1
       ids.size == 1 && results.size == 1 ? results.first : results
     end
 

data/lib/arx/cleaner.rb

@@ -1,6 +1,7 @@
 module Arx
 
   # Class for cleaning strings.
+  # @private
   class Cleaner
 
     # Cleans strings.

data/lib/arx/entities/author.rb

@@ -1,11 +1,9 @@
-require 'happymapper'
-require 'arx/cleaner'
-
 module Arx
 
   # Entity/model representing an arXiv paper's author.
   class Author
     include HappyMapper
+    include Inspector
 
     tag 'author'
 
@@ -25,5 +23,7 @@ module Arx
     def affiliations?
       !affiliations.empty?
     end
+
+    inspector :name, :affiliations?, :affiliations
   end
 end

data/lib/arx/entities/category.rb

@@ -1,11 +1,9 @@
-require 'arx/categories'
-require 'arx/cleaner'
-
 module Arx
 
   # Entity/model representing an arXiv paper's category.
   class Category
     include HappyMapper
+    include Inspector
 
     tag 'category'
 
@@ -20,5 +18,7 @@ module Arx
     def full_name
       CATEGORIES[name]
     end
+
+    inspector :name, :full_name
   end
 end

data/lib/arx/entities/link.rb

@@ -1,8 +1,7 @@
-require 'happymapper'
-
 module Arx
 
   # Helper entity/model representing a link on an arXiv paper.
+  # @private
   class Link
     include HappyMapper
 

data/lib/arx/entities/paper.rb

@@ -1,21 +1,15 @@
-require 'happymapper'
-require 'arx/exceptions'
-require 'arx/cleaner'
-require_relative 'author'
-require_relative 'category'
-require_relative 'link'
-
 module Arx
 
   # Entity/model representing an arXiv paper.
   class Paper
     include HappyMapper
+    include Inspector
 
     tag 'entry'
 
     element :id, Cleaner, parser: :clean, tag: 'id'
     # The identifier of the paper.
-    # @note This is either in {Validate::OLD_IDENTIFIER_FORMAT} or {Validate::NEW_IDENTIFIER_FORMAT}.
+    # @note This is either in {OLD_IDENTIFIER_FORMAT} or {NEW_IDENTIFIER_FORMAT}.
     # @example
     #   1705.01662v1
     #   cond-mat/0211034
@@ -87,7 +81,7 @@ module Arx
     # @!method comment
     # The comment of the paper.
     # @note This is an optional metadata field on an arXiv paper. To check whether the paper has a comment, use {comment?}
-    # @raise {MissingFieldError} If the paper does not have a comment.
+    # @raise {Error::MissingField} If the paper does not have a comment.
     # @return [String]
     element :comment, Cleaner, parser: :clean, tag: 'comment'
 
@@ -98,7 +92,7 @@ module Arx
     # @!method journal
     # The journal reference of the paper.
     # @note This is an optional metadata field on an arXiv paper. To check whether the paper has a journal reference, use {journal?}
-    # @raise {MissingFieldError} If the paper does not have a journal reference.
+    # @raise {Error::MissingField} If the paper does not have a journal reference.
     # @return [String]
     element :journal, Cleaner, parser: :clean, tag: 'journal_ref'
 
@@ -113,7 +107,7 @@ module Arx
         if self.send "#{optional}?"
           instance_variable_get("@#{optional}")
         else
-          raise MissingFieldError.new(optional)
+          raise Error::MissingField.new(optional)
         end
       end
     end
@@ -127,7 +121,7 @@ module Arx
     # @!method pdf_url
     # Link to the PDF version of the paper.
     # @note This is an optional metadata field on an arXiv paper. To check whether the paper has a PDF link, use {pdf?}
-    # @raise {MissingLinkError} If the paper does not have a PDF link.
+    # @raise {Error::MissingLink} If the paper does not have a PDF link.
     # @return [String]
 
     # @!method doi?
@@ -141,7 +135,7 @@ module Arx
     # @see https://arxiv.org/help/jref#doi
     # @see https://arxiv.org/help/prep#doi
     # @note This is an optional metadata field on an arXiv paper. To check whether the paper has a DOI link, use {doi?}
-    # @raise {MissingLinkError} If the paper does not have a DOI link.
+    # @raise {Error::MissingLink} If the paper does not have a DOI link.
     # @return [String]
 
     %i[pdf doi].each do |link_type|
@@ -155,9 +149,19 @@ module Arx
         if self.send exists
           links.find(&exists).href
         else
-          raise MissingLinkError.new link_type.to_s.upcase
+          raise Error::MissingLink.new link_type.to_s.upcase
         end
       end
     end
+
+    inspector *%i[
+      id url title summary authors
+      primary_category categories
+      publish_date last_updated revision?
+      comment? comment
+      journal? journal
+      pdf? pdf_url
+      doi? doi_url
+    ]
   end
 end

data/lib/arx/error.rb

@@ -0,0 +1,27 @@
+module Arx
+
+  # Various arXiv-related errors.
+  module Error
+
+    # Custom error for missing links on an arXiv paper.
+    class MissingLink < StandardError
+      def initialize(link_type)
+        super "This arXiv paper does not have a #{link_type} link"
+      end
+    end
+
+    # Custom error for missing fields on an arXiv paper.
+    class MissingField < StandardError
+      def initialize(field)
+        super "This arXiv paper is missing the `#{field}` field"
+      end
+    end
+
+    # Custom error for missing arXiv papers.
+    class MissingPaper < StandardError
+      def initialize(id)
+        super "Couldn't find an arXiv paper with ID: #{id}"
+      end
+    end
+  end
+end

data/lib/arx/inspector.rb

@@ -0,0 +1,42 @@
+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
+
+    # Overwrites the object's own inspect method.
+    def inspect
+      pairs = {}
+
+      self.class.inspector_fields.each do |field|
+        pairs[field] = self.send(field).inspect
+      rescue
+      end
+
+      "#<#{self.class.name}:#{self.object_id} #{pairs.map {|k,v| "#{k}=#{v}"}.join(", ")}>"
+    end
+
+    class << self
+      # Returns the +inspected+ instance variable, or sets it if undefined.
+      def inspected
+        @inspected ||= []
+      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
+        source.class_eval do
+          def self.inspector(*fields)
+            @inspector_fields = *fields
+          end
+
+          def self.inspector_fields
+            @inspector_fields ||= []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arx/query/query.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'cgi'
-require_relative 'validate'
-
 module Arx
 
   # Class for generating arXiv search API query strings.

data/lib/arx/query/validate.rb

@@ -1,30 +1,8 @@
-require_relative '../categories'
-
 module Arx
 
   # Validations for arXiv search query fields and identifier schemes.
+  # @private
   module Validate
-
-    # The current arxiv paper identifier scheme (1 April 2007 and onwards).
-    #   The last block of digits can either be five digits (if the paper was published after 1501 - January 2015),
-    #   or four digits (if the paper was published before 1501).
-    #
-    # @see https://arxiv.org/help/arxiv_identifier#new arXiv identifier (new)
-    # @example
-    #   1501.00001
-    #   1705.01662v1
-    #   1412.0135
-    #   0706.0001v2
-    NEW_IDENTIFIER_FORMAT = %r"^\d{4}\.\d{4,5}(v\d+)?$"
-
-    # The legacy arXiv paper identifier scheme (before 1 April 2007).
-    #
-    # @see https://arxiv.org/help/arxiv_identifier#old arXiv identifier (old)
-    # @example
-    #   math/0309136v1
-    #   cond-mat/0211034
-    OLD_IDENTIFIER_FORMAT = %r"^[a-z]+(\-[a-z]+)?\/\d{7}(v\d+)?$"
-
     class << self
       # Validates the +sortBy+ field of the query string.
       #

data/lib/arx/version.rb

@@ -6,7 +6,7 @@ module Arx
   VERSION = {
     major: 0,
     minor: 3,
-    patch: 0,
+    patch: 1,
     meta: nil
   }.compact.values.join('.').freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Edwin Onuonga
@@ -100,7 +100,8 @@ files:
 - lib/arx/entities/category.rb
 - lib/arx/entities/link.rb
 - lib/arx/entities/paper.rb
-- lib/arx/exceptions.rb
+- lib/arx/error.rb
+- lib/arx/inspector.rb
 - lib/arx/query/query.rb
 - lib/arx/query/validate.rb
 - lib/arx/version.rb

data/lib/arx/exceptions.rb

@@ -1,23 +0,0 @@
-module Arx
-
-  # Custom error for missing links on an arXiv paper.
-  class MissingLinkError < StandardError
-    def initialize(link_type)
-      super "This arXiv paper does not have a #{link_type} link"
-    end
-  end
-
-  # Custom error for missing fields on an arXiv paper.
-  class MissingFieldError < StandardError
-    def initialize(field)
-      super "This arXiv paper is missing the `#{field}` field"
-    end
-  end
-
-  # Custom error for missing arXiv papers.
-  class MissingPaper < StandardError
-    def initialize(id)
-      super "Couldn't find an arXiv paper with ID: #{id}"
-    end
-  end
-end