blindgaenger-sinatra-rest 0.3.0 → 0.3.1

data/Rakefile

@@ -4,7 +4,7 @@ task :default => :test
 
 desc "Run tests"
 Spec::Rake::SpecTask.new :test do |t|
-  t.spec_opts = %w(--format specdoc --color --backtrace)
+  t.spec_opts = %w(--format specdoc --color) #--backtrace
   t.spec_files = FileList['test/*_spec.rb']
 end
 

data/lib/sinatra/rest/rest.yaml

@@ -0,0 +1,67 @@
+--- 
+:index:
+  :verb: GET
+  :url: /PLURAL
+  :control: |-
+    @PLURAL = call_model_method(MODEL, :all, mp)
+  :render: |-
+    RENDERER :'PLURAL/index', options  
+
+:new:
+  :verb: GET
+  :url: /PLURAL/new
+  :control: |-
+    @SINGULAR = call_model_method(MODEL, :new, mp)
+  :render: |-
+    RENDERER :'PLURAL/new', options
+
+:create:
+  :verb: POST
+  :url: /PLURAL
+  :control: |-
+    @SINGULAR = call_model_method(MODEL, :new, mp)
+    @SINGULAR.save
+  :render: |-
+    redirect url_for_PLURAL_show(@SINGULAR), 'SINGULAR created'
+
+:show:
+  :verb: GET
+  :url: /PLURAL/:id
+  :control: |-
+    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
+  :render: |-
+    if @SINGULAR.nil?
+      throw :halt, [404, 'SINGULAR not found']
+    else
+      RENDERER :'PLURAL/show', options
+    end
+
+:edit:
+  :verb: GET
+  :url: /PLURAL/:id/edit
+  :control: |-
+    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
+  :render: |-
+    RENDERER :'PLURAL/edit', options
+
+:update:
+  :verb: PUT
+  :url: /PLURAL/:id
+  :control: |-
+    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
+    @SINGULAR.update_attributes(mp) unless @SINGULAR.nil?
+  :render: |-
+    if @SINGULAR.nil?
+      throw :halt, [404, 'SINGULAR not found']
+    else
+      redirect url_for_PLURAL_show(@SINGULAR), 'SINGULAR updated'
+    end
+
+:destroy:
+  :verb: DELETE
+  :url: /PLURAL/:id
+  :control: |-
+    call_model_method(MODEL, :delete, mp[:id])
+  :render: |-
+    redirect url_for_PLURAL_index, 'SINGULAR destroyed'
+

data/lib/sinatra/rest.rb

@@ -4,6 +4,7 @@ require 'english/inflect'
 libdir = File.dirname(__FILE__) + "/rest"
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 require 'adapters'
+require 'yaml'
 
 module Sinatra
 
@@ -13,13 +14,14 @@ module Sinatra
     # adds restful routes and url helpers for the model
     def rest(model_class, options={}, &block)
       parse_args(model_class, options)
+      read_config('rest/rest.yaml')
 
       # register model specific helpers
-      helpers read_module_template('rest/helpers.tpl.rb')
+      helpers generate_helpers
       
       # create an own module, to override the template with custom methods
       # this way, you can still use #super# in the overridden methods
-      controller = read_module_template('rest/controller.tpl.rb')
+      controller = generate_controller
       if block_given?
         custom = CustomController.new(@plural)
         custom.instance_eval &block
@@ -29,7 +31,7 @@ module Sinatra
       helpers controller
       
       # register routes as DSL extension
-      instance_eval read_template('rest/routes.tpl.rb')
+      instance_eval generate_routes
     end
 
   protected
@@ -48,14 +50,16 @@ module Sinatra
     end
     
     def parse_routes(routes)
-      [*routes].map {|route| ROUTES[route] || route}.flatten.uniq
+      routes = [*routes].map {|route| ROUTES[route] || route}.flatten.uniq
+      # keep the order of :all routes
+      ROUTES[:all].select{|route| routes.include? route}
     end
     
-    def gsub_routes(routes, template)
-      routes.each {|route| template.gsub!(/#{route.to_s.upcase}/, true.to_s) }
-      (ROUTES[:all] - routes).each {|route| template.gsub!(/#{route.to_s.upcase}/, false.to_s) }
+    def read_config(filename)
+      file = File.read(File.join(File.dirname(__FILE__), filename))
+      @config = YAML.load file
     end
-    
+
     #
     # creates the necessary forms of the model name
     # pretty much like ActiveSupport's inflections, but don't like to depend on
@@ -65,27 +69,80 @@ module Sinatra
       return model, singular, singular.pluralize
     end
 
-    #
-    # read the file and do some substitutions
-    def read_template(filename)
-      t = File.read(File.join(File.dirname(__FILE__), filename))
+    def replace_variables(t, route=nil)
+      if route
+        t.gsub!('NAME', route.to_s)
+        t.gsub!('VERB', @config[route][:verb].downcase)
+        t.gsub!('URL', @config[route][:url])
+        t.gsub!('CONTROL', @config[route][:control])
+        t.gsub!('RENDER', @config[route][:render]) 
+      end    
       t.gsub!(/PLURAL/, @plural)
       t.gsub!(/SINGULAR/, @singular)
       t.gsub!(/MODEL/, @model)
       t.gsub!(/RENDERER/, @renderer)
-      gsub_routes(@route_flags, t)
-      t
+      t    
     end
 
-    #
-    # read the template and put it into an anonymous module
-    def read_module_template(filename)
-      t = read_template(filename)
+    def generate_routes
+      @route_flags.map{|r| route_template(r)}.join("\n\n")
+    end
+    
+    def route_template(route)
+      t = <<-RUBY
+        VERB 'URL' do
+          PLURAL_before :NAME
+          PLURAL_NAME
+          PLURAL_after :NAME   
+          RENDER
+        end
+      RUBY
+      replace_variables(t, route)
+    end
+
+    def generate_helpers
       m = Module.new
-      m.module_eval(t, filename)
+      @route_flags.each {|r|
+        m.module_eval helpers_template(r)
+      }
       m
     end
+    
+    def helpers_template(route)
+      t = <<-RUBY
+        def url_for_PLURAL_NAME(model=nil)
+          "URL"
+        end
+      RUBY
+      helper_route = @config[route][:url].gsub(':id', '#{escape_model_id(model)}')
+      t.gsub!('URL', helper_route)
+      replace_variables(t, route)
+    end
 
+    def generate_controller
+      m = Module.new
+      t = <<-RUBY
+        def PLURAL_before(name); end
+        def PLURAL_after(name); end
+      RUBY
+      m.module_eval replace_variables(t)
+
+      @route_flags.each {|route|
+        m.module_eval controller_template(route)
+      }
+      m
+    end
+    
+    def controller_template(route)
+      t = <<-RUBY
+        def PLURAL_NAME(options=params)
+          mp = filter_model_params(options)
+          CONTROL
+        end
+      RUBY
+      replace_variables(t, route)
+    end
+    
     #
     # model unspecific helpers, will be included once
     module Helpers
@@ -110,7 +167,7 @@ module Sinatra
 
       def call_model_method(model_class, name, options={})
         method = model_class.method(name)
-        if method.arity == 0
+        if options.nil? || method.arity == 0
           Kernel.warn "warning: calling #{model_class.to_s}##{name} with args, although it doesn't take args" if options
           method.call
         else
@@ -129,15 +186,15 @@ module Sinatra
         @module = Module.new
       end
 
-      def before(&block)  prefix :before,  &block; end
-      def after(&block)   prefix :after,   &block; end      
-      def index(&block)   prefix :index,   &block; end
-      def new(&block)     prefix :new,     &block; end
-      def create(&block)  prefix :create,  &block; end
-      def show(&block)    prefix :show,    &block; end
-      def edit(&block)    prefix :edit,    &block; end
-      def update(&block)  prefix :update,  &block; end
-      def destroy(&block) prefix :destroy, &block; end                        
+      def before(options={}, &block)  prefix :before,  &block; end
+      def after(options={}, &block)   prefix :after,   &block; end      
+      def index(options={}, &block)   prefix :index,   &block; end
+      def new(options={}, &block)     prefix :new,     &block; end
+      def create(options={}, &block)  prefix :create,  &block; end
+      def show(options={}, &block)    prefix :show,    &block; end
+      def edit(options={}, &block)    prefix :edit,    &block; end
+      def update(options={}, &block)  prefix :update,  &block; end
+      def destroy(options={}, &block) prefix :destroy, &block; end                        
 
     private 
       def prefix(name, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blindgaenger-sinatra-rest
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - blindgaenger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-10 00:00:00 -07:00
+date: 2009-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,9 +45,7 @@ files:
 - README.textile
 - lib/sinatra/rest.rb
 - lib/sinatra/rest/adapters.rb
-- lib/sinatra/rest/controller.tpl.rb
-- lib/sinatra/rest/helpers.tpl.rb
-- lib/sinatra/rest/routes.tpl.rb
+- lib/sinatra/rest/rest.yaml
 - test/call_order_spec.rb
 - test/crud_spec.rb
 - test/helper.rb

data/lib/sinatra/rest/controller.tpl.rb

@@ -1,65 +0,0 @@
-def PLURAL_before(name)
-  # override
-end
-
-def PLURAL_after(name)
-  # override
-end
-
-# index GET /models
-if INDEX
-  def PLURAL_index(options=nil)
-    @PLURAL = call_model_method(MODEL, :all, options)
-  end
-end
-
-# new GET /models/new
-if NEW
-  def PLURAL_new(options=nil)
-    @SINGULAR = call_model_method(MODEL, :new, options)
-  end
-end
-
-# create POST /models
-if CREATE
-  def PLURAL_create(options=params)
-    mp = filter_model_params(options)
-    @SINGULAR = call_model_method(MODEL, :new, mp)
-    @SINGULAR.save
-  end
-end
-
-# show GET /models/1
-if SHOW
-  def PLURAL_show(options=params)
-    mp = filter_model_params(options)
-    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
-  end
-end
-
-# edit GET /models/1/edit
-if EDIT
-  def PLURAL_edit(options=params)
-    mp = filter_model_params(options) 
-    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
-  end
-end
-
-# update PUT /models/1
-if UPDATE
-  def PLURAL_update(options=params)
-    mp = filter_model_params(options)  
-    @SINGULAR = call_model_method(MODEL, :find_by_id, mp[:id])
-    @SINGULAR.update_attributes(mp) unless @SINGULAR.nil?
-  end
-end
-
-# destroy DELETE /models/1
-if DESTROY
-  def PLURAL_destroy(options=params)
-    mp = filter_model_params(options)  
-    call_model_method(MODEL, :delete, mp[:id])
-  end
-end
-
-

data/lib/sinatra/rest/helpers.tpl.rb

@@ -1,49 +0,0 @@
-# index GET /models
-if INDEX
-  def url_for_PLURAL_index
-    '/PLURAL'
-  end
-end
-
-# new GET /models/new
-if NEW
-  def url_for_PLURAL_new
-    '/PLURAL/new'
-  end
-end
-
-# create POST /models
-if CREATE
-  def url_for_PLURAL_create
-    '/PLURAL'
-  end
-end
-
-# show GET /models/1
-if SHOW
-  def url_for_PLURAL_show(model)
-    "/PLURAL/#{escape_model_id(model)}"
-  end
-end
-
-# edit GET /models/1/edit
-if EDIT
-  def url_for_PLURAL_edit(model)
-    "/PLURAL/#{escape_model_id(model)}/edit"
-  end
-end
-
-# update PUT /models/1
-if UPDATE
-  def url_for_PLURAL_update(model)
-    "/PLURAL/#{escape_model_id(model)}"
-  end
-end
-
-# destroy DELETE /models/1
-if DESTROY
-  def url_for_PLURAL_destroy(model)
-    "/PLURAL/#{escape_model_id(model)}"
-  end
-end
-

data/lib/sinatra/rest/routes.tpl.rb

@@ -1,78 +0,0 @@
-# index GET /models
-if INDEX
-  get '/PLURAL' do
-    PLURAL_before :index
-    PLURAL_index
-    PLURAL_after :index    
-    RENDERER :"PLURAL/index", options  
-  end
-end
-
-# new GET /models/new
-if NEW
-  get '/PLURAL/new' do
-    PLURAL_before :new  
-    PLURAL_new
-    PLURAL_after :new    
-    RENDERER :"PLURAL/new", options
-  end
-end
-
-# create POST /models
-if CREATE
-  post '/PLURAL' do
-    PLURAL_before :create
-    PLURAL_create
-    PLURAL_after :create
-    redirect url_for_PLURAL_show(@SINGULAR), 'SINGULAR created'
-  end
-end
-
-# show GET /models/1
-if SHOW
-  get '/PLURAL/:id' do
-    PLURAL_before :show
-    PLURAL_show
-    PLURAL_after :show
-    if @SINGULAR.nil?
-      throw :halt, [404, 'SINGULAR not found']
-    else
-      RENDERER :"PLURAL/show", options
-    end
-  end
-end
-
-# edit GET /models/1/edit
-if EDIT
-  get '/PLURAL/:id/edit' do
-    PLURAL_before :edit
-    PLURAL_edit
-    PLURAL_after :edit    
-    RENDERER :"PLURAL/edit", options
-  end
-end
-
-# update PUT /models/1
-if UPDATE
-  put '/PLURAL/:id' do
-    PLURAL_before :update  
-    PLURAL_update
-    PLURAL_after :update
-    if @SINGULAR.nil?
-      throw :halt, [404, 'SINGULAR not found']
-    else
-      redirect url_for_PLURAL_show(@SINGULAR), 'SINGULAR updated'
-    end
-  end
-end
-
-# destroy DELETE /models/1
-if DESTROY
-  delete '/PLURAL/:id' do
-    PLURAL_before :destroy
-    PLURAL_destroy
-    PLURAL_after :destroy
-    redirect url_for_PLURAL_index, 'SINGULAR destroyed'
-  end
-end
-