scanner 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scanner.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Diego Alonso
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/README.md

@@ -0,0 +1,47 @@
+# Scanner
+
+Scanner is a gem to scan strings for regular expressions, and return
+them as tokes, Each token will be identified by a symbol, and contain
+some extra information, like the line and column number.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scanner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scanner
+
+## Usage
+
+Scanner is a module that you can include in your classes. It defines a
+token function that accepts the regular expression that the token
+matches.
+
+Example code
+
+    class TestScanner
+      include Scanner
+      ignore /\s+/
+      token :number, /\d+/
+      token :id, /\w+/
+    end
+
+    @scanner = TestScanner.new
+    @scanner.parse("123")
+    @scanner.look_ahead.is?(:number) # Should be true
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/scanner/scanner.rb

@@ -0,0 +1,84 @@
+module Scanner
+
+  def self.append_features(aModule)
+    super
+
+    aModule.instance_eval do
+      @language_tokens = {}
+      @ignore = nil
+
+      def token(token_symbol, regular_expression)
+        @language_tokens[token_symbol] = regular_expression
+      end
+
+      def ignore(regular_expression)
+        @ignore = regular_expression
+      end
+
+      token :eof, /\A\z/
+    end
+
+  end
+
+  private
+  def language_tokens
+    self.class.instance_eval { @language_tokens }
+  end
+
+  def ignore
+    self.class.instance_eval { @ignore }
+  end
+
+  public
+
+  def parse(program)
+    @program = program
+    @token_list = []
+  end
+
+  def consume
+    if @token_list.empty?
+      consume_next_token
+    else
+      @token_list.shift
+    end
+  end
+
+  def look_ahead(number_of_tokens = 1)
+    end_of_file_met = false
+    while @token_list.size < number_of_tokens
+      throw :scanner_exception if end_of_file_met
+      token = consume_next_token
+      @token_list << token
+      end_of_file_met = token.is? :eof
+    end
+    @token_list[-1]
+  end
+
+  private
+
+
+  def consume_next_token
+    clear_ignore_text
+
+    language_tokens.each do |symbol, reg_exp|
+      if @program =~ reg_exp
+        return Token.new(symbol, consume_regular_expression(reg_exp), 0, 0)
+      end
+    end
+
+    throw :scanner_exception
+  end
+
+  def consume_regular_expression(regexp)
+    content = @program[regexp]
+    @program.gsub!(regexp,"")
+    content
+  end
+
+  def clear_ignore_text
+    consume_regular_expression(ignore) if ignore
+  end
+
+
+end

data/lib/scanner/token.rb

@@ -0,0 +1,21 @@
+module Scanner
+  class Token
+    attr_reader :symbol, :content, :line, :column
+
+    def initialize(symbol, content, line, column)
+      @symbol = symbol
+      @content = content
+      @line = line
+      @column = column
+    end
+
+    def is?(symbol)
+      @symbol == symbol
+    end
+
+    def is_not?(symbol)
+      not is? symbol
+    end
+  end
+end
+

data/lib/scanner/version.rb

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

data/lib/scanner.rb

@@ -0,0 +1,6 @@
+require "scanner/version"
+require "scanner/scanner"
+require "scanner/token"
+
+module Scanner
+end

data/scanner.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/scanner/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Diego Alonso"]
+  gem.email         = ["diego@gapthemind.net"]
+  gem.description   = %q{Simple scanner that returs tokens as symbols}
+  gem.summary       = %q{Simple scanner. For the time being, it uses regular expressions to scan tokens}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "scanner"
+  gem.require_paths = ["lib"]
+  gem.version       = Scanner::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

data/spec/scanner/scanner_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe Scanner do
+  before(:each) do
+    class TestScanner
+      include Scanner
+      ignore /\s+/
+      token :number, /\d+/
+      token :id, /\w+/
+    end
+
+    @scanner = TestScanner.new
+  end
+
+  it "detects the end of line" do
+    @scanner.parse("")
+    @scanner.consume.is?(:eof).should be true
+  end
+
+  describe "consume" do
+
+    it "consume returns the next token" do
+      @scanner.parse("123")
+      token = @scanner.consume
+      token.is?(:number).should be true
+      token.content.should eq("123")
+    end
+
+    it "consume clears ignore tokens before token" do
+      @scanner.parse("   123")
+      token = @scanner.consume
+      token.is?(:number).should be true
+    end
+  end
+
+  describe "lookahead" do
+    it "returns the next token without arguments" do
+      @scanner.parse("123")
+      @scanner.look_ahead.is?(:number).should be true
+    end
+
+    it "does not consume the token" do
+      @scanner.parse("123")
+      @scanner.look_ahead
+      @scanner.consume.is?(:number).should be true
+    end
+
+    it "returns look ahead of n elements" do
+      @scanner.parse("123 abc")
+      @scanner.look_ahead(2).is?(:id).should be true
+    end
+  end
+
+
+end

data/spec/scanner/token_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Scanner::Token do
+
+  it "is the right type of token" do
+    @token = Scanner::Token.new(:token_symbol, "content", 0, 0)
+    @token.is?(:token_symbol).should be true
+  end
+
+  it "is not the wrong type of token" do
+    @token = Scanner::Token.new(:token_symbol, "content", 0, 0)
+    @token.is_not?(:other_token_symbol).should be true
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'scanner'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: scanner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Diego Alonso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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'
+description: Simple scanner that returs tokens as symbols
+email:
+- diego@gapthemind.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/scanner.rb
+- lib/scanner/scanner.rb
+- lib/scanner/token.rb
+- lib/scanner/version.rb
+- scanner.gemspec
+- spec/scanner/scanner_spec.rb
+- spec/scanner/token_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -2890427904096243855
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2890427904096243855
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple scanner. For the time being, it uses regular expressions to scan tokens
+test_files:
+- spec/scanner/scanner_spec.rb
+- spec/scanner/token_spec.rb
+- spec/spec_helper.rb