ldpath 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 214f447c642fd8d87b794962987dc6ab57112c08
-  data.tar.gz: 4b0a6a855fae1a2532e9f081d9e8c17f52da8974
+SHA256:
+  metadata.gz: 82871915420d36fcd416a717f35185c1c1ab830390a65b071ea3740301d066b1
+  data.tar.gz: 41ecdc3227ddbf93b00dfe7929a4efaae21a31188a87fab19695958e3d946bfa
 SHA512:
-  metadata.gz: 12447d394cf8c3ee69b7835246a58b5a71d1a53dd088d97c52c1557baeb67061b9ef35b79538572883a10cca84e1795497aaea91330823ac280b6002eb59245f
-  data.tar.gz: 8e0fb7e040b1e3163bde5558fa51fc669e5cf8e3f03f0ceffbba20ca831b961d9a3e5ef349e62eb5da2f80187a102120a9e9863fb4734d9193e3b769b3a04e45
+  metadata.gz: 5b924bc7118ed584e4b0cf140ee51655b969a0ea7c0740ad17aae8732204833b6588971518e1db7e96ed6702f460098caa1f0cf83f2e49ed393dd229b7c158cd
+  data.tar.gz: dc0452a7565fb8d26ae1c078cd756479d88b2008aaf5faf8a64e7e6b17e667de358ac8836efd1296feb4662bd4ae31574c05b322995d7d42768aa138ca180a1a

data/.circleci/config.yml

@@ -0,0 +1,49 @@
+---
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@1.0
+
+jobs:
+  bundle_and_test:
+    parameters:
+      ruby_version:
+        type: string
+      bundler_version:
+        type: string
+        default: 2.3.10
+
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+
+    environment:
+      COVERAGE: true
+
+    working_directory: ~/ldpath
+
+    steps:
+      - samvera/cached_checkout
+
+      - run: 'sudo apt-get update'
+
+      - samvera/bundle:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          cache_version: "2"
+
+      - samvera/rubocop
+
+      - samvera/parallel_rspec
+
+workflows:
+  ci:
+    jobs:
+      - bundle_and_test:
+          name: "ruby3-1"
+          ruby_version: "3.1.2"
+      - bundle_and_test:
+          name: "ruby3-0"
+          ruby_version: "3.0.0"
+      - bundle_and_test:
+          name: "ruby2-7"
+          ruby_version: "2.7.5"

data/.rubocop.yml

@@ -1,8 +1,47 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
 inherit_from:
   - .rubocop_todo.yml
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 140
+  Exclude:
+    - 'lib/ldpath/parser.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/ldpath/selectors.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/ldpath/selectors.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/ldpath_parser_spec.rb'
+    - 'spec/ldpath_program_spec.rb'
+    - 'spec/ldpath_transform_spec.rb'
+    - 'spec/lib/functions/list_spec.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/ldpath/parser.rb'
+    - 'lib/ldpath/transform.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/ldpath/field_mapping.rb'
+    - 'lib/ldpath/selectors.rb'
+    - 'lib/ldpath/transform.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/ldpath/functions.rb'
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/ldpath/functions.rb'
 
 Style/WordArray:
   Enabled: false

data/.travis.yml

@@ -3,4 +3,6 @@ rvm:
   - 2.4.5
   - 2.5.3
 before_install:
-  - gem update --system
+  # cause ruby 2.5 doesn't come with bundler 2.x, which our
+  # gemspec now asks for.
+  - gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 1.1.0 (2020-01-21)
+
+* replace linkeddata dependency with rdf and nokogiri
+* update dependency on bundler to ~> 2.0
+
+### 1.0.1 (2019-04-23)
+
+* remove version restriction for linkeddata dependency
+
 ### 1.0.0 (2019-03-29)
 
 * add ability to restrict results to passed in context

data/CONTRIBUTING.md

@@ -22,6 +22,28 @@ https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Proper
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
+## Language
+
+The language we use matters.  Today, tomorrow, and for years to come
+people will read the code we write.  They will judge us for our
+design, logic, and the words we use to describe the system.
+
+Our words should be accessible.  Favor descriptive words that give
+meaning while avoiding reinforcing systemic inequities.  For example,
+in the Samvera community, we should favor using allowed\_list instead
+of whitelist, denied\_list instead of blacklist, or source/copy
+instead of master/slave.
+
+We're going to get it wrong, but this is a call to keep working to
+make it right.  View our code and the words we choose as a chance to
+have a conversation. A chance to grow an understanding of the systems
+we develop as well as the systems in which we live.
+
+See [“Blacklists” and “whitelists”: a salutary warning concerning the
+prevalence of racist language in discussions of predatory
+publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for
+further details.
+
 ## Contribution Tasks
 
 * Reporting Issues
@@ -34,7 +56,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 ### Reporting Issues
 
 * Make sure you have a [GitHub account](https://github.com/signup/free)
-* Submit a [Github issue](https://github.com/samvera/questioning_authority/issues) by:
+* Submit a [Github issue](https://github.com/samvera-labs/ldpath/issues) by:
   * Clearly describing the issue
     * Provide a descriptive summary
     * Explain the expected behavior
@@ -45,15 +67,22 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 * Fork the repository on GitHub
 * Create a topic branch from where you want to base your work.
-  * This is usually the master branch.
-  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
-  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
-  * Please avoid working directly on the `master` branch.
+  * This is usually the `main` branch.
+  * To quickly create a topic branch based on `main`; `git branch fix/main/my_contribution main`
+  * Then checkout the new branch with `git checkout fix/main/my_contribution`.
+  * Please avoid working directly on the `main` branch.
+  * Please do not create a branch called `master`. (See note below.)
   * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
 * Make sure you have added sufficient tests and documentation for your changes.
   * Test functionality with RSpec; Test features / UI with Capybara.
 * Run _all_ the tests to assure nothing else was accidentally broken.
 
+NOTE: This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) 
+and [language recommendations](#language).  
+Please ***do not*** create a branch called `master` for this repository or as part of 
+your pull request; the branch will either need to be removed or renamed before it can 
+be considered for inclusion in the code base and history of this repository.
+
 ### Documenting Code
 
 * All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
@@ -109,15 +138,15 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 ### Submitting Changes
 
 * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
-* Make sure your branch is up to date with its parent branch (i.e. master)
-  * `git checkout master`
+* Make sure your branch is up to date with its parent branch (i.e. main)
+  * `git checkout main`
   * `git pull --rebase`
   * `git checkout <your-branch>`
-  * `git rebase master`
+  * `git rebase main`
   * It is a good idea to run your tests again.
 * If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
   * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
-  * `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * `git rebase --interactive main` ([See Github help](https://help.github.com/articles/interactive-rebase))
   * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
 * Push your changes to a topic branch in your fork of the repository.
 * Submit a pull request from your fork to the project.
@@ -127,12 +156,15 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories.
 Common checks that may occur in our repositories:
 
-1. Travis CI - where our automated tests are running
-2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
+1. [CircleCI](https://circleci.com/gh/samvera) - where our automated tests are running
+2. RuboCop/Bixby - where we check for style violations
+3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
+4. CodeClimate - is our code remaining healthy (at least according to static code analysis)
+
 
 If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.
 
-*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
+*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (CI tests are usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
 
 #### Things to Consider When Reviewing
 
@@ -149,7 +181,7 @@ This is your chance for a mentoring moment of another developer. Take time to gi
   * Do new or changed methods, modules, and classes have documentation?
   * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
   * Does the description of the new/changed specs match your understanding of what the spec is doing?
-  * Did the Travis tests complete successfully?
+  * Did the Continuous Integration tests complete successfully?
 
 If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
 

data/Gemfile

@@ -1,8 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-gemspec path: File.expand_path('..', __FILE__)
+source 'https://rubygems.org'
 
-group :development, :test do
-  gem 'coveralls', require: false
-  gem 'simplecov', require: false
-end
+gemspec path: File.expand_path(__dir__)

data/README.md

@@ -3,11 +3,12 @@
 This is a ruby implementation of [LDPath](http://marmotta.apache.org/ldpath/language.html), a language for selecting values linked data resources.
 
 [![Gem Version](https://badge.fury.io/rb/ldpath.png)](http://badge.fury.io/rb/ldpath)
-[![Build Status](https://travis-ci.org/samvera-labs/ldpath.png?branch=master)](https://travis-ci.org/samvera-labs/ldpath)
-[![Coverage Status](https://coveralls.io/repos/github/samvera-labs/ldpath/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/ldpath?branch=master)
+[![Build Status](https://circleci.com/gh/samvera-labs/ldpath.svg?style=svg)]
 
 ## Installation
 
+### Required gem installation
+
 Add this line to your application's Gemfile:
 
     gem 'ldpath'
@@ -20,6 +21,10 @@ Or install it yourself as:
 
     $ gem install ldpath
 
+### Additional gem installations
+
+To support RDF serializations, you will need to either install the [linkeddata gem](https://github.com/ruby-rdf/linkeddata) which installs a large set of RDF serializations or, in order to have a smaller dependency footprint, install gems for only the serializations your plan to use in your app.  The list of serializations are in the [README](https://github.com/ruby-rdf/linkeddata/blob/develop/README.md#features) for the linkeddata gem.
+
 ## Usage
 
 ```ruby
@@ -35,14 +40,20 @@ uri = RDF::URI.new "info:a"
 context = RDF::Graph.new << [uri, RDF::Vocab::DC.title, "Some Title"]
 
 program = Ldpath::Program.parse my_program
-output = program.evaluate uri, context
+output = program.evaluate uri, context: context
 # => { ... }
 ```
- 
+
 ## Compatibility
 
 * Ruby 2.5 or the latest 2.4 version is recommended.  Later versions may also work.
 
+## Contributing 
+
+If you're working on PR for this project, create a feature branch off of `main`. 
+
+This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/master/templates/CONTRIBUTING.md#language).  Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.
+
 ## Product Owner & Maintenance
 
 LDPath is moving toward being a Core Component of the Samvera community. The documentation for

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/ldpath

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require 'open-uri'
@@ -6,8 +7,10 @@ require 'ldpath'
 
 begin
   require 'rest-client'
+# rubocop:disable Lint/SuppressedException
 rescue LoadError
 end
+# rubocop:enable Lint/SuppressedException
 
 options = {}
 opt_parser = OptionParser.new do |opts|
@@ -15,7 +18,9 @@ opt_parser = OptionParser.new do |opts|
 
   opts.on("--program=STRING_URI_OR_FILE", "LDPath program to run (reads from STDIN by default)") do |program|
     options[:program] = if File.exist?(program) || program =~ /^http/
+                          # rubocop:disable Security/Open
                           open(program).read
+                          # rubocop:enable Security/Open
                         elsif program.strip == "-"
                           $stdin.read
                         else
@@ -29,7 +34,7 @@ opt_parser.parse!
 uri = ARGV.shift
 
 if uri.nil?
-  $stderr.puts opt_parser
+  warn opt_parser
   raise OptionParser::MissingArgument, "URI" unless uri
 end
 

data/ldpath.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ldpath/version'
 
@@ -16,17 +17,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7.5"
 
+  spec.add_dependency "nokogiri", "~> 1.8"
   spec.add_dependency "parslet"
-  spec.add_dependency "linkeddata", "~> 2.0"
+  spec.add_dependency "rdf", '~> 3.0'
+  spec.add_dependency 'rdf-vocab', '~> 3.0'
 
-  # spec.add_development_dependency "bixby", "~> 1.0.0"
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bixby", "~> 5.0"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
   spec.add_development_dependency "rdf-reasoner"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency "rubocop-rake"
   spec.add_development_dependency "webmock"
 end

data/lib/ldpath/field_mapping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ldpath
   class FieldMapping
     attr_reader :name, :selector, :field_type

data/lib/ldpath/functions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Style/MethodName
 module Ldpath
   module Functions
@@ -60,13 +62,11 @@ module Ldpath
     end
 
     # collections
-    def flatten(uri, context, lists)
+    def flatten(uri, context, lists, &block)
       return to_enum(:flatten, uri, context, lists) unless block_given?
 
       deep_flatten_compact(lists).each do |x|
-        RDF::List.new(subject: x, graph: context).to_a.each do |i|
-          yield i
-        end
+        RDF::List.new(subject: x, graph: context).to_a.each(&block)
       end
     end
 

data/lib/ldpath/loaders/direct.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ldpath
+  module Loaders
+    class Direct
+      def load(uri)
+        Ldpath.logger.debug "Loading #{uri.inspect}"
+
+        reader_types = RDF::Format.reader_types.reject { |t| t.to_s =~ /html/ }.map do |t|
+          %r{text/(?:plain|html)}.match?(t.to_s) ? "#{t};q=0.5" : t
+        end
+
+        RDF::Graph.load(uri, headers: { 'Accept' => reader_types.join(", ") })
+      end
+    end
+  end
+end

data/lib/ldpath/loaders/graph.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ldpath
+  module Loaders
+    class Graph
+      def initialize(graph:)
+        @graph = graph
+      end
+
+      def load(_uri)
+        @graph
+      end
+    end
+  end
+end

data/lib/ldpath/loaders/linked_data_fragment.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Ldpath
+  module Loaders
+    class LinkedDataFragment
+      NEXT_PAGE = RDF::URI('http://www.w3.org/ns/hydra/core#nextPage')
+
+      def initialize(endpoint)
+        @endpoint = endpoint
+      end
+
+      def load(uri)
+        Ldpath.logger.debug "Loading LDF data for #{uri.inspect}"
+
+        graph = RDF::Graph.new
+        request_uri = RDF::URI("#{@endpoint}?subject=#{CGI.escape(uri)}")
+
+        while request_uri
+          Ldpath.logger.debug " -- querying #{request_uri}"
+          request_graph = RDF::Graph.load(request_uri)
+          graph.insert_statements(request_graph)
+          request_uri = request_graph.first_object([request_uri, NEXT_PAGE, nil])
+        end
+
+        graph
+      end
+    end
+  end
+end

data/lib/ldpath/loaders.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ldpath
+  module Loaders
+    autoload(:Direct, 'ldpath/loaders/direct')
+    autoload(:Graph, 'ldpath/loaders/graph')
+    autoload(:LinkedDataFragment, 'ldpath/loaders/linked_data_fragment')
+  end
+end

data/lib/ldpath/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parslet'
 
 module Ldpath
@@ -39,7 +41,7 @@ module Ldpath
 
     rule(:exponent) { match('[Ee]') >> match("[+-]").maybe >> match("\\d").repeat(1) }
     rule(:numeric_literal) { integer.as(:integer) | decimal.as(:decimal) | double.as(:double) }
-    rule(:boolean_literal) { str('true').as(:true) | str('false').as(:false) }
+    rule(:boolean_literal) { str('true').as(true) | str('false').as(false) }
 
     rule(:string) { string_literal_quote | string_literal_single_quote | string_literal_long_single_quote | string_literal_long_quote }
 
@@ -150,7 +152,7 @@ module Ldpath
       (identifier | str("")).as(:id) >> wsp? >>
       colon >> wsp? >>
       iriref >> space? >> scolon.maybe
-      ).as(:prefixID)
+    ).as(:prefixID)
     end
 
     # @graph iri, iri, iri ;

data/lib/ldpath/program.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ldpath
   class Program
     ParseError = Class.new StandardError
@@ -6,7 +8,7 @@ module Ldpath
       def parse(program, transform_context = {})
         ast = transform.apply load(program), transform_context
 
-        Ldpath::Program.new ast.compact, transform_context
+        Ldpath::Program.new ast.compact, **transform_context
       end
 
       def load(program)
@@ -26,20 +28,28 @@ module Ldpath
       end
     end
 
-    attr_reader :mappings, :prefixes, :filters
-    def initialize(mappings, options = {})
-      @mappings ||= mappings
-      @prefixes = options[:prefixes] || {}
-      @filters = options[:filters] || []
+    attr_reader :mappings, :prefixes, :filters, :default_loader, :loaders
+
+    def initialize(mappings, default_loader: Ldpath::Loaders::Direct.new, prefixes: {}, filters: [], loaders: {})
+      @mappings = mappings
+      @default_loader = default_loader
+      @loaders = loaders
+      @prefixes = prefixes
+      @filters = filters
     end
 
     def evaluate(uri, context: nil, limit_to_context: false)
       result = Ldpath::Result.new(self, uri, context: context, limit_to_context: limit_to_context)
-      unless filters.empty?
-        return {} unless filters.all? { |f| f.evaluate(result, uri, result.context) }
-      end
+      return {} if !filters.empty? && !filters.all? { |f| f.evaluate(result, uri, result.context) }
 
       result.to_hash
     end
+
+    def load(uri)
+      loader = loaders.find { |k, _v| uri =~ k }&.last
+      loader ||= default_loader
+
+      loader.load(uri)
+    end
   end
 end

data/lib/ldpath/result.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
 module Ldpath
   class Result
     include Ldpath::Functions
@@ -13,7 +17,7 @@ module Ldpath
     end
 
     def loading(uri, context)
-      return unless uri.to_s =~ /^http/
+      return unless /^http/.match?(uri.to_s)
       return if loaded[uri.to_s]
 
       context << load_graph(uri.to_s) unless limit_to_context?
@@ -21,15 +25,7 @@ module Ldpath
     end
 
     def load_graph(uri)
-      cache[uri] ||= begin
-        Ldpath.logger.debug "[#{object_id}] Loading #{uri.inspect}"
-
-        reader_types = RDF::Format.reader_types.reject { |t| t.to_s =~ /html/ }.map do |t|
-          t.to_s =~ %r{text/(?:plain|html)} ? "#{t};q=0.5" : t
-        end
-
-        RDF::Graph.load(uri, headers: { 'Accept' => reader_types.join(", ") }).tap { loaded[uri] = true }
-      end
+      cache[uri] ||= program.load(uri).tap { loaded[uri] = true }
     end
 
     def [](key)
@@ -54,9 +50,7 @@ module Ldpath
       @context ||= load_graph(uri.to_s)
     end
 
-    def prefixes
-      program.prefixes
-    end
+    delegate :prefixes, to: :program
 
     def meta
       @meta ||= {}