active_scaffold 3.0.0

data/lib/active_scaffold/config/form.rb

@@ -0,0 +1,46 @@
+module ActiveScaffold::Config
+  class Form < Base
+    def initialize(core_config)
+      @core = core_config
+
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+
+      # no global setting here because multipart should only be set for specific forms
+      @multipart = false
+    end
+
+    # global level configuration
+    # --------------------------
+
+    # instance-level configuration
+    # ----------------------------
+
+    # the ActionLink for this action
+    attr_accessor :link
+
+    # the label for this Form action. used for the header.
+    attr_writer :label
+    def label
+      as_(@label)
+    end
+
+    # 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
+        self.columns.exclude *@core.columns.collect{|c| c.name if c.polymorphic_association?}.compact
+      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,174 @@
+module ActiveScaffold::Config
+  class List < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+
+      # 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
+      @pagination = self.class.pagination
+      @show_search_reset = true
+    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 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
+
+    # 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
+
+    # show a link to reset the search next to filtered message
+    attr_accessor :show_search_reset
+
+    # 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)
+      val = [val] if val.is_a? Hash
+      sorting.clear
+      val.each { |clause| sorting.add *Array(clause).first }
+    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
+    
+    # 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
+        # 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'], @params['sort_direction']] 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'])
+          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,22 @@
+module ActiveScaffold::Config
+  class Mark < Base
+    self.crud_type = :read
+    
+    def initialize(core_config)
+      @core = core_config
+      @core.model.send(:include, ActiveScaffold::MarkedModel) unless @core.model.ancestors.include?(ActiveScaffold::MarkedModel)
+      add_mark_column
+    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 unless @core.list.columns.include? :marked 
+    end
+  end
+end

data/lib/active_scaffold/config/nested.rb

@@ -0,0 +1,43 @@
+module ActiveScaffold::Config
+  class Nested < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+      self.shallow_delete = self.class.shallow_delete
+    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.klass.model_name.human({:count => 2, :default => column.association.klass.name.pluralize}) 
+        action_link = @core.link_for_association(column, options)
+        @core.action_links.add(action_link) 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(action_link) unless action_link.nil?
+    end
+
+    # the label for this Nested action. used for the header.
+    attr_writer :label
+    def label
+      @label ? as_(@label) : as_(:add_existing_model, :model => @core.label)
+    end
+
+  end
+end

data/lib/active_scaffold/config/search.rb

@@ -0,0 +1,68 @@
+module ActiveScaffold::Config
+  class Search < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+
+      @text_search = self.class.text_search
+      @live = self.class.live?
+
+      # 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('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
+
+    # whether submits the search as you type
+    cattr_writer :live
+    def self.live?
+      @@live
+    end
+
+    # 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.collect{|c| c.name if c.searchable? and c.column and c.column.text?}.compact
+      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
+
+    # whether submits the search as you type
+    attr_writer :live
+    def live?
+      @live
+    end
+  end
+end

data/lib/active_scaffold/config/show.rb

@@ -0,0 +1,34 @@
+module ActiveScaffold::Config
+  class Show < Base
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+      # start with the ActionLink defined globally
+      @link = self.class.link.clone
+    end
+
+    # global level configuration
+    # --------------------------
+    cattr_accessor :link
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('show', :label => :show, :type => :member, :security_method => :show_authorized?)
+    # instance-level configuration
+    # ----------------------------
+
+    # the ActionLink for this action
+    attr_accessor :link
+    # the label for this action. used for the header.
+    attr_writer :label
+    def label
+      @label ? as_(@label) : as_(:show_model, :model => @core.label(:count => 1))
+    end
+
+    # provides access to the list of columns specifically meant for this action to use
+    def columns
+      self.columns = @core.columns._inheritable unless @columns # lazy evaluation
+      @columns
+    end
+    
+    public :columns=
+  end
+end

data/lib/active_scaffold/config/subform.rb

@@ -0,0 +1,35 @@
+module ActiveScaffold::Config
+  class Subform < Base
+    def initialize(core_config)
+      @core = core_config
+      @layout = self.class.layout # default layout
+    end
+
+    # global level configuration
+    # --------------------------
+
+    cattr_accessor :layout
+    @@layout = :horizontal
+
+    # instance-level configuration
+    # ----------------------------
+
+    attr_accessor :layout
+
+    # provides access to the list of columns specifically meant for the Sub-Form to use
+    def columns
+      # we want to delay initializing to the @core.update.columns set for as long as possible. but we have to eventually clone, or else have a configuration "leak"
+      unless @columns
+        if @core.actions.include? :update
+          @columns = @core.update.columns.clone
+        else
+          self.columns = @core.columns._inheritable
+        end
+      end
+
+      @columns
+    end
+
+    public :columns=
+  end
+end

data/lib/active_scaffold/config/update.rb

@@ -0,0 +1,38 @@
+module ActiveScaffold::Config
+  class Update < ActiveScaffold::Config::Form
+    self.crud_type = :update
+    def initialize(*args)
+      super
+      self.nested_links = self.class.nested_links
+    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('edit', :label => :edit, :type => :member, :security_method => :update_authorized?)
+
+    # instance-level configuration
+    # ----------------------------
+
+    # the label= method already exists in the Form base class
+    def label
+      @label ? as_(@label) : as_(:update_model, :model => @core.label(:count => 1))
+    end
+
+    attr_accessor :nested_links
+    cattr_accessor :nested_links
+    @@nested_links = false
+
+    attr_writer :hide_nested_column
+    def hide_nested_column
+      @hide_nested_column.nil? ? true : @hide_nested_column
+    end
+ 
+  end
+end