ramaze 0.1.3 → 0.1.4

data/lib/ramaze/store/default.rb

@@ -4,6 +4,9 @@
 require 'yaml/store'
 
 module Ramaze
+
+  # Namespace for Stores in Ramaze
+
   module Store
 
     # A simple wrapper around YAML::Store

data/lib/ramaze/template/ezamar/render_partial.rb

@@ -5,6 +5,9 @@ require 'ramaze/template/ezamar/engine'
 require 'ramaze/helper/partial'
 
 module Ezamar
+
+  # A transformer for <render /> tags.
+
   class RenderPartial
     extend Ramaze::PartialHelper
 

data/lib/ramaze/template/sass.rb

@@ -0,0 +1,45 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+
+require 'sass/engine'
+
+module Ramaze
+  module Template
+
+    # Is responsible for compiling a template using the Sass CSS templating engine.
+    # Can be found at: http://haml.hamptoncatlin.com/
+
+    class Sass < Template
+
+      # Custom SASS-options for your controller to be merged.
+
+      trait :sass_options => {
+        :locals => {}
+      }
+
+      ENGINES[self] = %w[ sass ]
+
+      class << self
+
+        # Transform any String via Sass, takes optionally an hash with the
+        # sass_options that you can set also by
+        #   trait :sass_options => {}
+        # if you pass the options it will merge the trait with them. (your
+        # options override the defaults from trait[:sass_options]
+
+        def transform action
+          Response.current['Content-Type'] = "text/css"
+          sass = wrap_compile(action)
+          sass.to_css()
+        end
+
+        # Instantiates Sass::Engine with the template and sass_options from
+        # the trait.
+
+        def compile(action, template)
+          ::Sass::Engine.new(template, ancestral_trait[:sass_options])
+        end
+      end
+    end
+  end
+end

data/lib/ramaze/template.rb

@@ -16,7 +16,7 @@ module Ramaze
 
     ENGINES = {} unless defined?(ENGINES)
 
-    %w[ Amrita2 Erubis Haml Liquid Markaby Remarkably ].each do |const|
+    %w[ Amrita2 Erubis Haml Liquid Markaby Remarkably Sass ].each do |const|
       autoload(const, "ramaze/template/#{const.downcase}")
     end
 

data/lib/ramaze/tool/create.rb

@@ -29,14 +29,14 @@ module Ramaze
           @basedir = ::Ramaze::BASEDIR / 'proto'
           @destdir = Dir.pwd / project
 
-          puts "creating project: #{project}"
+          puts "Creating project #{project}"
 
           FileUtils.mkdir_p(project)
 
-          puts "copy proto to new project (#@destdir)..."
+          puts "Copying skeleton project to new project (#@destdir)..."
 
           directories, files =
-            Dir[@basedir / '**' / '*'].partition{|f| File.directory?(f) }
+            Dir[@basedir / '**' / '*'].partition{ |f| File.directory?(f) }
 
           create_dirs(*directories)
           copy_files(*files)
@@ -49,7 +49,7 @@ module Ramaze
           dirs.each do |dir|
             dest = dir.gsub(@basedir, @destdir)
 
-            puts "create directory: '#{dest}'"
+            puts "Create directory: '#{dest}'"
             FileUtils.mkdir_p(dest)
           end
         end
@@ -60,7 +60,7 @@ module Ramaze
           files.each do |file|
             dest = file.gsub(@basedir, @destdir)
 
-            puts "copy file: '#{dest}'"
+            puts "Copy file: '#{dest}'"
             FileUtils.cp(file, dest)
           end
         end

data/lib/ramaze/tool/localize.rb

@@ -4,6 +4,10 @@
 $KCODE = 'UTF-8'
 require 'ya2yaml'
 
+# Localize helps transforming arbitrary text into localized forms using
+# a simple regular expression and substituting occurences with predefined
+# snippets stored in YAML files.
+
 class Ramaze::Tool::Localize
 
   # Enable Localization
@@ -16,8 +20,8 @@ class Ramaze::Tool::Localize
   # languages supported
   trait :languages => %w[ en ]
 
-  # YAML files the localizations are saved to and loaded from, %s is substituded
-  # by the values from trait[:languages]
+  # YAML files the localizations are saved to and loaded from, %s is
+  # substituted by the values from trait[:languages]
   trait :file => 'conf/locale_%s.yaml'.freeze
 
   # The pattern that is substituted with the translation of the current locale.
@@ -36,6 +40,8 @@ class Ramaze::Tool::Localize
 
     include Ramaze::Trinity
 
+    # Enables being plugged into Dispatcher::Action::FILTER
+
     def call(response, options = {})
       return response unless trait[:enable]
       return response if response.body.nil?
@@ -44,6 +50,10 @@ class Ramaze::Tool::Localize
       response
     end
 
+    # Localizes a response body.  It reacts to a regular expression as given
+    # in trait[:regex].  Every 'entity' in it will be translated, see
+    # `localize` for more information.
+
     def localize_body(body, options)
       locale = session[:LOCALE] || set_session_locale
 
@@ -56,9 +66,10 @@ class Ramaze::Tool::Localize
       body
     end
 
-    def localize(str, locale)
-      Ramaze::Inform.debug "localizing: #{locale} => '#{str}'"
+    # Localizes a single 'entity'.  If a translation in the chosen language is
+    # not available, it falls back to the default language.
 
+    def localize(str, locale)
       trans = nil
       default_language = trait[:default_language]
       dict = dictionary
@@ -81,6 +92,10 @@ class Ramaze::Tool::Localize
       str
     end
 
+    # Sets session[:LOCALE] to one of the languages defined in the dictionary.
+    # It first tries to honor the browsers accepted languages and then falls
+    # back to the default language.
+
     def set_session_locale
       session[:LOCALE] = trait[:default_language]
       accepted_langs = request.http_accept_language rescue 'en'
@@ -98,12 +113,16 @@ class Ramaze::Tool::Localize
       end
 
       session[:LOCALE]
-    end # end set_session_locale
+    end
+
+    # Returns the dictionary used for translation.
 
     def dictionary
       trait[:dictionary] || load(*trait[:languages])
     end
 
+    # Load given locales from disk and save it into the dictionary.
+
     def load(*locales)
       Ramaze::Inform.debug "loading locales: #{locales.inspect}"
 
@@ -120,6 +139,8 @@ class Ramaze::Tool::Localize
       trait[:dictionary] = dict
     end
 
+    # Stores given locales from the dictionary to disk.
+
     def store(*locales)
       locales.uniq.compact.each do |locale|
         Ramaze::Inform.debug "saving localized to: #{trait[:file] % locale}"

data/lib/ramaze/tool/mime.rb

@@ -5,11 +5,18 @@ require 'yaml'
 
 module Ramaze
   module Tool
+
+    # Responsible for lookup of MIME info for filetypes based on extension.
+
     module MIME
 
+      # the mime_types.yaml as full path, we use a copy of mongrels.
       trait :types => YAML.load_file(BASEDIR/'ramaze'/'tool'/'mime_types.yaml')
 
       class << self
+
+        # Get MIME-type for the given filename based on extension.
+        # Answers with an empty string if none is found.
         def type_for file
           ext = File.extname(file)
           trait[:types][ext].to_s

data/lib/ramaze/trinity/response.rb

@@ -2,7 +2,22 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 module Ramaze
+
+  # Subclassing Rack::Response for our own purposes.
   class Response < ::Rack::Response
+    # build a response, default values are from the current response.
+
+    def build body = body, status = status, head = header
+      Dispatcher.set_cookie if Global.sessions
+
+      head.each do |key, value|
+        self[key] = value
+      end
+
+      self.body, self.status = body, status
+      self
+    end
+
     class << self
 
       # get the current response out of Thread.current[:response]

data/lib/ramaze/trinity/session.rb

@@ -76,7 +76,7 @@ module Ramaze
       # enabled
 
       def startup(options = {})
-        Cache.add(:sessions) if Global.cookies
+        Cache.add(:sessions) if Global.sessions
       end
 
       # answers with Thread.current[:session] which holds the current session

data/lib/ramaze/version.rb

@@ -5,7 +5,7 @@ module Ramaze #:nodoc:
   module Version #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/ramaze.rb

@@ -1,6 +1,11 @@
 #          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
 # All files in this distribution are subject to the terms of the Ruby license.
 
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
 # The main namespace for Ramaze
 module Ramaze
   BASEDIR = File.dirname(File.expand_path(__FILE__))

data/rake_tasks/conf.rake

@@ -1,6 +1,6 @@
 AUTHOR = "manveru"
 EMAIL = "m.fellinger@gmail.com"
-DESCRIPTION = "Ramaze tries to be a very simple Webframework without the voodoo"
+DESCRIPTION = "Ramaze is a simple and modular web framework"
 HOMEPATH = 'http://ramaze.rubyforge.org'
 BIN_FILES = %w( ramaze )
 
@@ -49,8 +49,8 @@ You can now do following:
 * Create a new project using the `ramaze' command:
     ramaze --create yourproject
 
-* Browse and try the Examples in
-    #{File.join(Gem.path, 'gems', 'ramaze-' + VERS, 'examples')}
-
 #{'=' * 60}
 }.strip
+
+# * Browse and try the Examples in
+#     #{File.join(Gem.path, 'gems', 'ramaze-' + VERS, 'examples')}

data/rake_tasks/maintaince.rake

@@ -155,6 +155,7 @@ task 'tutorial2html' do
   File.open(basefile + '.html', 'w+'){|f| f.puts(wrap) }
 end
 
+desc "Rebuild doc/tutorial/todolist.html"
 task 'tutorial' => ['tutorial2html'] do
   require 'hpricot'
 
@@ -196,17 +197,19 @@ task 'tutorial' => ['tutorial2html'] do
   end
 end
 
+desc "Update /doc/AUTORS"
 task 'authors' do
   changes = `darcs changes`
   authors = []
   mapping = {}
   author_map = {
-    'm.fellinger@gmail.com'            => 'Michael Fellinger',
-    'manveru@weez-int.com'             => 'Michael Fellinger',
-    'clive@crous.co.za'                => 'Clive Crous',
-    'blueonyx@dev-area.net'            => 'Martin Hilbig',
-    'rff.rff@gmail.com'                => 'Gabriele Renzi',
-    'comp.lang.zenix+ramaze@gmail.com' => 'zenix',
+    'm.fellinger@gmail.com'                   => 'Michael Fellinger',
+    'manveru@weez-int.com'                    => 'Michael Fellinger',
+    'clive@crous.co.za'                       => 'Clive Crous',
+    'blueonyx@dev-area.net'                   => 'Martin Hilbig',
+    'rff.rff@gmail.com'                       => 'Gabriele Renzi',
+    'comp.lang.zenix+ramaze@gmail.com'        => 'zenix',
+    'jesuswasramazing.10.pistos@geoshell.com' => 'Pistos',
   }
   changes.split("\n").grep(/^\w/).each do |line|
     splat  = line.split
@@ -230,6 +233,7 @@ task 'authors' do
   end
 end
 
+desc "upload packages to rubyforge"
 task 'release' => ['distribute'] do
   sh 'rubyforge login'
   #sh "rubyforge add_release ramaze ramaze #{VERS} pkg/ramaze-#{VERS}.gem"
@@ -248,7 +252,6 @@ task 'release' => ['distribute'] do
   sh "rubyforge add_file ramaze ramaze #{release_id} pkg/ramaze-#{VERS}.tar.bz2"
 end
 
-desc "list all undocumented methods"
 task 'undocumented-module' do
   require 'strscan'
   require 'term/ansicolor'
@@ -342,11 +345,13 @@ task 'undocumented-module' do
   puts
 end
 
+desc "list all undocumented methods"
 task 'undocumented' do
 	$VERBOSE = false
 	Rake::Task['undocumented-module'].execute
 end
 
+desc "list all undocumented methods verbosely"
 task 'undocumented-verbose' do
 	$VERBOSE = true
 	Rake::Task['undocumented-module'].execute

data/rake_tasks/spec.rake

@@ -2,15 +2,18 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 require 'rake'
-require 'spec/helper/layout'
+require 'ramaze/spec/helper/layout'
 require 'lib/ramaze/snippets/string/DIVIDE'
 
 SPEC_BASE = File.expand_path('spec')
-
+EXAMPLE_BASE = File.expand_path('examples')
+SNIPPETS_BASE = File.expand_path('snippets')
 # ignore files with these paths
 ignores = [ './*', './helper/*', './ramaze/adapter.rb', './ramaze/request.rb', ]
 
-files = Dir[SPEC_BASE/'**'/'*.rb']
+files = Dir[SPEC_BASE/'**'/'*.rb'] + 
+        Dir[EXAMPLE_BASE/'**/spec'/'*.rb']
+        Dir[SNIPPETS_BASE/'**/*.rb']
 ignores.each do |ignore|
   ignore_files = Dir[SPEC_BASE/ignore]
   ignore_files.each do |ignore_file|
@@ -23,7 +26,7 @@ files.sort!
 spec_layout = Hash.new{|h,k| h[k] = []}
 
 files.each do |file|
-  name = file.gsub(/^#{SPEC_BASE}/, '.')
+  name = file.gsub(/^(#{SPEC_BASE}|#{EXAMPLE_BASE})/, '.')
   dir_name = File.dirname(name)[2..-1]
   task_name = ([:test] + dir_name.split('/')).join(':')
   spec_layout[task_name] << file

data/spec/examples/caching.rb

@@ -6,14 +6,12 @@ describe 'Caching' do
   ramaze
 
   it '/' do
-    n1 = 10_000
-    n2 = 10_000
-    result = n1 ** n2
-    url = "/#{n1}/#{n2}"
-    result_string = "Hello, i'm a little method with this calculation:\n#{n1} ** #{n2} = #{result}"
+    3.times do
+      lambda{ get('/') }.should_not change{ get('/').body }
+    end
 
-    intense_time = Benchmark.realtime{ get(url).body.should == result_string }
-    cached_already = Benchmark.realtime{ 10.times{ get(url) } }
-    intense_time.should be > cached_already
+    3.times do
+      lambda{ get('/invalidate') }.should change{ get('/').body }
+    end
   end
 end

data/spec/helper.rb

@@ -1,60 +1,3 @@
-#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-require 'spec/helper/minimal'
-require 'spec/helper/mock_http'
-require 'spec/helper/simple_http'
-require 'spec/helper/requester'
-require 'spec/helper/context'
-
-Spec::Runner.configure do |config|
-  config.include MockHTTP
-end
-
-
-if defined?(::Spec)
-  exclude = Ramaze::Controller.class_trait[:exclude_action_modules]
-  exclude += [Base64::Deprecated, Base64, Spec::Expectations::ObjectExpectations]
-  exclude << Spec::Mocks::Methods if defined?(Spec::Mock::Methods)
-end
-
-# start up ramaze with a given hash of options
-# that will be merged with the default-options.
-
-def ramaze_start hash = {}
-  options = {
-    :adapter      => false,
-    :run_loose    => true,
-    :error_page   => false,
-    :port         => 7007,
-    :host         => '127.0.0.1',
-    :force        => true,
-    :origin       => :spec,
-  }.merge(hash)
-
-  Ramaze.start(options)
-end
-
-alias ramaze ramaze_start
-
-# shutdown ramaze, this is not implemeted yet
-# (and might never be due to limited possibilites)
-
-def browser(*args, &block)
-  Browser.new(*args, &block)
-end
-
-
-# require each of the following and rescue LoadError, telling you why it failed.
-
-def testcase_requires(*following)
-  following.each do |file|
-    require(file.to_s)
-  end
-rescue LoadError => ex
-  puts ex
-  puts "Can't run #{$0}: #{ex}"
-  puts "Usually you should not worry about this failure, just install the"
-  puts "library and try again (if you want to use that feature later on)"
-  exit
-end
+$LOAD_PATH.unshift( File.join( File.dirname(__FILE__), "lib" ) )
+require 'ramaze'
+require 'ramaze/spec/helper'