ramaze 0.3.9.1 → 2023.01.06

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afe951903b9f669495e60996f5d8709d0b7327b2d0994b3268046f8db3683c96
+  data.tar.gz: 87acbc6a7db97ad1c92c7b03572f54d109e86a98bea854eafb6b762d33275191
+SHA512:
+  metadata.gz: 5320492673b92af275a7fdf80acd9a153e0522fd009019e6790032e470ca7e67535726441f775a88556593f67a97eb6f0a59feea74ce63e9c12b464c5878b728
+  data.tar.gz: 7d656d67c1eaecaee4a53dacc84ef9e27d7c92a12af0c5b4928f551a387709cb5bd8dacf2d4e51cc197f2febbe59f7eba498ad28dff1588177de6a30b3233e89

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,125 @@
+# Ramaze
+
+Ramaze is a very simple and straight-forward web-framework. The philosophy of
+it could be expressed in a mix of KISS and POLS, trying to make simple things
+simple and complex things possible.
+
+This of course is nothing new to anyone who knows some Ruby, but is often
+forgotten in a chase for new functionality and features. Ramaze only tries to
+give you the ultimate tools, but you have to use them yourself to achieve
+perfect custom-tailored results.
+
+Another one of the goals during development of Ramaze was to make every part as
+modular and therefore reusable as possible, not only to provide a basic
+understanding after the first glance, but also to make it as simple as possible
+to reuse parts of the code.
+
+The original purpose of Ramaze was to act as a kind of framework to build
+web-frameworks, this was made obsolete by the introduction of Rack, which
+provides this feature at a better level without trying to enforce any structural
+layout of the resulting framework.
+
+Today Ramaze serves as a framework for those who want to develop their projects
+in their own way rather than being forced to work in a way that the framework
+(and its creators) define. It tries not to make any assumptions and more
+importantly: it puts you back in control of your code. An example of this is the
+default file structure of new Ramaze projects.  Out of the box a new project
+uses the MVC pattern. The cool thing about Ramaze however is that you're not
+forced to use this pattern. If you prefer HMVC, PAC or something else you can
+simply apply it. Another example is the use of a database toolkit. Ramaze does
+not ship with one for a very simple reason: nobody likes the same toolkit. Some
+people prefer Sequel, others use Datamapper. With Ramaze you can use any tool
+you like.
+
+Installing Ramaze is as easy as the following command:
+
+    $ gem install ramaze
+
+For more information see the chapter {file:installation Installation}.
+
+<div class="note todo">
+    <p>
+        <strong>Note:</strong> if you spot any mistakes made such as spelling
+        errors or links not working feel free to report them on the mailing
+        list, in the IRC channel or by submitting a bug at the
+        <a href="https://github.com/ramaze/ramaze/issues">bugtracker</a>.
+    </p>
+</div>
+
+## Quick Example
+
+While Ramaze applications are usually spread across multiple directories for
+controllers, models and views one can quite easily create a very basic
+application in just a single file:
+
+    require 'ramaze'
+
+    class MyController < Ramaze::Controller
+      map '/'
+
+      def index
+        return "Hello, Ramaze!"
+      end
+    end
+
+    Ramaze.start
+
+Once this is saved in a file (you can also run this from IRB) simply execute it
+using the Ruby binary:
+
+    $ ruby hello_ramaze.rb
+
+This starts a WEBRick server listening on localhost:7000.
+
+## Requirements
+
+* Innate (which in turn requires Rack).
+* A Ruby implementation based on Ruby 1.8 or newer (1.9.2, Rubinius, etc).
+* A Rack server such as Thin or Unicorn.
+* Basic knowledge of Ruby.
+
+## License
+
+Ramaze is licensed under the MIT license, a copy of this license can be found in
+``guide/LICENSE``. If you happen to view this README using YARD (this is what
+you see on <http://ramaze.net/documentation/index.html>) you can also view this
+license by clicking the "Files" button at the top right and then clicking on the
+"LICENSE" item.
+
+## Community
+
+* \#ramaze on the Freenode IRC network
+* [Mailing list][mailing list]
+* [Website][website]
+
+When joining the IRC channel you don't have to be afraid to ask a question, just
+ask it and (hopefully) you'll get the answer you're looking for. However, keep
+in mind that most of us are located in different timezones so it may sometimes
+take a while before you get a reply.
+
+## Chapters
+
+If you're viewing this file in your editor or from Github it's likely that the
+table of contents isn't rendered. You can find all these files in the ``guide/``
+directory.
+
+* {file:general/installation Installation}
+* {file:general/upgrading Upgrading}
+* {file:general/principles Principles}
+* {file:general/special_thanks Special Thanks}
+* {file:general/contributing Contributing To Ramaze}
+* {file:general/configuration Configuration}
+* {file:general/ramaze_command Ramaze Command}
+* {file:general/controllers Controllers}
+* {file:general/models Models}
+* {file:general/views Views}
+* {file:general/helpers Helpers}
+* {file:general/middlewares Rack Middlewares}
+* {file:general/routes Routes}
+* {file:general/sessions Sessions}
+* {file:general/cache Caching Data}
+* {file:general/logging Logging Information}
+* {file:general/testing Testing Ramaze}
+
+[mailing list]: https://groups.google.com/forum/#!forum/ramaze
+[website]: http://ramaze.net/

data/Rakefile

@@ -1,195 +1,22 @@
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
+require 'rubygems'
 require 'rake'
-require 'rake/clean'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'fileutils'
+require 'date'
 require 'time'
-require 'pp'
-include FileUtils
-
-$:.unshift File.join(File.dirname(__FILE__), "lib")
-
-require 'ramaze/version'
-load 'rake_tasks/conf.rake'
-load 'rake_tasks/gem.rake'
-load 'rake_tasks/maintenance.rake'
-load 'rake_tasks/spec.rake'
-load 'rake_tasks/coverage.rake'
-
-task :default => ['spec']
-task :test => ['spec']
-task :package => ['jquery']
-
-desc 'download latest jquery and put in /lib/proto/public/js/jquery.js'
-task :jquery do
-  require 'open-uri'
-  $stdout.sync = true
-
-  File.open('lib/proto/public/js/jquery.js', 'w+') do |jquery|
-    remote = open('http://code.jquery.com/jquery-latest.js')
-    print "openend remote side, copying..."
-    while chunk = remote.read(4096)
-      print '.'
-      jquery.write(chunk)
-    end
-    puts " done."
-  end
-end
-
-desc "sanitize the code and darcs record"
-task :record => ['fix-end-spaces', 'add-copyright'] do
-  sh "darcs record"
-end
-
-desc "create the doc/changes.xml"
-task 'changes-xml' do
-  File.open('doc/changes.xml', 'w+') do |f|
-    f.print(`darcs changes --xml`)
-  end
-end
-
-desc "create the doc/changes.txt"
-task 'changes-text' do
-  File.open('doc/changes.txt', 'w+') do |f|
-    f.print(`darcs changes --human-readable`)
-  end
-end
-
-desc "create both doc/changes.txt and doc/changes.xml"
-task :changes => ['changes-xml', 'changes-text'] do
-  puts(`darcs changes`.split("\n").first(25))
-end
-
-desc "copy the doc/changes.txt to doc/CHANGELOG"
-task :changelog => :changes do
-  cp 'doc/changes.txt', 'doc/CHANGELOG'
-end
+require 'rubygems/package_task'
 
-task :rcov_dir do
-  mkdir_p 'doc/output/tools/rcov/'
-end
-
-desc "Generate HTML coverage report"
-task :rcov_summary => :rcov_dir do
-  `rcov --version`
-  raise LoadError, "Please `gem install rcov` first" if $?.exitstatus == 127
-  raise "Run `rake coverage` to generate coverage data first" unless File.exists? 'coverage.data'
-  sh "rcov --aggregate coverage.data -o doc/output/tools/rcov/"
-end
-
-desc "generate rdoc"
-task :rdoc => [:clean, :readme2html] do
-  sh "rdoc #{(RDOC_OPTS + RDOC_FILES).join(' ')}"
-end
-
-desc "generate improved allison-rdoc"
-task :allison => :clean do
-  opts = RDOC_OPTS
-  path = `allison --path`.strip
-  raise LoadError, "Please `gem install allison` first" if $?.exitstatus == 127
-  opts << %W[--template '#{path}']
-  sh "rdoc #{(RDOC_OPTS + RDOC_FILES).join(' ')}"
-end
-
-desc "create bzip2 and tarball"
-task :distribute => :gem do
-  sh "rm -rf pkg/ramaze-#{VERS}"
-  sh "mkdir -p pkg/ramaze-#{VERS}"
-  sh "cp -r {bin,doc,lib,examples,spec,Rakefile,rake_tasks} pkg/ramaze-#{VERS}/"
-
-  Dir.chdir('pkg') do |pwd|
-    sh "tar -zcvf ramaze-#{VERS}.tar.gz ramaze-#{VERS}"
-    sh "tar -jcvf ramaze-#{VERS}.tar.bz2 ramaze-#{VERS}"
-  end
+PROJECT_SPECS = Dir.glob(File.expand_path('../spec/ramaze/**/*.rb', __FILE__))
 
-  sh "rm -rf pkg/ramaze-#{VERS}"
-end
-
-desc "show a todolist from all the TODO tags in the source"
-task :todo do
-  files = Dir[File.join(BASEDIR, '{lib,spec}', '**/*.rb')]
-
-  files.each do |file|
-    lastline = todo = comment = long_comment = false
+GEMSPEC = Gem::Specification::load(
+  File.expand_path('../ramaze.gemspec', __FILE__)
+)
 
-    File.readlines(file).each_with_index do |line, lineno|
-      lineno += 1
-      comment = line =~ /^\s*?#.*?$/
-      long_comment = line =~ /^=begin/
-      long_comment = line =~ /^=end/
-      todo = true if line =~ /TODO/ and (long_comment or comment)
-      todo = false if line.gsub('#', '').strip.empty?
-      todo = false unless comment or long_comment
-      if todo
-        unless lastline and lastline + 1 == lineno
-          puts
-          puts "vim #{file} +#{lineno}"
-        end
-
-        l = line.strip.gsub(/^#\s*/, '')
-        print '  ' unless l =~ /^-/
-        puts l
-        lastline = lineno
-      end
-    end
-  end
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
 end
 
-desc "opens a simple readline that makes making requests easier"
-task 'request' do
-  ARGV.clear
-  require 'open-uri'
-  require 'pp'
-
-  loop do
-    print 'do request? [enter] '
-    gets
-    begin
-      pp open('http://localhost:7000/xxx').read
-    rescue Object => ex
-      puts ex
-    end
-  end
+Dir.glob(File.expand_path('../tasks/*.rake', __FILE__)).each do |task|
+  import task
 end
 
-desc "runs all the testdocs (not functional yet)"
-task "testdoc" do
-  require '../testdoc/lib/testdoc'
-  Dir['lib/ramaze/helper/*.rb'].each do |file|
-    p file
-    begin
-      require file
-      TestDoc.rspec_run(file)
-    rescue Object => ex
-      puts ex
-    end
-  end
-end
-
-desc 'listing of available traits per class/module'
-task 'traits' do
-  nodes = Hash.new{|h,k| h[k] = []}
-  Dir['lib/**/*.rb'].each do |file|
-    content = File.read(file)
-    traits = content.grep(/^\s*trait\s*:/)
-    traits.each do |trait|
-      space = content[0..content.index(trait)].scan(/^\s*(?:class|module)\s+(.*)$/)
-      space = space.flatten.join('::')
-      nodes[space] << trait.strip
-    end
-  end
-
-  nodes.each do |space, traits|
-    puts space
-    traits.each do |trait|
-      print '  ', trait, "\n"
-    end
-    puts
-  end
-end
+task :default => :bacon

data/bin/ramaze

@@ -1,152 +1,7 @@
 #!/usr/bin/env ruby
+begin; require 'rubygems'; rescue LoadError; end
 
-begin
-  $:.unshift File.join(File.dirname(__FILE__), '../lib')
-  require 'ramaze'
-rescue LoadError
-  $:.shift
+require File.expand_path('../../lib/ramaze'           , __FILE__)
+require File.expand_path('../../lib/ramaze/bin/runner', __FILE__)
 
-  begin
-    require 'rubygems'
-  rescue LoadError
-  end
-  require 'ramaze'
-end
-
-RAMAZE_VERSION = "Ramaze Version #{Ramaze::VERSION}"
-
-options = {:origin => :console, :create => false, :force => true}
-cli_options = Ramaze::CLI_OPTIONS
-cli_abbrevs = cli_options.map{|o| o.name.to_s}.abbrev
-
-# options occupied by custom switches
-%w[e h i].each{|key| cli_abbrevs.delete key}
-cli_abbrevs = Hash[*cli_abbrevs.select{|k,v| k.size == 1}.flatten].invert
-
-opts = OptionParser.new do |opt|
-  ruby_version = "ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  ramaze_version = "#{RAMAZE_VERSION}, on #{ruby_version}"
-
-  opt.banner = "Usage: ramaze start.rb [OPTIONS]"
-  opt.define_head ramaze_version
-
-  opt.separator ''
-  opt.separator 'Specialized options:'
-
-  opt.on('--create PROJECT', "A new application based on proto.") do |project_name|
-    options[:create] = project_name
-  end
-
-  opt.on('-eSTRING', '--execute STRING', String, "Execute string instead of a start.rb.") do |execute|
-    options[:execute] = execute
-  end
-
-  opt.on('-i', '--instant', "Start up with bare-bones Controller") do |instant|
-    options[:instant] = instant
-  end
-
-  opt.separator ''
-  opt.separator 'Global options, value in [] shows default.'
-
-  cli_options.each do |option|
-    cli_name = option.name.to_s.gsub('_', '-')
-    short_option = (option.short || cli_abbrevs[option.name.to_s])
-    short_option = "-#{short_option}" if short_option
-    long_option = '--' + cli_name
-    doc = "[#{option.cli.inspect}] #{option.doc}"
-
-    case option.cli
-    when TrueClass
-      params = [short_option, "--[no-]#{cli_name}", doc]
-    when FalseClass
-      params = [short_option, long_option, doc]
-    when Numeric
-      params = [short_option, "#{long_option} NUM", Integer, doc]
-    when String
-      params = [short_option, "#{long_option} STRING", String, doc]
-    when Array
-      index = option.cli.map(&:to_s)
-      aliases = index.abbrev
-      list = "  (#{index.join(', ')})"
-      doc = "[#{option.default.inspect}] #{option.doc}"
-
-      params = [short_option, "#{long_option} CHOICE", index, aliases, doc, list]
-    else
-      pp option
-      next
-    end
-
-    opt.on(*params.compact) do |input|
-      options[option.name] = input
-    end
-  end
-
-  opt.separator ''
-  opt.separator 'Common options:'
-
-  opt.on_tail('-h', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-
-  opt.on_tail('-v', '--version', "Show version") do
-    puts ramaze_version
-    exit
-  end
-end
-
-begin
-  opts.parse!(ARGV)
-rescue OptionParser::MissingArgument => ex
-  puts ex
-  exit 1
-end
-
-runner = (ARGV + ['start.rb']).find{|f| File.exists?(f)}
-execute = options.delete :execute
-instant = options.delete :instant
-
-if project = options.delete(:create)
-  require 'ramaze/tool/create'
-  Ramaze::Tool::Create.create(project)
-  exit
-end
-
-unless ARGV.any? or [runner, execute, instant].any?
-  abort(opts.to_s)
-end
-
-if execute
-  eval execute
-elsif not instant
-  begin
-    puts "running `#{runner}'"
-    require runner.to_s
-    options[:runner] = runner
-  rescue LoadError => ex
-    puts ex
-    puts ex.backtrace
-    puts "Maybe i cannot find `#{runner}'"
-    puts "You could provide a file to execute like:"
-    puts "$ ramaze myapp.rb"
-    exit
-  end
-end
-
-if options.delete(:console)
-  options[:run_loose] = true
-  ARGV.clear # Avoid passing args to IRB
-
-  Ramaze.start(options)
-
-  require 'irb'
-  require 'irb/completion'
-
-  def exit() Ramaze.shutdown end
-
-  ENV['IRBRC'] = ".irbrc" if File.exists? ".irbrc"
-  IRB.start
-  Ramaze.shutdown
-else
-  Ramaze.start(options)
-end
+Ramaze::Bin::Runner.run

data/examples/app/auth/layout/auth.xhtml

@@ -0,0 +1,25 @@
+<html>
+  <head>
+    <title>Auth App</title>
+    <?css
+      body { margin: 5em; padding: 1em; border: 1px soid black; }
+      ul { list-style: none; margin: 0; }
+      .error { color: red; }
+    ?>
+  </head>
+  <body>
+    <div class="header">
+      <?r if logged_in? ?>
+        #{a 'Logout', :logout}
+      <?r else ?>
+        #{a 'Login', :login}
+      <?r end ?>
+    </div>
+    <div class="content">
+      <h1>Auth App</h1>
+      #{@content}
+    </div>
+    <div class="footer">
+    </div>
+  </body>
+</html>

data/examples/app/auth/start.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'ramaze'
+
+# Small application performing authentication without a database
+
+module Auth
+  USERS = {
+    'demo'    => Digest::SHA1.hexdigest('demo'),
+    'manveru' => Digest::SHA1.hexdigest('letmein'),
+  }
+
+  class AuthController < Ramaze::Controller
+    map '/', :auth
+    app.location = '/'
+
+    helper :auth
+    layout :auth
+    trait :auth_table => USERS
+
+    before(:secret){ login_required }
+    before(:login){ redirect r('/') if logged_in? }
+  end
+end
+
+Ramaze.start

data/examples/app/auth/view/index.xhtml

@@ -0,0 +1,4 @@
+<p>
+  This is a small example application showing you how to integrate the
+  <code>Ramaze::Helper::Auth</code> into your own code.
+</p>

data/examples/app/auth/view/login.xhtml

@@ -0,0 +1,20 @@
+<div class="auth login">
+  <form method='post'>
+    <fieldset>
+      <legend>Login</legend>
+      <ul>
+        <li>
+          <label for="username">Username:</label>
+          <input type="text" name="username" id="username" />
+        </li>
+        <li>
+          <label for="password">Password:</label>
+          <input type="text" name="password" id="password" />
+        </li>
+        <li>
+          <input type="submit" value="Login" />
+        </li>
+      </ul>
+    </fieldset>
+  </form>
+</div>

data/examples/app/auth/view/secret.xhtml

@@ -0,0 +1 @@
+Something you can only see if you are logged in.

data/examples/app/blog/app.rb

@@ -0,0 +1,23 @@
+# This file contains your application, it requires dependencies and necessary
+# parts of the application.
+#
+# It will be required from either `config.ru` or `start.rb`
+
+require 'rubygems'
+require 'ramaze'
+require 'sequel'
+require 'sqlite3'
+require 'bcrypt'
+require 'rdiscount'
+
+# Make sure that Ramaze knows where you are. Without this layouts and such
+# wouldn't be rendered. While Ramaze.options.roots includes "." (the current
+# directory) you should not rely on this path as it changes depending from what
+# directory this script was called.
+Ramaze.options.roots = [__DIR__]
+
+# Initialize controllers and models
+require __DIR__('model/init')
+require __DIR__('controller/init')
+
+Ramaze::Log.info('Logging in can be done by going to /users/login')

data/examples/app/blog/config.ru

@@ -0,0 +1,19 @@
+#!/usr/bin/env rackup
+#
+# config.ru for ramaze apps
+#
+# Rackup is a useful tool for running Rack applications, which uses the
+# Rack::Builder DSL to configure middleware and build up applications easily.
+#
+# Rackup automatically figures out the environment it is run in, and runs your
+# application as FastCGI, CGI, or standalone with Mongrel or WEBrick -- all from
+# the same configuration.
+#
+# Do not set the adapter.handler in here, it will be ignored.
+# You can choose the adapter like `ramaze start -s mongrel` or set it in the
+# 'start.rb' and use `ruby start.rb` instead.
+require ::File.expand_path('../app', __FILE__)
+
+Ramaze.start(:root => Ramaze.options.roots, :started => true)
+
+run Ramaze

data/examples/app/blog/controller/init.rb

@@ -0,0 +1,30 @@
+##
+# Base controller that provides a few things used by sub controllers throughout
+# this example application.
+#
+# @since  26-09-2011
+#
+class BaseController < Ramaze::Controller
+  engine :etanni
+  layout :default
+  helper :blue_form, :user, :xhtml, :paginate
+
+  # Configures the Paginate helper so that it shows a maximum of 10 posts per
+  # page and uses the "page" query string key to determine the current page.
+  # This will result in URLs such as /posts?page=2. Note that when calling the
+  # paginate() method you can override these settings.
+  trait :paginate => {
+    :var   => 'page',
+    :limit => 10
+  }
+
+  # Tells the User helper what model class should be used for the authenticate()
+  # method. By default this is already set to "User" so technically this isn't
+  # required but to make it easier to understand what's going on I decided to
+  # put it here.
+  trait :user_model => User
+end
+
+# Load all other controllers
+require __DIR__('posts')
+require __DIR__('users')