arx 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b23b9ea5d15ed9ed58108f69176cebe48f6d5ce44f7fd4f4bd6e2937d36e8a20
-  data.tar.gz: 0f0928e5737bbd6d5a0c2f058e4fc198b75f5968f94630d0648755616d2085a8
+  metadata.gz: 71eb1bee2ff468ea9327736e613e40b414c2b630d4f21b148da648500af3a47e
+  data.tar.gz: 8592a476d3abbeedfe2bef11637498b551fd478d643c5985a7c6a119aa79ca80
 SHA512:
-  metadata.gz: edf64375f0efffb2722afb5746d5fd5e7ce150c88f2a8ebecdf58db3ca8b1de9c24cb950630e33f418db54d98c7cc351d5ee370e3fc481de55a4b3da59b658bd
-  data.tar.gz: bdb9966e13ede3888ff707c8c5c1350cb74af45b276b392242985adc9e6f48ab41ca5ecc1b5f53289ac862adadcaabdd58f509932d930feac75aefc47a8ba6e1
+  metadata.gz: c9d708bd3f7d244f8557da0c9dba42d66c9a344a8f0316463879e76cc385fcf895c4c4089a5340543e166d771958d975fac685d27908755be0575e97f70625c2
+  data.tar.gz: 382f4ec892499c9e3b062693755aaa4af6c86790a830aaee39a2435d8af902d7e6bdcfc91712eaa539ef3e066c6a6ae04c151327951477194b0ca722848b0d2c

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+# 1.1.0
+
+#### Major changes
+
+- Change `bundler` requirement to `>= 1.17` in `arx.gemspec`. ([#53](https://github.com/eonu/arx/pull/53))
+- Remove `Arx.find` alias of `Arx.search`. ([#57](https://github.com/eonu/arx/pull/57))
+- Add `Query#group` for subquery grouping support. ([#59](https://github.com/eonu/arx/pull/59))
+
+#### Minor changes
+
+- Add contributing guidelines (`CONTRIBUTING.md`). ([#48](https://github.com/eonu/arx/pull/48))
+- Add issue templates to `./github/ISSUE_TEMPLATE` for ([#49](https://github.com/eonu/arx/pull/49), [#54](https://github.com/eonu/arx/pull/54), [#55](https://github.com/eonu/arx/pull/55)):
+  - **Error or warning**<br>For reporting an error or warning generated by Arx.
+  - **Unexpected or incorrect functionality**<br>For reporting something that doesn't seem to be working correctly or is unexpected.
+  - **Improvement to an existing feature**<br>For suggesting an improvement to a feature already offered by Arx.
+  - **Suggesting a new feature**<br>For proposing a new feature to Arx that would be beneficial.
+- Add a pull request template at `./github/PULL_REQUEST_TEMPLATE.md`. ([#49](https://github.com/eonu/arx/pull/49))
+- Remove issue templates from `CONTRIBUTING.md`. ([#49](https://github.com/eonu/arx/pull/49))
+- Remove `LICENSE` from YARD documentation (remove from `.yardopts`). ([#50](https://github.com/eonu/arx/pull/50))
+- Add RVM ruby version `2.6` to `.travis.yml`. ([#53](https://github.com/eonu/arx/pull/53))
+- Add contributor code-of-conduct (`CODE_OF_CONDUCT.md`). ([#56](https://github.com/eonu/arx/pull/56))
+- Thank Scholastica in `README.md`. ([#58](https://github.com/eonu/arx/pull/58))
+- Add `bin/console` for gem debugging. ([#60](https://github.com/eonu/arx/pull/60))
+- Modify `gem:debug` rake task to run `bin/console`. ([#60](https://github.com/eonu/arx/pull/60))
+
+# 1.0.1
+
+#### Major changes
+
+- Add cases to handle `nil` query returns. ([#45](https://github.com/eonu/arx/pull/45))
+- Add support for the `coveralls` gem (`.coveralls.yml` configuration file). ([#42](https://github.com/eonu/arx/pull/42))
+
+#### Minor changes
+
+- Add code coverage badge to `README.md`. ([#42](https://github.com/eonu/arx/pull/42))
+- Remove documentation badge from top of `README.md`. ([#42](https://github.com/eonu/arx/pull/42))
+- Change author email from `ed@mail.eonu.net` to `ed@eonu.net`. ([#43](https://github.com/eonu/arx/pull/43))
+- Change `ends_with_connective?` to `end_with_connective?` to follow typical Ruby patterns. ([#44](https://github.com/eonu/arx/pull/44))
+- Add `/coverage/` directory to `.gitignore`. ([#45](https://github.com/eonu/arx/pull/45))
+- Remove version numbers from paper identifiers in error message in `README.md`. ([#46](https://github.com/eonu/arx/pull/46))
+
 # 1.0.0
 
 #### Major changes

data/README.md

@@ -7,8 +7,8 @@
 [![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/github/eonu/arx/master/toplevel)
 [![Build Status](https://travis-ci.com/eonu/arx.svg?branch=master)](https://travis-ci.com/eonu/arx)
+[![Coverage Status](https://coveralls.io/repos/github/eonu/arx/badge.svg?branch=feature%2Fcoveralls)](https://coveralls.io/github/eonu/arx?branch=feature%2Fcoveralls)
 
 **A Ruby interface for querying academic papers on the arXiv search API.**
 
@@ -60,6 +60,10 @@ $ gem install arx
 
 The documentation for Arx is hosted on [![rubydoc.info](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/github/eonu/arx/master/toplevel).
 
+## Contributing
+
+All contributions to Arx are greatly appreciated. Contribution guidelines can be found [here](/CONTRIBUTING.md).
+
 ## Usage
 
 Before you start using Arx, you'll have to ensure that the gem is required (either in your current working file, or shell such as [IRB](https://en.wikipedia.org/wiki/Interactive_Ruby_Shell)):
@@ -205,6 +209,39 @@ q.and_not
 q.category('math.NA', 'math.CO', connective: :or)
 ```
 
+#### Grouping subqueries
+
+Sometimes you'll have a query that requires nested or grouped logic, using parentheses. This can be done using the `Arx::Query#group` method.
+
+This method accepts a block and basically parenthesises the result of whichever methods were called within the block.
+
+For example, this will allow the last query from the previous section to be written as:
+
+```ruby
+# Papers authored by "Eleonora Andreotti" in neither the "Numerical Analysis" (math.NA) or "Combinatorics (math.CO)" categories.
+q = Arx::Query.new
+q.author('Eleonora Andreotti')
+q.and_not
+q.group do
+  q.category('math.NA').or.category('math.CO')
+end
+```
+
+Another more complicated example with two grouped subqueries:
+
+```ruby
+# Papers whose title contains "Buchi Automata", either authored by "Tomáš Babiak", or in the "Formal Languages and Automata Theory (cs.FL)" category and not the "Computational Complexity (cs.CC)" category.
+q = Arx::Query.new
+q.title('Buchi Automata')
+q.group do
+  q.author('Tomáš Babiak')
+  q.or
+  q.group do
+    q.category('cs.FL').and_not.category('cs.CC')
+  end
+end
+```
+
 ### Running search queries
 
 Search queries can be executed with the `Arx()` method (alias of `Arx.search`). This method contains the same parameters as the `Arx::Query` initializer - including the list of IDs.
@@ -307,13 +344,13 @@ paper.updated_at
 paper.comment?
 #=> false
 paper.comment
-#=> Arx::Error::MissingField (arXiv paper 1809.09415v1 is missing the `comment` metadata field)
+#=> Arx::Error::MissingField (arXiv paper 1809.09415 is missing the `comment` metadata field)
 
 # Paper's journal reference
 paper.journal?
 #=> false
 paper.journal
-#=> Arx::Error::MissingField (arXiv paper 1809.09415v1 is missing the `journal` metadata field)
+#=> Arx::Error::MissingField (arXiv paper 1809.09415 is missing the `journal` metadata field)
 
 # Paper's PDF URL
 paper.pdf?
@@ -359,4 +396,14 @@ category.name
 #=> "cond-mat"
 category.full_name
 #=> "Condensed Matter"
-```
+```
+
+# Thanks
+
+A large portion of this library is based on the brilliant work done by [Scholastica](https://github.com/scholastica) in their [`arxiv`](https://github.com/scholastica/arxiv) gem for retrieving individual papers from arXiv through the search API.
+
+Arx was created mostly due to the seemingly inactive nature of Scholastica's repository. Additionally, it would have been infeasible to contribute such large changes to an already well-established gem, especially since https://scholasticahq.com/ appears to be dependent upon this gem.
+
+---
+
+Nevertheless, a special thanks goes out to Scholastica for providing the influence for Arx.

data/Rakefile

@@ -13,7 +13,7 @@ namespace :gem do
 
   desc 'Debug the gem (load into IRB)'
   task :debug do
-    exec 'bundle exec rake install && irb -I lib/arx.rb -r arx'
+    exec 'bin/console'
   end
 
   desc 'Prepare a new gem release'

data/arx.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'arx'
   spec.version       = Arx::VERSION
   spec.authors       = ['Edwin Onuonga']
-  spec.email         = ['ed@mail.eonu.net']
+  spec.email         = ['ed@eonu.net']
   spec.homepage      = 'https://github.com/eonu/arx'
 
   spec.summary       = %q{A Ruby interface for querying academic papers on the arXiv search API.}
@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
   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 'bundler', '>= 1.17'
   spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'thor', '~> 0.20'
+  spec.add_development_dependency 'thor', '~> 0.19.4'
   spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'coveralls', '0.8.22'
 
   spec.metadata = {
     'source_code_uri' => spec.homepage,

data/lib/arx/query/query.rb

@@ -173,6 +173,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]
@@ -189,7 +203,7 @@ module Arx
     # @return [self]
     def add_connective(connective)
       if search_query?
-        @query << "+#{CONNECTIVES[connective]}" unless ends_with_connective?
+        @query << "+#{CONNECTIVES[connective]}" unless end_with_connective? || start_of_group?
       end
       self
     end
@@ -198,9 +212,10 @@ module Arx
     #
     # @param subquery [String] The subquery to add.
     def add_subquery(subquery)
+      add_connective :and unless end_with_connective?
+
       if search_query?
-        add_connective :and unless ends_with_connective?
-        @query << "+#{subquery}"
+        @query << (start_of_group? ? "#{subquery}" : "+#{subquery}")
       else
         @query << "&#{PARAMS[:search_query]}=#{subquery}"
       end
@@ -218,10 +233,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.

data/lib/arx/version.rb

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

data/lib/arx.rb

@@ -65,12 +65,17 @@ module Arx
         raise Error::MissingPaper.new(ids.first) if results.title.empty?
       elsif results.is_a? Array
         results.reject! {|paper| paper.title.empty?}
+      elsif results.nil?
+        if ids.size == 1
+          raise Error::MissingPaper.new(ids.first)
+        else
+          results = []
+        end
       end
 
       results
     end
 
-    alias_method :find, :search
     alias_method :get, :search
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.19.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +94,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.22
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.22
 description: 
 email:
-- ed@mail.eonu.net
+- ed@eonu.net
 executables: []
 extensions: []
 extra_rdoc_files: []