ramaze 2012.12.08b → 2023.01.06

data/guide/general/sessions.md

@@ -138,6 +138,12 @@ To make it easier to display flash based messages you can use
 {Ramaze::Helper::Flash#flashbox}. You can load this helper by calling
 ``helper(:flash)`` inside your controller.
 
+Displaying the flashbox is then as simple as :
+
+    #{flashbox}
+
+anywhere in your layouts or views.
+
 To change the markup of the flashbox' HTML you can use the following trait
 inside your controller:
 
@@ -166,3 +172,39 @@ displayed because the flash data isn't there yet. As soon as the client visits
 "Hello, Ramaze!" would be displayed. Refreshing the page would clear the flash
 data and the message would no longer be displayed until the client visits
 /set\_message again.
+
+In the above example, the content of the flash is returned by a method in the
+controller. However, the most common scenario is to address the flash object
+directly in the layouts or viems. You can display flash data (in your
+layout for instance), just like any other variable :
+
+    #{flash[:message]}
+
+and you can use any key in flash, and display in a view or in a layout
+afterwards (no just :message of course).
+
+For instance, let's say you want to display information boxes at the top of your
+layout page. This information is displayed when an operation succeeds, fails, or
+when you just want to inform the user. You can easily take advantage of your key
+values and use them as css selectors like that :
+
+    ....
+    <div>
+      <!-- flash -->
+      <?r [:success, :error, :info].each do |type| ?>
+        <?r if flash[type] ?>
+
+          <div class="alert alert-block alert-#{type} fade in">
+            <a class="close" data-dismiss="alert" href="#">×</a>
+            <h4 class="alert-heading">#{ type.capitalize }</h4>
+            #{flash[type]}
+          </div>
+
+        <?r end ?>
+      <?r end ?>
+
+      #{@content}
+
+    </div>
+    ...
+

data/guide/general/upgrading.md

@@ -0,0 +1,85 @@
+# @title Upgrading
+# Upgrading
+
+Ramaze strives to be backwards compatible between each release. However, some
+releases may contain changes that are *not* backwards compatible. This document
+describes the steps required to upgrade between these releases.
+
+## Upgrading to Ramaze 2012.12.08
+
+Ramaze 2012.12.08 is **not** backwards compatible with previous releases due
+to changes made in Innate 2012.12.
+
+### Middleware
+
+In previous versions one could add Rack middleware using `Ramaze.middleware!`.
+This method has been renamed to `Ramaze.middleware` (without the `!`) and its
+use has been changed. Instead of calling `run Ramaze.middleware` one now has to
+use `run Ramaze.core`.
+
+An example of the old way of defining middleware:
+
+    Ramaze.middleware! :dev do |m|
+      m.use Rack::Lint
+      m.run Ramaze.middleware
+    end
+
+The new way of defining middleware:
+
+    Ramaze.middleware :dev do
+      use Rack::Lint
+      run Ramaze.core
+    end
+
+### Commands
+
+Various executable commands such as `ramaze start` and `ramaze console` have
+been removed in favour of the use of Rake tasks. For existing projects that do
+not have these Rake tasks you'll have to import them manually, new projects
+will have these tasks automatically. These tasks are located [here][rake
+tasks].
+
+These commands were removed as they contained a lot of old and rotting code
+without any tests. Some of them, such as `ramaze start` weren't very useful
+either as most people will use the commands for their webservers (e.g. Thin)
+instead. The use of Rake tasks also makes it possible for people to customize
+these to their liking.
+
+### Snippets
+
+Ramaze ships with various snippets that extend various core Ruby classes. In
+Ramaze 2012.12.08 a lot of these snippets have been removed. A list of all the
+removed snippets can be found [here][removed snippets].
+
+### Loggers
+
+The following logging classes are no longer available:
+
+* Ramaze::Logger::Growl
+* Ramaze::Logger::Analogger
+* Ramaze::Logger::Knotify
+* Ramaze::Logger::Xosd
+
+### Helpers
+
+The following helpers have been removed:
+
+* Ramaze::Helper::Disqus
+* Ramaze::Helper::Ultraviolet
+
+### Core classes
+
+The following core classes have been removed:
+
+* Ramaze::AppGraph
+* Ramaze::Plugin
+* Ramaze::MiddlewareCompiler (alias of Innate::MiddlewareCompiler)
+
+### Prototypes
+
+The prototype generated by `ramaze create` has been changed. It contains a set
+of Rake tasks, a README, a Gemfile and some other small changes compared to the
+previous prototype. Existing projects are not affected.
+
+[rake tasks]: https://github.com/Ramaze/ramaze/blob/master/lib/proto/task/ramaze.rake
+[removed snippets]: https://github.com/Ramaze/ramaze/commit/7e966dcdec50d490eb828f7673f101b1a6b087b3

data/lib/proto/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem 'ramaze', '>= 2.0.0'
+gem 'ramaze'
 gem 'rake'

data/lib/ramaze/cache/memcache.rb

@@ -10,7 +10,7 @@ module Ramaze
     ##
     # Cache driver for the Memcache storage engine. Memcache is a key/value
     # store that's extremely useful for caching data such as views or API
-    # responses. More inforamtion about Memcache can be found on it's website:
+    # responses. More information about Memcache can be found on it's website:
     # <http://memcached.org/>.
     #
     # Note that this cache driver requires the Dalli gem rather than Memcache
@@ -21,7 +21,7 @@ module Ramaze
     # operate but you won't get the nice speed boost.
     #
     # This driver works similar to Ramaze::Cache::Sequel in that it allows you
-    # to specify instance specific options uisng the using() method:
+    # to specify instance specific options using the using() method:
     #
     #     Ramaze::Cache.options.session = Ramaze::Cache::MemCache.using(
     #       :compression => false
@@ -203,7 +203,7 @@ module Ramaze
       #  specified key.
       # @return [Mixed]
       #
-      def cache_store(key, value, ttl = nil, options = {})
+      def cache_store(key, value, options = {})
         ttl = options.delete(:ttl) || @options[:expires_in]
 
         if ttl > MAX_TTL

data/lib/ramaze/cache/moneta.rb

@@ -0,0 +1,143 @@
+require 'moneta'
+
+module Ramaze
+  class Cache
+    ##
+    # The Moneta cache is a cache driver for Moneta (http://github.com/minad/moneta). Moneta is a
+    # unified interface to key/value stores.
+    #
+    # The usage of this cache is very similar to the Memcache driver. You load
+    # it by simply specifying the class:
+    #
+    #     Ramaze::Cache.options.session = Ramaze::Cache::Moneta
+    #
+    # If you want to specify custom options you can do so by calling {.using} on
+    # the class:
+    #
+    #     Ramaze::Cache.options.session = Ramaze::Cache::Moneta.using(...)
+    #
+    # @example Configuring the Moneta backend
+    #  Ramaze::Cache.options.names.push(:moneta)
+    #  Ramaze::Cache.options.moneta = Ramaze::Cache::Moneta.using(
+    #    :adapter => :File,
+    #    :dir => './ramaze-cache'
+    #  )
+    #
+    # @author Daniel Mendler
+    #
+    class Moneta
+      include Cache::API
+      include Innate::Traited
+
+      # Hash containing all the default options to use when no custom ones are
+      # specified in .using().
+      trait :default => {
+        :expires_in => 604800,
+        :adapter => :Memory,
+      }
+
+      # Hash containing all the default options merged with the user specified
+      # ones.
+      attr_accessor :options
+
+      class << self
+        attr_accessor :options
+
+        ##
+        # Creates a new instance of the cache class and merges the default
+        # options with the custom ones.
+        #
+        # Using this method you can specify custom options for various caches.
+        # For example, the Moneta cache for your sessions could be located at
+        # server #1 while a custom cache is located on server #2.
+        #
+        # @author Daniel Mendler
+        # @param  [Hash] options A hash containing custom options.
+        # @option options [Fixnum] :expires_in The default time after which a
+        #  key should expire.
+        # @option options [Symbol] :adapter Moneta adapter
+        #
+        def using(options = {})
+          merged = Ramaze::Cache::Moneta.trait[:default].merge(options)
+          Class.new(self) { @options = merged }
+        end
+      end # class << self
+
+      ##
+      # Creates a new instance of the cache and merges the options if they
+      # haven't already been set.
+      #
+      # @author Daniel Mendler
+      # @param  [Hash] options A hash with custom options. See
+      #  Ramaze::Cache::Moneta.using() and the trait :default for more
+      #  information.
+      #
+      def initialize(options = {})
+        self.class.options ||=
+          Ramaze::Cache::Moneta.trait[:default].merge(options)
+
+        @options = options.merge(self.class.options)
+      end
+
+      ##
+      # Prepares the cache by setting up the prefix and loading Moneta.
+      #
+      # @author Daniel Mendler
+      #
+      def cache_setup(*args)
+        opts = options.dup
+        opts[:prefix] = ['ramaze', *args].compact.join(':')
+        opts[:expires] = opts.delete(:expires_in)
+        adapter = opts.delete(:adapter)
+        @moneta = ::Moneta.new(adapter, options)
+      end
+
+      ##
+      # Clears the entire cache.
+      #
+      # @author Daniel Mendler
+      #
+      def cache_clear
+        @moneta.clear
+      end
+
+      ##
+      # Removes a number of keys from the cache.
+      #
+      # @author Daniel Mendler
+      # @param  [Array] keys An array of key names to remove.
+      #
+      def cache_delete(*keys)
+        keys.each {|key| @moneta.delete(key) }
+      end
+
+      ##
+      # Retrieves the value of the given key. If no value could be retrieved the
+      # default value (set to nil by default) will be returned instead.
+      #
+      # @author Daniel Mendler
+      # @param  [String] key The name of the key to retrieve.
+      # @param  [Mixed] default The default value.
+      # @return [Mixed]
+      #
+      def cache_fetch(key, default = nil)
+        @moneta.fetch(key, default)
+      end
+
+      ##
+      # Stores a new value under the given key.
+      #
+      # @author Daniel Mendler
+      # @param  [String] key The name of the key to store.
+      # @param  [Mixed] value The value of the key.
+      # @param  [Fixnum] ttl The Time To Live of the key.
+      # @param  [Hash] options A hash containing key specific options.
+      # @option options :expires_in The time after which the key should expire.
+      #
+      def cache_store(key, value, options = {})
+        options[:expires] = options.delete(:ttl) || @options[:expires_in]
+        @moneta.store(key, value, options)
+      end
+    end # Moneta
+  end # Cache
+end # Ramaze

data/lib/ramaze/cache/redis.rb

@@ -1,4 +1,4 @@
-require 'redis'
+require 'redis-namespace'
 
 module Ramaze
   class Cache
@@ -102,8 +102,8 @@ module Ramaze
         options[:namespace] = [
           'ramaze', hostname, username, appname, cachename
         ].compact.join(':')
-
-        @client = ::Redis.new(options)
+        redis_connection = ::Redis.new
+        @client = ::Redis::Namespace.new(options[:namespace], redis: redis_connection)
       end
 
       ##
@@ -123,7 +123,7 @@ module Ramaze
       # @param  [Array] keys An array of key names to remove.
       #
       def cache_delete(*keys)
-        @client.del(*keys.map{|key| namespaced_key(key) })
+        @client.del(*keys)
       end
 
       ##
@@ -136,7 +136,7 @@ module Ramaze
       # @return [Mixed]
       #
       def cache_fetch(key, default = nil)
-        value = @client.get(namespaced_key(key))
+        value = @client.get(key)
         value.nil? ? default : ::Marshal.load(value)
       end
 
@@ -150,17 +150,14 @@ module Ramaze
       # @param  [Hash] options A hash containing key specific options.
       # @option options :expires_in The time after which the key should expire.
       #
-      def cache_store(key, value, ttl = nil, options = {})
+      def cache_store(key, value, options = {})
         ttl = options[:ttl] || @options[:expires_in]
 
-        @client.setex(namespaced_key(key), ttl, ::Marshal.dump(value))
+        @client.setex(key, ttl, ::Marshal.dump(value))
 
         return value
       end
-
-      def namespaced_key(key)
-        [options[:namespace], key].join(':')
-      end
+      
     end # Redis
   end # Cache
 end # Ramaze

data/lib/ramaze/cache/sequel.rb

@@ -108,13 +108,13 @@ module Ramaze
         #  should be set to an integer representing the number of seconds before
         #  a cache item becomes invalidated.
         # @option options [TrueClass] :display_warnings When this option is set
-        #  to true, failure to serialiaze or deserialize cache items will produce
+        #  to true, failure to serialize or de-serialize cache items will produce
         #  a warning in the Ramaze log. This option is set to false by default.
         #  Please note that certain objects (for instance Procs) cannot be
         #  serialized by ruby and therefore cannot be cached by this cache class.
         #  Setting this option to true is a good way to find out if the stuff you
         #  are trying to cache is affected by this. Failure to
-        #  serialize/deserialize a cache item will never raise an exception, the
+        #  serialize/de-serialize a cache item will never raise an exception, the
         #  item will just remain uncached.
         # @return [Object]
         #

data/lib/ramaze/cache.rb

@@ -12,6 +12,7 @@ module Ramaze
     autoload :MemCache,      'ramaze/cache/memcache'
     autoload :Sequel,        'ramaze/cache/sequel'
     autoload :Redis,         'ramaze/cache/redis'
+    autoload :Moneta,        'ramaze/cache/moneta'
 
     ##
     # Overwrites {Innate::Cache#initialize} to make cache classes application

data/lib/ramaze/files.rb

@@ -52,7 +52,7 @@ module Ramaze
     # @since  14-03-2009
     #
     def sync
-      file_apps = @roots.map { |root| Rack::File.new(root) }
+      file_apps = @roots.map { |root| Rack::Files.new(root) }
       @cascade  = Rack::Cascade.new(file_apps)
     end
   end # Files

data/lib/ramaze/helper/paginate.rb

@@ -226,6 +226,11 @@ module Ramaze
 
           action = Current.action
           params = request.params.merge(@var.to_s => n)
+          params.keys.each do |p|
+            if params[p].is_a?(Array) and not p.end_with?('[]')
+              params["#{p}[]"] = params.delete(p)
+            end
+          end
           hash[:href] = action.node.r(action.path, params)
 
           g.a(hash){ text }

data/lib/ramaze/helper/request_accessor.rb

@@ -1,12 +1,14 @@
+require 'rack/request'
 module Ramaze
   module Helper
     module RequestAccessor
-      classes = [Rack::Request, Innate::Request, Ramaze::Request]
+      classes = [Rack::Request, Rack::Request::Helpers, Rack::Request::Env, Innate::Request, Ramaze::Request]
       methods = classes.map { |klass|
         klass.instance_methods(false)
       }.flatten.uniq
 
       methods.each do |method|
+        next if method == :intialize
         if method =~ /=/
           eval("def %s(a) request.%s a; end" % [method, method])
         else

data/lib/ramaze/helper/stack.rb

@@ -7,7 +7,7 @@ module Ramaze
     # Provides an call/answer mechanism, this is useful for example in a
     # login-system.
     #
-    # It is basically good to redirect temporarly somewhere else without
+    # It is basically good to redirect temporarily somewhere else without
     # forgetting where you come from and offering a nice way to get back
     # to the last urls.
     #

data/lib/ramaze/helper/upload.rb

@@ -2,7 +2,7 @@ module Ramaze
   module Helper
     ##
     # Helper module for handling file uploads. File uploads are mostly handled
-    # by Rack, but this helper adds some conveniance methods for handling
+    # by Rack, but this helper adds some convenience methods for handling
     # and saving the uploaded files.
     #
     # @example

data/lib/ramaze/log/syslog.rb

@@ -19,7 +19,7 @@ module Ramaze
       ALIASES = {:dev => :debug, :warn => :warning, :error => :err}
 
       ##
-      # Open the syslog library, if it is allready open, we reopen it using the
+      # Open the syslog library, if it is already open, we reopen it using the
       # new argument list. The argument list is passed on to the Syslog library
       # so please check that, and man syslog for detailed information.
       #

data/lib/ramaze/request.rb

@@ -3,7 +3,7 @@
 module Ramaze
   ##
   # The purpose of this class is to act as a simple wrapper for Rack::Request
-  # and provide some convinient methods for our own use.
+  # and provide some convenient methods for our own use.
   class Request < Innate::Request
     ##
     # you can access the original @request via this method_missing,
@@ -105,7 +105,7 @@ module Ramaze
     end
     alias inspect to_s
 
-    # Pretty prints current action with parameters, cookies and enviroment
+    # Pretty prints current action with parameters, cookies and environment
     # variables.
     def pretty_print(pp)
       pp.object_group(self) do

data/lib/ramaze/snippets.rb

@@ -4,7 +4,6 @@
 require 'ramaze/snippets/blankslate'
 require 'ramaze/snippets/object/__dir__'
 require 'ramaze/snippets/ramaze/deprecated'
-require 'ramaze/snippets/ramaze/lru_hash'
 require 'ramaze/snippets/string/camel_case'
 require 'ramaze/snippets/string/color'
 require 'ramaze/snippets/string/esc'

data/lib/ramaze/version.rb

@@ -1,3 +1,5 @@
 module Ramaze
-  VERSION = '2012.12.08b'
+  VERSION = Gem::Specification.load(
+    File.expand_path('../../../ramaze.gemspec', __FILE__)
+  ).version.to_s
 end

data/lib/ramaze/view/nagoro/render_partial.rb

@@ -5,7 +5,7 @@ module Nagoro
     # Pipe that transforms <render /> tags.
     #
     # the src parameter in the render tag will be used as first parameter to
-    # render_partial, all other paramters are passed on as +variables+.
+    # render_partial, all other parameters are passed on as +variables+.
     #
     # Example calling render_partial('hello'):
     #   <render src="hello" />

data/lib/ramaze.rb

@@ -61,7 +61,7 @@ module Ramaze
     roots, publics = options[:roots], options[:publics]
 
     joined  = roots.map { |r| publics.map { |p| File.join(r, p) } }
-    joined  = joined.flatten.map { |p| Rack::File.new(p) }
+    joined  = joined.flatten.map { |p| Rack::Files.new(p) }
     current = Current.new(Route.new(AppMap), Rewrite.new(AppMap))
 
     return Rack::Cascade.new(joined << current, [404, 405])

data/ramaze.gemspec

@@ -1,10 +1,6 @@
-require File.expand_path('../lib/ramaze/version', __FILE__)
-
-path = File.expand_path('../', __FILE__)
-
 Gem::Specification.new do |s|
   s.name        = 'ramaze'
-  s.version     = Ramaze::VERSION
+  s.version     = '2023.01.06'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.authors     = ['Michael \'manveru\' Fellinger', 'Yorick Peterse']
   s.email       = ['m.fellinger@gmail.com', 'yorickpeterse@gmail.com']
@@ -13,43 +9,51 @@ Gem::Specification.new do |s|
   s.description = s.summary
 
   s.required_rubygems_version = '>= 1.3.5'
-  s.files                     = `cd #{path}; git ls-files`.split("\n").sort
-  s.has_rdoc                  = 'yard'
+  s.files = (
+    Dir['{bin,examples,guide,lib,spec,tasks}/**/*'] |
+    %w[Gemfile Rakefile README.md ramaze.gemspec]
+  ).sort
+
   s.executables               = ['ramaze']
 
-  s.add_dependency 'innate', '>= 2012.12'
+  s.add_dependency 'innate', '>= 2023.01.05'
   s.add_dependency 'rake'
 
-  s.add_development_dependency 'Remarkably'
   s.add_development_dependency 'bacon'
+  s.add_development_dependency 'bluecloth'
   s.add_development_dependency 'dalli'
   s.add_development_dependency 'erector'
   s.add_development_dependency 'erubis'
   s.add_development_dependency 'ezamar'
   s.add_development_dependency 'haml'
-  s.add_development_dependency 'hpricot'
   s.add_development_dependency 'liquid'
   s.add_development_dependency 'locale'
   s.add_development_dependency 'maruku'
+  s.add_development_dependency 'moneta'
   s.add_development_dependency 'mustache'
-  s.add_development_dependency 'rack-contrib'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rdiscount'
-  s.add_development_dependency 'redis'
+  s.add_development_dependency 'redis-namespace'
+  s.add_development_dependency 'Remarkably'
   s.add_development_dependency 'sass'
   s.add_development_dependency 'sequel'
   s.add_development_dependency 'slim'
   s.add_development_dependency 'slippers'
-  s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'tagz'
   s.add_development_dependency 'tenjin'
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'localmemcache'
 
   if RUBY_VERSION.to_f >= 1.9
     s.add_development_dependency 'lokar'
   end
 
+  # C extensions don't work reliably on jruby and Travis CI doesn't have them
+  # enabled.
+  if !RUBY_DESCRIPTION.include?('jruby')
+    s.add_development_dependency 'nokogiri'
+    s.add_development_dependency 'rdiscount'
+    s.add_development_dependency 'sqlite3'
+  end
+
   # Nagoro doesn't seem to work on Rbx
   if !RUBY_DESCRIPTION.include?('rubinius')
     s.add_development_dependency 'nagoro'

data/spec/ramaze/cache/moneta.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../../../../spec/helper', __FILE__)
+spec_require 'moneta'
+
+describe Ramaze::Cache::Moneta do
+  Ramaze.options.cache.names   = [:one, :two]
+  Ramaze.options.cache.default = Ramaze::Cache::Moneta
+  Ramaze.setup_dependencies
+
+  cache = Ramaze::Cache.one
+  hello = 'Hello, World!'
+
+  should 'store without ttl' do
+    cache.store(:hello, hello).should == hello
+  end
+
+  should 'fetch' do
+    cache.fetch(:hello).should == hello
+  end
+
+  should 'delete' do
+    cache.delete(:hello)
+    cache.fetch(:hello).should == nil
+  end
+
+  should 'delete two key/value pairs at once' do
+    cache.store(:hello, hello).should == hello
+    cache.store(:ramaze, 'ramaze').should == 'ramaze'
+    cache.delete(:hello, :ramaze)
+    cache.fetch(:hello).should == nil
+    cache.fetch(:innate).should == nil
+  end
+
+  should 'store with ttl' do
+    cache.store(:hello, @hello, :ttl => 1)
+    cache.fetch(:hello).should == @hello
+    sleep 2
+    cache.fetch(:hello).should == nil
+  end
+
+  should 'clear' do
+    cache.store(:hello, @hello)
+    cache.fetch(:hello).should == @hello
+    cache.clear
+    cache.fetch(:hello).should == nil
+  end
+
+  should 'use a custom set of options' do
+    klass = Ramaze::Cache::Moneta.using(:answer => 42)
+
+    klass.options[:answer].should     == 42
+    klass.new.options[:answer].should == 42
+  end
+end

data/spec/ramaze/cache/redis.rb

@@ -3,7 +3,7 @@ spec_require 'redis'
 
 spec_precondition 'redis is running' do
   cache = Redis.new
-  cache['active'] = true
+  "OK" == cache.set('testkey', 'testval')
 end
 
 describe Ramaze::Cache::Redis do

data/spec/ramaze/cache/sequel.rb

@@ -2,6 +2,8 @@
 # All files in this distribution are subject to the terms of the MIT license.
 
 require File.expand_path('../../../../spec/helper', __FILE__)
+
+spec_require 'sqlite3'
 spec_require 'sequel'
 
 DB = Sequel.sqlite(':memory:')