airbed 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-08-11
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Lachie Cox
+
+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/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/airbed.rb
+lib/airbed/version.rb
+scripts/txt2html
+setup.rb
+test/test_airbed.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml
+examples/faces.rb

data/README.txt

@@ -0,0 +1,5 @@
+Airbed makes camping restful.
+
+Airbed works in much the same way that rails maps HTTP verbs (GET,POST,PUT and DELETE) onto CRUDdy actions (list, show, create, update, delete, (plus those two also-rans new and edit)).
+
+However it goes a little deeper to provide default implementations and hooks for the CRUD actions.

data/Rakefile

@@ -0,0 +1,125 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'airbed', 'version')
+
+AUTHOR = 'Lachie Cox'  # can also be an array of Authors
+EMAIL = "lachie@smartbomb.com.au"
+DESCRIPTION = "airbed makes camping restful"
+GEM_NAME = 'airbed' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'rails-oceania' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "airbed"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Airbed::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'airbed documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [ ['camping', '>= 1.5'] ]
+  
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/examples/faces.rb

@@ -0,0 +1,91 @@
+require 'airbed'
+# require File.dirname(__FILE__)+'/../lib/airbed'
+
+Camping.goes :Faces
+
+module Faces
+  module Models
+    class Person < Base; end
+  end
+  
+  module Controllers
+    include Airbed::Resources
+    
+    class Index < R '/'
+      def get
+        redirect People
+      end
+    end
+    
+    class People < Resource Models::Person
+      def after_modification(instance)
+        redirect(People)
+      end
+    end
+  end
+
+  module Views
+    # TODO make this work using
+    # include Airbed::Views
+    def form(options={})
+      verb = method = options[:method] || :post
+      options[:method] = :post unless [:get,:post].include? method.to_sym
+    
+      tag!(:form, options) {
+        input(:type => 'hidden', :name => '_verb', :value => verb)
+        yield
+      }
+    end
+    
+    def _button(text,href,method=:post)
+      form(:action => href, :method => method) {
+        input :type => 'submit', :value => text
+      }
+    end
+    
+    def list_people
+      h1 'ppl!'
+      ul {
+        @people.each {|person|
+          li { a person.name, :href => R(People,person) }
+          _button('x',R(People,person),:delete)
+        }
+      }
+      
+      form( :action => R(People), :method => 'post') {
+        input :name => 'person[name]'
+        input :type => 'submit', :value => '+'
+      }
+    end
+    
+    def show_person
+      h1 @person.name
+      
+      form(:action => R(People,@person), :method => :put) {
+        input :name => 'person[name]', :value => @person.name
+        input :type => 'submit', :value => 'save'
+      }
+      a(:href => R(People)) {"&larr; people"}
+    end
+  end
+  
+  
+  # schema
+  module Models
+    class CreateTheBasics < V 1.0
+      def self.up
+        create_table :faces_people do |t|
+          t.column :name, :string
+        end
+      end
+    end  
+  end
+  
+end
+
+def Faces.create
+  Faces::Models.create_schema
+end
+
+
+  

data/lib/airbed.rb

@@ -0,0 +1,279 @@
+require 'camping'
+require 'airbed/version'
+
+module Airbed
+  # The Airbed::Resources module is designed to be mixed into your Controllers module.
+  # 
+  # == Getting Started
+  #
+  # To let your controllers be restful
+  #
+  # 1. <tt>require 'rubygems'</tt>
+  # 2. <tt>require 'airbed'</tt>
+  # 3. Mixin airbed: <tt>module YourApp::Controllers; include Airbed::Resources; end</tt>
+  #
+  # Now, instead of deriving your controller from <tt>R</tt>, derive it from <tt>Resource</tt>:
+  #
+  #   module YourApp::Controllers
+  #     class YourModels < Resource YourModel
+  #     end
+  #   end
+  #
+  # You can override the various default implementations of the restful actions below by just overriding the methods.
+  #
+  module Resources
+
+    def self.included(base) # +nodoc+
+      base.send :extend, ClassMethods
+    end
+
+    # Acts as a dispatcher to map between HTTP verbs and actions
+    class Resty
+      
+      # Maps from GET requests to restful actions
+      #
+      # * If +id+ and +action+ are provided, call the method +action+ (if implemented).
+      # * If only id is provided, load the +show_context+ and call show.
+      # * Otherwise, load the new context and call list
+      def get(id=nil,action=nil)
+
+        # we have id and action ... call arbitrary action
+        if !id.blank? and !action.blank?
+          model = instance_context(id)
+          
+          # special case
+          action = (action == 'new' ? 'new_action' : action)
+          send(action,model)
+
+        elsif !id.blank?
+          model = show_context(id)
+          show(model)
+
+        else
+          list = list_context
+          list(list)
+        end
+      end
+
+      # Maps from POST requests to restful actions. Also supports "exotic" methods PUT and DESTROY (via the _verb parameter).
+      # 
+      # 1. POST with an id is undefined
+      # 2. POST with no id loads +new_context+ and calls +create+.
+      # 3. _verb == 'put' + id delegates to +put+ the handler
+      # 4. _verb == 'destroy' + id deletgates to the +destroy+ handler
+      # 
+      def post(id=nil)
+        unless id.blank?
+          @model = instance_context(id)
+          
+          case input['_verb']
+          when 'put'
+            put(id)
+          when 'delete'
+            delete(id)
+          else
+            raise "eh? unknown verb #{input['_verb']}"
+          end
+        else
+          create(new_context)
+        end
+      end
+      
+      # Map from PUT requests to restful actions.
+      #
+      # put + id loads +instance_context+ and calls +update+
+      def put(id)
+        update(@model || instance_context(id))
+      end
+      
+      # Map from DELETE requests to restful actions.
+      #
+      # delete + id loads +instance_context+ and calls +destroy+
+      def delete(id)
+        destroy(@model || instance_context(id))
+      end
+
+
+      protected
+      # default implementation of show
+      #
+      # Renders the <tt>show_#{singular_name}</tt> view.
+      def show(instance)
+        render "show_#{singular_name}"
+      end
+
+      # default implementation of list
+      #
+      # Renders the <tt>list_#{plural_name}</tt> view.
+      def list(list)
+        render "list_#{plural_name}"
+      end
+
+      # default implementation of create
+      #
+      # It extracts the model attributes from +input+ and calls +save!+
+      #
+      # Calls +after_modification+ if defined, other wise redirects to +show+.
+      def create(instance)
+        instance.attributes = input[singular_name]
+        instance.save!
+
+        if respond_to? :after_modification
+          after_modification(instance)
+        else
+          redirect(self.class,instance)
+        end
+      end
+
+      # default implementation of update
+      #
+      # delegates to create.
+      def update(instance)
+        create(instance)
+      end
+
+      # default implementation of destroy
+      #
+      # Destroys the instance and redirects to +list+.
+      def destroy(instance)
+        instance.destroy
+        redirect(self.class)
+      end
+
+      ## pseudo-rest methods
+      # default implementation of edit
+      #
+      # Renders the <tt>form_#{singular_name}</tt> view.
+      def edit(instance)
+        render "form_#{singular_name}"
+      end
+
+      # default implementation of new
+      #
+      # Renders the <tt>form_#{singular_name}</tt> view.
+      def new_action(instance)
+        render "form_#{singular_name}"
+      end
+
+      ## utilities
+      # calls a method if its implemented
+      def hook(method,*args)
+        send(method,*args) if respond_to? method
+      end
+
+      # returns the singular, sluggy class name
+      def singular_name
+        @singular_name ||= model_class.to_s.demodulize.underscore
+      end
+
+      # returns the plural, sluggy class name
+      def plural_name
+        @plural_name ||= singular_name.pluralize
+      end
+
+      # instance version of Resty#model_class (meta defined)
+      def model_class; self.class.model_class   ; end
+      
+      # instance version of Resty#options (meta defined)
+      def options
+        @options ||= self.class.options || {}
+      end
+
+      # loads the context for show
+      #
+      # delegates to +instance_context+ with <tt>options[:show_options]</tt> if defined.
+      def show_context(id)
+        instance_context(id, options[:show_options] || {})
+      end
+
+      # loads the context for REST methods requiring an instance of the controlled model
+      #
+      # merges <tt>options[:show_options]</tt> with +instance_options+ (if supplied), 
+      # and passes it as options to the model classes' +find+ method.
+      #
+      # Sets to <tt>@#{singular_name}</tt> to the loaded instance and returns it.
+      def instance_context(id,instance_options={})
+        instance_options = (options[:instance_options] || {}).merge(instance_options)
+
+        puts "instance context, #{instance_options.inspect}"
+
+        returning(model_class.find(id,instance_options)) do |instance|
+          instance_variable_set("@#{singular_name}",instance)
+        end
+      end
+
+      # loads the context for REST methods requiring a list of instances of the controlled model.
+      #
+      # Passes <tt>options[:list_options]</tt> (if defined) to the model classes' +find+ method.
+      #
+      # Sets <tt>@#{plural_name}</tt> to the list and returns it.
+      def list_context
+        list_options = options[:list_options] || {}
+
+        returning(model_class.find(:all, list_options)) do |list|
+          instance_variable_set("@#{plural_name}",list)
+        end
+      end
+
+      # load the context for REST methods requiring a fresh, unsaved, defaulted instance of the controlled model.
+      #
+      # Hooks +setup_defaults+ and sets <tt>@#{singular_name}</tt> to the instance and returns it.
+      def new_context
+        returning(self.class.model_class.new) do |instance|
+          hook(:setup_defaults,instance)
+          instance_variable_set("@#{singular_name}",instance)
+        end
+      end
+    end
+
+    module ClassMethods
+      
+      # Make a controller into a resource.
+      #
+      # Just do
+      #
+      #   module Camping::Controllers
+      #     class Users < Resource User; end
+      #   end
+      #
+      # or maybe something more complex
+      #
+      #   module Camping::Controllers
+      #     class Users < Resource User, :show_options => {:include => [:achievements]}
+      #       def show(user)
+      #         user.tweak!
+      #         super
+      #       end
+      #     end
+      #   end
+      #
+      def Resource(model_class,options={})
+
+        class_name = model_class.to_s.demodulize
+        name = options[:name] || class_name.underscore.pluralize
+
+        r = @r
+        u = options[:urls] || ["/#{name}", "/#{name}/(\\d+)", "/#{name}/(\\d+)/(.+)"]
+
+        Class.new(Airbed::Resources::Resty) {
+          meta_def(:model_class) { model_class }
+          meta_def(:options) { options }
+          meta_def(:urls) { u }
+          meta_def(:inherited){|x| r << x}
+        }
+      end
+    end
+  end
+  
+  module Views
+    def form(options={})
+      verb = method = options[:method] || :post
+      options[:method] = :post unless [:get,:post].include? method.to_sym
+    
+      tag!(:form, options) {
+        input(:type => 'hidden', :name => '_verb', :value => verb)
+        yield
+      }
+    end
+  end
+end