arx 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292c64f4c39d1d5a1d20ea803f98bd2f02f9830af51babcb1d8a2048ca06b403
-  data.tar.gz: 75ad806933191bcbb3d84c6aad20bcc73f18c559c0c122ca57d49e23f3f7757a
+  metadata.gz: b2fa216412d2bdf6261f3fd1ada0b0c50498f13e5a8142dfd3db3433b693e4b4
+  data.tar.gz: 31c272fcc9d1ed4750e88d4c179035a0f37995f1afc030378e656f402a2dfeec
 SHA512:
-  metadata.gz: 6b77f4ada7df3953695822feef7ca7e1f0feeb3d2a5375e3a37b9ae3a6db2d5c03db7979f19a19b6483e74226ca91113324052778a86a12b3f426e5689098b6a
-  data.tar.gz: 419f468c377406c8459528c8755330986b8c3c0545788a9efb99f0f1ee9902a9fc618f4dc760b7b083c9988180f8877cf7cc03ed1e0be8d725552105d7e72044
+  metadata.gz: 8b8c8abf18d875a40e098f95dfb7452389a3b44691ecae568028563b12e5aa02e8b0233bf7fdfc25df58594df30b43f4caca37cf57df43240006ff22a5cfcdec
+  data.tar.gz: a8a40c0d3ccd18a86945e69a136b2275dcfd88a2ddc3678ab3b555f576e68b1d50d346b1c1a233def7bff62cb60fa0a071a870fcd6c41f34dcb8cf217d422437

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.3.2
+
+#### Major changes
+
+- Add `Paper#category` alias for `Paper#primary_category`. ([#34](https://github.com/eonu/arx/pull/34))
+- Change `Author#affiliations?` to `Author#affiliated?`. ([#34](https://github.com/eonu/arx/pull/34))
+- Change `Paper#last_updated` to `Paper#updated_at` (and remove `updated_at` alias). ([#34](https://github.com/eonu/arx/pull/34))
+- Change `Paper#publish_date` to `Paper#published_at` (and remove `published_at` alias). ([#34](https://github.com/eonu/arx/pull/34))
+- Conditionally assign query object in `Arx.search` with `||=` operator. ([#33](https://github.com/eonu/arx/pull/33))
+- Add `gem:debug` rake task for loading the gem into an interactive console. ([#28](https://github.com/eonu/arx/pull/28))
+- Add `gem:release` rake task for preparing gem releases. ([#36](https://github.com/eonu/arx/pull/36))
+- Add `thor` gem development dependency. ([#36](https://github.com/eonu/arx/pull/36))
+
+#### Minor changes
+
+- Update documentation links to `rubydoc.info`'s GitHub service. ([#30](https://github.com/eonu/arx/pull/30))
+- Add email address to `LICENSE`. ([#31](https://github.com/eonu/arx/pull/31))
+- Improve `Error::MissingField` and `Error::MissingLink` error messages. ([#35](https://github.com/eonu/arx/pull/35))
+
 # 0.3.1
 
 #### Major changes

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Edwin Onuonga
+Copyright (c) 2019 Edwin Onuonga <ed@mail.eonu.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,7 +7,7 @@
 [![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)
+[![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)
 
 **A Ruby interface for querying academic papers on the arXiv search API.**
@@ -41,7 +41,7 @@ $ gem install arx
 
 ## Documentation
 
-The documentation for Arx is hosted on [![rubydoc.info](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/gems/arx/toplevel).
+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).
 
 ## Usage
 
@@ -287,13 +287,13 @@ paper.revision?
 paper.comment?
 #=> false
 paper.comment
-#=> Arx::Error::MissingField (This arXiv paper is missing the `comment` field)
+#=> Arx::Error::MissingField (arXiv paper 1809.09415v1 is missing the `comment` metadata field)
 
 # Paper's journal reference
 paper.journal?
 #=> false
 paper.journal
-#=> Arx::Error::MissingField (This arXiv paper is missing the `journal` field)
+#=> Arx::Error::MissingField (arXiv paper 1809.09415v1 is missing the `journal` metadata field)
 
 # Paper's PDF URL
 paper.pdf?
@@ -320,7 +320,7 @@ author = paper.authors.first
 author.name
 #=> "F. Gebhard"
 
-author.affiliations?
+author.affiliated?
 #=> true
 author.affiliations
 #=> ["ILL Grenoble, France"]

data/Rakefile

@@ -1,7 +1,65 @@
+require 'thor'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
 
 desc 'Run application specs'
-RSpec::Core::RakeTask.new :spec
+task default: [:spec]
+
+namespace :gem do
+  class T < Thor
+    include Thor::Actions
+  end
+
+  desc 'Debug the gem (load into IRB)'
+  task :debug do
+    exec 'bundle exec rake install && irb -I lib/arx.rb -r arx'
+  end
+
+  desc 'Prepare a new gem release'
+  task :release, %i[major minor patch meta] do |task, args|
+    array = args.to_a
+    raise ArgumentError.new("Expected at least 3 SemVer segments, got #{array.size}") if array.size < 3
+    raise ArgumentError.new("Expected no more than 4 SemVer segments, got #{array.size}") if array.size > 4
+    args.to_h.each_with_index do |(segment, value), index|
+      next if index == array.size - 1 && array.size == 4
+      raise TypeError.new("Invalid #{segment} SemVer segment: #{value}") unless value == value.to_i.to_s
+    end
+
+    versions = args.to_h.transform_values {|v| v.to_i if Integer(v) rescue v}
+    versions[:meta] ||= nil
+    update_version versions
+
+    version = versions.compact.values.join('.')
+    add_changelog_entry version
+  end
+
+  private
+
+  def update_version(versions)
+    versions.each do |segment, value|
+      thor :gsub_file, File.join(__dir__, 'lib', 'arx', 'version.rb'), /#{segment}: .*,/, "#{segment}: #{value.inspect},"
+    end
+  end
+
+  def add_changelog_entry(version)
+    thor :insert_into_file, File.join(__dir__, 'CHANGELOG.md'), after: /\A/ do
+      <<-ENTRY
+# #{version}
+
+#### Major changes
+
+- TODO
+
+#### Minor changes
+
+- TODO
+
+      ENTRY
+    end
+  end
 
-task default: [:spec]
+  def thor(*args, &block)
+    T.new.send *args, &block
+  end
+end

data/arx.gemspec

@@ -23,12 +23,13 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'thor', '~> 0.20'
   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',
+    'documentation_uri' => 'https://www.rubydoc.info/github/eonu/arx/master/toplevel',
     'bug_tracker_uri' => "#{spec.homepage}/issues",
     'changelog_uri' => "#{spec.homepage}/blob/master/CHANGELOG.md"
   }

data/lib/arx.rb

@@ -53,15 +53,12 @@ module Arx
     # @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, query: nil, sort_by: :relevance, sort_order: :descending)
-      if query.nil?
-        query = Query.new(*ids, sort_by: sort_by, sort_order: sort_order)
-        yield query if block_given?
-      else
-        raise TypeError.new("Expected `query` to be an Arx::Query, got: #{query.class}") unless query.is_a? Query
-      end
+      query ||= Query.new(*ids, sort_by: sort_by, sort_order: sort_order)
+      raise TypeError.new("Expected `query` to be an Arx::Query, got: #{query.class}") unless query.is_a? Query
 
-      document = Nokogiri::XML(open ENDPOINT + query.to_s + '&max_results=10000').remove_namespaces!
+      yield query if block_given?
 
+      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 Error::MissingPaper.new(ids.first) if results.empty? && ids.size == 1
       ids.size == 1 && results.size == 1 ? results.first : results

data/lib/arx/entities/author.rb

@@ -17,13 +17,12 @@ module Arx
     # @return [Array<String>]
     has_many :affiliations, Cleaner, tag: 'affiliation', parser: :clean
 
-    # @!method affiliations?
     # Whether or not the author has any affiliations.
     # @return [Boolean]
-    def affiliations?
+    def affiliated?
       !affiliations.empty?
     end
 
-    inspector :name, :affiliations?, :affiliations
+    inspector :name, :affiliated?, :affiliations
   end
 end

data/lib/arx/entities/paper.rb

@@ -27,17 +27,15 @@ module Arx
       @id
     end
 
-    # @!method last_updated
+    # @!method updated_at
     # The date that the paper was last updated.
     # @return [DateTime]
-    element :last_updated, DateTime, tag: 'updated'
-    alias_method :updated_at, :last_updated
+    element :updated_at, DateTime, tag: 'updated'
 
-    # @!method publish_date
+    # @!method published_at
     # The original publish/submission date of the paper.
     # @return [DateTime]
-    element :publish_date, DateTime, tag: 'published'
-    alias_method :published_at, :publish_date
+    element :published_at, DateTime, tag: 'published'
 
     # @!method title
     # The title of the paper.
@@ -53,19 +51,18 @@ module Arx
     # The primary category of the paper.
     # @return [Category]
     element :primary_category, Category, tag: 'primary_category'
-    alias_method :primary_subject, :primary_category
+    alias_method :category, :primary_category
 
     # @!method categories
     # The categories of the paper.
     # @return [Array<Category>]
     has_many :categories, Category, tag: 'category'
-    alias_method :subjects, :categories
 
     # Whether the paper is a revision or not.
-    # @note A paper is a revision if {last_updated} differs from {publish_date}.
+    # @note A paper is a revision if {updated_at} differs from {published_at}.
     # @return [Boolean]
     def revision?
-      @publish_date != @last_updated
+      @published_at != @updated_at
     end
 
     # @!method summary
@@ -107,7 +104,7 @@ module Arx
         if self.send "#{optional}?"
           instance_variable_get("@#{optional}")
         else
-          raise Error::MissingField.new(optional)
+          raise Error::MissingField.new id, optional
         end
       end
     end
@@ -149,7 +146,7 @@ module Arx
         if self.send exists
           links.find(&exists).href
         else
-          raise Error::MissingLink.new link_type.to_s.upcase
+          raise Error::MissingLink.new id, link_type.to_s.upcase
         end
       end
     end
@@ -157,7 +154,7 @@ module Arx
     inspector *%i[
       id url title summary authors
       primary_category categories
-      publish_date last_updated revision?
+      published_at updated_at revision?
       comment? comment
       journal? journal
       pdf? pdf_url

data/lib/arx/error.rb

@@ -5,15 +5,15 @@ module Arx
 
     # 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"
+      def initialize(id, link_type)
+        super "arXiv paper #{id} 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"
+      def initialize(id, field)
+        super "arXiv paper #{id} is missing the `#{field}` metadata field"
       end
     end
 

data/lib/arx/version.rb

@@ -6,7 +6,7 @@ module Arx
   VERSION = {
     major: 0,
     minor: 3,
-    patch: 1,
-    meta: nil
+    patch: 2,
+    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.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +125,7 @@ licenses:
 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
+  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: