lector 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+
+# Only build master branch
+branches:
+  only:
+    - master
+
+# To stop Travis from running tests for a new commit,
+# add the following to your commit message: [ci skip]
+# You should add this when you edit documentation or comments, etc.

data/Gemfile

@@ -1,3 +1,7 @@
 source 'http://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -24,6 +24,7 @@ GEM
       method_source (~> 0.6.7)
       ruby_parser (>= 2.3.1)
       slop (~> 2.1.0)
+    rake (0.9.2.2)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -50,5 +51,6 @@ DEPENDENCIES
   guard-rspec
   lector!
   pry
+  rake
   rspec
   simplecov

data/README.md

@@ -1,7 +1,8 @@
-`lector` reads Ruby data as a string or from a file without evaluating the code it reads.
+`lector` reads Ruby data as a string or from a file without evaluating the code it reads. [![Build Status](https://secure.travis-ci.org/alandipert/lector.png)](http://travis-ci.org/alandipert/lector)
 
 # Usage
 
+## Reading Strings
 ```
 > require 'lector'
  => true
@@ -9,6 +10,17 @@
  => {:x=>11, :pants?=>false} 
 ```
 
+## Read-Eval
+```
+# read-eval is off by default:
+> Lector::read_s("{three: #='1+2'}")
+ => {:three=>nil}
+
+# but you can turn it on...
+> Lector::read_s("{three: #='1+2'}", :read_eval => true)
+ => {:three=>3} 
+```
+
 Please see the
 [tests](https://github.com/alandipert/lector/tree/master/spec/lector)
 for more usage examples.

data/lib/lector/reader.citrus

@@ -9,7 +9,7 @@ grammar Lector::RubyParse
   end
 
   rule literal
-    nil | boolean | string | symbol | hashkey | number
+    nil | boolean | string | code | symbol | hashkey | number
   end
 
   rule nil
@@ -21,11 +21,19 @@ grammar Lector::RubyParse
   end
 
   rule string
-    ("\"" content:string_content* "\"") <Lector::Types::String>
+    single_quoted_string | double_quoted_string
   end
 
-  rule string_content
-    (/[^"\\]/ | /\\./)
+  rule double_quoted_string
+    ("\"" content:(/[^"\\]/ | /\\./)* "\"") <Lector::Types::String>
+  end
+
+  rule single_quoted_string
+    ("'" content:(/[^'\\]/ | /\\./)* "'") <Lector::Types::String>
+  end
+
+  rule code
+    ("#=" code:string) <Lector::Types::Code>
   end
 
   rule symbol

data/lib/lector/types.rb

@@ -11,6 +11,14 @@ module Lector
     module HashKey; def val; to_sym; end; end
     module String; def val; captures[:content].first.gsub(/\\\"/,"\""); end; end
 
+    module Code
+      def val
+        if $_LECTOR_READ_EVAL
+          eval(code.to_s.slice(3..-2))
+        end
+      end
+    end
+
     module Array
       def val
         captures[:form].map(&:val)

data/lib/lector/version.rb

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

data/lib/lector.rb

@@ -7,10 +7,11 @@ end
 
 module Lector
   module RubyParse; end
-  def self.read_s(string)
+  def self.read_s(string, opts = {})
+    $_LECTOR_READ_EVAL = opts[:read_eval]
     Lector::RubyParse::parse(string).val
   end
-  def self.read_file(file)
-    Lector::RubyParse::parse(File.read(file)).val
+  def self.read_file(file, opts = {})
+    read_s(File.read(file), opts)
   end
 end

data/spec/lector/reader_spec.rb

@@ -2,107 +2,114 @@ 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
+      Lector::read_s("+42").should == 42
+      Lector::read_s("-42").should == -42
+      Lector::read_s("42").should == 42
+      Lector::read_s("-42").should == -42
+      Lector::read_s("-0").should == 0
+      Lector::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
+      Lector::read_s("0xF").should == 15
+      Lector::read_s("+0xF").should == 15
+      Lector::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
+      Lector::read_s("1.1").should == 1.1
+      Lector::read_s("-1.1").should == -1.1
+      Lector::read_s("-1.21e10").should == -12_100_000_000.0
+      Lector::read_s("+1.21e10").should == 12_100_000_000.0
+      Lector::read_s("1e4").should == 10_000
     end
 
     it "parses true and false" do
-      read_s("true").should == true
-      read_s("false").should == false
+      Lector::read_s("true").should == true
+      Lector::read_s("false").should == false
     end
 
     it "parses nil" do
-      read_s("nil").should == nil
+      Lector::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"
+      Lector::read_s(":sym").should == :sym
+      Lector::read_s(':"blah"').should == :blah
+      Lector::read_s(':"blah blah"').should == :"blah blah"
+      Lector::read_s(":'foo foo'").should == :"foo foo"
     end
 
     it 'parses arrays of single elements' do
-      read_s('[42]').should == [42]
+      Lector::read_s('[42]').should == [42]
     end
 
     it 'ignores whitespace' do
-      read_s("[ 42   ]").should == [42]
+      Lector::read_s("[ 42   ]").should == [42]
     end
 
     it 'parses arrays of multiple elements' do
-      read_s("[42, -1]").should == [42, -1]
+      Lector::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}
+      Lector::read_s("{a: 7, b: 6}").should == {:a => 7, :b => 6}
+      Lector::read_s("{b: 6}").should == {:b => 6}
+      Lector::read_s("{:a => 7, :b => 6}").should == {:a => 7, :b => 6}
+      Lector::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]
+      Lector::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]}
+      Lector::read_s("{a: [1, 2], b: [3, 4]}").should == {:a => [1, 2], :b => [3, 4]}
+      Lector::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("
+      Lector::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'
+    it 'reads double-quoted strings' do
+      Lector::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 single-quoted strings' do
+      Lector::read_s("'i only have single quotes'").should == 'i only have single quotes'
     end
 
     it 'reads strings with escaped quotes' do
-      read_s('"a string with an \"escaped quote\""').should == 'a string with an "escaped quote"'
+      Lector::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'
+      Lector::read_s('"a string with a\nnewline"').should == 'a string with a\nnewline'
     end
   end
 
+  context 'read-evaling' do
+    it "shouldn't eval the code" do
+      Lector::read_s("#='1+2'").should == nil
+    end
+    it "should eval the code" do
+      Lector::read_s("#='1+2'", :read_eval => true).should == 3
+    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
+        Lector::read_file(f).should == hsh
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -119,6 +119,7 @@ files:
 - .document
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - Guardfile