sid-csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0930d2fcacf9e23529f172d66f4d8d3ad22b181c6a40013999278b30b2a187d1'
+  data.tar.gz: 1871c2534af3fd0063bfe11c779dd5b7c7dbb376007a69f34ca3d4f26dfc16b2
+SHA512:
+  metadata.gz: fc3972b423d25efa128695717bcf9d8d2acb8d57a3689c1bfe84f859e37da3e2c0191e3ed7d56d3495a6f7ddf5ac9881616ea61c2234c680902ccd80733f784a
+  data.tar.gz: '01719d214191ab4b1426a7fd1d833b3172242637a312f2a854fad5cc2975bf85db3ffb04161eed9df47b5c25ef7ed9a3b1a9ff36d25501ee049c9ecf1869161b'

data/README.md

@@ -0,0 +1,34 @@
+# SID CSV conversion utility
+
+This little tool provides for conversion between [YANG-SID][core-sid]
+files as used by [YANG-CBOR][RFC9254] and corresponding human-readable
+CSV files.
+
+[![](https://badge.fury.io/rb/sid-csv.svg)](http://badge.fury.io/rb/sid-csv)
+
+[core-sid]: https://www.ietf.org/archive/id/draft-ietf-core-sid-20.html
+
+## Installation
+
+`gem install sid-csv`
+
+## Formats
+
+sid-csv knows the following formats:
+
+* .sid: sid file (JSON) as defined in [draft-ietf-core-sid][core-sid]
+* .csv: CSV file as defined in [RFC4180][]
+
+[RFC9254]: http://rfc-editor.org/rfc/rfc9254
+[RFC8610]: http://rfc-editor.org/rfc/rfc8610
+[RFC4180]: http://rfc-editor.org/rfc/rfc4180
+
+Sources and targets are defined by `-f csv`, `-t csv` (default: `sid`).
+
+## Command line utilities
+
+* `sid-csv -tcsv foo.sid > foo.csv`
+* `sid-csv -fcsv foo.csv > foo.sid`
+
+Output is to stdout, input from one or more files given as command line
+arguments (use `-` for standard input).

data/bin/sid-csv

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+require_relative '../lib/sid-csv.rb'
+include CSV::SID
+
+Encoding.default_external = Encoding::UTF_8
+require 'optparse'
+require 'ostruct'
+
+$options = OpenStruct.new
+begin
+  op = OptionParser.new do |opts|
+    opts.banner = "Usage: merge-patch orig patch"
+
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      $options.verbose = v
+    end
+    opts.on("-tFMT", "--to=FMT", [:sid, :csv], "Target format") do |v|
+      $options.target = v
+    end
+    opts.on("-fFMT", "--from=FMT", [:sid, :csv], "Source format") do |v|
+      $options.source = v
+    end
+    opts.on("-c", "--[no-]cddlcheck", "Perform CDDL check") do |v|
+      $options.cddlcheck = v
+    end
+  end
+  op.parse!
+rescue Exception => e
+  warn e
+  exit 1
+end
+
+if $options.cddlcheck
+  warn "** Can't check cddl yet."
+  exit 1
+end
+
+$options.target ||= :sid
+$options.source ||= :sid
+
+input = ARGF.read
+
+case [$options.source, $options.target]
+in [:sid, :csv]
+  sid_data = sid_data_from_file(input)
+  sid_csv_data = sid_csv_from_data(sid_data)
+  generated_csv1 = csv_generate(sid_csv_data)
+  puts generated_csv1
+in [:csv, :sid]
+  converted_csv2 = CSV.parse(input, nil_value: "", converters: :integer)
+  # File.write("ietf-system-csv-cddl.diag", `cddl ../data/sid-csv.cddl vp ietf-system-csv-2.json`)
+  sid2 = sid_file_from_csv(converted_csv2)
+  puts JSON.pretty_generate(sid2)
+in [src, trg]
+  warn "** Can't translate #{src} to #{trg} yet."
+  exit 1
+end

data/data/sid-csv.cddl

@@ -0,0 +1,49 @@
+; header = absent
+
+SID-File = [meta-record,
+            ?description-record,
+            *dependency-record,
+            *range-record,
+            *item-record]
+
+meta-record = ["ietf-sid-file",
+               module-name: text,
+               module-revision: empty / text,
+               sid-file-revision: empty / text,
+               sid-file-status: empty / "unpublished" / "published"]
+
+description-record = ["description",
+                      description: empty / text]
+
+dependency-record = ["dependency",
+                     module-name: text,
+                     module-revision: text]
+
+range-record = ["range",
+                entry-point: uint,
+                size: uint]
+
+item-record = [; "item", -- useful to elide for bulk of file
+               sid: uint
+               (
+                 namespace: "module" / "identity" / "feature"
+                 identifier: yang-identifier
+                //
+                 namespace: "data"
+                 identifier: schema-node-path
+               )
+               status: empty / "stable" / "unstable" / "obsolete"]
+
+yang-identifier = text .abnf ("yang-identifier" .det id-abnf)
+schema-node-path = text .abnf ("schema-node-path" .det id-abnf)
+id-abnf = '
+  schema-node-path = "/" QID *( "/" OQID)
+  yang-identifier = ID
+  QID = ID ":" ID
+  OQID = ID [":" ID]
+  ID = I *C
+  I = "_" / %x41-5a / %x61-7a
+  C = I / %x30-39 / "-" / "."
+'
+
+empty = ""

data/lib/sid-csv.rb

@@ -0,0 +1,88 @@
+require 'json'
+require 'csv'
+
+module CSV::SID
+
+  def csv_line(source, *entries)
+    entries.map do |entry|
+      case entry
+      in String
+        source[entry]
+      in Symbol
+        entry.to_s
+      end
+    end
+  end
+
+  def csv_lines(source, *entries)
+    if source
+      source.map do |row|
+        csv_line(row, *entries)
+      end
+    end
+  end
+
+  def sid_csv_from_data(sid_data)
+    [
+      csv_line(sid_data, :"ietf-sid-file", "module-name", "module-revision",
+               "sid-file-revision", "sid-file-status"),
+      csv_line(sid_data, :description, "description"),
+      *csv_lines(sid_data["dependency-revision"], :dependency,
+                 "module-name", "module-revision"),
+      *csv_lines(sid_data["assignment-range"], :range, "entry-point", "size"),
+      *csv_lines(sid_data["item"], "sid", "namespace", "identifier", "status"),
+    ]
+  end
+
+  def csv_hash(names, values)
+    Hash[names.zip(values).filter{|k, v| v != ""}]
+  end
+
+  def csv_store(csv, name, names, values)
+    csv[name] ||= []
+    csv[name] << csv_hash(names, values)
+  end
+
+  SID_FILE_TOP_LEVEL = "ietf-sid-file:sid-file"
+
+  def sid_file_from_csv(sid_csv)
+    {SID_FILE_TOP_LEVEL =>
+     sid_csv.each_with_object({}) do |line, result|
+       case line
+       in ["ietf-sid-file", *values]
+         result.merge!(csv_hash(["module-name", "module-revision",
+                                 "sid-file-revision", "sid-file-status"], values))
+       in ["description", *values]
+         result.merge!(csv_hash(["description"], values))
+       in ["dependency", *values]
+         csv_store(result, "dependency-revision",
+                   ["module-name", "module-revision"], values)
+       in ["range", entry_point, size]
+         csv_store(result, "assignment-range",
+                   ["entry-point", "size"], [entry_point.to_s, size.to_s])
+       in [sid, namespace, name, status]
+         csv_store(result, "item",
+                   ["namespace", "identifier", "sid", "status"],
+                   [namespace, name, sid.to_s, status])
+       end
+     end
+    }
+  end
+
+  def csv_generate(data)
+    CSV.generate('') do |csv|
+      data.each do |row|
+        csv << row
+      end
+    end
+  end
+
+  def sid_data_from_file(text)
+    JSON.load(text)[SID_FILE_TOP_LEVEL]
+  end
+
+  def json_dump(fn, value)
+    File.write(fn, JSON.pretty_generate(value))
+  end
+
+end

data/sid-csv.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "sid-csv"
+  s.version = "0.0.1"
+  s.summary = "YANG-CBOR SID file as CSV"
+  s.description = %q{sid-csv implements a library and a command-line interface to YANG sid files as CSV}
+  s.author = "Carsten Bormann"
+  s.email = "cabo@tzi.org"
+  s.license = "Apache-2.0"
+  s.homepage = "https://github.com/cabo/sid-csv"
+  s.has_rdoc = false
+  s.files = Dir['lib/**/*.rb'] + %w(README.md sid-csv.gemspec data/sid-csv.cddl) + Dir['bin/**/*']
+  s.executables = Dir['bin/**/*'].map {|x| File.basename(x)}
+  s.required_ruby_version = '>= 2.7.0'
+
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: sid-csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carsten Bormann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-29 00:00:00.000000000 Z
+dependencies: []
+description: sid-csv implements a library and a command-line interface to YANG sid
+  files as CSV
+email: cabo@tzi.org
+executables:
+- sid-csv
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/sid-csv
+- data/sid-csv.cddl
+- lib/sid-csv.rb
+- sid-csv.gemspec
+homepage: https://github.com/cabo/sid-csv
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: YANG-CBOR SID file as CSV
+test_files: []