rdparser 0.1.1 → 0.1.2

data/.gitignore

@@ -5,3 +5,5 @@ test_files/
 Gemfile.lock
 .yardoc/
 pkg/
+.*.swp
+rdoc/

data/Rakefile

@@ -29,12 +29,12 @@ end
 
 task :spec => 'spec:progress'
 
-desc 'Generate documentation for the a4-core plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
+desc 'Generate documentation for the rdparser plugin.'
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'RDParser'
   rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
-  rdoc.rdoc_files.include('README')
+  #rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/lib/rdparser.rb

@@ -3,7 +3,10 @@ require File.expand_path('../patches/array.rb', __FILE__)
 
 # A Simple Recursive Descending (LL) Parser for Ruby
 module RDParser
-  require File.expand_path('../rdparser/exceptions.rb', __FILE__)
+
+  # raised when Parser cannot get through the entire string.
+  class ParserError < StandardError; end
+
   autoload :RDParser, File.expand_path('../rdparser/rdparser.rb', __FILE__)
   autoload :Scanner,  File.expand_path('../rdparser/scanner.rb', __FILE__)
 

data/lib/rdparser/rdparser.rb

@@ -14,15 +14,15 @@ class RDParser::RDParser
     @depth = -1
 
     # Create a string scanner object based on the content
-    @content = RDParser::Scanner.new(content, :slurp_whitespace => !options[:manual_whitespace])
+    @content = ::RDParser::Scanner.new(content, :slurp_whitespace => !options[:manual_whitespace])
 
     # Kick off the show by parsing from the rule specified
-    result = parse_section(rule.to_sym).flatten
+    results = parse_section(rule.to_sym)
 
     # Raises ParserError when cannot get parse the entire content and :partial is not set.
-    raise ParserError, %{Cannot parse the entire content! (error was on position ##{@content.position}: "#{content[0...@content.position]}|#{content[@content.position..@content.position]}|#{content[@content.position+1..-1]}")} unless options[:partial] == true or @content.eos?
+    raise ::RDParser::ParserError, %{Cannot parse the entire content! (error was on position ##{@content.position}: "#{content[0...@content.position]}|#{content[@content.position..@content.position]}|#{content[@content.position+1..-1]}")} unless options[:partial] == true or @content.eos?
 
-    result
+    [results].flatten
   end
 
   # Parse the content based on the rulesets for a particular grammar context
@@ -32,7 +32,7 @@ class RDParser::RDParser
 
     # For each distinct set of rules within a ruleset, get parsing..
     sub_rulesets(rule).each do |ruleset|
-      RDParser::DEBUG && debug_message("RULE SET : #{ruleset}")
+      ::RDParser::DEBUG && debug_message("RULE SET : #{ruleset}")
 
       # By default, we assume failure!
       success = false
@@ -43,7 +43,7 @@ class RDParser::RDParser
 
       # Go through each rule in this ruleset
       sub_rules(ruleset).each do |r|
-        RDParser::DEBUG && debug_message("Running rule '#{r}' against '#{@content.lookahead}'")
+        ::RDParser::DEBUG && debug_message("Running rule '#{r}' against '#{@content.lookahead}'")
         suboutput = []
 
         # Match a rule with 1 or more occurrences (e.g. "rule(s)") 
@@ -95,22 +95,22 @@ class RDParser::RDParser
 
       # We've either processed all the rules for this ruleset, or.. it failed      
       if success
-        RDParser::DEBUG && debug_message("Success of all rules in #{ruleset}")
+        ::RDParser::DEBUG && debug_message("Success of all rules in #{ruleset}")
 
         # No need to check any more rulesets! We've just passed one,
         # so drop the depth a notch, we're headed back up the tree of recursion!
         @depth -= 1
-        RDParser::DEBUG && debug_message("SUCCEED: #{ruleset}", :passback)
+        ::RDParser::DEBUG && debug_message("SUCCEED: #{ruleset}", :passback)
         return output
       else
-        RDParser::DEBUG && debug_message("failed #{ruleset}.. moving on")
+        ::RDParser::DEBUG && debug_message("failed #{ruleset}.. moving on")
 
         # If the rule set failed, revert the position back to that we stored earlier
         @content.rollback_to(was_position)
 
         # And clean the output.. because any output we got from a broken rule is as useful
         # as an ashtray on a motorbike, a chocolate teapot, or ice cutlery.
-        RDParser::DEBUG && debug_message("FAIL: #{ruleset}", :passback)
+        ::RDParser::DEBUG && debug_message("FAIL: #{ruleset}", :passback)
       end
     end
 
@@ -121,7 +121,7 @@ class RDParser::RDParser
 
   # Parse the content based on a single subrule
   def match_for_rule(rule)
-    RDParser::DEBUG && debug_message("TRYING #{rule}")
+    ::RDParser::DEBUG && debug_message("TRYING #{rule}")
     output = []
     rule_data = @grammar[rule]
 
@@ -129,7 +129,7 @@ class RDParser::RDParser
     if rule.to_s =~ /^\"(.+)\"$/
       m = $1
       if @content.scan(m)
-        RDParser::DEBUG && debug_message("GOT #{m}")
+        ::RDParser::DEBUG && debug_message("GOT #{m}")
         output << {rule => m}
       else
         return false
@@ -139,7 +139,7 @@ class RDParser::RDParser
     elsif rule_data.class == Regexp
       # If we get a match.. do stuff!
       if c = @content.scan(rule_data)
-        RDParser::DEBUG && debug_message("GOT IT --> #{c}")
+        ::RDParser::DEBUG && debug_message("GOT IT --> #{c}")
         output << {rule => c}
       else
         # If we get no match, go and cry to mommy^H^H^H^H^Hhead up the recursion ladder
@@ -154,11 +154,11 @@ class RDParser::RDParser
       # But did it really work out as planned?
       if response
         # Yes.. so celebrate and process the response.
-        RDParser::DEBUG && debug_message("GOT #{rule}")
+        ::RDParser::DEBUG && debug_message("GOT #{rule}")
         return {rule => response}
       else
         # No.. so throw a hissyfit
-        RDParser::DEBUG && debug_message("NOT GOT #{rule}")
+        ::RDParser::DEBUG && debug_message("NOT GOT #{rule}")
         return false
       end
     end    
@@ -174,7 +174,7 @@ class RDParser::RDParser
 
   # A 'pretty printer' for RDParser's syntax trees (pp just doesn't cut it for these beasties)
   # There's probably a nice iterative way of doing this but I'm tired.
-  def RDParser.text_syntax_tree(v, depth = 0, output = '')
+  def self.text_syntax_tree(v, depth = 0, output = '')
     if v.class == Array
       v.each { |a| output = text_syntax_tree(a, depth, output) }
     elsif v.class == Hash
@@ -189,7 +189,7 @@ class RDParser::RDParser
   # Prints a debugging message if debug mode is enabled
   def debug_message(message, priority = true)
     # Let's different types of message through
-    return if priority != RDParser::DEBUG
+    return if priority != ::RDParser::DEBUG
     puts "#{("  " * @depth.to_i) if @depth && @depth > -1 } #{message}"
   end
 end

data/lib/rdparser/version.rb

@@ -1,3 +1,3 @@
 module RDParser
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/rdparser.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.description       = "A Simple Recursive Descending (LL) Parser for Ruby"
   s.rubyforge_project = "rdparser"
 
+  s.add_development_dependency "rdoc"
   s.add_development_dependency "rake"
   s.add_development_dependency "bundler"
   s.add_development_dependency "rspec"

data/spec/exceptions_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path('../support/spec_helper.rb', __FILE__)
+
+describe "RDParser::ParserError" do
+  it { expect{ RDParser::ParserError }.should_not raise_error }
+end

data/spec/parser_base_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../support/spec_helper.rb', __FILE__)
+
+describe RDParser::RDParser do
+  context "given a very simple grammar" do
+    include ParserHelper
+    parser do |p|
+      p.expression  '"a" expression1'
+      p.expression1 /^.*$/
+    end
+
+    it { should     parse("asdf") }
+    it { should_not parse("qwer") }
+  end
+end
+

data/spec/support/parser_helper.rb

@@ -16,8 +16,17 @@ module ParserHelper
         def description
           %{should parse "#{@_expression}" starting with :#{@_root}}
         end
+        def failure_message
+          %{Grammar should parse "#{@_expression}"!}
+        end
+        def negative_failure_message
+          %{Grammar should not parse "#{@_expression}"!}
+        end
         def matches? parser
           parser.parse(@_root, @_expression).kind_of?(Array)
+          return true
+        rescue RDParser::ParserError
+          return false
         end
       end
       o.instance_variable_set('@_expression', expression)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdparser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-17 00:00:00.000000000Z
+date: 2011-12-22 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &19621620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19621620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15362520 !ruby/object:Gem::Requirement
+  requirement: &19621200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15362520
+  version_requirements: *19621200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &15362100 !ruby/object:Gem::Requirement
+  requirement: &19620780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15362100
+  version_requirements: *19620780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &15361680 !ruby/object:Gem::Requirement
+  requirement: &19620360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15361680
+  version_requirements: *19620360
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &15361260 !ruby/object:Gem::Requirement
+  requirement: &19619940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15361260
+  version_requirements: *19619940
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &15360840 !ruby/object:Gem::Requirement
+  requirement: &19619520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15360840
+  version_requirements: *19619520
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &15360420 !ruby/object:Gem::Requirement
+  requirement: &19619100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15360420
+  version_requirements: *19619100
 description: A Simple Recursive Descending (LL) Parser for Ruby
 email:
 - golda@bitandpixel.hu
@@ -91,12 +102,13 @@ files:
 - Rakefile
 - lib/patches/array.rb
 - lib/rdparser.rb
-- lib/rdparser/exceptions.rb
 - lib/rdparser/rdparser.rb
 - lib/rdparser/scanner.rb
 - lib/rdparser/version.rb
 - rdparser.gemspec
 - spec/examples/a4_spec.rb
+- spec/exceptions_spec.rb
+- spec/parser_base_spec.rb
 - spec/support/parser_helper.rb
 - spec/support/spec_helper.rb
 homepage: http://www.rubyinside.com/recursive-descent-parser-for-ruby-300.html
@@ -114,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2323939059109042522
+      hash: 534404727448102245
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,11 +135,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2323939059109042522
+      hash: 534404727448102245
 requirements: []
 rubyforge_project: rdparser
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: rdparser-0.1.1
+summary: rdparser-0.1.2
 test_files: []

data/lib/rdparser/exceptions.rb

@@ -1,4 +0,0 @@
-module RDParser
-  # raised when Parser cannot get through the entire string.
-  class ParserError < StandardError; end
-end