ramaze 2011.01.30 → 2011.07.25

data/lib/proto/public/css/text.css

@@ -0,0 +1,109 @@
+/**
+ * Stylesheet used for styling headings, links, etc.
+ *
+ * @author Yorick Peterse
+ * @link   http://yorickpeterse.com/ 
+ */
+body
+{
+    background:  url('../images/bg.png') repeat top left;
+    border-top:  5px solid #444;
+    color:       #444;
+    font-family: 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Arial, sans-serif;
+    font-size:   14px;
+}
+
+p
+{
+    font-size:     14px;
+    line-height:   22px;
+    margin-bottom: 20px;
+}
+
+a
+{
+    color: #444;
+}
+
+ol
+{
+    margin-left: 20px;
+}
+
+    ol li
+    {
+        list-style-type: decimal;
+    }
+
+ul
+{
+    margin-left: 18px;
+}
+
+    ul li
+    {
+        list-style-type: disc;
+    }
+
+ul, ol
+{
+    line-height:   22px;
+    margin-bottom: 20px;
+}
+
+a:hover, h1 a:hover
+{
+    color: #E33F1E;
+}
+
+h1, h2, h3, h4, h5, h6
+{
+    font-weight:   bold;
+    margin-bottom: 5px;
+}
+
+h1
+{
+    font-size: 28px;
+}
+
+h2
+{ 
+    font-size: 24px;
+}
+
+h3
+{
+    font-size: 22px;
+}
+
+h4
+{
+    font-size: 20px;
+}
+
+h5
+{
+    font-size: 18px;
+}
+
+h6
+{
+    font-size: 16px;
+}
+
+h1 a
+{
+    color:           #444;
+    text-decoration: none;
+}
+
+pre
+{
+    margin: 20px 0px;
+}
+
+code
+{
+    background: #eee;
+}

data/lib/proto/spec/main.rb

@@ -9,12 +9,12 @@ describe MainController do
   should 'show start page' do
     get('/').status.should == 200
     last_response['Content-Type'].should == 'text/html'
-    last_response.should =~ /<h1>Welcome to Ramaze!<\/h1>/
+    last_response.should =~ /Congratulations, Ramaze is running fine/
   end
 
   should 'show /notemplate' do
     get('/notemplate').status.should == 200
     last_response['Content-Type'].should == 'text/html'
-    last_response.should =~ /there is no 'notemplate\.xhtml' associated with this action/
+    last_response.should =~ /There is no 'notemplate\.xhtml' associated with this action\./
   end
 end

data/lib/proto/start.rb

@@ -2,9 +2,19 @@
 
 # Use this file directly like `ruby start.rb` if you don't want to use the
 # `ramaze start` command.
+#
 # All application related things should go into `app.rb`, this file is simply
 # for options related to running the application locally.
-
+#
+# You can run this file as following:
+#
+#  $ ruby start.rb
+#  $ ./start.rb
+#
+# If you want to be able to do the latter you'll have to make sure the file can be
+# executed:
+#
+#  $ chmod +x ./start.rb
 require File.expand_path('../app', __FILE__)
 
 Ramaze.start(:adapter => :webrick, :port => 7000, :file => __FILE__)

data/lib/proto/view/index.xhtml

@@ -1,41 +1,45 @@
 <p>
-  Ramaze is working correctly with this application, now you can start working.
+    Congratulations, Ramaze is running fine and you can start working on your application.
 </p>
 
 <p>
-  To start you can modify:
-  <ol>
+    You can play around with this prototype by changing the following:
+</p>
+
+<ul>
     <li>
-      <code>view/index.xhtml</code>, this page.
+        <code>view/index.xhtml</code>: the content of this page.
     </li>
     <li>
-      <code>layout/default.xhtml</code>, the layout for this page.
+        <code>layout/default.xhtml</code>: the layout for this page.
     </li>
     <li>
-      <code>controller/main.rb</code>, where you can change the header of this
-      page and the <a href="/notemplate">notemplate</a> action
+        <code>controller/main.rb</code>: the controller responsible for server this page.
     </li>
-  </ol>
-</p>
+</ul>
 
-<p>For more documentation, check out <a href="http://ramaze.net">ramaze.net</a> and <a href="http://wiki.ramaze.net">wiki.ramaze.net</a>, which includes:
-  <ul>
-    <li>a <a href="http://wiki.ramaze.net/Walkthrough">getting started</a> guide</li>
-    <li>some <a href="http://wiki.ramaze.net/Screencasts">screencasts</a></li>
-    <li>and an <a href="http://wiki.ramaze.net/Tutorials/Todolist">introductory tutorial</a></li>
-  </ul>
+<p>
+    For more information, check out <a href="http://ramaze.net">ramaze.net</a> and 
+    <a href="http://ramaze.net/documentation/index.html">the documentation</a>.
+    <br />
+    You can also read the 
+    <a href="http://doc.rubyists.com/ramaze%2binnate/">YARD documentation</a>
+    or browse around the <a href="https://github.com/ramaze/ramaze">Ramaze source code</a>.
 </p>
 
 <p>
-You can also read the 
-<a href="http://doc.rubyists.com/ramaze%2binnate/">rdocs</a>
-or browse around the
-<a href="http://source.ramaze.net">Ramaze source code</a>.
+    For help with Ramaze, visit 
+    <a href="irc://chat.freenode.net/ramaze">#ramaze on irc.freenode.net</a>.
+    <br />
+    You can use <a href="http://embed.mibbit.com/?server=irc.freenode.net&channel=#ramaze,#ruby-lang&forcePrompt=true">Mibbit</a>, 
+    an AJAX based IRC client or 
+    <a href="http://java.freenode.net/?channel=ramaze">
+        the official freenode irc java applet
+    </a>.
 </p>
 
 <p>
-For help with Ramaze, visit <a href="irc://chat.freenode.net/ramaze">#ramaze on irc.freenode.net</a>.<br />
-You can use <a href="http://embed.mibbit.com/?server=irc.freenode.net&channel=#ramaze,#ruby-lang&forcePrompt=true">Mibbit</a>, an AJAX based IRC client or <a href="http://java.freenode.net/?channel=ramaze">the official freenode irc java applet</a>.
-<br />
-Feel free to post to the <a href="http://groups.google.com/group/ramaze">Ramaze Google Group</a>, your first mail has to go through moderation, so please be patient.
+    Feel free to post to the 
+    <a href="https://groups.google.com/forum/#!forum/ramaze">Ramaze Google Group</a>, your 
+    first mail has to go through moderation, so please be patient.
 </p>

data/lib/ramaze.rb

@@ -92,7 +92,6 @@ module Ramaze
       m.use Rack::ETag, 'public'
     end
 
-    m.use Rack::ETag
     m.use Rack::Head
     m.run Ramaze::AppMap
   end

data/lib/ramaze/app.rb

@@ -3,9 +3,9 @@ module Ramaze
   # common name.
   # Every application has a location it dispatches from, this behaves similar
   # to Rack::URLMap.
-
   AppMap = Innate::URLMap.new
 
+  #:nodoc:
   def self.to(object)
     app_name = object.ancestral_trait[:app]
     App[app_name].to(object)
@@ -70,6 +70,38 @@ module Ramaze
 
     attr_reader :name, :location, :url_map, :options
 
+    ##
+    # Finds or creates an application for the given name and URI.
+    #
+    # @author Michael Fellinger
+    # @param  [String] name The name of the application.
+    # @param  [String] location The URI to which the app is mapped.
+    # @return [Ramaze::App]
+    #
+    def self.find_or_create(name, location = nil)
+      location = '/' if location.nil? && name == :pristine
+      self[name] || new(name, location)
+    end
+
+    ##
+    # Returns the application for the given name.
+    #
+    # @author Michael Fellinger
+    # @param  [String] name The name of the application.
+    # @return [Ramaze::App]
+    #
+    def self.[](name)
+      APP_LIST[name.to_sym]
+    end
+
+    ##
+    # Creates a new instance of the application and sets the name and location.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @param  [String] name The name of the application.
+    # @param  [String] location The location to which the application is mapped.
+    #
     def initialize(name, location = nil)
       @name = name.to_sym
       @url_map = Innate::URLMap.new
@@ -80,46 +112,87 @@ module Ramaze
       @options = self.class.options.sub(@name)
     end
 
+    ##
+    # Syncs the instance of the current application with Ramaze::AppMap.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    #
     def sync
       AppMap.map(location, self)
     end
 
+    ##
+    # Sets the location and syncs the application.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    #
     def location=(location)
       @location = location.to_str.freeze
       sync
     end
 
+    ##
+    # Allows the application to be called as a Rack middleware.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @param  [Hash] env The environment hash.
+    #
     def call(env)
       to_app.call(env)
     end
 
+    ##
+    # Converts the application to a Rack compatible class.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @return [Rack::Cascade]
+    #
     def to_app
       files = Ramaze::Files.new(*public_roots)
       app = Current.new(Route.new(url_map), Rewrite.new(url_map))
       Rack::Cascade.new([files, app])
     end
 
+    ##
+    # Maps an object to the given URI.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @param  [String] location The URI to map the object to.
+    # @param  [Object] object The object (usually a controller) to map to the
+    #  URI.
+    #
     def map(location, object)
       url_map.map(location, object)
     end
 
+    ##
+    # Returns a URI to the given object.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @param  [Object] object An object for which to generate the URI.
+    #
     def to(object)
       return unless mapped = url_map.to(object)
       [location, mapped].join('/').squeeze('/')
     end
 
+    ##
+    # Returns an array containing all the public directories for each root
+    # directory.
+    #
+    # @author Michael Fellinger
+    # @since  30-06-2009
+    # @return [Array]
+    #
     def public_roots
       roots, publics = [*options.roots], [*options.publics]
       roots.map{|root| publics.map{|public| ::File.join(root, public) }}.flatten
     end
-
-    def self.find_or_create(name, location = nil)
-      location = '/' if location.nil? && name == :pristine
-      self[name] || new(name, location)
-    end
-
-    def self.[](name)
-      APP_LIST[name.to_sym]
-    end
-  end
-end
+  end # App
+end # Ramaze

data/lib/ramaze/app_graph.rb

@@ -0,0 +1,107 @@
+require 'set'
+
+module Ramaze
+  ##
+  # The AppGraph class can be used to generate a graph of all the URLs mapped in
+  # a Ramaze application and saves this graph as an image.
+  #
+  # == Usage
+  #
+  # In order to generate a graph of your application all you need to do is the
+  # following:
+  #
+  #  require 'ramaze/app_graph'
+  #
+  #  graph = Ramaze::AppGraph.new graph.generate graph.show
+  #
+  # Once this code is executed you can find the .dot and PNG files in the root
+  # directory of your application.
+  #
+  # @author Michael Fellinger
+  #
+  class AppGraph
+    ##
+    # Creates a new instance of the class.
+    #
+    # @author Michael Fellinger
+    #
+    def initialize
+      @out = Set.new
+    end
+
+    ##
+    # Generates the graph based on all the current routes. The graph is saved in
+    # the application directory.
+    #
+    # @author Michael Fellinger
+    #
+    def generate
+      Ramaze::AppMap.to_hash.each do |location, app|
+        connect(location => app.name)
+
+        app.url_map.to_hash.each do |c_location, c_node|
+          connect(app.name => c_node)
+          connect(c_node.mapping => c_node)
+
+          c_node.update_template_mappings
+          c_node.view_templates.each do |wish, mapping|
+            mapping.each do |action_name, template|
+              action_path = File.join(c_node.mapping, action_name)
+              connect(c_node => action_path, action_path => template)
+            end
+          end
+
+          c_node.update_method_arities
+          c_node.method_arities.each do |method, arity|
+            action_path = File.join(c_node.mapping, method.to_s)
+            connect(
+              action_path => "#{c_node}##{method}[#{arity}]",
+              c_node      => action_path
+            )
+          end
+        end
+      end
+    end
+
+    ##
+    # Connects various elements in the graph to each other.
+    #
+    # @author Michael Fellinger
+    #
+    def connect(hash)
+      hash.each do |from, to|
+        @out << ("  %p -> %p;" % [from.to_s, to.to_s])
+      end
+    end
+
+    ##
+    # Writes the dot file containing the graph data.
+    #
+    # @author Michael Fellinger
+    #
+    def write_dot
+      File.open('graph.dot', 'w+') do |dot|
+        dot.puts 'digraph appmap {'
+        dot.puts(*@out)
+        dot.puts '}'
+      end
+    end
+
+    ##
+    # Generates a PNG file based on the .dot file.
+    #
+    # @author Michael Fellinger
+    #
+    def show
+      write_dot
+      options = {
+        'rankdir' => 'LR',
+        'splines' => 'true',
+        'overlap' => 'false',
+      }
+      args = options.map{|k,v| "-G#{k}=#{v}" }
+      system("dot -O -Tpng #{args.join(' ')} graph.dot")
+      system('feh graph.dot.png')
+    end
+  end # AppGraph
+end # Ramaze