RubyGems - ramaze - Versions diffs - 2011.07.25 → 2011.10.23 - Mend

ramaze 2011.07.25 → 2011.10.23

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 (181) hide show

data/.gitignore +3 -0
data/.mailmap +3 -2
data/.travis.yml +17 -0
data/.yardopts +13 -0
data/README.md +95 -352
data/examples/app/blog/app.rb +25 -64
data/examples/app/blog/config.ru +11 -9
data/examples/app/blog/controller/init.rb +29 -86
data/examples/app/blog/controller/posts.rb +232 -0
data/examples/app/blog/controller/users.rb +160 -0
data/examples/app/blog/layout/default.xhtml +61 -0
data/examples/app/blog/migrations/01_create_schema.rb +50 -0
data/examples/app/blog/model/comment.rb +41 -54
data/examples/app/blog/model/init.rb +41 -13
data/examples/app/blog/model/post.rb +35 -0
data/examples/app/blog/model/user.rb +105 -0
data/examples/app/blog/public/.htaccess +24 -0
data/examples/app/blog/public/css/grid.css +107 -0
data/examples/app/blog/public/css/layout.css +203 -0
data/examples/app/blog/public/css/reset.css +123 -0
data/examples/app/blog/public/css/text.css +109 -0
data/examples/app/blog/public/dispatch.fcgi +11 -0
data/examples/app/blog/public/favicon.ico +0 -0
data/examples/app/blog/public/images/bg.png +0 -0
data/examples/app/blog/start.rb +18 -3
data/examples/app/blog/view/feed.xhtml +23 -0
data/examples/app/blog/view/form.xhtml +11 -0
data/examples/app/blog/view/index.xhtml +44 -0
data/examples/app/blog/view/users/form.xhtml +12 -0
data/examples/app/blog/view/users/index.xhtml +30 -0
data/examples/app/blog/view/users/login.xhtml +8 -0
data/examples/app/blog/view/view.xhtml +68 -0
data/{doc → guide}/AUTHORS +5 -3
data/{doc → guide}/CHANGELOG +428 -0
data/{doc/GPL → guide/GPL_LICENSE} +0 -0
data/{doc/COPYING → guide/RUBY_LICENSE} +3 -6
data/guide/_static/logo.png +0 -0
data/guide/_static/logo.svg +49 -0
data/guide/_static/ramaze_console.png +0 -0
data/guide/css/common.css +20 -0
data/guide/general/cache.md +167 -0
data/guide/general/configuration.md +168 -0
data/guide/general/contributing.md +108 -0
data/guide/general/controllers.md +115 -0
data/guide/general/helpers.md +76 -0
data/guide/general/installation.md +58 -0
data/guide/general/logging.md +99 -0
data/guide/general/middlewares.md +100 -0
data/guide/general/models.md +78 -0
data/guide/general/principles.md +53 -0
data/guide/general/ramaze_command.md +155 -0
data/guide/general/routes.md +81 -0
data/guide/general/sessions.md +140 -0
data/guide/general/special_thanks.md +67 -0
data/guide/general/testing.md +61 -0
data/guide/general/views.md +322 -0
data/guide/tutorials/introduction.md +259 -0
data/lib/proto/config.ru +1 -1
data/lib/proto/public/favicon.ico +0 -0
data/lib/proto/view/index.xhtml +7 -7
data/lib/ramaze.rb +4 -4
data/lib/ramaze/app.rb +11 -11
data/lib/ramaze/app_graph.rb +2 -4
data/lib/ramaze/bin/console.rb +3 -3
data/lib/ramaze/bin/create.rb +2 -2
data/lib/ramaze/bin/restart.rb +4 -4
data/lib/ramaze/bin/runner.rb +5 -5
data/lib/ramaze/bin/start.rb +19 -4
data/lib/ramaze/bin/status.rb +3 -3
data/lib/ramaze/bin/stop.rb +3 -3
data/lib/ramaze/cache.rb +1 -0
data/lib/ramaze/cache/lru.rb +8 -4
data/lib/ramaze/cache/memcache.rb +32 -13
data/lib/ramaze/cache/redis.rb +164 -0
data/lib/ramaze/cache/sequel.rb +43 -28
data/lib/ramaze/controller.rb +1 -2
data/lib/ramaze/dependencies.rb +40 -3
data/lib/ramaze/helper/bench.rb +26 -16
data/lib/ramaze/helper/blue_form.rb +46 -73
data/lib/ramaze/helper/cache.rb +10 -6
data/lib/ramaze/helper/csrf.rb +35 -39
data/lib/ramaze/helper/disqus.rb +5 -4
data/lib/ramaze/helper/email.rb +35 -24
data/lib/ramaze/helper/erector.rb +9 -13
data/lib/ramaze/helper/flash.rb +7 -9
data/lib/ramaze/helper/formatting.rb +194 -179
data/lib/ramaze/helper/gravatar.rb +4 -8
data/lib/ramaze/helper/identity.rb +3 -3
data/lib/ramaze/helper/layout.rb +23 -8
data/lib/ramaze/helper/markaby.rb +1 -1
data/lib/ramaze/helper/paginate.rb +46 -39
data/lib/ramaze/helper/request_accessor.rb +3 -1
data/lib/ramaze/helper/simple_captcha.rb +18 -17
data/lib/ramaze/helper/stack.rb +1 -1
data/lib/ramaze/helper/tagz.rb +4 -2
data/lib/ramaze/helper/upload.rb +523 -0
data/lib/ramaze/helper/user.rb +4 -8
data/lib/ramaze/helper/xhtml.rb +11 -15
data/lib/ramaze/log.rb +9 -6
data/lib/ramaze/log/rotatinginformer.rb +62 -27
data/lib/ramaze/log/syslog.rb +20 -15
data/lib/ramaze/log/xosd.rb +2 -1
data/lib/ramaze/reloader.rb +2 -0
data/lib/ramaze/request.rb +11 -10
data/lib/ramaze/setup.rb +23 -6
data/lib/ramaze/snippets/array/put_within.rb +3 -9
data/lib/ramaze/snippets/binding/locals.rb +5 -10
data/lib/ramaze/snippets/fiber.rb +1 -23
data/lib/ramaze/snippets/kernel/pretty_inspect.rb +3 -6
data/lib/ramaze/snippets/numeric/filesize_format.rb +3 -5
data/lib/ramaze/snippets/numeric/time.rb +3 -7
data/lib/ramaze/snippets/object/__dir__.rb +3 -7
data/lib/ramaze/snippets/object/instance_variable_defined.rb +3 -6
data/lib/ramaze/snippets/object/pretty.rb +3 -7
data/lib/ramaze/snippets/object/scope.rb +7 -9
data/lib/ramaze/snippets/proc/locals.rb +12 -12
data/lib/ramaze/snippets/ramaze/acquire.rb +15 -14
data/lib/ramaze/snippets/ramaze/deprecated.rb +1 -1
data/lib/ramaze/snippets/ramaze/fiber.rb +1 -1
data/lib/ramaze/snippets/ramaze/lru_hash.rb +2 -3
data/lib/ramaze/snippets/ramaze/struct.rb +2 -4
data/lib/ramaze/snippets/string/camel_case.rb +8 -10
data/lib/ramaze/snippets/string/color.rb +3 -4
data/lib/ramaze/snippets/string/end_with.rb +3 -6
data/lib/ramaze/snippets/string/esc.rb +3 -8
data/lib/ramaze/snippets/string/ord.rb +3 -8
data/lib/ramaze/snippets/string/snake_case.rb +6 -9
data/lib/ramaze/snippets/string/start_with.rb +3 -8
data/lib/ramaze/snippets/string/unindent.rb +3 -6
data/lib/ramaze/snippets/thread/into.rb +1 -3
data/lib/ramaze/spec.rb +2 -31
data/lib/ramaze/spec/bacon.rb +18 -2
data/lib/ramaze/version.rb +1 -1
data/lib/ramaze/view.rb +1 -1
data/ramaze.gemspec +1 -1
data/spec/helper.rb +2 -1
data/spec/ramaze/bin/start.rb +16 -20
data/spec/ramaze/cache/localmemcache.rb +4 -7
data/spec/ramaze/cache/memcache.rb +3 -1
data/spec/ramaze/cache/redis.rb +62 -0
data/spec/ramaze/helper/blue_form.rb +33 -4
data/spec/ramaze/helper/layout.rb +40 -7
data/spec/ramaze/helper/upload.rb +149 -0
data/spec/ramaze/helper/uploads/text_1.txt +1 -0
data/spec/ramaze/helper/uploads/text_2.txt +1 -0
data/spec/ramaze/log/growl.rb +4 -6
data/spec/ramaze/log/syslog.rb +6 -0
data/spec/ramaze/view/lokar.rb +5 -0
data/spec/ramaze/view/nagoro.rb +5 -0
data/tasks/authors.rake +1 -1
data/tasks/bacon.rake +14 -5
data/tasks/changelog.rake +1 -1
data/tasks/yard.rake +12 -4
metadata +277 -239
data/doc/LEGAL +0 -26
data/examples/app/blog/README +0 -3
data/examples/app/blog/controller/comment.rb +0 -45
data/examples/app/blog/controller/entry.rb +0 -85
data/examples/app/blog/controller/main.rb +0 -20
data/examples/app/blog/controller/tag.rb +0 -9
data/examples/app/blog/layout/default.nag +0 -31
data/examples/app/blog/model/entry.rb +0 -89
data/examples/app/blog/model/tag.rb +0 -36
data/examples/app/blog/public/css/screen.css +0 -273
data/examples/app/blog/spec/blog.rb +0 -87
data/examples/app/blog/view/comment/form.nag +0 -10
data/examples/app/blog/view/comment/show.nag +0 -16
data/examples/app/blog/view/entry/edit.nag +0 -14
data/examples/app/blog/view/entry/feed.atom.nag +0 -8
data/examples/app/blog/view/entry/feed.rss.nag +0 -7
data/examples/app/blog/view/entry/index.nag +0 -7
data/examples/app/blog/view/entry/new.nag +0 -13
data/examples/app/blog/view/entry/show.nag +0 -36
data/examples/app/blog/view/feed.atom.nag +0 -18
data/examples/app/blog/view/feed.rss.nag +0 -25
data/examples/app/blog/view/index.nag +0 -6
data/examples/app/blog/view/tag/index.nag +0 -5
data/lib/proto/public/ramaze.png +0 -0
data/lib/ramaze/rest.rb +0 -36
data/spec/ramaze/rest.rb +0 -28
data/tasks/rcov.rake +0 -22

data/examples/app/blog/controller/users.rb ADDED

@@ -0,0 +1,160 @@
+##
+# The Users controller is used for managing users and allowing existing users to
+# log in.
+#
+# @author Yorick Peterse
+# @since  26-09-2011
+#
+class Users < BaseController
+  map '/users'
+  # The user has to be logged in in order to access this controller. The only
+  # exception is the login() method.
+  before_all do
+    if action.method.to_sym != :login and !logged_in?
+      flash[:error] = 'You need to be logged in to view that page'
+      redirect(Users.r(:login))
+    end
+  end
+  ##
+  # Shows an overview of all the users that have been added to the database.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  #
+  def index
+    @users = paginate(User)
+    @title = 'Users'
+  end
+  ##
+  # Allows users to add another user to the database.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  #
+  def new
+    @user  = flash[:form_data] || User.new
+    @title = 'New user'
+    render_view(:form)
+  end
+  ##
+  # Edits an existing user. If the specified user ID is invalid the user is
+  # redirected back to the previous page.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  # @param  [Fixnum] id The ID of the user to edit.
+  #
+  def edit(id)
+    @user = flash[:form_data] || User[id]
+    if @user.nil?
+      flash[:error] = 'The specified user is invalid'
+      redirect_referrer
+    end
+    @title = "Edit #{@user.username}"
+    render_view(:form)
+  end
+  ##
+  # Saves the changes made by Users#new() and Users#edit(). Just like
+  # Posts#save() this method is used for both methods since the actions required
+  # for adding/updating the data is pretty much identical.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  #
+  def save
+    data = request.subset(:username, :password)
+    id   = request.params['id']
+    if !id.nil? and !id.empty?
+      user = User[id]
+      if user.nil?
+        flash[:error] = 'The specified user is invalid'
+        redirect_referrer
+      end
+      success = 'The user has been updated'
+      error   = 'The user could not be updated'
+    else
+      user    = User.new
+      success = 'The user has been added'
+      error   = 'The user could not be added'
+    end
+    begin
+      user.update(data)
+      flash[:success] = success
+      redirect(Users.r(:edit, user.id))
+    rescue => e
+      Ramaze::Log.error(e)
+      flash[:error]       = error
+      flash[:form_errors] = user.errors
+      flash[:form_data]   = user
+      redirect_referrer
+    end
+  end
+  ##
+  # Deletes a single user and redirects the user back to the overview.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  # @param  [Fixnum] id The ID of the user to delete.
+  #
+  def delete(id)
+    begin
+      User.filter(:id => id).destroy
+      flash[:success] = 'The specified user has been removed'
+    rescue => e
+      Ramaze::Log.error(e)
+      flash[:error] = 'The specified user could not be removed'
+    end
+    redirect_referrer
+  end
+  ##
+  # Allows a user to log in. Once logged in the user is able to manage existing
+  # users and edit posts.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  #
+  def login
+    if request.post?
+      if user_login(request.subset('username', 'password'))
+        flash[:success] = 'You have been logged in'
+        redirect(Posts.r(:index))
+      else
+        flash[:error] = 'You could not be logged in'
+      end
+    end
+    @title = 'Login'
+  end
+  ##
+  # Logs the user out and destroys the session.
+  #
+  # @author Yorick Peterse
+  # @since  27-09-2011
+  #
+  def logout
+    user_logout
+    session.clear
+    flash[:success] = 'You have been logged out'
+    redirect(Users.r(:login))
+  end
+end # Users

data/examples/app/blog/layout/default.xhtml ADDED

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <title>#{@title}</title>
+        #{css('reset')}
+        #{css('grid')}
+        #{css('layout')}
+        #{css('text')}
+    </head>
+    <body>
+        <div class="container">
+            <div id="container" class="row">
+                <!-- Top part, contains the navigation menu -->
+                <div id="top" class="grid_12">
+                    <header class="grid_6">
+                        <h1>#{@title}</h1>
+                    </header>
+                    <nav class="grid_6 last">
+                        <ul class="clearfix">
+                            <li>#{Posts.a('Posts', :index)}</li>
+                            <?r if logged_in? ?>
+                            <li>#{Users.a('Users', :index)}</li>
+                            <li>#{Users.a('Logout', :logout)}</li>
+                            <?r else ?>
+                            <li>#{Users.a('Login', :login)}</li>
+                            <?r end ?>
+                        </ul>
+                    </nav>
+                </div>
+                <?r [:success, :error].each do |type| ?>
+                <?r if flash[type] ?>
+                <div class="message grid_12 #{type}">
+                    <p>#{flash[type]}</p>
+                </div>
+                <?r end ?>
+                <?r end ?>
+                <div id="content" class="grid_12">
+                    #{@content}
+                </div>
+            </div>
+            <footer id="footer">
+                <p>
+                    Ramaze is free software and is licensed under the Ruby
+                    license.
+                </p>
+            </footer>
+        </div>
+    </body>
+</html>

data/examples/app/blog/migrations/01_create_schema.rb ADDED

@@ -0,0 +1,50 @@
+# For more information on Sequel migrations see the following page:
+# http://sequel.rubyforge.org/rdoc/files/doc/migration_rdoc.html
+Sequel.migration do
+  # The up() method and block is used to update a database to the current
+  # migration.
+  up do
+    create_table(:users) do
+      primary_key :id
+      String :username, :null => false
+      String :password, :null => false
+    end
+    create_table(:posts) do
+      primary_key :id
+      String :title, :null => false
+      String :body , :null => false, :text => true
+      Time :created_at
+      Time :updated_at
+      foreign_key :user_id, :users, :on_update => :cascade,
+        :on_delete => :cascade, :key => :id
+    end
+    create_table(:comments) do
+      primary_key :id
+      String :username, :null => true
+      String :comment , :null => false, :text => true
+      Time :created_at
+      foreign_key :post_id, :posts, :on_update => :cascade,
+        :on_delete => :cascade, :key => :id
+      foreign_key :user_id, :users, :on_update => :cascade,
+        :on_delete => :cascade, :key => :id
+    end
+  end
+  # The down() method and block is used to revert the changes introduced by the
+  # up() block.
+  down do
+    drop_table(:comments)
+    drop_table(:posts)
+    drop_table(:users)
+  end
+end

data/examples/app/blog/model/comment.rb CHANGED

@@ -1,58 +1,45 @@
-module Blog
-  class Comment < Sequel::Model
-    set_schema do
-      primary_key :id
-      # on update
-      varchar :author
-      varchar :email
-      varchar :homepage
-      text :content
-      # system
-      time :published
-      time :updated
-      boolean :public, :default => true
-      foreign_key :entry_id
-    end
-    many_to_one :entry, :class => 'Blog::Entry'
-    create_table unless table_exists?
-    before_save{ self.updated = Time.now }
-    before_create{ self.published = Time.now }
-    validations.clear
-    validates do
-      length_of :author, :within => (2..255)
-      # yay, reddit! we should rather set a minimum like:
-      # "I, for one, welcome our new x overlords.".size
-      length_of :content, :minimum => 2
-      # a@b.c anyone know a domain like that?
-      length_of :email, :within => (5..255)
-      format_of :email, :with => /^([^@\s]{1}+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
-      format_of :homepage, :with => /^https?:\/\/[^\s\/]+\.[^\s\/]+/
-    end
-    def href
-      Entries.r(:/, "#{entry.slug}#comment-#{id}")
+##
+# The Comment model is used for creating and managing comments.
+#
+# @author Yorick Peterse
+# @since  26-09-2011
+#
+class Comment < Sequel::Model
+  plugin :timestamps, :create => :created_at, :update => :updated_at
+  # A comment can belong to only one post and one user
+  many_to_one :post
+  many_to_one :user
+  ##
+  # Validates a comment before saving it to the database.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  #
+  def validate
+    validates_presence(:comment)
+    # Comments can either have user ID or a custom name. The user ID is only set
+    # when the user is logged in.
+    unless self.user_id
+      validates_presence(:username)
     end
+  end
-    def update(entry, hash)
-      return unless entry
-      [:author, :email, :homepage, :content].each do |key|
-        self[key] = hash[key]
-      end
-      return unless valid?
-      save
-      entry.add_comment(self)
+  ##
+  # Gets the name of the author from either an associated user or the "name"
+  # field.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  # @return [String]
+  #
+  def username
+    if user and user.username
+      return user.username
+    else
+      return super
     end
   end
-end
+end # Comment

data/examples/app/blog/model/init.rb CHANGED

@@ -1,16 +1,44 @@
-require 'sequel'
-require 'sequel/extensions/inflector'
+# Configure Sequel. This example uses a SQLite3 database with it's encoding set
+# to UTF-8. The :test option is used to confirm that the database connection is
+# valid before it's actually being used. In this case the connection returned by
+# Sequel.connect is stored in a constant called "DB" but you're free to store it
+# wherever you want.
+DB = Sequel.connect(
+  :adapter  => 'sqlite',
+  :database => __DIR__('../database.db'),
+  :test     => true,
+  :encoding => 'utf8'
+)
-module Blog
-  DB = Sequel.sqlite("#{__DIR__}/../blog.db")
-  # DB = Sequel.connect("sqlite:///#{__DIR__}/../blog.db")
-end
+# The validation_helpers plugin is required if you want to use the #validate()
+# method in your model in combination with easy to use methods such as
+# validates_presence().
+Sequel::Model.plugin(:validation_helpers)
+# The migration extension is needed in order to run migrations.
+Sequel.extension(:migration)
+# The pagination extension is needed by Ramaze::Helper::Paginate.
+Sequel.extension(:pagination)
+# Migrate the database
+Sequel::Migrator.run(DB, __DIR__('../migrations'))
-Sequel.extension :pagination
-Sequel::Model.plugin :validation_class_methods
-Sequel::Model.plugin :schema
-Sequel::Model.plugin :hook_class_methods
+# Time to load all the models now that Sequel is set up.
+require __DIR__('comment')
+require __DIR__('post')
+require __DIR__('user')
-require 'model/tag'
-require 'model/entry'
-require 'model/comment'
+# Insert the default user if this hasn't already been done so.
+unless User[:username => 'admin']
+  User.create(:username => 'admin', :password => 'admin')
+end
+# Insert a default post if no posts have been added.
+if Post.all.empty?
+  Post.create(
+    :title   => 'Example Post',
+    :body    => 'This is a post that uses Markdown!',
+    :user_id => User[:username => 'admin'].id
+  )
+end

data/examples/app/blog/model/post.rb ADDED

@@ -0,0 +1,35 @@
+##
+# The Post class is a model that's used for managing posts. The corresponding
+# table is called "posts". For more information on how Sequel works see the
+# following page: http://sequel.rubyforge.org/documentation.html
+#
+# @author Yorick Peterse
+# @since  26-09-2011
+#
+class Post < Sequel::Model
+  # The timestamps plugin is used to automatically fill two database columns
+  # with the dates and times on which an object was created and when it was
+  # modified.
+  plugin :timestamps, :create => :created_at, :update => :updated_at
+  # Multiple posts can only belong to a single user.
+  many_to_one :user
+  one_to_many :comments
+  ##
+  # Post#validate() is called whenever an instance of this class is saved or
+  # updated. For more information on what you can do with this method see the
+  # following page:
+  # http://sequel.rubyforge.org/rdoc/files/doc/validations_rdoc.html
+  #
+  # If you're used to working with ActiveRecord it's important to remember that
+  # these validation methods can't be used in a model's class declaration, they
+  # have to be placed inside the #validate() method.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  #
+  def validate
+    validates_presence([:title, :body])
+  end
+end # Post