Merge pull request #62 from basyura/feature/project_pattern

add project pattern

Author: onozaty

app/controllers/view_customizes_controller.rb

@@ -68,6 +68,6 @@ def find_view_customize
 
   def view_customize_params
     params.require(:view_customize)
-      .permit(:path_pattern, :customize_type, :code, :is_enabled, :is_private, :insertion_position, :comments)
+      .permit(:path_pattern, :project_pattern, :customize_type, :code, :is_enabled, :is_private, :insertion_position, :comments)
   end
 end

app/models/view_customize.rb

@@ -3,6 +3,7 @@ class ViewCustomize < ActiveRecord::Base
 
   validates_presence_of :path_pattern
   validates_length_of :path_pattern, :maximum => 255
+  validates_length_of :project_pattern, :maximum => 255
 
   validates_presence_of :code
 
@@ -66,6 +67,15 @@ def valid_pattern
     rescue
       errors.add(:path_pattern, :invalid)
     end
+
+    unless project_pattern.empty?
+      begin
+        Regexp.compile(project_pattern)
+      rescue
+        errors.add(:project_pattern, :invalid)
+      end
+    end
+
   end
 
   def initialize(attributes=nil, *args)

app/views/view_customizes/_form.html.erb

@@ -8,6 +8,14 @@
       <%= l(:text_path_pattern_match_info) %>
     </em>
   </p>
+  <p>
+    <%= form.text_field :project_pattern,
+        :size => 100, :required => false %>
+    <em class="info">
+      <%= l(:text_project_pattern_info) %><br />
+      <%= l(:text_project_pattern_match_info) %>
+    </em>
+  </p>
   <p>
     <%= form.select :insertion_position,
           options_for_select(

app/views/view_customizes/index.html.erb

@@ -15,6 +15,7 @@
     <tr>
       <%= sort_header_tag('id', :caption => '#') %>
       <%= sort_header_tag('path_pattern', :caption => l(:field_path_pattern)) %>
+      <%= sort_header_tag('project_pattern', :caption => l(:field_project_pattern)) %>
       <%= sort_header_tag('insertion_position', :caption => l(:field_insertion_position)) %>
       <%= sort_header_tag('customize_type', :caption => l(:field_customize_type)) %>
       <%= sort_header_tag('comments', :caption => l(:field_comments) + ' / ' + l(:field_code)) %>
@@ -27,6 +28,7 @@
     <tr class="<%= cycle('odd', 'even') %><%= ' disable' unless view_customize.is_enabled %><%= ' private' unless !view_customize.is_private %>">
       <td class="id"><%= link_to view_customize.id, view_customize_path(view_customize.id) %></td>
       <td class="path"><%=h view_customize.path_pattern %></td>
+      <td class="project_pattern"><%=h view_customize.project_pattern%></td>
       <td class="insertion_position"><%=h l(view_customize.insertion_position_label) %></td>
       <td><%=h l(view_customize.customize_type_label) %></td>
       <td class="comments"><%=h view_customize.comments.present? ? view_customize.comments : truncate(view_customize.code, :length => 80) %></td>

app/views/view_customizes/show.html.erb

@@ -17,6 +17,10 @@
     <th><%=h l(:field_path_pattern) %></th>
     <td><%=h @view_customize.path_pattern %></td>
   </tr>
+  <tr>
+    <th><%=h l(:field_project_pattern) %></th>
+    <td><%=h @view_customize.project_pattern %></td>
+  </tr>
   <tr>
     <th><%=h l(:field_insertion_position) %></th>
     <td><%=h l(@view_customize.insertion_position_label) %></td>

config/locales/en.yml

@@ -12,6 +12,7 @@ en:
   label_insertion_position_issue_form: "Bottom of issue form"
   label_insertion_position_issue_show: "Bottom of issue detail"
   field_path_pattern: "Path pattern"
+  field_project_pattern: "Project pattern"
   field_insertion_position: "Insertion position"
   field_customize_type: "Type"
   field_code: "Code"
@@ -21,4 +22,6 @@ en:
   field_author: "Author"
   text_path_pattern_info: "Path pattern is specified with a regular expression. (ex. /issues/[0-9]+)"
   text_path_pattern_match_info: "If there is a match with the path of the page, insert the following code and execute it."
+  text_project_pattern_info: "Project (identifier) pattern is specified with a regular expression (ex. sampleProjA|samplePrjB)"
+  text_project_pattern_match_info: "If there is a match with the current project, insert the following code and execute it."
   option_create_api_access_key: "Automatically create API access key"

config/locales/ja.yml

@@ -11,6 +11,7 @@ ja:
   label_insertion_position_issue_form: "チケット入力欄の下"
   label_insertion_position_issue_show: "チケット詳細の下"
   field_path_pattern: "パスのパターン"
+  field_project_pattern: "プロジェクトのパターン"
   field_insertion_position: "挿入位置"
   field_customize_type: "種別"
   field_code: "コード"
@@ -20,4 +21,6 @@ ja:
   field_author: "作成者"
   text_path_pattern_info: "パスのパターンは正規表現で指定します。 (例 /issues/[0-9]+)"
   text_path_pattern_match_info: "ページのパスが一致した場合、以下のコードを挿入し、実行します。"
-  option_create_api_access_key: "APIアクセスキーを自動的に作成する"
+  text_project_pattern_info: "プロジェクト(識別子)を正規表現で指定します。 (例 sampleProjA|samplePrjB)"
+  text_project_pattern_match_info: "選択中のプロジェクトが一致した場合、以下のコードを挿入し、実行します。"
+  option_create_api_access_key: "APIアクセスキーを自動的に作成する"

db/migrate/006_add_project_pattern_to_view_customizes.rb

@@ -0,0 +1,11 @@
+class AddProjectPatternToViewCustomizes < ActiveRecord::CompatibleLegacyMigration.migration_class
+  def up
+    add_column :view_customizes, :project_pattern, :string, :null => false, :default => ""
+  end
+
+  def down
+    remove_column :view_customizes, :project_pattern
+  end
+end
+
+

lib/view_customize/view_hook.rb

@@ -3,16 +3,16 @@
 module RedmineViewCustomize
   class ViewHook < Redmine::Hook::ViewListener
     def view_layouts_base_html_head(context={})
-
+      ctx = create_view_customize_context(context)
       path = Redmine::CodesetUtil.replace_invalid_utf8(context[:request].path_info);
 
       html = "\n<!-- [view customize plugin] path:#{path} -->\n"
       html << stylesheet_link_tag("view_customize", plugin: "view_customize")
       html << "<script type=\"text/javascript\">\n//<![CDATA[\n"
-      html << "ViewCustomize = { context: #{create_view_customize_context(context).to_json} };"
+      html << "ViewCustomize = { context: #{ctx.to_json} };"
       html << "\n//]]>\n</script>"
 
-      html << create_view_customize_html(path, ViewCustomize::INSERTION_POSITION_HTML_HEAD)
+      html << create_view_customize_html(ctx, path, ViewCustomize::INSERTION_POSITION_HTML_HEAD)
 
       return html
     end
@@ -37,22 +37,30 @@ def view_issues_show_details_bottom(context={})
 
     private
 
-    def create_view_customize_html(path, insertion_position)
+    def create_view_customize_html(ctx, path, insertion_position)
 
-      view_customize_html_parts = match_customize(path, insertion_position).map {|item|
+      view_customize_html_parts = match_customize(ctx, path, insertion_position).map {|item|
         to_html(item)
       }
       return view_customize_html_parts.join("\n").html_safe
 
     end
 
-    def match_customize(path, insertion_position)
+    def match_customize(ctx, path, insertion_position)
+      ViewCustomize.all.select {|item| target_customize?(ctx, path, insertion_position, item)}
+    end
 
-      ViewCustomize.all.select {|item|
-        item.available? \
-          && item.insertion_position == insertion_position \
-          && path =~ Regexp.new(item.path_pattern)
-      }
+    def target_customize?(ctx, path, insertion_position, item)
+      return false unless item.available?
+      return false unless item.insertion_position == insertion_position 
+      return false unless path =~ Regexp.new(item.path_pattern)
+
+      if item.project_pattern.empty?
+        return true
+      end
+
+      return false unless ctx["project"]
+      return ctx["project"]["identifier"] =~ Regexp.new(item.project_pattern)
     end
 
     def to_html(view_customize)

test/unit/view_customize_test.rb

@@ -1,9 +1,74 @@
 require File.expand_path('../../test_helper', __FILE__)
+require File.expand_path('../../../lib/view_customize/view_hook', __FILE__)
 
 class ViewCustomizeTest < ActiveSupport::TestCase
+  #
+  #
+  class Record
+    attr_accessor :path_pattern, :project_pattern, :insertion_position
+    def initialize(available, path, project, position)
+      @available, @path_pattern, @project_pattern, @insertion_position = available, path, project, position
+    end
+
+    def available?
+      @available
+    end
+
+    def self.store(records)
+      @records = records
+    end
+
+    def self.get
+      @records
+    end
+  end
+  #
+  # Replace records
+  module ViewCustomizeExt
+    refine ViewCustomize do
+      class << ViewCustomize 
+        def all
+          Record.get
+        end
+      end
+    end
+  end
+  #
+  using ViewCustomizeExt
+  #
+  #
+  def test_hook_match_customize
+    ctx = {}
+    path = "/redmine/issues"
+    pos = "html_head"
+
+    Record.store([Record.new(true, ".*", "", "html_head")])
+
+    hook = RedmineViewCustomize::ViewHook.instance
+    matches = hook.send(:match_customize, ctx, path, pos)
+    assert_equal matches.length, 1
+
+    # right project
+    Record.store([Record.new(true, ".*", "testproject", "html_head")])
+    matches = hook.send(:match_customize, { "project" => { "identifier" => "testproject" }}, path, pos)
+    assert matches.length == 1
+    # wrong proejct
+    matches = hook.send(:match_customize, { "project" => { "identifier" => "sampleproject" }}, path, pos)
+    assert matches.length == 0
+    # no project in ctx, but project is in record
+    matches = hook.send(:match_customize, {}, path, pos)
+    assert matches.length == 0
+    # filter by path
+    Record.store([Record.new(true, ".*", "", "html_head"), Record.new(true, "/redmine/view_customize", "", "html_head")])
+    matches = hook.send(:match_customize, {}, path, pos)
+    assert matches.length == 1
+    # filter by project and path
+    Record.store([Record.new(true, ".*", "", "html_head"), Record.new(true, "/redmine/issues", "testproject", "html_head")])
+    matches = hook.send(:match_customize, { "project" => { "identifier" => "testproject" }}, path, pos)
+    assert matches.length == 2
+
+
+
 
-  # Replace this with your real tests.
-  def test_truth
-    assert true
   end
 end