rdf-borsh 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d3f80cf1f9a45652da775024fabd5c00d460f3d02c3ee34ed7ec355829a50f4
-  data.tar.gz: c631076d5c4d8a9c57e2add7c937feb492699c3a5187ea735c06200713e9a03b
+  metadata.gz: 35de9225111f9f281e91c1a287470859366dfe8fce5d211416e8e0a4216cf42a
+  data.tar.gz: 01f1d2ecd33f0f016c021fb4d24de4ca1333beb739c27b3f1de2f8eff15f579e
 SHA512:
-  metadata.gz: 1c45cf0db32119a5532825e288630b50d08634f72f8ef2e3c9d49719ca03aeaa2c3b52d03af4639163555ac90a17ff2f123eaaa01b1362fd28877b9c0a2dc13a
-  data.tar.gz: ffc8a1a577fb3f8b0f0253de890dbb93366e7af112aab10af327ff27ce38e683462b2678027d6044c5fbb7106ceffc47768f7268bb71ef863e8108a807330b6d
+  metadata.gz: 8b3442aaf6fffe3abd8de243ca3f3af85fd3ae4b288997344d8051f43198d5601475539e63eea3a62c424b3075ce17dbf3a15f7092883a5909bb3f0c2a7187b5
+  data.tar.gz: bf2e5f7860fa8f733112713993ccb743b67960f732a7cfc0c4caada867b653d6d8b355d154a91649892459305c8177fe8c8eb6b4ae48f35684e652b1bb2baa0f

data/CHANGES.md

@@ -5,4 +5,6 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1 - 2025-01-07
+
 ## 1.0.0 - 2025-01-07

data/README.md

@@ -4,10 +4,12 @@
 [![Compatibility](https://img.shields.io/badge/ruby-3.0%2B-blue)](https://rubygems.org/gems/rdf-borsh)
 [![Package](https://img.shields.io/gem/v/rdf-borsh)](https://rubygems.org/gems/rdf-borsh)
 
-A Ruby library for encoding and decoding RDF data using the [Borsh]
-binary serialization format.
+An [RDF.rb] extension for encoding and decoding [RDF] knowledge graphs in
+the [Borsh] binary serialization format.
 
 [Borsh]: https://borsh.io
+[RDF]: https://www.w3.org/TR/rdf12-concepts/
+[RDF.rb]: https://github.com/ruby-rdf/rdf
 
 ## 🛠️ Prerequisites
 
@@ -27,6 +29,29 @@ gem install rdf-borsh
 
 ```ruby
 require 'rdf/borsh'
+
+include RDF
+```
+
+### Serializing an RDF graph into an RDF/Borsh file
+
+```ruby
+RDF::Borsh::Writer.open("mygraph.rdfb") do |writer|
+  writer << [RDF::URI("https://rubygems.org/gems/rdf-borsh"), RDFS.label, "RDF/Borsh for Ruby"]
+end
+```
+
+### Parsing an RDF graph from an RDF/Borsh file
+
+```ruby
+graph = RDF::Graph.load("mygraph.rdfb")
+graph.to_a
+```
+
+### Parsing an RDF/Borsh dataset from standard input
+
+```ruby
+RDF::Borsh::Reader.new($stdin).to_a
 ```
 
 ## 👨‍💻 Development

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/rdf/borsh/format.rb

@@ -4,7 +4,7 @@ require 'rdf/format'
 
 module RDF::Borsh
   class Format < RDF::Format
-    content_type 'application/x-rdf+borsh', extension: :borsh
+    content_type 'application/x-rdf+borsh', extension: :rdfb
     reader { RDF::Borsh::Reader }
     writer { RDF::Borsh::Writer }
 

data/lib/rdf/borsh/writer.rb

@@ -24,6 +24,7 @@ module RDF::Borsh
             when 0 then self.instance_eval(&block)
             else block.call(self)
           end
+          self.finish
         end
       end
     end
@@ -53,6 +54,7 @@ module RDF::Borsh
 
     # Writes the uncompressed header.
     def write_header
+      @output.binmode
       @output.write([MAGIC, VERSION, FLAGS].pack('a4CC'))
       @output.write([@quads_set.size].pack('V'))
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdf-borsh
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Arto Bendiken
@@ -93,8 +93,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: A Ruby library for encoding and decoding RDF data using the Borsh binary
-  serialization format.
+description: An RDF.rb extension for encoding and decoding RDF knowledge graphs in
+  the Borsh binary serialization format.
 email: public-rdf-ruby@w3.org
 executables: []
 extensions: []