hassox-pancake 0.1.6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Neighman
+
+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/README.textile

@@ -0,0 +1,95 @@
+__This read me is getting thrown to get there in little bits of time snatched between other bits of snatched time... it will be magnificient, eventually... please bare with it...__
+
+h3. Whats this then
+
+A tool for making pancake stacks. Where, as you know, pancake == ruby web thing.
+
+It essentially takes the awesome "rack":rack.github.com and "rack router":http://github.com/carllerche/rack-router/ and mixes it with flour and water and eggs to bind it together into a pancake thin layer of goodness providing a structured way of orgnaising (stacking) your assortment of ruby web things. In doing so, it  allows you to provide each of your ruby web things (lets call them "middlewares") with some underlying contextual functionality.
+
+h3. Why stack pancakes?
+
+Well, simply put, reuse! I'm building something... and what do you know i need another forum/asset manager/bla thing etc. Typically I can:
+
+  * Write/include the functionality directly in to my current app.
+  * Add a second app, theme it up similarly and use apache/nginx/other configs to glue it up, and perhaps come up with a devious approach for auth with some cunning SSO... or not
+
+What we'd like to facilitate with pancake is you take your existing much loved forum/asset manager/bla thing etc and mount it into pancake, sharing auth and other contextual information between apps.
+
+Insert helpful diagram here...
+
+h3. Getting Started
+
+h4. You'll need to have installed (as well as your usual ruby stuffs)...
+
+* wycats-thor 
+* Carllerches rack router
+
+h4. Installing
+
+<pre>
+  $sudo gem install hassox-pancake
+</pre>
+
+h4. Create your own stack
+
+<pre>
+  $pancake-gen stack yummy-app
+</pre>
+
+h4. Does it work?
+
+(I've used curl here, feel free to use your point your browser to http://localhost:9292/ instead)
+<pre>
+  $cd yummy-app/lib/yummy-app
+  $rackup config.ru
+  Loading Development Environment
+</pre>
+
+Now in your browser, visit http://localhost:9292/
+Or, with curl like here:
+<pre>
+  $curl -I localhost:9292
+  127.0.0.1 - - [26/Jul/2009 15:42:55] "HEAD / HTTP/1.1" 404 9 0.0011
+  HTTP/1.1 404 Not Found
+  Connection: close
+  Date: Sun, 26 Jul 2009 05:42:55 GMT
+  Content-Type: text/plain
+  Content-Length: 9
+</pre>
+
+You should see 'NOT FOUND' in your browser window and something like this appear in your rackup console window.
+
+<pre>
+  127.0.0.1 - - [26/Jul/2009 15:42:55] "GET / HTTP/1.1" 404 9 0.0011
+</pre>
+
+That 404 is good news! The stack is running.. we just haven't cooked any pancakes yet, theres nothing to find. Next step add something...
+
+h4. Routing
+
+Edit config/router.rb with:
+<pre>
+  home = lambda {|e| [200,{"Content-Type" => "text/plain", "Content-Length" => "12"}, "Welcome home" ]}
+  
+  YummyApp.add_routes do |r|
+    r.map "/", :to => home
+  end
+</pre>
+Now, restart the server (^C) and try again:
+<pre>
+  $rackup config.ru
+  Loading Development Environment
+</pre>
+Reload you page and you should see "Welcome home".
+And, in your console window, rack should log the request like so:
+<pre>
+  127.0.0.1 - - [26/Jul/2009 16:16:23] "GET / HTTP/1.1" 200 12 0.0012
+  127.0.0.1 - - [26/Jul/2009 16:16:23] "GET /favicon.ico HTTP/1.1" 200 12 0.0012
+</pre>
+
+h4. Whats next:
+
+Well we don't want to be writing our apps as lambdas jemmied into the router, instead next we start to build stacks, out of other middlewares... merbs, other pancake stacks, some sinatra, more rack ups or what ever.
+
+To be continued...
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pancake"
+    gem.summary = %Q{Eat Pancake Stacks for Breakfast}
+    gem.description = %Q{Eat Pancake Stacks for Breakfast}
+    gem.email = "has.sox@gmail.com"
+    gem.homepage = "http://github.com/hassox/pancake"
+    gem.authors = ["Daniel Neighman"]
+    gem.add_development_dependency "rspec"
+    gem.add_dependency "usher", ">=0.5.5"
+    gem.add_dependency "mynyml-rack-accept-media-types"
+    gem.require_path = 'lib'
+    gem.autorequire = 'pancake'
+    gem.bindir = "bin"
+    gem.executables = %w( pancake-gen )
+    gem.files = %w(LICENSE README.textile Rakefile TODO) + Dir.glob("{lib,spec,bin}/**/{*,.[a-z]*}")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = %w(--format progress --color)
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pancake #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,18 @@
+TODO:
+
+Controller Publish Declaration:
+  Allow requirements to be declared for multiple controllers at once
+  Support syntax for coercing multiple values into a single param entry i.e. two date strings into a range
+  Default values should be generated with a method rather than a static value alone
+  The list of params should be able to be flagged as exclusive i.e. no additional parameters may be passed in
+  Handle nested params
+  Collect options suitable for a OPTIONS request from a client
+  Mechanism to whitelist fields from a model
+  
+Renderable Mixin
+  Design interface for adapters -- adapters allow support for different template libs
+  Compiled templates need to be cached
+  Options used by the mixin need to be configurable
+  Templates should be inheritable
+  The target class should be able to inject arbitrary helpers into the template context
+  Layouts, views and partials should be supported

data/bin/jeweler

@@ -0,0 +1,19 @@
+#!/opt/local/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'jeweler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'jeweler', version
+load Gem.bin_path('jeweler', 'jeweler', version)

data/bin/pancake-gen

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'thor/runner'
+require 'pancake/generators'
+
+# TODO update for pancake to have a version
+case ARGV.shift
+when "stack"
+  Pancake::Generators::Stack.start
+when "short"
+  Pancake::Generators::Short.start
+when "flat"
+  Pancake::Generators::Flat.start
+else
+  puts "Unknown Generator"
+end

data/bin/rubyforge

@@ -0,0 +1,19 @@
+#!/opt/local/bin/ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'rubyforge' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
+  version = $1
+  ARGV.shift
+end
+
+gem 'rubyforge', version
+load Gem.bin_path('rubyforge', 'rubyforge', version)

data/lib/pancake.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'extlib/class'
+require 'extlib/boolean'
+require 'extlib/module'
+require 'extlib/nil'
+require 'extlib/numeric'
+require 'extlib/object'
+require 'extlib/symbol'
+require 'extlib/blank'
+require "extlib/dictionary"
+require 'usher'
+require 'usher/interface/rack_interface'
+require 'tilt'
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'pancake/paths'
+require 'pancake/hooks/on_inherit'
+require 'pancake/hooks/inheritable_inner_classes'
+require 'pancake/core_ext/class'
+require 'pancake/core_ext/object'
+require 'pancake/core_ext/symbol'
+require 'pancake/configuration'
+require 'pancake/bootloaders'
+require 'pancake/mime_types'
+require 'pancake/middleware'
+require 'pancake/router'
+require 'pancake/master'
+require 'pancake/errors'
+require 'pancake/stack/stack'
+require 'pancake/stack/configuration'
+require 'pancake/stack/router'
+require 'pancake/stack/bootloader'
+require 'pancake/stack/app'
+require 'pancake/mixins/request_helper'
+
+module Pancake
+
+  module Stacks
+    autoload :Short,    "pancake/stacks/short"
+  end
+
+  module Mixins
+    autoload :Publish,      "pancake/mixins/publish"
+    autoload :Render,       "pancake/mixins/render"
+    autoload :StackHelper, "pancake/mixins/stack_helper"
+  end
+end

data/lib/pancake/bootloaders.rb

@@ -0,0 +1,180 @@
+require 'set'
+module Pancake
+  module BootLoaderMixin
+    include Enumerable
+    class Base
+      # :api: :public
+      attr_accessor :config
+      
+      # Sets options for the bootloder
+      # By including conditions in the bootloader when you declare it
+      # You can selectively run bootloaders later
+      # :api: private
+      def self.options=(opts={}) # :nodoc:
+        @options = opts
+        @options[:level] ||= :default
+      end
+      
+      # Provides access to the bootloader options
+      # :api: private
+      def self.options # :nodoc:
+        @options ||= {}
+      end
+      
+      def stack
+        raise "No Stack Configured" unless @config[:stack]
+        @config[:stack]
+      end
+      
+      def stack_class
+        raise "No Stack Class Configured" unless @config[:stack_class]
+        @config[:stack_class]
+      end
+      
+      def initialize(config)
+        @config = config
+      end
+      
+      # Creates a new instance and runs it
+      # :api: private
+      def self.call(config)
+        new(config).run!
+      end
+      
+      # Checks the conditions with the options of the bootloader
+      # To see if this one should be run
+      # Only the central bootloaders with the conditions will be checked
+      # :api: private
+      def self.run?(conditions = {}) 
+        opts = options
+        if conditions.keys.include?(:only)
+          return conditions[:only].all?{|k,v| opts[k] == v}
+        end
+        if conditions.keys.include?(:except)
+          return conditions[:except].all?{|k,v| opts[k] != v}
+        end
+        true
+      end
+    end
+    
+    def self.extended(base)
+      base.class_eval do
+        class_inheritable_reader :_bootloaders, :_central_bootloaders, :_bootloader_map
+        @_bootloaders, @_central_bootloaders = {}, []
+        @_bootloader_map = Hash.new{|h,k| h[k] = {:before => [], :after => []}}
+      end
+    end
+    
+    # Provides access to an individual bootloader
+    # :api: public
+    def [](name)
+      _bootloaders[name]
+    end
+    
+    # Add a bootloader.  Inside the block we're inside a class definition.  
+    # Requirements: define a +run!+ method
+    #
+    # Example
+    #   FooStack::BootLoader.add(:foo) do
+    #     def run!
+    #       # stuff
+    #     end
+    #   end
+    # 
+    # :api: public
+    def add(name, opts = {}, &block)
+      _bootloaders[name] = Class.new(Pancake::BootLoaderMixin::Base, &block)
+      raise "You must declare a #run! method on your bootloader" unless _bootloaders[name].method_defined?(:run!)
+      before = opts[:before]
+      after  = opts[:after]
+      
+      if opts[:level]
+        levels << opts[:level]
+        levels.uniq!
+      end
+      
+      # If there are no before or after keys, add it to the central bootloaders
+      if before
+        _bootloader_map[before][:before] << name
+      elsif after
+        _bootloader_map[after][:after] << name
+      else
+        _central_bootloaders << name unless _central_bootloaders.include?(name)
+      end
+      _bootloaders[name].options = opts
+      _bootloaders[name]
+    end      
+    
+    # Runs the bootloaders in order
+    # :api: private 
+    def run!(options = {}) # :nodoc:
+      unless options.keys.include?(:only) || options.keys.include?(:except)
+        options[:only] = {:level => :default}
+      end
+      conditions = if options[:only]
+        {:only => options.delete(:only)}
+      else
+        {:except => options.delete(:except)}
+      end
+      options[:stack_class] ||= stack
+
+      each(conditions) do |name, bl|
+        bl.call(options)
+      end
+    end
+    
+    # Set the stack that this bootloader is responsible for.
+    # :api: private
+    def stack=(stack) # :nodoc:
+      @stack = stack
+    end
+    
+    # Access to the stack that this bootloader is responsible for
+    # :api: public
+    def stack
+      @stack ||= Object.full_const_get(self.name.split("::")[0..-2].join("::"))
+    end
+    
+    # Resets the bootloaders on the stack
+    # :api: public
+    def reset!
+      _central_bootloaders.clear
+      _bootloaders.clear
+      _bootloader_map.clear
+    end
+    
+    # Yields each bootloader in order along with it's name
+    # 
+    # Example
+    #   FooStack::BootLoader.each do |name, bootloader|
+    #     # do stuff
+    #   end
+    # 
+    # :api: public
+    def each(conditions = {})
+      _map_bootloaders(_central_bootloaders, conditions).each do |n|
+        yield n, _bootloaders[n]
+      end
+    end
+    
+    private
+    # Map out the bootloaders by name to run.
+    # :api: private
+    def _map_bootloaders(*names)
+      conditions = Hash === names.last ? names.pop : {}
+      names.flatten.map do |name|
+        if _bootloaders[name].run?(conditions)
+          r = []
+          r << _map_bootloaders(_bootloader_map[name][:before])
+          r << name
+          r << _map_bootloaders(_bootloader_map[name][:after])
+        end
+      end.flatten.compact
+    end
+    
+    def levels
+      @levels ||= [:default]
+    end
+
+  end # BootLoaders
+end # Pancake