arx 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14a14b55d1c42c5804102ce84826f404ec7e91505a0cd2eacf6e92e05f17cee
-  data.tar.gz: d15151e01710261ef194ec5175a4151b5df6e0d336528c24d15b6d1764dc6901
+  metadata.gz: 71eb1bee2ff468ea9327736e613e40b414c2b630d4f21b148da648500af3a47e
+  data.tar.gz: 8592a476d3abbeedfe2bef11637498b551fd478d643c5985a7c6a119aa79ca80
 SHA512:
-  metadata.gz: 10e7463175ceaf3b32d15527247b8e8c9f6e54a3f8c56338c060696c6f919907baf19cfbb8a010e59cd1606037b30a1d46ca8da10bdf5a4a094ef0fa0ecb9f60
-  data.tar.gz: 2b82185ac4299a4541b7d8701abf3e2c8e6fd31811efb888273d665362f7ba9bfd35b45c9cfe6d0991c867e44ed1ac3b8362ed8e5f5d5ac6717cb5c3ff9b0161
+  metadata.gz: c9d708bd3f7d244f8557da0c9dba42d66c9a344a8f0316463879e76cc385fcf895c4c4089a5340543e166d771958d975fac685d27908755be0575e97f70625c2
+  data.tar.gz: 382f4ec892499c9e3b062693755aaa4af6c86790a830aaee39a2435d8af902d7e6bdcfc91712eaa539ef3e066c6a6ae04c151327951477194b0ca722848b0d2c

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# 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

data/README.md

@@ -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.
@@ -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

@@ -21,7 +21,7 @@ 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.19.4'
   spec.add_development_dependency 'rspec', '~> 3.7'

data/lib/arx.rb

@@ -76,7 +76,6 @@ module Arx
       results
     end
 
-    alias_method :find, :search
     alias_method :get, :search
   end
 end

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 end_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 end_with_connective?
-        @query << "+#{subquery}"
+        @query << (start_of_group? ? "#{subquery}" : "+#{subquery}")
       else
         @query << "&#{PARAMS[:search_query]}=#{subquery}"
       end
@@ -222,6 +237,13 @@ module Arx
       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,8 +5,8 @@ module Arx
   # The current version of Arx.
   VERSION = {
     major: 1,
-    minor: 0,
-    patch: 1,
+    minor: 1,
+    patch: 0,
     meta: nil,
   }.compact.values.join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arx
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-14 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