scanner 0.0.3 → 0.0.4

data/lib/scanner/scanner.rb

@@ -1,3 +1,4 @@
+# THis is the module to include in your class to inherit the scanner functionality
 module Scanner
 
   def self.append_features(aModule)
@@ -10,6 +11,20 @@ module Scanner
       @check_for_token_separator = {}
       @separator = nil
 
+      # defines a token of the language
+      # Each token is defined by a symbol, used to identify the token, and a
+      # regular expression that the token should match. An optional third
+      # parameter accepts a hash of options. For example:
+      # 
+      #     token :number, '\d+'
+      # 
+      # will match strings containing digits.
+      # 
+      # Some care is needed when defining tokens that collide with other
+      # tokens. For instance, a languange may define the token '==' and the
+      # token '='. You need to define the double equals before the single
+      # equals, otherwise the string '==' will be identified as two '=' tokens,
+      # instead of a '==' token. 
       def token(token_symbol, regular_expression, options = {})
         modified_reg_exp = "\\A#{regular_expression}"
         @language_tokens[token_symbol] = /#{modified_reg_exp}/
@@ -60,6 +75,7 @@ module Scanner
 
   include Enumerable
 
+  # Sets the string to parse
   def parse(program)
     @program = program
     @token_list = []

data/lib/scanner/version.rb

@@ -1,3 +1,3 @@
 module Scanner
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scanner
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2266866493885490648
+      hash: -1550862085541949899
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2266866493885490648
+      hash: -1550862085541949899
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24