edgarj 0.01.12

data/app/controllers/edgarj/authentication_mixin.rb.sample

@@ -0,0 +1,30 @@
+module Edgarj
+  module AuthenticationMixin
+    def self.included(klass)
+      klass.helper_method :current_user
+    end
+
+  private
+    def access_denied
+      flash.now[:error] = v('login_failed')
+     #redirect_to login_path
+      respond_to do |format|
+        format.html {
+          render '/edgarj/sssns/new', layout: 'login'
+        }
+        format.js {
+          render '/edgarj/sssns/new'
+        }
+      end
+    end
+
+    # before_filter to enforce a login requirement.
+    def require_login
+      !!current_user || access_denied
+    end
+
+    def current_user
+      @current_user ||= User.find(session[:user_id]) if session[:user_id]
+    end
+  end
+end

data/app/controllers/edgarj/controller_mixin_common.rb

@@ -0,0 +1,80 @@
+module Edgarj
+  # Common module for EdgarjController and PopupController.
+  module ControllerMixinCommon
+    def self.included(klass)
+      klass.before_filter :intern_sssn
+    end
+
+    # page is reset to 1 since order and/or lines/page are/is changed.
+    def page_info_save
+      if (@page_info = @sssn.page_infos.find_by_id(params[:id]))
+        @page_info.update_attributes(page_info_params)
+        @page_info.update_attribute(:page, 1)
+      end
+      prepare_list
+    end
+
+  private
+    # return page related infomation for each controller x session.
+    #
+    # search_form may depend on each controller so that search_form
+    # method should be defined for each controller.
+    def page_info
+      @page_info ||= PageInfo.intern(@sssn, controller_name, search_form)
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def page_info_params
+      params.require(:edgarj_page_info).permit(
+        :view,
+        :order_by,
+        :dir,
+        :page,
+        :lines,
+        :record_data)
+    end
+
+    # prepare followings:
+    # 1. @page_info
+    # 1. @count
+    # 1. @list (with user_scoped if defined)
+    #
+    # This private method is called from both EdgarjController and
+    # EdgarjPopupController to draw list.
+    #
+    # You can overwrite prepare_list() to show list at your controller.
+    def prepare_list
+      page_info
+      @list = user_scoped.where(@page_info.record.conditions).
+          page(@page_info.page).
+          per(@page_info.lines)
+      if !@page_info.order_by.blank?
+        @list = @list.order(@page_info.order_by + ' ' + @page_info.dir)
+      end
+
+      @count = user_scoped.where(@page_info.record.conditions).count
+    end
+
+    # provide 2nd parameter for Model.user_scoped(user, context).
+    # Default is @sssn.
+    def scope_context
+      @sssn
+    end
+
+    # narrow data scope on model
+    #
+    # Model's user_scoped parameters are as follows:
+    # 1st argument::  current_user
+    # 2nd argument::  scope_context method result (default = @sssn)
+    # 3rd argument::  target for popup (see below for the detail)
+    #
+    # === 3rd argument
+    # This is used to identify which column the selected value
+    # on the popup is populated.
+    def user_scoped
+      @_user_scoped ||= model.respond_to?(:user_scoped) ?
+          model.user_scoped(current_user, scope_context, params[:id_target]) :
+          model
+    end
+  end
+end

data/app/controllers/edgarj/controller_mixin_for_app.rb

@@ -0,0 +1,71 @@
+module Edgarj
+  # Mixin for All controllers (not only Edgarj::ControllerMixin include class)
+  module ControllerMixinForApp
+    def self.included(klass)
+      klass.helper_method :v, :url_prefix
+    end
+
+  private
+    # Transform the controller name into a more humane format, using I18n.
+    # I18n fallbacks work as follows (LeadsController as example):
+    #
+    # 1. t('activerecord.models.lead')
+    # 1. t('controller.leads')
+    # 1. t('lead')
+    # 1. 'Lead'
+    def human_name
+      @human_name ||= begin
+        str = controller_path
+        single = str.singularize
+        I18n.t(         "activerecord.models.#{model.to_s.underscore}",
+          default:      I18n.t("controller.#{str}",
+            default:    I18n.t(single,
+              default:  single.camelize)))
+      end
+    end
+
+    # application-wide rescue to log error info.
+    def app_rescue
+      logger.error(sprintf("error %s(%s) at %s#%s:\n%s",
+         $!.class.to_s,
+         $!.to_s,
+         self.class.name,
+         self.action_name,
+         $@.join("\n")))
+    end
+
+    # set @sssn if not exist
+    def intern_sssn
+      @sssn ||=
+          if (sid = request.session_options[:id])
+            Edgarj::Sssn.find_by_session_id(sid) ||
+                Edgarj::Sssn.new(session_id: sid)
+          else
+            Edgarj::Sssn.new
+          end
+    end
+
+    # convenient t() for view.  v(KEY) fallback works as follows:
+    #
+    # 1. t('view.CONTROLLER.KEY') if exists.  Where, CONTROLLER
+    #    is controller name.
+    # 1. t('edgarj.view.CONTROLLER.KEY') if exists.
+    # 1. t('edgarj.default.KEY') if exists.
+    # 1. Key
+    #
+    def v(key)
+      t(key,
+          scope:    "view.#{controller_name}",
+          default:  I18n.t(key,
+              scope:    "edgarj.view.#{controller_name}",
+              default:  I18n.t(key,
+                  scope:    'edgarj.default',
+                  default:  key.camelize)))
+    end
+
+    # TODO: dirty solution to support url namespace
+    def url_prefix
+      @url_prefix ||= '/'
+    end
+  end
+end