xjson 0.1

data/lib/xjson.rb

@@ -0,0 +1,268 @@
+require 'json'
+# require 'byebug'
+
+class Xjson
+
+    class XjsonIncludeError < RuntimeError; end
+    class XjsonReferenceError < RuntimeError; end
+
+    VERSION = "0.0.1"
+    def Xjson.version
+        Xjson::VERSION
+    end
+
+    def Xjson.load( filename )
+        Marshal.load( File.read( filename ) )
+    end
+
+    attr_reader :ext_data
+    attr_reader :data
+    attr_reader :dir
+
+    def initialize( xjson_file )
+        @cur_file = []
+        @cur_data = []
+        @ext_data = {}
+        @ext_data = read_json_file( xjson_file )
+        @data = expand( @ext_data )
+    end
+
+    def read_json_file( xjson_file )
+        @cur_file.unshift xjson_file
+        if xjson_file[0] != "<"
+            JSON.parse( File.read( xjson_file ) )
+        else
+            JSON.parse( STDIN.read )
+        end
+    end
+
+    # Flatten by one level within array.
+    def flatten( data )
+        case data
+        when Array;
+            res = []
+            data.each do |i|
+                if i.class == Array
+                    res += i
+                else
+                    res.push i
+                end
+            end
+            res
+        else
+            data
+        end
+    end
+
+    def find_in_array_of_hash( scope, key, value )
+        index = 0
+        while index < scope.length
+            if Regexp.new( value).match( scope[ index ][ key ] )
+                return index
+            end
+            index += 1
+        end
+        nil
+    end
+
+    def reference_handle( data, ref_desc )
+        if ref_desc[0] != ":"
+            # [ data, ref_desc ]
+            reference_handle( data, ":#{ref_desc}" )
+        else
+            # Relative reference from root.
+            path = ref_desc.split( ":" )[1..-1]
+            scope = data
+            while path[0..-2].any?
+                if path[0] == "*"
+                    # Wildcard for array.
+                    unless path[1] && path[2]
+                        raise XjsonReferenceError,
+                        "Invalid reference: \"#{ref_desc}\" in \"#{@cur_file[0]}\", missing match key and value ..."
+                    end
+                    index = find_in_array_of_hash( scope, path[1], path[2] )
+                    unless index
+                        raise XjsonReferenceError,
+                        "Invalid reference: \"#{ref_desc}\" in \"#{@cur_file[0]}\", key and value not matched ..."
+                    end
+                    scope = scope[ index ]
+                    path.shift( 2 )
+                else
+                    begin
+                        index = Integer( path[0] )
+                        scope = scope[ index ]
+                    rescue
+                        scope = scope[ path[0] ]
+                    end
+                end
+                path.shift
+                unless scope
+                    raise XjsonReferenceError,
+                    "Invalid reference: \"#{ref_desc}\" in \"#{@cur_file[0]}\"..."
+                end
+            end
+            [ scope, path[-1] ]
+        end
+    end
+
+    def reference( data, ref_desc )
+        path, label = reference_handle( data, ref_desc )
+        begin
+            index = Integer( label )
+            scope = path[ index ]
+        rescue
+            # scope = scope[ path[0] ]
+            scope = path[ label ]
+        end
+        # scope = path[ label ]
+        # if scope.class == String
+            scope
+        # else
+        #     scope.to_s
+        # end
+    end
+
+    def override_desc( data, exp )
+        path, label = reference_handle( data, exp[0] )
+        { path: path, label: label, value: exp[1] }
+    end
+
+
+    def override_apply( desc, overwrite = false )
+        if desc[:label] == "*"
+            desc[:path].each do |place|
+                if not( place[ desc[:value][0] ] ) || overwrite
+                    place[ desc[:value][0] ] = desc[:value][1]
+                end
+            end
+        else
+            if not( desc[:path][desc[:label]] ) || overwrite
+                desc[:path][desc[:label]] = desc[:value]
+            end
+        end
+    end
+
+
+    def override( data, exp, overwrite = false )
+        desc = override_desc( data, exp )
+        override_apply( desc, overwrite )
+    end
+
+
+    # Expand json recursively.
+    def expand( data )
+
+        case data
+
+        when TrueClass; data
+
+        when FalseClass; data
+
+        when Float; data
+
+        when Integer; data
+
+        when String; data
+
+        when Array;
+            ret = []
+            @cur_data.unshift ret
+            data.each do |v|
+                value = expand( v )
+                ret.push( value ) if value
+            end
+            @cur_data.shift
+            ret
+
+        when Hash
+
+            if data.size == 1
+
+                # Most possible extension.
+
+                k, v = data.first
+
+                case k
+
+                when "@eval"
+                    %x"#{expand(v)}".split("\n")
+
+                when "@env"
+                    ENV[expand(v)]
+
+                when "@join"
+                    flatten( v[1..-1].map{|i| expand( i )} ).join( v[0] )
+
+                when "@flat"
+                    flatten( v[1..-1].map{|i| expand( i )} )
+
+                when "@self"
+                    reference( @ext_data, expand(v) )
+
+                when "@over";
+                    override( @cur_data[0], expand(v), true )
+                    nil
+
+                when "@base";
+                    override( @cur_data[0], expand(v), false )
+                    nil
+
+                when "@null"
+                    nil
+
+                when "@include";
+                    jsonfile = expand(v)
+                    subdata = read_json_file( jsonfile )
+                    expdata = expand( subdata )
+                    if expdata.class == Hash
+                        if @cur_data[0].class == expdata.class
+                            expdata.each do |ke,ve|
+                                @cur_data[0][ ke ] = ve
+                            end
+                        else
+                            raise XjsonIncludeError,
+                            "Included file (\"#{jsonfile}\") must contain a hash as top level"
+                        end
+                    elsif expdata.class == Array
+                        expdata.each do |ve|
+                            @cur_data[0].push ve
+                        end
+                    else
+                        raise XjsonIncludeError,
+                        "Included file (\"#{jsonfile}\") must contain a hash or a an array as top level"
+                    end
+                    @cur_file.shift
+                    nil
+
+                else
+                    # Non-extension.
+                    { k => expand( v ) }
+
+                end
+
+            else
+                ret = {}
+                @cur_data.unshift ret
+                data.each do |k,v|
+                    case k
+                    when "@null"; nil
+                    else
+                        value = expand( v )
+                        ret[ k ] = value if value
+                    end
+                end
+                @cur_data.shift
+                ret
+            end
+        end
+    end
+
+    def to_s
+        JSON.pretty_generate( @data )
+    end
+
+    def dump( filename )
+        File.write( filename, Marshal.dump( @data ) )
+    end
+
+end

data/test/golden/test.json

@@ -0,0 +1,66 @@
+{
+  "action": "test",
+  "regressions": {
+    "all": {
+      "test": [
+        [
+          "t_run_1_2",
+          [
+            1234
+          ]
+        ],
+        [
+          "t_run_1_4",
+          [
+            1234
+          ]
+        ],
+        [
+          "t_run_2_1",
+          [
+            1234
+          ]
+        ],
+        [
+          "t_run_2_2",
+          [
+            1234
+          ]
+        ],
+        [
+          "t_run_7_1",
+          [
+            1234
+          ]
+        ],
+        {
+          "foobar1": "test1"
+        },
+        {
+          "foobar2": "test2"
+        }
+      ]
+    }
+  },
+  "foobar1": "test1",
+  "foobar2": "test2",
+  "release": "201104",
+  "minor": "3",
+  "runroot": "prog-",
+  "home": "FOOBAR",
+  "dut_files": [
+    "/release/201104/src/main.c",
+    [
+      "YES: 3"
+    ],
+    {
+      "myarr": [
+        "bar",
+        1,
+        2,
+        3
+      ]
+    }
+  ],
+  "eof": true
+}

data/test/input/inc-arr.ext.json

@@ -0,0 +1,4 @@
+[
+    { "foobar1":        "test1" },
+    { "foobar2":        "test2" }
+]

data/test/input/inc-hash.ext.json

@@ -0,0 +1,4 @@
+{
+    "foobar1":        "test1",
+    "foobar2":        "test2"
+}

data/test/input/test.ext.json

@@ -0,0 +1,34 @@
+{
+    "action":        "test",
+
+    "regressions": {
+
+        "all": {
+            "test": [
+                [ "t_run_1_2", [ 1234 ] ],
+                { "@null": false },
+                [ "t_run_1_4", [ 1234 ] ],
+                [ "t_run_2_1", [ 1234 ] ],
+                [ "t_run_2_2", [ 1234 ] ],
+                [ "t_run_7_1", [ 1234 ] ],
+                { "@include": "test/input/inc-arr.ext.json" }
+            ]
+        }
+    },
+
+    "included-file": { "@include": "test/input/inc-hash.ext.json" },
+
+    "release"     : "201104",
+    "minor"       : "3",
+    "runroot"     : { "@join": [ "-", "prog", {"@self":":regressions:all:test:1:0"} ] },
+    "home"        : { "@env": "XJSON_FOOBAR" },
+
+
+    "dut_files": [
+        { "@join": [ "/", "/release", {"@self":"release"}, "src/main.c" ] },
+        { "@eval": { "@join": [ " ", "echo YES:", {"@self": "minor"} ] } },
+        { "myarr": { "@flat" : [ "foo", "bar", [ 1, 2 ,3 ] ] } }
+    ],
+
+    "eof": true
+}

data/test/test_xjson.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require_relative '../lib/xjson.rb'
+require 'fileutils'
+
+class XjsonTest < Test::Unit::TestCase
+
+    def test_basic
+
+        FileUtils.mkdir_p( "test/result" )
+
+        ENV['XJSON_FOOBAR'] = "FOOBAR"
+
+        ifile = 'test/input/test.ext.json'
+
+        # Open file.
+        json = Xjson.new( ifile )
+        ofile = "test/result/test.json"
+        File.write( ofile, JSON.pretty_generate( json.data ) )
+
+        golden_data = File.read( "test/golden/test.json" )
+        design_data = File.read( ofile )
+
+        assert_equal( golden_data, design_data )
+
+        FileUtils.rm_f ofile
+        FileUtils.rm_f "test/result"
+
+    end
+
+end
+
+#require_relative '../lib/xjson.rb'
+#require 'fileutils'
+#FileUtils.mkdir_p( "test/result" )
+#
+#ifile = 'test/input/test.ext.json'
+#
+## Open file.
+#json = Xjson.new( ifile )
+#ofile = "test/result/test.json"
+#File.write( ofile, JSON.pretty_generate( json.data ) )
+#
+#golden_data = File.read( "test/golden/test.json" )
+#design_data = File.read( ofile )

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: xjson
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tero Isannainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-08 00:00:00.000000000 Z
+dependencies: []
+description: Xjson is extension to JSON format.
+email: tero.isannainen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+files:
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- doc/Xjson.html
+- doc/Xjson/XjsonIncludeError.html
+- doc/Xjson/XjsonReferenceError.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.CHANGELOG.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/xjson.rb
+- test/golden/test.json
+- test/input/inc-arr.ext.json
+- test/input/inc-hash.ext.json
+- test/input/test.ext.json
+- test/test_xjson.rb
+homepage: 
+licenses:
+- Ruby
+metadata: {}
+post_install_message: Check README...
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Xjson is extension to JSON format.
+test_files: []