ldpath 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28ccab2d84a4940b22d84fb600e064502c13e66
-  data.tar.gz: df43a5b99ec5247b4dfe47a6cb13a9d8ce2049ba
+  metadata.gz: 214f447c642fd8d87b794962987dc6ab57112c08
+  data.tar.gz: 4b0a6a855fae1a2532e9f081d9e8c17f52da8974
 SHA512:
-  metadata.gz: da380d1b4292306f3465036491ecb03ce233bf4b14620e0a3ad9ceeddc37628c78c67acebb1061f5c1ac5ce4a591c4c00e7b2fe791bb32189d45c1c8888def06
-  data.tar.gz: 3a37f12008af97a7acd1cacf11d469efe5d6825f902b6d00927264a0a49bad51ae34412ef17e393b702cc649f192ab1bdc3004c728adc3b6c5c2fa673530c8c6
+  metadata.gz: 12447d394cf8c3ee69b7835246a58b5a71d1a53dd088d97c52c1557baeb67061b9ef35b79538572883a10cca84e1795497aaea91330823ac280b6002eb59245f
+  data.tar.gz: 8e0fb7e040b1e3163bde5558fa51fc669e5cf8e3f03f0ceffbba20ca831b961d9a3e5ef349e62eb5da2f80187a102120a9e9863fb4734d9193e3b769b3a04e45

data/.rubocop.yml

@@ -1,7 +1,8 @@
 inherit_from:
-  - .rubocop_hound.yml
   - .rubocop_todo.yml
 
-AllCops:
-  Exclude:
-    - "*.gemspec"
+Metrics/LineLength:
+  Max: 140
+
+Style/WordArray:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,36 +1,5 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-05-03 18:22:33 -0700 using RuboCop version 0.30.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-# Offense count: 68
-# Cop supports --auto-correct.
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-# Offense count: 4
-Metrics/AbcSize:
-  Max: 28
-
-# Offense count: 47
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 171
-
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/ExtraSpacing:
+Style/StringLiterals:
   Enabled: false
 
-# Offense count: 42
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
+Style/Documentation:
   Enabled: false

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.4.5
+  - 2.5.3
+before_install:
+  - gem update --system

data/CHANGELOG.md

@@ -0,0 +1,98 @@
+### 1.0.0 (2019-03-29)
+
+* add ability to restrict results to passed in context
+* Add Coveralls for test coverage analysis
+* update to make all tests pass
+* move to samvera-labs
+* Refactor recursive path selector
+* Extract Result#evaluate to FieldMapping#evaluate
+* Defer mapping enumerables to arrays until Result#to_hash
+* Remove hound's rubocop styling and replace with default upstream styles
+* Convert selectors to yield enumerators instead of arrays
+* Extract Ldpath::Result from Ldpath::Program
+* Update travis build matrix
+* Update to rdf 2.x
+* Refactor grouping rule into a macro
+* Refactor and/or tests to use left and right operands
+* Refactor transforms to remove case statements within rules
+* Add the range \u10000 - \uEFFFF to the allowed prefix chars
+* Add simplecov
+* Add NegatedPropertySelector from sparql property paths
+* Add reasonable error handling to the ldpath binary
+
+### 0.3.1 (2015-05-04)
+
+* Add reasonable error handling to parsing the user input
+
+### 0.3.0 (2015-05-04)
+
+* push literal parsing down to literal
+* map strings to strings
+* Parse literals into properly typed and lang-tagged literals
+
+### 0.2.0 (2015-05-03)
+
+* Use rubocop to enforce a common style
+* refactor parser rules
+* Improve transform specs
+* Add 'zero or one' path operator
+* refactor recursive_path_selector
+* refactoring parsing for compound selectors
+* Add support for single line, sparql-style comments
+* Use sparql's definition of the prefix identifier
+* Adopt turtle's EBNF names for basic types
+* require that the prologue occur before the mappings
+* add parsing spec
+* Use parse, not parse_with_debug
+* Simplify the ldpath parser
+* Add list-aware functions
+
+### 0.1.0 (2015-04-04)
+
+* Add bin/ldpath
+* Update gem homepage
+* Support parsing the field type options
+* Parse and ignore @boost
+* Support @filter
+* Add more lenient whitespace parsing
+* Add fn:xpath
+* Complete test functions (fn:eq, fn:ne, etc)
+
+### 0.0.2 (2015-04-02)
+
+* Fix and test ldpath functions receiving selectors
+* Load rdf/reasoner as a dev dependency
+* Always attempt retrieve resources unless they've been previously fetched
+* Add loose property selector (~) for allowing super-properties to be u…
+* Add debug logging when loading resources
+* Add tap selector for saving additional metadata while evaluating a ma… 
+* Use RDF::Util::Cache by default to cache retrieved graphs
+* Add fn:predicates function for retrieving available predicates for an…
+
+### 0.0.1 (2014-07-21)
+
+* Update README.md
+* Add is and is-a tests
+* Add add/or/not tests
+* Add type test
+* Handle mapping fields to literals
+* Allow strlits to include escaped quotes
+* treat functions as a mixin to the program
+* Update functions to support property arrays for certain arguments
+* Naive stub implementations for functions
+* Improve the parser tests
+* Naively try to load up RDF graphs whenver they are referenced by URI
+* Add field datatype declarations
+* Extract Ldpath::Selector to handle the default wrapping/unwrapping
+* Add convenient accessor to parse and evaluate a program
+* Reorganize Ldpath::Transform
+* Re-organize the Ldpath::Parser rules
+* Anywhere there's whitespace is (probably) a valid place for a multili…
+* Implement partial testing selectors
+* Add recursive path selector
+* Implement low-hanging selectors
+* add README
+* Implement path selector evaluation
+* Demonstrate evaluating an LDPath program with a simple property selector
+* first pass at transforming the parslet output into an AST
+* initial commit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,36 @@
+The Samvera community is dedicated to providing a welcoming and
+positive experience for all its members, whether they are at a formal
+gathering, in a social setting, or taking part in activities online.
+The Samvera community welcomes participation from people all over the
+world and these members bring with them a wide variety of
+professional, personal and social backgrounds; whatever these may be,
+we treat colleagues with dignity and respect.
+
+Community members communicate primarily in English, though for many of
+them this is not their native language. We therefore strive to express
+ourselves simply and clearly remembering that unnecessary use of
+jargon and slang will be a barrier to understanding for many of our
+colleagues.  We are sensitive to the fact that the international
+nature of the community means that we span many different social norms
+around language and behaviour and we strive to conduct ourselves,
+online and in person, in ways that are unlikely to cause offence.
+
+Samvera conversations are often information-rich and intended to
+generate discussion and debate.  We discuss ideas from a standpoint of
+mutual respect and reasoned argument.
+
+Community members work together to promote a respectful and safe
+community. In the event that someone’s conduct is causing offence or
+distress, Samvera has a detailed
+[Anti-Harassment Policy and Protocol](https://wiki.duraspace.org/display/samvera/Anti-Harassment+Policy)
+which can be applied to address the problem. The first step in dealing
+with any serious misconduct is to contact a local meeting organizer,
+the
+[Samvera community helpers](https://wiki.duraspace.org/display/samvera/Samvera+Community+Helpers)
+([email](mailto:helpers@samvera.org)), a community member you
+trust, or the
+[Samvera Steering Group](https://wiki.duraspace.org/display/samvera/Samvera+Steering+Group+membership)
+immediately; at Samvera events, these people can be identified by
+distinctive name badges. The
+[Policy and Protocol](https://wiki.duraspace.org/display/samvera/Anti-Harassment+Policy)
+should be consulted for fuller details.

data/CONTRIBUTING.md

@@ -0,0 +1,161 @@
+# How to Contribute
+
+We want your help to make the Samvera community great. There are a few guidelines
+that we need contributors to follow so that we can have a chance of
+keeping on top of things.
+
+## Code of Conduct
+
+The Samvera Community is dedicated to providing a welcoming and positive
+experience for all its members, whether they are at a formal gathering, in
+a social setting, or taking part in activities online. Please see our
+[Code of Conduct](CODE_OF_CONDUCT.md) for more information.
+
+## Samvera Community Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement
+(iCLA) on file with the Samvera Steering Group. If the contributor works for
+an institution, the institution must have a Corporate Contributor License
+Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Documenting Code
+* Committing Changes
+* Submitting Changes
+* Reviewing and Merging Changes
+
+### 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:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* 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.
+  * 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.
+
+### Documenting Code
+
+* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
+  * Documentation should seek to answer the question "why does this code exist?"
+* Document private / protected methods as desired.
+* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code.
+  * If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
+  * This work greatly increases the usability of the code base and supports the on-ramping of new committers.
+  * We will all be understanding of one another's time constraints in this area.
+* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
+
+### Committing changes
+
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_to do |wants|
+              wants.html { render 'index' }
+            end
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### 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`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * 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))
+  * 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.
+
+### Reviewing and Merging Changes
+
+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.
+
+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.*
+
+#### Things to Consider When Reviewing
+
+First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review.
+
+* Ask clarifying questions
+* State your understanding and expectations
+* Provide example code or alternate solutions, and explain why
+
+This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider:
+
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  * 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?
+
+If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ldpath.gemspec
-gemspec
+gemspec path: File.expand_path('..', __FILE__)
+
+group :development, :test do
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+end

data/README.md

@@ -2,6 +2,10 @@
 
 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)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,17 +32,37 @@ EOF
 
 uri = RDF::URI.new "info:a"
 
-context = RDF::Graph.new << [uri, RDF::DC.title, "Some Title"]
+context = RDF::Graph.new << [uri, RDF::Vocab::DC.title, "Some Title"]
 
 program = Ldpath::Program.parse my_program
 output = program.evaluate uri, context
 # => { ... }
 ```
  
-## Contributing
+## Compatibility
+
+* Ruby 2.5 or the latest 2.4 version is recommended.  Later versions may also work.
+
+## Product Owner & Maintenance
+
+LDPath is moving toward being a Core Component of the Samvera community. The documentation for
+what this means can be found [here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
+
+### Product Owner
+
+[elrayle](https://github.com/elrayle)
+
+# Help
+
+The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
+
+# Acknowledgments
+
+This software has been developed by and is brought to you by the Samvera community.  Learn more at the
+[Samvera website](http://samvera.org/).
+
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)
+
+### Special thanks to...
 
-1. Fork it ( http://github.com/cbeer/ldpath.rb/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[Chris Beer](https://github.com/cbeer) for the initial implementation of this gem!

data/SUPPORT.md

@@ -0,0 +1,6 @@
+If you would like to report an issue, first search [the list of issues](https://github.com/samvera/questioning_authority/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/questioning_authority/issues/new).
+
+If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
+
+You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.
+

data/bin/ldpath

@@ -3,28 +3,36 @@
 require 'optparse'
 require 'open-uri'
 require 'ldpath'
-require 'byebug'
 
 begin
   require 'rest-client'
-  rescue LoadError
+rescue LoadError
 end
 
 options = {}
-OptionParser.new do |opts|
+opt_parser = OptionParser.new do |opts|
   opts.banner = "Usage: ldpath [options] URI"
 
-  opts.on("--program=STRING_URI_OR_FILE", "LDPath program to run (- for STDIN)") do |program|
-    if File.exists?(program) || program =~ /^http/
-      options[:program] = open(program).read
-    elsif program.strip == "-"
-      options[:program] = $stdin.read
-    else
-      options[:program] = program
-    end
+  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/
+                          open(program).read
+                        elsif program.strip == "-"
+                          $stdin.read
+                        else
+                          program
+                        end
   end
-end.parse!
+end
+
+opt_parser.parse!
 
 uri = ARGV.shift
 
+if uri.nil?
+  $stderr.puts opt_parser
+  raise OptionParser::MissingArgument, "URI" unless uri
+end
+
+options[:program] ||= $stdin.read
+
 puts Ldpath::Program.parse(options[:program]).evaluate(RDF::URI.new(uri)).to_json

data/ldpath.gemspec

@@ -8,20 +8,25 @@ Gem::Specification.new do |spec|
   spec.version       = Ldpath::VERSION
   spec.authors       = ["Chris Beer"]
   spec.email         = ["cabeer@stanford.edu"]
-  spec.summary       = %q{Ruby implementation of LDPath}
-  spec.homepage      = "https://github.com/cbeer/ldpath.rb"
+  spec.summary       = "Ruby implementation of LDPath"
+  spec.homepage      = "https://github.com/samvera-labs/ldpath"
   spec.license       = "Apache 2"
 
   spec.files         = `git ls-files -z`.split("\x0")
   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.add_dependency "parslet"
-  spec.add_dependency "linkeddata"
+  spec.add_dependency "linkeddata", "~> 2.0"
 
+  # spec.add_development_dependency "bixby", "~> 1.0.0"
   spec.add_development_dependency "bundler", "~> 1.5"
+  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 "webmock"
 end

data/lib/ldpath/field_mapping.rb

@@ -1 +1,43 @@
-Ldpath::FieldMapping = Struct.new(:name, :selector, :field_type)
+module Ldpath
+  class FieldMapping
+    attr_reader :name, :selector, :field_type
+
+    def initialize(name:, selector:, field_type: nil, options: {})
+      @name = name.to_s
+      @selector = selector
+      @field_type = field_type
+      @options = options
+    end
+
+    def evaluate(program, uri, context)
+      case selector
+      when Ldpath::Selector
+        return to_enum(:evaluate, program, uri, context) unless block_given?
+
+        selector.evaluate(program, uri, context).each do |value|
+          yield transform_value(value)
+        end
+      when RDF::Literal
+        Array(selector.canonicalize.object)
+      else
+        Array(selector)
+      end
+    end
+
+    private
+
+    def transform_value(value)
+      v = if value.is_a? RDF::Literal
+            value.canonicalize.object
+          else
+            value
+          end
+
+      if field_type
+        RDF::Literal.new(v.to_s, datatype: field_type).canonicalize.object
+      else
+        v
+      end
+    end
+  end
+end