bkerley-radius 0.6.1

data/lib/radius/parser/scan.rl

@@ -0,0 +1,122 @@
+%%{
+	machine parser;
+	
+	
+	action _prefix { mark_pfx = p }
+	action prefix {
+	  if data[mark_pfx..p-1] != @prefix
+	    fnext Closeout;
+    end
+	}
+	action _starttag { mark_stg = p }
+	action starttag { @starttag = data[mark_stg..p-1] }
+	action _attr { mark_attr = p }
+	action attr {
+	  @attrs[@nat] = @vat 
+	}
+	
+	action prematch {
+	  @prematch_end = p
+	  @prematch = data[0..p] if p > 0
+	}
+	
+	action _nameattr { mark_nat = p }
+	action nameattr { @nat = data[mark_nat..p-1] }
+	action _valattr { mark_vat = p }
+	action valattr { @vat = data[mark_vat..p-1] }
+	
+	action opentag  { @flavor = :open }
+	action selftag  { @flavor = :self }
+	action closetag { @flavor = :close }
+	
+	action stopparse {
+	  @cursor = p;
+	  fbreak;
+	}
+	
+	
+	Closeout := empty;
+	
+	# words
+	PrefixChar = [\-A-Za-z0-9._?] ;
+	NameChar = [\-A-Za-z0-9._:?] ;
+	TagName = NameChar+ >_starttag %starttag;
+	Prefix = PrefixChar+ >_prefix %prefix;
+	
+	Name = Prefix ":" TagName;
+	
+	NameAttr = NameChar+ >_nameattr %nameattr;
+  Q1Char = ( "\\\'" | [^'] ) ;
+  Q1Attr = Q1Char* >_valattr %valattr;
+  Q2Char = ( "\\\"" | [^"] ) ;
+  Q2Attr = Q2Char* >_valattr %valattr;
+ 
+  Attr =  NameAttr space* "=" space* ('"' Q2Attr '"' | "'" Q1Attr "'") space* >_attr %attr;
+  Attrs = (space+ Attr* | empty);
+  
+  CloseTrailer = "/>" %selftag;
+  OpenTrailer = ">" %opentag;
+  
+  Trailer = (OpenTrailer | CloseTrailer);
+  
+	OpenOrSelfTag = Name Attrs? Trailer;
+	CloseTag = "/" Name space* ">" %closetag;
+	
+	SomeTag = '<' (OpenOrSelfTag | CloseTag);
+	
+	main := |*
+	  SomeTag => {
+	    tag = {:prefix=>@prefix, :name=>@starttag, :flavor => @flavor, :attrs => @attrs}
+	    @prefix = nil
+	    @name = nil
+	    @flavor = :tasteless
+	    @attrs = {}
+	    @nodes << tag << ''
+      fbreak;
+	  };
+	  any => {
+	    @nodes.last << data[p]
+	    @tagstart = p
+	  };
+	*|;
+}%%
+
+module Radius
+  class Scanner
+    def self.operate(prefix, data)
+      buf = ""
+      csel = ""
+      @prematch = ''
+      @starttag = nil
+      @attrs = {}
+      @flavor = :tasteless
+      @cursor = 0
+      @tagstart = 0
+      @nodes = ['']
+      remainder = data.dup
+
+      until remainder.length == 0
+        p = perform_parse(prefix, remainder)
+        remainder = remainder[p..-1]
+      end
+
+      return @nodes
+    end
+    
+    private
+    def self.perform_parse(prefix, data)
+      stack = []
+      p = 0
+      ts = 0
+      te = 0
+      act = 0
+      eof = data.length
+      
+      @prefix = prefix
+      %% write data;
+      %% write init;
+      %% write exec;
+      return p
+    end
+  end
+end

data/lib/radius/parsetag.rb

@@ -0,0 +1,24 @@
+module Radius
+  class ParseTag # :nodoc:
+    def initialize(&b)
+      @block = b
+    end
+
+    def on_parse(&b)
+      @block = b
+    end
+
+    def to_s
+      @block.call(self)
+    end
+  end
+
+  class ParseContainerTag < ParseTag # :nodoc:
+    attr_accessor :name, :attributes, :contents
+    
+    def initialize(name = "", attributes = {}, contents = [], &b)
+      @name, @attributes, @contents = name, attributes, contents
+      super(&b)
+    end
+  end
+end

data/lib/radius/tagbinding.rb

@@ -0,0 +1,71 @@
+module Radius
+  #
+  # A tag binding is passed into each tag definition and contains helper methods for working
+  # with tags. Use it to gain access to the attributes that were passed to the tag, to
+  # render the tag contents, and to do other tasks.
+  #
+  class TagBinding
+    # The Context that the TagBinding is associated with. Used internally. Try not to use
+    # this object directly.
+    attr_reader :context
+  
+    # The locals object for the current tag.
+    attr_reader :locals
+  
+    # The name of the tag (as used in a template string).
+    attr_reader :name
+  
+    # The attributes of the tag. Also aliased as TagBinding#attr.
+    attr_reader :attributes
+    alias :attr :attributes
+  
+    # The render block. When called expands the contents of the tag. Use TagBinding#expand
+    # instead.
+    attr_reader :block
+  
+    # Creates a new TagBinding object.
+    def initialize(context, locals, name, attributes, block)
+      @context, @locals, @name, @attributes, @block = context, locals, name, attributes, block
+    end
+  
+    # Evaluates the current tag and returns the rendered contents.
+    def expand
+      double? ? block.call : ''
+    end
+
+    # Returns true if the current tag is a single tag.
+    def single?
+      block.nil?
+    end
+
+    # Returns true if the current tag is a container tag.
+    def double?
+      not single?
+    end
+  
+    # The globals object from which all locals objects ultimately inherit their values.
+    def globals
+      @context.globals
+    end
+  
+    # Returns a list of the way tags are nested around the current tag as a string.
+    def nesting
+      @context.current_nesting
+    end
+  
+    # Fires off Context#tag_missing for the current tag.
+    def missing!
+      @context.tag_missing(name, attributes, &block)
+    end
+  
+    # Renders the tag using the current context .
+    def render(tag, attributes = {}, &block)
+      @context.render_tag(tag, attributes, &block)
+    end
+  
+    # Shortcut for accessing tag.attr[key]
+    def [](key)
+      attr[key]
+    end
+  end
+end

data/lib/radius/tagdefs.rb

@@ -0,0 +1,78 @@
+module Radius
+  module TagDefinitions # :nodoc:
+    class TagFactory # :nodoc:
+      def initialize(context)
+        @context = context
+      end
+    
+      def define_tag(name, options, &block)
+        options = prepare_options(name, options)
+        validate_params(name, options, &block)
+        construct_tag_set(name, options, &block)
+        expose_methods_as_tags(name, options)
+      end
+    
+      protected
+
+        # Adds the tag definition to the context. Override in subclasses to add additional tags
+        # (child tags) when the tag is created.
+        def construct_tag_set(name, options, &block)
+          if block
+            @context.definitions[name.to_s] = block
+          else
+            lp = last_part(name)
+            @context.define_tag(name) do |tag|
+              if tag.single?
+                options[:for]
+              else
+                tag.locals.send("#{ lp }=", options[:for]) unless options[:for].nil?
+                tag.expand
+              end
+            end
+          end
+        end
+
+        # Normalizes options pased to tag definition. Override in decendants to preform
+        # additional normalization.
+        def prepare_options(name, options)
+          options = Util.symbolize_keys(options)
+          options[:expose] = expand_array_option(options[:expose])
+          object = options[:for]
+          options[:attributes] = object.respond_to?(:attributes) unless options.has_key? :attributes
+          options[:expose] += object.attributes.keys if options[:attributes]
+          options
+        end
+      
+        # Validates parameters passed to tag definition. Override in decendants to add custom
+        # validations.
+        def validate_params(name, options, &block)
+          unless options.has_key? :for
+            raise ArgumentError.new("tag definition must contain a :for option or a block") unless block
+            raise ArgumentError.new("tag definition must contain a :for option when used with the :expose option") unless options[:expose].empty?
+          end
+        end
+      
+        # Exposes the methods of an object as child tags.
+        def expose_methods_as_tags(name, options)
+          options[:expose].each do |method|
+            tag_name = "#{name}:#{method}"
+            lp = last_part(name)
+            @context.define_tag(tag_name) do |tag|
+              object = tag.locals.send(lp)
+              object.send(method)
+            end
+          end
+        end
+      
+      protected
+    
+        def expand_array_option(value)
+          [*value].compact.map { |m| m.to_s.intern }
+        end
+      
+        def last_part(name)
+          name.split(':').last
+        end
+    end
+  end
+end

data/lib/radius/util.rb

@@ -0,0 +1,30 @@
+module Radius
+  module Util # :nodoc:
+    def self.symbolize_keys(hash)
+      new_hash = {}
+      hash.keys.each do |k|
+        new_hash[k.to_s.intern] = hash[k]
+      end
+      new_hash
+    end
+  
+    def self.impartial_hash_delete(hash, key)
+      string = key.to_s
+      symbol = string.intern
+      value1 = hash.delete(symbol)
+      value2 = hash.delete(string)
+      value1 || value2
+    end
+  
+    def self.constantize(camelized_string)
+      raise "invalid constant name `#{camelized_string}'" unless camelized_string.split('::').all? { |part| part =~ /^[A-Za-z]+$/ }
+      Object.module_eval(camelized_string)
+    end
+  
+    def self.camelize(underscored_string)
+      string = ''
+      underscored_string.split('_').each { |part| string << part.capitalize }
+      string
+    end
+  end
+end

data/tasks/scan.rake

@@ -0,0 +1,27 @@
+namespace :scan do
+  desc 'Generate the parser'
+  task 'build' => ['lib/radius/parser/scan.rb']
+  
+  desc 'Generate a PDF state graph from the parser'
+  task 'graph' => ['doc/scan.pdf']
+  
+  desc 'turn the scan.rl file into a ruby file'
+  file 'lib/radius/parser/scan.rb' => ['lib/radius/parser/scan.rl'] do |t|
+    cd 'lib/radius/parser' do
+      sh "ragel -R scan.rl"
+    end
+  end
+
+  desc 'pdf of the ragel scanner'
+  file 'doc/scan.pdf' => 'lib/radius/parser/scan.dot' do |t|
+    cd 'lib/radius/parser' do
+      sh "dot -Tpdf -o ../../../doc/scan.pdf scan.dot"
+    end
+  end
+
+  file 'lib/radius/parser/scan.dot' => ['lib/radius/parser/scan.rl'] do |t|
+    cd 'lib/radius/parser' do
+      sh "ragel -Vp scan.rl > scan.dot"
+    end
+  end
+end

data/test/context_test.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RadiusContextTest < Test::Unit::TestCase
+  include RadiusTestHelper
+  
+  def setup
+    @context = new_context
+  end
+  
+  def test_initialize
+    @context = Radius::Context.new
+  end
+  
+  def test_initialize_with_block
+    @context = Radius::Context.new do |c|
+      assert_kind_of Radius::Context, c
+      c.define_tag('test') { 'just a test' }
+    end
+    assert_not_equal Hash.new, @context.definitions
+  end
+  
+  def test_with
+    got = @context.with do |c|
+      assert_equal @context, c
+    end
+    assert_equal @context, got
+  end
+  
+  def test_render_tag
+    define_tag "hello" do |tag|
+      "Hello #{tag.attr['name'] || 'World'}!"
+    end
+    assert_render_tag_output 'Hello World!', 'hello'
+    assert_render_tag_output 'Hello John!', 'hello', 'name' => 'John'
+  end
+  
+  def test_render_tag__undefined_tag
+    e = assert_raises(Radius::UndefinedTagError) { @context.render_tag('undefined_tag') }
+    assert_equal "undefined tag `undefined_tag'", e.message
+  end
+  
+  def test_tag_missing
+    class << @context
+      def tag_missing(tag, attr, &block)
+        "undefined tag `#{tag}' with attributes #{attr.inspect}"
+      end
+    end
+    
+    text = ''
+    expected = %{undefined tag `undefined_tag' with attributes {"cool"=>"beans"}}
+    assert_nothing_raised { text = @context.render_tag('undefined_tag', 'cool' => 'beans') }
+    assert_equal expected, text
+  end
+  
+  private
+    
+    def assert_render_tag_output(output, *render_tag_params)
+      assert_equal output, @context.render_tag(*render_tag_params)
+    end
+  
+end

data/test/parser_test.rb

@@ -0,0 +1,278 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RadiusParserTest < Test::Unit::TestCase
+  include RadiusTestHelper
+  
+  def setup
+    @context = new_context
+    @parser = Radius::Parser.new(@context, :tag_prefix => 'r')
+  end
+  
+  def test_initialize
+    @parser = Radius::Parser.new
+    assert_kind_of Radius::Context, @parser.context
+  end
+  
+  def test_initialize_with_params
+    @parser = Radius::Parser.new(TestContext.new)
+    assert_kind_of TestContext, @parser.context
+    
+    @parser = Radius::Parser.new(:context => TestContext.new)
+    assert_kind_of TestContext, @parser.context
+    
+    @parser = Radius::Parser.new('context' => TestContext.new)
+    assert_kind_of TestContext, @parser.context
+    
+    @parser = Radius::Parser.new(:tag_prefix => 'r')
+    assert_kind_of Radius::Context, @parser.context
+    assert_equal 'r', @parser.tag_prefix
+    
+    @parser = Radius::Parser.new(TestContext.new, :tag_prefix => 'r')
+    assert_kind_of TestContext, @parser.context
+    assert_equal 'r', @parser.tag_prefix
+  end
+  
+  def test_parse_individual_tags_and_parameters
+    define_tag "add" do |tag|
+      tag.attr["param1"].to_i + tag.attr["param2"].to_i
+    end
+    assert_parse_output "<3>", %{<<r:add param1="1" param2='2'/>>}
+  end
+  
+  def test_parse_attributes
+    attributes = %{{"a"=>"1", "b"=>"2", "c"=>"3", "d"=>"'"}}
+    assert_parse_output attributes, %{<r:attr a="1" b='2'c="3"d="'" />}
+    assert_parse_output attributes, %{<r:attr a="1" b='2'c="3"d="'"></r:attr>}
+  end
+  
+  def test_parse_attributes_with_slashes_or_angle_brackets
+    slash = %{{"slash"=>"/"}}
+    angle = %{{"angle"=>">"}}
+    assert_parse_output slash, %{<r:attr slash="/"></r:attr>}
+    assert_parse_output slash, %{<r:attr slash="/"><r:attr /></r:attr>}
+    assert_parse_output angle, %{<r:attr angle=">"></r:attr>}
+  end
+  
+  def test_parse_quotes
+    assert_parse_output "test []", %{<r:echo value="test" /> <r:wrap attr="test"></r:wrap>}
+  end
+  
+  def test_things_that_should_be_left_alone
+    [
+      %{ test="2"="4" },
+      %{="2" } 
+    ].each do |middle|
+      assert_parsed_is_unchanged "<r:attr#{middle}/>"
+      assert_parsed_is_unchanged "<r:attr#{middle}>"
+    end
+  end
+  
+  def test_tags_inside_html_tags
+    assert_parse_output %{<div class="xzibit">tags in yo tags</div>},
+      %{<div class="<r:reverse>tibizx</r:reverse>">tags in yo tags</div>}
+  end
+    
+  def test_parse_result_is_always_a_string
+    define_tag("twelve") { 12 }
+    assert_parse_output "12", "<r:twelve />"
+  end
+  
+  def test_parse_double_tags
+    assert_parse_output "test".reverse, "<r:reverse>test</r:reverse>"
+    assert_parse_output "tset TEST", "<r:reverse>test</r:reverse> <r:capitalize>test</r:capitalize>"
+  end
+  
+  def test_parse_tag_nesting
+    define_tag("parent", :for => '')
+    define_tag("parent:child", :for => '')
+    define_tag("extra", :for => '')
+    define_tag("nesting") { |tag| tag.nesting }
+    define_tag("extra:nesting") { |tag| tag.nesting.gsub(':', ' > ') }
+    define_tag("parent:child:nesting") { |tag| tag.nesting.gsub(':', ' * ') }
+    assert_parse_output "nesting", "<r:nesting />"
+    assert_parse_output "parent:nesting", "<r:parent:nesting />"
+    assert_parse_output "extra > nesting", "<r:extra:nesting />"
+    assert_parse_output "parent * child * nesting", "<r:parent:child:nesting />"
+    assert_parse_output "parent > extra > nesting", "<r:parent:extra:nesting />"
+    assert_parse_output "parent > child > extra > nesting", "<r:parent:child:extra:nesting />"
+    assert_parse_output "parent * extra * child * nesting", "<r:parent:extra:child:nesting />"
+    assert_parse_output "parent > extra > child > extra > nesting", "<r:parent:extra:child:extra:nesting />"
+    assert_parse_output "parent > extra > child > extra > nesting", "<r:parent><r:extra><r:child><r:extra><r:nesting /></r:extra></r:child></r:extra></r:parent>"
+    assert_parse_output "extra * parent * child * nesting", "<r:extra:parent:child:nesting />"
+    assert_parse_output "extra > parent > nesting", "<r:extra><r:parent:nesting /></r:extra>"
+    assert_parse_output "extra * parent * child * nesting", "<r:extra:parent><r:child:nesting /></r:extra:parent>"
+    assert_raises(Radius::UndefinedTagError) { @parser.parse("<r:child />") }
+  end
+  def test_parse_tag_nesting_2
+    define_tag("parent", :for => '')
+    define_tag("parent:child", :for => '')
+    define_tag("content") { |tag| tag.nesting }
+    assert_parse_output 'parent:child:content', '<r:parent><r:child:content /></r:parent>'
+  end
+  
+  def test_parse_tag__binding_do_missing
+    define_tag 'test' do |tag|
+      tag.missing!
+    end
+    e = assert_raises(Radius::UndefinedTagError) { @parser.parse("<r:test />") }
+    assert_equal "undefined tag `test'", e.message
+  end
+
+  def test_parse_chirpy_bird
+    # :> chirp chirp
+    assert_parse_output "<:", "<:"
+  end
+
+  def test_parse_tag__binding_render_tag
+    define_tag('test') { |tag| "Hello #{tag.attr['name']}!" }
+    define_tag('hello') { |tag| tag.render('test', tag.attr) }
+    assert_parse_output 'Hello John!', '<r:hello name="John" />'
+  end
+  
+  def test_accessing_tag_attributes_through_tag_indexer
+    define_tag('test') { |tag| "Hello #{tag['name']}!" }
+    assert_parse_output 'Hello John!', '<r:test name="John" />'
+  end
+  
+  def test_parse_tag__binding_render_tag_with_block
+    define_tag('test') { |tag| "Hello #{tag.expand}!" }
+    define_tag('hello') { |tag| tag.render('test') { tag.expand } }
+    assert_parse_output 'Hello John!', '<r:hello>John</r:hello>'
+  end
+  
+  def test_tag_locals
+    define_tag "outer" do |tag|
+      tag.locals.var = 'outer'
+      tag.expand
+    end
+    define_tag "outer:inner" do |tag|
+      tag.locals.var = 'inner'
+      tag.expand
+    end
+    define_tag "outer:var" do |tag|
+      tag.locals.var
+    end
+    assert_parse_output 'outer', "<r:outer><r:var /></r:outer>"
+    assert_parse_output 'outer:inner:outer', "<r:outer><r:var />:<r:inner><r:var /></r:inner>:<r:var /></r:outer>"
+    assert_parse_output 'outer:inner:outer:inner:outer', "<r:outer><r:var />:<r:inner><r:var />:<r:outer><r:var /></r:outer>:<r:var /></r:inner>:<r:var /></r:outer>"
+    assert_parse_output 'outer', "<r:outer:var />"
+  end
+  
+  def test_tag_globals
+    define_tag "set" do |tag|
+      tag.globals.var = tag.attr['value']
+      ''
+    end
+    define_tag "var" do |tag|
+      tag.globals.var
+    end
+    assert_parse_output "  true  false", %{<r:var /> <r:set value="true" /> <r:var /> <r:set value="false" /> <r:var />}
+  end
+  
+  def test_parse_loops
+    @item = nil
+    define_tag "each" do |tag|
+      result = []
+      ["Larry", "Moe", "Curly"].each do |item|
+        tag.locals.item = item
+        result << tag.expand
+      end
+      result.join(tag.attr["between"] || "")
+    end
+    define_tag "each:item" do |tag|
+      tag.locals.item
+    end
+    assert_parse_output %{Three Stooges: "Larry", "Moe", "Curly"}, %{Three Stooges: <r:each between=", ">"<r:item />"</r:each>}
+  end
+  
+  def test_parse_speed
+    define_tag "set" do |tag|
+      tag.globals.var = tag.attr['value']
+      ''
+    end
+    define_tag "var" do |tag|
+      tag.globals.var
+    end
+    parts = %w{decima nobis augue at facer processus commodo legentis odio lectorum dolore nulla esse lius qui nonummy ullamcorper erat ii notare}
+    multiplier = parts.map{|p| "#{p}=\"#{rand}\""}.join(' ')
+    assert_nothing_raised do
+      Timeout.timeout(10) do
+        assert_parse_output " false", %{<r:set value="false" #{multiplier} /> <r:var />}
+      end
+    end
+  end
+  
+  def test_tag_option_for
+    define_tag 'fun', :for => 'just for kicks'
+    assert_parse_output 'just for kicks', '<r:fun />'
+  end
+  
+  def test_tag_expose_option
+    define_tag 'user', :for => users.first, :expose => ['name', :age]
+    assert_parse_output 'John', '<r:user:name />'
+    assert_parse_output '25', '<r:user><r:age /></r:user>'
+    e = assert_raises(Radius::UndefinedTagError) { @parser.parse "<r:user:email />" }
+    assert_equal "undefined tag `email'", e.message
+  end
+  
+  def test_tag_expose_attributes_option_on_by_default
+    define_tag 'user', :for => user_with_attributes
+    assert_parse_output 'John', '<r:user:name />'
+  end
+  def test_tag_expose_attributes_set_to_false
+    define_tag 'user_without_attributes', :for => user_with_attributes, :attributes => false
+    assert_raises(Radius::UndefinedTagError) { @parser.parse "<r:user_without_attributes:name />" }
+  end
+  
+  def test_tag_options_must_contain_a_for_option_if_methods_are_exposed
+    e = assert_raises(ArgumentError) { define_tag('fun', :expose => :today) { 'test' } }
+    assert_equal "tag definition must contain a :for option when used with the :expose option", e.message
+  end
+  
+  def test_parse_fail_on_missing_end_tag
+    assert_raises(Radius::MissingEndTagError) { @parser.parse("<r:reverse>") }
+  end
+  
+  def test_parse_fail_on_wrong_end_tag
+    assert_raises(Radius::WrongEndTagError) { @parser.parse("<r:reverse><r:capitalize></r:reverse>") }
+  end
+  
+  protected
+  
+    def assert_parse_output(output, input, message = nil)
+      r = @parser.parse(input)
+      assert_equal(output, r, message)
+    end
+    
+    def assert_parsed_is_unchanged(something)
+      assert_parse_output something, something
+    end
+    
+    class User
+      attr_accessor :name, :age, :email, :friend
+      def initialize(name, age, email)
+        @name, @age, @email = name, age, email
+      end
+      def <=>(other)
+        name <=> other.name
+      end
+    end
+    
+    class UserWithAttributes < User
+      def attributes
+        { :name => name, :age => age, :email => email }
+      end
+    end
+    
+    def users
+      [
+        User.new('John', 25, 'test@johnwlong.com'),
+        User.new('James', 27, 'test@jameslong.com')
+      ]
+    end
+    
+    def user_with_attributes
+      UserWithAttributes.new('John', 25, 'test@johnwlong.com')
+    end
+  
+end