RubyGems - ramaze - Versions diffs - 0.1.3 → 0.1.4 - Mend

ramaze 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (149) hide show

data/bin/ramaze +58 -26
data/doc/AUTHORS +2 -0
data/doc/CHANGELOG +401 -0
data/doc/README +14 -9
data/doc/README.html +737 -0
data/doc/TODO +14 -14
data/doc/changes.txt +401 -0
data/doc/changes.xml +401 -0
data/doc/meta/announcement.txt +28 -15
data/doc/meta/configuration.txt +3 -3
data/doc/meta/internals.txt +2 -2
data/doc/meta/users.kml +62 -0
data/doc/readme_chunks/examples.txt +1 -1
data/doc/readme_chunks/features.txt +13 -8
data/doc/tutorial/todolist.html +2 -2
data/doc/tutorial/todolist.mkd +2 -2
data/examples/blog/README +3 -0
data/examples/blog/spec/blog.rb +101 -0
data/examples/blog/{main.rb → start.rb} +0 -0
data/examples/caching.rb +16 -5
data/examples/layout.rb +41 -0
data/examples/templates/template_amrita2.rb +1 -1
data/examples/templates/template_erubis.rb +1 -1
data/examples/templates/template_ezamar.rb +1 -1
data/examples/templates/template_haml.rb +1 -1
data/examples/templates/template_liquid.rb +1 -1
data/examples/templates/template_markaby.rb +1 -1
data/examples/templates/template_remarkably.rb +1 -1
data/examples/todolist/README +1 -0
data/{spec/examples → examples/todolist/spec}/todolist.rb +3 -3
data/examples/todolist/{main.rb → start.rb} +0 -0
data/examples/whywiki/{main.rb → start.rb} +0 -0
data/examples/wiktacular/README +2 -0
data/examples/wiktacular/spec/wiktacular.rb +146 -0
data/examples/wiktacular/src/controller.rb +11 -0
data/examples/wiktacular/src/model.rb +5 -1
data/examples/wiktacular/{main.rb → start.rb} +0 -1
data/examples/wiktacular/template/edit.xhtml +1 -2
data/examples/wiktacular/template/html_layout.xhtml +27 -0
data/examples/wiktacular/template/index.xhtml +8 -10
data/examples/wiktacular/template/new.xhtml +1 -2
data/lib/proto/{main.rb → start.rb} +0 -0
data/lib/proto/template/index.xhtml +1 -1
data/lib/ramaze/action/render.rb +58 -4
data/lib/ramaze/action.rb +20 -0
data/lib/ramaze/adapter/cgi.rb +7 -4
data/lib/ramaze/adapter/fcgi.rb +6 -4
data/lib/ramaze/adapter/mongrel.rb +4 -0
data/lib/ramaze/adapter/webrick.rb +20 -9
data/lib/ramaze/adapter.rb +3 -1
data/lib/ramaze/cache/memcached.rb +2 -26
data/lib/ramaze/cache.rb +8 -4
data/lib/ramaze/controller/resolve.rb +26 -8
data/lib/ramaze/controller.rb +44 -7
data/lib/ramaze/dispatcher/action.rb +5 -1
data/lib/ramaze/dispatcher/directory.rb +115 -0
data/lib/ramaze/dispatcher/error.rb +19 -5
data/lib/ramaze/dispatcher/file.rb +2 -2
data/lib/ramaze/dispatcher.rb +52 -39
data/lib/ramaze/global/dsl.rb +3 -2
data/lib/ramaze/global/globalstruct.rb +26 -4
data/lib/ramaze/global.rb +20 -11
data/lib/ramaze/helper/aspect.rb +29 -11
data/lib/ramaze/helper/auth.rb +2 -2
data/lib/ramaze/helper/cache.rb +2 -0
data/lib/ramaze/helper/identity.rb +21 -6
data/lib/ramaze/helper/link.rb +1 -1
data/lib/ramaze/helper/pager.rb +158 -100
data/lib/ramaze/helper/partial.rb +22 -0
data/lib/ramaze/helper/redirect.rb +1 -2
data/lib/ramaze/helper/stack.rb +1 -1
data/lib/ramaze/inform/informer.rb +20 -0
data/lib/ramaze/inform/syslog.rb +5 -0
data/lib/ramaze/snippets/kernel/__dir__.rb +21 -0
data/lib/ramaze/snippets/kernel/aquire.rb +22 -12
data/lib/ramaze/snippets/numeric/human_readable_filesize_format.rb +33 -0
data/lib/ramaze/snippets/ramaze/caller_lines.rb +1 -1
data/lib/ramaze/snippets/struct/values_at.rb +11 -4
data/lib/ramaze/sourcereload.rb +29 -1
data/{spec → lib/ramaze/spec}/helper/context.rb +0 -0
data/{spec → lib/ramaze/spec}/helper/layout.rb +1 -1
data/{spec → lib/ramaze/spec}/helper/minimal.rb +0 -0
data/{spec → lib/ramaze/spec}/helper/mock_http.rb +0 -0
data/{spec → lib/ramaze/spec}/helper/requester.rb +0 -0
data/{spec → lib/ramaze/spec}/helper/simple_http.rb +0 -0
data/{spec → lib/ramaze/spec}/helper/wrap.rb +0 -0
data/lib/ramaze/spec/helper.rb +60 -0
data/lib/ramaze/store/default.rb +3 -0
data/lib/ramaze/template/ezamar/render_partial.rb +3 -0
data/lib/ramaze/template/sass.rb +45 -0
data/lib/ramaze/template.rb +1 -1
data/lib/ramaze/tool/create.rb +5 -5
data/lib/ramaze/tool/localize.rb +26 -5
data/lib/ramaze/tool/mime.rb +7 -0
data/lib/ramaze/trinity/response.rb +15 -0
data/lib/ramaze/trinity/session.rb +1 -1
data/lib/ramaze/version.rb +1 -1
data/lib/ramaze.rb +5 -0
data/rake_tasks/conf.rake +4 -4
data/rake_tasks/maintaince.rake +12 -7
data/rake_tasks/spec.rake +7 -4
data/spec/examples/caching.rb +6 -8
data/spec/helper.rb +3 -60
data/spec/ramaze/action/basics.rb +17 -0
data/spec/ramaze/action/cache.rb +28 -0
data/spec/ramaze/action/layout.rb +110 -0
data/spec/ramaze/action/render.rb +14 -0
data/spec/ramaze/action/template/bar.xhtml +1 -0
data/spec/ramaze/action/template/other_wrapper.xhtml +1 -0
data/spec/ramaze/action/template/single_wrapper.xhtml +1 -0
data/spec/ramaze/controller/template/edit/content.xhtml +1 -0
data/spec/ramaze/controller/template/edit.xhtml +1 -0
data/spec/ramaze/controller/template_resolving.rb +2 -2
data/spec/ramaze/dispatcher/directory.rb +53 -0
data/spec/ramaze/dispatcher/file.rb +0 -3
data/spec/ramaze/error.rb +17 -2
data/spec/ramaze/helper/aspect.rb +14 -20
data/spec/ramaze/helper/pager.rb +83 -1
data/spec/ramaze/helper/partial.rb +1 -1
data/spec/ramaze/helper/template/test_template.xhtml +1 -0
data/spec/ramaze/inform/informer.rb +37 -5
data/spec/ramaze/localize.rb +1 -1
data/spec/ramaze/template/haml.rb +5 -5
data/spec/ramaze/template/sass/file.css.sass +5 -0
data/spec/ramaze/template/sass.rb +46 -0
data/spec/ramaze/template.rb +1 -1
data/spec/ramaze/trinity/session.rb +27 -0
data/spec/snippets/kernel/__dir__.rb +8 -0
data/spec/snippets/kernel/aquire.rb +71 -0
data/spec/snippets/kernel/constant.rb +27 -0
data/spec/snippets/numeric/human_readable_filesize_format.rb +11 -0
data/spec/snippets/ramaze/caller_info.rb +39 -0
data/spec/snippets/ramaze/caller_lines.rb +27 -0
data/spec/snippets/string/DIVIDE.rb +18 -0
data/spec/snippets/string/camel_case.rb +25 -0
data/spec/snippets/string/color.rb +11 -0
data/spec/snippets/string/snake_case.rb +17 -0
data/spec/snippets/struct/fill.rb +27 -0
data/spec/snippets/struct/values_at.rb +39 -0
metadata +71 -31
data/examples/todolist/todolist.db +0 -5
data/examples/wiktacular/src/page.rb +0 -66
data/lib/ramaze/helper/feed.rb +0 -135
data/lib/ramaze/helper/form.rb +0 -204
data/lib/ramaze/snippets/openstruct/temp.rb +0 -13
data/lib/ramaze/store/yaml.rb +0 -170
data/spec/ramaze/helper/feed.rb +0 -127
data/spec/ramaze/helper/form.rb +0 -146
data/spec/ramaze/store/yaml.rb +0 -76

data/lib/ramaze/helper/partial.rb CHANGED Viewed

@@ -2,6 +2,28 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 module Ramaze
+  # = PartialHelper
+  #
+  # === Example Usage
+  #
+  #   class MyController
+  #     def index
+  #     end
+  #     def list
+  #       plain = request['plain']
+  #       "Hello World from List!  Plain List == #{plain}"
+  #     end
+  #   end
+  #
+  #
+  #   <html>
+  #     <head><title>Partial Render Index</title></head>
+  #     <body>
+  #       #{render_partial(Rs(:list), 'plain' => true)}
+  #     </body>
+  #   </html>
   module PartialHelper
     private

data/lib/ramaze/helper/redirect.rb CHANGED Viewed

@@ -36,8 +36,7 @@ module Ramaze
       status = opts[:status] || STATUS_CODE["See Other"]
-      body = %{Please follow <a href="#{target}">#{target}</a>!}
+      body = %{You are being redirected, please follow <a href="#{target}">this link to: #{target}</a>!}
       throw(:redirect, :body => body, :status => status, :head => head)
     end

data/lib/ramaze/helper/stack.rb CHANGED Viewed

@@ -35,7 +35,7 @@ module Ramaze
   #
   #   def secret_information
   #     call :login unless logged_in?
-  #     "Agent X is assinged to fight the RubyNinjas"
+  #     "Agent X is assigned to fight the RubyNinjas"
   #   end
   # end

data/lib/ramaze/inform/informer.rb CHANGED Viewed

@@ -28,6 +28,17 @@ module Ramaze
       :error => :red,
     }
+    # Create a new instance of Informer.
+    # You can spcify
+    #
+    # Examples:
+    #   Informer.new                    #=> logs to stdout with all levels being
+    #                                       shown.
+    #   Informer.new($stderr)           #=> same, but to stderr
+    #   Informer.new("foo.log")         #=> same, but logs to the file foo.log
+    #                                       (or creates it if it doesn't exist yet)
+    #   Informer.new($stdout, [:info])  #=> show only #info messages to stdout.
     def initialize(out = $stdout, log_levels = [:debug, :error, :info, :warn])
       @colorize = false
@@ -54,6 +65,8 @@ module Ramaze
       @log_levels = log_levels
     end
+    # Close the file we log to if it isn't closed already.
     def shutdown
       if @out.respond_to?(:close)
         Inform.debug("close, #{@out.inspect}")
@@ -61,6 +74,8 @@ module Ramaze
       end
     end
+    # Integration to Informing.
     def inform tag, *messages
       return if closed? || !@log_levels.include?(tag)
       messages.flatten!
@@ -79,6 +94,9 @@ module Ramaze
       @out.flush if @out.respond_to?(:flush)
     end
+    # Takes the prefix (tag), text and timestamp and applies it to
+    # the :format trait.
     def log_interpolate prefix, text, time = timestamp
       message = class_trait[:format].dup
@@ -97,6 +115,8 @@ module Ramaze
       Time.now.strftime(mask || "%Y-%m-%d %H:%M:%S")
     end
+    # is @out closed?
     def closed?
       @out.respond_to?(:closed?) and @out.closed?
     end

data/lib/ramaze/inform/syslog.rb CHANGED Viewed

@@ -10,19 +10,24 @@ module Ramaze
   class Syslog
     include ::Syslog
+    # opens syslog
     def initialize
       open unless ::Syslog.opened?
     end
+    # alias for default syslog methods so they match ramaze
     alias error err
     alias warn warning
+    # just sends all messages received to ::Syslog
     def inform(tag, *args)
       self.__send__(tag, *args)
     end
     public :error, :warn
+    # Has to call the modules singleton-method.
     def inspect
       ::Syslog.inspect
     end

data/lib/ramaze/snippets/kernel/__dir__.rb ADDED Viewed

@@ -0,0 +1,21 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+# Extensions for Kernel
+module Kernel
+  # This is similar to +__FILE__+ and +__LINE__+, and returns a String
+  # representing the directory of the current file is.
+  # Unlike +__FILE__+ the path returned is absolute.
+  #
+  # This method is convenience for the
+  #  File.expand_path(File.dirname(__FILE__))
+  # idiom.
+  #
+  unless defined?__DIR__
+    def __DIR__()
+      filename = caller[0][/(.*?):/, 1]
+      File.expand_path(File.dirname(filename))
+    end
+  end
+end

data/lib/ramaze/snippets/kernel/aquire.rb CHANGED Viewed

@@ -5,19 +5,29 @@
 module Kernel
-  # Example:
-  #   aquire 'foo/bar/*'
-  # requires all files inside foo/bar - recursive
-  # can take multiple parameters, it's mainly used to require all the
-  # snippets.
+  # Require all .rb and .so files on the given globs, utilizes Dir::[].
+  #
+  # Examples:
+  #   # Given following directory structure:
+  #   # src/foo.rb
+  #   # src/bar.so
+  #   # src/foo.yaml
+  #   # src/foobar/baz.rb
+  #   # src/foobar/README
+  #
+  #   # requires all files in 'src':
+  #   aquire 'src/*'
+  #
+  #   # requires all files in 'src' recursive:
+  #   aquire 'src/**/*'
+  #
+  #   # require 'src/foo.rb' and 'src/bar.so' and 'src/foobar/baz.rb'
+  #   aquire 'src/*', 'src/foobar/*'
-  def aquire *files
-    files.each do |file|
-      require file if %w(rb so).any?{|f| File.file?("#{file}.#{f}")}
-      $:.each do |dir|
-        Dir[File.join(dir, file, '*.rb')].each do |path|
-          require path unless path == File.expand_path(__FILE__)
-        end
+  def aquire *globs
+    globs.flatten.each do |glob|
+      Dir[glob].each do |file|
+        require file if file =~ /\.(rb|so)$/
       end
     end
   end

data/lib/ramaze/snippets/numeric/human_readable_filesize_format.rb ADDED Viewed

@@ -0,0 +1,33 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+class Numeric
+  HUMAN_READBLE_FILESIZE_FORMAT = [
+      ['%.1fT', 1 << 40],
+      ['%.1fG', 1 << 30],
+      ['%.1fM', 1 << 20],
+      ['%.1fK', 1 << 10],
+    ]
+  def human_readable_filesize_format
+    HUMAN_READBLE_FILESIZE_FORMAT.each do |format, size|
+      return format % (self.to_f / size) if self >= size
+    end
+    self.to_s
+  end
+end
+=begin
+$microtest_verbose = true
+$microtest_run     = true
+require 'micro/test'
+{ :description => 'format_human_filesize',
+  1 << 0  => '1',
+  1 << 10 => '1.0K',
+  1 << 20 => '1.0M',
+  1 << 30 => '1.0G',
+}.test :human_readable_filesize_format
+=end

data/lib/ramaze/snippets/ramaze/caller_lines.rb CHANGED Viewed

@@ -17,7 +17,7 @@ module Ramaze
   #     ...
   #   ]
   # Example:
-  #  __caller_lines__('/usr/lib/ruby/1.8/debug.rb', 122, 2) # ->
+  #  caller_lines('/usr/lib/ruby/1.8/debug.rb', 122, 2) # ->
   #   [
   #     [ 120, "  def check_suspend",                               false ],
   #     [ 121, "    return if Thread.critical",                     false ],

data/lib/ramaze/snippets/struct/values_at.rb CHANGED Viewed

@@ -3,12 +3,19 @@
 # Extensions for Struct
+class Symbol
+  undef_method :to_int
+end
 class Struct
-  # Point = Struct.new(:x, :y)
-  # point = Point.new(15, 10)
-  # point.values_at(:y, :x)
-  # # => [10, 15]
+  # Example:
+  #  Point = Struct.new(:x, :y)
+  #  point = Point.new(15, 10)
+  #  point.values_at(:y, :x)
+  #  # => [10, 15]
+  #  point.values_at(0, 1)
+  #  # => [15, 10]
   def values_at(*keys)
     keys.map{|k| self[k.to_sym] }

data/lib/ramaze/sourcereload.rb CHANGED Viewed

@@ -4,20 +4,29 @@
 require 'set'
 module Ramaze
+  # SourceReload provides a way to reload changed files automatically during
+  # runtime. Its default behaviour in Ramaze is to check periodically for
+  # files with newer mtime and then attempts to load them in a controlled
+  # manner.
   class SourceReload
     attr_accessor :thread, :interval, :reload_glob, :map
+    # Take interval and a regular expression for files that are going to be reloaded.
     def initialize interval = 1, reload_glob = %r{(^\./)|#{Dir.pwd}|ramaze}
       @interval, @reload_glob = interval, reload_glob
       @map, @files, @paths = [], [], []
       @mtimes = {}
     end
+    # start reloader-thread and assign it to this instance.
     def start
       Inform.debug("initialize automatic source reload every #{interval} seconds")
       @thread = reloader
     end
+    # Takes value of Global.sourcereload and unless it's false calls #start
     def self.startup options = {}
       interval = Global.sourcereload
       instance = new(interval)
@@ -26,6 +35,7 @@ module Ramaze
       instance.start if interval
     end
+    # Start reload loop in separate Thread
     def reloader
       Thread.new do
         loop do
@@ -35,6 +45,8 @@ module Ramaze
       end
     end
+    # One iteration of reload will look for files that changed since the last iteration
+    # and will try to #safe_load it.
     # This method is quite handy if you want direct control over when your code is reloaded
     #
     # Usage example:
@@ -58,6 +70,8 @@ module Ramaze
       SourceReloadHooks.after_reload
     end
+    # Scans loaded features and paths for file-paths, filters them in the end
+    # according to the @reload_glob
     def all_reload_files
       files, paths = $LOADED_FEATURES, Array['', './', *$LOAD_PATH]
@@ -75,19 +89,20 @@ module Ramaze
       m = @map.grep(@reload_glob)
     end
+    # Safe mtime
     def mtime(file)
       File.mtime(file)
     rescue Errno::ENOENT
       false
     end
+    # A safe Kernel::load, issuing the SourceReloadHooks dependin on the result.
     def safe_load(file)
       SourceReloadHooks.before_safe_load(file)
       load(file)
       SourceReloadHooks.after_safe_load_succeed(file)
       true
     rescue Object => ex
-      Inform.error(ex)
       SourceReloadHooks.after_safe_load_failed(file, ex)
       false
     end
@@ -98,21 +113,34 @@ module Ramaze
   module SourceReloadHooks
     module_function
+    # Overwrite to add actions before the reload cycle is started.
     def before_reload
     end
+    # Overwrite to add actions after the reload cycle has ended.
     def after_reload
     end
+    # Overwrite to add actions before a file is Kernel::load-ed
     def before_safe_load(file)
     end
+    # Overwrite to add actions after a file is Kernel::load-ed successfully,
+    # by default we clean the Cache for compiled templates and resolved actions.
     def after_safe_load_succeed(file)
       Cache.compiled.clear
       Cache.resolved.clear
     end
+    # Overwrite to add actions after a file is Kernel::load-ed unsuccessfully,
+    # by default we output an error-message with the exception.
     def after_safe_load_failed(file, error)
+      Inform.error(error)
     end
   end
 end

data/{spec → lib/ramaze/spec}/helper/context.rb RENAMED Viewed

File without changes

data/{spec → lib/ramaze/spec}/helper/layout.rb RENAMED Viewed

@@ -1,4 +1,4 @@
-require 'spec/helper/wrap'
+require 'ramaze/spec/helper/wrap'
 class SpecLayout
   attr_accessor :base, :layout, :files

data/{spec → lib/ramaze/spec}/helper/minimal.rb RENAMED Viewed

File without changes

data/{spec → lib/ramaze/spec}/helper/mock_http.rb RENAMED Viewed

File without changes

data/{spec → lib/ramaze/spec}/helper/requester.rb RENAMED Viewed

File without changes

data/{spec → lib/ramaze/spec}/helper/simple_http.rb RENAMED Viewed

File without changes

data/{spec → lib/ramaze/spec}/helper/wrap.rb RENAMED Viewed

File without changes

data/lib/ramaze/spec/helper.rb ADDED Viewed

@@ -0,0 +1,60 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+require 'ramaze/spec/helper/minimal'
+require 'ramaze/spec/helper/mock_http'
+require 'ramaze/spec/helper/simple_http'
+require 'ramaze/spec/helper/requester'
+require 'ramaze/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