zig 0.0.2 → 0.0.3

data/.gitignore

@@ -2,5 +2,6 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 pkg

data/README.md

@@ -1,24 +1,29 @@
 # ZIG
 
-ZIG is a simple data format. It is designed to be easily edited by hand.
+Zig is a simple data format. It is designed to be edited by hand.
 It is also pretty easy to parse and generate, though.
+You can think of Zig as an alternate, indentation-based
+syntax for JSON.
 
-ZIG is indentation-based, like Python or Coffeescript.
-
-Here is a short example:
+Here is a short example that shows all data structures:
 
 ```
 {
   type: 'error'
+  subtype: nil
+  description: "
+    Check your Internet connection. Restart any router, modem,
+    or other network devices you may be using.
   color: {
     r: 255
     g: 192
     b: 0
-  description: "
-    Check your Internet connection. Restart any router, modem,
-    or other network devices you may be using.
   # TODO: do we need these any more?
-  codes: [
-    118
-    192
+  flags: [
+    true
+    false
+    true
 ```
+
+In order of appearance: hash, string, nil, multiline string, number,
+comment, list, boolean.

data/bin/zig

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+require "zig"
+require "optparse"
+
+def fail_with(message)
+  $stderr.puts message
+  exit 1
+end
+
+def parse_zig(file)
+  ZIG::Parser.parse_document(ZIG::Lines.new(File.open(file)))
+rescue ZIG::SyntaxError => e
+  fail_with(e.message)
+end
+
+def parse_json(file)
+  require "json"
+  JSON.parse(File.read(file))
+rescue JSON::ParserError => e
+  fail_with(e.message)
+end
+
+output = nil
+OptionParser.new do |opts|
+  opts.on("-o", "--output [format]", "convert to output format") do |format|
+    output = format
+  end
+end.parse!
+
+_, ending = ARGV[0].split(".")
+data = case ending
+when "zig"
+  parse_zig(ARGV[0])
+when "json"
+  parse_json(ARGV[0])
+end
+
+case output
+when nil
+  # no output
+when "zig"
+  puts ZIG.generate(data)
+when "json"
+  require "json"
+  puts JSON.pretty_generate(data)
+else
+  fail_with("unknown format: #{output}")
+end

data/lib/zig.rb

@@ -2,6 +2,7 @@ require "zig/version"
 require "zig/lines"
 require "zig/parser"
 require "zig/formatter"
+require "zig/syntax_error"
 
 require "stringio"
 
@@ -9,13 +10,14 @@ module ZIG
 
   def self.parse(string)
     lines = Lines.new(StringIO.new(string))
-    start = lines.current || raise("cannot parse empty document")
-    lines.next
-    Parser.parse_value(0, lines, start)
+    Parser.parse_document(lines)
   end
 
-  def self.print(data)
-    Formatter.print_value("", data)
+  def self.generate(data)
+    out = StringIO.new
+    Formatter.print_value(out, "", data)
+    out.rewind
+    out.read
   end
 
 end

data/lib/zig/formatter.rb

@@ -2,43 +2,43 @@ class ZIG::Formatter
 
   INDENT = " " * 2
 
-  def self.print_hash(indent, hash)
-    print "{\n"
+  def self.print_hash(out, indent, hash)
+    out.write("{\n")
     indent = indent + INDENT
     hash.each do |key, value|
-      print indent + key.to_s + ": "
-      print_value(indent, value)
+      out.write(indent + key.to_s + ": ")
+      print_value(out, indent, value)
     end
   end
 
-  def self.print_array(indent, array)
-    print "[\n"
+  def self.print_array(out, indent, array)
+    out.write("[\n")
     indent = indent + INDENT
     array.each do |v|
-      print indent
-      print_value(indent, v)
+      out.write(indent)
+      print_value(out, indent, v)
     end
   end
 
-  def self.print_multiline_string(indent, string)
-    print "\"\n"
+  def self.print_multiline_string(out, indent, string)
+    out.write("\"\n")
     indent = indent + INDENT
     string.split("\n").each do |line|
-      print indent + line.lstrip + "\n"
+      out.write(indent + line.lstrip + "\n")
     end
   end
 
-  def self.print_value(indent, value)
+  def self.print_value(out, indent, value)
     case value
-    when Hash then print_hash(indent, value)
-    when Array then print_array(indent, value)
+    when Hash then print_hash(out, indent, value)
+    when Array then print_array(out, indent, value)
     when String
       if value.include?("\n")
-        print_multiline_string(indent, value)
+        print_multiline_string(out, indent, value)
       else
-        print "'#{value}'\n"
+        out.write("'#{value}'\n")
       end
-    else print value.inspect + "\n"
+    else out.write(value.inspect + "\n")
     end
   end
 

data/lib/zig/lines.rb

@@ -1,17 +1,15 @@
-module ZIG
-  class Lines
-    attr_reader :current, :num
+class ZIG::Lines
+  attr_reader :current, :num
 
-    def initialize(file)
-      @file, @current, @num = file, file.gets, 1
-    end
+  def initialize(file)
+    @file, @current, @num = file, file.gets, 1
+  end
 
-    def empty?
-      @current.nil?
-    end
+  def empty?
+    @current.nil?
+  end
 
-    def next
-      @current, @num = @file.gets, @num + 1
-    end
+  def next
+    @current, @num = @file.gets, @num + 1
   end
 end

data/lib/zig/parser.rb

@@ -13,20 +13,19 @@ class ZIG::Parser
       return object if lines.empty?
       spaces, value = lines.current.scan(FULL_LINE).flatten
       return object if spaces.size < indent
-      raise "[line #{lines.num}] illegal indent" if spaces.size > indent
+      raise ZIG::SyntaxError, "[line #{lines.num}] illegal indent" if spaces.size > indent
       lines.next
       if object.is_a?(String)
         object << "\n" unless object.empty?
         object << value
+      elsif object.is_a?(Array)
+        next if value[0] == '#'
+        object << parse_value(indent, lines, value)
       else
         next if value[0] == '#'
-        if object.is_a?(Hash)
-          key, value = value.scan(KEY_VALUE).flatten
-          raise "[line #{lines.num}] missing key" if key.nil?
-          object[key.strip.to_sym] = parse_value(indent, lines, value)
-        else
-          object << parse_value(indent, lines, value)
-        end
+        key, value = value.scan(KEY_VALUE).flatten
+        raise ZIG::SyntaxError, "[line #{lines.num - 1}] missing key" if key.nil?
+        object[key.strip.to_sym] = parse_value(indent, lines, value)
       end
     end
   end
@@ -44,8 +43,16 @@ class ZIG::Parser
     when INTEGER then text.to_i
     when FLOAT   then text.to_f
     else
-      raise "[line #{lines.num}] illegal value: #{text}"
+      raise ZIG::SyntaxError, "[line #{lines.num}] illegal value: #{text}"
     end
   end
 
+  def self.parse_document(lines)
+    raise ZIG::SyntaxError, "cannot parse empty document" if lines.empty?
+    lines.next while lines.current[0] == '#'
+    start = lines.current
+    lines.next
+    return parse_value(0, lines, start)
+  end
+
 end

data/lib/zig/syntax_error.rb

@@ -0,0 +1,2 @@
+class ZIG::SyntaxError < StandardError
+end

data/lib/zig/version.rb

@@ -1,3 +1,3 @@
 module ZIG
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/zig_test.rb

@@ -6,7 +6,7 @@ describe ZIG do
 
   describe "empty" do
     it "should reject an empty document" do
-      assert_raises(RuntimeError) { ZIG.parse("") }
+      assert_raises(ZIG::SyntaxError) { ZIG.parse("") }
     end
   end
 
@@ -24,7 +24,7 @@ describe ZIG do
     end
 
     it "should reject other literals" do
-      assert_raises(RuntimeError) { ZIG.parse("foo") }
+      assert_raises(ZIG::SyntaxError) { ZIG.parse("foo") }
     end
   end
 
@@ -107,6 +107,15 @@ describe ZIG do
       assert_equal [1, 2, 3], ZIG.parse(doc)
     end
 
+    it "should parse nested empty lists" do
+      doc =
+"[
+  [
+  [
+  ["
+      assert_equal [[], [], []], ZIG.parse(doc)
+    end
+
     it "should parse a list of complex values" do
       doc =
 "[
@@ -154,16 +163,29 @@ describe ZIG do
   a: 1
   : 2
   c: 3"
-      assert_raises(RuntimeError) { ZIG.parse(doc) }
+      assert_raises(ZIG::SyntaxError) { ZIG.parse(doc) }
     end
   end
 
   describe "comments" do
+    it "should skip comment lines at the start of a document" do
+      doc =
+"# IMPORTANT
+{
+  a: 1
+  b: 2
+  c: 3"
+      assert_equal Hash[a: 1, b: 2, c: 3], ZIG.parse(doc)
+    end
+    
+    
+    
     it "should skip comment lines inside hashes" do
       doc =
 "{
   a: 1
   #b: 2
+  #b: 2
   c: 3"
       assert_equal Hash[a: 1, c: 3], ZIG.parse(doc)
     end
@@ -173,6 +195,7 @@ describe ZIG do
 "[
   'one'
   #'two'
+  #'two'
   'three'"
       assert_equal %w[one three], ZIG.parse(doc)
     end
@@ -191,7 +214,7 @@ describe ZIG do
   a: 1
    # TODO: check c
   c: 3"
-      assert_raises(RuntimeError) { ZIG.parse(doc) }
+      assert_raises(ZIG::SyntaxError) { ZIG.parse(doc) }
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zig
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies: []
 description: A parser for the ZIG data format.
 email:
 - tim@lossen.de
 executables:
-- format
+- zig
 extensions: []
 extra_rdoc_files: []
 files:
@@ -24,13 +24,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/format
+- bin/zig
 - data/example.json
 - data/example.zig
 - lib/zig.rb
 - lib/zig/formatter.rb
 - lib/zig/lines.rb
 - lib/zig/parser.rb
+- lib/zig/syntax_error.rb
 - lib/zig/version.rb
 - test/zig_test.rb
 - zig.gemspec
@@ -54,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A parser for the ZIG data format.

data/bin/format

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-require "json"
-
-begin
-  require "zig"
-rescue LoadError
-  $:.unshift File.expand_path('../lib', File.dirname(__FILE__))
-  require "zig"
-end
-
-data = JSON.parse(File.read(ARGV[0]))
-ZIG.print(data)