edgarj 0.01.12

data/lib/edgarj/enum_cache.rb

@@ -0,0 +1,46 @@
+module Edgarj
+  # build map: value -> label on-the-fly
+  class EnumCache
+    include Singleton
+
+    def initialize
+      @enum_map = {}
+
+      # for stat
+      @hit = @out = @out_of_enum = 0
+    end
+
+    # return label of 'rec.attr', where attr is enum value.
+    def label(rec, attr, enum = nil)
+      if !enum
+        enum = rec.class.const_get(attr.to_s.camelize)
+        raise(NameError, "wrong constant name #{attr}") if !enum
+      end
+      if !@enum_map[enum]
+        @enum_map[enum] = {}
+      end
+      value = rec.attributes[attr.to_s]
+      if label = @enum_map[enum][value]
+        @hit += 1
+        label
+      else
+        member = enum.constants.detect{|m|
+                    enum.const_get(m) == value
+                 }
+        @enum_map[enum][value] = 
+            if member
+              @out += 1
+              rec.class.human_const_name(enum, member)
+            else
+              @out_of_enum += 1
+              '??'
+            end
+      end
+    end
+
+    # return statistic information of hit, out, out_of_enum.
+    def stat
+      [@hit, @out, @out_of_enum]
+    end
+  end
+end

data/lib/edgarj/templates/rails/helper/helper.rb

@@ -0,0 +1,10 @@
+<% model_name = class_name.singularize -%>
+<% module_namespacing do -%>
+module <%= class_name %>Helper
+  class <%= model_name %>Drawer < Edgarj::Drawer::Normal
+    def initialize(view_context, params, page_info, model_class = <%= model_name %>)
+      super
+    end
+  end
+end
+<% end -%>

data/lib/edgarj/templates/test_unit/scaffold/functional_test.rb

@@ -0,0 +1,575 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+# Edgarj chooses traditional testing framework(TestUnit) with
+# shoulda-context and fixture rather than rspec.
+#
+# EdgarjController assumes authentication, model_permission, and
+# user_scoped so that functional test should cover the following
+# combinations:
+#
+# 1. methods for CRUD, clear, search, search_clear, search_save, search_load,
+#    csv_download, and file_download.
+# 2. authenticated or not.
+# 3. User has enough role (model_permission) or not.
+# 4. User is in user_scoped or not.
+#
+# This edgarj:scaffold generated functional test just covers 1 and 2 above
+# because 3 and 4 require to prepare fixtures.  For the latter cases,
+# skipping tests are provided.
+#
+# Please read the file below as a reference:
+#
+#   edgarj/test/dummy/test/functional/authors_controller_test.rb
+#
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+  context 'root user' do
+    setup do
+      login_as(:root)
+      @<%= singular_table_name %> = <%= table_name %>(:one)
+      @pi = create_page_info(@sssn, '<%= table_name %>', <%= class_name %>)
+    end
+  
+    should 'get index' do
+      get :index
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+
+    should 'paginate' do
+      xhr :get, :index, page: 2
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'sort' do
+      xhr :put, :page_info_save,
+        id:                 @pi.id,
+        edgarj_page_info:  {
+          dir:      'asc',
+          order_by: 'created_at'
+        }
+      assert_response :success
+      assert_not_nil assigns(:list)
+      assert_equal 'asc',         assigns(:page_info).dir
+      assert_equal 'created_at',  assigns(:page_info).order_by
+    end
+
+    should 'create <%= singular_table_name %>' do
+      assert_difference('<%= class_name %>.count') do
+        xhr :post, :create, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      end
+      assert_response :success
+      assert assigns(:record)
+    end
+  
+    should 'not create invalid <%= singular_table_name %>' do
+      skip 'not create invalid <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+       #xhr :post, :create, invalid resource attributes...
+      end
+      assert_response :success
+      assert assigns(:record)
+    end
+
+    should 'show <%= singular_table_name %> in HTML' do
+      get :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'show <%= singular_table_name %> in JS' do
+      xhr :get, :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+  
+    should 'update <%= singular_table_name %>' do
+      xhr :put, :update, id: <%= "@#{singular_table_name}" %>, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      assert_response :success
+      assert assigns(:record)
+    end
+  
+    should 'destroy <%= singular_table_name %>' do
+      assert_difference('<%= class_name %>.count', -1) do
+        xhr :delete, :destroy, id: <%= "@#{singular_table_name}" %>
+      end
+      assert_response :success
+      assert assigns(:record)
+      assert assigns(:list)
+    end
+  
+    should 'clear <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :get, :clear
+      end
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'csv_download <%= table_name %>' do
+      get :csv_download
+      assert_response :success
+    end
+
+    should 'search' do
+      xhr :get, :search, edgarj_search_form: {}
+      assert_response :success
+      assert assigns(:list).count >= 1
+    end
+
+    should 'search_clear <%= singular_table_name %>' do
+      xhr :get, :search_clear
+      assert_response :success
+    end
+
+    should 'search_save <%= singular_table_name %>' do
+      skip 'search_save'
+    end
+
+    should 'search_load <%= singular_table_name %>' do
+      skip 'search_load'
+    end
+  end
+
+  # All of tests in this context is skipped because it is required
+  # to prepare read-only user.
+  # When complete the preparation, delete the skip lines.
+  context 'read-only user' do
+    setup do
+      # prepare fixtures of model_permissions, user_groups, and
+      # user_group_users for read-only user of the
+      # <%= controller_class_name %>Controller and login by him/her.
+      #
+      login_as(:<%= singular_table_name %>_reader)
+      @pi = create_page_info(@sssn, '<%= table_name %>', <%= class_name %>)
+    end
+  
+    should 'get index' do
+      skip 'get index'
+      get :index
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+
+    should 'paginate' do
+      skip 'paginate'
+      xhr :get, :index, page: 2
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'sort' do
+      skip 'sort'
+      xhr :put, :page_info_save,
+        id:                 @pi.id,
+        edgarj_page_info:  {
+          dir:      'asc',
+          order_by: 'created_at'
+        }
+      assert_response :success
+      assert_not_nil assigns(:list)
+      assert_equal 'asc',         assigns(:page_info).dir
+      assert_equal 'created_at',  assigns(:page_info).order_by
+    end
+
+    should 'not create <%= singular_table_name %>' do
+      skip 'not create <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :post, :create, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      end
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+  
+    should 'not create invalid <%= singular_table_name %>' do
+      skip 'not create invalid <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+       #xhr :post, :create, invalid resource attributes...
+      end
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'show <%= singular_table_name %> in HTML' do
+      skip 'show <%= singular_table_name %> in HTML'
+      get :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'show <%= singular_table_name %> in JS' do
+      skip 'show <%= singular_table_name %> in JS'
+      xhr :get, :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+  
+    should 'not update <%= singular_table_name %>' do
+      skip 'not update <%= singular_table_name %>'
+      xhr :put, :update, id: <%= "@#{singular_table_name}" %>, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+      old_<%= singular_table_name %> = @<%= singular_table_name %>
+      assert_equal(
+          old_<%= singular_table_name %>,
+          @<%= singular_table_name %>.reload)
+    end
+  
+    should 'not destroy <%= singular_table_name %>' do
+      skip 'not destroy <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :delete, :destroy, id: <%= "@#{singular_table_name}" %>
+      end
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+  
+    should 'clear <%= singular_table_name %>' do
+      skip 'clear <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :get, :clear
+      end
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'csv_download <%= table_name %>' do
+      skip 'csv_download <%= table_name %>'
+      get :csv_download
+      assert_response :success
+    end
+
+    should 'search' do
+      skip 'search <%= table_name %>'
+      xhr :get, :search, edgarj_search_form: {}
+      assert_response :success
+      assert assigns(:list).count >= 1
+    end
+
+    should 'search_clear <%= singular_table_name %>' do
+      skip 'search_clear <%= singular_table_name %>'
+      xhr :get, :search_clear
+      assert_response :success
+    end
+
+    should 'search_save <%= singular_table_name %>' do
+      skip 'search_save'
+    end
+
+    should 'search_load <%= singular_table_name %>' do
+      skip 'search_load'
+    end
+  end
+
+  # All of tests in this context is skipped because it is required
+  # to prepare 'permitted but user_scoped' user.
+  # When complete the preparation, delete the skip lines.
+  context 'permitted and user_scoped user' do
+    setup do
+      # prepare fixtures of model_permissions, user_groups, and
+      # user_group_users for permitted and user_scoped user of the
+      # <%= controller_class_name %>Controller and login by him/her.
+      #
+      #login_as(:permitted_n_user_scoped_on_<%= table_name %>)
+      #@pi = create_page_info(@sssn, '<%= table_name %>', <%= class_name %>)
+
+      @<%= singular_table_name %>             = <%= table_name %>(:one)
+      @<%= singular_table_name %>_scoped_out  = <%= table_name %>(:two)
+    end
+
+    should 'search 1 hit since role and user_scoped satisfy' do
+      skip 'search 1 hit since role and user_scoped satisfy'
+      xhr :get, :search, edgarj_search_form: {_id: @<%= singular_table_name %>.id}
+      assert_response :success
+      assert_equal 1, assigns(:list).count
+    end
+
+    should 'not search 1 hit since key is out-of-scope' do
+      skip 'not search 1 hit since key is out-of-scope'
+      xhr :get, :search, edgarj_search_form: {_id: @<%= singular_table_name %>_scoped_out.id}
+      assert_response :success
+      assert_equal 0, assigns(:list).count
+    end
+
+    should 'show assigned <%= singular_table_name %> in HTML' do
+      skip 'show assigned <%= singular_table_name %> in HTML'
+      get :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'show assigned <%= singular_table_name %> in JS' do
+      skip 'show assigned <%= singular_table_name %> in JS'
+      xhr :get, :show, id: <%= "@#{singular_table_name}" %>
+      assert_response :success
+      assert_not_nil assigns(:record)
+    end
+
+    should 'not show non-assigned <%= singular_table_name %> in HTML' do
+      skip 'not show non-assigned <%= singular_table_name %> in HTML'
+      get :show, id: <%= "@#{singular_table_name}_scoped_out" %>
+      assert_response :redirect
+      assert_nil assigns(:record)
+      assert_equal I18n.t('edgarj.default.not_found'), flash[:error]
+    end
+
+    should 'not show non-assigned <%= singular_table_name %> in JS' do
+      skip 'not show non-assigned <%= singular_table_name %> in JS'
+      xhr :get, :show, id: <%= "@#{singular_table_name}_scoped_out" %>
+      assert_response :success
+      assert_nil assigns(:record)
+      assert_equal I18n.t('edgarj.default.not_found'), flash[:error]
+    end
+
+    should 'update <%= singular_table_name %>' do
+      skip 'update <%= singular_table_name %>'
+      xhr :put, :update, id: <%= "@#{singular_table_name}" %>, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      assert_response :success
+      assert assigns(:record)
+    end
+
+    should 'not update non-assigned <%= singular_table_name %>' do
+      skip 'not update non-assigned <%= singular_table_name %>'
+      xhr :put, :update, id: <%= "@#{singular_table_name}_scoped_out" %>, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      assert_nil assigns(:record)
+      assert_equal I18n.t('edgarj.default.not_found'), flash[:error]
+      old_<%= singular_table_name %> = @<%= singular_table_name %>_scoped_out
+      assert_equal(
+          old_<%= singular_table_name %>,
+          @<%= singular_table_name %>_scoped_out.reload)
+    end
+
+    should 'destroy <%= singular_table_name %>' do
+      skip 'destroy <%= singular_table_name %>'
+      assert_difference('<%= class_name %>.count', -1) do
+        xhr :delete, :destroy, id: <%= "@#{singular_table_name}" %>
+      end
+      assert_response :success
+      assert assigns(:record)
+      assert assigns(:list)
+    end
+
+    should 'not destroy non-assigned <%= singular_table_name %>' do
+      skip 'not destroy non-assigned <%= singular_table_name %>'
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :delete, :destroy, id: <%= "@#{singular_table_name}_scoped_out" %>
+      end
+      assert_equal I18n.t('edgarj.default.not_found'), flash[:error]
+    end
+  end
+
+  context 'not-permitted user' do
+    setup do
+      login_as(:not_permitted)
+      @<%= singular_table_name %> = <%= table_name %>(:one)
+    end
+
+    should 'not get index' do
+      get :index
+
+      assert_redirected_to top_path
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not paginate' do
+      xhr :get, :index, page: 2
+
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not sort' do
+      xhr :put, :page_info_save,
+        id:                 edgarj_page_infos(:root_zip_address),
+        edgarj_page_info:  {
+          dir:      'asc',
+          order_by: 'name'
+        }
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not create <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :post, :create, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      end
+
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not show <%= singular_table_name %> in HTML' do
+      get :show, id: @<%= singular_table_name %>
+      assert_redirected_to top_path
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not show <%= singular_table_name %> in JS' do
+      xhr :get, :show, id: @<%= singular_table_name %>
+
+      assert_template 'message_popup'
+      assert_equal    I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not update <%= singular_table_name %>' do
+      xhr :put, :update, id: <%= "@#{singular_table_name}" %>, <%= "#{singular_table_name}: { #{attributes_hash} }" %>
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+      old_<%= singular_table_name %> = @<%= singular_table_name %>
+      assert_equal(
+          old_<%= singular_table_name %>,
+          @<%= singular_table_name %>.reload)
+    end
+
+    should 'not destroy <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :delete, :destroy, id: @<%= singular_table_name %>
+      end
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not clear' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :get, :clear
+      end
+
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not csv_download' do
+      get :csv_download
+
+      assert_redirected_to top_path
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not search' do
+      xhr :get, :search, edgarj_search_form: {_id: @<%= singular_table_name %>.id}
+
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not search_clear' do
+      xhr :get, :search_clear
+
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not search_save' do
+      skip 'search_save'
+    end
+
+    should 'not search_load' do
+      skip 'search_load'
+    end
+
+  # test Edgarj::AuthenticationMixin
+
+    should 'current_user' do
+      get :index
+      assert_equal users(:not_permitted), @controller.send(:current_user)
+    end
+  end
+
+  context 'not-login' do
+    setup do
+      @<%= singular_table_name %> = <%= table_name %>(:one)
+    end
+
+    should 'not get index' do
+      get :index
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not paginate' do
+      xhr :get, :index, page: 2
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not sort' do
+      xhr :put, :page_info_save,
+        # ensure what happens when not-login user puts with
+        # current edgarj_page_info-id
+        id:                 edgarj_page_infos(:root_zip_address),
+        edgarj_page_info:  {
+          dir:      'asc',
+          order_by: 'name'
+        }
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not create <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :post, :create, <%= singular_table_name %>: { name: @<%= singular_table_name %>.name }
+      end
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not create <%= singular_table_name %> invalid' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :post, :create, <%= singular_table_name %>: { name: nil }
+      end
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not show <%= singular_table_name %> in HTML' do
+      get :show, id: @<%= singular_table_name %>
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not show <%= singular_table_name %> in JS' do
+      xhr :get, :show, id: @<%= singular_table_name %>
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not update <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :put, :update, id: @<%= singular_table_name %>, <%= singular_table_name %>: { name: @<%= singular_table_name %>.name }
+      end
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not destroy <%= singular_table_name %>' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :delete, :destroy, id: @<%= singular_table_name %>
+      end
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not clear' do
+      assert_no_difference('<%= class_name %>.count') do
+        xhr :get, :clear
+      end
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not csv_download' do
+      get :csv_download
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not search' do
+      xhr :get, :search, edgarj_search_form: {_id: <%= table_name %>(:one).id}
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not search_clear' do
+      xhr :get, :search_clear
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not search_save' do
+      skip 'search_save'
+    end
+
+    should 'not search_load' do
+      skip 'search_load'
+    end
+  end
+end
+<% end -%>

data/lib/edgarj/version.rb

@@ -0,0 +1,3 @@
+module Edgarj
+  VERSION = "0.01.12"
+end

data/lib/edgarj.rb

@@ -0,0 +1,14 @@
+require "edgarj/engine"
+
+module Edgarj
+  class EdgarjError < StandardError; end
+    class NoPopupTarget < EdgarjError; end
+
+  LINES_PER_PAGE    = [2, 5, 10,20,50,100,200].freeze
+  LIST_TEXT_MAX_LEN = 20
+
+  # ActiveRecord::Fixtures.identify へのショートカット
+  def self.label(label)
+    ActiveRecord::Fixtures.identify(label)
+  end
+end

data/lib/generators/edgarj/popup_scaffold/USAGE

@@ -0,0 +1,6 @@
+Description:
+    'edgarj:popup_scaffold' generates popup controller
+    for the specified model.
+
+Example:
+    `rails generate edgarj:popup_scaffold Author`

data/lib/generators/edgarj/popup_scaffold/popup_scaffold_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators'
+
+module Edgarj
+  class PopupScaffoldGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_edgarj_routes
+      route "edgarj_popup_resources :#{file_name.pluralize}_popup"
+    end
+
+    def create_controller_files
+      template 'controller.rb', File.join('app/controllers',
+          class_path, "#{controller_file_name}_popup_controller.rb")
+    end
+
+=begin
+    hook_for :test_framework, as: :popup_scaffold
+    hook_for :helper, in: :rails, as: :popup_scaffold do |invoked|
+      invoke invoked, [ controller_name ]
+    end
+=end
+
+    def create_test
+      template 'functional_test.rb', File.join('test/functional',
+          class_path, "#{controller_file_name}_popup_controller_test.rb")
+    end
+
+    def create_helper
+      template 'helper.rb', File.join('app/helpers',
+          class_path, "#{controller_file_name}_popup_helper.rb")
+    end
+  end
+end