cddl 0.1.0 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc6439f876088c1d9355f78363bfa34eaa844613
-  data.tar.gz: eb88cc041f3a03ef495aeecf4b663af0a2384673
+SHA256:
+  metadata.gz: 6c877883cb125426e061f527ba4375c0f021d70dfef060336fe0bb0f5e2ca3d4
+  data.tar.gz: 7a3dc4065f3616bf57c229b410782b35140018ecada4418c0ef45056c62aef0b
 SHA512:
-  metadata.gz: 449e97a60fb3ee5584b582dc8da13d54de607f99ce02020a5565d7495142a8547965429b9d429582a2c898f8c6680a64d089339ff6c8fe4def07887da9ddd782
-  data.tar.gz: af6dd64fe9c1267fe4f86fbf4825e7da9faa4be03545991369b647c5766e5735fb1c760341bdf0afb7a4f07f3f7f06279bb1e900c459795eaf150c5c76cbb9a1
+  metadata.gz: b3987fbe82e80dddba2f650b1a12941ed6092708297302cf1a78dfe45b20b79d08e85901cb8739b5fc79eab8cde70ca8efb88698f4340da72c722a7a461565c6
+  data.tar.gz: 68c35688bac9b30411ee419e171860c463df28c3452bce1741399274e51295b609e0acc8df54e9876037f9d96ba02e369fd9465c2fe7c38bb9682d5ec19018cd

data/bin/cddl

@@ -1,42 +1,99 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
+# require_relative '../lib/cddl'
 require 'cddl'
 require 'cbor-diagnostic'
 require 'json'
 
 Encoding.default_external = "UTF-8" # wake up, smell the coffee
 
+EX_USAGE = 64
+EX_DATAERR = 65
+
 def usage
   warn "Usage:"
   warn "#$0 spec.cddl generate [n]"
   warn "#$0 spec.cddl json-generate [n]"
   warn "#$0 spec.cddl validate instance.cbor"
   warn "#$0 spec.cddl validate instance.json"
-  exit 1
+  exit EX_USAGE
+end
+
+def read_arg(arg)
+  if arg == "-"
+    STDIN.read
+  else
+    usage unless arg
+    File.read(arg, mode: "rb")
+  end
+end
+
+def parser
+  @parser ||= CDDL::Parser.new(read_arg(ARGV[0]))
+end
+
+def my_pp(v)
+  if $annotate
+    CBOR::PP.pp v
+  else
+    pp v
+  end
+end
+
+def my_diag(v)
+  if $annotate
+    CBOR::PP.pp v
+  else
+    puts v.cbor_diagnostic
+  end
 end
 
-case ARGV[1]
-when /\Ag/
-  parser = CDDL::Parser.new(File.read(ARGV[0]))
-  n = 1
-  n = ARGV[2].to_i if ARGV[2]
-  n.times do
-    g = parser.generate
-    puts g.cbor_diagnostic
+begin
+  case ARGV[1]
+  when /\A.p/
+    $annotate = true
+    require_relative '../lib/cbor-pp'
   end
-when /\Aj/
-  parser = CDDL::Parser.new(File.read(ARGV[0]))
-  n = 1
-  n = ARGV[2].to_i if ARGV[2]
-  n.times do
-    g = parser.generate
-    puts JSON.pretty_generate(g)
+  case ARGV[1]
+  when /\Ar/                      # secret
+    $advanced = true
+    my_pp parser.rules
+  when /\Ae/                      # secret
+    $advanced = true
+    puts parser.defines(ARGV[2])
+  when /\Ag/
+    n = 1
+    n = ARGV[2].to_i if ARGV[2]
+    n.times do
+      g = parser.generate
+      if $annotate
+        g = g.cbor_clone if ENV["EXPERIMENTAL_ANNOTATE"]
+        ann = parser.validate(g)
+        # my_pp ann
+        g.cbor_add_annotations_from(ann) rescue nil
+      end
+      my_diag(g)
+    end
+  when /\Aj/
+    n = 1
+    n = ARGV[2].to_i if ARGV[2]
+    n.times do
+      g = parser.generate
+      puts JSON.pretty_generate(g)
+    end
+  when /\Av/
+    instance = read_arg(ARGV[2])
+    instance = CBOR.decode(instance.b) rescue JSON.load(instance)
+    instance = instance.cbor_clone if $annotate && ENV["EXPERIMENTAL_ANNOTATE"]
+    ann = parser.validate(instance)
+    # my_pp ann
+    instance.cbor_add_annotations_from(ann) rescue nil
+    my_diag(instance) if $annotate
+    exit 1 unless ann
+  else
+    usage
   end
-when /\Av/
-  parser = CDDL::Parser.new(File.read(ARGV[0]))
-  instance = File.read(ARGV[2])
-  instance = CBOR.decode(instance) rescue JSON.load(instance)
-  p parser.validate(instance)
-else
-  usage
+rescue CDDL::ParseError => e
+  warn e.message
+  exit EX_DATAERR
 end

data/cddl.gemspec

@@ -1,17 +1,19 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.1.0'
+  s.version = '0.8.8'
   s.summary = "CDDL generator and validator."
   s.description = %{A parser, generator, and validator for CDDL}
   s.add_dependency('cbor-diag')
   s.add_dependency('abnc')
   s.add_dependency('json')
+  s.add_dependency('regexp-examples') # , '1.1.0')
+  s.add_dependency('colorize')
   s.files = `git ls-files`.split("\n").grep(/^[a-z]/)
   s.files = Dir['lib/**/*.rb'] + %w(cddl.gemspec) + Dir['data/**/*.abnf'] + Dir['data/**/*.cddl'] + Dir['test-data/**/*.cddl'] + Dir['test/**/*.rb']
   s.require_path = 'lib'
   s.executables = ['cddl']
   s.default_executable = 'cddl'
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 2.0'
   s.author = "Carsten Bormann"
   s.email = "cabo@tzi.org"
   s.homepage = "http://github.com/cabo/cddl"

data/data/cddl.abnf

@@ -1,30 +1,45 @@
 cddl = S 1*rule
-rule = typename S "=" S type S
-     / groupname S "=" S group S
+rule = typename [genericparm] S assign S type S
+     / groupname [genericparm] S assign S grpent S
 
 typename = id
 groupname = id
 
+assign = "=" / "/=" / "//="
+
+genericparm = "<" S id S *("," S id S ) ">"
+genericarg = "<" S type1 S *("," S type1 S ) ">"
+
 type = type1 S *("/" S type1 S)
 
-type1 = value
+type1 = type2 [S (rangeop / annotator) S type2]
      / "#" "6" ["." uint] "(" S type S ")" ; note no space!
      / "#" DIGIT ["." uint]                ; major/ai
      / "#"                                 ; any
      / "{" S group S "}"
      / "[" S group S "]"
-     / "(" type ")"
-     / typename
+     / "&" S "(" S group S ")"
+     / "&" S groupname [genericarg]
+
+type2 = value
+      / typename [genericarg]
+      / "(" type ")"
+
+rangeop = "..." / ".."
+
+annotator = "." id
 
-group = "(" S *grpent S ")"
-      / *grpent
+group = grpchoice S *("//" S grpchoice S)
 
-grpent = [occur S] [memberkey S] type1 optcom
-       / [occur S] groupname optcom       ; always preempted by previous...
+grpchoice = *grpent
 
-memberkey = membername S ":"
-membername = bareword              ; note that this can be a typename
-           / type1                 ; can be preempted by previous...
+grpent = [occur S] [memberkey S] type optcom
+       / [occur S] groupname [genericarg] optcom ; preempted by above
+       / [occur S] "(" S group S ")" optcom
+
+memberkey = type1 S "=>"
+          / bareword S ":"
+          / value S ":"
 
 bareword = id
 
@@ -34,25 +49,39 @@ occur = [uint] "*" [uint]
       / "+"
       / "?"
 
-uint = "0"
-     / DIGIT1 *DIGIT
+uint = DIGIT1 *DIGIT
+     / "0x" 1*HEXDIG
+     / "0b" 1*BINDIG
+     / "0"
 
-value = int
-      / float
-      / string
+value = number
+      / text
+      / bytes
 
 int = ["-"] uint
 
-float = int ["." 1*DIGIT] ["e" int ]
+; This is a float if it has fraction or exponent; int otherwise
+number = int ["." fraction] ["e" exponent ]
+fraction = 1*DIGIT
+exponent = int
 
-string = %x22 *SCHAR %x22
+text = %x22 *SCHAR %x22
 SCHAR = %x20-21 / %x23-7E / SESC
 SESC = "\" %x20-7E
 
-id = ALPHA *(ALPHA / DIGIT / "_" / "-")
+bytes = [bsqual] %x27 *BCHAR %x27
+BCHAR = %x20-26 / %x28-7E / SESC / CRLF
+bsqual = %x68 ; "h"
+       / %x62.36.34 ; "b64"
+
+id = EALPHA *(*("-" / ".") (EALPHA / DIGIT))
 ALPHA = %x41-5A / %x61-7A
+EALPHA = %x41-5A / %x61-7A / "@" / "_" / "$"
 DIGIT = %x30-39
 DIGIT1 = %x31-39
+HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F"
+BINDIG = %x30-31
+
 S = *WS
 WS = SP / NL
 SP = %x20
@@ -60,3 +89,4 @@ NL = COMMENT / CRLF
 COMMENT = ";" *(SP / VCHAR) CRLF
 VCHAR = %x21-7E
 CRLF = %x0A / %x0D.0A
+

data/data/prelude.cddl

@@ -7,20 +7,23 @@ nint = #1
 int = uint / nint
 
 bstr = #2
+bytes = bstr
 tstr = #3
+text = tstr
 
-tdate = #6.0(tstr)
+tdate = #6.0(tstr .regexp "\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])[Tt]([0-1]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)(\\.\\d+)?([Zz]|[+\\-](?:[0-1]\\d|2[0-3]):[0-5]\\d)")
 time = #6.1(number)
 number = int / float
 biguint = #6.2(bstr)
 bignint = #6.3(bstr)
 bigint = biguint / bignint
 integer = int / bigint
+unsigned = uint / biguint
 decfrac = #6.4([e10: int, m: integer])
 bigfloat = #6.5([e2: int, m: integer])
 eb64url = #6.21(any)
-eb64legacy = #6.21(any)
-eb16 = #6.21(any)
+eb64legacy = #6.22(any)
+eb16 = #6.23(any)
 encoded-cbor = #6.24(bstr)
 uri = #6.32(tstr)
 b64url = #6.33(tstr)
@@ -38,6 +41,9 @@ float = float16-32 / float64
 
 false = #7.20
 true = #7.21
+bool = false / true
 nil = #7.22
+null = nil
 undefined = #7.23
 
+used_in_cddl_prelude = any / bytes / tdate / time / number / biguint / bignint / bigint / integer / unsigned / decfrac / bigfloat / eb64url / eb64legacy / eb16 / encoded-cbor / uri / b64url / b64legacy / regexp / mime-message / cbor-any / float16 / float32 / float64 / float16-32 / float32-64 / float / false / true / bool / null / undefined / uint / nint / int / text

data/lib/cbor-pp-play.rb

@@ -0,0 +1,13 @@
+require_relative "cbor-pp"
+
+a = [1, {foo: "bar", busel: "basel", baz: "bass", ant: "cat", bat: "dog", eel: "fox"},
+             2, 3, 4, [3]*55, "foo".b, 0.00006103515625, 0.0000099, 1e-7, nil]
+a[1].cbor_annotation_add "fasel"
+CBOR::PP.pp a
+
+a = [1, "baz", 3]
+a.cbor_annotation_add "foo"
+a[1].cbor_annotation_add "bar"
+CBOR::PP.pp(a)
+
+p 1.cbor_annotation_format

data/lib/cbor-pp.rb

@@ -0,0 +1,213 @@
+require 'prettyprint'
+require 'cbor-diagnostic'
+require 'delegate'
+
+class CBOR::PP < PrettyPrint
+  # Outputs +obj+ to +out+ in pretty printed format of
+  # +width+ columns in width.
+  #
+  # If +out+ is omitted, <code>$></code> is assumed.
+  # If +width+ is omitted, 79 is assumed.
+  #
+  # CBOR::PP.pp returns +out+.
+  def self.pp(obj, out=$>, width=79)
+    q = new(out, width)
+    q.pp obj
+    q.flush
+    #$pp = q
+    out << "\n"
+  end
+
+  module PPMethods
+    # Adds +obj+ to the pretty printing buffer
+    # using Object#cbor_pp.
+    def pp(obj)
+      group {obj.cbor_pp self}
+    end
+
+    # XXX: a nested group that is broken should not have things added at the end
+    def comma_breakable
+      text ','
+      fill_breakable
+    end
+
+    def seplist(list, sep=nil, iter_method=:each) # :yield: element
+      sep ||= lambda { comma_breakable }
+      first = true
+      list.__send__(iter_method) {|*v|
+        if first
+          first = false
+        else
+          sep.call
+        end
+        yield(*v)
+      }
+    end
+
+    # A pretty print for a Hash
+    def pp_hash(obj, anno)
+      s = "#{anno}{"
+      group(1, s, '}') {
+        seplist(obj, nil, :each_pair) {|k, v|
+          group {
+            pp k
+            text ':'
+            group(1) {
+              breakable ' '
+              pp v
+            }
+          }
+        }
+      }
+    end
+  end
+
+  include PPMethods
+
+  module ObjectMixin # :nodoc:
+    def cbor_pp(q)
+      if @cbor_annotation
+        q.text cbor_annotation_format
+      end
+      q.text cbor_diagnostic
+    end
+    def cbor_annotation_add(v)
+      unless frozen?
+        @cbor_annotation ||= []
+        @cbor_annotation << v unless @cbor_annotation.include? v
+      end
+    end
+    def cbor_annotation_replace(v)
+      @cbor_annotation = [v]
+    end
+    def cbor_annotations
+      @cbor_annotation
+    end
+    def cbor_annotation_format
+      if @cbor_annotation
+        "/" << @cbor_annotation.join(", ") << "/ "
+      end
+    end
+    def cbor_add_annotations_from(ann_list)
+      _data, anno = ann_list.find{|data, _anno| equal?(data)}
+      f = anno.cbor_annotations
+      f.each {|a| cbor_annotation_add(a)} if f
+    end
+    def cbor_clone
+      if frozen?
+        CBOR::PP::Cloak.new(self)
+      else
+        self
+      end
+    end
+    def eql?(other)
+      if other.respond_to? :__getobj__
+        eql? other.__getobj__
+      else
+        super
+      end
+    end
+  end
+
+  module EqlMixin
+    def eql?(other)
+      if other.respond_to? :__getobj__
+        eql? other.__getobj__
+      else
+        super
+      end
+    end
+    # def ==(other)
+    #   eql?(other) || super
+    # end
+  end
+
+  def self.add_annotations(tree, ann_list)
+    tree.cbor_add_annotations_from(ann_list)
+  end
+
+  class Cloak < ::SimpleDelegator
+    def class
+      @delegate_sd_obj.class
+    end
+    include CBOR::PP::ObjectMixin
+  end
+end
+
+class Class
+  def ===(other)
+    if other.respond_to? :__getobj__
+      other.__getobj__.kind_of? self
+    else
+      other.kind_of? self
+    end
+  end
+end
+
+class String
+  def cbor_clone
+    frozen? ? dup : self
+  end
+end
+
+class Array # :nodoc:
+  def cbor_pp(q) # :nodoc:
+    s = "#{cbor_annotation_format}["
+    q.group(1, s, ']') {
+      q.seplist(self) {|v|
+        q.pp v
+      }
+    }
+  end
+  def cbor_add_annotations_from(ann_list)
+    super
+    each {|m| m.cbor_add_annotations_from(ann_list)}
+  end
+  def cbor_clone
+    map(&:cbor_clone)
+  end
+end
+
+class Hash # :nodoc:
+  def cbor_pp(q) # :nodoc:
+    q.pp_hash self, cbor_annotation_format
+  end
+  def cbor_add_annotations_from(ann_list)
+    super
+    each {|k, v|
+      # k.cbor_add_annotations_from(ann_list)
+      v.cbor_add_annotations_from(ann_list)
+    }
+  end
+  def cbor_clone
+    # to_a.cbor_clone.to_h  # this breaks for unknown reasons
+    h = {}
+    each {|k, v| h[k.cbor_clone] = v.cbor_clone}
+    each {|k, v| fail [h, k, k.cbor_clone, h[k], v].inspect unless h[k] == v}
+    h
+  end
+end
+
+class Float                     # Hmm.
+  prepend CBOR::PP::EqlMixin
+end
+
+class Numeric
+  prepend CBOR::PP::EqlMixin
+end
+
+class TrueClass
+  prepend CBOR::PP::EqlMixin
+end
+
+class FalseClass
+  prepend CBOR::PP::EqlMixin
+end
+
+class NilClass
+  prepend CBOR::PP::EqlMixin
+end
+
+class Object < BasicObject # :nodoc:
+  include CBOR::PP::ObjectMixin
+end