rdf-tabular 1.0.0 → 3.1.1

data/lib/rdf/tabular/reader.rb

@@ -5,7 +5,7 @@ module RDF::Tabular
   ##
   # A Tabular Data to RDF parser in Ruby.
   #
-  # @author [Gregg Kellogg](http://greggkellogg.net/)
+  # @author [Gregg Kellogg](https://greggkellogg.net/)
   class Reader < RDF::Reader
     format Format
     include RDF::Util::Logger
@@ -22,24 +22,34 @@ module RDF::Tabular
 
     ##
     # Writer options
-    # @see http://www.rubydoc.info/github/ruby-rdf/rdf/RDF/Writer#options-class_method
+    # @see https://www.rubydoc.info/github/ruby-rdf/rdf/RDF/Writer#options-class_method
     def self.options
       super + [
         RDF::CLI::Option.new(
           symbol: :metadata,
           datatype: RDF::URI,
+          control: :url2,
           on: ["--metadata URI"],
           description: "user supplied metadata, merged on top of extracted metadata. If provided as a URL, Metadata is loade from that location.") {|arg| RDF::URI(arg)},
         RDF::CLI::Option.new(
           symbol: :minimal,
+          control: :checkbox,
           datatype: TrueClass,
           on: ["--minimal"],
           description: "Includes only the information gleaned from the cells of the tabular data.") {true},
         RDF::CLI::Option.new(
           symbol: :noProv,
           datatype: TrueClass,
+          control: :checkbox,
           on: ["--no-prov"],
           description: "do not output optional provenance information.") {true},
+        RDF::CLI::Option.new(
+          symbol: :decode_uri,
+          datatype: TrueClass,
+          control: :checkbox,
+          on: ["--decode-uri"],
+          description: "decode %-encodings in the result of a URI Template operation."
+        )
       ]
     end
 
@@ -51,16 +61,18 @@ module RDF::Tabular
     #   or an Array used as an internalized array of arrays
     # @param  [Hash{Symbol => Object}] options
     #   any additional options (see `RDF::Reader#initialize`)
+    # @option options [Boolean] :decode_uri
+    #   Decode %-encodings in the result of a URI Template operation.
+    # @option options [Array<Hash>] :fks_referencing_table
+    #   When called with Table metadata, a list of the foreign keys referencing this table
     # @option options [Metadata, Hash, String, RDF::URI] :metadata user supplied metadata, merged on top of extracted metadata. If provided as a URL, Metadata is loade from that location
     # @option options [Boolean] :minimal includes only the information gleaned from the cells of the tabular data
     # @option options [Boolean] :noProv do not output optional provenance information
-    # @option optinons [Array<Hash>] :fks_referencing_table
-    #   When called with Table metadata, a list of the foreign keys referencing this table
     # @yield  [reader] `self`
     # @yieldparam  [RDF::Reader] reader
     # @yieldreturn [void] ignored
     # @raise [RDF::ReaderError] if the CSV document cannot be loaded
-    def initialize(input = $stdin, options = {}, &block)
+    def initialize(input = $stdin, **options, &block)
       super do
         # Base would be how we are to take this
         @options[:base] ||= base_uri.to_s if base_uri
@@ -86,7 +98,7 @@ module RDF::Tabular
           # If input is JSON, then the input is the metadata
           content_type = @input.respond_to?(:content_type) ? @input.content_type : ""
           if @options[:base] =~ /\.json(?:ld)?$/ || content_type =~ %r(application/(csvm\+|ld\+)?json)
-            @metadata = Metadata.new(@input, @options.merge(filenames: @options[:base]))
+            @metadata = Metadata.new(@input, filenames: @options[:base], **@options)
             # If @metadata is for a Table, turn it into a TableGroup
             @metadata = @metadata.to_table_group if @metadata.is_a?(Table)
             @metadata.normalize!
@@ -99,7 +111,7 @@ module RDF::Tabular
               def script.content_type; "application/csvm+json"; end
               log_debug("Reader#initialize") {"Process HTML script block"}
               @input = script
-              @metadata = Metadata.new(@input, @options.merge(filenames: @options[:base]))
+              @metadata = Metadata.new(@input, filenames: @options[:base], **@options)
               # If @metadata is for a Table, turn it into a TableGroup
               @metadata = @metadata.to_table_group if @metadata.is_a?(Table)
               @metadata.normalize!
@@ -116,7 +128,7 @@ module RDF::Tabular
             dialect.separator = "\t" if (input.content_type == "text/tsv" rescue nil)
             embed_options = @options.dup
             embed_options[:lang] = dialect_metadata.lang if dialect_metadata.lang
-            embedded_metadata = dialect.embedded_metadata(input, @options[:metadata], embed_options)
+            embedded_metadata = dialect.embedded_metadata(input, @options[:metadata], **embed_options)
 
             if (@metadata = @options[:metadata]) && @metadata.tableSchema
               @metadata.verify_compatible!(embedded_metadata)
@@ -133,7 +145,7 @@ module RDF::Tabular
           else
             # It's tabluar data. Find metadata and proceed as if it was specified in the first place
             @options[:original_input] = @input unless @options[:metadata]
-            @input = @metadata = Metadata.for_input(@input, @options).normalize!
+            @input = @metadata = Metadata.for_input(@input, **@options).normalize!
           end
 
           log_debug("Reader#initialize") {"input: #{input}, metadata: #{metadata.inspect}"}
@@ -183,7 +195,7 @@ module RDF::Tabular
               if options[:original_input] && !input.describes_file?(options[:base_uri])
                 table_resource = RDF::Node.new
                 add_statement(0, table_group, CSVW.table, table_resource) unless minimal?
-                Reader.new(options[:original_input], options.merge(
+                Reader.new(options[:original_input], **options.merge(
                     metadata: input.tables.first,
                     base: input.tables.first.url,
                     no_found_metadata: true,
@@ -202,7 +214,7 @@ module RDF::Tabular
                   end.flatten.compact
                   table_resource = table.id || RDF::Node.new
                   add_statement(0, table_group, CSVW.table, table_resource) unless minimal?
-                  Reader.open(table.url, options.merge(
+                  Reader.open(table.url, **options.merge(
                       metadata: table,
                       base: table.url,
                       no_found_metadata: true,
@@ -222,7 +234,7 @@ module RDF::Tabular
                 activity = RDF::Node.new
                 add_statement(0, table_group, RDF::Vocab::PROV.wasGeneratedBy, activity)
                 add_statement(0, activity, RDF.type, RDF::Vocab::PROV.Activity)
-                add_statement(0, activity, RDF::Vocab::PROV.wasAssociatedWith, RDF::URI("http://rubygems.org/gems/rdf-tabular"))
+                add_statement(0, activity, RDF::Vocab::PROV.wasAssociatedWith, RDF::URI("https://rubygems.org/gems/rdf-tabular"))
                 add_statement(0, activity, RDF::Vocab::PROV.startedAtTime, RDF::Literal::DateTime.new(start_time))
                 add_statement(0, activity, RDF::Vocab::PROV.endedAtTime, RDF::Literal::DateTime.new(Time.now))
 
@@ -418,9 +430,9 @@ module RDF::Tabular
 
       res = if io
         ::JSON::dump_default_options = json_state
-        ::JSON.dump(self.send(hash_fn, options), io)
+        ::JSON.dump(self.send(hash_fn, **options), io)
       else
-        hash = self.send(hash_fn, options)
+        hash = self.send(hash_fn, **options)
         ::JSON.generate(hash, json_state)
       end
 
@@ -440,7 +452,7 @@ module RDF::Tabular
     #
     # @param [Hash{Symbol => Object}] options
     # @return [Hash, Array]
-    def to_hash(options = {})
+    def to_hash(**options)
       # Construct metadata from that passed from file open, along with information from the file.
       if input.is_a?(Metadata)
         log_debug("each_statement: metadata") {input.inspect}
@@ -464,13 +476,13 @@ module RDF::Tabular
             table_group['tables'] = tables
 
             if options[:original_input] && !input.describes_file?(options[:base_uri])
-              Reader.new(options[:original_input], options.merge(
+              Reader.new(options[:original_input], **options.merge(
                   metadata:           input.tables.first,
                   base:               input.tables.first.url,
                   minimal:            minimal?,
                   no_found_metadata:  true,
               )) do |r|
-                case t = r.to_hash(options)
+                case t = r.to_hash(**options)
                 when Array then tables += t unless input.tables.first.suppressOutput
                 when Hash  then tables << t unless input.tables.first.suppressOutput
                 end
@@ -478,13 +490,13 @@ module RDF::Tabular
             else
               input.each_table do |table|
                 next if table.suppressOutput && !validate?
-                Reader.open(table.url, options.merge(
+                Reader.open(table.url, **options.merge(
                   metadata:           table,
                   base:               table.url,
                   minimal:            minimal?,
                   no_found_metadata:  true,
                 )) do |r|
-                  case t = r.to_hash(options)
+                  case t = r.to_hash(**options)
                   when Array then tables += t unless table.suppressOutput
                   when Hash  then tables << t unless table.suppressOutput
                   end
@@ -557,7 +569,7 @@ module RDF::Tabular
             co['@id'] = subject.to_s unless subject == 'null'
             prop = case cell.propertyUrl
             when RDF.type then '@type'
-            when nil then URI.decode(column.name) # Use URI-decoded name
+            when nil then CGI.unescape(column.name) # Use URI-decoded name
             else
               # Compact the property to a term or prefixed name
               metadata.context.compact_iri(cell.propertyUrl, vocab: true)

data/lib/rdf/tabular/uax35.rb

@@ -3,7 +3,7 @@ module RDF::Tabular
   ##
   # Utilities for parsing UAX35 dates and numbers.
   #
-  # @see http://www.unicode.org/reports/tr35
+  # @see https://www.unicode.org/reports/tr35
   module UAX35
 
     ##

data/spec/data/countries-minimal.json

@@ -0,0 +1,38 @@
+[
+  {
+    "@id": "http://example.org/countries.csv#AD",
+    "http://www.geonames.org/ontology#countryCode": "AD",
+    "schema:latitude": 42.546245,
+    "schema:longitude": 1.601554,
+    "schema:name": "Andorra"
+  },
+  {
+    "@id": "http://example.org/countries.csv#AE",
+    "http://www.geonames.org/ontology#countryCode": "AE",
+    "schema:latitude": 23.424076,
+    "schema:longitude": 53.847818,
+    "schema:name": "United Arab Emirates"
+  },
+  {
+    "@id": "http://example.org/countries.csv#AF",
+    "http://www.geonames.org/ontology#countryCode": "AF",
+    "schema:latitude": 33.93911,
+    "schema:longitude": 67.709953,
+    "schema:name": "Afghanistan"
+  },
+  {
+    "countryRef": "http://example.org/countries.csv#AF",
+    "year": "1960",
+    "population": 9616353
+  },
+  {
+    "countryRef": "http://example.org/countries.csv#AF",
+    "year": "1961",
+    "population": 9799379
+  },
+  {
+    "countryRef": "http://example.org/countries.csv#AF",
+    "year": "1962",
+    "population": 9989846
+  }
+]

data/spec/data/countries-minimal.ttl

@@ -0,0 +1,36 @@
+@prefix geo: <http://www.geonames.org/ontology#> .
+@prefix schema: <http://schema.org/> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://example.org/countries.csv#AD> schema:latitude "42.546245"^^xsd:double;
+   schema:longitude "1.601554"^^xsd:double;
+   schema:name "Andorra";
+   geo:countryCode "AD" .
+
+<http://example.org/countries.csv#AE> schema:latitude "23.424076"^^xsd:double;
+   schema:longitude "53.847818"^^xsd:double;
+   schema:name "United Arab Emirates";
+   geo:countryCode "AE" .
+
+<http://example.org/countries.csv#AF> schema:latitude "33.93911"^^xsd:double;
+   schema:longitude "67.709953"^^xsd:double;
+   schema:name "Afghanistan";
+   geo:countryCode "AF" .
+
+ [
+    <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+    <http://example.org/country_slice.csv#population> 9616353;
+    <http://example.org/country_slice.csv#year> "1960"^^xsd:gYear
+ ] .
+
+ [
+    <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+    <http://example.org/country_slice.csv#population> 9799379;
+    <http://example.org/country_slice.csv#year> "1961"^^xsd:gYear
+ ] .
+
+ [
+    <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+    <http://example.org/country_slice.csv#population> 9989846;
+    <http://example.org/country_slice.csv#year> "1962"^^xsd:gYear
+ ] .

data/spec/data/countries-standard.json

@@ -0,0 +1,86 @@
+{
+  "tables": [
+    {
+      "url": "http://example.org/countries.csv",
+      "row": [
+        {
+          "url": "http://example.org/countries.csv#row=2",
+          "rownum": 1,
+          "describes": [
+            {
+              "@id": "http://example.org/countries.csv#AD",
+              "http://www.geonames.org/ontology#countryCode": "AD",
+              "schema:latitude": 42.546245,
+              "schema:longitude": 1.601554,
+              "schema:name": "Andorra"
+            }
+          ]
+        },
+        {
+          "url": "http://example.org/countries.csv#row=3",
+          "rownum": 2,
+          "describes": [
+            {
+              "@id": "http://example.org/countries.csv#AE",
+              "http://www.geonames.org/ontology#countryCode": "AE",
+              "schema:latitude": 23.424076,
+              "schema:longitude": 53.847818,
+              "schema:name": "United Arab Emirates"
+            }
+          ]
+        },
+        {
+          "url": "http://example.org/countries.csv#row=4",
+          "rownum": 3,
+          "describes": [
+            {
+              "@id": "http://example.org/countries.csv#AF",
+              "http://www.geonames.org/ontology#countryCode": "AF",
+              "schema:latitude": 33.93911,
+              "schema:longitude": 67.709953,
+              "schema:name": "Afghanistan"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "url": "http://example.org/country_slice.csv",
+      "row": [
+        {
+          "url": "http://example.org/country_slice.csv#row=2",
+          "rownum": 1,
+          "describes": [
+            {
+              "countryRef": "http://example.org/countries.csv#AF",
+              "year": "1960",
+              "population": 9616353
+            }
+          ]
+        },
+        {
+          "url": "http://example.org/country_slice.csv#row=3",
+          "rownum": 2,
+          "describes": [
+            {
+              "countryRef": "http://example.org/countries.csv#AF",
+              "year": "1961",
+              "population": 9799379
+            }
+          ]
+        },
+        {
+          "url": "http://example.org/country_slice.csv#row=4",
+          "rownum": 3,
+          "describes": [
+            {
+              "countryRef": "http://example.org/countries.csv#AF",
+              "year": "1962",
+              "population": 9989846
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/spec/data/countries-standard.ttl

@@ -0,0 +1,75 @@
+@prefix csvw: <http://www.w3.org/ns/csvw#> .
+@prefix geo: <http://www.geonames.org/ontology#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix schema: <http://schema.org/> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<http://example.org/countries.csv#AD> schema:latitude "42.546245"^^xsd:double;
+   schema:longitude "1.601554"^^xsd:double;
+   schema:name "Andorra";
+   geo:countryCode "AD" .
+
+<http://example.org/countries.csv#AE> schema:latitude "23.424076"^^xsd:double;
+   schema:longitude "53.847818"^^xsd:double;
+   schema:name "United Arab Emirates";
+   geo:countryCode "AE" .
+
+<http://example.org/countries.csv#AF> schema:latitude "33.93911"^^xsd:double;
+   schema:longitude "67.709953"^^xsd:double;
+   schema:name "Afghanistan";
+   geo:countryCode "AF" .
+
+ [
+    a csvw:TableGroup;
+    csvw:table [
+      a csvw:Table;
+      csvw:row [
+        a csvw:Row;
+        csvw:describes <http://example.org/countries.csv#AD>;
+        csvw:rownum 1;
+        csvw:url <http://example.org/countries.csv#row=2>
+      ],  [
+        a csvw:Row;
+        csvw:describes <http://example.org/countries.csv#AE>;
+        csvw:rownum 2;
+        csvw:url <http://example.org/countries.csv#row=3>
+      ],  [
+        a csvw:Row;
+        csvw:describes <http://example.org/countries.csv#AF>;
+        csvw:rownum 3;
+        csvw:url <http://example.org/countries.csv#row=4>
+      ];
+      csvw:url <http://example.org/countries.csv>
+    ],  [
+      a csvw:Table;
+      csvw:row [
+        a csvw:Row;
+        csvw:describes [
+          <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+          <http://example.org/country_slice.csv#population> 9616353;
+          <http://example.org/country_slice.csv#year> "1960"^^xsd:gYear
+        ];
+        csvw:rownum 1;
+        csvw:url <http://example.org/country_slice.csv#row=2>
+      ],  [
+        a csvw:Row;
+        csvw:describes [
+          <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+          <http://example.org/country_slice.csv#population> 9799379;
+          <http://example.org/country_slice.csv#year> "1961"^^xsd:gYear
+        ];
+        csvw:rownum 2;
+        csvw:url <http://example.org/country_slice.csv#row=3>
+      ],  [
+        a csvw:Row;
+        csvw:describes [
+          <http://example.org/country_slice.csv#countryRef> <http://example.org/countries.csv#AF>;
+          <http://example.org/country_slice.csv#population> 9989846;
+          <http://example.org/country_slice.csv#year> "1962"^^xsd:gYear
+        ];
+        csvw:rownum 3;
+        csvw:url <http://example.org/country_slice.csv#row=4>
+      ];
+      csvw:url <http://example.org/country_slice.csv>
+    ]
+ ] .

data/spec/data/countries.csv

@@ -0,0 +1,4 @@
+countryCode,latitude,longitude,name
+AD,42.546245,1.601554,Andorra
+AE,23.424076,53.847818,"United Arab Emirates"
+AF,33.93911,67.709953,Afghanistan

data/spec/data/countries.csv-minimal.json

@@ -0,0 +1,16 @@
+[{ 
+  "countryCode": "AD", 
+  "latitude": "42.546245", 
+  "longitude": "1.601554", 
+  "name": "Andorra" 
+}, { 
+  "countryCode": "AE", 
+  "latitude": "23.424076", 
+  "longitude": "53.847818", 
+  "name": "United Arab Emirates" 
+}, { 
+  "countryCode": "AF", 
+  "latitude": "33.93911", 
+  "longitude": "67.709953", 
+  "name": "Afghanistan" 
+}]