edgarj 0.01.12

data/lib/generators/edgarj/popup_scaffold/templates/controller.rb

@@ -0,0 +1,13 @@
+<% model_name = class_name.singularize -%>
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>PopupController < Edgarj::PopupController
+private
+  def drawer_class
+    <%= controller_class_name %>PopupHelper::<%= model_name -%>PopupDrawer
+  end
+end
+<% end -%>

data/lib/generators/edgarj/popup_scaffold/templates/functional_test.rb

@@ -0,0 +1,197 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= controller_class_name %>PopupControllerTest < ActionController::TestCase
+  context 'root user' do
+    setup do
+      login_as(:root)
+      @pi = create_page_info(@sssn, '<%= table_name %>', <%= class_name %>)
+    end
+  
+    should 'get index' do
+      xhr :get, :index,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'paginate' do
+      xhr :get, :index, page: 2,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'sort' do
+      xhr :put, :page_info_save, id: @pi.id,
+          id_target:        "PARENT_MODEL_DOM_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 'search' do
+      xhr :get, :search, edgarj_search_form: {},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert assigns(:list).count >= 1
+    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'
+      xhr :get, :index,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'paginate' do
+      skip 'get paginate'
+      xhr :get, :index, page: 2,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_not_nil assigns(:list)
+    end
+  
+    should 'sort' do
+      skip 'sort'
+      xhr :put, :page_info_save, id: @pi.id,
+          id_target:        "PARENT_MODEL_DOM_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 'search' do
+      skip 'search'
+      xhr :get, :search, edgarj_search_form: {},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert assigns(:list).count >= 1
+    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 read-only user of the
+     #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 since role and user_scoped satisfy' do
+      skip 'search since role and user_scoped satisfy'
+      xhr :get, :search, edgarj_search_form: {col: 'id', val: @<%= singular_table_name %>.id},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_equal 1, assigns(:list).count
+    end
+
+    should 'not search since key is out-of-scope' do
+      skip 'not search since key is out-of-scope'
+      xhr :get, :search, edgarj_search_form: {col: 'id', val: @<%= singular_table_name %>_scoped_out.id},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_response :success
+      assert_equal 0, assigns(:list).count
+    end
+  end
+
+  context 'not-permitted user' do
+    setup do
+      login_as(:not_permitted)
+      @pi = create_page_info(@sssn, '<%= table_name %>', <%= class_name %>)
+    end
+
+    should 'not get index' do
+      xhr :get, :index,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+  
+    should 'not paginate' do
+      xhr :get, :index, page: 2,
+          id_target: "PARENT_MODEL_DOM_ID"
+      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: @pi.id,
+          id_target:        "PARENT_MODEL_DOM_ID",
+          edgarj_page_info:  {
+            dir:              'asc',
+            order_by:         'created_at'
+          }
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+
+    should 'not search' do
+      xhr :get, :search, edgarj_search_form: {},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_template 'message_popup'
+      assert_equal I18n.t('edgarj.default.permission_no'), flash[:error]
+    end
+  end
+
+  context 'not-login' do
+    should 'not get index' do
+      xhr :get, :index,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+  
+    should 'not paginate' do
+      xhr :get, :index, page: 2,
+          id_target: "PARENT_MODEL_DOM_ID"
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+  
+    should 'not sort' do
+      xhr :put, :page_info_save, id: 0,
+          id_target:        "PARENT_MODEL_DOM_ID",
+          edgarj_page_info:  {
+            dir:              'asc',
+            order_by:         'created_at'
+          }
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+
+    should 'not search' do
+      xhr :get, :search, edgarj_search_form: {},
+          id_target:        "PARENT_MODEL_DOM_ID"
+      assert_equal I18n.t('edgarj.default.login_failed'), flash[:error]
+    end
+  end
+end
+<% end -%>

data/lib/generators/edgarj/popup_scaffold/templates/helper.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+module <%= class_name.pluralize %>PopupHelper
+  class <%= class_name %>PopupDrawer < Edgarj::Drawer::Popup
+    def initialize(view_context, params, page_info, model_class = <%= class_name %>)
+      super
+    end
+  end
+end
+<% end -%>

data/lib/generators/edgarj/scaffold/USAGE

@@ -0,0 +1,17 @@
+Description:
+    'edgarj:scaffold' is similar to original scaffold, but adds the followings:
+
+    * CRUD with Ajax
+    * QBE search form
+    * sort by clicking list column header
+    * csv-download
+    * role-based access control on controller
+    * data-scope access control on data model
+
+    If you want to remove all the generated files, run
+    'rails destroy edgarj/scaffold ModelName'.
+
+Example:
+    `rails generate edgarj:scaffold Author name`
+    `rails generate edgarj:scaffold Book name desc:text author:belongs_to`
+    `rails generate edgarj:scaffold Purchase amount:decimal tracking_id:integer:uniq`

data/lib/generators/edgarj/scaffold/scaffold_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators'
+
+module Edgarj
+  class ScaffoldGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
+
+    source_root File.expand_path('../templates', __FILE__)
+    invoke :model, in: :rails
+
+    def add_edgarj_routes
+      route "edgarj_resources :#{file_name.pluralize}"
+    end
+
+    def create_controller_files
+      template 'controller.rb', File.join('app/controllers',
+          class_path, "#{controller_file_name}_controller.rb")
+    end
+
+    hook_for :test_framework, as: :scaffold
+    hook_for :helper, in: :rails, as: :scaffold do |invoked|
+      invoke invoked, [ controller_name ]
+    end
+
+=begin
+  private
+    # copied from TestUnit::Generators::ScaffoldGenerator
+    def attributes_hash
+      return if attributes_names.empty?
+
+      attributes_names.map do |name|
+        if %w(password password_confirmation).include?(name) && attributes.any?(&:password_digest?)
+          "#{name}: 'secret'"
+        else
+          "#{name}: @#{singular_table_name}.#{name}"
+        end
+      end.sort.join(', ')
+    end
+=end
+  end
+end

data/lib/generators/edgarj/scaffold/templates/controller.rb

@@ -0,0 +1,13 @@
+<% model_name = class_name.singularize -%>
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < Edgarj::EdgarjController
+private
+  def drawer_class
+    <%= controller_class_name %>Helper::<%= model_name -%>Drawer
+  end
+end
+<% end -%>

data/lib/tasks/edgarj_tasks.rake

@@ -0,0 +1,32 @@
+if Rails.env != 'production'
+  require 'yard'
+  
+  namespace :doc do
+    desc 'upload to sourceforge'
+    task up: [:yard, :gen_juli] do
+      sh <<-EOSH
+        cd doc/www
+        rsync -avz --delete . ido00,jjedgarj@web.sourceforge.net:htdocs/
+      EOSH
+    end
+  
+    desc 'generate documents'
+    task :gen_juli do
+      sh <<-EOSH
+        unset RUBYOPT
+        (cd doc/doc-en; juli; juli sitemap; juli recent_update)
+        (cd doc/doc-jp; juli; juli sitemap; juli recent_update)
+      EOSH
+    end
+    
+    YARD::Rake::YardocTask.new do |t|
+     #t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
+
+      # NOTE: --exclude option value should be Regex rather than
+      # shell wildcard (e.g. foo/**/*.rb)
+      t.options = %w(--private -o doc/www/api
+          --exclude lib/edgarj/templates
+          --exclude lib/generators/edgarj/.*/templates)
+    end
+  end
+end

data/lib/tasks/pakcage.rake

@@ -0,0 +1,18 @@
+namespace :edgarj do
+  desc "build package under pkg/ with umask 002"
+  task :build_gem do
+    FileUtils.mkdir "/tmp/edgarj" if !File.directory?("/tmp/edgarj")
+    sh <<-EOSH
+      umask 002
+      git archive --format=tar --prefix=edgarj/ HEAD | gzip >/tmp/edgarj.tgz
+      cd /tmp/edgarj &&
+      tar zxvf /tmp/edgarj.tgz &&
+      cd edgarj &&
+      gem build edgarj.gemspec
+    EOSH
+    
+    FileUtils.mkdir "pkg" if !File.directory?("pkg")
+    sh "mv /tmp/edgarj/edgarj/edgarj-*.gem pkg/"
+    sh "rm -r /tmp/edgarj"
+  end
+end

data/locale/en.yml

@@ -0,0 +1,94 @@
+en:
+  # active record column
+  activerecord:
+    models:
+      edgarj/address:                Address
+      edgarj/model_permission:       Role
+      edgarj/sssn:                   Session
+      edgarj/user:                   User
+      edgarj/user_group:             Group
+      edgarj/user_group_user:        Group - User
+      edgarj/zip_address:            Zip - Address
+    attributes:
+      edgarj/address:
+        zip:                      Zip
+        prefecture:               State
+        city:                     City/County
+        town:                     Town
+        other:                    Street
+        other2:                   Bldg/Floor
+        other3:                   (Reserved)
+        other4:                   (Reserved)
+      edgarj/model_permission:
+        flags:                    Access Type
+      edgarj/user:
+        code:                     Login Id
+        password_confirmation:    Password (confirmation)
+      edgarj/zip_address:
+        zip:                      Zip
+        prefecture:               State
+        city:                     City/County
+        town:                     Town
+  # active model column
+  activemodel:
+    attributes:
+      edgarj/search_form:
+        _id:                      Id
+      edgarj/search_popup:
+        val:                      Value
+
+  # controller human name
+  #
+  # if derived model class name is not defined at activerecord.models,
+  # then definition here is used.
+  controller:
+   #edgarj/addresses:              Address
+
+  edgarj:
+    # Edgarj specific time format
+    time:
+      format:           ! '%b %d,%Y %H:%M:%S'
+    form:
+      delete_confirm: 'Really Delete?'
+      popup:
+        title:        '%s Selection'
+    message_popup:
+      title:            'Message'
+    view:
+      sssns:
+        login:          'Login'
+        login_success:  'Logged in!'
+        login_failed:   'Logged failed!'
+        logout:         'Logged out!'
+
+    # final fallback is here.
+    #
+    # NOTE: even if humanize() is enough in some cases (e.g. name: 'Name')
+    # I18n is defined here because those are used in Edgarj plugin:
+    default:
+      clear:              'Clear'
+      close:              'Close'
+      create:             'Create'
+      created_at:         'Created at'
+      csv_download:       'CSV Download'
+      date:               Date
+      delete:             'Delete'
+      kind:               'Kind'
+      login_failed:       'Login failed'
+      logout:             'Logout'
+      name:               'Name'
+      not_found:          'Not found'
+      parent:             'Parent'
+      password:           'Password'
+      permission_no:      You don't have enough permission.
+      read:               'Read'
+      save:               'Save'
+      search_form:        'Search Form'
+      seq:                'Sequence'
+      total_records:      Total %d Records
+      updated_at:         'Update'
+      updated_at:         'Updated at'
+      zip_complete:       'to Address'
+
+      # just for test purpose
+      test_column:        'TEST COLUMN in global!!'

data/locale/ja.yml

@@ -0,0 +1,100 @@
+ja:
+  # active record column
+  activerecord:
+    models:
+      edgarj/address:                住所
+      edgarj/model_permission:       権限
+      edgarj/sssn:                   セッション
+      edgarj/user:                   ユーザ
+      edgarj/user_group:             グループ
+      edgarj/user_group_user:        ユーザのグループ所属
+      edgarj/zip_address:            〒→住所
+    attributes:
+      edgarj/address:
+        zip:                      〒
+        prefecture:               都道府県
+        city:                     市・郡
+        town:                     町・村
+        other:                    番地
+        other2:                   ビル・フロア
+        other3:                   (未使用)
+        other4:                   (未使用)
+      edgarj/model_permission:
+        flags:                    アクセス種類
+      edgarj/user:
+        code:                     ログインId
+        password_confirmation:    パスワード(確認)
+      edgarj/zip_address:
+        zip:                      〒
+        prefecture:               都道府県
+        city:                     市・郡
+        town:                     町・村
+  # active model column
+  activemodel:
+    attributes:
+      edgarj/search_form:
+        _id:                      Id
+      edgarj/search_popup:
+        val:                      値
+
+  views:
+    pagination:
+      first:                      "« 最初"
+      last:                       "最後 »"
+      previous:                   "‹ 前"
+      next:                       "次 ›"
+      truncate:                   "…"
+
+  # コントローラ名
+  #
+  # もしコントローラから導出されるモデルのラベルが activerecord.models で
+  # 定義されてない場合、ここの定義が使用されます。
+  controller:
+   #edgarj/addresses:              住所
+
+  edgarj:
+    # Edgarj specific time format
+    time:
+      format:           ! '%Y/%m/%d %H:%M:%S'
+    form:
+      delete_confirm: '本当に削除しますか？'
+      popup:
+        title:        '%s 選択'
+    message_popup:
+      title:            'メッセージ'
+    view:
+      sssns:
+        login:          'ログイン'
+        login_success:  'ログインしました。'
+        login_failed:   'ログインに失敗しました。'
+        logout:         'ログアウトしました。'
+    # final fallback is here.
+    default:
+      clear:              'クリア'
+      close:              '閉じる'
+      create:             '作成'
+      created_at:         '作成日時'
+      csv_download:       'csvダウンロード'
+      date:               '日付'
+      delete:             '削除'
+      kind:               '種類'
+      login_failed:       'ログインできません。'
+      logout:             'ログアウト'
+      name:               '名前'
+      not_found:          'Not found'
+      parent:             '親'
+      password:           'パスワード'
+      permission_no:      '権限がありません。'
+      read:               '参照'
+      records_per_page:   '件/頁'
+      save:               '保存'
+      search:             '検索'
+      search_clear:       'クリア'
+      search_end:         '検索終了'
+      search_form:        '検索フォーム'
+      search_save:        '検索条件保存(未実装)'
+      seq:                '順序'
+      total_records:      計 %d件
+      update:             '更新'
+      updated_at:         '更新日時'
+      zip_complete:       '〒→住所'

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,21 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require jquery-ui
+//= require jquery-ui/datepicker-ja
+//= require jquery.remotipart
+//= require edgarj/base
+//= require edgarj/menu
+//= require edgarj/operator_selection
+//= require_tree .

data/test/dummy/app/assets/javascripts/authors.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require jquery-ui
+ *= require edgarj/base
+ *= require edgarj/menu
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/assets/stylesheets/authors.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}