ramaze 2011.07.25 → 2011.10.23

data/lib/ramaze/controller.rb

@@ -7,8 +7,7 @@ module Ramaze
   # applications in Ramaze. It acts as a nice wrapper around Innate::Node and
   # allows for a more traditional MVC approach.
   #
-  # == Example
-  #
+  # @example An example controller
   #  class Posts < Ramaze::Controller
   #    map '/posts'
   #

data/lib/ramaze/dependencies.rb

@@ -1,4 +1,15 @@
 module Ramaze
+  # Array containing gems that aren't supported for certain reasons. The gems
+  # that are in this array by default will be removed if the current setup
+  # *does* support them.
+  UNSUPPORTED_GEMS = [
+    'lokar',
+    'localmemcache',
+    'ruby-growl',
+    'nagoro',
+    'syslog'
+  ]
+
   # Array containing the names and versions of all the gems required by Ramaze
   # along with the name of how the gem should be required.
   DEPENDENCIES = [
@@ -17,10 +28,8 @@ module Ramaze
     {:name => 'hpricot'     , :version => ['>= 0.8.4']},
     {:name => 'liquid'      , :version => ['>= 2.2.2']},
     {:name => 'locale'      , :version => ['>= 2.0.5']},
-    {:name => 'lokar'       , :version => ['>= 0.2.1']},
     {:name => 'maruku'      , :version => ['>= 0.6.0']},
     {:name => 'mustache'    , :version => ['>= 0.99.4']},
-    {:name => 'nagoro'      , :version => ['>= 2009.05']},
     {:name => 'rack-contrib', :version => ['>= 1.1.0'], :lib => 'rack/contrib'},
     {:name => 'rack-test'   , :version => ['>= 0.6.0'], :lib => 'rack/test'},
     {:name => 'Remarkably'  , :version => ['>= 0.6.1'], :lib => 'remarkably'},
@@ -30,17 +39,45 @@ module Ramaze
     {:name => 'tagz'        , :version => ['>= 9.0.0']},
     {:name => 'tenjin'      , :version => ['>= 0.6.1']},
     {:name => 'yard'        , :version => ['>= 0.7.2']},
+    {:name => 'redis'       , :version => ['>= 2.2.2']},
+    {:name => 'rdiscount'   , :version => ['>= 1.6.8']}
   ]
 
-  if !RUBY_PLATFORM.include?('darwin')
+  # Lokar requires Ruby >= 1.9
+  if RUBY_VERSION.to_f >= 1.9
+    DEVELOPMENT_DEPENDENCIES.push({:name => 'lokar', :version => ['>= 0.2.1']})
+    UNSUPPORTED_GEMS.delete('lokar')
+  end
+
+  # LocalMemcache doesn't work on Mac OS X or jruby.
+  if !RUBY_DESCRIPTION.include?('jruby') and !RUBY_PLATFORM.include?('darwin')
     DEVELOPMENT_DEPENDENCIES.push(
       {:name => 'localmemcache', :version => ['>= 0.4.4']}
     )
+
+    UNSUPPORTED_GEMS.delete('localmemcache')
   end
 
+  # Ruby-growl, requiring Growl, only works on Mac OS X.
   if RUBY_PLATFORM.include?('darwin')
     DEVELOPMENT_DEPENDENCIES.push(
       {:name => 'ruby-growl', :version => ['>= 3.0']}
     )
+
+    UNSUPPORTED_GEMS.delete('ruby-growl')
+  end
+
+  # Nagoro doesn't seem to work on Rbx
+  if !RUBY_DESCRIPTION.include?('rubinius')
+    DEVELOPMENT_DEPENDENCIES.push(
+      {:name => 'nagoro', :version => ['>= 2009.05']}
+    )
+
+    UNSUPPORTED_GEMS.delete('nagoro')
+  end
+
+  # Syslog uses forking which apparently isn't available on jruby.
+  if !RUBY_DESCRIPTION.include?('jruby')
+    UNSUPPORTED_GEMS.delete('syslog')
   end
 end # Ramaze

data/lib/ramaze/helper/bench.rb

@@ -2,10 +2,14 @@ require 'benchmark'
 
 module Ramaze
   module Helper
-
-    # Little helper to give you a hand when benching parts of actions
+    ##
+    # The Benchmark helper is a simple helper that can be used to benchmark
+    # certain blocks of code by wrapping them in a block. This can be useful if
+    # you want to see how long a certain query takes or how long it takes to
+    # create a new user.
+    #
     module Bench
-
+      ##
       # Will first run an empty loop to determine the overhead it imposes, then
       # goes on to yield your block +iterations+ times.
       #
@@ -15,27 +19,33 @@ module Ramaze
       #
       # Example:
       #
-      #   class MainController < Ramaze::Controller
-      #     def index
-      #       @users = bench{ User.all }
-      #       @tags = bench{ Article.tags }
+      #     class MainController < Ramaze::Controller
+      #       def index
+      #         @users = bench{ User.all }
+      #         @tags = bench{ Article.tags }
+      #       end
       #     end
-      #   end
       #
       # This will show something like following in your log:
-      # [..] INFO   Bench ./start.rb:3:in `index': 0.121163845062256
-      # [..] INFO   Bench ./start.rb:4:in `index': 2.234987235098341
+      #
+      #     [..] INFO   Bench ./start.rb:3:in `index': 0.121163845062256
+      #     [..] INFO   Bench ./start.rb:4:in `index': 2.234987235098341
       #
       # So now we know that the Article.tags call takes the most time and
       # should be improved.
+      #
+      # @param  [Fixnum] iterations The amount of iterations to run.
+      # @return [Mixed]
+      #
       def bench(iterations = 1)
         result = nil
-        from = caller[0]
-        delta = Benchmark.realtime{ iterations.times{ nil }}
-        taken = Benchmark.realtime{ iterations.times{ result = yield }}
+        from   = caller[0]
+        delta  = Benchmark.realtime{ iterations.times{ nil }}
+        taken  = Benchmark.realtime{ iterations.times{ result = yield }}
+
         Log.info "Bench #{from}: #{taken - delta}"
         return result
       end
-    end
-  end
-end
+    end # Bench
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/blue_form.rb

@@ -4,34 +4,13 @@ require 'ramaze/gestalt'
 module Ramaze
   module Helper
     ##
-    # == Introduction
-    #
     # The BlueForm helper tries to be an even better way to build forms
-    # programmatically.  By using a simple block you can quickly create all the
+    # programmatically. By using a simple block you can quickly create all the
     # required elements for your form.
     #
-    # Since November 2010 the BlueForm helper works different. You can now
-    # specify an object as the first parameter of the form_for() method. This
-    # object will be used to retrieve the values of each field. This means that
-    # you can directly pass a database result object to the form and no longer
-    # have to manually specify values. However, you can still specify your own
-    # values if you want.
-    #
-    # Old behaviour:
-    #
-    #  form_for(:method => :post) do |f|
-    #    f.input_text 'Username', :username, 'Chuck Norris'
-    #  end
-    #
-    # New behaviour:
+    # See {Ramaze::Helper::BlueForm::Form} for all the available methods.
     #
-    #  # @data is an object that contains an instance variable named "username".
-    #  # This variable contains the value "Chuck Norris".
-    #  form_for(@data, :method => :post) do |f|
-    #    f.input_text 'Username', :username
-    #  end
-    #
-    # == Form Data
+    # ## Form Data
     #
     # As stated earlier it's possible to pass an object to the form_for()
     # method. What kind of object this is, a database result object or an
@@ -40,16 +19,16 @@ module Ramaze
     # extremely easy to directly pass a result object from your favourite ORM.
     # Example:
     #
-    #  @data = User[1]
+    #     @data = User[1]
     #
-    #  form_for(@data, :method => :post) do |f|
-    #    f.input_text 'Username', :username
-    #  end
+    #     form_for(@data, :method => :post) do |f|
+    #       f.input_text 'Username', :username
+    #     end
     #
     # If you don't want to use an object you can simply set the first parameter
     # to nil.
     #
-    # == HTML Output
+    # ## HTML Output
     #
     # The form helper uses Gestalt, Ramaze's custom HTML builder that works
     # somewhat like Erector. The output is very minimalistic, elements such as
@@ -61,14 +40,11 @@ module Ramaze
     # directly. When using Etanni this would result in something like the
     # following:
     #
-    #  #{
-    #    form_for(@result, :method => :post) do |f| do
-    #      f.input_text 'Text label', :textname, 'Chunky bacon!'
-    #    end
-    #  }
-    #
-    # @example
+    #     #{form_for(@result, :method => :post) do |f| do
+    #       f.input_text 'Text label', :textname, 'Chunky bacon!'
+    #     end}
     #
+    # @example Creating a basic form
     #  form_for(@data, :method => :post) do |f|
     #    f.input_text 'Username', :username
     #  end
@@ -197,7 +173,6 @@ module Ramaze
         #
         # @param [String] text The text to display inside the legend tag.
         # @example
-        #
         #   form_for(@data, :method => :post) do |f|
         #     f.legend 'Ramaze rocks!'
         #   end
@@ -211,7 +186,6 @@ module Ramaze
         #
         # @param [Block] &block The form elements to display inside the fieldset.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.fieldset do
         #      f.legend 'Hello, world!'
@@ -232,7 +206,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #   form_for(@data, :method => :post) do |f|
         #     f.input_text 'Username', :username
         #   end
@@ -264,7 +237,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.input_password 'My password', :password
         #  end
@@ -293,7 +265,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.input_submit 'Save'
         #  end
@@ -316,20 +287,20 @@ module Ramaze
         # for each checkbox.  When using a hash the key will be displayed and
         # the value will be the value of the checkbox. Example:
         #
-        #  @data = Class.new
-        #    attr_reader :gender_arr
-        #    attr_reader :gender_hash
+        #     @data = Class.new
+        #       attr_reader :gender_arr
+        #       attr_reader :gender_hash
         #
-        #    def initialize
-        #      @gender_arr  = ['male', 'female']
-        #      @gender_hash = {"Male" => "male", "Female" => "female"}
-        #    end
-        #  end.new
+        #       def initialize
+        #         @gender_arr  = ['male', 'female']
+        #         @gender_hash = {"Male" => "male", "Female" => "female"}
+        #       end
+        #     end.new
         #
-        #  form_for(@data, :method => :post) do |f|
-        #    f.input_checkbox "Gender", :gender_arr
-        #    f.input_checkbox "Gender", :gender_hash
-        #  end
+        #     form_for(@data, :method => :post) do |f|
+        #       f.input_checkbox "Gender", :gender_arr
+        #       f.input_checkbox "Gender", :gender_hash
+        #     end
         #
         # @example
         #  form_for(@data, :method => :post) do |f|
@@ -338,8 +309,8 @@ module Ramaze
         #
         # @param [String] label The text to display inside the label tag.
         # @param [String Symbol] name The name of the checkbox.
-        # @param [String] checked String that indicates if (and which) checkbox
-        #  should be checked.
+        # @param [String/Array] checked String or array that indicates which
+        #  value(s) should be checked.
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @option args [String/Symbol] :id The value to use for the ID attribute.
@@ -430,8 +401,14 @@ module Ramaze
                 end
 
                 # Let's see if the current item is checked
-                if checkbox_value == checked
-                  opts[:checked] = 'checked'
+                if checked.class == Array
+                  if checked.include?(checkbox_value)
+                    opts[:checked] = 'checked'
+                  end
+                else
+                  if checkbox_value == checked
+                    opts[:checked] = 'checked'
+                  end
                 end
 
                 # And we're done, easy wasn't it?
@@ -462,20 +439,20 @@ module Ramaze
         # If you want to generate multiple radio buttons you can use an array
         # just like you can with checkboxes. Example:
         #
-        #  @data = Class.new
-        #    attr_reader :gender_arr
-        #    attr_reader :gender_hash
+        #     @data = Class.new
+        #       attr_reader :gender_arr
+        #       attr_reader :gender_hash
         #
-        #    def initialize
-        #      @gender_arr  = ['male', 'female']
-        #      @gender_hash = {"Male" => "male", "Female" => "female"}
-        #    end
-        #  end.new
+        #       def initialize
+        #         @gender_arr  = ['male', 'female']
+        #         @gender_hash = {"Male" => "male", "Female" => "female"}
+        #       end
+        #     end.new
         #
-        #  form_for(@data, :method => :post) do |f|
-        #    f.input_radio "Gender", :gender_arr
-        #    f.input_radio "Gender", :gender_hash
-        #  end
+        #     form_for(@data, :method => :post) do |f|
+        #       f.input_radio "Gender", :gender_arr
+        #       f.input_radio "Gender", :gender_hash
+        #     end
         #
         # For more information see the input_checkbox() method.
         #
@@ -511,7 +488,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.input_file 'Image', :image
         #  end
@@ -536,7 +512,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.input_hidden :user_id
         #  end
@@ -562,7 +537,6 @@ module Ramaze
         # @param [Hash] args Any additional HTML attributes along with their
         #  values.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.textarea 'Description', :description
         #  end
@@ -593,7 +567,6 @@ module Ramaze
         # @param [String Symbol] name The name of the select tag.
         # @param [Hash] args Hash containing additional HTML attributes.
         # @example
-        #
         #  form_for(@data, :method => :post) do |f|
         #    f.select 'Country', :country_list
         #  end

data/lib/ramaze/helper/cache.rb

@@ -3,15 +3,16 @@
 
 module Ramaze
   module Helper
-
+    ##
     # Caching of simple objects and whole action responses.
+    #
     module Cache
-
       # Setup needed traits, add the singleton methods and add the caches used
       # by this helper.
       #
       # @param [Class] into Class that this Module is included into
       # @author manveru
+      #
       def self.included(into)
         into.extend(SingletonMethods)
         into.add_action_wrapper(6.0, :cache_wrap)
@@ -19,11 +20,13 @@ module Ramaze
         Ramaze::Cache.add(:action, :cache_helper_value)
       end
 
+      ##
       # @param [Action] action The currently wrapped action
       # @yield The next block in wrap_action_call
       # @return [String] the response body
       # @see Innate::Node#wrap_action_call
       # @author manveru
+      #
       def cache_wrap(action)
         cache = Innate::Cache.action
 
@@ -58,6 +61,7 @@ module Ramaze
         yield
       end
 
+      ##
       # This method is used to access Ramaze::Cache.cache_helper_value.
       # It provides an easy way to cache long-running computations, gathering
       # external resources like RSS feeds or DB queries that are the same for
@@ -78,6 +82,7 @@ module Ramaze
       # @return [Object] The cache wrapper assigned for :cache_helper_value
       # @see Innate::Cache
       # @author manveru
+      #
       def cache_value(key = nil, options = {})
         cache = Ramaze::Cache.cache_helper_value
 
@@ -96,7 +101,6 @@ module Ramaze
         # This method allows you to cache whole actions.
         #
         # @example Basic usage
-        #
         #   class Foo < Ramaze::Controller
         #     helper :cache
         #     cache_action :method => :bar
@@ -112,6 +116,6 @@ module Ramaze
           trait[:cache_action] << hash
         end
       end
-    end
-  end
-end
+    end # Cache
+  end # Helper
+end # Ramaze