simple-data 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac192701653932fa65dfad509a17ff7b1e97ff530cf0d7adc7fced1c8a97474f
-  data.tar.gz: 28deb77f46642a96c789ed0b0e83ac9ecc069416bf57c4ecf452ca714ce57940
+  metadata.gz: 58034c7baa9961e9d038600d0d3a5aeb5b0d9e2d794ca5c1df06a9387bc944c2
+  data.tar.gz: 85b415e5e37de378f97e9797c1ca2304bbf454f30821da39303cc52fad84b9aa
 SHA512:
-  metadata.gz: 62e1ea2a685d816c61be2c4c9d0724a9bf7f9f34aa23341f94009c135704d453af9a7c00f8ff6c4b225f069e47682bc1557290540f622051fc7771bea6a30053
-  data.tar.gz: cb3f6b31f8dfeafe924eec3fb89f6672501363accfae6d8150471c111f53654a9c9e97b54f349ed15d43254634a7ce0f933fae9c8aec07434d931e89a183d404
+  metadata.gz: a4b31167024aec064b90ecf531769a98bc10b5b4e702637c5fa3bf4e8c320b11a5c0955b6ec236007a8f9d5a810dbc1fac784ba1d27598420546d0c3ca034c9b
+  data.tar.gz: f35b584990bb6dce182c3e1d3adc3cd48bb74727b60c5e369ae1cb212e172f57552ba1dc9029b9c8d55a96bacc315410fee4ad2f64372f51d61030e146e11826

data/README.md

@@ -6,11 +6,11 @@ This is the ruby implementation of the [simple-data spec][sda]
 require 'simple-data'
 
 SimpleData.generate('spacecraft.sda', 
-                    [ [ :cstr, 'name',   'spacecraft'     ],
-                      [ :cstr, 'origin', 'serie or movie' ],
-                      [ :f64,  'x'                        ],
-                      [ :f64,  'y'                        ],
-                      [ :f64,  'z'                        ] ],
+                    [ [ :cstr, 'name',   nil, 'spacecraft'     ],
+                      [ :cstr, 'origin', nil, 'serie or movie' ],
+                      [ :f64,  'x',      'm'                   ],
+                      [ :f64,  'y',      'm'                   ],
+                      [ :f64,  'z',      'm'                   ] ],
                     tags: { author:  "Stephane D'Alu",
                             url:     "http://www.sdalu.com/",
                             license: "MIT" }) do |sda|
@@ -21,6 +21,7 @@ SimpleData.generate('spacecraft.sda',
 end
 
 SimpleData.open('spacecraft.sda') do |sda|
+	puts sda.fields.inspect
 	while row = sda.get do
 	    puts row.inspect
     end

data/lib/simple-data/compression.rb

@@ -29,11 +29,12 @@ class SimpleData
 
         def write(data)
             @written += data.size
-            if (@written.size > @write_size)
+            if (@written > @write_size)
                 @io.write(@zstd.flush)
-            else
-                @zstd << data
+                @io.flush
+                @written = 0
             end
+            @io.write(@zstd.compress(data))
         end
     end
     
@@ -53,7 +54,7 @@ class SimpleData
             type = MAGIC.find {|k, v| str.start_with?(k) }&.last
 
             # Sanity check
-            rasie "data is not Zstd compressed" if type != :zstd
+            raise "data is not Zstd compressed" if type != :zstd
 
             # Decoder
             zstd = Zstd::StreamingDecompress.new
@@ -61,6 +62,14 @@ class SimpleData
         end
 
         def eof?
+            return false unless @sio.eof?
+            return true  if     @io.eof?
+
+            # Refill
+            cstr = @io.read(@read_size)
+            @sio.string = @decoder.call(cstr)
+
+            # Recheck
             @io.eof? && @sio.eof?
         end
         

data/lib/simple-data/version.rb

@@ -1,4 +1,4 @@
 class SimpleData
-    VERSION = '0.1.0'
+    VERSION = '0.3.1'
 end
 

data/lib/simple-data.rb

@@ -5,9 +5,10 @@ class SimpleData
     # Various regex
     REGEX_MAGIC   = /\A# simple-data:(?<version>\d+)\s*\z/
     REGEX_SECTION = /\A# --<(?<section>[^>:]+)(?::(?<extra>[^>]+))?>--+\s*\z/
-    REGEX_FIELD   = /\A\#\s*    (?<type>\w+     )       \s*:\s*
-                                            (?<name>[\w\-.]+)
-                                   \s* (?:\((?<desc>.*      )\))?   \s*\z
+    REGEX_FIELD   = /\A\#\s*    (?<type>\w+      )       \s*:\s*
+                                (?<name>[\w\-.:]+)
+                            \s* (?:\[(?<unit>.*?     )\])?
+                            \s* (?:\((?<desc>.*      )\))?   \s*\z
                                 /ix
     REGEX_TAG     = /\A@(?<tag>\w+)\s+(?<value>.*?)\s*\z/
     REGEX_EMPTY   = /\A#\s*\z/
@@ -87,7 +88,7 @@ class SimpleData
             when :cstr then [ d ].pack('Z*')
             when :blob then raise ParserError, 'not implemented'
             when :char then [ d ].pack('c' )
-            when :bool then [ d ? 'T' : 'F' ].pack('c')
+            when :bool then [ d ? 'T' : 'F' ]
             end
         }.join
         
@@ -116,7 +117,8 @@ class SimpleData
             when :f64  then @io.read(8).unpack1('E' )
             when :cstr then @io.each_byte.lazy.take_while {|b| !b.zero? }
                                               .map {|b| b.chr }.to_a.join
-            when :blob then raise ParserError, 'not implemented'
+            when :blob then @io.read(2).unpack1('s<')
+                               .then {|size| @io.read(size) }
             when :char then @io.read(1)
             when :bool then @io.read(1) == 'T'
             end
@@ -128,7 +130,8 @@ class SimpleData
     end
 
     # Generating file
-    def self.generate(file, fields, compress = false,
+    def self.generate(file, fields,
+                      compress: const_defined?(:IOCompressedWrite),
                       tags: nil, sections: nil, &block)
         # Sanity check
         if compress && !const_defined?(:IOCompressedWrite)
@@ -152,19 +155,32 @@ class SimpleData
         # Spec
         io.puts "#"
         io.puts "# --<spec>--"
-        maxlen = fields.map {|(_, name)| name.size }.max
-        fields.each do |(type, name, desc)|
+        name_maxlen = fields.map {|(_, name)| name.size }.max
+        unit_maxlen = fields.map {|(_, _, unit)| unit&.size || 0 }.max
+        
+        fields.each do |(type, name, unit, desc)|
             if desc
-                io.puts "# %-4s : %-*s (%s)" % [ type, maxlen, name, desc ]
+                if unit
+                    io.puts "# %-4s : %-*s [%-*s] (%s)" % [
+                                type, name_maxlen, name, unit_maxlen, unit, desc ]
+                else
+                    io.puts "# %-4s : %-*s  %-*s  (%s)" % [
+                                type, name_maxlen, name, unit_maxlen, '',   desc ]
+                end
             else
-                io.puts "# %-4s : %s" % [ type, name ]
+                if unit
+                    io.puts "# %-4s : %-*s [%-*s]" % [
+                                type, name_maxlen, name, unit_maxlen, unit, ]
+                else
+                    io.puts "# %-4s : %s" % [ type, name ]
+                end
             end
         end
 
         # Custom sections
         if sections && !sections.empty?
-            io.puts "#"
             sections.each do |name, value|
+                io.puts "#"
                 io.puts "# --<#{name}>--"
                 value.split(/\r?\n/).each do |line|
                     io.puts "# #{line}"
@@ -205,7 +221,7 @@ class SimpleData
         fields, tags, sections, dataopt = self.get_metadata(io)
 
         # Deal with compression
-        if dataopt.include?(:compressed)
+        if dataopt&.include?(:compressed)
             unless const_defined?(:IOCompressedRead)
                 raise Error, 'compression not supported (add zstd-ruby gem)'
             end
@@ -220,6 +236,18 @@ class SimpleData
         sda.close if sda && block
     end
 
+    # Iterate over sda file
+    def self.each(file)
+        return to_enum(:each) unless block_given?
+
+        self.open(file, :read) do |sda|
+            while d = sda.get
+                yield(d)
+            end
+        end
+    end
+
+        
     private
     
     def self.get_magic(io)
@@ -255,7 +283,7 @@ class SimpleData
                         raise ParserError, "wrong spec" if field.nil?
 
                         # Normalize
-                        t, n, d = field
+                        t, n, u, d = field
                         t = t.downcase.to_sym
                         n .force_encoding('UTF-8')
                         d&.force_encoding('UTF-8')
@@ -266,10 +294,12 @@ class SimpleData
                         end
 
                         # Cleaned-up field description
-                        [ t, n, d ].compact
+                        [ t, n, u, d ]
                     }
                 # Extract description
                 else
+                    grp = grp.map {|l| l.sub(/^#\s?/, '') }
+                    grp = grp[...-1] if grp.last&.empty?
                     sections[s] = grp.join("\n")
                 end
             else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Stéphane D'Alu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zstd-ruby
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Simple Data (CSV alternative)