rdf-kv 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deb27dba84f5646d65c33ad83bd4ac842724ed0458f943194c572ef06b9ab679
-  data.tar.gz: 150094cd1b73702b87ada062070d66752bab1c28be502aaad8ca754fa7d51815
+  metadata.gz: 8ace8319f10ea7f736fc8881d6546b19c908284189e5a40f1d0e08659bad5b19
+  data.tar.gz: f38dd9a9e778c037aad1199d6fc753bf6c037ba00acf0d6ee6e437e81efc0034
 SHA512:
-  metadata.gz: 49fdd4acc90ca6089385473885b8fc49a9160e7d628eaf53242ab209f9b9858941d533df9966f7a77b853b20e4b203791ac43e58b566443ebab66e4196b18cfc
-  data.tar.gz: 58f9571d7c07fadbe58ca1e171382ea0a00ed43e86b02236dbba8e496be078a9ec62b29b03ce2d927b6ac609817318320adfa52d0f0049c62755f463ee20fe83
+  metadata.gz: efc28fc50193b33e5b461e053eff1e2eed46da55e29dd569b0546b0ef606f05b71dc36430eefed20031b35c25d5a2f455edcebda07f7fe327de7d43cf9373a68
+  data.tar.gz: 053f381f9cf6d907183103f50e47ffd2e5a3f5f85c86b7017dfca0d7733b993cc5994e37feb4890183a8c9f3bbfe7dd5c63829fb9e0b39ccc63b25747c5bc3c4

data/.gitignore

@@ -12,3 +12,4 @@ Gemfile.lock
 .rspec_status
 .\#*
 \#*\#
+*.gem

data/.yardopts

@@ -0,0 +1,7 @@
+--output-dir doc/yard
+--protected
+--no-private
+--hide-void-return
+--markup markdown
+--readme README.md
+-

data/lib/rdf/kv/version.rb

@@ -1,5 +1,5 @@
 module RDF
   class KV
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/rdf/kv.rb

@@ -35,7 +35,7 @@ class RDF::KV
 
   GRAMMAR = /#{PARTIAL_STMT}/o
   MAP     = %i[modifier term1 term2 designator term1 designator graph
-             term1 term2 designator graph deref]
+             term1 term2 designator graph deref].freeze
 
   # these should be instance_exec'd
   SPECIALS = {
@@ -47,10 +47,10 @@ class RDF::KV
       val.each do |v, _|
         next unless m = /^\s*(#{NCNAME}):\s+(.*)$/o.match(v)
         prefix, uri = m.captures
-        @namespaces[prefix.to_sym] = RDF::Vocabulary.new uri
+        @prefixes[prefix.to_sym] = RDF::Vocabulary.new uri
       end
     },
-  }
+  }.freeze
 
   # macros are initially represented as a pair: the macro value and a
   # flag denoting whether or not the macro itself contains macros and to
@@ -60,7 +60,7 @@ class RDF::KV
     NEW_UUID_URN: [[-> { UUIDTools::UUID.random_create.to_uri }, false]],
     NEW_BNODE:    [[-> { "_:#{UUID::NCName.to_ncname_64(
           UUIDTools::UUID.random_create.to_s, version: 1) }" }, false]],
-  }
+  }.freeze
 
   # just the classics
   DEFAULT_NS = {
@@ -70,15 +70,14 @@ class RDF::KV
     xsd:  RDF::XSD,
   }.freeze
 
+  # Given a (massaged) set of macros, dereference the given array of
+  # strings and return it.
   def deref_content strings, macros
     strings = [strings] unless strings.is_a? Array
     # bail out early if there is nothing to do
     return strings unless strings.any? { |s| /#{MACRO}/o.match s }
     out = []
     strings.each do |s|
-      # sometimes these are arrays of arrays
-      #s = s.first if s.is_a? Array
-
       # chunks are parallel output; each element is a value
       chunks = []
       s.scan(/\G#{MACROS}/o) do |m|
@@ -125,6 +124,10 @@ class RDF::KV
     out
   end
 
+  # Given the structure of macro declarations, dereference any
+  # recursively-defined macros, and return a new structure with a key
+  # and array of _values_, rather than an array of `[value, deref]`
+  # pairs.
   def massage_macros macros
     seen = {}
     done = GENERATED.transform_values { |v| v.map { |w| w.first } }
@@ -147,9 +150,7 @@ class RDF::KV
         next unless deref
 
         if deref.is_a? Array
-          deref.each do |m|
-            done[m] ? dm[m] = true : pm[m] = true
-          end
+          deref.each { |m| done[m] ? dm[m] = true : pm[m] = true }
         else
           m = {}
           val.scan(/#{MACRO}/o).compact.each do |x|
@@ -161,7 +162,8 @@ class RDF::KV
 
             done[m] ? dm[m] = true : pm[m] = true
           end
-          # push the deref
+
+          # replace the deref flag with the elements to deref with
           pair[1] = m.empty? ? false : m.keys.sort
         end
       end
@@ -174,6 +176,7 @@ class RDF::KV
           q << m
         end
 
+        # put the current key back on the queue but put the dependencies first
         queue = q + [k] + queue
         next
       end
@@ -205,7 +208,7 @@ class RDF::KV
     # ugh now we gotta do urls
     if m = /^(#{NCNAME}):(\S*)$/o.match(term)
       prefix, slug = m.captures
-      if !slug.start_with?(?/) and vocab = namespaces[prefix.to_sym]
+      if !slug.start_with?(?/) and vocab = prefixes[prefix.to_sym]
         return vocab[slug]
       end
     end
@@ -238,37 +241,39 @@ class RDF::KV
 
     # call the callback if we have one
     term = callback.call term if callback
-      
+
     term
   end
 
   public
 
-  attr_reader :subject, :graph, :namespaces, :callback
+  attr_reader :subject, :graph, :prefixes, :callback
+  # why is this :target, :source
+  alias_method :namespaces, :prefixes
 
   # Initialize the processor.
   #
-  # @param subject    [RDF::URI] The default subject. Required.
-  # @param graph      [RDF::URI] The default context. Optional.
-  # @param namespaces [Hash]     Namespace/prefix mappings. Optional.
-  # @param callback   [#call]    A callback that expects and returns a term.
+  # @param subject  [RDF::URI] The default subject. Required.
+  # @param graph    [RDF::URI] The default context. Optional.
+  # @param prefixes [Hash]     Namespace/prefix mappings. Optional.
+  # @param callback [#call]    A callback that expects and returns a term.
   #  Optional.
   #
-  def initialize subject: nil, graph: nil, namespaces: {}, callback: nil
+  def initialize subject: nil, graph: nil, prefixes: {}, callback: nil
     # look at all of our pretty assertions
     raise ArgumentError, 'subject must be an RDF::Resource' unless
       subject.is_a? RDF::Resource
     raise ArgumentError, 'graph must be an RDF::Resource' unless
       graph.nil? or graph.is_a? RDF::Resource
-    raise ArgumentError, 'namespaces must be hashable' unless
-      namespaces.respond_to? :to_h
+    raise ArgumentError, 'prefixes must be hashable' unless
+      prefixes.respond_to? :to_h
     rase ArgumentError, 'callback must be callable' unless
       callback.nil? or callback.respond_to? :call
 
-    @subject    = subject
-    @graph      = graph
-    @callback   = callback
-    @namespaces = DEFAULT_NS.merge(namespaces.to_h.map do |k, v|
+    @subject  = subject
+    @graph    = graph
+    @callback = callback
+    @prefixes = DEFAULT_NS.merge(prefixes.to_h.map do |k, v|
       k = k.to_s.to_sym    unless k.is_a? Symbol
       # coerce to uri
       v = RDF::URI(v.to_s) unless v.is_a? RDF::Resource
@@ -327,7 +332,7 @@ class RDF::KV
       end
     rescue Exception => e
       # again this should be nicer
-      raise e
+      raise Error.new e
     end
 
     # this will be our output
@@ -418,4 +423,6 @@ class RDF::KV
 
     patch
   end
+
+  class Error < RuntimeError; end
 end

data/lib/rdf-kv.rb

@@ -0,0 +1 @@
+require 'rdf/kv'

data/rdf-kv.gemspec

@@ -29,16 +29,16 @@ RDF::Changeset.
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
   # dev/test dependencies
   spec.add_development_dependency 'bundler',   '~> 2'
-  spec.add_development_dependency 'rdf-vocab', '~> 3.1'
+  spec.add_development_dependency 'rdf-vocab', '~> 3'
 
   # stuff we use
-  spec.add_runtime_dependency 'rdf',       '>= 3.1.1' # include my changes
+  spec.add_runtime_dependency 'rdf',       '~> 3' # include my changes
   spec.add_runtime_dependency 'uuidtools', '~> 2'
 
   # stuff i wrote
-  spec.add_runtime_dependency 'uuid-ncname', '>= 0.2.5'
+  spec.add_runtime_dependency 'uuid-ncname', '>= 0.4'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdf-kv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dorian Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: '0.4'
 description: |
   This module implements https://doriantaylor.com/rdf-kv, taking
   key-value input (e.g. from a Web form) and converting it into an
@@ -93,12 +93,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/rdf-kv.rb
 - lib/rdf/kv.rb
 - lib/rdf/kv/version.rb
 - rdf-kv.gemspec
@@ -107,7 +109,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/doriantaylor/rb-rdf-kv
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +117,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Ruby implementation of the RDF-KV protocol
 test_files: []