trellis 0.0.1

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "test/spec.opts"]
+  t.spec_files = FileList['test/**/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/application_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require "rack" 
+require_fixtures 'application_spec_applications'
+
+describe Trellis::Application, " a Trellis application when declared" do
+  before do
+    @homepage = TestApp::MyApp.instance_eval { @homepage }
+    @pages = TestApp::MyApp.instance_eval { @pages }
+    @static_routes = TestApp::MyApp.instance_eval { @static_routes }
+  end
+  
+  it "should contain a contain the symbol for its home page" do
+    @homepage.should == :home
+  end
+  
+  it "should contain the home page in its collection of pages" do
+    @pages.include?(:home).should be(true)
+  end
+  
+  it "should contain any declared static routes" do
+    images_route = @static_routes.select { |item| item[:urls].include?('/images') }
+    images_route.should_not be_empty    
+    style_route = @static_routes.select { |item| item[:urls].include?('/style') }
+    style_route.should_not be_empty  
+    favicon_route = @static_routes.select { |item| item[:urls].include?('/favicon.ico') }
+    favicon_route.should_not be_empty
+    yui_route = @static_routes.select { |item| item[:urls].include?('/yui') && item[:root].include?('./js') }
+    yui_route.should_not be_empty    
+  end
+ 
+end
+
+describe Trellis::Application, " when requesting the root url with a GET" do
+  before(:each) do
+    application = TestApp::MyApp.new
+    request = Rack::MockRequest.new(application) 
+    @response = request.get("/")
+  end
+  
+  it "should return an OK HTTP status" do
+    @response.status.should be(200)
+  end
+
+  it "should reply with the home page" do
+    @response.body.should == "<html><body><h1>Hello World!</h1></body></html>"
+  end
+end
+
+describe Trellis::Application, " when sending an event to a page" do
+  before(:each) do
+    application = TestApp::MyApp.new
+    @request = Rack::MockRequest.new(application) 
+  end
+  
+  it "if the event handler returns self it should render the receiving page" do
+    response = @request.get("/home.event1")
+    response.body.should == "<html><body><h1>Hello World!</h1></body></html>"
+  end
+  
+  it "should return a response as a string if the event handler returns a String" do
+    response = @request.get("/home.event2")
+    response.body.should == "just some text"
+  end  
+  
+  it "should render the injected page as a response if the event handler returns an injected page " do
+    response = @request.get("/home.event3")
+    response.body.should == "<html><body><p>Goodbye Cruel World </p></body></html>"
+  end
+end
+
+describe Trellis::Page, " when calling inject_dependent_pages on an instance of child class of Page" do
+  it "should contain instances of the injected pages" do
+    homepage = TestApp::Home.new
+    homepage.inject_dependent_pages
+    injected_page = homepage.instance_eval { @other }
+    injected_page.class.should == TestApp::Other
+  end
+end

data/test/component_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Trellis::Component do
+  before(:each) do
+    #@component = Component.new
+  end
+
+  it "should desc" do
+    # TODO
+  end
+end
+
+
+# module TestTrellis
+#   class TestComponent < Test::Unit::TestCase
+#     def test_class_body
+#       raise NotImplementedError, 'Need to write test_class_body'
+#     end
+# 
+#     def test_class_contained_in
+#       raise NotImplementedError, 'Need to write test_class_contained_in'
+#     end
+# 
+#     def test_class_depends_on
+#       raise NotImplementedError, 'Need to write test_class_depends_on'
+#     end
+# 
+#     def test_class_dom_contribution
+#       raise NotImplementedError, 'Need to write test_class_dom_contribution'
+#     end
+# 
+#     def test_class_enhance_page
+#       raise NotImplementedError, 'Need to write test_class_enhance_page'
+#     end
+# 
+#     def test_class_field
+#       raise NotImplementedError, 'Need to write test_class_field'
+#     end
+# 
+#     def test_class_get_component
+#       raise NotImplementedError, 'Need to write test_class_get_component'
+#     end
+# 
+#     def test_class_inherited
+#       raise NotImplementedError, 'Need to write test_class_inherited'
+#     end
+# 
+#     def test_class_is_stateful
+#       raise NotImplementedError, 'Need to write test_class_is_stateful'
+#     end
+# 
+#     def test_class_page_contribution
+#       raise NotImplementedError, 'Need to write test_class_page_contribution'
+#     end
+# 
+#     def test_class_register_with_tag_context
+#       raise NotImplementedError, 'Need to write test_class_register_with_tag_context'
+#     end
+# 
+#     def test_class_tag_name
+#       raise NotImplementedError, 'Need to write test_class_tag_name'
+#     end
+# 
+#     def test_load_component_session_information
+#       raise NotImplementedError, 'Need to write test_load_component_session_information'
+#     end
+# 
+#     def test_logger
+#       raise NotImplementedError, 'Need to write test_logger'
+#     end
+# 
+#     def test_logger_equals
+#       raise NotImplementedError, 'Need to write test_logger_equals'
+#     end
+# 
+#     def test_page
+#       raise NotImplementedError, 'Need to write test_page'
+#     end
+# 
+#     def test_page_equals
+#       raise NotImplementedError, 'Need to write test_page_equals'
+#     end
+# 
+#     def test_save_component_session_information
+#       raise NotImplementedError, 'Need to write test_save_component_session_information'
+#     end
+#   end
+# end

data/test/core_extensions_spec.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# replace_ant_style_property
+describe String, " when calling replace_ant_style_property" do
+  
+  it "should return a string with the property replaced" do
+    source = "Good ${greeting}"
+    result = source.replace_ant_style_property("greeting", "Morning!")
+    result.should eql("Good Morning!")
+  end
+  
+  it "should return an unmodified string when the source doesn't contain the specified ant style property" do
+    source = "Good Morning!"
+    result = source.replace_ant_style_property("chunky", "bacon!")
+    result.should eql("Good Morning!")
+  end
+end
+
+# replace_ant_style_properties
+describe String, " when calling replace_ant_style_properties" do
+  
+  it "should return a string with any given properties replaced" do
+    source = "Good ${greeting}, ${state_of_world} World"
+    result = source.replace_ant_style_properties({"greeting" => "Bye!", "state_of_world" => "Cruel"})
+    result.should eql("Good Bye!, Cruel World")
+  end
+  
+  it "should return an unmodified string when the source doesn't contain any of the specified ant style properties" do
+    source = "Good Morning!"
+    result = source.replace_ant_style_properties({"greeting" => "Bye!", "state_of_world" => "Cruel"})
+    result.should eql("Good Morning!")
+  end
+end
+
+# underscore_class_name
+describe Class, " when calling underscore_class_name" do
+  
+  it "should return a valid underscore ruby identifier string" do
+    class SomeClass; end
+    sym = SomeClass.underscore_class_name
+    sym.should eql("some_class")
+  end
+  
+  it "should return a valid underscore ruby identifier string sans the module" do
+    module Boo
+      class SomeOtherClass; end;
+    end
+    sym = Boo::SomeOtherClass.underscore_class_name
+    sym.should eql("some_other_class")
+  end
+end
+
+# class_to_sym
+describe Class, " when calling class_to_sym" do
+  
+  it "should return a valid underscore ruby identifier as a symbol" do
+    class SomeClass; end
+    sym = SomeClass.class_to_sym
+    sym.should eql(:some_class)
+  end
+  
+  it "should return a valid underscore ruby identifier as a symbol sans the module" do
+    module Boo
+      class SomeOtherClass; end;
+    end
+    sym = Boo::SomeOtherClass.class_to_sym
+    sym.should eql(:some_other_class)
+  end
+end
+
+# attr_array tests
+describe "when calling attr_array", :shared => true do
+  
+  it "should create an empty array" do
+    elements = @target.instance_eval { @elements }
+    elements.should_not be_nil
+    elements.should be_empty
+  end
+end
+
+describe Class, " when calling attr_array with default options" do
+  
+  before(:each) do
+    @target = Class.new
+    @target.attr_array(:elements)
+  end
+
+  it_should_behave_like "when calling attr_array" 
+  
+  it "should create an accessor method for the array" do
+    @target.should respond_to(:elements) 
+  end
+    
+end
+
+describe Class, " when calling attr_array with options {:create_accessor => false}" do
+
+  before(:each) do
+    @target = Class.new
+    @target.attr_array(:elements, :create_accessor => false)    
+  end
+  
+  it_should_behave_like "when calling attr_array"
+  
+  it "should not create an accessor method for the array" do
+    @target.should_not respond_to(:elements)
+  end
+end

data/test/fixtures/application_spec_applications.rb

@@ -0,0 +1,51 @@
+module TestApp
+  class MyApp < Trellis::Application
+    home :home
+    pages :other
+    
+    map_static ['/images', '/style', '/favicon.ico']
+    map_static ['/yui'], "./js" 
+  end
+
+  class Home < Trellis::Page 
+    pages :other
+    
+    template do html { body { h1 "Hello World!" }} end
+      
+    def on_event1 
+      self
+    end
+    
+    def on_event2 
+      "just some text"
+    end
+    
+    def on_event3 
+      @other
+    end
+  end
+  
+  class Other < Trellis::Page    
+    template do html { body { p "Goodbye Cruel World " }} end
+  end
+  
+  class BeforeLoad < Trellis::Page
+    attr_reader :some_value
+    
+    def before_load
+      @some_value = "8675309"
+    end
+    
+    template do html { body { text %[<trellis:value name="some_value"/>] }} end
+  end
+  
+  class AfterLoad < Trellis::Page
+    attr_reader :some_value
+    
+    def after_load
+      @some_value = "chunky bacon!"
+    end
+    
+    template do html { body { text %[<trellis:value name="some_value"/>] }} end
+  end  
+end

data/test/page_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require "rack" 
+require_fixtures 'application_spec_applications'
+
+describe Trellis::Page, " when sending an event to a page" do
+  before(:each) do
+    @application = TestApp::MyApp.new
+    @request = Rack::MockRequest.new(@application) 
+  end
+  
+  it "if the event handler returns self it should render the receiving page" do
+    response = @request.get("/home.event1")
+    response.body.should == "<html><body><h1>Hello World!</h1></body></html>"
+  end
+  
+  it "should return a response as a string if the event handler returns a String" do
+    response = @request.get("/home.event2")
+    response.body.should == "just some text"
+  end  
+  
+  it "should render the injected page as a response if the event handler returns an injected page " do
+    response = @request.get("/home.event3")
+    response.body.should == "<html><body><p>Goodbye Cruel World </p></body></html>"
+  end
+  
+  it "should invoke the before_load method if provided by the page" do
+    response = @request.get("/before_load")
+    response.body.should == "<html><body>8675309</body></html>"
+  end
+  
+  it "should invoke the after_load method if provided by the page" do
+    response = @request.get("/after_load")
+    response.body.should == "<html><body>chunky bacon!</body></html>"    
+  end
+end
+
+describe Trellis::Page, " when calling inject_dependent_pages on an instance of child class of Page" do
+  it "should contain instances of the injected pages" do
+    homepage = TestApp::Home.new
+    homepage.inject_dependent_pages
+    injected_page = homepage.instance_eval { @other }
+    injected_page.should be_an_instance_of(TestApp::Other)
+  end
+end
+

data/test/renderer_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Trellis::Renderer do
+  before(:each) do
+    #@renderer = Renderer.new
+  end
+
+  it "should desc" do
+    # TODO
+  end
+end
+

data/test/router_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Trellis::DefaultRouter, " when processing a request" do
+  before do
+    @regexp = Trellis::DefaultRouter::ROUTE_REGEX
+  end
+  
+  it "should extract the page " do
+    value, source, event, destination = "/some_page".match(@regexp).to_a.reverse
+    value.should be_nil
+    source.should be_nil
+    event.should be_nil
+    destination.should_not be_nil
+    destination.should == "some_page"
+  end
+  
+  it "should extract the page and event " do
+    value, source, event, destination = "/some_page.event".match(@regexp).to_a.reverse
+    value.should be_nil
+    source.should be_nil
+    event.should == "event"
+    destination.should_not be_nil
+    destination.should == "some_page"
+  end  
+  
+  it "should extract the page, event and source " do
+    value, source, event, destination = "/some_page.event_source".match(@regexp).to_a.reverse
+    value.should be_nil
+    source.should == "source"
+    event.should == "event"
+    destination.should_not be_nil
+    destination.should == "some_page"
+  end  
+  
+  it "should extract the page, event and source and value" do
+    value, source, event, destination = "/some_page.event_source/123".match(@regexp).to_a.reverse
+    value.should == "123"
+    source.should == "source"
+    event.should == "event"
+    destination.should_not be_nil
+    destination.should == "some_page"
+  end  
+
+  it "should extract the page, event and value" do
+    value, source, event, destination = "/some_page.event/123".match(@regexp).to_a.reverse
+    value.should == "123"
+    source.should be_nil
+    event.should == "event"
+    destination.should_not be_nil
+    destination.should == "some_page"
+  end   
+end

data/test/spec.opts

@@ -0,0 +1 @@
+--colour

data/test/spec_helper.rb

@@ -0,0 +1,16 @@
+begin
+  require 'rubygems'
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'trellis'
+
+FIXTURES = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures')) unless defined?(FIXTURES)
+def require_fixtures(path)
+  require File.expand_path(File.join(FIXTURES, path))
+end

data/website/index.html

@@ -0,0 +1,124 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Trellis
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Trellis</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/trellis"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/trellis" class="numbers">0.0.1</a>
+    </div>
+    <h2>What</h2>
+<p>Trellis is an object-oriented, event-driven, page and component-based Web <br />
+Application Framework written in Ruby. Its main goal is to bring <br />
+component-driven development to the micro-framework world. <br />
+The framework is a zero configuration framework.</p>
+<p>It draws inspiration from:</p>
+<p>Ruby Web Frameworks<br />
+=======</p>
+<ul>
+	<li>Rails</li>
+	<li>Camping</li>
+	<li>Merb</li>
+	<li>Iowa</li>
+</ul>
+<p>Java Web Frameworks<br />
+=======</p>
+<ul>
+	<li>Tapesty</li>
+	<li>Wicket</li>
+	<li>The good parts of <span class="caps">JSF</span> (components)</li>
+	<li>Seam (session per conversation)</li>
+</ul>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">trellis</span></pre></p>
+<h2>The basics</h2>
+<p>A Trellis application consists of the Application class; a descendant of <br />
+Trellis::Application and one or more pages; descendants of Trellis::Page. The<br />
+Application at a minimum needs to declare the starting or home page:</p>
+<p><pre class='syntax'>
+  <span class="keyword">module </span><span class="module">Hello</span>
+    <span class="keyword">class </span><span class="class">HelloWorld</span> <span class="punct">&lt;</span> <span class="constant">Trellis</span><span class="punct">::</span><span class="constant">Application</span>
+      <span class="ident">home</span> <span class="symbol">:home</span>
+    <span class="keyword">end</span>
+
+    <span class="keyword">class </span><span class="class">Home</span> <span class="punct">&lt;</span> <span class="constant">Trellis</span><span class="punct">::</span><span class="constant">Page</span> 
+      <span class="ident">template_as_markaby</span> <span class="keyword">do</span> <span class="ident">html</span> <span class="punct">{</span> <span class="ident">body</span> <span class="punct">{</span> <span class="ident">h1</span> <span class="punct">&quot;</span><span class="string">Hello World!</span><span class="punct">&quot;</span> <span class="punct">}}</span> <span class="keyword">end</span>
+    <span class="keyword">end</span>
+  <span class="keyword">end</span>
+</pre></p>
+<h2>Demonstration of usage</h2>
+<p>To run the above application simply add the line:</p>
+<pre class='syntax'><span class="constant">Hello</span><span class="punct">::</span><span class="constant">HelloWorld</span><span class="punct">.</span><span class="ident">new</span><span class="punct">.</span><span class="ident">start</span></pre>
+<p>That will start the application on Mongrel running on port 3000 by default. To <br />
+run on any other port pass the port number to the start method like:</p>
+<pre class='syntax'><span class="constant">Hello</span><span class="punct">::</span><span class="constant">HelloWorld</span><span class="punct">.</span><span class="ident">new</span><span class="punct">.</span><span class="ident">start</span> <span class="number">8282</span></pre>
+<h2>Forum</h2>
+<p><a href="http://groups.google.com/group/trellis">http://groups.google.com/group/trellis</a></p>
+<h2>How to submit patches</h2>
+<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+<p>The trunk repository is <code>svn://rubyforge.org/var/svn/trellis/trunk</code> for anonymous access.</p>
+<p><span class="caps">OOOORRRR</span></p>
+<p>You can fetch the source from either:</p>
+<ul>
+	<li>rubyforge: <span class="caps">MISSING</span> IN <span class="caps">ACTION</span></li>
+</ul>
+<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code><br />
+yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
+<p>When you do this, this message will magically disappear!</p>
+<p>Or you can hack website/index.txt and make it all go away!!</p>
+<ul>
+	<li>github: <a href="http://github.com/GITHUB_USERNAME/trellis/tree/master">http://github.com/GITHUB_USERNAME/trellis/tree/master</a></li>
+</ul>
+<pre>git clone git://github.com/GITHUB_USERNAME/trellis.git</pre>
+<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+<ul>
+	<li>gitorious: <a href="git://gitorious.org/trellis/mainline.git">git://gitorious.org/trellis/mainline.git</a></li>
+</ul>
+<pre>git clone git://gitorious.org/trellis/mainline.git</pre>
+<h3>Build and test instructions</h3>
+<pre>cd trellis
+rake spec
+rake install_gem</pre>
+<h2>License</h2>
+<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+<h2>Contact</h2>
+<p>Comments are welcome. Send an email to <a href="mailto:bsbodden@integrallis.com">Brian Sam-Bodden</a> email via the <a href="http://groups.google.com/group/trellis">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 25th August 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>