edgarj 4.02.00 → 4.03.00

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb262ae814e088c79954becacd222d8cdc4b3797
-  data.tar.gz: 7fe707418fcedd8a51a40f15100008390ec30829
+  metadata.gz: a6e9e87b3ebbda6b9e3ad40f1f2f2496208c0674
+  data.tar.gz: 5539c9053f74354ec35ecae734bc82128c3fe05c
 SHA512:
-  metadata.gz: 5595e58910da9ee716808607d7e28dd435d16d029feb749feb035c0192d8ba350e44a6f09b471508caba00006601506a7767117cea4dbaa1bb76fb3676681476
-  data.tar.gz: e51083e18e3578df94d6691ab653d4ddce11eaf27d0c8601361ff6abe48d0280c36ae27107a6f7a958fb62af38b131acc4ce0e3b14ea289d358a04232e052d6d
+  metadata.gz: 1b8396a15cb2e18c79b6b5769f98339c89dd560f9816de54fd7b87ca7bc35e5a218a215b961bda07085f6457a4d3c4992fa828fc48fdfc8d64b813f92de8688a
+  data.tar.gz: 1c2c1f664e0a2a0c1ac95f4e183f8152edc86098a38de0de594877d19cadcd793b1f440c7b419d180af34bb39cf58fda732576f09925574d960c63486632f2fc

data/README.rdoc

@@ -22,6 +22,17 @@ Edgarj 0.* for Rails 3.2
 * Rails
 * external 'User' model.
 
+== Dummy App
+
+* How to run
+    $ cd test/dummy
+    $ rake db:drop && rake db:create && rake db:migrate
+    $ FIXTURES_PATH=../../test/fixtures rake db:fixtures:load
+    $ rails server
+* How to test
+    $ cd [RAILS_ROOT]
+    $ rake test
+
 == KNOWN BUGS
 
 * "rake scaffold" (not "rake edgarj:scaffold") generates

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

@@ -1,8 +1,158 @@
+require 'singleton'
+
 module Edgarj
   module Drawer
+    # Column-info classes to provide the following common methods:
+    #
+    # * name
+    # * css_style
+    # * sort_key
+    # * column_header_label
+    # * column_value
+    #
+    # As wells as the following for backward compatibility:
+    # * type
+    module ColumnInfo
+      # ActiveRecord::ConnectionAdapters::[DRIVER]::Column wrapper
+      #
+      # NOTE: ColumnInfo::* classes instances are cached during server process
+      # lifetime so that dynamic object (like drawer) cannot be stored.
+      class Normal
+        # @param vc     [ViewContext]
+        # @param model  [AR]
+        # @param name   [String]
+        def initialize(vc, model, name)
+          @vc             = vc
+          @model          = model
+          @name           = name
+          @ar_column_info = model.columns_hash[name]
+        end
+
+        def name
+          @name
+        end
+
+        def css_style
+          case @ar_column_info.type
+          when :integer
+            {align: 'right'}
+          when :boolean
+            {align: 'center'}
+          else
+            {}
+          end
+        end
+
+        # return table_name + col.name for sort
+        def sort_key
+          @model.table_name + '.' + @name
+        end
+
+        # draw column header (with sort link)
+        #
+        # === INPUTS
+        # options::     options to url_for
+        def column_header_label(page_info, options)
+          label = @vc.column_label(@name)
+          dir   = 'asc'
+
+          if page_info.order_by == sort_key
+            # toggle direction
+            if page_info.dir == 'asc' || page_info.dir.blank?
+              label += '▲'
+              dir    = 'desc'
+            else
+              label += '▼'
+            end
+          end
+          @vc.link_to(label,
+            {
+              :action                       => 'page_info_save',
+              :id                           => page_info.id,
+              'edgarj_page_info[order_by]'  => sort_key,
+              'edgarj_page_info[dir]'       => dir
+            }.merge(options),
+            :remote => true,
+            :method => :put)
+        end
+
+        # draw rec.col other than 'belongs_to'
+        #
+        # === INPUTS
+        # rec::   AR instance
+        def column_value(rec, drawer)
+          if (enum = @vc.get_enum(rec.class, @ar_column_info))
+            @vc.draw_column_enum(rec, @ar_column_info, enum)
+          else
+            case @ar_column_info.type
+            when :datetime
+              @vc.datetime_fmt(rec.send(name))
+            when :date
+              @vc.date_fmt(rec.send(name))
+            when :integer
+              rec.send(name).to_s
+            when :boolean
+              rec.send(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[name]
+                draw_trimmed_str(str)
+              else
+                ''
+              end
+            end
+          end
+        end
+
+        # just for backward compatibility
+        def type
+          @ar_column_info.type
+        end
+
+        private
+
+        # 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
+      end
+
+      # auto-generated column-info for 'belongs_to' column
+      #
+      # parent model is assumed to have 'name' method
+      class BelongsTo < Normal
+        def initialize(vc, model, name, parent_model, belongs_to_link)
+          super(vc, model, name)
+          @parent_model     = parent_model
+          @belongs_to_link  = belongs_to_link
+        end
+
+        # column header for 'belongs_to' column prints label without
+        # any sort action unlike Normal-class behavior.
+        def column_header_label(page_info, options)
+          @vc.draw_belongs_to_label_sub(@model, name, @parent_model)
+        end
+
+        def column_value(rec, drawer)
+          @parent_rec = rec.belongs_to_AR(@ar_column_info)
+          if @belongs_to_link
+            @vc.link_to(@parent_rec.name, drawer.popup_path(self), remote: true)
+          else
+            @parent_rec ? @parent_rec.name : ''
+          end
+        end
+      end
+    end
+
     # 'Mediator' to draw list and form of the model on the view.
     #
-    # This collaborate with the following sub classes:
+    # This collaborates with the following sub classes:
     # Edgarj::ListDrawer::Normal::    for list
     # Edgarj::FormDrawer::Base::      for data entry form
     # Edgarj::FormDrawer::Search::    for search form
@@ -138,32 +288,25 @@ module Edgarj
 
         @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 << d.draw_column_header(col)
-              end
+            for col in columns_for(list_columns, :list) do
+              @vc.concat d.draw_column_header(col)
             end
           end +
-          ''.html_safe.tap do |trs|
+          @vc.capture do
             for rec in list do
               @line_color = 1 - @line_color
-              trs << draw_row(rec) do
-                ''.html_safe.tap do |cols|
-                  for col in columns_for(list_columns) do
-                    cols << d.draw_column(rec, col)
+              @vc.concat(draw_row(rec) do
+                @vc.capture do
+                  for col in columns_for(list_columns, :list) do
+                    @vc.concat d.draw_column(rec, col)
                   end
                 end
-              end
+              end)
             end
           end
         end
       end
 
-      # return table_name + col.name
-      def fullname(col)
-        @model.table_name + '.' + col.name
-      end
-
       # overwrite to replace form drawer for the model
       def form_drawer_class
         Edgarj::FormDrawer::Base
@@ -192,17 +335,60 @@ module Edgarj
         end
       end
 
+      # cache ColumnInfo array per 'controller x kind'
+      class ColumnInfoCache
+        include Singleton
+
+        def initialize
+          #Rails.logger.debug('ColumnInfoCache initialized')
+          @cache = {}
+        end
+
+        # return if @cache[controller][kind] exists
+        def presence(controller, kind)
+          if @cache[controller].nil?
+            @cache[controller] = {}
+          end
+          @cache[controller][kind]
+        end
+
+        def set(controller, kind, val)
+          if @cache[controller].nil?
+            @cache[controller] = {}
+          end
+          @cache[controller][kind] = val
+        end
+
+        def cache
+          @cache
+        end
+      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
+      # kind::              :list, :form, or :search_form
+      def columns_for(column_name_list, kind = :default)
+        if (val = ColumnInfoCache.instance.presence(@vc.controller.class, kind))
+          val
+        else
+          #Rails.logger.debug("ColumnInfoCache non-cached access for (#{@vc.controller.class.name} x #{kind})")
+          ColumnInfoCache.instance.set(@vc.controller.class, kind,
+              [].tap do |result|
+                for col_name in column_name_list do
+                  result <<
+                      if col_name.is_a?(ColumnInfo::Normal)
+                        col_name
+                      elsif (col = @model.columns_hash[col_name])
+                        if (parent = @model.belongs_to_AR(col))
+                          ColumnInfo::BelongsTo.new(@vc, @model, col_name, parent, false)
+                        else
+                          ColumnInfo::Normal.new(@vc, @model, col_name)
+                        end
+                      end
+                end
+              end)
         end
       end
 

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

@@ -25,22 +25,18 @@ module Edgarj
 
         @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 << d.draw_column_header(col, id_target: @params[:id_target])
-              end
+            for col in columns_for(list_columns, :list) do
+              @vc.concat d.draw_column_header(col, id_target: @params[:id_target])
             end
           end +
-          ''.html_safe.tap do |trs|
+          @vc.capture do
             for rec in list do
               @line_color = 1 - @line_color
-              trs << draw_row(rec) do
-                ''.html_safe.tap do |cols|
-                  for col in columns_for(list_columns) do
-                    cols << d.draw_column(rec, col)
-                  end
+              @vc.concat(draw_row(rec) do
+                for col in columns_for(list_columns, :list) do
+                  @vc.concat d.draw_column(rec, col)
                 end
-              end
+              end)
             end
           end
         end

data/app/helpers/edgarj/form_drawer.rb

@@ -81,7 +81,7 @@ module Edgarj
 
       def columns
         drawer = @vc.drawer
-        drawer.columns_for(drawer.form_columns)
+        drawer.columns_for(drawer.form_columns, :form)
       end
 
       # base method for derived class
@@ -215,7 +215,7 @@ module Edgarj
       # overwrite
       def columns
         drawer = @vc.drawer
-        drawer.columns_for(drawer.search_form_columns)
+        drawer.columns_for(drawer.search_form_columns, :search_form)
       end
 
       # overwrite

data/app/helpers/edgarj/list_drawer.rb

@@ -1,6 +1,8 @@
 # coding: UTF-8
 
 module Edgarj
+  # ListDrawer will be obsoleted.  Column will be handled by
+  # Edgarj::Drawer::ColumnInfo
   module ListDrawer
     # Base for popup-list and normal-list column drawer
     #
@@ -10,13 +12,10 @@ module Edgarj
 
       # * drawer        - Edgarj::Drawer::Base object
       # * options
-      #
-      # 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
@@ -24,161 +23,21 @@ module Edgarj
 
       def draw_column_header(col, options={})
         @vc.content_tag(:th) do
-          draw_column_header_sub(col, options)
+          col.column_header_label(@drawer.page_info, options)
         end
       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
+          col.column_value(rec, @drawer)
         end
       end
 
-    private
+      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 sort link on list column header
-      #
-      # === INPUTS
-      # col::         column data
-      # options::     options to url_for
-      def draw_sort(col, options={})
-        label = @vc.column_label(col)
-        dir   = 'asc'
-        if @drawer.page_info.order_by == @drawer.fullname(col)
-          # toggle direction
-          if @drawer.page_info.dir == 'asc' || @drawer.page_info.dir.blank?
-            label += '▲'
-            dir    = 'desc'
-          else
-            label += '▼'
-          end
-        end
-        @vc.link_to(label,
-            {
-            :controller                   => @drawer.params[:controller],
-            :action                       => 'page_info_save',
-            :id                           => @drawer.page_info.id,
-            'edgarj_page_info[order_by]'   => @drawer.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_column_header_sub(col, options={})
-        parent = @drawer.model.belongs_to_AR(col)
-        if parent then
-          @vc.draw_belongs_to_label_sub(@drawer.model, col.name, parent)
-        else
-          draw_sort(col, options)
-        end
-      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
+        col.css_style
       end
     end
 

data/app/views/edgarj/popup/_search.html.erb

@@ -19,7 +19,7 @@ params[:id_target]::    target DOM id for hidden 'belongs_to' id
       <td><%= v('search') %></td>
       <td>
         <%= f.select("col",
-                popup_drawer.columns_for(popup_drawer.list_columns).map{|col|
+                popup_drawer.columns_for(popup_drawer.list_columns, :list).map{|col|
                     [model.human_attribute_name(col.name), col.name]}) %>
       </td>
       <td><%= f.text_field("val") %></td>

data/lib/edgarj/version.rb

@@ -1,3 +1,3 @@
 module Edgarj
-  VERSION = "4.02.00"
+  VERSION = '4.03.00'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edgarj
 version: !ruby/object:Gem::Version
-  version: 4.02.00
+  version: 4.03.00
 platform: ruby
 authors:
 - Fuminori Ido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails