active_scaffold-sequel 0.3.0

data/lib/active_scaffold/config/core.rb

@@ -0,0 +1,219 @@
+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
+      ModelPermissions
+    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
+    @@sti_create_links = true
+
+    # 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
+
+      # 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.sort_by {|c| c.to_s}
+      association_column_names = self.model.associations.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_key] or c.name.to_s =~ /(_id|_count)$/) }.collect {|c| c.name})
+
+      # 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.respond_to?(:sti_key) ? self.model.sti_key : :type
+      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.model_name.human, model_name.to_s.camelize]
+        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
+
+    def self.available_frontends
+      frontends_dir = File.join(Rails.root, "vendor", "plugins", ActiveScaffold::Config::Core.plugin_directory, "frontends")
+      Dir.entries(frontends_dir).reject { |e| e.match(/^\./) } # Get rid of files that start with .
+    end
+  end
+end
+

data/lib/active_scaffold/config/create.rb

@@ -0,0 +1,44 @@
+module ActiveScaffold::Config
+  class Create < ActiveScaffold::Config::Form
+    self.crud_type = :create
+    def initialize(core_config)
+      super
+      @label = :create_model
+      self.persistent = self.class.persistent
+      self.action_after_create = self.class.action_after_create
+      self.refresh_list = self.class.refresh_list
+    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 :action_after_create
+    @@action_after_create = nil
+
+    # whether we should refresh list after create or not
+    cattr_accessor :refresh_list
+    @@refresh_list = false
+
+    # 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 :action_after_create
+
+    # whether we should refresh list after create or not
+    attr_accessor :refresh_list
+  end
+end

data/lib/active_scaffold/config/delete.rb

@@ -0,0 +1,33 @@
+module ActiveScaffold::Config
+  class Delete < Base
+    self.crud_type = :delete
+
+    def initialize(core_config)
+      super
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+      @action_group = self.class.action_group.clone if self.class.action_group
+      self.refresh_list = self.class.refresh_list
+    end
+
+    # global level configuration
+    # --------------------------
+
+    # the ActionLink for this action
+    cattr_accessor :link
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('destroy', :label => :delete, :type => :member, :confirm => :are_you_sure_to_delete, :method => :delete, :crud_type => :delete, :position => false, :parameters => {:destroy_action => true}, :security_method => :delete_authorized?, :ignore_method => :delete_ignore?)
+
+    # whether we should refresh list after destroy or not
+    cattr_accessor :refresh_list
+    @@refresh_list = false
+
+    # instance-level configuration
+    # ----------------------------
+
+    # the ActionLink for this action
+    attr_accessor :link
+
+    # whether we should refresh list after destroy or not
+    attr_accessor :refresh_list
+  end
+end

data/lib/active_scaffold/config/field_search.rb

@@ -0,0 +1,76 @@
+module ActiveScaffold::Config
+  class FieldSearch < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      super
+      @text_search = self.class.text_search
+
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+      @action_group = self.class.action_group.clone if self.class.action_group
+    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
+        if @core.columns.active_record_class.respond_to?(:lock_column)
+          self.columns.exclude @core.columns.active_record_class.lock_column
+        end
+      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

data/lib/active_scaffold/config/form.rb

@@ -0,0 +1,48 @@
+module ActiveScaffold::Config
+  class Form < Base
+    def initialize(core_config)
+      super
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone unless self.class.link.nil?
+      @action_group = self.class.action_group.clone if self.class.action_group
+      @show_unauthorized_columns = self.class.show_unauthorized_columns
+
+      # no global setting here because multipart should only be set for specific forms
+      @multipart = false
+    end
+
+    # global level configuration
+    # --------------------------
+    # show value of unauthorized columns instead of skip them
+    class_attribute :show_unauthorized_columns
+
+    # instance-level configuration
+    # ----------------------------
+
+    # show value of unauthorized columns instead of skip them
+    attr_accessor :show_unauthorized_columns
+    
+    # the ActionLink for this action
+    attr_accessor :link
+
+    # the label for this Form action. used for the header.
+    attr_writer :label
+
+    # provides access to the list of columns specifically meant for the Form to use
+    def columns
+      unless @columns # lazy evaluation
+        self.columns = @core.columns._inheritable
+        self.columns.exclude :created_on, :created_at, :updated_on, :updated_at, :marked
+      end
+      @columns
+    end
+    
+    public :columns=
+    
+    # whether the form should be multipart
+    attr_writer :multipart
+    def multipart?
+      @multipart ? true : false
+    end
+  end
+end

data/lib/active_scaffold/config/list.rb

@@ -0,0 +1,196 @@
+module ActiveScaffold::Config
+  class List < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      super
+      # inherit from global scope
+      # full configuration path is: defaults => global table => local table
+      @per_page = self.class.per_page
+      @page_links_window = self.class.page_links_window
+      
+      # originates here
+      @sorting = ActiveScaffold::DataStructures::Sorting.new(@core.columns)
+      @sorting.set_default_sorting(@core.model)
+
+      # inherit from global scope
+      @empty_field_text = self.class.empty_field_text
+      @association_join_text = self.class.association_join_text
+      @pagination = self.class.pagination
+      @show_search_reset = true
+      @mark_records = self.class.mark_records
+    end
+
+    # global level configuration
+    # --------------------------
+    # how many records to show per page
+    cattr_accessor :per_page
+    @@per_page = 15
+
+    # how many page links around current page to show
+    cattr_accessor :page_links_window
+    @@page_links_window = 2
+
+    # what string to use when a field is empty
+    cattr_accessor :empty_field_text
+    @@empty_field_text = '-'
+
+    # what string to use to join records from plural associations
+    cattr_accessor :association_join_text
+    @@association_join_text = ', '
+
+    # What kind of pagination to use:
+    # * true: The usual pagination
+    # * :infinite: Treat the source as having an infinite number of pages (i.e. don't count the records; useful for large tables where counting is slow and we don't really care anyway)
+    # * false: Disable pagination
+    cattr_accessor :pagination
+    @@pagination = true
+
+    # Add a checkbox in front of each record to mark them and use them with a batch action later
+    cattr_accessor :mark_records
+
+    # instance-level configuration
+    # ----------------------------
+
+    # provides access to the list of columns specifically meant for the Table to use
+    def columns
+      self.columns = @core.columns._inheritable unless @columns # lazy evaluation
+      @columns
+    end
+    
+    public :columns=
+
+    # how many rows to show at once
+    attr_accessor :per_page
+
+    # how many page links around current page to show
+    attr_accessor :page_links_window
+
+    # What kind of pagination to use:
+    # * true: The usual pagination
+    # * :infinite: Treat the source as having an infinite number of pages (i.e. don't count the records; useful for large tables where counting is slow and we don't really care anyway)
+    # * false: Disable pagination
+    attr_accessor :pagination
+
+    # what string to use when a field is empty
+    attr_accessor :empty_field_text
+
+    # what string to use to join records from plural associations
+    attr_accessor :association_join_text
+
+    # show a link to reset the search next to filtered message
+    attr_accessor :show_search_reset
+
+    # Add a checkbox in front of each record to mark them and use them with a batch action later
+    attr_accessor :mark_records
+
+    # the default sorting. should be an array of hashes of {column_name => direction}, e.g. [{:a => 'desc'}, {:b => 'asc'}]. to just sort on one column, you can simply provide a hash, though, e.g. {:a => 'desc'}.
+    def sorting=(val)
+      sorting.set(*val)
+    end
+    def sorting
+      @sorting ||= ActiveScaffold::DataStructures::Sorting.new(@core.columns)
+    end
+    
+    # overwrite the includes used for the count sql query
+    attr_accessor :count_includes
+
+    # the label for this List action. used for the header.
+    attr_writer :label
+    def label
+      @label ? as_(@label, :count => 2) : @core.label(:count => 2)
+    end
+
+    attr_writer :no_entries_message
+    def no_entries_message
+      @no_entries_message ? @no_entries_message : :no_entries
+    end
+
+    attr_writer :filtered_message
+    def filtered_message
+      @filtered_message ? @filtered_message : :filtered
+    end
+    
+    attr_writer :always_show_search
+    def always_show_search
+      @always_show_search && !search_partial.blank?
+    end
+    
+    def search_partial
+      return "search" if @core.actions.include?(:search)
+      return "field_search" if @core.actions.include?(:field_search)
+    end
+    
+    # always show create
+    attr_writer :always_show_create
+    def always_show_create
+      @always_show_create && @core.actions.include?(:create)
+    end
+
+    # if list view is nested hide nested_column
+    attr_writer :hide_nested_column
+    def hide_nested_column
+      @hide_nested_column.nil? ? true : @hide_nested_column
+    end
+    
+    # might be set to open nested_link automatically in view
+    # conf.nested.add_link(:players)
+    # conf.list.nested_auto_open = {:players => 2}
+    # will open nested players view if there are 2 or less records in parent
+    attr_accessor :nested_auto_open
+    
+    class UserSettings < UserSettings
+      # This label has alread been localized.
+      def label
+        @session[:label] ? @session[:label] : @conf.label
+      end
+
+      def per_page
+        @session['per_page'] = @params['limit'].to_i if @params.has_key? 'limit'
+        @session['per_page'] || @conf.per_page
+      end
+
+      def page
+        @session['page'] = @params['page'] if @params.has_key? 'page'
+        @session['page'] || 1
+      end
+
+      def page=(value = nil)
+        @session['page'] = value
+      end
+
+      attr_reader :nested_default_sorting
+
+      def nested_default_sorting=(options)
+        @nested_default_sorting ||= @conf.sorting.clone
+        @nested_default_sorting.set_nested_sorting(options[:table_name], options[:default_sorting])
+      end
+
+      def default_sorting
+        nested_default_sorting.nil? ? @conf.sorting : nested_default_sorting
+      end
+
+      def sorting
+        @sorting ||= get_sorting
+      end
+
+      def get_sorting
+        # we want to store as little as possible in the session, but we want to return a Sorting data structure. so we recreate it each page load based on session data.
+        @session['sort'] = [@params['sort'].to_sym, @params['sort_direction'] == 'DESC'] if @params['sort'] and @params['sort_direction']
+        @session['sort'] = nil if @params['sort_direction'] == 'reset'
+
+        if @session['sort']
+          sorting = @conf.sorting.clone
+          sorting.set(@session['sort'][1] ? @session['sort'][0].desc : @session['sort'][0])
+          return sorting
+        else
+          return default_sorting
+        end
+      end
+      
+      def count_includes
+        @conf.count_includes
+      end
+    end
+  end
+end

data/lib/active_scaffold/config/mark.rb

@@ -0,0 +1,35 @@
+module ActiveScaffold::Config
+  class Mark < Base
+    self.crud_type = :read
+
+    # What kind of mark all mode to use:
+    # * :search: de-/mark all records using current search conditions
+    # * :page: de-/mark all records on current page
+    cattr_accessor :mark_all_mode
+    @@mark_all_mode = :search
+
+    attr_accessor :mark_all_mode
+    
+    def initialize(core_config)
+      @core = core_config
+      @mark_all_mode = self.class.mark_all_mode
+      if core_config.actions.include?(:update)
+        @core.model.send(:include, ActiveScaffold::MarkedModel) unless @core.model.ancestors.include?(ActiveScaffold::MarkedModel)
+        add_mark_column
+      else
+        raise "Mark action requires update action in controller for model: #{core_config.model.to_s}"
+      end
+    end
+    
+    protected
+    
+    def add_mark_column
+      @core.columns.add :marked
+      @core.columns[:marked].label = 'M'
+      @core.columns[:marked].form_ui = :checkbox
+      @core.columns[:marked].inplace_edit = true
+      @core.columns[:marked].sort = false
+      @core.list.columns = [:marked] + @core.list.columns.names_without_auth_check unless @core.list.columns.include? :marked
+    end
+  end
+end

data/lib/active_scaffold/config/nested.rb

@@ -0,0 +1,42 @@
+module ActiveScaffold::Config
+  class Nested < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      super
+      @label = :add_existing_model
+      self.shallow_delete = self.class.shallow_delete
+      @action_group = self.class.action_group.clone if self.class.action_group
+    end
+
+    # global level configuration
+    # --------------------------
+    cattr_accessor :shallow_delete
+    @@shallow_delete = true
+
+    # instance-level configuration
+    # ----------------------------
+    attr_accessor :shallow_delete
+
+    # Add a nested ActionLink
+    def add_link(attribute, options = {})
+      column = @core.columns[attribute.to_sym]
+      unless column.nil? || column.association.nil?
+        options.reverse_merge! :security_method => :nested_authorized?, :label => column.association.associated_class.model_name.human({:count => 2, :default => column.association.associated_class.name.pluralize}) 
+        action_link = @core.link_for_association(column, options)
+        action_link.action ||= :index
+        @core.action_links.add_to_group(action_link, action_group) unless action_link.nil?
+      else
+        
+      end
+    end
+    
+    def add_scoped_link(named_scope, options = {})
+      action_link = @core.link_for_association_as_scope(named_scope.to_sym, options)
+      @core.action_links.add_to_group(action_link, action_group) unless action_link.nil?
+    end
+
+    # the label for this Nested action. used for the header.
+    attr_writer :label
+  end
+end