active_scaffold 3.0.0

data/lib/active_scaffold/bridges/tiny_mce/bridge.rb

@@ -0,0 +1,5 @@
+ActiveScaffold::Bridges.bridge "TinyMCE" do
+  install do
+    require File.join(File.dirname(__FILE__), "lib/tiny_mce_bridge.rb")
+  end
+end

data/lib/active_scaffold/bridges/tiny_mce/lib/tiny_mce_bridge.rb

@@ -0,0 +1,45 @@
+module ActiveScaffold
+  module TinyMceBridge
+    module ViewHelpers
+      def active_scaffold_includes(*args)
+        tiny_mce_js = javascript_tag(%|
+var action_link_close = ActiveScaffold.ActionLink.Abstract.prototype.close;
+ActiveScaffold.ActionLink.Abstract.prototype.close = function() {
+  this.adapter.select('textarea.mceEditor').each(function(elem) {
+    tinyMCE.execCommand('mceRemoveControl', false, elem.id);
+  });
+  action_link_close.apply(this);
+};
+        |) if using_tiny_mce?
+        super(*args) + (include_tiny_mce_if_needed || '') + (tiny_mce_js || '')
+      end
+    end
+
+    module FormColumnHelpers
+      def active_scaffold_input_text_editor(column, options)
+        options[:class] = "#{options[:class]} mceEditor #{column.options[:class]}".strip
+        html = []
+        html << send(override_input(:textarea), column, options)
+        html << javascript_tag("tinyMCE.execCommand('mceAddControl', false, '#{options[:id]}');") if request.xhr?
+        html.join "\n"
+      end
+
+      def onsubmit
+        submit_js = 'tinyMCE.triggerSave();this.select("textarea.mceEditor").each(function(elem) { tinyMCE.execCommand("mceRemoveControl", false, elem.id); });' if using_tiny_mce?
+        [super, submit_js].compact.join ';'
+      end
+    end
+
+    module SearchColumnHelpers
+      def self.included(base)
+        base.class_eval { alias_method :active_scaffold_search_text_editor, :active_scaffold_search_text }
+      end
+    end
+  end
+end
+
+ActionView::Base.class_eval do
+  include ActiveScaffold::TinyMceBridge::FormColumnHelpers
+  include ActiveScaffold::TinyMceBridge::SearchColumnHelpers
+  include ActiveScaffold::TinyMceBridge::ViewHelpers
+end

data/lib/active_scaffold/bridges/validation_reflection/bridge.rb

@@ -0,0 +1,8 @@
+ActiveScaffold::Bridges.bridge "ValidationReflection" do
+  install do
+    require File.join(File.dirname(__FILE__), "lib/validation_reflection_bridge.rb")
+  end
+  install? do
+    ActiveRecord::Base.respond_to? :reflect_on_validations_for
+  end
+end

data/lib/active_scaffold/bridges/validation_reflection/lib/validation_reflection_bridge.rb

@@ -0,0 +1,21 @@
+module ActiveScaffold
+  module ValidationReflectionBridge
+    def self.included(base)
+      base.class_eval { alias_method_chain :initialize, :validation_reflection }
+    end
+
+    def initialize_with_validation_reflection(name, active_record_class)
+      initialize_without_validation_reflection(name, active_record_class)
+      column_names = [name]
+      column_names << @association.primary_key_name if @association
+      self.required = column_names.any? do |column_name|
+        active_record_class.reflect_on_validations_for(column_name.to_sym).any? do |val|
+          val.macro == :validates_presence_of or (val.macro == :validates_inclusion_of and not val.options[:allow_nil] and not val.options[:allow_blank])
+        end
+      end
+    end
+  end
+end
+ActiveScaffold::DataStructures::Column.class_eval do
+  include ActiveScaffold::ValidationReflectionBridge
+end

data/lib/active_scaffold/config/base.rb

@@ -0,0 +1,54 @@
+module ActiveScaffold::Config
+  class Base
+    include ActiveScaffold::Configurable
+    extend ActiveScaffold::Configurable
+
+    def self.inherited(subclass)
+      class << subclass
+        # the crud type of the action. possible values are :create, :read, :update, :delete, and nil.
+        # this is not a setting for the developer. it's self-description for the actions.
+        def crud_type; @crud_type; end
+
+        protected
+
+        def crud_type=(val)
+          raise ArgumentError, "unknown CRUD type #{val}" unless [:create, :read, :update, :delete].include?(val.to_sym)
+          @crud_type = val.to_sym
+        end
+      end
+    end
+    # delegate
+    def crud_type; self.class.crud_type end
+
+    # the user property gets set to the instantiation of the local UserSettings class during the automatic instantiation of this class.
+    attr_accessor :user
+
+    class UserSettings
+      def initialize(conf, storage, params)
+        # the session hash relevant to this action
+        @session = storage
+        # all the request params
+        @params = params
+        # the configuration object for this action
+        @conf = conf
+      end
+    end
+    
+    def formats
+      @formats ||= []
+    end
+    
+    def formats=(val)
+      @formats=val
+    end
+    
+    private
+    
+    def columns=(val)
+      @columns = ActiveScaffold::DataStructures::ActionColumns.new(*val)
+      @columns.action = self
+      @columns.set_columns(@core.columns) if @columns.respond_to?(:set_columns)
+      @columns
+    end
+  end
+end

data/lib/active_scaffold/config/core.rb

@@ -0,0 +1,229 @@
+module ActiveScaffold::Config
+  # to fix the ckeditor bridge problem
+  class Core < ActiveScaffold::Config::Base
+  # code commented out (see above)
+  #class Core < Base
+    # global level configuration
+    # --------------------------
+
+    # provides read/write access to the global Actions DataStructure
+    cattr_reader :actions
+    def self.actions=(val)
+      @@actions = ActiveScaffold::DataStructures::Actions.new(*val)
+    end
+    self.actions = [:create, :list, :search, :update, :delete, :show, :nested, :subform]
+
+    # configures where the ActiveScaffold plugin itself is located. there is no instance version of this.
+    cattr_accessor :plugin_directory
+    @@plugin_directory = File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/core.rb})[1]
+
+    # lets you specify a global ActiveScaffold frontend.
+    cattr_accessor :frontend
+    @@frontend = :default
+
+    # lets you specify a global ActiveScaffold theme for your frontend.
+    cattr_accessor :theme
+    @@theme = :default
+
+    # lets you disable the DHTML history
+    def self.dhtml_history=(val)
+      @@dhtml_history = val
+    end
+    def self.dhtml_history?
+      @@dhtml_history ? true : false
+    end
+    @@dhtml_history = true
+
+    # action links are used by actions to tie together. you can use them, too! this is a collection of ActiveScaffold::DataStructures::ActionLink objects.
+    cattr_reader :action_links
+    @@action_links = ActiveScaffold::DataStructures::ActionLinks.new
+
+    # access to the permissions configuration.
+    # configuration options include:
+    #  * current_user_method - what method on the controller returns the current user. default: :current_user
+    #  * default_permission - what the default permission is. default: true
+    def self.security
+      ActiveRecordPermissions
+    end
+
+    # columns that should be ignored for every model. these should be metadata columns like change dates, versions, etc.
+    # values in this array may be symbols or strings.
+    def self.ignore_columns
+      @@ignore_columns
+    end
+    def self.ignore_columns=(val)
+      @@ignore_columns = ActiveScaffold::DataStructures::Set.new(*val)
+    end
+    @@ignore_columns = ActiveScaffold::DataStructures::Set.new
+
+    # lets you specify whether add a create link for each sti child
+    cattr_accessor :sti_create_links
+
+    # instance-level configuration
+    # ----------------------------
+
+    # provides read/write access to the local Actions DataStructure
+    attr_reader :actions
+    def actions=(args)
+      @actions = ActiveScaffold::DataStructures::Actions.new(*args)
+    end
+
+    # provides read/write access to the local Columns DataStructure
+    attr_reader :columns
+    def columns=(val)
+      @columns._inheritable = val.collect {|c| c.to_sym}
+      # Add virtual columns
+      @columns << val.collect {|c| c.to_sym unless @columns[c.to_sym]}.compact
+    end
+
+    # lets you override the global ActiveScaffold frontend for a specific controller
+    attr_accessor :frontend
+
+    # lets you override the global ActiveScaffold theme for a specific controller
+    attr_accessor :theme
+
+    # lets you specify whether add a create link for each sti child for a specific controller
+    attr_accessor :sti_create_links
+    def add_sti_create_links?
+      self.sti_create_links and not self.sti_children.nil?
+    end
+
+    # action links are used by actions to tie together. they appear as links for each record, or general links for the ActiveScaffold.
+    attr_reader :action_links
+
+    # a generally-applicable name for this ActiveScaffold ... will be used for generating page/section headers
+    attr_writer :label
+    def label(options={})
+      as_(@label, options) || model.model_name.human(options.merge(options[:count].to_i == 1 ? {} : {:default => model.name.pluralize}))
+    end
+
+    # STI children models, use an array of model names
+    attr_accessor :sti_children
+
+    ##
+    ## internal usage only below this point
+    ## ------------------------------------
+
+    def initialize(model_id)
+      # model_id is the only absolutely required configuration value. it is also not publicly accessible.
+      @model_id = model_id.to_s.pluralize.singularize
+
+      # inherit the actions list directly from the global level
+      @actions = self.class.actions.clone
+
+      # create a new default columns datastructure, since it doesn't make sense before now
+      attribute_names = self.model.columns.collect{ |c| c.name.to_sym }.sort_by { |c| c.to_s }
+      association_column_names = self.model.reflect_on_all_associations.collect{ |a| a.name.to_sym }.sort_by { |c| c.to_s }
+      @columns = ActiveScaffold::DataStructures::Columns.new(self.model, attribute_names + association_column_names)
+
+      # and then, let's remove some columns from the inheritable set.
+      @columns.exclude(*self.class.ignore_columns)
+      @columns.exclude(*@columns.find_all { |c| c.column and (c.column.primary or c.column.name =~ /(_id|_count)$/) }.collect {|c| c.name})
+      @columns.exclude(*self.model.reflect_on_all_associations.collect{|a| :"#{a.name}_type" if a.options[:polymorphic]}.compact)
+
+      # inherit the global frontend
+      @frontend = self.class.frontend
+      @theme = self.class.theme
+      @sti_create_links = self.class.sti_create_links
+
+      # inherit from the global set of action links
+      @action_links = self.class.action_links.clone
+    end
+
+    # To be called after your finished configuration
+    def _load_action_columns
+      ActiveScaffold::DataStructures::ActionColumns.class_eval {include ActiveScaffold::DataStructures::ActionColumns::AfterConfiguration}
+
+      # then, register the column objects
+      self.actions.each do |action_name|
+        action = self.send(action_name)
+        next unless action.respond_to? :columns
+        action.columns.set_columns(self.columns)
+      end
+    end
+
+    # To be called after your finished configuration
+    def _configure_sti
+      column = self.model.inheritance_column
+      if sti_create_links
+        self.columns[column].form_ui ||= :hidden
+      else
+        self.columns[column].form_ui ||= :select
+        self.columns[column].options ||= {}
+        self.columns[column].options[:options] = self.sti_children.collect do |model_name|
+          [model_name.to_s.camelize.constantize.human_name, model_name.to_s.camelize]
+        end
+      end
+    end
+
+    # To be called after include action modules
+    def _add_sti_create_links
+      new_action_link = @action_links['new']
+      unless new_action_link.nil?
+        @action_links.delete('new')
+        self.sti_children.each do |child|
+          new_sti_link = Marshal.load(Marshal.dump(new_action_link)) # deep clone
+          new_sti_link.label = as_(:create_model, :model => child.to_s.camelize.constantize.human_name)
+          new_sti_link.parameters = {model.inheritance_column => child}
+          @action_links.add(new_sti_link)
+        end
+      end
+    end
+
+    # configuration routing.
+    # we want to route calls named like an activated action to that action's global or local Config class.
+    # ---------------------------
+    def method_missing(name, *args)
+      @action_configs ||= {}
+      titled_name = name.to_s.camelcase
+      underscored_name = name.to_s.underscore.to_sym
+      klass = "ActiveScaffold::Config::#{titled_name}".constantize rescue nil
+      if klass
+        if @actions.include? underscored_name
+          return @action_configs[underscored_name] ||= klass.new(self)
+        else
+          raise "#{titled_name} is not enabled. Please enable it or remove any references in your configuration (e.g. config.#{underscored_name}.columns = [...])."
+        end
+      end
+      super
+    end
+
+    def self.method_missing(name, *args)
+      klass = "ActiveScaffold::Config::#{name.to_s.titleize}".constantize rescue nil
+      if @@actions.include? name.to_s.underscore and klass
+        return eval("ActiveScaffold::Config::#{name.to_s.titleize}")
+      end
+      super
+    end
+    # some utility methods
+    # --------------------
+
+    def model_id
+      @model_id
+    end
+
+    def model
+      @model ||= @model_id.to_s.camelize.constantize
+    end
+
+    # warning - this won't work as a per-request dynamic attribute in rails 2.0.  You'll need to interact with Controller#generic_view_paths
+    def inherited_view_paths
+      @inherited_view_paths||=[]
+    end
+
+    # must be a class method so the layout doesn't depend on a controller that uses active_scaffold
+    # note that this is unaffected by per-controller frontend configuration.
+    def self.asset_path(filename, frontend = self.frontend)
+      "active_scaffold/#{frontend}/#{filename}"
+    end
+
+    # must be a class method so the layout doesn't depend on a controller that uses active_scaffold
+    # note that this is unaffected by per-controller frontend configuration.
+    def self.javascripts(frontend = self.frontend)
+      javascript_dir = File.join(Rails.public_path, "javascripts", asset_path('', frontend))
+      Dir.entries(javascript_dir).reject { |e| !e.match(/\.js$/) or (!self.dhtml_history? and e.match('dhtml_history')) }
+    end
+
+  end
+end
+

data/lib/active_scaffold/config/create.rb

@@ -0,0 +1,43 @@
+module ActiveScaffold::Config
+  class Create < ActiveScaffold::Config::Form
+    self.crud_type = :create
+    def initialize(*args)
+      super
+      self.persistent = self.class.persistent
+      self.edit_after_create = self.class.edit_after_create
+    end
+
+    # global level configuration
+    # --------------------------
+    # the ActionLink for this action
+    def self.link
+      @@link
+    end
+    def self.link=(val)
+      @@link = val
+    end
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('new', :label => :create_new, :type => :collection, :security_method => :create_authorized?, :ignore_method => :create_ignore?)
+
+    # whether the form stays open after a create or not
+    cattr_accessor :persistent
+    @@persistent = false
+
+    # whether update form is opened after a create or not
+    cattr_accessor :edit_after_create
+    @@edit_after_create = false
+
+    # instance-level configuration
+    # ----------------------------
+    # the label= method already exists in the Form base class
+    def label(model = nil)
+      model ||= @core.label(:count => 1)
+      @label ? as_(@label) : as_(:create_model, :model => model)
+    end
+    
+    # whether the form stays open after a create or not
+    attr_accessor :persistent
+
+    # whether the form stays open after a create or not
+    attr_accessor :edit_after_create
+  end
+end

data/lib/active_scaffold/config/delete.rb

@@ -0,0 +1,25 @@
+module ActiveScaffold::Config
+  class Delete < Base
+    self.crud_type = :delete
+
+    def initialize(core_config)
+      @core = core_config
+
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+    end
+
+    # global level configuration
+    # --------------------------
+
+    # the ActionLink for this action
+    cattr_accessor :link
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('delete', :label => :delete, :type => :member, :confirm => :are_you_sure_to_delete, :crud_type => :delete, :position => false, :security_method => :delete_authorized?)
+
+    # instance-level configuration
+    # ----------------------------
+
+    # the ActionLink for this action
+    attr_accessor :link
+  end
+end

data/lib/active_scaffold/config/field_search.rb

@@ -0,0 +1,74 @@
+module ActiveScaffold::Config
+  class FieldSearch < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+
+      @text_search = self.class.text_search
+
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+    end
+
+
+    # global level configuration
+    # --------------------------
+    # the ActionLink for this action
+    cattr_reader :link
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('show_search', :label => :search, :type => :collection, :security_method => :search_authorized?, :ignore_method => :search_ignore?)
+
+    # A flag for how the search should do full-text searching in the database:
+    # * :full: LIKE %?%
+    # * :start: LIKE ?%
+    # * :end: LIKE %?
+    # * false: LIKE ?
+    # Default is :full
+    cattr_accessor :text_search
+    @@text_search = :full
+
+    # instance-level configuration
+    # ----------------------------
+
+    # provides access to the list of columns specifically meant for the Search to use
+    def columns
+      # we want to delay initializing to the @core.columns set for as long as possible. Too soon and .search_sql will not be available to .searchable?
+      unless @columns
+        self.columns = @core.columns._inheritable
+        self.columns.exclude @core.columns.active_record_class.locking_column.to_sym
+      end
+      @columns
+    end
+
+    public :columns=
+
+    # A flag for how the search should do full-text searching in the database:
+    # * :full: LIKE %?%
+    # * :start: LIKE ?%
+    # * :end: LIKE %?
+    # * false: LIKE ?
+    # Default is :full
+    attr_accessor :text_search
+    
+    # the ActionLink for this action
+    attr_accessor :link
+    
+    # rarely searched columns may be placed in a hidden subgroup
+     def optional_columns=(optionals)
+      @optional_columns= Array(optionals)
+    end
+    
+    def optional_columns
+      @optional_columns ||= []
+    end
+    
+    # default search params
+    # default_params = {:title => {"from"=>"test", "to"=>"", "opt"=>"%?%"}} 
+    attr_accessor :default_params
+    
+    # human conditions
+    # instead of just filtered you may show the user a humanized search condition statment
+    attr_accessor :human_conditions
+    
+  end
+end