edgarj 0.01.12

data/app/controllers/edgarj/popup_controller.rb

@@ -0,0 +1,128 @@
+# Modal popup controller module to pick-up 'belongs_to' record
+#
+# == Requrements for popup
+# 1. Multiple 'belongs_to' parents for one model
+# 1. Easy customize as the same as EdgarjController
+module Edgarj
+  class PopupController < ApplicationController
+    include ControllerMixinCommon
+    include Edgarj::PermissionMixin
+
+    helper_method :model, :popup_drawer
+    before_filter :require_read_permission
+
+    # draw popup windows
+    #
+    # === INPUTS
+    # params[:id_target]::          id target DOM on click entry of popup
+    # params[:page]::               on paginate
+    #
+    # === Paginate logic
+    # - params[:page] exists        -> save it to @page_info and use it
+    # - params[:page] doesn't exist -> use @page_info.page
+    #
+    # === call flow
+    # ==== draw popup
+    # EdgarjHelper.draw_belongs_to_label() is called. Example:
+    #       <a href='http://.../edgarj_popup?...' data-remote=true>Author</a>
+    #       <input type=hidden name='book[author_id]'>
+    #       <span id='popup_target_book_author'>...</span>
+    #           :
+    #
+    # ==== on opening popup
+    # 1. edgarj_popup URL http://.../edgarj_popup?... is executed.
+    # 1. EdgarjPopupController.index() is called.
+    #    1. data is searched based on @page_info and user_scoped and
+    #       set it to \@list. 
+    # 1. app/views/edgarj_popup/index.js.erb
+    #    1. $('#edgarj_form_popup') dialog is opened.
+    #
+    # ==== on paginate
+    # Same as above('on opening popup'), but page=N parameter is added.
+    #
+    # ==== on search
+    # 1. post search condition to EdgarjPopupController.search().
+    #
+    # ==== on clicking entry on the popup
+    # TBD
+    def index
+      page_info
+      @page_info.page = (params[:page] || 1)
+      prepare_list
+      @search = page_info.record
+    end
+
+    # Ajax method to execute search
+    #
+    # Actually, this saves condition for later use.
+    # Execution of search could be done at 'index' method, but
+    # do it in this action to avoid 'POST' redirect issue(
+    # POST method redirect resulted in 'POST index', not 'GET index').
+    #
+    # === INPUTS
+    # params[:id_target]::          id target DOM on click entry of popup
+    # params[:edgarj_search_form]::  search condition
+    def search
+      page_info
+      @page_info.record = SearchPopup.new(model, params[:edgarj_search_form])
+      @page_info.update_attribute(:page, 1)
+      @search   = @page_info.record
+      prepare_list  if @search.valid?
+    end
+
+  private
+    # # derive model class from this controller.
+    #
+    # If controller cannot guess model class, overwrite this.
+    #  
+    # === Examples:
+    # * PopupAuthorsController  -> Author
+    def model
+      @_model ||=
+          if self.class.name =~ /^(.+)PopupController$/
+            $1.singularize.constantize
+          else
+            raise 'Cannot guess popup model from controller'
+          end
+    end
+
+    # return search-form object.
+    #
+    # called from page_info
+    def search_form
+      SearchPopup.new(model)
+    end
+
+    # drawer class of this controller.
+    #
+    # Derived popup controller should implement this method.
+    #
+    # === Examples:
+    # * AuthorsController   -> AuthorPopupHelper::AuthorPopupDrawer
+    def drawer_class
+      raise 'Derived popup controller class should implement'
+    end
+
+    # set drawer instance as drawer for later use on rendering view
+    def set_popup_drawer
+      @popup_drawer = drawer_class.new(view_context, params, page_info)
+    end
+
+    def popup_drawer
+      @popup_drawer
+    end
+
+    # This works as:
+    #
+    #   before_render :set_popup_drawer
+    #
+    # to set drawer just before rendering.
+    #
+    # See http://stackoverflow.com/questions/9281224/filter-to-execute-before-render-but-after-controller
+    def render(*args)
+      # set_drawer should be called only when finishing before_filters.
+      set_popup_drawer if current_user
+      super
+    end
+  end
+end

data/app/controllers/edgarj/rescue_mixin.rb

@@ -0,0 +1,37 @@
+# rescue part for EdgarjController (or ApplicationController) and
+# EdgarjPopupController
+#
+module Edgarj
+  module RescueMixin
+  private
+  
+    # rescue callback sub method to show message by flush on normal http request
+    # or by popup-dialog on Ajax request.
+    def edgarj_rescue_sub(ex, message)
+      logger.info(
+          "#{ex.class} #{ex.message} bactrace:\n  " +
+          ex.backtrace.join("\n  "))
+  
+      respond_to do |format|
+        format.html {
+          flash[:error] = message
+          redirect_to top_path
+        }
+        format.js {
+          flash.now[:error] = message
+          render 'message_popup'
+        }
+      end
+    end
+  
+    # rescue callback for 404
+    def edgarj_rescue_404(ex)
+      edgarj_rescue_sub(ex, v('not_found'))
+    end
+  
+    # rescue callback
+    def edgarj_rescue_app_error(ex)
+      edgarj_rescue_sub(ex, ex.message)
+    end
+  end
+end

data/app/controllers/edgarj/user_group_users_controller.rb

@@ -0,0 +1,8 @@
+module Edgarj
+  class UserGroupUsersController < Edgarj::EdgarjController
+  private
+    def drawer_class
+      UserGroupUsersHelper::UserGroupUserDrawer
+    end
+  end
+end

data/app/controllers/edgarj/user_groups_controller.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  class UserGroupsController < Edgarj::EdgarjController
+  private
+    def drawer_class
+      UserGroupsHelper::UserGroupDrawer
+    end
+  end
+end
+

data/app/controllers/edgarj/user_groups_popup_controller.rb

@@ -0,0 +1,8 @@
+module Edgarj
+  class UserGroupsPopupController < Edgarj::PopupController
+  private
+    def drawer_class
+      UserGroupsPopupHelper::UserGroupPopupDrawer
+    end
+  end
+end

data/app/helpers/edgarj/assoc_helper.rb

@@ -0,0 +1,369 @@
+module Edgarj
+  module AssocHelper
+=begin
+    # remote_function + spinner
+    def edgarj_remote_function(url, method='get')
+      "Edgarj._simple_ajax('#{j(url_for(url))}', '#{method}')"
+    end
+
+    # form_for which supports Ajax-like file upload.
+    #
+    # In order to support Ajax-like file upload, use
+    # form-target-iframe-responds_to_parent mechanism.
+    def edgarj_form(&block)
+      url_hash = {
+        controller: params[:controller],
+        action:     @model.new_record? ? 'create' : 'update',
+        format:     :js
+      }
+      url_hash[:id] = @model.id if @model.persisted?
+      form_for(@model,
+          remote: true,
+          url:    url_hash,
+          html:   {
+              id:         '_edgarj_form',
+              method:     @model.new_record? ? 'post' : 'put',
+              multipart:  true,
+             #target:     'edgarj_form_frame'
+          }, &block)
+    end
+
+    # According to http://khamsouk.souvanlasy.com/articles/ajax_file_uploads_in_rails
+    # 'display:none' style should *NOT* used:
+    def iframe_for_edgarj_form
+      %Q(<iframe id=edgarj_form_frame name=edgarj_form_frame
+        style='width:1px;height:1px;border:0px' src='about:blank'></iframe>
+      ).html_safe
+    end
+
+    # === INPUTS
+    # o::       operator form builder
+    # method::  column name
+    def draw_search_operator(o, method)
+      render '/edgarj/search_operator',
+          o:        o,
+          method:   method
+    end
+
+    # Edgarj standard datetime format
+    def datetime_fmt(dt)
+      if dt.blank? then
+        ''
+      else
+        I18n.l(dt, format: I18n.t('edgarj.time.format'))
+      end
+    end
+
+    # Edgarj standard date format
+    def date_fmt(dt)
+      if dt == nil then
+        ''
+      else
+        dt.strftime(I18n.t('date.formats.default'))
+      end
+    end
+
+    def draw_view_status_load_menu
+      content_tag(:div, :id=>'edgarj_load_condition_menu', :class=>'edgarj_menu') do
+        content_tag(:table) do
+          content_tag(:tr) do
+            if current_user.saved_view_statuss.count(:conditions=>['view=?', controller_name]) > 0
+              draw_menu_top_and_pulldown('saved_conditions', t('load_condition')) do
+                out = ""
+                for svc in current_user.saved_view_statuss.find_all_by_view(controller_name) do
+                  out += edgarj_link_to_remote(
+                                svc.name, {:action=>'search_load', :id=>svc.id})
+                end
+                out
+              end
+            else
+              # not to draw empty sub menu of 'saved_conditions' 
+              ''
+            end +
+            content_tag(:td) do
+              link_to 'Help', url_for(:controller=>'/help',
+                                :action=>'search.html'), {:target=>'help'}
+            end
+          end
+        end
+      end
+    end
+
+    # draw sort link on list column header
+    #
+    # === INPUTS
+    # col::         column data
+    # options::     options to url_for
+    def draw_sort(col, options={})
+      label = model_class.human_attribute_name(col.name)
+      dir   = 'asc'
+      if @view_status.order_by == col.name
+        # toggle direction
+        if @view_status.dir == 'asc' || @view_status.dir.blank?
+          label += '▲'
+          dir    = 'desc'
+        else
+          label += '▼'
+        end
+      end
+      link_to(label,
+          {
+          :controller                   => params[:controller],
+          :action                       => 'view_status_save',
+          :id                           => @view_status.id,
+          'edgarj_view_status[order_by]' => col.name,
+          'edgarj_view_status[dir]'      => dir
+          }.merge(options),
+          :remote => true,
+          :method => :put)
+    end
+=end
+
+    # 1. column I18n is used if defined
+    # 2. else, parent.human_name is used.
+    def draw_belongs_to_label_sub(model, col_name, parent_model)
+      I18n.t(col_name,
+          scope:    "activerecord.attributes.#{model.to_s.underscore}",
+          default:  parent_model.human_name)
+    end
+
+=begin
+    # draw belongs_to name.  When link=true(default), draw it as hyper-link
+    def draw_belongs_to(parent_obj, link=true)
+        if link
+          link_to( parent_obj.name,
+              controller: '/' + parent_obj.class.name.underscore.pluralize,
+              action:     'show',
+              id:         parent_obj.id)
+        else
+          h(parent_obj.name)
+        end
+    end
+=end
+
+    # draw 'belongs_to' popup button(link) label.  This is used at:
+    #
+    # * edgarj form for data entry
+    # * edgarj search form(Edgarj::SearchForm) for search-condition entry
+    #
+    # === INPUTS
+    # f::           FormBuilder object
+    # popup_path::  popup path(url)
+    # col_name::    'belongs_to' column name
+    # model::       data model class
+    def draw_belongs_to_label(f, popup_path, col_name, model = f.object.class)
+      col   = model.columns.detect{|c| c.name == col_name.to_s}
+      return "no column found" if !col
+
+      parent_model = model.belongs_to_AR(col)
+      return "parent_model is nil" if !parent_model
+
+      link_to(
+          draw_belongs_to_label_sub(model, col.name, parent_model),
+          popup_path,
+          remote:           true)
+    end
+
+    # draw 'clear' link for 'belongs_to' popup data-entry field
+    #
+    # === INPUTS
+    # f::           FormBuilder object
+    # col_name::    'belongs_to' column name
+    # popup_field:: Edgarj::PopupHelper::PopupField object
+    # parent_name:: initial parent name
+    def draw_belongs_to_clear_link(f, col_name, popup_field, parent_name)
+      ('&nbsp;&nbsp;' +
+          link_to("[#{I18n.t('edgarj.default.clear')}]", '#',
+              onClick:  sprintf("Edgarj.Popup.clear('%s'); return false;",
+                                popup_field.id_target),
+              id:       popup_field.clear_link,
+              style:    'display:' + (parent_name.blank? ? 'none' : '')) +
+          f.hidden_field(col_name)).html_safe
+    end
+
+    # draw 'belongs_to' popup data-entry field
+    #
+    # This is usually used with draw_belongs_to_label().
+    #
+    # === INPUTS
+    # f::           FormBuilder object
+    # col_name::    'belongs_to' column name
+    # model:: data model class
+    def draw_belongs_to_field(f, col_name, model = f.object.class)
+      col   = model.columns.detect{|c| c.name == col_name.to_s}
+      return "no column found" if !col
+
+      parent_model = model.belongs_to_AR(col)
+      return "parent_model is nil" if !parent_model
+
+      parent_obj  = f.object.belongs_to_AR(col)
+      popup_field = Edgarj::PopupHelper::PopupField.new_builder(
+          f.object_name, col_name)
+      label       = sprintf("<span id='%s'>%s</span>",
+                            popup_field.label_target,
+                            parent_obj ? parent_obj.name : '').html_safe
+      if parent_obj
+        link_to(label,
+            # TODO: Hardcoded 'master' prefix should be fixed
+            controller: url_prefix + parent_obj.class.name.underscore.pluralize,
+            action:     'show',
+            id:         parent_obj,
+            topic_path: 'add')
+      else
+        label
+      end +
+      draw_belongs_to_clear_link(f, col.name, popup_field, parent_obj && parent_obj.name)
+    end
+
+    # Is flag in column_value on?
+    def flag_on?(column_value, bitset, flag)
+      val = column_value || 0
+      (val & bitset.const_get(flag)) != 0
+    end
+
+    # get bitset Module.
+    #
+    # When ColBitset(camelized argument col name + 'Bitset') module exists,
+    # the ColBitset is assumed enum definition.
+    def get_bitset(model, col)
+      bitset_name = col.name.camelize + 'Bitset'
+      if model.const_defined?(bitset_name, false)
+        _module = model.const_get(bitset_name)
+        _module.is_a?(Module) ? _module : nil
+      else
+        nil
+      end
+    end
+
+    # draw bitset column in list.
+    #
+    # === INPUTS
+    # rec::         AR object
+    # col_or_sym::  column object returned by rec.class.columns
+    # bitset::      Module which contains bitset constants
+    #
+    # === SEE ALSO
+    # get_bitset()::        get bitset definition
+    # draw_bitset()::       draw bitste checkboxes field
+    # draw_column_enum()::  draw bitset column in list
+    def draw_column_bitset(rec, col_or_sym, bitset)
+      turn_on_flags = []
+      value         = rec.send(get_column_name(col_or_sym))
+      for flag in bitset.constants do
+        turn_on_flags << flag if flag_on?(value, bitset, flag)
+      end
+      turn_on_flags.map{|f| rec.class.human_const_name(bitset, f) }.join(' ')
+    end
+
+    # get enum Module.
+    #
+    # When Col(camelized argument col name) module exists, the Col is
+    # assumed enum definition.
+    def get_enum(model, col)
+      col_name  = col.name
+      if model.const_defined?(col_name.camelize, false)
+        enum = model.const_get(col_name.camelize)
+        enum.is_a?(Module) ? enum : nil
+      else
+        nil
+      end
+    end
+
+    # draw enum column in list.
+    #
+    # When enum for col is defined, constant string (rather than rec.col value)
+    # is drawn.  See get_enum() for more detail of enum for the col.
+    #
+    # === EXAMPLE
+    # Question has status attribute and Question::Status enum.
+    # When question.status == 300,
+    # draw_column_enum(question, status_col, Question::Status) returns
+    # I18n.t('WORKING').
+    #
+    # Where:
+    # * question is Question AR object.
+    # * status_col is one of Question.columns object for status column.
+    #
+    # === INPUTS
+    # rec::         AR object
+    # col_or_sym::  column object returned by rec.class.columns
+    # enum::        Module which contains constants
+    #
+    # === SEE ALSO
+    # get_enum()::            get enum definition
+    # draw_enum()::           draw enum selection field
+    # draw_column_bitset()::  draw bitset column in list
+    #
+    def draw_column_enum(rec, col_or_sym, enum)
+      Edgarj::EnumCache.instance.label(rec, get_column_name(col_or_sym), enum)
+    end
+
+    # return address element string or ''
+    def adrs_str_sub(model, prefix, element)
+      e = model.send(prefix + element)
+      e.blank? ? '' : e
+    end
+
+    # model & adrs_prefix -> address string
+    def adrs_str(model, adrs_prefix)
+      result = ''
+      for adrs_element in ['prefecture', 'city', 'other', 'bldg'] do
+        result << adrs_str_sub(model, adrs_prefix, adrs_element)
+      end
+      result
+    end
+
+    # return true if login user has enough permission on current controller.
+    def permitted?(requested_flags = 0)
+      current_user_roles.any?{|ug| ug.admin?} ||
+      current_model_permissions.any?{|cp| cp.permitted?(requested_flags)}
+    end
+
+    # return true if login user has any permission on the controller.
+    def permitted_on?(controller)
+      true  # TBD
+    end
+
+    # Visit @list and generate csv
+    class CsvVisitor
+      # === INPUTS
+      # t:: template object
+      def initialize(t)
+        @t = t
+      end
+
+      def visit_column(rec, col)
+        val = rec.send(col.name)
+        case col.type
+        when :date
+          @t.date_fmt(val)
+        when :datetime
+          @t.datetime_fmt(val)
+        else
+          rec.send(col.name)
+        end
+      end
+    end
+
+  private
+    def top_menu_td(id, name)
+      content_tag(:td,
+        :id           => id,
+        :onMouseOver  => "Edgarj.Menu.show('#{id}')",
+        :onMouseOut   => "Edgarj.Menu.hide('#{id}')") do
+
+        content_tag(:a, name, :href=>'#') + yield
+      end
+    end
+
+    # Provide consistency between <td> tag id and its sub contents <div> id.
+    # This concistency is required for javascript pull-down action.
+    def draw_menu_top_and_pulldown(id, name)
+      top_menu_td(id, name) do
+        content_tag(:div, :class=>'submenu', :id=>"sub#{id}") do
+          yield
+        end
+      end
+    end
+  end
+end

data/app/helpers/edgarj/common_helper.rb

@@ -0,0 +1,37 @@
+# coding: UTF-8
+
+module Edgarj
+  module CommonHelper
+    # Edgarj standard datetime format
+    def datetime_fmt(dt)
+      if dt.blank? then
+        ''
+      else
+        I18n.l(dt, format: I18n.t('edgarj.time.format'))
+      end
+    end
+
+    # Edgarj standard date format
+    def date_fmt(dt)
+      if dt == nil then
+        ''
+      else
+        dt.strftime(I18n.t('date.formats.default'))
+      end
+    end
+
+    # get enum Module.
+    #
+    # When Col(camelized argument col name) module exists, the Col is
+    # assumed enum definition.
+    def get_enum(model, col)
+      col_name  = col.name
+      if model.const_defined?(col_name.camelize, false)
+        enum = model.const_get(col_name.camelize)
+        enum.is_a?(Module) ? enum : nil
+      else
+        nil
+      end
+    end
+  end
+end

data/app/helpers/edgarj/edgarj_helper.rb

@@ -0,0 +1,20 @@
+# coding: UTF-8
+
+require 'edgarj/common_helper'
+require 'edgarj/assoc_helper'
+require 'edgarj/field_helper'
+require 'edgarj/popup_helper'
+require 'edgarj/form_drawer'
+require 'edgarj/list_drawer'
+
+module Edgarj
+  module EdgarjHelper
+    include CommonHelper
+    include AssocHelper
+    include FieldHelper
+    include PopupHelper
+    include FormDrawer
+    include ListDrawer
+    include SearchHelper
+  end
+end