rison 1.2.1 → 2.0.0

data/{COPYING.txt → License.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Tim Fletcher <tfletcher.com>
+Copyright the authors and contributors. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -19,4 +19,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+rison
+=====
+
+
+A Ruby implementation of [Rison - Compact Data in URIs](http://mjtemplate.org/examples/rison.html).
+
+
+Installation
+------------
+
+```
+$ gem install rison
+```
+
+
+Usage
+-----
+
+Use `Rison.dump` to encode Ruby objects as Rison, and `Rison.load` to decode
+Rison encoded strings into Ruby objects:
+
+```ruby
+require 'rison'
+
+Rison.dump(true)         # => '!t'
+
+Rison.dump([1, 2, 3])    # => '!(1,2,3)'
+
+Rison.dump({:a => 0})    # => '(a:0)'
+
+Rison.dump(Array)        # => Rison::DumpError
+
+Rison.load('!t')         # => true
+
+Rison.load('!(1,2,3)')   # => [1, 2, 3]
+
+Rison.load('(a:0)')      # => {:a => 0}
+
+Rison.load('abc def')    # => Rison::ParseError
+```

data/Rakefile.rb

@@ -1,83 +1,7 @@
-require 'rake'
 require 'rake/testtask'
-require 'rake/gempackagetask'
 
+task :default => :spec
 
-GEMSPEC = Gem::Specification.new do |s|
-  s.name = 'rison'
-  s.version = '1.2.1'
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = false
-  s.summary = 'Pure Ruby parser for Rison (http://mjtemplate.org/examples/rison.html)'
-  s.description = s.summary
-  s.author = 'Tim Fletcher'
-  s.email = 'twoggle@gmail.com'
-  s.homepage = 'http://rison.rubyforge.org/'
-  s.files = Dir.glob('{lib,test}/**/*') + %w( COPYING.txt Rakefile.rb README.html )
-  s.require_paths = ['lib']
-  s.add_dependency 'dhaka'
-end
-
-
-Rake::GemPackageTask.new(GEMSPEC) { }
-
-
-Rake::PackageTask.new(GEMSPEC.name, GEMSPEC.version) do |p|
-  p.need_tar_gz = true
-  p.package_files.include GEMSPEC.files
-end
-
-
-desc 'Run all the tests'
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.ruby_opts = ['-rubygems']
-end
-
-
-namespace :stdin do
-  $:.unshift 'lib'
-  require 'rison'
-  require 'pp'
-
-  task :lex do
-    pp Rison.lex($stdin.read.chomp).to_a
-  end
-  task :parse do
-    parsed = Rison.parse(Rison.lex($stdin.read.chomp))
-    
-    if parsed.has_error?
-      p parsed
-    else
-      pp Rison.load(parsed)
-    end
-  end
-end
-
-
-task :reinstall do
-  sh 'sudo gem uninstall rison dhaka'
-  sh 'sudo gem install pkg/rison-%s.gem' % GEMSPEC.version
-end
-
-
-desc 'Regenerate the compiled parser'
-task :regen do
-  $:.unshift 'lib'
-  
-  require 'rison/grammar'
-  require 'dhaka'
-  
-  parser = Dhaka::Parser.new(Rison::Grammar)
-
-  source = [
-    "require 'dhaka'",
-    "require 'rison/grammar'",
-    '',
-    'module Rison',
-      parser.compile_to_ruby_source_as(:Parser).gsub(/^/, '  '),
-    'end'
-  ]
-
-  File.open('lib/rison/parser.rb', 'w+') { |f| f.puts source * "\n" }
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/*_spec.rb']
 end

data/lib/rison/dump.rb

@@ -1,49 +1,40 @@
 require 'rational'
 
 module Rison
+  NIL = '!n'.freeze
+
+  TRUE = '!t'.freeze
+
+  FALSE = '!f'.freeze
+
+  class DumpError < StandardError; end
+
   def self.dump(object)
     case object
-      when NilClass then '!n'
+      when NilClass then NIL
+
+      when TrueClass then TRUE
 
-      when TrueClass then '!t'
+      when FalseClass then FALSE
 
-      when FalseClass then '!f'
-        
-      when Symbol then dump(object.to_s)
+      when Symbol then object.to_s
 
       when Rational then object.to_f.to_s
-      
+
       when Numeric then object.to_s
 
-      when String
-        if object.empty?
-          "''"
-        elsif id?(object)
-          object
-        else
-          quote(object)
-        end
+      when String then "'#{escape(object)}'"
 
-      when Hash
-        '(%s)' % (object.sort_by { |k, v| k.to_s }.map { |(k, v)| '%s:%s' % [ dump(k), dump(v) ] } * ',')
+      when Hash then '(%s)' % object.map { |(k, v)| "#{dump(k)}:#{dump(v)}" }.join(?,)
 
-      when Array
-        '!(%s)' % (object.map { |x| dump(x) } * ',')
+      when Array then '!(%s)' % object.map { |member| dump(member) }.join(?,)
 
       else
-        raise ArgumentError, 'cannot serialize: %p' % object
+        raise DumpError, "Cannot encode #{object.class} objects"
     end
   end
 
-  def self.quote(string)
-    "'%s'" % escape(string)
-  end
-
   def self.escape(string)
-    string.gsub('!', '!!').gsub("'", "!'") 
-  end
-
-  def self.id?(string)
-    string !~ /^(-|\d)/ && string !~  /['!:(),*@$ ]/
+    string.gsub('!', '!!').gsub("'", "!'")
   end
-end
+end

data/lib/rison/parslet_parser.rb

@@ -0,0 +1,55 @@
+require 'parslet'
+
+module Rison
+  class ParsletParser < Parslet::Parser
+    root(:value)
+
+    rule(:value) { t | f | n | number | string | id | object | array }
+
+    rule(:object) { str(?() >> members >> str(?)) | str('()').as(:empty_object) }
+
+    rule(:array) { str('!(') >> elements >> str(?)) | str('!()').as(:empty_array) }
+
+    rule(:string) { str(?') >> strchars.repeat.as(:string) >> str(?') }
+
+    rule(:number) { int >> exp | int >> frac >> exp | int >> frac | int }
+
+    rule(:elements) { value.as(:array_value) >> str(?,) >> elements.as(:array_elements) | value.as(:array_value) }
+
+    rule(:members) { pair.as(:object_pair) >> str(?,) >> members.as(:object_members) | pair }
+
+    rule(:pair) { key.as(:key) >> str(?:) >> value.as(:value) }
+
+    rule(:key) { id | string }
+
+    rule(:id) { (idstart >> idchars | idstart).as(:identifier) }
+
+    rule(:idchars) { idchar.repeat(1) }
+
+    rule(:idchar) { match(/[a-zA-Z_\.\/~\-0-9]/) } # TODO: any non-ASCII Unicode character
+
+    rule(:idstart) { match(/[a-zA-Z_\.\/~]/) }
+
+    rule(:int) { (str('-').maybe >> (non_zero_digit >> digits | digit)).as(:int) }
+
+    rule(:frac) { str(?.) >> digits.as(:frac) }
+
+    rule(:exp) { str(?e) >> (str(?-).maybe >> digits).as(:exp) }
+
+    rule(:strchars) { strchar.repeat(1) }
+
+    rule(:strchar) { str(?!) >> str(?').as(:chr) | str(?!) >> str(?!).as(:chr) | match('[^\'\!]').as(:chr) }
+
+    rule(:non_zero_digit) { match('[1-9]') }
+
+    rule(:digits) { digit.repeat(1) }
+
+    rule(:digit) { match('[0-9]') }
+
+    rule(:t) { str('!t').as(:tfn) }
+
+    rule(:f) { str('!f').as(:tfn) }
+
+    rule(:n) { str('!n').as(:tfn) }
+  end
+end

data/lib/rison/parslet_transform.rb

@@ -0,0 +1,44 @@
+require 'parslet'
+require 'rational'
+
+module Rison
+  class ParsletTransform < Parslet::Transform
+    rule(tfn: '!t') { true }
+
+    rule(tfn: '!f') { false }
+
+    rule(tfn: '!n') { nil }
+
+    rule(int: simple(:value)) { value.to_i }
+
+    rule(int: simple(:int), exp: simple(:exp)) { Rison::Number(int, nil, exp) }
+
+    rule(int: simple(:int), frac: simple(:frac)) { Rison::Number(int, frac) }
+
+    rule(int: simple(:int), frac: simple(:frac), exp: simple(:exp)) { Rison::Number(int, frac, exp) }
+
+    rule(identifier: simple(:value)) { value.to_s.to_sym }
+
+    rule(chr: simple(:chr)) { chr.to_s }
+
+    rule(string: subtree(:characters)) { characters.join }
+
+    rule(key: subtree(:k), value: subtree(:v)) { {k => v} }
+
+    rule(empty_object: '()') { Hash.new }
+
+    rule(object_pair: subtree(:pair), object_members: subtree(:members)) { pair.merge(members) }
+
+    rule(empty_array: '!()') { [] }
+
+    rule(array_value: subtree(:h)) { [h] }
+
+    rule(array_value: subtree(:h), array_elements: subtree(:t)) { [h] + t }
+  end
+
+  def self.Number(int, frac = nil, exp = nil)
+    base = frac ? int.to_i + Rational(frac.to_i, 10 ** frac.to_s.length) : int.to_i
+
+    exp ? base * 10 ** exp.to_i : base
+  end
+end

data/lib/rison.rb

@@ -1,46 +1,13 @@
-require 'dhaka'
-require 'rison/lexer'
-require 'rison/parser'
-require 'rison/evaluator'
+require 'rison/parslet_parser'
+require 'rison/parslet_transform'
 require 'rison/dump'
 
 module Rison
+  class ParseError < StandardError; end
 
-  class ParseError < ArgumentError
-    attr_reader :result
-    
-    def initialize(invalid_string, result)
-      @result = result
-      
-      super "invalid Rison string: %p" % invalid_string
-    end
+  def self.load(string)
+    ParsletTransform.new.apply(ParsletParser.new.parse(string))
+  rescue Parslet::ParseFailed => exception
+    raise ParseError, "Invalid Rison input. #{exception.message}"
   end
-  
-  def self.load(data)
-    lexed = lex(data)
-    
-    parsed = parse(lexed)
-    
-    raise ParseError.new(data, parsed) if parsed.has_error?
-    
-    evaluate(parsed)
-  end
-
-  
-  LEXER = Dhaka::Lexer.new(LexerSpec)
-  
-  EVALUATOR = Evaluator.new
-  
-  def self.lex(data)
-    LEXER.lex(data.to_s)
-  end
-  
-  def self.parse(lexed)
-    Parser.parse(lexed)
-  end
-  
-  def self.evaluate(parsed)
-    EVALUATOR.evaluate(parsed)
-  end
-
-end
+end

data/rison.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'rison'
+  s.version = '2.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Fletcher']
+  s.email = ['mail@tfletcher.com']
+  s.homepage = 'http://github.com/tim/ruby-rison'
+  s.description = 'A Ruby implementation of Rison (http://mjtemplate.org/examples/rison.html)'
+  s.summary = 'See description'
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md Rakefile.rb rison.gemspec License.txt)
+  s.add_dependency('parslet', ['~> 1.4.0'])
+  s.require_path = 'lib'
+end

data/spec/rison_dump_spec.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+
+$:.unshift 'lib'
+
+require 'rison'
+
+describe 'Rison dump method' do
+  it 'encodes true' do
+    Rison.dump(true).must_equal('!t')
+  end
+
+  it 'encodes false' do
+    Rison.dump(false).must_equal('!f')
+  end
+
+  it 'encodes nil' do
+    Rison.dump(nil).must_equal('!n')
+  end
+
+  it 'encodes zero' do
+    Rison.dump(0).must_equal('0')
+  end
+
+  it 'encodes positive integers' do
+    Rison.dump(1).must_equal('1')
+    Rison.dump(42).must_equal('42')
+  end
+
+  it 'encodes negative integers' do
+    Rison.dump(-3).must_equal('-3')
+    Rison.dump(-33).must_equal('-33')
+  end
+
+  it 'encodes rationals as fractional numbers' do
+    Rison.dump(Rational(3, 2)).must_equal('1.5')
+    Rison.dump(Rational(9999, 100)).must_equal('99.99')
+  end
+
+  it 'encodes symbols as ids' do
+    Rison.dump(:a).must_equal('a')
+    Rison.dump(:'a-z').must_equal('a-z')
+    Rison.dump(:'domain.com').must_equal('domain.com')
+  end
+
+  it 'encodes strings' do
+    Rison.dump('').must_equal(%(''))
+    Rison.dump('0a').must_equal(%('0a'))
+    Rison.dump('-h').must_equal(%('-h'))
+    Rison.dump('abc def').must_equal(%('abc def'))
+    Rison.dump('user@domain.com').must_equal(%('user@domain.com'))
+    Rison.dump('US $10').must_equal(%('US $10'))
+  end
+
+  it 'encodes strings with escape sequences' do
+    Rison.dump(%(can't)).must_equal(%('can!'t'))
+    Rison.dump('wow!').must_equal(%('wow!!'))
+  end
+
+  it 'encodes hashes as objects' do
+    Rison.dump({}).must_equal('()')
+    Rison.dump({:a => 0}).must_equal('(a:0)')
+    Rison.dump({:a => 0, :b => 1}).must_equal('(a:0,b:1)')
+    Rison.dump({:a => 0, :b => :foo, :c => '23skidoo'}).must_equal('(a:0,b:foo,c:\'23skidoo\')')
+    Rison.dump({:id => nil, :type => :'/common/document'}).must_equal('(id:!n,type:/common/document)')
+    Rison.dump({'id' => nil, 'type' => '/common/document'}).must_equal(%(('id':!n,'type':'/common/document')))
+  end
+
+  it 'encodes arrays' do
+    Rison.dump([]).must_equal('!()')
+    Rison.dump([true]).must_equal('!(!t)')
+    Rison.dump([true, false]).must_equal('!(!t,!f)')
+    Rison.dump([true, false, nil, 123]).must_equal('!(!t,!f,!n,123)')
+  end
+
+  it 'raises an exception when given an undumpable object' do
+    proc { Rison.dump(Array) }.must_raise(Rison::DumpError)
+  end
+end

data/spec/rison_load_spec.rb

@@ -0,0 +1,93 @@
+require 'minitest/autorun'
+
+$:.unshift 'lib'
+
+require 'rison'
+
+describe 'Rison load method' do
+  it 'parses true' do
+    Rison.load('!t').must_equal(true)
+  end
+
+  it 'parses false' do
+    Rison.load('!f').must_equal(false)
+  end
+
+  it 'parses nil' do
+    Rison.load('!n').must_equal(nil)
+  end
+
+  it 'parses zero' do
+    Rison.load('0').must_equal(0)
+  end
+
+  it 'parses positive integers' do
+    Rison.load('1').must_equal(1)
+    Rison.load('42').must_equal(42)
+  end
+
+  it 'parses negative integers' do
+    Rison.load('-3').must_equal(-3)
+    Rison.load('-33').must_equal(-33)
+  end
+
+  it 'parses integers with exponents' do
+    Rison.load('1e30').must_equal(10 ** 30)
+    Rison.load('1e-30').must_equal(10 ** -30)
+  end
+
+  it 'parses fractional numbers as rationals' do
+    Rison.load('1.5').must_equal(Rational(3, 2))
+    Rison.load('99.99').must_equal(Rational(9999, 100))
+  end
+
+  it 'parses fractional numbers with exponents' do
+    Rison.load('1.5e2').must_equal(150)
+  end
+
+  it 'parses ids as symbols' do
+    Rison.load('a').must_equal(:a)
+    Rison.load('a-z').must_equal(:'a-z')
+    Rison.load('domain.com').must_equal(:'domain.com')
+  end
+
+  it 'parses strings' do
+    Rison.load(%('')).must_equal('')
+    Rison.load(%('0a')).must_equal('0a')
+    Rison.load(%('-h')).must_equal('-h')
+    Rison.load(%('abc def')).must_equal('abc def')
+    Rison.load(%('user@domain.com')).must_equal('user@domain.com')
+    Rison.load(%('US $10')).must_equal('US $10')
+  end
+
+  it 'parses strings with escape sequences' do
+    Rison.load(%('wow!!')).must_equal('wow!')
+    Rison.load(%('can!'t')).must_equal("can't")
+  end
+
+  it 'parses objects as hashes' do
+    Rison.load('()').must_equal({})
+    Rison.load('(a:0)').must_equal(:a => 0)
+    Rison.load('(a:0,b:1)').must_equal(:a => 0, :b => 1)
+    Rison.load('(a:0,b:foo,c:\'23skidoo\')').must_equal(:a => 0, :b => :foo, :c => '23skidoo')
+    Rison.load('(id:!n,type:/common/document)').must_equal(:id => nil, :type => :'/common/document')
+  end
+
+  it 'parses arrays' do
+    Rison.load('!()').must_equal([])
+    Rison.load("!(!t)").must_equal([true])
+    Rison.load("!(!t,!f)").must_equal([true, false])
+    Rison.load("!(!t,!f,!n,123)").must_equal([true, false, nil, 123])
+  end
+
+  it 'raises an exception when given invalid input' do
+    proc { Rison.load('-h') }.must_raise(Rison::ParseError)
+    proc { Rison.load('1.5e+2') }.must_raise(Rison::ParseError)
+    proc { Rison.load('1.5E2') }.must_raise(Rison::ParseError)
+    proc { Rison.load('1.5E+2') }.must_raise(Rison::ParseError)
+    proc { Rison.load('1.5E-2') }.must_raise(Rison::ParseError)
+    proc { Rison.load('abc def') }.must_raise(Rison::ParseError)
+    proc { Rison.load('US $10') }.must_raise(Rison::ParseError)
+    proc { Rison.load('user@domain.com') }.must_raise(Rison::ParseError)
+  end
+end

metadata

@@ -1,72 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rison
-version: !ruby/object:Gem::Version 
-  version: 1.2.1
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tim Fletcher
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2008-03-31 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: dhaka
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Pure Ruby parser for Rison (http://mjtemplate.org/examples/rison.html)
-email: twoggle@gmail.com
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: A Ruby implementation of Rison (http://mjtemplate.org/examples/rison.html)
+email:
+- mail@tfletcher.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/rison
+files:
 - lib/rison/dump.rb
-- lib/rison/evaluator.rb
-- lib/rison/grammar.rb
-- lib/rison/lexer.rb
-- lib/rison/parser.rb
+- lib/rison/parslet_parser.rb
+- lib/rison/parslet_transform.rb
 - lib/rison.rb
-- test/test_dump.rb
-- test/test_parser.rb
-- COPYING.txt
+- spec/rison_dump_spec.rb
+- spec/rison_load_spec.rb
+- README.md
 - Rakefile.rb
-- README.html
-has_rdoc: false
-homepage: http://rison.rubyforge.org/
+- rison.gemspec
+- License.txt
+homepage: http://github.com/tim/ruby-rison
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.1.0
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 2
-summary: Pure Ruby parser for Rison (http://mjtemplate.org/examples/rison.html)
+specification_version: 3
+summary: See description
 test_files: []
-
+has_rdoc: