rtml 1.2.2

data/app_generators/rtml/templates/rtml/lib/extensions/nil_class.rb

@@ -0,0 +1,20 @@
+class NilClass
+  # If this is a valid screen name, it is returned with a # preceding it.
+  # Otherwise, it is returned as-is.
+  def to_screen_ref
+    self.to_s.to_screen_ref
+  end
+  
+  # Returns true if this is a valid screen name.
+  #
+  # (It does not have to exist as a screen
+  # to be a valid screen name.)
+  def valid_screen_name?
+    self.to_s.valid_screen_name?
+  end
+  
+  # Raises an error if this is not a valid screen name.
+  def validate_screen_name
+    raise "Nil: Not a valid screen name"
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/rake.rb

@@ -0,0 +1,19 @@
+# OverrideRakeTask
+# Modified from the plugin at http://github.com/eugenebolshakov/override_rake_task.git
+module Rake
+  module TaskManager
+    def remove_task(task_name)
+      @tasks.delete(task_name.to_s)
+    end
+  end
+  
+  def Rake.remove_task(task_name)
+    Rake.application.remove_task(task_name)
+  end
+  
+  def Rake.override_task(args, &block)
+    name, deps = Rake.application.resolve_args([args])  
+    Rake.remove_task Rake.application[name].name
+    task(args, &block)
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/regexp.rb

@@ -0,0 +1,16 @@
+class Regexp
+  # Yields a MatchData object for each match found in the specified string.
+  # Returns the total number of matches found.
+  def each_match(str)
+    offset = 0
+    matches = 0
+    while (str[offset..-1] =~ self)
+      match = $~
+      matches += 1
+      offset += match.offset(0)[1]
+      yield match
+    end
+    
+    matches
+  end
+end

data/app_generators/rtml/templates/rtml/lib/extensions/string.rb

@@ -0,0 +1,37 @@
+class String
+  # Inserts a tab character at the beginning of this string and at every new line
+  # within this string
+  def indent
+    return self if self.strip.length == 0
+    "\t"+(self.strip.gsub(/(\n)/m, "\n\t"))
+  end
+  
+  # If the string is a valid screen name, it is returned with a # preceding it.
+  # Otherwise, it is returned as-is.
+  def to_screen_ref
+    return "##{self}" if self.valid_screen_name?
+    return self
+  end
+  
+  # Returns true if the string is a valid screen name.
+  #
+  # (It does not have to exist as a screen
+  # to be a valid screen name.)
+  def valid_screen_name?
+    return false if ["back", "menu", "cancel", "exit"].include? self
+    return(self.length <= 12 and self.to_s =~ /^[a-zA-Z_][a-zA-Z0-9_]*$/)
+  end
+  
+  # Raises an error if the string is not a valid screen name.
+  def validate_screen_name
+    raise "#{self}: Not a valid screen name" unless self.valid_screen_name?
+  end
+end
+
+class Symbol
+  [ :to_screen_ref, :valid_screen_name?, :validate_screen_name ].each do |method|
+    define_method method do
+      self.to_s.send(method)
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins.rb

@@ -0,0 +1,23 @@
+require 'find'
+
+configuration = nil
+
+if defined? Dependencies then configuration = Dependencies
+elsif defined? ActiveSupport::Dependencies then configuration = ActiveSupport::Dependencies
+end
+
+# autoloading of add'l plugins
+if configuration
+  path = File.join(File.dirname(__FILE__), "other_plugins")
+  Find.find(path) do |fi|
+    Find.prune if fi =~ /\.svn$/
+    unless fi == path
+      lib = File.join(fi, "lib")
+      $LOAD_PATH << lib
+      configuration.load_paths << lib
+      configuration.load_once_paths.delete(lib)
+      require File.join(fi, "init.rb")
+    end
+    Find.prune if File.directory? fi and not fi == path
+  end
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/README

@@ -0,0 +1,36 @@
+BeforeRender
+============
+
+Add a hook like before_filter to your controllers that gets executed between
+when your action is completed and the template is rendered.  It can really
+DRY up loading some data that is used for views (headers / layouts / etc).
+
+Provided methods:
+  before_render / before_render_filter / append_before_render_filter (aliases)
+  prepend_before_render_filter
+
+TODO
+====
+
+It doesn't have the skip_before_render_filter logic.
+
+ActionController::Filters::FilterChain encodes logic about the types of filters
+that exist all over the place where it could be more generic, maybe try to
+merge some of this back into rails core.
+
+Example
+=======
+
+class MyController < ApplicationController
+  before_render :load_header_image_based_on_hostname
+
+  private
+  def load_header_image_based_on_hostname
+    @header_image = HeaderImage.src_for_request(request)
+  end
+end
+
+# in the layout or view
+<img src="<%= @header_image %>" alt="header image" />
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/Rakefile

@@ -0,0 +1,44 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the before_render plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the before_render plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BeforeRender'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/init.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ActionController::Filters::Filter.send :include, FilterHasBeforeRender
+ActionController::Base.send :extend, BeforeRender
+ActionController::Base.send :include, BeforeRenderInstance
+ActionController::Filters::FilterChain.send :include, FilterChainHasManyTypesOfFilters

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/lib/action_controller/filters/before_render_filter.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class ActionController::Filters::BeforeRenderFilter < ActionController::Filters::Filter
+  def type
+    :before_render
+  end
+
+  def before_render?
+    true
+  end
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/lib/before_render.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module BeforeRender
+
+  def append_before_render_filter *filters, &block
+    filter_chain.append_filter_to_chain(filters, :before_render, &block)
+  end
+
+  def prepend_before_render_filter *filters, &block
+    filter_chain.prepend_filter_to_chain(filters, :before_render, &block)
+  end
+
+  alias :before_render_filter :append_before_render_filter
+  alias :before_render :append_before_render_filter
+
+  def skip_before_render_filter *filters
+    filter_chain.skip_filter_in_chain(*filters, &:before_render?)
+  end
+
+  def before_render_filters
+    filter_chain.select(&:before_render?).map(&:method)
+  end
+
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/lib/before_render_instance.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module BeforeRenderInstance
+  def self.included kls
+    kls.send :alias_method_chain, :render, :before_render_filter
+  end
+
+  def render_with_before_render_filter *opts
+    return nil unless run_before_render_filters
+    rv = render_without_before_render_filter(*opts)
+    return rv
+  end
+
+  private
+  def run_before_render_filters chain=self.class.filter_chain
+    chain.select{|x| x.is_a?(ActionController::Filters::BeforeRenderFilter)}.each do |filter|
+      filter.call(self)
+      if self.__send__(:performed?)
+        self.__send__(:halt_filter_chain, filter.method, :rendered_or_redirected)
+        return false
+      end
+    end
+    true
+  end
+
+end

data/app_generators/rtml/templates/rtml/lib/other_plugins/before_render/lib/filter_chain_has_many_types_of_filters.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module FilterChainHasManyTypesOfFilters
+
+  def self.included kls
+    kls.send :alias_method, :find_filter_append_position, :find_filter_append_positions_multitype
+    kls.send :alias_method, :find_filter_prepend_position, :find_filter_prepend_positions_multitype
+    kls.send :alias_method, :find_or_create_filter, :find_or_create_filter_multitype
+
+    kls.send :cattr_accessor, :filter_order
+    kls.filter_order = [
+      :before,
+      :around,
+      :before_render,
+      :after
+    ]
+  end
+
+  private
+  def map_filter_types_to_positions
+    returning({}) do |rv|
+      self.class.filter_order.each_with_index do |filter, idx|
+        rv[filter] = idx
+      end
+    end
+  end
+
+  def find_filter_append_positions_multitype filters, filter_type
+    positions = map_filter_types_to_positions
+    i = 0
+    pos = positions[filter_type]
+
+    # shortcut the last type
+    return -1 if (pos + 1) >= self.class.filter_order.length
+
+    while self[i] and p2=positions[self[i].type] and p2 <= pos
+      i += 1
+    end
+    i
+  end
+
+  def find_filter_prepend_positions_multitype filters, filter_type
+    positions = map_filter_types_to_positions
+    i = 0
+    pos = positions[filter_type]
+
+    # shortcut the first type
+    return 0 if pos == 0
+
+    while self[i] and p2=positions[self[i].type] and p2 < pos
+      i += 1
+    end
+    i
+  end
+
+  def find_or_create_filter_multitype filter, filter_type, options={}
+    update_filter_in_chain([filter], options)
+    rv = find(filter){|f| f.type == filter_type}
+    rv ||= filter_class(filter_type).new(filter_type, filter, options)
+    rv
+  end
+
+  def filter_class filter_type
+    "ActionController::Filters::#{filter_type.to_s.camelize}Filter".constantize
+  rescue
+    raise "Invalid filter class: ActionController::Filters::#{filter_type.to_s.camelize}Filter"
+  end
+end