arx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2022e15b66aaccb897b5596132b924ed9104040f8d090789312636be309eaf
-  data.tar.gz: 844f3ca659a5e60168f7368db64942f90c4ab035c0d0708d726cf0bed65d6c4b
+  metadata.gz: 77d25732b98e3be9492bc5e103c51a2919217510e4b85e4690c1338ece3ef1fd
+  data.tar.gz: 0cb9a4134e64581160c079fdd47c3082f39eb72b3069a13c3f6ebd2a74c14eae
 SHA512:
-  metadata.gz: 2d95949ba20917ea3f6d570a25011275b56259917fcff040cd1f933f4befe4af1aa037faac82a778b9a62b83c8fc82e618102cfab3e3d5e2c04fdebbbbeef396
-  data.tar.gz: 9db9805a3328cc2cfb9c63b8c0aed45370f79ac0a6042ad5365f26156c966a43c3e818e3dfad424367350e956d92dbfeacd1bcf2cd1d88d7dcd98f81f40d6c33
+  metadata.gz: f91faea3efef98fc048906719b2919267fa78b99ae2e4623b7500a575691af90df5c3a7ed03328f94ebb89f5d17d754e51b6e77548e23b4482d7b603144fcf7c
+  data.tar.gz: 898c9c61db65c62852f0b7a097df59a0fccc77f03a1e853a06b92a0edcf31e3d5c912de1a8fde61e6b511c51523cf89bcd902a64a862d7f6f264e2869dbbad35

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.2.0
+
+#### Major changes
+
+- Flatten provided values in `Arx::Paper`'s field instance methods (allow an array as the `values` splat parameter). ([#5](https://github.com/eonu/arx/pull/5))
+- Add `Arx.find` and `Arx.get` as aliases for `Arx.search`. ([#6](https://github.com/eonu/arx/pull/6), [#8](https://github.com/eonu/arx/pull/8))
+
+#### Minor changes
+
+- Add `homepage` and `metadata` fields to `arx.gemspec`. ([#1](https://github.com/eonu/arx/pull/1), [#14](https://github.com/eonu/arx/pull/14))
+- Specify required ruby version (`~> 2.5`) in `arx.gemspec`. ([#2](https://github.com/eonu/arx/pull/2))
+- Add badges to `README.md`. ([#3](https://github.com/eonu/arx/pull/3), [#9](https://github.com/eonu/arx/pull/9))
+- Fix documentation for `Arx::Paper`'s field methods `exact` argument. ([#4](https://github.com/eonu/arx/pull/4))
+- Update documentation links in `arx.gemspec` and `README.md`. ([#7](https://github.com/eonu/arx/pull/7))
+- Remove newline from end of `Gemfile`. ([#11](https://github.com/eonu/arx/pull/11))
+- Add ruby-head version to RVM rubies in `.travis.yml`. ([#12](https://github.com/eonu/arx/pull/12))
+- Remove unnecessary git-ignored files. ([#13](https://github.com/eonu/arx/pull/13), [#10](https://github.com/eonu/arx/pull/10))
+
 # 0.1.0
 
 Initial commit! 🎉

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/README.md

@@ -1,3 +1,13 @@
 # Arx
 
+<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a8/ArXiv_web.svg/1200px-ArXiv_web.svg.png" width="15%" align="right"></img>
+
+[![Ruby Version](https://img.shields.io/badge/ruby-~%3E%202.5-red.svg)](https://github.com/eonu/arx/blob/503a1c95ac450dbc20623491060c3fc32d213627/arx.gemspec#L19)
+[![Gem](https://img.shields.io/gem/v/arx.svg)](https://rubygems.org/gems/arx)
+[![License](https://img.shields.io/github/license/eonu/arx.svg)](https://github.com/eonu/arx/blob/master/LICENSE)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/e94073dfa8c3e2442298/maintainability)](https://codeclimate.com/github/eonu/arx/maintainability)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/gems/arx/toplevel)
+[![Build Status](https://travis-ci.com/eonu/arx.svg?branch=master)](https://travis-ci.com/eonu/arx)
+
 A Ruby interface for querying academic papers on the arXiv search API.

data/arx.gemspec

@@ -6,7 +6,8 @@ Gem::Specification.new do |spec|
   spec.name          = 'arx'
   spec.version       = Arx::VERSION
   spec.authors       = ['Edwin Onuonga']
-  spec.email         = ['edwinonuonga@gmail.com']
+  spec.email         = ['ed@mail.eonu.net']
+  spec.homepage      = 'https://github.com/eonu/arx'
 
   spec.summary       = %q{A Ruby interface for querying academic papers on the arXiv search API.}
   spec.license       = 'MIT'
@@ -15,10 +16,20 @@ Gem::Specification.new do |spec|
     Gemfile LICENSE CHANGELOG.md README.md Rakefile arx.gemspec
   ]
 
+  spec.required_ruby_version = '~> 2.5'
+
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
   spec.add_runtime_dependency 'nokogiri-happymapper', '~> 0.8'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
+
+  spec.metadata = {
+    'source_code_uri' => spec.homepage,
+    'homepage_uri' => spec.homepage,
+    'documentation_uri' => 'https://www.rubydoc.info/gems/arx/toplevel',
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri' => "#{spec.homepage}/blob/master/CHANGELOG.md"
+  }
 end

data/lib/arx.rb

@@ -16,23 +16,29 @@ module Arx
   # The arXiv search API endpoint.
   ENDPOINT = 'http://export.arxiv.org/api/query?'
 
-  # Performs a search query for papers on the arXiv search API.
-  #
-  # @param ids [Array<String>] The IDs of the arXiv papers to restrict the query to.
-  # @param sort_by [Symbol] The sorting criteria for the returned results (see {Query::SORT_BY}).
-  # @param sort_order [Symbol] The sorting order for the returned results (see {Query::SORT_ORDER}).
-  # @return [Array<Paper>, Paper] The {Paper}(s) found by the search query.
-  def self.search(*ids, sort_by: :relevance, sort_order: :descending)
-    query = Query.new(*ids, sort_by: sort_by, sort_order: sort_order)
-
-    yield query if block_given?
-
-    document = Nokogiri::XML open(ENDPOINT + query.to_s + '&max_results=10000')
-    document.remove_namespaces!
-
-    results = Paper.parse(document, single: false).reject {|paper| paper.id.empty?}
-    raise MissingPaper.new(ids.first) if results.empty? && ids.size == 1
-    ids.size == 1 && results.size == 1 ? results.first : results
+  class << self
+
+    # Performs a search query for papers on the arXiv search API.
+    #
+    # @param ids [Array<String>] The IDs of the arXiv papers to restrict the query to.
+    # @param sort_by [Symbol] The sorting criteria for the returned results (see {Query::SORT_BY}).
+    # @param sort_order [Symbol] The sorting order for the returned results (see {Query::SORT_ORDER}).
+    # @return [Array<Paper>, Paper] The {Paper}(s) found by the search query.
+    def search(*ids, sort_by: :relevance, sort_order: :descending)
+      query = Query.new(*ids, sort_by: sort_by, sort_order: sort_order)
+
+      yield query if block_given?
+
+      document = Nokogiri::XML open(ENDPOINT + query.to_s + '&max_results=10000')
+      document.remove_namespaces!
+
+      results = Paper.parse(document, single: false).reject {|paper| paper.id.empty?}
+      raise MissingPaper.new(ids.first) if results.empty? && ids.size == 1
+      ids.size == 1 && results.size == 1 ? results.first : results
+    end
+
+    alias_method :find, :search
+    alias_method :get, :search
   end
 end
 

data/lib/arx/query/query.rb

@@ -103,35 +103,35 @@ module Arx
       define_method(symbol) { add_connective connective }
     end
 
-    # @!method title(*values, exact: false, connective: :and)
+    # @!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.
     # @return [self]
 
-    # @!method author(*values, exact: false, connective: :and)
+    # @!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.
     # @return [self]
 
-    # @!method abstract(*values, exact: false, connective: :and)
+    # @!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.
     # @return [self]
 
-    # @!method comment(*values, exact: false, connective: :and)
+    # @!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.
     # @return [self]
 
-    # @!method journal(*values, exact: false, connective: :and)
+    # @!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).
@@ -161,6 +161,8 @@ module Arx
       define_method(name) do |*values, exact: true, connective: :and|
         return if values.empty?
 
+        values.flatten!
+
         Validate.values values
         Validate.categories values if name == :category
         Validate.exact exact

data/lib/arx/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -82,7 +82,7 @@ dependencies:
         version: '3.7'
 description: 
 email:
-- edwinonuonga@gmail.com
+- ed@mail.eonu.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -104,19 +104,24 @@ files:
 - lib/arx/query/query.rb
 - lib/arx/query/validate.rb
 - lib/arx/version.rb
-homepage: 
+homepage: https://github.com/eonu/arx
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/eonu/arx
+  homepage_uri: https://github.com/eonu/arx
+  documentation_uri: https://www.rubydoc.info/gems/arx/toplevel
+  bug_tracker_uri: https://github.com/eonu/arx/issues
+  changelog_uri: https://github.com/eonu/arx/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="