edgarj 0.01.12

data/app/views/edgarj/edgarj/_search_operator_selection.html.erb

@@ -0,0 +1,12 @@
+<%# operator selection menu items %>
+<% id = 'edgarj_search_operator_selection' %>
+<div class="contextMenu" id="<%= id -%>" style='display: none;'> <!-- edgarj/edgarj/_search_operator_selection.html.erb -->
+  <ul>
+    <li id="<%= id + '_eq' -%>">=</li>
+    <li id="<%= id + '_ne' -%>">&lt;&gt;</li>
+    <li id="<%= id + '_gt' -%>">&gt;</li>
+    <li id="<%= id + '_ge' -%>">&gt;=</li>
+    <li id="<%= id + '_lt' -%>">&lt;</li>
+    <li id="<%= id + '_le' -%>">&lt;=</li>
+  </ul>
+</div>

data/app/views/edgarj/edgarj/clear.js.erb

@@ -0,0 +1 @@
+$('#edgarj_form').replaceWith("<%= j(render 'form') %>");

data/app/views/edgarj/edgarj/create.js.erb

@@ -0,0 +1,4 @@
+<% if !@record.errors.any? %>
+  $('#edgarj_list').replaceWith("<%= j(render 'list') %>");
+<% end %>
+$('#edgarj_form').replaceWith("<%= j(render 'form') %>");

data/app/views/edgarj/edgarj/destroy.js.erb

@@ -0,0 +1,2 @@
+  $('#edgarj_list').replaceWith("<%= j(render 'list') %>");
+  $('#edgarj_form').replaceWith("<%= j(render 'form') %>");

data/app/views/edgarj/edgarj/index.html.erb

@@ -0,0 +1,37 @@
+<!-- edgarj/index.html.erb -->
+<table>
+  <tr>
+    <td id=page_title><h2><%= controller.send(:human_name) %></h2></td>
+  </tr>
+</table>
+<%= render 'list' %>
+<%= render 'form' %>
+<%= render 'search_form' %>
+<%= render 'search_operator_selection' %>
+
+<div id=edgarj_message_popup></div>
+<%= javascript_tag do %>
+$(function(){
+  $('#edgarj_search_form').hide();
+
+  /* init message-dialog, which will be mainly used to display error message */
+  $('#edgarj_message_popup').dialog({
+    autoOpen: false,
+    modal:    true,
+    title:    '<%= t('edgarj.message_popup.title') %>',
+    width:    800,
+  });
+});
+<% end %>
+
+<div id=edgarj_form_popup></div>
+<%= javascript_tag do %>
+$(function(){
+  /* init popup-dialog, but don't show */
+  $('#edgarj_form_popup').dialog({
+    autoOpen: false,
+    modal:    true,
+    width:    800,
+  });
+});
+<% end %>

data/app/views/edgarj/edgarj/index.js.erb

@@ -0,0 +1 @@
+$('#edgarj_list').replaceWith("<%= j(render 'list') %>");

data/app/views/edgarj/edgarj/message_popup.js.erb

@@ -0,0 +1,3 @@
+$('#edgarj_message_popup').html("<%= j(render 'message_popup') %>");
+$('#edgarj_message_popup').dialog('open');
+

data/app/views/edgarj/edgarj/page_info_save.js.erb

@@ -0,0 +1 @@
+$('#edgarj_list').replaceWith("<%= j(render 'list') %>");

data/app/views/edgarj/edgarj/search.js.erb

@@ -0,0 +1,4 @@
+<% if !@search.errors.any? %>
+  $('#edgarj_list').replaceWith("<%= j(render 'list') %>");
+<% end %>
+$('#edgarj_search_form').replaceWith("<%= j(render 'search_form') %>");

data/app/views/edgarj/edgarj/search_clear.js.erb

@@ -0,0 +1 @@
+$('#edgarj_search_form').replaceWith("<%= j(render 'search_form') %>");

data/app/views/edgarj/edgarj/show.js.erb

@@ -0,0 +1 @@
+$('#edgarj_form').replaceWith("<%= j(render 'form') %>");

data/app/views/edgarj/edgarj/top.html.erb

@@ -0,0 +1,4 @@
+<!-- edgarj/edgarj/top.html.erb -->
+<h2><%= t('top_screen') %></h2>
+
+(TBD)

data/app/views/edgarj/edgarj/update.js.erb

@@ -0,0 +1,4 @@
+<% if @record && !@record.errors.any? %>
+  $('#edgarj_list').replaceWith("<%= j(render 'list') %>");
+<% end %>
+$('#edgarj_form').replaceWith("<%= j(render 'form') %>");

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

@@ -0,0 +1,16 @@
+<!-- edgarj_popup/_index.html.erb -->
+<%#
+popup template.
+
+see EdgarjPopupController for more detail.
+%>
+<%= render 'search' %>
+<%= render 'list'   %>
+<hr>
+<center>
+  <%= button_tag t('close'),
+          type:     'button',
+          id:       'edgarj_popup_close',
+          onClick:  "$('#edgarj_form_popup').dialog('close');"
+  %>
+</center>

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

@@ -0,0 +1,42 @@
+<%#
+popup list.
+
+= INPUTS
+
+@list::                 popup model list
+params[:id_target]::    target DOM id for 'belongs_to' id (hidden)
+
+= OUTPUTS
+
+* paginate:
+  /edgarj_popup/index?update=...&template=
+* on click item, update id_target DOM by rec.id
+%>
+<% popup_field = Edgarj::PopupHelper::PopupField.new(params[:id_target]) %>
+<div id=edgarj_popup_list>           <!-- edgarj/popup/_list.html.erb -->
+  <table width="100%">
+    <tr>
+      <td><%= t('edgarj.default.total_records') % @count %></td>
+      <td><%= paginate @list,
+                  remote:         true,
+                  params:         {
+                    action:         'index',
+                   #model:          model.to_s,
+                    id_target:      popup_field.id_target}%></td>
+    </tr>
+  </table>
+  <%= popup_drawer.draw_list(@list) %>
+
+  <%= javascript_tag do %>
+  $(function(){
+    /* invoke select-callback on popup list */
+    $('.edgarj_popup_list_row').click(function(){
+      $('#<%= popup_field.id_target %>').val($(this).attr('data-id'));
+      $('#<%= popup_field.label_target %>').text($(this).attr('data-name'));
+      $('#<%= popup_field.label_hidden_field %>').val($(this).attr('data-name'));
+      $('#<%= popup_field.clear_link %>').show();
+      $('#edgarj_form_popup').dialog('close');
+    });
+  });
+  <% end %>
+</div>

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

@@ -0,0 +1,15 @@
+<!-- edgarj/_message_popup.html.erb -->
+<%#
+message popup template.
+%>
+
+<center>
+  <div id=edgarj_message_error ><%= flash[:error]  || '' %></div>
+  <div id=edgarj_message_notice><%= flash[:notice] || '' %></div>
+  <hr>
+  <%= button_tag t('close'),
+          type:     'button',
+          id:       'edgarj_message_popup_close',
+          onClick:  "$('#edgarj_message_popup').dialog('close');"
+  %>
+</center>

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

@@ -0,0 +1,42 @@
+<%#
+popup search form.
+
+= INPUTS
+
+@search::               search model
+params[:id_target]::    target DOM id for hidden 'belongs_to' id
+
+%>
+<div id=edgarj_popup_search>           <!-- edgarj/popup/_search.html.erb -->
+  <% pf = Edgarj::PopupHelper::PopupField.new(params[:id_target]) %>
+  <%= form_for(@search,
+          as:     'search_form',
+          remote: true,
+          method: :get,
+          url:    {action: 'search'}) do |f| %>
+    <table>
+    <tr>
+      <td><%= v('search') %></td>
+      <td>
+        <%= f.select("col",
+                popup_drawer.columns_for(popup_drawer.list_columns).map{|col|
+                    [model.human_attribute_name(col.name), col.name]}) %>
+      </td>
+      <td><%= f.text_field("val") %></td>
+      <td>
+        <% if @search.errors.any? %>
+          <div class="error_explanation">
+            <ul>
+              <% @search.errors.full_messages.each do |msg| %>
+                <li><%= msg %></li>
+              <% end %>
+            </ul>
+          </div>
+        <% end %>
+      </td>
+    </tr>
+    </table>
+    <%= hidden_field_tag :model,      model.to_s %>
+    <%= hidden_field_tag :id_target,  pf.id_target %>
+  <% end %>
+</div>

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

@@ -0,0 +1,16 @@
+<!-- edgarj/_search_save_popup.html.erb -->
+<div id=search_save_popup style='display:none'>
+<center>
+  <h3><%= t('search_save_dialog') %></h3>
+
+  <p id=search_save_popup_flash_error  style="color: red"
+      ><%=   @flash_error  || '' %></p>
+
+  <%= t('name') %><input type=text_field id=view_status_name>
+  <%= url = url_for(:action=>'search_save');
+      button_to_function t('save'),
+          sprintf("Edgarj.SearchSavePopup.submit('%s')", url) %>
+  <hr>
+  <%= button_to_function t('close'), 'Edgarj.SearchSavePopup.close()' %>
+</center>
+</div>

data/app/views/edgarj/popup/index.js.erb

@@ -0,0 +1,5 @@
+$('#edgarj_form_popup').html("<%= j(render 'index') %>");
+$('#edgarj_form_popup').dialog('option', 'title',
+    '<%= t('edgarj.form.popup.title') % model.human_name %>');
+$('#edgarj_form_popup').dialog('open');
+

data/app/views/edgarj/popup/message_popup.js.erb

@@ -0,0 +1,3 @@
+$('#edgarj_message_popup').html("<%= j(render 'message_popup') %>");
+$('#edgarj_message_popup').dialog('open');
+

data/app/views/edgarj/popup/page_info_save.js.erb

@@ -0,0 +1 @@
+$('#edgarj_popup_list').replaceWith("<%= j(render 'list') %>");

data/app/views/edgarj/popup/search.js.erb

@@ -0,0 +1,15 @@
+<%#
+index.js.erb needs to draw whole popup elements(list, search, close-button)
+while search.js.erb does only:
+
+* draw search form
+* draw list if @search is valid
+%>
+<% if !@search.errors.any? %>
+  $('#edgarj_popup_list').replaceWith("<%= j(render 'list') %>");
+<% end %>
+$('#edgarj_popup_search').replaceWith("<%= j(render 'search') %>");
+$('#edgarj_form_popup').dialog('option', 'title',
+    '<%= t('edgarj.form.popup.title') % model.human_name %>');
+$('#edgarj_form_popup').dialog('open');
+

data/app/views/edgarj/popup/view_status_save.js.erb

@@ -0,0 +1 @@
+$('#edgarj_popup_list').replaceWith("<%= j(render 'list') %>");

data/config/routes.rb

@@ -0,0 +1,15 @@
+Rails.application.routes.draw do
+  edgarj_resources :user_group_users
+
+  namespace :edgarj do
+    edgarj_popup_resources :users_popup
+    edgarj_popup_resources :user_groups_popup
+
+    edgarj_resources :model_permissions
+    edgarj_resources :sssns
+    edgarj_resources :user_groups
+    edgarj_resources :user_group_users
+  end
+
+  get :top, to: 'edgarj/edgarj#top'
+end

data/config/settings.yml

@@ -0,0 +1,5 @@
+edgarj:
+  base:
+    time_zone_for_timestamp_comparison: '9'
+  work_dir: <%= Rails.root + 'tmp/edgarj' %>
+  csv_dir:  <%= Rails.root + 'tmp/edgarj/csv_download' %>

data/db/migrate/20131118084600_create_edgar_sssns.rb

@@ -0,0 +1,14 @@
+class CreateEdgarSssns < ActiveRecord::Migration
+  def change
+    create_table :edgar_sssns do |t|
+      t.string :session_id, null: false
+      t.text    :data
+      t.integer :user_id
+
+      t.timestamps
+    end
+
+    add_index :edgar_sssns, :session_id
+    add_index :edgar_sssns, :updated_at
+  end
+end

data/db/migrate/20131123124730_create_edgar_page_infos.rb

@@ -0,0 +1,15 @@
+class CreateEdgarPageInfos < ActiveRecord::Migration
+  def change
+    create_table :edgar_page_infos do |t|
+      t.integer   :sssn_id
+      t.string    :view
+      t.string    :order_by
+      t.string    :dir
+      t.integer   :page
+      t.integer   :lines
+      t.text      :record_data
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140116062252_create_edgar_user_groups.rb

@@ -0,0 +1,18 @@
+class CreateEdgarUserGroups < ActiveRecord::Migration
+  def change
+    create_table :edgar_user_groups do |t|
+      t.integer   :kind
+      t.string    :name
+      t.integer   :parent_id
+      t.integer   :lft
+      t.integer   :rgt
+
+      t.timestamps
+    end
+
+    add_index :edgar_user_groups, :kind
+    add_index :edgar_user_groups, :parent_id
+    add_index :edgar_user_groups, :lft
+    add_index :edgar_user_groups, :rgt
+  end
+end

data/db/migrate/20140116062327_create_edgar_user_group_users.rb

@@ -0,0 +1,10 @@
+class CreateEdgarUserGroupUsers < ActiveRecord::Migration
+  def change
+    create_table :edgar_user_group_users do |t|
+      t.integer   :user_group_id
+      t.integer   :user_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140206222308_create_edgar_model_permissions.rb

@@ -0,0 +1,14 @@
+class CreateEdgarModelPermissions < ActiveRecord::Migration
+  def change
+    create_table :edgar_model_permissions do |t|
+      t.integer  "user_group_id"
+      t.string   "name"
+      t.integer  "flags"
+      t.datetime "created_at",    :null => false
+      t.datetime "updated_at",    :null => false
+      t.string   "model"
+    end
+
+    add_index :edgar_model_permissions, :model
+  end
+end

data/db/migrate/20141209053055_rename_edgar_to_edgarj.rb

@@ -0,0 +1,17 @@
+class RenameEdgarToEdgarj < ActiveRecord::Migration
+  def up
+    rename_table :edgar_sssns,              :edgarj_sssns
+    rename_table :edgar_page_infos,         :edgarj_page_infos
+    rename_table :edgar_user_groups,        :edgarj_user_groups
+    rename_table :edgar_user_group_users,   :edgarj_user_group_users
+    rename_table :edgar_model_permissions,  :edgarj_model_permissions
+  end
+
+  def down
+    rename_table :edgarj_sssns,             :edgar_sssns
+    rename_table :edgarj_page_infos,        :edgar_page_infos
+    rename_table :edgarj_user_groups,       :edgar_user_groups
+    rename_table :edgarj_user_group_users,  :edgar_user_group_users
+    rename_table :edgarj_model_permissions, :edgar_model_permissions
+  end
+end

data/lib/core_ext/active_record.rb

@@ -0,0 +1,123 @@
+# Add Edgarj specific methods.
+class ActiveRecord::Base
+  # cache several kind of information for each (class x kind) during runtime,
+  # for example, result of edgarj_address? method.
+  @@_edgarj_cache = {}
+
+  # Fallback is as follows (Author model is an example):
+  # 1. t('activerecord.author')
+  # 1. t('edgarj.default.author')
+  # 1. human()
+  def self.human_name
+    name = self.model_name
+    I18n.t(name.i18n_key,
+        scope:    :activerecord,
+        default:  I18n.t(name.i18n_key,
+            scope:   'edgarj.default',
+            default: name.human))
+  end
+
+  # return AR assoc which the column belongs to.  nil if not exist
+  def self.belongs_to_AR_assoc(column)
+    parent_assoc_cache = edgarj_cache(:parent_assoc)
+    if (parent_assoc = parent_assoc_cache[column])
+      return parent_assoc
+    end
+
+    for parent_assoc in reflect_on_all_associations(:belongs_to) do
+      if !parent_assoc.options[:polymorphic] &&
+          parent_assoc.foreign_key.to_sym == column.name.to_sym
+        parent_assoc_cache[column] = parent_assoc
+        return parent_assoc
+      end
+    end
+    nil
+  end
+
+  # return AR class which the column belongs to.  nil if not exist
+  def self.belongs_to_AR(column)
+    if (parent_assoc = belongs_to_AR_assoc(column))
+      parent_assoc.klass
+    else
+      nil
+    end
+  end
+
+  # Human name for 'const' in namespace of the '_module'.
+  #
+  # I18n fallbacks is as follows (Question::Priority::HIGH as example):
+  #
+  # 1. t('activerecord.enums.question/priority.HIGH')
+  # 1. t('high')
+  # 1. 'High'
+  #
+  def self.human_const_name(_module, const)
+    lower = const.downcase
+    I18n.t(const,
+        scope:    "activerecord.enums.#{_module.name.underscore}",
+        default:  I18n.t(lower,
+            scope:    'edgarj.default',
+            default:  lower.to_s.humanize))
+  end
+
+  # short-cut of:
+  #   errors.add(attr, I18n.t(message_key, :scope=>'activerecord.errors.messages')
+  def err_on(attr, message_key)
+    errors.add(
+        attr,
+        I18n.t(message_key, :scope=>'activerecord.errors.messages'))
+  end
+
+  # get belongs_to association name from column.
+  #
+  # Example: get_assoc_name(:adrs_id) -> :adrs
+  def self.get_belongs_to_name(col_or_sym)
+    cache     = edgarj_cache(:belongs_to_name)
+    col_name  = get_column_name(col_or_sym).to_s
+    if !cache[col_name].nil?
+      return cache[col_name]
+    end
+
+    for reflection in reflect_on_all_associations(:belongs_to) do
+      if reflection.foreign_key.to_sym == col_name.to_sym
+        cache[col_name] = reflection.name
+        return reflection.name
+      end
+    end
+    nil
+  end
+
+  # initialize cache per (class x kind) on the fly
+  def self.edgarj_cache(kind)
+    @@_edgarj_cache[self] = {}       if !@@_edgarj_cache[self]
+    @@_edgarj_cache[self][kind] = {} if !@@_edgarj_cache[self][kind]
+    @@_edgarj_cache[self][kind]
+  end
+
+  # just for dump purpose
+  def self._edgarj_cache
+    @@_edgarj_cache
+  end
+
+  # get column name from column object or symbol
+  def self.get_column_name(col_or_sym)
+    case col_or_sym
+    when String, Symbol
+      col_or_sym
+    else
+      col_or_sym.name
+    end
+  end
+
+  # return AR object which the column belongs to.
+  # return nil if the column is not 'belongs_to'
+  #
+  # @see self.belongs_to_AR
+  def belongs_to_AR(column)
+    if (parent_assoc = self.class.belongs_to_AR_assoc(column))
+      send(parent_assoc.name)
+    else
+      nil
+    end
+  end
+end

data/lib/core_ext/resources.rb

@@ -0,0 +1,71 @@
+module ActionDispatch::Routing::Mapper::Resources
+  # add followings to work on Edgarj::EdgarjController derived class to
+  # default resource routing:
+  #
+  #   collection do
+  #     get :clear
+  #     get :csv_download
+  #     get :search
+  #     get :search_clear
+  #     get :search_save
+  #     get :search_load
+  #   end
+  #
+  #   member do
+  #     put :page_info_save
+  #   end
+  #
+  def edgarj_resources(*symbols, &block)
+    resources *symbols do
+      yield if block_given?
+
+      collection do
+        get :clear
+        get :csv_download
+        get :search
+        get :search_clear
+        get :search_save
+        get :search_load
+        get :zip_complete
+      end
+
+      member do
+        put :page_info_save
+      end
+    end
+
+    self
+  end
+
+  # add followings to work on Edgarj::PopupController derived class to
+  # default resource routing:
+  #
+  #   collection do
+  #     get :clear
+  #     get :csv_download
+  #     get :search
+  #     get :search_clear
+  #     get :search_save
+  #     get :search_load
+  #   end
+  #
+  #   member do
+  #     put :page_info_save
+  #   end
+  #
+  def edgarj_popup_resources(*symbols, &block)
+    resources *symbols, only: [:index] do
+      yield if block_given?
+
+      collection do
+        get :search
+      end
+
+      member do
+        put :page_info_save
+      end
+    end
+
+    self
+  end
+end

data/lib/edgarj/engine.rb

@@ -0,0 +1,64 @@
+module Edgarj
+  class Engine < ::Rails::Engine
+    require 'core_ext/active_record'
+    require 'core_ext/resources'
+    require 'edgarj/enum_cache'
+
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../templates', __FILE__)
+    end
+
+    # load this engine's config
+    # (rails_config default loads from only Rails.root/config/...)
+    def self.load_config
+      engine_config_dir = Pathname.new(File.expand_path('../../../config', __FILE__))
+      Settings.add_source!((engine_config_dir + 'settings.yml').to_s)
+      Settings.add_source!((engine_config_dir + "settings/#{Rails.env}.yml").to_s)
+      Settings.reload!
+    end
+
+    # Require/load application side edgarj config in RAILS_ROOT/config/edgarj/
+    def self.load_edgarj_conf_in_app
+      [
+        Dir.glob(File.join(Rails.root, "config/edgarj/**/*.rb"))
+      ].flatten.each do |edgarj_conf|
+        Rails.application.config.cache_classes ?
+            require(edgarj_conf) :
+            load(edgarj_conf)
+      end
+    end
+
+    # Require/load (based on config) all decorators from app/decorators/
+    #
+    # thanks:
+    # * http://edgeguides.rubyonrails.org/engines.html#overriding-models-and-controllers
+    # * https://github.com/resolve/refinerycms/commit/3387b547f8e58c9fced9eee78ca1bd2acd2588c2
+    def self.load_decorators
+      [
+        Dir.glob(File.join(Rails.root, "app/decorators/**/*_decorator.rb"))
+      ].flatten.each do |decorator|
+        Rails.application.config.cache_classes ?
+            require(decorator) :
+            load(decorator)
+      end
+    end
+
+    # make edgarj related work directories
+    def self.make_work_dir
+      for dir in [Settings.edgarj.work_dir, Settings.edgarj.csv_dir] do
+        FileUtils.mkdir_p(dir) if !File.directory?(dir)
+      end
+    end
+
+    initializer "edgarj" do
+      ActiveRecord::SessionStore::Session.table_name = 'edgarj_sssns'
+      Engine::load_config
+      Engine::load_edgarj_conf_in_app
+      Engine::load_decorators
+      for file in Dir.glob(File.join(File.dirname(__FILE__), "../../locale/*.yml")) do
+        I18n.load_path << file
+      end
+      Engine::make_work_dir
+    end
+  end
+end