toolbox 0.1.0

data/lib/toolbox/rendering.rb

@@ -0,0 +1,413 @@
+require File.dirname(__FILE__) << '/config'
+
+# Helper method for form builders
+module ActionView
+  module Helpers
+    class FormBuilder
+      def tag_id(method, options = {})
+        it = InstanceTag.new(@object_name, method, @template, nil, @object)
+        it.send :add_default_name_and_id, options #private method
+        options['id']
+      end
+    end
+  end
+end
+
+module Toolbox
+
+
+  class Renderer
+    attr_reader :widget_config
+
+    def initialize view, widget_config, dialog = false
+      @view = view
+      @widget_config = widget_config
+      @dialog = dialog
+    end
+
+
+    # Get the field value out of a model object
+    # If the attribute method is defined and it's a symbol, this method is called on the model object
+    # If the attribute method is defined and it's a block (Proc), the block is called with the model object as parameter
+    # In all other cases, the field name is interpreted as method and called on the model object
+    def value(rec)
+      val = rec.send(@widget_config.model_method) if @widget_config.model_method && @widget_config.model_method.is_a?(Symbol)
+      val = @widget_config.model_method.call(rec) if @widget_config.model_method && @widget_config.model_method.is_a?(Proc)
+      unless val # fallback
+        a = @widget_config.name.to_s.split('.')
+        a.each do |t|
+          rec = rec.send(t)
+          break unless rec # stop if nil is returned
+        end
+        val = rec
+      end
+      val = nil if val == ''
+      val
+    end
+    
+    # Renders the label of the widget.
+    # If show_model is set to a model name, the model name of this widget
+    # will be added in parenthesis if it differs to the value in show_model.
+    def label(show_model = nil, html = true)
+      unless @widget_config.suppress_label
+        if @widget_config.label
+          html ? @view.send(:h, @widget_config.label) : @widget_config.label
+        else
+          translate_field(show_model, html)
+        end
+      end
+    end
+
+    # Translates a column name of a model using gettext
+    # The show_model argument is optional. If true, the model name will also be translated
+    # and appended to the column name. Ensure, that the model name is also translated
+    # (gettext does not extract this automatically).
+    #
+    def translate_field(show_model = nil, html = true)
+      col_name = @widget_config.name.to_s
+      model_name = @widget_config.model_name.classify
+      a = col_name.split('.')
+      if a.length > 1
+        model_name = a[-2].classify
+        col_name = a[-1]
+      end
+
+      text = @view.send(:s_, model_name + '|' + col_name.humanize)
+      text += ' (' + @view.send(:s_, model_name) + ')' if show_model && model_name != show_model
+      
+      html ? @view.send(:h, text) : text
+    end
+
+  end
+
+  class FieldRenderer < Renderer
+    # Generate a sort link for the given field
+    # A list can only be sorted by one field.
+    # Multiple list on one page can be distinguished by the prefix
+    # The field parameter is a field form a list configuration (Symbol, String or Hash)
+    # The text is the link text.
+    #
+    # The following css classes are assigend regarding the current sort direction
+    # - no sorting: 'sort-none'
+    # - asc sorting: 'sort-asc'
+    # - desc sorting: 'sort-desc'
+    def sort_link(params, prefix = nil)
+      if @widget_config.suppress_sorting
+        label
+      else
+        # see if we are already sorted
+        current_dir = Toolbox::Sorting.current(params, prefix, @widget_config.name.to_s)
+        case current_dir
+          when nil
+            new_dir = 'asc'
+            class_attr = 'sort-none'
+          when 'asc'
+            new_dir = 'desc'
+            class_attr = 'sort-asc'
+          else
+            new_dir = nil
+            class_attr = 'sort-desc'
+        end
+        @view.link_to(label, Toolbox::Sorting.params(params, prefix, @widget_config.name.to_s, new_dir), {:class => class_attr})
+      end
+    end
+
+
+    # Renders the value of an attribute of a given object.
+    # Parameters:
+    # - object: the object to get the attribute of
+    # - html: if true, returns the value in html (escaped etc.)
+    # The following options are used:
+    # - :model_method => an alternative method or block of the object to get the display value
+    # - :render_method => an (helper/view) method or block that returns the rendered value (parameters: object, val, html)
+    # - :hide_empty: returns nil if the display value is empty. Otherwise, an empty string
+    # will be returned (or &nbsp; in case of html)
+    # - :suppress_link: if the display value is an ActiveRecord usually a link to it will
+    # be returned (only if html = true of course). If this option is set, only the string
+    # represenation will be returned
+    # - :join if the value is an array and :join is defined, the values are joined using the string
+    # representation of the :join value. Else, a unnumbered list (ul) is generated
+    #
+    # If the display value is an instance of Date, it will be formatted using the
+    # :local_date format
+    def render_value(object, html = true)
+      val =  value(object)
+      unless val == nil && @widget_config.hide_empty
+        if @widget_config.render_method
+          render_own object, val, html
+        elsif val.is_a? Array
+          render_array object, val, html
+        else
+          value_text val, html, object
+        end
+      end
+    end
+    
+    protected
+    # internal helper to get the text of a value-object
+    def value_text (val, html, context) #:nodoc:
+      text = val # default
+      unless val == nil && @widget_config.hide_empty
+        if val
+          if @widget_config.trunc && val.to_s.length > @widget_config.trunc
+            v = val.to_s
+            v = v[0,@widget_config.trunc] + '...'
+            text = html ? "<span title=\"#{@view.send(:h, val)}\">#{@view.send(:h, v)}</span>" : v
+          else
+            text = html ? @view.send(:h, val) : val
+          end
+        else
+          text = html ? '&nbsp;' : ''
+        end
+        if val.kind_of?(ActiveRecord::Base) && !@widget_config.suppress_link
+          if html
+            text = @view.send(:link_to, val.to_s, val)
+            text += @view.context_menu_link(val, context) unless @widget_config.suppress_context_menu 
+          else
+            text = val.to_s
+          end
+        end
+        text = val.to_s(:local_date) if val.instance_of? Date
+        text = val.to_s(:local_time) if val.instance_of? Time
+        text = val.to_s(:local_datetime) if val.instance_of? ActiveSupport::TimeWithZone
+        text += @widget_config.suffix.to_s if @widget_config.suffix
+      end
+      text
+    end
+
+    private
+
+    def render_own (object, val, html)
+      if @widget_config.render_method.is_a? Proc
+        @widget_config.render_method.call @view, object, val, html
+      else
+        @view.send @widget_config.render_method, object, val, html
+      end
+    end
+
+    def render_array (object, val, html)
+      if val.size > 0
+        if @widget_config.join
+          val.map { |v| value_text(v, html, object) }.join(@widget_config.join.to_s)
+        else
+          @view.content_tag 'ul' do
+            val.map { |v| @view.content_tag 'li', value_text(v, html, object) }.join
+          end
+        end
+      else # map empty array to nil
+        value_text nil, html, object
+      end
+    end
+  
+  end
+
+  class ControlRenderer < Renderer
+
+    def render_control(form, rec, has_error = false)
+      options = {}
+      options[:class] = 'error' if has_error
+      options[:class] = (options[:class] || '') + ' ' + @widget_config.css_class if @widget_config.css_class       
+      options[:id] = "dialog_#{form.tag_id @widget_config.name}" if @dialog
+      options[:title] = @view.send(:h, @widget_config.info) if @widget_config.info
+      options[:disabled] = @widget_config.disabled if @widget_config.disabled and not @widget_config.disabled.is_a?(Proc)
+      options[:disabled] = @widget_config.disabled.call(rec) if @widget_config.disabled.is_a?(Proc)
+
+      case @widget_config.type
+      when :select
+        render_select form, rec, options
+      when :collection_select
+        render_collection_select form, rec, options
+      when :auto_complete
+        render_autocomplete form, rec, options
+      when :radio
+        render_radio form, rec, options
+      when :check_box
+        render_checkbox form, rec, options
+      when :date
+        render_date form, rec, options
+      when :textfield
+        render_textfield form, rec, options
+      when :textarea
+        render_textarea form, rec, options
+      when :filefield
+        render_filefield form, rec, options
+      when :hidden
+        render_hidden form, rec, options
+      else          
+        raise "Unkown control type #{@widget_config.type}"
+      end
+    end
+
+    private
+
+    def render_select form, rec, options
+      form.select @widget_config.name, @widget_config.values, {}, options
+    end
+
+    def render_collection_select form, rec, options
+      form.collection_select @widget_config.name,
+                             @widget_config.values,
+                             @widget_config.model_method,
+                             @widget_config.text_method,
+                             {},
+                             options.merge({ :multiple => true })
+    end
+
+    def render_autocomplete form, rec, options
+      t = rec.class.name.underscore
+      #id = "#{t}_#{@widget_config.name.to_s}"
+      id = options[:id] || form.tag_id(@widget_config.name)
+      name =  @widget_config.name.to_s.foreign_key.to_sym
+      opt = {}
+      opt[:id] = "dialog_#{form.tag_id name}" if @dialog
+      s = form.hidden_field name, opt
+      s += form.text_field @widget_config.name, options.merge(:size => (@widget_config.size || 40))
+      s += @view.content_tag("div", "", :id => "#{id}_auto_complete", :class => "auto_complete")
+      s += @view.auto_complete_field(id,
+        :url => @view.send(@widget_config.url),
+        :method => :get,
+        :param_name => :autocomplete_query,
+        :select => 'autocomplete_name',
+        :after_update_element => 'auto_complete_update_hidden')
+      s
+    end
+
+    def render_radio form, rec, options
+      s = ''
+      @widget_config.values.each do |val|
+        s += form.radio_button @widget_config.name, val[1].to_s, options
+        s += @view.content_tag('span', val[0])
+      end
+      s
+    end
+
+    def render_checkbox form, rec, options
+      form.check_box @widget_config.name, options
+    end
+
+    def render_date form, rec, options
+      form.calendar_date_select @widget_config.name, options.merge(:size => (@widget_config.size || 15))
+    end
+
+    def render_textfield form, rec, options
+      val = value(rec) #rec.send @widget_config.name
+      text = val.to_s
+      text = val.to_s(:local_date) if val.instance_of? Date
+      text = val.to_s(:local_time) if val.instance_of? Time
+      text = val.to_s(:local_datetime) if val.instance_of? ActiveSupport::TimeWithZone
+      form.text_field @widget_config.name, options.merge({:size => (@widget_config.size || 40), :value => text})
+    end
+
+    def render_textarea form, rec, options
+      size = @widget_config.size || '40x10'
+      #val = rec.send @widget_config.name
+      #if val
+      #  row = 0
+      #  col = 0
+      #  val.each_line do |line|
+      #    row = row.succ
+      #    col = [col, line.length].max
+      #  end
+      #  size = "#{col}x#{row}"
+      #end
+      form.text_area @widget_config.name, options.merge({:size => size})
+    end
+
+    def render_filefield form, rec, options
+      form.file_field @widget_config.name, options
+    end
+
+    def render_hidden form, rec, options
+      form.hidden_field @widget_config.name, options.merge({:value => value(rec)})
+    end
+
+  end
+
+  class ActionRenderer < Renderer
+
+    def label
+        if @widget_config.label
+            @widget_config.label
+         else
+            t = @widget_config.name.to_s.split '_'
+            l = @view.send(:_, t[0].humanize)
+            if t.size > 1 # e.g. new_group
+              model_name = t[1..-1].join '_'
+              l += ' ' + @view.send(:s_, model_name.humanize.downcase)
+            end
+            l
+        end
+    end
+
+    def render_action rec, context, current_action = nil
+      t = @widget_config.name.to_s.split '_'
+      action = t[0]
+      foreign_action  = t.size > 1
+      if foreign_action # e.g. new_group
+        model_name = t[1..-1].join '_'
+      else
+        model_name = @widget_config.model_name
+        return nil if action == current_action
+      end
+      css_class = @widget_config.active == 1 ? 'enabled ' : 'disabled '
+      css_class += @widget_config.css_class || action
+
+      if @widget_config.active == 1
+        case action
+        when 'separator'
+          @widget_config.name if context
+        when 'new'
+          # copy the _id params to save the context
+          pars = {}
+          pars.merge! context if context
+          # delete self-reference
+          pars.delete model_name + '_id'
+          # set the object as parameter
+          pars[rec.class.name.underscore + '_id'] = rec #if foreign_action
+          url = @view.send("#{action}_#{model_name}_path".to_sym, pars)
+          if !@widget_config.direct_link && (context || foreign_action)
+            @view.link_to_remote label, { :url => url, :method => :get }, {:class => css_class }
+          else
+            @view.link_to label, url, {:class => css_class}
+          end
+        when 'show'
+          @view.link_to label, @view.polymorphic_path(rec), :class => css_class
+        when 'destroy'
+          msg = _('Are you sure?') #@view.send(:_, 'Are you sure?')
+          if context
+            url = @view.polymorphic_path(rec)
+            @view.link_to_remote label, { :url => url, :method => :delete, :confirm => msg }, {:class => css_class }
+          else
+            @view.link_to label, rec, :confirm => msg, :method => :delete, :class => css_class
+          end
+        when 'list'
+          @view.link_to label, @view.send("#{model_name.pluralize}_path".to_sym), :class => css_class
+        when 'edit'
+          url = @view.edit_polymorphic_path rec
+          if context
+            @view.link_to_remote label, { :url => url, :method => :get }, {:class => css_class }
+          else
+            @view.link_to label, url
+          end
+        else
+          url = @widget_config.url || @view.formatted_polymorphic_path([rec, action]) #eval("@view.#{action}_#{model_name}_path(rec)")
+          if context
+            if @widget_config.direct_link
+              @view.link_to label, url, :class => css_class
+            else
+              @view.link_to_remote label, { :url => url, :method => :get }, {:class => css_class }
+            end
+          else
+            @view.link_to label, url
+          end
+        end # case
+      else # if disabled
+        if context
+          @view.content_tag :a, label, :href => '#', :class => css_class
+        else
+          label
+        end
+      end
+    end
+  end
+end

data/lib/toolbox/searching.rb

@@ -0,0 +1,85 @@
+require 'gettext_rails'
+require File.expand_path("../dirs", File.dirname(__FILE__))
+require File.dirname(__FILE__) << '/config'
+require File.dirname(__FILE__) << '/rendering'
+module Toolbox
+  module Searching
+
+    def self.setup #:nodoc:
+      ActionController::Base.send(:extend, ControllerClassMethods)
+      ActionController::Base.send(:include, ControllerInstanceMethods)
+      ActionView::Base.send(:include, HelperMethods)
+    end
+
+    # Creates a SQL where condition with the given filter and a list of fields
+    # filter: the text to search for. Separated multiple value by space
+    # widgets_list: an instance of Toolbox::WidgetList. See ControllerClassMethods::search_fields
+    # for more information about the syntax.
+    # Example:
+    #   search_field :firstname, :lastname, :address
+    #   create_search_condition('dav ny')
+    # -> (firstname like 'dav' or lastname like 'dav' or address like 'dav')
+    # and (firstname like 'ny' or lastname like 'ny' or address like 'ny')
+    def self.create_search_condition(filter, widgets_list)
+      raise 'widgets_list are not of type Toolbox:WidgetList' unless widgets_list.is_a? Toolbox::WidgetList
+      cond_template = []
+      widgets_list.widgets.each do |w|
+        table = w.model_name.tableize
+        col_name = w.name
+        a = col_name.to_s.split('.')
+        if a.length > 1
+          table = a[-2].tableize
+          col_name = a[-1]
+        end
+        cond_template << "#{table}.#{col_name} like ? "
+      end
+      cond_template = '(' + cond_template.join(' or ') + ')'
+      cond = Array.new
+      cond.push('')
+      filter.squeeze(' ').split(' ').each do |text|
+        text = '%' + text + '%'
+        cond[0] += ' and ' if !cond[0].empty?
+        cond[0] += cond_template
+        cond_template.count('?').times do cond.push(text) end
+      end
+      # in case of empty search text
+      cond[0] = '1=1' if cond.length == 1
+      cond
+    end
+
+    module ControllerClassMethods
+      # Defines the search fields
+      # Example:
+      #   search_field :firstname, :lastname, :address
+      # If symbols are given, the model is determined using the controllers name.
+      # If you want to search in associated tables, use this format:
+      #   search_fields :firstname, :lastname, 'orders.desc'
+      def search_fields *fields
+        write_inheritable_attribute('search_fields', Toolbox::WidgetList.new(controller_name.singularize, fields, Toolbox::FieldConfig))
+      end
+
+    end
+
+    module ControllerInstanceMethods
+
+      # Returns the fields (array) defined with  Toolbox::Searching::ControllerClassMethods::search_fields for this controller.
+      def search_fields
+        self.class.read_inheritable_attribute('search_fields') || nil
+      end
+
+    end
+
+    module HelperMethods
+      include GetText
+      bindtextdomain('toolbox', :path => Toolbox::Dirs::LOCALE)
+
+      def search_field_hint widgets_list
+        labels = []
+        widgets_list.widgets.each {|w| labels << Toolbox::Renderer.new(self, w).label(controller.model_name) }
+
+        _('Search in this fields:') + ' ' + labels.join(', ')
+      end
+    end
+  end
+
+end

data/lib/toolbox/session_params.rb

@@ -0,0 +1,63 @@
+require 'gettext_rails'
+
+module Toolbox
+  module SessionParams
+
+    def self.setup #:nodoc:
+      ActionController::Base.send(:extend, ClassMethods)
+      ActionController::Base.send(:include, InstanceMethods)
+
+    end
+
+    module ClassMethods
+
+      # Makes the given parameters "persistend' (per controller).
+      # The listed parameters will be stored in the session.
+      # In a before filter, the params hash is set with the value from
+      # the session, if (and only if) the parameter does not exist in the session.
+      # Otherwise the session value is updated.
+      def session_params *params
+        write_inheritable_attribute('session_params', params)
+      end
+    end
+
+    module InstanceMethods #:nodoc:all
+
+      def self.included(base)
+        base.send :before_filter, :set_session_params
+        base.send :after_filter, :update_session_params
+      end
+
+      private
+
+      #  update the parameter hash from the session
+      def set_session_params
+        if self.class.read_inheritable_attribute('session_params')
+          create_session_params
+          session[:session_params][controller_name].each_key do |field|
+            params[field] = session[:session_params][controller_name][field] unless params[field]
+          end
+        end
+      end
+      # update the session from the params hash
+      def update_session_params
+        if p = self.class.read_inheritable_attribute('session_params')
+          create_session_params
+          p.each do |field|
+            if params[field]
+              session[:session_params][controller_name][field] = params[field]
+            else
+              session[:session_params][controller_name].delete(field)
+            end
+          end
+        end
+      end
+
+      def create_session_params
+        session[:session_params] = {} unless session[:session_params]
+        session[:session_params][controller_name] = {} unless session[:session_params][controller_name]
+      end
+    end
+  end
+
+end

data/lib/toolbox/sorting.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) << '/config'
+module Toolbox
+
+  module Sorting
+
+    def self.quote_order_by(table, field)
+      table = ActiveRecord::Base.connection.quote_table_name(table)
+      field = ActiveRecord::Base.connection.quote_column_name(field)
+      "#{table}.#{field}"
+    end
+
+    # Create an oder-by string
+    # Parameters
+    # - prefix: an optional prefix used to get the right sort-field from the params hash
+    # - params: the parameter hash
+    # - widgets: an array of field configuration
+    def self.order_by(params, widgets, prefix = nil)
+      val = params[params_key(prefix)]
+      return nil unless val # no sort parameter set
+      field, dir = val.split '-'
+      dir = fix_direction dir
+      return nil if dir == 'none' # no sort direction
+      # find the field in field list
+      field = widgets.select{ |w| w == field }.first
+      order_by_string = nil
+      if field
+        if field.order_by
+          order_by_string = field.order_by
+          order_by_string = order_by_string.join(" #{dir}, ") if order_by_string.is_a? Array
+        else
+          order_by_string = quote_order_by(field.model_name.tableize, field.name.to_s)
+        end
+        order_by_string += " #{dir}"
+      end
+      order_by_string
+    end
+
+    # inhibit any sql injection
+    def self.fix_direction dir #:nodoc:
+      dir == 'asc' ? 'asc' : (dir == 'desc' ? 'desc' : 'none')
+    end
+
+    # Get the current sorting direction from the given params hash
+    def self.current(params, prefix, field_name) #:nodoc:
+      dir = nil
+      if val = params[params_key(prefix)]
+        f, d = val.split '-'
+        dir = fix_direction(d) if f == field_name
+      end
+      dir
+    end
+
+    # Gets a parameter hash for link generation
+    def self.params(params, prefix, field_name, new_dir) #:nodoc:
+      if new_dir
+        params.merge({params_key(prefix) => "#{field_name}-#{new_dir}"})
+      else
+        params.delete params_key(prefix)
+        params
+      end
+    end
+
+    # Get the sort-key for the params hash regarding the prefix
+    def self.params_key(prefix) #:nodoc:
+      if prefix
+        "#{prefix}-sort".to_sym
+      else
+        :sort
+      end
+    end
+
+
+  end
+end

data/lib/toolbox/version.rb

@@ -0,0 +1,4 @@
+
+module Toolbox
+  VERSION = '0.1.0'
+end

data/lib/toolbox.rb

@@ -0,0 +1,29 @@
+require 'gettext'
+require File.dirname(__FILE__) << '/toolbox/searching'
+require File.dirname(__FILE__) << '/toolbox/sorting'
+require File.dirname(__FILE__) << '/toolbox/session_params'
+require File.dirname(__FILE__) << '/toolbox/helpers'
+require File.dirname(__FILE__) << '/toolbox/default_controller'
+require File.dirname(__FILE__) << '/toolbox/config'
+require File.dirname(__FILE__) << '/toolbox/version'
+require File.dirname(__FILE__) << '/dirs'
+
+if Object.const_defined?(:Rails) && File.directory?(Rails.root.to_s + "/public")
+
+  Toolbox::Searching.setup
+  Toolbox::SessionParams.setup
+  Toolbox::DefaultController.setup
+  ActionController::Base.send(:append_view_path, Toolbox::Dirs::VIEW)
+
+  # install files
+  unless File.exists?(RAILS_ROOT + "/public/javascripts/toolbox-#{Toolbox::VERSION}/toolbox.js")
+    ['/public/javascripts', '/public/stylesheets', '/public/images'].each do |dir|
+      source = File.join(Toolbox::Dirs::GEM_ROOT, dir)
+      appendix = dir.ends_with?('javascripts') ? "toolbox-#{Toolbox::VERSION}" : 'toolbox'
+      dest = File.join(RAILS_ROOT, dir, appendix)
+      FileUtils.mkdir_p(dest)
+      FileUtils.cp(Dir.glob(source + '/*.*'), dest)
+    end
+  end
+end
+