edgarj 0.01.12

data/app/models/edgarj/drawer/base.rb

@@ -0,0 +1,234 @@
+module Edgarj
+  module Drawer
+    # 'Mediator' to draw list and form of the model on the view.
+    class Base
+      attr_accessor :vc
+
+      # * options
+      #   * list_drawer_options   - options for Edgarj::ListDrawer::Normal
+      #   * draw_form_options     - options for draw_form_options
+      def initialize(view_context, params, page_info, model, options={})
+        @vc         = view_context
+        @params     = params
+        @page_info  = page_info
+        @model      = model
+        @options    = options.dup
+      end
+
+  # level-1 methods which may be modified most frequently:
+
+      # define model-wide default columns for view.
+      #
+      # If you need to customize, overwrite it at derived model class.
+      # Example:
+      #   def columns
+      #     %w(id name email updated_at)
+      #   end
+      #
+      # === SEE ALSO
+      # list_columns::         define list columns
+      # form_columns::         define form columns
+      # search_form_columns::  define search form columns
+      def columns
+        @model.columns.map{|c| c.name}
+      end
+
+      # This defines list columns.
+      # You can overwrite this method at each model if it is different from
+      # columns.  Default is calling columns().
+      #
+      # === SEE ALSO
+      # columns::              define default columns
+      # form_columns::         define form columns
+      # search_form_columns::  define search form columns
+      #
+      def list_columns
+        columns
+      end
+
+      # This defines form columns.
+      # You can overwrite this method at each model if it is different from
+      # columns.  Default is calling columns().
+      #
+      # === SEE ALSO
+      # columns::              define default columns
+      # list_columns::         define list columns
+      # search_form_columns::  define search form columns
+      #
+      def form_columns
+        columns
+      end
+
+      # This defines search-form columns.
+      # You can overwrite this method at each model if it is different from
+      # columns.  Default is calling columns().
+      #
+      # === SEE ALSO
+      # columns::              define default columns
+      # list_columns::         define list columns
+      # form_columns::         define form columns
+      #
+      def search_form_columns
+        columns
+      end
+
+  # level-2 methods which may be modified occasionally:
+
+      # This defines popup path for the column on the model.
+      #
+      # Default returns parent model's popup-controller.
+      # For example, book.author_id -> 'authors_popup' path
+      #
+      # You can overwrite this method at each model if it is different from
+      # columns.
+      #
+      # @see popup_path_on_search     popup path for the column on the model's search form
+      def popup_path(col)
+        parent_model = @model.belongs_to_AR(col)
+        raise 'Parent is nil' if !parent_model
+
+        popup_field = PopupHelper::PopupField.new_builder(@model.model_name.param_key, col.name)
+        @vc.main_app.url_for(
+            controller: parent_model.model_name.collection + '_popup',
+            id_target:  popup_field.id_target)
+      end
+
+      # This defines popup path for the search column on the model.
+      #
+      # Default returns parent model's popup-controller with id_target
+      # on the search column.
+      #
+      # @see popup_path     popup path for the column on the model itself
+      def popup_path_on_search(col)
+        parent_model = @model.belongs_to_AR(col)
+        raise 'Parent is nil' if !parent_model
+
+        popup_field = PopupHelper::PopupField.new_builder(Edgarj::SearchForm.model_name.param_key, col.name)
+        @vc.main_app.url_for(
+            controller: parent_model.model_name.collection + '_popup',
+            id_target:  popup_field.id_target)
+      end
+
+      # draw sort link on list column header
+      #
+      # === INPUTS
+      # col::         column data
+      # options::     options to url_for
+      def draw_sort(col, options={})
+        label = @model.human_attribute_name(col.name)
+        dir   = 'asc'
+        if @page_info.order_by == fullname(col)
+          # toggle direction
+          if @page_info.dir == 'asc' || @page_info.dir.blank?
+            label += '▲'
+            dir    = 'desc'
+          else
+            label += '▼'
+          end
+        end
+        @vc.link_to(label,
+            {
+            :controller                   => @params[:controller],
+            :action                       => 'page_info_save',
+            :id                           => @page_info.id,
+            'edgarj_page_info[order_by]'   => fullname(col),
+            'edgarj_page_info[dir]'        => dir
+            }.merge(options),
+            :remote => true,
+            :method => :put)
+      end
+
+      # draw list column header for both usual list and popup list
+      def draw_list_column_header(col, options={})
+        parent = @model.belongs_to_AR(col)
+        if parent then
+          @vc.draw_belongs_to_label_sub(@model, col.name, parent)
+        else
+          draw_sort(col, options)
+        end
+      end
+
+      def list_drawer_class
+        Edgarj::ListDrawer::Normal
+      end
+
+      def draw_list(list)
+        line_color  = 1
+        d           = list_drawer_class.new(
+            self,
+            @options[:list_drawer_options] || {})
+
+        @vc.content_tag(:table, width: '100%', class: 'list') do
+          @vc.content_tag(:tr) do
+            ''.html_safe.tap do |result|
+              for col in columns_for(list_columns) do
+                result << @vc.content_tag(:th) do
+                  draw_list_column_header(col)
+                end
+              end
+            end
+          end +
+          ''.html_safe.tap do |trs|
+            for rec in list do
+              line_color = 1 - line_color
+              d.set_path(rec)
+              trs << @vc.content_tag(:tr, class: "list_line#{line_color}") do
+                ''.html_safe.tap do |cols|
+                  for col in columns_for(list_columns) do
+                    cols << d.draw_column(rec, col)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # return table_name + col.name
+      def fullname(col)
+        @model.table_name + '.' + col.name
+      end
+
+      def form_drawer_class
+        Edgarj::FormDrawer::Base
+      end
+
+      def draw_form(record)
+        url_hash = {
+          controller: @params[:controller],
+          action:     record.new_record? ? 'create' : 'update',
+        }
+        url_hash[:id] = record.id if record.persisted?
+        @vc.form_for(record,
+            remote: true,
+            url:    url_hash,
+            html:   {
+                id:         '_edgarj_form',
+                method:     record.new_record? ? 'post' : 'put',
+                multipart:  true,
+               #target:     'edgarj_form_frame'
+            }) do |f|
+          form_drawer_class.new(self, record, f).draw() +
+
+          # to avoid submit on 1-textfield form when hit [ENTER] key
+          '<input type="text" name="dummy" style="visibility:hidden" size=0>'.html_safe
+        end +
+        @vc.draw_form_buttons(@options[:draw_form_options] || {})
+      end
+
+      # return array of model columns (ActiveRecord::ConnectionAdapters::X_Column type).
+      #
+      # === INPUTS
+      # column_name_list::  column name list
+      def columns_for(column_name_list)
+        [].tap do |result|
+          for col_name in column_name_list do
+            if (col = @model.columns_hash[col_name])
+              result << col
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/edgarj/drawer/normal.rb

@@ -0,0 +1,6 @@
+module Edgarj
+  module Drawer
+    class Normal < Base
+    end
+  end
+end

data/app/models/edgarj/drawer/popup.rb

@@ -0,0 +1,47 @@
+module Edgarj
+  module Drawer
+    # PopupDrawer is the same as Drawer to draw 'belongs_to' model
+    # to popup window.
+    #
+    # For example, AuthorPopupDrawer is to draw Author popup,
+    # which is called from Book page.
+    #
+    # * options
+    #   * list_drawer_options   - options for Edgarj::ListDrawer::Normal
+    class Popup < Base
+      def draw_list(list)
+        line_color  = 1
+        d           = Edgarj::ListDrawer::Normal.new(
+            self,
+            @options[:list_drawer_options] || {})
+
+        @vc.content_tag(:table, width: '100%', class: 'list') do
+          @vc.content_tag(:tr) do
+            ''.html_safe.tap do |result|
+              for col in columns_for(list_columns) do
+                result << @vc.content_tag(:th) do
+                  draw_list_column_header(col, id_target: @params[:id_target])
+                end
+              end
+            end
+          end +
+          ''.html_safe.tap do |trs|
+            for rec in list do
+              line_color = 1 - line_color
+              d.set_path(rec)
+              trs << @vc.content_tag(:tr,
+                        class:  "list_line#{line_color} edgarj_popup_list_row",
+                        data:   {id: rec.id, name: rec.name}) do
+                ''.html_safe.tap do |cols|
+                  for col in columns_for(list_columns) do
+                    cols << d.draw_column(rec, col)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/edgarj/drawer.rb

@@ -0,0 +1,13 @@
+module Edgarj
+  # Drawer is a 'presentor' and it is similar to decorator (like Draper),
+  # but this simply connects model to view in order to have view-related
+  # information for the model (or, to isolate view-related information
+  # from the model), while decorator inherits both model and
+  # view.
+  module Drawer
+  end
+end
+
+require 'edgarj/drawer/base'
+require 'edgarj/drawer/normal'
+require 'edgarj/drawer/popup'

data/app/models/edgarj/model_permission.rb

@@ -0,0 +1,41 @@
+# Model-wide CRUD permission for role.  In other words, 
+# CRUD permission for each model for each role is defined by this.
+#
+# This permission is used for two purposes:
+#
+# 1. page access permission
+#    * If this object,which relates to a model by model-attribute, exists and
+#      user belongs to the role (= user-group), then the controller,
+#      which 'model_class' method returns the model, can be accessed.
+# 1. popup access permission
+#    * Popup access for a model-class is an read-permission for that.
+#
+# Example:
+# 1. User 'u' belongs to 'x-role' Edgarj::UserGroup.
+# 1. x-role has author model permission.
+# 1. User 'u' can access AuthorController page.
+# 1. If x-role has READ permission on author model, then
+#    user 'u' can see author-popup on any 'belongs_to' related page
+#    (e.g. BookController book form's author-popup).
+module Edgarj
+  class ModelPermission < ActiveRecord::Base
+    self.table_name = 'edgarj_model_permissions'
+    belongs_to      :user_group
+
+    # define bitset on 'flags' column
+    module FlagsBitset
+      CREATE  = 0x01
+      READ    = 0x02
+      UPDATE  = 0x04
+      DELETE  = 0x08
+    end
+    FLAGS_ALL = FlagsBitset.constants.inject(0){|sum, flag|
+      sum += FlagsBitset.const_get(flag)
+    }
+
+    # return true if *ALL* requested flags are included in flags
+    def permitted?(requested_flags)
+      (self.flags & requested_flags) == requested_flags
+    end
+  end
+end

data/app/models/edgarj/page_info.rb

@@ -0,0 +1,47 @@
+module Edgarj
+  class PageInfo < ActiveRecord::Base
+    self.table_name = 'edgarj_page_infos'
+
+    belongs_to  :sssn
+
+    def self.intern(sssn, view, search_obj)
+      if !sssn || !(page_info = sssn.page_infos.find_by_view(view))
+        page_info = sssn.page_infos.build(
+            view:     view,
+            lines:    10,
+            order_by: '',
+            dir:      '',
+            page:     1)
+        page_info.record = search_obj
+
+        # save it to get id since id will be used later e.g.
+        # @vs.link_to(... @page_info.id) in Edgarj::Drawer::Base#draw_sort
+        page_info.save!
+      end
+      page_info
+    end
+
+    # serialize model and set it to model_data
+    #
+    def record=(record)
+      self.record_data = Base64.encode64(Marshal.dump(record))
+    end
+
+    # de-serialize in model_data and return it
+    #
+    def record
+      if self.record_data
+        # FIXME: Following code fixes the error:
+        #  - ArgumentError (undefined class/module Search)
+        #  - ArgumentError (undefined class/module SearchForm)
+        #
+        # But some autoload may smartlier fixes this?
+        Search
+        SearchForm
+        Marshal.load(Base64.decode64(self.record_data))
+      else
+        nil
+      end
+    end
+  end
+end

data/app/models/edgarj/search.rb

@@ -0,0 +1,81 @@
+module Edgarj
+  # Search condition
+  #
+  # Abstract class to SearchForm and SearchPopup to provide common method
+  # 'conditions'.
+  #
+  # 'Search' instance will be stored in view_status.model.
+  #
+  # \@errors will be used for error_messages_for helper in search-form.
+  class Search
+    # required at 'form_for' helper
+    extend ActiveModel::Naming
+    extend ActiveModel::Conversion
+#   include ActiveModel::Conversion     ??
+    include ActiveModel::Validations
+
+    # to support 'human_attribute_name'
+    extend ActiveModel::Translation
+
+    # cache the map: column name -> column type
+    #
+    # SearchForm instance is serialized to be stored at session so that
+    # another class (=Cache) is introduced to store cache information. 
+    class Cache
+      include Singleton
+
+      attr_accessor :klass_hash, :hit, :miss
+
+      def initialize
+        @klass_hash = {}
+
+        # for cache statistics
+        @hit   = 0
+        @miss  = 0
+      end
+
+      # report hit rate
+      def klass_hash_report
+        sprintf("%d/%d", @hit, @hit + @miss)
+      end
+    end
+
+    attr_accessor :errors, :_klass_str
+
+    def initialize(klass)
+      @errors     = ActiveModel::Errors.new(self)
+      @_klass_str = klass.to_s
+    end
+
+    # generate search-conditions from ActiveRecord attributes
+    #
+    # === RETURN
+    # [condition_string, value_array]:: values for :conditions option on model
+    def conditions
+      raise "Not implemented"
+    end
+
+    def persisted?
+      false
+    end
+
+  private
+    # cache column type
+    def column_type(col_name)
+      cache = Cache.instance
+      cache.klass_hash[@_klass_str] ||= {}
+      if v = cache.klass_hash[@_klass_str][col_name.to_s]
+        cache.hit += 1
+        v
+      else
+        cache.miss += 1
+        col = @_klass_str.constantize.columns.find{|c|
+          c.name == col_name.to_s
+        }
+        if col
+          cache.klass_hash[@_klass_str][col_name.to_s] = col.type
+        end
+      end
+    end
+  end
+end