edgarj 0.01.12

data/app/helpers/edgarj/form_drawer.rb

@@ -0,0 +1,322 @@
+# coding: UTF-8
+
+module Edgarj
+  module FormDrawer
+    # Edgarj::FormDrawer::Base draws HTML table tag based data entry form.
+    # This also provides default methods for SearchFormDrawer search condition
+    # entry form.
+    #
+    # === How to Customize
+    # 1. First, it may be enough to just redefine @options
+    # 1. Next, when draw_ATTR() is defined, it is called.  See ModelPermissionControllerHelper for example.
+    # 1. Then, consider to overwrite draw_ATTR() method.
+    class Base
+
+      # === INPUTS
+      # drawer::  Edgarj::Drawer instance
+      # record::  instance of AR
+      # f::       FormBuilder
+      def initialize(drawer, record, f)
+        @drawer = drawer
+        @vc     = drawer.vc   # just short-cut
+        @record = record
+        @f      = f
+
+        # define default options for draw_X() method, where X is :flags, :kind,
+        # and so on.  @options can be redefined at derived class.
+        @options  = {
+          :flags      => {},
+          :kind       => {},
+          :boolean    => {},
+          :default    => {
+            :date     => {:use_month_numbers=>true},
+            :integer  => {:size=>16},
+            :text     => {:size=>20},
+          }
+        }
+      end
+
+      # draw form
+      #
+      # I18n for label is:
+      #
+      # 1. usual column uses model.human_attribute_name()
+      # 1. 'belongs_to' column uses:
+      # ** I18n.t('activerecord.attributes.MODEL.EXT_ID')
+      # ** parent.human_name
+      def draw()
+        adrs_field  = {}
+        @vc.content_tag(:table) do
+          @left       = true
+          html        = ''
+          for col in columns do
+            draw_method = "draw_#{col.name}"
+            html << if self.class.method_defined?(draw_method) then
+              send(draw_method, col)
+           #elsif edgarj_address?(col)
+           #   draw_address(col)
+           #elsif edgarj_file?(col)
+           #  draw_file(col)
+            elsif (enum = get_enum(col))
+               draw_enum(col, enum)
+            elsif (bitset = get_bitset(col))
+              draw_bitset(col, bitset)
+            else
+              parent_model = @vc.model.belongs_to_AR(col)
+              if parent_model
+                _draw_belongs_to_field(parent_model, col)
+              else
+                _draw_field(col)
+              end
+            end
+          end
+          html << '<td colspan=3></td>'.html_safe if !@left
+          html.html_safe
+        end
+      end
+
+      def columns
+        drawer = @vc.drawer
+        drawer.columns_for(drawer.form_columns)
+      end
+
+      # base method for derived class
+      def edgarj_address?(col)
+        @record.class.edgarj_address?(col)
+      end
+
+      # base method for derived class
+      def edgarj_file?(col)
+        @record.class.edgarj_file?(col)
+      end
+
+      # return enum of the column
+      #
+      # Derived class must overwrite to return expected enum
+      def get_enum(col)
+        @vc.get_enum(@f.object.class, col)
+      end
+
+      # return bitset of the column
+      #
+      # Derived class must overwrite to return expected bitset
+      def get_bitset(col)
+        @vc.get_bitset(@f.object.class, col)
+      end
+
+      # flip field to left-lane or right-lane
+      def _draw_2_lane(&block)
+        result = @left ? '<tr>' : ''
+        result += yield
+        result += '</tr>' if !@left
+        @left = !@left              # flip it
+        result
+      end
+
+      # draw head(label).  SearchFormDrawer will overwrite to insert operator.
+      #
+      # === INPUTS
+      # col::   column info
+      # label:: if not-nil, label is used rather than human_attribute_name of col.name for field-label
+      # block:: wrapped field-drawing logic
+      #
+      def _draw_head(col, label=nil, &block)
+        _draw_2_lane{
+          html = @vc.content_tag(:th, label || @record.class.human_attribute_name(col.name))
+          html << @vc.content_tag(:td, '')
+          html << (@vc.content_tag(:td) do yield end)
+          html
+        }
+      end
+
+      def draw_id(col)
+        ''
+      end
+
+      def draw_type(col)
+        ''
+      end
+
+      def draw_created_at(col)
+        ''
+      end
+
+      def draw_updated_at(col)
+        ''
+      end
+
+      # draw address fields
+      def draw_address(col)
+        _draw_head(col){ @vc.draw_address(@f, col) }
+      end
+
+      # draw bitset checkboxes field
+      def draw_bitset(col, bitset)
+        _draw_head(col){ @vc.draw_bitset(@f, col, bitset, @options[:flags]) }
+      end
+
+      # draw 'belongs_to' field for AR
+      def _draw_belongs_to_field(parent_model, col)
+        _draw_head(col, @vc.draw_belongs_to_label(@f, @drawer.popup_path(col), col.name)){
+          @vc.draw_belongs_to_field(@f, col.name)
+        }
+      end
+
+      def draw_boolean(col)
+        _draw_head(col){ @vc.draw_boolean(@f, col, @options[:boolean]) }
+      end
+
+      def draw_file(col)
+        _draw_head(col){ @vc.draw_file(@f, col) }
+      end
+
+      def draw_enum(col, enum)
+        _draw_head(col){ @vc.draw_enum(@f, col, enum) }
+      end
+
+      # draw general field
+      def _draw_field(col)
+        case col.type
+        when :boolean
+          draw_boolean(col)
+        else
+          _draw_head(col){ @vc.draw_field(@f, col, @options[:default]) }
+        end
+      end
+    end
+
+    # Search-class differs from Base-class as follows:
+    # * draws the fields of ID, created_at, and updated_at for search
+    # * 'kind' selection has blank-option.
+    # * boolean is not checkbox.  Rather, it is selection of [nil,false,true]
+    # * edgarj_file column is not drawn. 
+    class Search < Base
+      # === INPUTS
+      # drawer::            Edgarj::Drawer instance
+      # model::             SearchForm object
+      # f::                 FormBuilder object
+      # operator_builder::  FormBuilder object for operator
+      def initialize(drawer, model, f, operator_builder)
+        super(drawer, model, f)
+        @operator_builder = operator_builder
+
+        # merge options
+        @options[:kind].merge!(:include_blank=>true)
+        @options[:default][:date].merge!(:include_blank=>true)
+      end
+
+      # overwrite
+      def columns
+        drawer = @vc.drawer
+        drawer.columns_for(drawer.search_form_columns)
+      end
+
+      # overwrite
+      def edgarj_address?(col)
+        @record._klass_str.constantize.edgarj_address?(col)
+      end
+
+      # overwrite
+      def edgarj_file?(col)
+        @record._klass_str.constantize.edgarj_file?(col)
+      end
+
+      # overwrite to insert operator
+      #
+      def _draw_head(col, label=nil, &block)
+        _draw_2_lane{
+          sprintf("<th>%s</th><td>", label || @record.class.human_attribute_name(col.name)) +
+
+          # add operator for appropreate data type.
+          if col.name == 'id'
+            @vc.draw_search_operator(@operator_builder, '_id')
+          else
+            case col.type
+            when :date, :datetime, :integer
+              @vc.draw_search_operator(@operator_builder, col.name)
+            else
+              ''
+            end
+          end + '</td><td>' + yield + '</td>'
+        }
+      end
+
+      # overwrite to draw 'id' search field
+      def draw_id(col)
+        _draw_head(col){ @f.text_field('_id', @options[:default][:integer]) }
+      end
+
+      # overwrite to draw created_at
+      def draw_created_at(col)
+        _draw_head(col){ @vc.draw_date(@f, col, @options[:default]) }
+      end
+
+      # overwrite to draw updated_at
+      def draw_updated_at(col)
+        _draw_head(col){ @vc.draw_date(@f, col, @options[:default]) }
+      end
+
+      # overwrite to draw address fields: TBD
+      def draw_address(col)
+        _draw_head(col){
+          'TBD'
+        }
+      end
+
+      # overwrite to draw 'belongs_to' field for SearchForm
+      #
+      # This is similar to Base class 'belongs_to field', but
+      # * add parent 'name' hidden field at drawing.
+      # * no link on parent name
+      def _draw_belongs_to_field(parent_model, col)
+        model = @f.object._klass_str.constantize
+        parent_name = @f.object._parent && @f.object._parent[col.name]
+        _draw_head(col, @vc.draw_belongs_to_label(@f, @drawer.popup_path_on_search(col), col.name, model)){
+          popup_field = Edgarj::PopupHelper::PopupField.new_builder(
+              @f.object_name, col.name)
+
+          @vc.content_tag(:span, parent_name, id: popup_field.label_target) +
+          @vc.hidden_field_tag(
+            'edgarj_search_form[search_form_parent][%s]' % col.name,
+            parent_name.blank? ? '' : parent_name,
+            id: popup_field.label_hidden_field) +
+          @vc.draw_belongs_to_clear_link(@f, col.name, popup_field, parent_name)
+        }
+      end
+
+      # overwrite because it is totally different from checkbox on search.
+      def draw_boolean(col)
+        _draw_head(col){
+          @f.select(col.name, [
+              ['(both)',  ''],
+              ['',        'false'],
+              ['√',       'true']])
+        }
+      end
+
+      # overwrite to return enum of the column in SearchForm
+      #
+      # see overwritten draw_enum() also.
+      def get_enum(col)
+        @vc.get_enum(@record._klass_str.constantize, col)
+      end
+
+      # overwrite to add '(all)' at top of enum selection for search.
+      #
+      # see overwritten get_enum() also.
+      def draw_enum(col, enum)
+        _draw_head(col){
+          @vc.draw_enum(@f, col, enum,
+              :choice_1st => ['(all)',''],
+              :class      => @record._klass_str.constantize
+              )
+        }
+      end
+
+      # overwrite to disable file upload column
+      def draw_file(col)
+        ''
+      end
+    end
+  end
+end

data/app/helpers/edgarj/list_drawer.rb

@@ -0,0 +1,169 @@
+# coding: UTF-8
+
+module Edgarj
+  module ListDrawer
+    # Base for popup-list and normal-list column drawer
+    #
+    # Sub class of Drawer to draw list
+    class Base
+      include ERB::Util
+
+      # * options
+      #   * namespace   - namespace for path (ex: :admin)
+      #
+      # TODO: enum_cache は止め、グローバルに１つのキャッシュを作る。
+      def initialize(drawer, options = {})
+        @drawer           = drawer
+        @options          = options.dup
+        @vc               = drawer.vc
+        @enum_cache       = {}
+        @bitset_cache     = {}
+        @parent_rec       = nil
+        @belongs_to_link  = false   # doesn't make link on belongs_to
+      end
+
+      def draw_column(rec, col)
+        @parent_rec = rec.belongs_to_AR(col)
+        @vc.content_tag(:td, td_options(rec, col)) do
+          # edgarj_address column is prior to draw_belongs_to() because of
+          # avoiding link_to process on the 'belongs_to' column.
+=begin
+          if rec.class.edgarj_address?(col)
+            col_name  = rec.class.get_column_name(col)
+            adrs      = Edgarj::Address.find_by_id(rec.send(col_name))
+            adrs ? draw_trimmed_str(adrs.name) : ''
+=end
+          if @parent_rec then
+            if @belongs_to_link
+              @vc.link_to(@parent_rec.name, @drawer.popup_path(col), remote: true)
+            else
+              h(@parent_rec.name)
+            end
+          else
+            draw_normal_column(rec, col)
+          end
+        end
+      end
+
+    private
+      # <td> options
+      def td_options(rec, col)
+        if @enum_cache[col.name]
+          {}
+        elsif @bitset_cache[col.name]
+          {}
+        elsif @parent_rec
+          {}
+        else
+          if @vc.get_enum(rec.class, col)
+            {}
+#         elsif @vc.get_bitset(rec.class, col)
+#           {}
+          else
+            case col.type
+            when :datetime
+              {}
+            when :date
+              {}
+            when :integer
+              {align: 'right'}
+            when :boolean
+              {align: 'center'}
+            else
+              {}
+            end
+          end
+        end
+      end
+
+      # trim string when too long
+      def draw_trimmed_str(str)
+        s = str.split(//)
+        if s.size > Edgarj::LIST_TEXT_MAX_LEN
+          s = s[0..Edgarj::LIST_TEXT_MAX_LEN] << '...'
+        end
+        s.join('')
+      end
+
+
+      # draw rec.col other than 'belongs_to'
+      # 1. DateTime format is YYYY-MM-DD hh:mm:ss.
+      # 1. if col.name == 'flags', it is assumed bitset.
+      # 1. if col is edgarj_file, it is assumed file.
+      #
+      # === INPUTS
+      # rec::   AR instance
+      # col::   ActiveRecord::ConnectionAdapters::Column type which rec.class.columns returns
+      def draw_normal_column(rec, col)
+=begin
+        if rec.class.edgarj_file?(col)
+          file_info = FileInfo.safe_find(rec.send(col.name))
+          file_info ? file_info.filename : ''
+        elsif (enum = @enum_cache[col.name])
+          @vc.draw_column_enum(rec, col, enum)
+        elsif (bitset = @bitset_cache[col.name])
+          @vc.draw_column_bitset(rec, col, bitset)
+        else
+=end
+          if (enum = @vc.get_enum(rec.class, col))
+            @enum_cache[col.name] = enum
+            @vc.draw_column_enum(rec, col, enum)
+=begin
+          elsif (bitset = @vc.get_bitset(rec.class, col))
+            @bitset_cache[col.name] = bitset
+            @vc.draw_column_bitset(rec, col, bitset)
+=end
+          else
+            case col.type
+            when :datetime
+              @vc.datetime_fmt(rec.send(col.name))
+            when :date
+              @vc.date_fmt(rec.send(col.name))
+            when :integer
+              h(rec.send(col.name))
+            when :boolean
+              rec.send(col.name) ? '√' : ''
+            else
+              # NOTE: rec.send(col.name) is not used since sssn.send(:data)
+              # becomes hash rather than actual string-data so that following
+              # split() fails for Hash.
+              if str = rec.attributes[col.name]
+                draw_trimmed_str(str)
+              else
+                ''
+              end
+            end
+          end
+       #end
+      end
+    end
+
+    # Drawer for record list in Edgarj CRUD view.
+    #
+    class Normal < Base
+      def initialize(edgarj_drawer, options = {})
+        super(edgarj_drawer, options)
+       #@belongs_to_link  = true    # make link on belongs_to
+      end
+
+      # prepare path for the rec, which will be drawn later.
+      def set_path(rec)
+        @path = @vc.polymorphic_path([@options[:namespace], rec], format: :js)
+      end
+
+      # <td> options
+      #
+      # add Edgarj.click_listCB() with base result.
+      # When the column is parent, do nothing.
+      def td_options(rec, col)
+        result = super.merge(
+            style:  'cursor:pointer;',
+            class:  '_edgarj_list_column')
+       #if !@parent_rec
+          result[:'data-url'] = @path
+       #end
+        result
+      end
+    end
+  end
+end

data/app/helpers/edgarj/menu_helper.rb

@@ -0,0 +1,92 @@
+# draw Edgarj menu based on application's menu configuration
+# at config/edgarj/menu_config.rb.
+#
+# Edgarj::MenuConfig should have 'top' module-function which returns arrays each
+# entry is one of the followings:
+#
+# * item which contains link_to arg
+# * controller menu list which contains controller name
+#   * special entry is '_separator' which is not controller name, rather
+#     generates just menu separator.
+#
+# See test/dummy/config/edgarj/menu_config.rb as an example.
+#
+# === SEE ALSO
+# draw_menu::                   method to draw menu
+#
+# === FILE
+# config/initializer/menu.rb::  menu configuration at application
+module Edgarj::MenuHelper
+  require File.join(Rails.root, 'config/edgarj/menu_config.rb')
+  include Edgarj::MenuConfig
+
+  def draw_menu
+    content_tag(:ul, :id=>'edgarj_menu', :class=>'edgarj_menu') do
+      out = ''
+      for menu in Edgarj::MenuConfig.top
+        out += content_tag(:li) do
+          case menu[0]
+          when :item
+            draw_item(*menu[1])
+          when :controller
+            draw_controller_menu(menu[1], menu[2], menu[3])
+          else
+            "unknown menu type: #{menu[0]}"
+          end
+        end
+      end
+      out.html_safe
+    end
+  end
+
+private
+  # draw menu item
+  #
+  # === INPUTS
+  # link_to_args:: link_to args
+  def draw_item(*link_to_args)
+    content_tag(:li) do
+      link_to(
+          v(link_to_args[0]),
+          *link_to_args[1, link_to_args.size - 1])
+    end
+  end
+
+  # draw controller menu for arg
+  #
+  # @param [string] name menu name
+  # @param [ActionDispatch::Routing::RouteSet] route_proxy routes for url_for() method calling
+  # @param [Array] menu_items array of string(menu item name)
+  def draw_controller_menu(name, route_proxy, menu_items)
+    link_to(v(name.to_s), '#') +
+    content_tag(:ul) do
+      out = ''
+      for menu_item in menu_items do
+        out += content_tag(:li) do
+          case menu_item
+          when '_separator'
+            '<hr>'.html_safe
+            # <hr> background doesn't work as I expected so that
+            # use <div> with border color
+            #'<div class=separator>x</div>'.html_safe
+          else
+            ctrl_str  = menu_item
+            if permitted_on?(ctrl_str)
+              # NOTE: controller string begins with '/' below.  This ensures
+              # top name space.  See Rails API url_for().  For example,
+              # Album::Book page, url is like /PREFIX/album/books/....
+              # If there is no beginning '/', User controler page means Album::User.
+              # This is not expected behavior at menu.
+              link_to(
+                  "#{ctrl_str.camelize}Controller".constantize.new.send(:human_name),
+                  route_proxy.url_for(
+                      controller:   '/' + ctrl_str,
+                      only_path:    true))
+            end
+          end
+        end
+      end
+      out.html_safe
+    end
+  end
+end

data/app/helpers/edgarj/model_permissions_helper.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  module ModelPermissionsHelper
+    class ModelPermissionDrawer < Edgarj::Drawer::Normal
+      def initialize(view_context, params, page_info, model_class = Edgarj::ModelPermission)
+        super
+      end
+    end
+  end
+end

data/app/helpers/edgarj/popup_helper.rb

@@ -0,0 +1,40 @@
+# coding: UTF-8
+module Edgarj  
+  module PopupHelper
+    # handle popup related fields to simplify params[] passing
+    # from browser to server.
+    #
+    # === SEE ALSO
+    # Edgarj.Popup.Field:: same logic at js side
+    class PopupField
+      attr_accessor(
+          :id_target,
+          :label_target,
+
+          # NOTE: This is search-form specific hidden field
+          # to store parent name.  This will be used when re-drawing
+          # search-form.
+          :label_hidden_field,
+          :clear_link)
+
+      # new from object_name and col_name
+      def self.new_builder(object_name, col_name)
+        new(object_name.to_s + '_' + col_name.to_s)
+      end
+
+      def initialize(id_target)
+        raise Edgarj::NoPopupTarget if id_target.blank?
+
+        @id_target    = id_target
+        # Using id_target as suffix rather than prefix is to avoid
+        # DOM-id conflict.  For example, if id_target is 'author_id' and
+        # use it as prefix, then label_target would be something like
+        # 'author_id_label_target' and it would be conflict with actual
+        # author.id_label_target DB column.
+        @label_target = '__edgarj_label_target_for_' + @id_target
+        @label_hidden_field = '__edgarj_label_hidden_field_for_' + @id_target
+        @clear_link   = @label_target + '_clear_link'
+      end
+    end
+  end
+end

data/app/helpers/edgarj/search_helper.rb

@@ -0,0 +1,14 @@
+# coding: UTF-8
+
+module Edgarj
+  module SearchHelper
+    # === INPUTS
+    # o::       operator form builder
+    # method::  column name
+    def draw_search_operator(o, method)
+      render '/edgarj/edgarj/search_operator',
+          o:        o,
+          method:   method
+      end
+  end
+end

data/app/helpers/edgarj/sessions_helper.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  module SessionsHelper
+    class SessionDrawer < Edgarj::Drawer::Normal
+      def initialize(view_context, params, page_info, model = Sssn)
+        super
+      end
+    end
+  end
+end

data/app/helpers/edgarj/user_group_users_helper.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  module UserGroupUsersHelper
+    class UserGroupUserDrawer < Edgarj::Drawer::Normal
+      def initialize(view_context, params, page_info, model_class = UserGroupUser)
+        super
+      end
+    end
+  end
+end

data/app/helpers/edgarj/user_groups_helper.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  module UserGroupsHelper
+    class UserGroupDrawer < Edgarj::Drawer::Normal
+      def initialize(view_context, params, page_info, model = UserGroup)
+        super
+      end
+    end
+  end
+end

data/app/helpers/edgarj/user_groups_popup_helper.rb

@@ -0,0 +1,9 @@
+module Edgarj
+  module UserGroupsPopupHelper
+    class UserGroupPopupDrawer < Edgarj::Drawer::Popup
+      def initialize(view_context, params, page_info, model = UserGroup)
+        super
+      end
+    end
+  end
+end