scaffolding_extensions 1.2.0 → 1.3.0

data/README

@@ -21,14 +21,14 @@ to better suit your needs.
 Scaffolding Extensions currently supports:
 
 * Web Frameworks
-  * Rails 2.1
-  * Ramaze 2008.06
+  * Rails 2.2.2
+  * Ramaze 2008.11
   * Camping 1.5
-  * Sinatra 0.3.1
+  * Sinatra 0.3.2
+  * Merb 1.0.4
 * Object/Relational Mappers
-  * ActiveRecord 2.1
-  * DataMapper 0.3.1
-  * Sequel 2.5.0
+  * ActiveRecord 2.2.2
+  * Sequel 2.8.0
 * Javascript Libaries (used for Ajax/Autocompleting)
   * Prototype 1.6.0.1
   * JQuery 1.2.3

data/doc/merb.txt

@@ -0,0 +1,13 @@
+To use this plugin after installing the gem, somewhere in your Merb config,
+add:
+
+  require 'scaffolding_extensions'
+ 
+Then you can use scaffold, scaffold_habtm, or scaffold_all_models in your
+controllers:
+
+  class Admin < Merb::Controller
+    scaffold Model1
+    scaffold_habtm Model1, :things
+    scaffold_all_models :only=>[Model1, Model2, Model3]
+  end

data/lib/scaffolding_extensions/controller/action_controller.rb

@@ -23,7 +23,7 @@ module ScaffoldingExtensions
       end
   end
   
-  # Instance methods for ActionController::Base related necessary for Scaffolding Extensions
+  # Instance methods for ActionController::Base necessary for Scaffolding Extensions
   module ActionController
     private
       def scaffold_flash
@@ -93,7 +93,7 @@ module ScaffoldingExtensions
       end
   end
   
-  # Class methods for ActionController::Base related necessary for Scaffolding Extensions
+  # Class methods for ActionController::Base necessary for Scaffolding Extensions
   module MetaActionController
     private
       # Adds a before filter for checking nonidempotent requests use method POST

data/lib/scaffolding_extensions/controller/merb.rb

@@ -0,0 +1,123 @@
+module ScaffoldingExtensions
+  class << self
+    private
+      # Use whatever model directory Merb is using.
+      def model_files
+        @model_files ||= Dir["#{Merb.dir_for(:model)}/*.rb"]
+      end
+  end
+
+  # Helper methods for Merb that override the defaults in Scaffolding Extensions
+  module MerbControllerHelper
+    private
+      # Merb apparently requires that params that are desired to be lists have
+      # the suffix '[]'
+      def scaffold_param_list_suffix
+        '[]'
+      end
+  end
+  
+  # Instance methods for Merb necessary for Scaffolding Extensions
+  module MerbController
+    private
+      def scaffold_flash
+        message
+      end
+      
+      def scaffold_method_not_allowed
+        render('', :status=>405)
+      end
+      
+      def scaffold_redirect_to(url)
+        redirect("#{request.protocol}://#{request.host}#{url}")
+      end
+      
+      # Renders user provided template if it exists, otherwise renders a scaffold template.
+      # If a layout is specified (either in the controller or as an render_option), use that layout,
+      # otherwise uses the scaffolded layout.  If :inline is one of the render_options,
+      # use the contents of it as the template without the layout.
+      #
+      # There may well be a much better way to do this via modifying the _template_roots, but
+      # I didn't have much luck and decided to take the path I used with Camping and Sinatra,
+      # rendering the templates directly.
+      def scaffold_render_template(action, options = {}, render_options = {})
+        suffix = options[:suffix]
+        suffix_action = "#{action}#{suffix}".to_sym
+        @scaffold_options ||= options
+        @scaffold_suffix ||= suffix
+        @scaffold_class ||= @scaffold_options[:class]
+        begin
+          render(suffix_action, render_options)
+        rescue Merb::ControllerExceptions::TemplateNotFound
+          if render_options.include?(:inline)
+            headers['Content-Type'] = 'text/javascript' if @scaffold_javascript
+            render(Erubis::Eruby.new(render_options[:inline]).result(binding), {:layout=>false}.merge(render_options))
+          else
+            html = Erubis::Eruby.new(File.read(scaffold_path(action))).result(binding)
+            merb_layout = begin
+              merb_layout = _get_layout
+            rescue Merb::ControllerExceptions::TemplateNotFound
+              merb_layout = false
+            end
+            if merb_layout
+              render(html, render_options)
+            else
+              @content = html
+              render(Erubis::Eruby.new(File.read(scaffold_path('layout'))).result(binding), render_options.merge(:layout=>false))
+            end
+          end
+        end
+      end
+      
+      def scaffold_request_action
+        params[:action]
+      end
+      
+      def scaffold_request_env
+        request.env
+      end
+      
+      # Merb overrides any given query params with the path params even if the
+      # path params are nil.  Work around it by getting the query params
+      # directly.
+      def scaffold_request_id
+        params[:id] || request.send(:query_params)[:id]
+      end
+      
+      def scaffold_request_method
+        request.method.to_s.upcase
+      end
+      
+      def scaffold_request_param(v)
+        params[v]
+      end
+      
+      def scaffold_session
+        session
+      end
+      
+      def scaffold_url(action, options = {})
+        url(options.merge(:controller=>controller_name, :action=>action))
+      end
+  end
+  
+  # Class methods for Merb necessary for Scaffolding Extensions
+  module MetaMerbController
+    private
+      # Adds a before filter for checking nonidempotent requests use method POST
+      def scaffold_setup_helper
+        include ScaffoldingExtensions::Helper
+        include ScaffoldingExtensions::MerbControllerHelper
+        include ScaffoldingExtensions::PrototypeHelper
+        include ScaffoldingExtensions::Controller
+        include ScaffoldingExtensions::MerbController
+        before :scaffold_check_nonidempotent_requests
+      end
+  end
+end
+
+# Add class methods necessary for Scaffolding Extensions
+class Merb::Controller
+  extend ScaffoldingExtensions::MetaController
+  extend ScaffoldingExtensions::MetaMerbController
+end

data/lib/scaffolding_extensions/model/active_record.rb

@@ -1,5 +1,3 @@
-require 'scaffolding_extensions/model/ardm'
-
 ScaffoldingExtensions::MODEL_SUPERCLASSES << ::ActiveRecord::Base
 
 # Instance methods added to ActiveRecord::Base to allow it to work with Scaffolding Extensions.
@@ -8,6 +6,11 @@ module ScaffoldingExtensions::ActiveRecord
   def scaffold_attribute_value(field)
     self[field]
   end
+
+  # the value of the primary key for this object
+  def scaffold_id
+    id
+  end
 end
 
 # Class methods added to ActiveRecord::Base to allow it to work with Scaffolding Extensions.
@@ -138,6 +141,32 @@ module ScaffoldingExtensions::MetaActiveRecord
   end
 
   private
+    # Merge an array of conditions into a single condition array
+    def scaffold_merge_conditions(conditions)
+      new_conditions = [[]]
+      if Array === conditions
+        if conditions.length == 0 || (conditions.length == 1 && conditions[0].nil?)
+          nil
+        elsif Array === conditions[0]
+          conditions.each do |cond|
+            next unless cond
+            new_conditions[0] << cond.shift
+            cond.each{|c| new_conditions << c}
+          end
+          if new_conditions[0].length > 0
+            new_conditions[0] = "(#{new_conditions[0].join(") AND (")})"
+            new_conditions
+          else
+            nil
+          end
+        else
+          conditions
+        end
+      else
+        conditions
+      end
+    end
+
     # Updates associated records for a given reflection and from record to point to the
     # to record
     def scaffold_reflection_merge(reflection, from, to)
@@ -153,16 +182,19 @@ module ScaffoldingExtensions::MetaActiveRecord
       end
       connection.update(sql)
     end
+
+    # Remove the associated object from object's association
+    def scaffold_remove_associated_object(association, object, associated_object)
+      object.send(association).delete(associated_object)
+    end
 end
 
 # Add the class methods and instance methods from Scaffolding Extensions
 class ActiveRecord::Base
   SCAFFOLD_OPTIONS = ::ScaffoldingExtensions::MetaModel::SCAFFOLD_OPTIONS
   include ScaffoldingExtensions::Model
-  include ScaffoldingExtensions::ARDM
   include ScaffoldingExtensions::ActiveRecord
   extend ScaffoldingExtensions::MetaModel
-  extend ScaffoldingExtensions::MetaARDM
   extend ScaffoldingExtensions::MetaActiveRecord
   extend ScaffoldingExtensions::Overridable
 end

data/lib/scaffolding_extensions.rb

@@ -82,9 +82,9 @@ require 'scaffolding_extensions/controller/action_controller' if defined? Action
 require 'scaffolding_extensions/controller/camping' if defined? Camping::Controllers
 require 'scaffolding_extensions/controller/ramaze' if defined? Ramaze::Controller
 require 'scaffolding_extensions/controller/sinatra' if defined? Sinatra
+require 'scaffolding_extensions/controller/merb' if defined? Merb
 
 require 'scaffolding_extensions/model/active_record' if defined? ActiveRecord::Base
-require 'scaffolding_extensions/model/data_mapper' if defined? DataMapper::Base
 require 'scaffolding_extensions/model/sequel' if defined? Sequel::Model
 
 ScaffoldingExtensions.javascript_library = 'Prototype'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scaffolding_extensions
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Jeremy Evans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-09 00:00:00 -07:00
+date: 2008-12-10 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - lib/scaffolding_extensions/controller/camping.rb
 - lib/scaffolding_extensions/controller/ramaze.rb
 - lib/scaffolding_extensions/controller/sinatra.rb
+- lib/scaffolding_extensions/controller/merb.rb
 - lib/scaffolding_extensions/helper.rb
 - lib/scaffolding_extensions/jquery_helper.rb
 - lib/scaffolding_extensions/meta_controller.rb
@@ -39,8 +40,6 @@ files:
 - lib/scaffolding_extensions/model.rb
 - lib/scaffolding_extensions/model
 - lib/scaffolding_extensions/model/active_record.rb
-- lib/scaffolding_extensions/model/ardm.rb
-- lib/scaffolding_extensions/model/data_mapper.rb
 - lib/scaffolding_extensions/model/sequel.rb
 - lib/scaffolding_extensions/overridable.rb
 - lib/scaffolding_extensions/prototype_helper.rb
@@ -53,6 +52,7 @@ files:
 - doc/ramaze.txt
 - doc/sinatra.txt
 - doc/testing.txt
+- doc/merb.txt
 - contrib/scaffold_associations_tree
 - contrib/scaffold_associations_tree/README
 - contrib/scaffold_associations_tree/bullet.gif
@@ -98,6 +98,7 @@ rdoc_options:
 - doc/ramaze.txt
 - doc/sinatra.txt
 - doc/testing.txt
+- doc/merb.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: scaffolding-ext
-rubygems_version: 1.0.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Administrative database front-end for multiple web-frameworks and ORMs

data/lib/scaffolding_extensions/model/ardm.rb

@@ -1,42 +0,0 @@
-# Instance methods used by both ActiveRecord and Datamapper
-module ScaffoldingExtensions::ARDM
-  # the value of the primary key for this object
-  def scaffold_id
-    id  
-  end 
-end
-
-# Class methods used by both ActiveRecord and DataMapper
-module ScaffoldingExtensions::MetaARDM
-  private
-    # Merge an array of conditions into a single condition array
-    def scaffold_merge_conditions(conditions)
-      new_conditions = [[]]
-      if Array === conditions
-        if conditions.length == 0 || (conditions.length == 1 && conditions[0].nil?)
-          nil
-        elsif Array === conditions[0]
-          conditions.each do |cond|
-            next unless cond
-            new_conditions[0] << cond.shift
-            cond.each{|c| new_conditions << c}
-          end
-          if new_conditions[0].length > 0
-            new_conditions[0] = "(#{new_conditions[0].join(") AND (")})"
-            new_conditions
-          else
-            nil
-          end
-        else
-          conditions
-        end
-      else
-        conditions
-      end
-    end
-    
-    # Remove the associated object from object's association
-    def scaffold_remove_associated_object(association, object, associated_object)
-      object.send(association).delete(associated_object)
-    end
-end

data/lib/scaffolding_extensions/model/data_mapper.rb

@@ -1,174 +0,0 @@
-require 'scaffolding_extensions/model/ardm'
-
-ScaffoldingExtensions::MODEL_SUPERCLASSES << ::DataMapper::Base
-
-# Instance methods added to DataMapper::Base to allow it to work with Scaffolding Extensions.
-module ScaffoldingExtensions::DataMapper
-  # Get value for given attribute
-  def scaffold_attribute_value(field)
-    attributes[field]
-  end
-end
-
-# Class methods added to DataMapper::Base to allow it to work with Scaffolding Extensions.
-module ScaffoldingExtensions::MetaDataMapper
-  SCAFFOLD_OPTIONS = ::ScaffoldingExtensions::MetaModel::SCAFFOLD_OPTIONS
-
-  # Add the associated object to the object's association
-  def scaffold_add_associated_object(association, object, associated_object)
-    association_proxy = object.send(association)
-    next if association_proxy.include?(associated_object)
-    association_proxy << associated_object
-    object.save
-  end
-  
-  # Array of all association reflections for this model
-  def scaffold_all_associations
-    database.schema[self].associations.to_a
-  end
-  
-  # The class that this model is associated with via the association
-  def scaffold_associated_class(association)
-    case reflection = scaffold_association(association)
-      when DataMapper::Associations::HasManyAssociation
-        reflection.associated_constant
-      else
-        reflection.constant
-    end
-  end
-  
-  # The association reflection for this association
-  def scaffold_association(association)
-    database.schema[self].associations.each{|assoc| return assoc if assoc.name == association}
-    nil
-  end
-
-  # The type of association, either :new for :has_many (as you can create new objects
-  # associated with the current object), :edit for :has_and_belongs_to_many (since you
-  # can edit the list of associated objects), or :one for other associations.  I'm not
-  # sure that :has_one is supported, as I don't use it.
-  def scaffold_association_type(association)
-    case scaffold_association(association)
-      when DataMapper::Associations::HasManyAssociation
-        :new
-      when DataMapper::Associations::HasAndBelongsToManyAssociation
-        :edit
-      else
-        :one
-    end
-  end
-  
-  # List of symbols for associations to display on the scaffolded edit page. Defaults to
-  # all associations that aren't :through or :polymorphic. Can be set with an instance variable.
-  def scaffold_associations
-    @scaffold_associations ||= scaffold_all_associations.collect{|assoc| assoc.name}.sort_by{|name| name.to_s}
-  end
-
-  # Destroys the object
-  def scaffold_destroy(object)
-    object.destroy!
-  end
-  
-  # The error to raise, should match other errors raised by the underlying library.
-  # I'm not sure that this is the correct error, but it is the most common error I've
-  # received.
-  def scaffold_error_raised
-    ::DataObject::ReaderClosed
-  end
-  
-  # Returns the list of fields to display on the scaffolded forms. Defaults
-  # to displaying all columns with the exception of primary key column, timestamp columns,
-  # count columns, and inheritance columns.  Also includes belongs_to associations, replacing
-  # the foriegn keys with the association itself.  Can be set with an instance variable.
-  def scaffold_fields(action = :default)
-    return @scaffold_fields if @scaffold_fields
-    schema = database.schema[self]
-    key = schema.key.name
-    fields = schema.columns.to_a.collect{|x| x.name}.reject{|x| x == key}
-    schema.associations.each do |r| 
-      next unless DataMapper::Associations::BelongsToAssociation === r 
-      fields << r.name 
-      fields.delete(r.foreign_key_name.to_sym)
-    end
-    @scaffold_fields = fields.sort_by{|x| x.to_s}
-  end
-  
-  # The foreign key for the given reflection
-  def scaffold_foreign_key(reflection)
-    reflection.foreign_key_name
-  end
-  
-  # Retrieve a single model object given an id
-  def scaffold_get_object(id)
-    self[id]
-  end
-
-  # Retrieve multiple objects given a hash of options
-  def scaffold_get_objects(options)
-    options[:conditions] = scaffold_merge_conditions(options[:conditions])
-    all(options)
-  end
-
-  # Return the class, left foreign key, right foreign key, and join table for this habtm association
-  def scaffold_habtm_reflection_options(association)
-    reflection = scaffold_association(association)
-    [reflection.constant, reflection.left_foreign_key, reflection.right_foreign_key, reflection.join_table]
-  end
-
-  # Returns a hash of values to be used as url parameters on the link to create a new
-  # :has_many associated object.  Defaults to setting the foreign key field to the
-  # record's primary key.
-  def scaffold_new_associated_object_values(association, record)
-    {scaffold_foreign_key(scaffold_association(association))=>record.id}
-  end
-  
-  # The primary key for the given table
-  def scaffold_primary_key
-    database.schema[self].key.name
-  end
-
-  # Saves the object.
-  def scaffold_save(action, object)
-    object.save rescue false
-  end
-
-  # The column type for the given table column, or nil if it isn't a table column
-  def scaffold_table_column_type(column)
-    column = database.schema[self][column]
-    column.type if column
-  end
-
-  # The name of the underlying table
-  def scaffold_table_name
-    database.schema[self].name
-  end
-
-  private
-    # Updates associated records for a given reflection and from record to point to the
-    # to record
-    def scaffold_reflection_merge(reflection, from, to)
-      sql = case reflection
-        when DataMapper::Associations::HasManyAssociation
-          foreign_key = scaffold_foreign_key(reflection)
-          "UPDATE #{reflection.associated_constant.scaffold_table_name} SET #{foreign_key} = #{to} WHERE #{foreign_key} = #{from}"
-        when DataMapper::Associations::HasAndBelongsToManyAssociation
-          foreign_key = reflection.left_foreign_key
-          "UPDATE #{reflection.join_table} SET #{foreign_key} = #{to} WHERE #{foreign_key} = #{from}" 
-        else
-          return
-      end
-      database.execute(sql)
-    end
-end
-
-# Add the class methods and instance methods from Scaffolding Extensions
-class DataMapper::Base
-  SCAFFOLD_OPTIONS = ::ScaffoldingExtensions::MetaModel::SCAFFOLD_OPTIONS
-  include ScaffoldingExtensions::Model
-  include ScaffoldingExtensions::ARDM
-  include ScaffoldingExtensions::DataMapper
-  extend ScaffoldingExtensions::MetaModel
-  extend ScaffoldingExtensions::MetaARDM
-  extend ScaffoldingExtensions::MetaDataMapper
-  extend ScaffoldingExtensions::Overridable
-end