Support for redmine 2.3.x

Author: Massimo Rossello

README.rdoc

@@ -2,6 +2,9 @@
 
 This is the Redmine(Project manage system) plug-in which adds the feature of the glossary.
 
+Ported to and tested on 2.3.x Redmine branch.
+Care has been taken to keep compatibility with 1.4.x, but not tested!
+
 == The Use
 
  * Management of technical terms in a system analysis phase
@@ -10,21 +13,21 @@ This is the Redmine(Project manage system) plug-in which adds the feature of the
  * Management of naming examples in a coding
 
 
-== Gegging a plugin package
+== Getting a plugin package
 
 {SourceForge.JP}[http://sourceforge.jp/projects/rp-glossary/releases/]
 
 
-== Installation and Setup
+== Installation and Setup (redmine 2.x)
 
 cf. http://www.redmine.org/wiki/1/Plugins
 
-1. Extends the dawnloaded package in vender/plugins directory.
+1. Put the downloaded package in the /plugins directory.
 2. run the following command to upgrade your database. 
-    rake db:migrate_plugins RAILS_ENV=production
+    rake redmine:plugins:migrate RAILS_ENV=production
 3. Restart Redmine WEB server.
 4. Set permissions of glossary plugin in "Administration" -> "Roles and permissions"
-5. Open the setting page of projects you need, check the "Glossray" module
+5. Open the setting page of projects you need, check the "Glossary" module
 6. If you need, select items to make hidden in plugin setting page.
 
 == Usage
@@ -36,9 +39,9 @@ For the details of the usage, see the following page.
 * http://www.r-labs.org/projects/rp-glossary/wiki/UsageEn
 
 
-== Quesion or Proposal
+== Question or Proposal
 
-If you find a bug(Defect) or hava a Proposal, create a new issue.
+If you find a bug(Defect) or have a Proposal, create a new issue.
 http://www.r-labs.org/projects/rp-glossary/issues
 
 If you quest about this plugin, write the forum.

app/controllers/glossary_controller.rb

@@ -96,14 +96,14 @@ def preview
   def edit
     @term_categories = TermCategory.find(:all, :conditions => "project_id = #{@project.id}", :order => "position")
 
-    if request.post?
+    if request.post? || request.put?
       @term.attributes = params[:term]
       @term.updater_id = User.current.id
       if @term.save
         attach_files(@term, params[:attachments])
         flash[:notice] = l(:notice_successful_update)
-        redirect_to(:controller => 'glossary', :action => 'show',
-                    :project_id => @project, :id => @term.id)
+        redirect_to(:controller => 'glossary', :action => 'show', 
+          :project_id => @project, :id => @term.id)
         return
       end
     end

app/controllers/term_categories_controller.rb

@@ -7,9 +7,6 @@ class TermCategoriesController < ApplicationController
   before_filter :find_project, :authorize
   before_filter :retrieve_glossary_style, :only => [:index]
 
-  verify :method => :post, :only => :destroy
-  verify :mothod => :post, :only => :change_order
-
   helper :glossary
   include GlossaryHelper
   helper :glossary_styles

app/helpers/glossary_helper.rb

@@ -67,8 +67,7 @@ def tokenize_by_space(str)
 
 
   def updated_by(updated, author)
-    l(:label_updated_time_by,
-      :author => link_to_user(author), :age => time_tag(updated)).html_safe
+    l(:label_updated_time_by, :author => link_to_user(author), :age => time_tag(updated)).html_safe
   end
 
 end

app/helpers/glossary_port_helper.rb

@@ -1,32 +1,36 @@
 module GlossaryPortHelper
 
 
-  def glossary_csvout(csv, ic, ary)
+  #def glossary_csvout(csv, ic, ary)
+  def glossary_csvout(csv, ary)
     csv << ary.collect {|c|
       begin
-        ic.iconv(c.to_s)
+        #ic.iconv(c.to_s)
+        Redmine::CodesetUtil.from_utf8(c.to_s, l(:general_csv_encoding))
       rescue
         c.to_s
       end
     }
   end
 
   def glossary_to_csv(terms)
-    ic = Iconv.new(l(:general_csv_encoding), 'UTF-8')    
+    #ic = Iconv.new(l(:general_csv_encoding), 'UTF-8')    
     export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv|
       # csv header fields
       headers = Term.export_params.collect {|prm|
         label_param(prm)
       }
 
-      glossary_csvout(csv, ic, headers)
+      #glossary_csvout(csv, ic, headers)
+      glossary_csvout(csv, headers)
 
       # csv lines
       terms.each do |term|
         fields = Term.export_params.collect {|prm|
           term.param_to_s(prm)
         }
-        glossary_csvout(csv, ic, fields)
+        #glossary_csvout(csv, ic, fields)
+        glossary_csvout(csv, fields)
       end
     end
     export
@@ -36,7 +40,7 @@ def glossary_to_csv(terms)
   def glossary_from_csv(portinfo, projid)
     line_count = 0
     begin
-      ic = Iconv.new('UTF-8', portinfo.in_encoding)
+      #ic = Iconv.new('UTF-8', portinfo.in_encoding)
 
       raise l(:error_file_none)	if (!portinfo.import_file)
       FCSV::parse(portinfo.import_file) { |row|
@@ -47,7 +51,8 @@ def glossary_from_csv(portinfo, projid)
         name = row[portinfo.param_col('name')]        
         raise sprintf(l(:error_no_name), t("label.name"))	unless name
 
-        name = ic.iconv(name)
+        #name = ic.iconv(name)
+        name = Redmine::CodesetUtil.to_utf8(name, portinfo.in_encoding)
         term = Term.find(:first,
                          :conditions => ["project_id = #{projid} AND name = :name",
                                          {:name=>name}])
@@ -61,7 +66,8 @@ def glossary_from_csv(portinfo, projid)
         for col in 0 ... row.size
           prm = portinfo.col_param(col)
           next	unless prm
-          val = ic.iconv(row[col].to_s)
+          #val = ic.iconv(row[col].to_s)
+          name = Redmine::CodesetUtil.to_utf8(row[col].to_s, portinfo.in_encoding)
           case prm
           when 'name'
           when 'category'

app/helpers/glossary_styles_helper.rb

@@ -37,6 +37,7 @@ def search_index_table(ary, sepcnt, proj, search_index_type = nil)
       str += '</td>'
     end
     str += '</tr></table>'
+    str.html_safe
   end
 
   def search_params

app/models/term.rb

@@ -111,38 +111,38 @@ def self.find_for_macro(tname, proj, all_project = false)
   end
 
   def self.default_show_params
-    ['name_cn', 'name_fr', 'name_en', 'tech_en', 'rubi', 'abbr_whole', 'datatype', 'codename', 'project', 'category']
+    ['name_en', 'rubi', 'abbr_whole', 'datatype', 'codename', 'project', 'category']
   end
 
   def self.default_searched_params
-    ['name', 'name_en', 'name_cn', 'name_fr', 'tech_en', 'abbr_whole', 'datatype', 'codename', 'description']
+    ['name', 'name_en', 'abbr_whole', 'datatype', 'codename', 'description']
   end
 
   def self.default_sort_params
-    ['id', 'name', 'name_en', 'name_cn', 'name_fr', 'tech_en', 'abbr_whole', 'datatype', 'codename', 'project', 'category',
+    ['id', 'name', 'name_en', 'abbr_whole', 'datatype', 'codename', 'project', 'category',
      'datetime']
   end
 
   def self.hidable_params
-    ['name_en', 'name_cn', 'name_fr', 'tech_en', 'rubi', 'abbr_whole', 'datatype', 'codename']
+    ['name_en', 'rubi', 'abbr_whole', 'datatype', 'codename']
   end
 
   def self.setting_params
-    ['name_en', 'name_cn', 'name_fr', 'tech_en', 'rubi', 'abbr_whole', 'datatype', 'codename']
+    ['name_en', 'rubi', 'abbr_whole', 'datatype', 'codename']
   end
 
   def self.export_params
     ['id','project',
-     'name', 'name_en', 'name_cn', 'name_fr', 'tech_en', 'rubi', 'abbr_whole', 'category', 'datatype', 'codename',
+     'name', 'name_en', 'rubi', 'abbr_whole', 'category', 'datatype', 'codename',
      'author',  'updater', 'created_on', 'updated_on',
      'description']
   end
 
   def self.import_params
-    ['name', 'name_en', 'name_cn', 'name_fr', 'tech_en', 'rubi', 'abbr_whole', 'category', 'datatype', 'codename',
+    ['name', 'name_en', 'rubi', 'abbr_whole', 'category', 'datatype', 'codename',
      'description']
   end
 
 
 
-end
+end

app/views/glossary/_add_term_category_modal.html.erb

@@ -0,0 +1,10 @@
+<h3 class="title"><%=l(:label_term_category_new)%></h3>
+
+<% form = labelled_form_for @category, :as => :category, :url => { :action => 'add_term_category', :project_id => @project }, :html => {:class => 'tabular'} do |f| %>
+<%= render :partial => 'term_categories/form', :locals => { :f => f } %>
+  <p class="buttons">
+    <%= submit_tag l(:button_create), :name => nil %>
+    <%= submit_tag l(:button_cancel), :name => nil, :onclick => "hideModal(this);", :type => 'button' %>
+  </p>
+<% end %>
+<%= form if Rails::VERSION::MAJOR >= 3 %>

app/views/glossary/_form.html.erb

@@ -9,10 +9,20 @@
 
 <div class="splitcontentleft">
 <p><%= f.select :category_id, (@term_categories.collect {|c| [c.name, c.id]}), :include_blank => true %>
-<%= prompt_to_remote(l(:label_term_category_new),
-                     l(:label_term_category_new), 'category[name]', 
-                     {:controller => 'glossary', :action => 'add_term_category', :project_id => @project},
+<% if Rails::VERSION::MAJOR >= 3 %>
+  <%= link_to(l(:label_term_category_new),
+                 {:controller => 'glossary', :action => 'add_term_category', :project_id => @project.id },
+                 :category => 'category[name]', 
+                 :class => 'icon icon-add', 
+                 :tabindex => 199, 
+                 :method => 'get',
+                 :remote => true) if authorize_for('glossary', 'add_term_category') %></p>
+<% else %>
+  <%= prompt_to_remote(l(:label_term_category_new),
+                     l(:label_term_category_new), 'category[name]',
+                     {:controller => 'glossary', :action => 'add_term_category', :project_id => @project },
                      :class => 'icon icon-add', :tabindex => 199) if authorize_for('glossary', 'add_term_category') %></p>
+<% end %>
 </div>
 <p><%= f.text_area :description, :label=>t('label.description'),
                    :cols => 60,

app/views/glossary/_index_in_category.html.erb

@@ -16,9 +16,10 @@
 <% for prm in @show_params %>
 <td><%=h term.value(prm) %></td>
 <% end %>
-<td><%=h truncate(term.description, :length=>50) %></td>
-<td align="right">
-<% if term.project_id == @project.id %>
+<!--td><%=h truncate(term.description, :length=>50) %></td-->
+<td><%=textilizable term.description %></td>
+<td align="right" width="40px">
+  <% if term.project_id == @project.id %>
 <%= link_to_if_authorized(image_tag('edit.png'), {:action => 'edit', :project_id => @project, :id => term}, :title => l(:button_edit)) %>
 <%= link_to_if_authorized(image_tag('delete.png'), {:action => 'destroy', :project_id => @project, :id => term}, :confirm => l(:text_are_you_sure), :method => :post, :title => l(:button_delete)) %>
 <% end %>
@@ -27,4 +28,4 @@
 <% end %>
 </tbody>
 </table>
-<br />
+<br />

app/views/glossary/_sidebar.html.erb

@@ -37,7 +37,6 @@
   <%= link_to_if_authorized(l(:button_clear), {:controller => 'glossary', :action => 'index_clear', :project_id => @project}, :class => 'icon icon-reload') %>
 </div>
 <% end %>
-
   <%= search_index_table(l(:index_ary_en), l(:index_ary_en_sep_cnt), @project, 'en') %>
   <br />
   <%= search_index_table(l(:index_ary), l(:index_ary_sep_cnt), @project) %>

app/views/glossary/add_term_category.html.erb

@@ -0,0 +1,9 @@
+<h2><%=l(:label_term_category_new)%></h2>
+
+<% form = labelled_form_for @category, :as => :category, :url => { :action => 'add_term_category', :project_id => @project }, :html => {:class => 'tabular'} do |f| %>
+  <%= render :partial => 'term_categories/form', :locals => { :f => f } %>
+<%= submit_tag l(:button_create) %>
+<% end %>
+<%= form if Rails::VERSION::MAJOR >= 3 %>
+
+<% html_title(l(:glossary_title)) -%>

app/views/glossary/add_term_category.js.erb

@@ -0,0 +1,2 @@
+$('#ajax-modal').html('<%= escape_javascript(render :partial => 'glossary/add_term_category_modal') %>');
+showModal('ajax-modal', '600px');

app/views/glossary/edit.html.erb

@@ -1,21 +1,28 @@
 <h2><%= l(:label_term) %> #<%= @term.id %></h2>
 
-<% labelled_tabular_form_for :term, @term, 
+<% form = labelled_form_for @term, :as => :term,
                              :url => {:action => 'edit', :project_id => @project, :id => @term},
-                             :html => {:multipart => true, :id => 'term-form'} do |f| %>
+                             :html => {:class => 'tabular', :multipart => true, :id => 'term-form'} do |f| %>
     <%= error_messages_for 'term' %>
     <div class="box">
     <%= render :partial => 'glossary/form', :locals => {:f => f} %>
     </div>
     <%= submit_tag l(:button_edit) %>
-    <%= link_to_remote l(:label_preview),
-                       { :url => { :controller => 'glossary', :action => 'preview', :project_id => @project },
-                         :method => 'post',
-                         :update => 'preview',
-                         :with => "Form.serialize('term-form')",
-                         :complete => "Element.scrollTo('preview')"
-                       }, :accesskey => accesskey(:preview) %>
+    <% if Rails::VERSION::MAJOR >= 3 %>
+        <%= preview_link({:controller => 'glossary', :action => 'preview', :project_id => @project.id },
+                     "term-form",
+                     "preview") %> 
+    <% else %>
+      <%= link_to_remote l(:label_preview),
+                 { :url => { :controller => 'glossary', :action => 'preview', :project_id => @project },
+                   :method => 'post',
+                   :update => 'preview',
+                   :with => "Form.serialize('term-form')",
+                   :complete => "Element.scrollTo('preview')"
+                 }, :accesskey => accesskey(:preview) %>
+    <% end %>
 <% end %>
+<%= form if Rails::VERSION::MAJOR >= 3 %>
 
 <div id="preview" class="wiki"></div>
 

app/views/glossary/import_csv.html.erb

@@ -1,7 +1,7 @@
 <h2><%=h l(:label_glossary_import_csv) %> </h2>
 
 
-<% form_tag({:controller => 'glossary', :action => 'import_csv_exec', :project_id=>@project},
+<% form = form_tag({:controller => 'glossary', :action => 'import_csv_exec', :project_id=>@project},
             {:multipart => true}) do %>
 
 <%= l(:label_csv_file) %> 
@@ -52,5 +52,6 @@
 
 <%= submit_tag(l(:label_import)) %>
 <% end %>
+<%= form if Rails::VERSION::MAJOR >= 3 %>
 
 <% html_title(l(:glossary_title)) -%>

app/views/glossary/move_all.html.erb

@@ -7,7 +7,7 @@
 <%=  simple_format(l(:error_no_movement_project)) %>
 </div>
 <% else %>
-<%   form_tag({:project_id => @project}, :id => 'move_all_form') do %>
+<%   form = form_tag({:project_id => @project}, :id => 'move_all_form') do %>
 
 <div class="box tabular">
 <p><label for="new_project_id"><%=l(:label_movement_project)%>:</label>
@@ -17,5 +17,6 @@
 </div>
 <%=   submit_tag l(:button_move) %>
 <%   end %>
+<%=  form if Rails::VERSION::MAJOR >= 3 %>
 <% end %>