lector 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+*.gem
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3@lector

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    lector (0.0.1)
+      citrus
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    citrus (2.4.1)
+    coderay (0.9.8)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.8)
+      guard (>= 0.8.4)
+    method_source (0.6.7)
+      ruby_parser (>= 2.3.1)
+    multi_json (1.0.3)
+    pry (0.9.7.4)
+      coderay (~> 0.9.8)
+      method_source (~> 0.6.7)
+      ruby_parser (>= 2.3.1)
+      slop (~> 2.1.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.8)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.1.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  lector!
+  pry
+  rspec
+  simplecov

data/Guardfile

@@ -0,0 +1,13 @@
+if RbConfig::CONFIG['host_os'] =~ /linux/
+  notification :notifysend
+end
+
+guard 'rspec', 
+  version: 2,
+  cli: '--format documentation',
+  all_on_start: false,
+  all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.(rb|citrus)$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -0,0 +1,32 @@
+`lector` reads Ruby data as a string or from a file without evaluating the code it reads.
+
+# Usage
+
+```
+> require 'lector'
+ => true
+> Lector::read_s("{x: 11, :pants? => false}")
+ => {:x=>11, :pants?=>false} 
+```
+
+Please see the
+[tests](https://github.com/alandipert/lector/tree/master/spec/lector)
+for more usage examples.
+
+# Rationale
+
+Ruby's literal support for hashes, arrays, keywords, numbers, and
+strings makes Ruby data slightly more expressive than JSON and
+arguably as expressive as YAML.
+
+Ruby could be a decent format for representing things like markup or
+configuration data.  This library allows you to digest Ruby data
+strings and files without having to worry if arbitrary code will
+execute.
+
+# Thanks
+
+This library started as a fork of Michael Fogus and Alex Redington's
+[clj.rb](https://github.com/fogus/clj.rb), a library for parsing
+[Clojure](http://clojure.org) data from Ruby.  A big thanks to them
+for getting this party started.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+require "rspec/core/rake_task"
+require 'rake'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.ruby_opts = '-Ilib -Ispec -I.'
+  t.rspec_opts = '--color'
+end
+
+task :default => :spec

data/lector.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lector/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lector"
+  s.version     = Lector::VERSION
+  s.authors     = ["Alan Dipert", "Michael Fogus", "Alex Redington"]
+  s.email       = ["alan@dipert.org"]
+  s.homepage    = "http://github.com/alandipert/lector"
+  s.summary     = %q{A Ruby data reader.}
+  s.description = %q{lector parses Ruby data into Ruby data structures.}
+
+  s.rubyforge_project = "lector"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_runtime_dependency 'citrus'
+end

data/lib/lector/reader.citrus

@@ -0,0 +1,88 @@
+grammar Lector::RubyParse
+
+  rule ruby_data
+    (space* form space*) <Lector::Types::Data>
+  end
+
+  rule form
+    array | hash | literal
+  end
+
+  rule literal
+    nil | boolean | string | symbol | hashkey | number
+  end
+
+  rule nil
+    "nil" <Lector::Types::Nil>
+  end
+
+  rule boolean
+    ("true" | "false") <Lector::Types::Boolean>
+  end
+
+  rule string
+    ("\"" content:string_content* "\"") <Lector::Types::String>
+  end
+
+  rule string_content
+    (/[^"\\]/ | /\\./)
+  end
+
+  rule symbol
+    simple_symbol | string_symbol
+  end
+
+  rule simple_symbol
+    (":" symbol_content) <Lector::Types::SimpleSymbol>
+  end
+
+  rule symbol_content
+    /[a-zA-Z!_][a-zA-Z0-9_]*[\?!]?/
+  end
+
+  rule string_symbol
+    (":" string) <Lector::Types::StringSymbol>
+  end
+
+  rule number
+    hex_integer | float | integer
+  end
+
+  rule hex_integer
+    /([-+]?)0[xX]([0-9A-Fa-f]+)?/ <Lector::Types::HexInteger>
+  end
+
+  rule float
+    ((number:/[-+]?[0-9]+\.[0-9]*(?:[eE][-+]?[0-9]+)?/)
+     | (number:/[-+]?[0-9][eE][-+]?[0-9]+/)) <Lector::Types::Float>
+  end
+
+  rule integer
+    /([-+]?0)|([-+]?[1-9]\d*)?/ <Lector::Types::Integer>
+  end
+
+  rule array
+    #TODO: Spurious commas should be parse errors.
+    ('['
+     ((space* form space* ',')* (space* form space*))
+     ']') <Lector::Types::Array>
+  end
+
+  rule hash
+    #TODO: Spurious commas should be parse errors.
+    ('{'
+     (((space* form space* '=>' space* form space* ',') |
+       (space* form ':' space* form space* ','))*
+      ((space* form space* '=>' space* form space*) |
+       (space* form ':' space* form space*)))
+     '}') <Lector::Types::Hash>
+  end
+
+  rule hashkey
+    #TODO: Kludge - this shouldn't be a standalone terminal.
+    symbol_content <Lector::Types::HashKey>
+  end
+
+  rule space [ \t\n\r] end
+
+end

data/lib/lector/types.rb

@@ -0,0 +1,31 @@
+module Lector
+  module Types
+    module Data; def val; form.val; end; end
+    module Boolean; def val; to_s == "true"; end; end
+    module Nil; def val; nil; end; end
+    module Integer; def val; to_i; end; end
+    module HexInteger; def val; to_i 16; end; end
+    module Float; def val; to_f; end; end
+    module SimpleSymbol; def val; slice(1..-1).to_sym; end; end
+    module StringSymbol; def val; slice(2..-2).to_sym; end; end
+    module HashKey; def val; to_sym; end; end
+    module String; def val; captures[:content].first.gsub(/\\\"/,"\""); end; end
+
+    module Array
+      def val
+        captures[:form].map(&:val)
+      end
+    end
+
+    module Hash
+      def val
+        ruby_val = {}
+        captures[:form].each_slice(2) do |slice|
+          key,value = slice
+          ruby_val[key.val] = value.val
+        end
+        ruby_val
+      end
+    end
+  end
+end

data/lib/lector/version.rb

@@ -0,0 +1,3 @@
+module Lector
+  VERSION = "0.0.1"
+end

data/lib/lector.rb

@@ -0,0 +1,16 @@
+require 'citrus'
+require 'lector/types'
+
+module Lector
+  Citrus.load('lib/lector/reader', :force => true)
+end
+
+module Lector
+  module RubyParse; end
+  def self.read_s(string)
+    Lector::RubyParse::parse(string).val
+  end
+  def self.read_file(file)
+    Lector::RubyParse::parse(File.read(file)).val
+  end
+end

data/spec/lector/reader_spec.rb

@@ -0,0 +1,109 @@
+require File.join(File.dirname(__FILE__), *%w[.. spec_helper.rb])
+require 'pry'
+require 'tempfile'
+
+def read_s(string)
+  Lector::read_s(string)
+end
+
+def read_file(file)
+  Lector::read_file(file)
+end
+
+describe Lector do
+  context 'reading strings' do
+    it 'parses integers' do
+      read_s("+42").should == 42
+      read_s("-42").should == -42
+      read_s("42").should == 42
+      read_s("-42").should == -42
+      read_s("-0").should == 0
+      read_s("+0").should == 0
+    end
+
+    it "parses hex integers" do
+      read_s("0xF").should == 15
+      read_s("+0xF").should == 15
+      read_s("-0xF").should == -15
+    end
+
+    it "parses floating point numbers" do
+      read_s("1.1").should == 1.1
+      read_s("-1.1").should == -1.1
+      read_s("-1.21e10").should == -12_100_000_000.0
+      read_s("+1.21e10").should == 12_100_000_000.0
+      read_s("1e4").should == 10_000
+    end
+
+    it "parses true and false" do
+      read_s("true").should == true
+      read_s("false").should == false
+    end
+
+    it "parses nil" do
+      read_s("nil").should == nil
+    end
+
+    it 'parses symbols' do
+      read_s(":sym").should == :sym
+      read_s(':"blah"').should == :blah
+      read_s(':"blah blah"').should == :"blah blah"
+    end
+
+    it 'parses arrays of single elements' do
+      read_s('[42]').should == [42]
+    end
+
+    it 'ignores whitespace' do
+      read_s("[ 42   ]").should == [42]
+    end
+
+    it 'parses arrays of multiple elements' do
+      read_s("[42, -1]").should == [42, -1]
+    end
+
+    it 'parses hashes' do
+      read_s("{a: 7, b: 6}").should == {:a => 7, :b => 6}
+      read_s("{b: 6}").should == {:b => 6}
+      read_s("{:a => 7, :b => 6}").should == {:a => 7, :b => 6}
+      read_s("{:a => 7, b: 6}").should == {:a => 7, :b => 6}
+    end
+
+    it 'parses nested collections' do
+      read_s("[[1,2], 3, 4]").should == [[1, 2], 3, 4]
+    end
+
+    it 'has no problem with hashes of arrays' do
+      read_s("{a: [1, 2], b: [3, 4]}").should == {:a => [1, 2], :b => [3, 4]}
+      read_s("{:a => [1, 2], :b => [3, 4]}").should == {:a => [1, 2], :b => [3, 4]}
+    end
+
+    it 'copes when data is surrounded by whitespace' do
+      read_s("
+{a: 7, b: 6}   ").should == {:a => 7, :b => 6}
+    end
+
+    it 'reads strings' do
+      read_s('"a string by any other name is just as tangly"').should == 'a string by any other name is just as tangly'
+    end
+
+    it 'reads strings with escaped quotes' do
+      read_s('"a string with an \"escaped quote\""').should == 'a string with an "escaped quote"'
+    end
+
+    it 'preserves other escaped characters' do
+      read_s('"a string with a\nnewline"').should == 'a string with a\nnewline'
+    end
+  end
+
+  context 'reading files' do
+    it 'should be able to round-trip data to file' do
+      hsh = {:a => [1, 2], nil => false, :b => [3, 4], blah: [1.2, {:x => 20}]}
+      Tempfile.new('lector').tap do |f|
+        f.write(hsh.to_s)
+        f.rewind
+        read_file(f).should == hsh
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib lector])
+
+RSpec.configure do |config|
+  config.filter_run :focused => true
+  config.alias_example_to :fit, :focused => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: lector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alan Dipert
+- Michael Fogus
+- Alex Redington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: citrus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: lector parses Ruby data into Ruby data structures.
+email:
+- alan@dipert.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lector.gemspec
+- lib/lector.rb
+- lib/lector/reader.citrus
+- lib/lector/types.rb
+- lib/lector/version.rb
+- spec/lector/reader_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alandipert/lector
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: lector
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby data reader.
+test_files: []