redmine_rate 0.2.0

data/app/controllers/rates_controller.rb

@@ -0,0 +1,154 @@
+class RatesController < ApplicationController
+  unloadable
+  helper :users
+  helper :sort
+  include SortHelper
+
+  before_filter :require_admin
+  before_filter :require_user_id, :only => [:index, :new]
+  before_filter :set_back_url
+  
+  ValidSortOptions = {'date_in_effect' => "#{Rate.table_name}.date_in_effect", 'project_id' => "#{Project.table_name}.name"}
+  
+  # GET /rates?user_id=1
+  # GET /rates.xml?user_id=1
+  def index
+    sort_init "#{Rate.table_name}.date_in_effect", "desc"
+    sort_update ValidSortOptions
+
+    @rates = Rate.history_for_user(@user, sort_clause)
+
+    respond_to do |format|
+      format.html { render :action => 'index', :layout => !request.xhr?}
+      format.xml  { render :xml => @rates }
+    end
+  end
+
+  # GET /rates/1
+  # GET /rates/1.xml
+  def show
+    @rate = Rate.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @rate }
+    end
+  end
+
+  # GET /rates/new?user_id=1
+  # GET /rates/new.xml?user_id=1
+  def new
+    @rate = Rate.new(:user_id => @user.id)
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @rate }
+    end
+  end
+
+  # GET /rates/1/edit
+  def edit
+    @rate = Rate.find(params[:id])
+  end
+
+  # POST /rates
+  # POST /rates.xml
+  def create
+    @rate = Rate.new(params[:rate])
+
+    respond_to do |format|
+      if @rate.save
+        format.html {
+          flash[:notice] = 'Rate was successfully created.'
+          redirect_back_or_default(rates_url(:user_id => @rate.user_id))
+        }
+        format.xml  { render :xml => @rate, :status => :created, :location => @rate }
+        format.js { render :action => 'create.js.rjs'}
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @rate.errors, :status => :unprocessable_entity }
+        format.js { 
+          flash.now[:error] = 'Error creating a new Rate.'
+          render :action => 'create_error.js.rjs'
+        }
+      end
+    end
+  end
+
+  # PUT /rates/1
+  # PUT /rates/1.xml
+  def update
+    @rate = Rate.find(params[:id])
+
+    respond_to do |format|
+      # Locked rates will fail saving here.
+      if @rate.update_attributes(params[:rate])
+        flash[:notice] = 'Rate was successfully updated.'
+        format.html { redirect_back_or_default(rates_url(:user_id => @rate.user_id)) }
+        format.xml  { head :ok }
+      else
+        if @rate.locked?
+          flash[:error] = "Rate is locked and cannot be edited"
+          @rate.reload # Removes attribute changes
+        end
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @rate.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /rates/1
+  # DELETE /rates/1.xml
+  def destroy
+    @rate = Rate.find(params[:id])
+    @rate.destroy
+
+    respond_to do |format|
+      format.html {
+        flash[:error] = "Rate is locked and cannot be deleted" if @rate.locked?
+        redirect_back_or_default(rates_url(:user_id => @rate.user_id))
+      }
+      format.xml  { head :ok }
+    end
+  end
+  
+  private
+  
+  def require_user_id
+    begin
+      @user = User.find(params[:user_id])
+    rescue ActiveRecord::RecordNotFound
+      respond_to do |format|
+        flash[:error] = l(:rate_error_user_not_found)
+        format.html { redirect_to(home_url) }
+        format.xml  { render :xml => "User not found", :status => :not_found }
+      end
+    end
+  end
+  
+  def set_back_url
+    @back_url = params[:back_url]
+    @back_url
+  end
+  
+  # Override defination from ApplicationController to make sure it follows a
+  # whitelist
+  def redirect_back_or_default(default)
+    whitelist = %r{(rates|/users/edit)}
+    
+    back_url = CGI.unescape(params[:back_url].to_s)
+    if !back_url.blank?
+      begin
+        uri = URI.parse(back_url)
+        if uri.path && uri.path.match(whitelist)
+          super
+          return
+        end
+      rescue URI::InvalidURIError
+        # redirect to default
+        logger.debug("Invalid URI sent to redirect_back_or_default: " + params[:back_url].inspect)
+      end
+    end
+    redirect_to default
+  end
+end

data/app/models/rate.rb

@@ -0,0 +1,161 @@
+require 'lockfile'
+
+class Rate < ActiveRecord::Base
+  unloadable
+  class InvalidParameterException < Exception; end
+  CACHING_LOCK_FILE_NAME = 'rate_cache'
+
+  belongs_to :project
+  belongs_to :user
+  has_many :time_entries
+  
+  validates_presence_of :user_id
+  validates_presence_of :date_in_effect
+  validates_numericality_of :amount
+  
+  before_save :unlocked?
+  after_save :update_time_entry_cost_cache
+  before_destroy :unlocked?
+  after_destroy :update_time_entry_cost_cache
+  
+  named_scope :history_for_user, lambda { |user, order|
+    {
+      :conditions => { :user_id => user.id },
+      :order => order,
+      :include => :project
+    }
+  }
+  
+  def locked?
+    return self.time_entries.length > 0
+  end
+  
+  def unlocked?
+    return !self.locked?
+  end
+  
+  def default?
+    return self.project.nil?
+  end
+  
+  def specific?
+    return !self.default?
+  end
+
+  def update_time_entry_cost_cache
+    TimeEntry.update_cost_cache(user, project)
+  end
+  
+  # API to find the Rate for a +user+ on a +project+ at a +date+
+  def self.for(user, project = nil, date = Date.today.to_s)
+    # Check input since it's a "public" API
+    if Object.const_defined? 'Group' # 0.8.x compatibility
+      raise Rate::InvalidParameterException.new("user must be a Principal instance") unless user.is_a?(Principal)
+    else
+      raise Rate::InvalidParameterException.new("user must be a User instance") unless user.is_a?(User)
+    end
+    raise Rate::InvalidParameterException.new("project must be a Project instance") unless project.nil? || project.is_a?(Project)
+    Rate.check_date_string(date)
+      
+    rate = self.for_user_project_and_date(user, project, date)
+    # Check for a default (non-project) rate
+    rate = self.default_for_user_and_date(user, date) if rate.nil? && project
+    rate
+  end
+  
+  # API to find the amount for a +user+ on a +project+ at a +date+
+  def self.amount_for(user, project = nil, date = Date.today.to_s)
+    rate = self.for(user, project, date)
+
+    return nil if rate.nil?
+    return rate.amount
+  end
+
+  def self.update_all_time_entries_with_missing_cost(options={})
+    with_common_lockfile(options[:force]) do
+      TimeEntry.all(:conditions => {:cost => nil}).each do |time_entry|
+        begin
+          time_entry.save_cached_cost
+        rescue Rate::InvalidParameterException => ex
+          puts "Error saving #{time_entry.id}: #{ex.message}"
+        end
+      end
+    end
+    store_cache_timestamp('last_caching_run', Time.now.utc.to_s)
+  end
+
+  def self.update_all_time_entries_to_refresh_cache(options={})
+    with_common_lockfile(options[:force]) do
+      TimeEntry.find_each do |time_entry| # batch find
+        begin
+          time_entry.save_cached_cost
+        rescue Rate::InvalidParameterException => ex
+          puts "Error saving #{time_entry.id}: #{ex.message}"
+        end
+      end
+    end
+    store_cache_timestamp('last_cache_clearing_run', Time.now.utc.to_s)
+  end
+  
+  private
+  def self.for_user_project_and_date(user, project, date)
+    if project.nil?
+      return Rate.find(:first,
+                       :order => 'date_in_effect DESC',
+                       :conditions => [
+                                       "user_id IN (?) AND date_in_effect <= ? AND project_id IS NULL",
+                                       user.id,
+                                       date
+                                      ])
+    
+    else
+      return Rate.find(:first,
+                       :order => 'date_in_effect DESC',
+                       :conditions => [
+                                       "user_id IN (?) AND project_id IN (?) AND date_in_effect <= ?",
+                                       user.id,
+                                       project.id,
+                                       date
+                                      ])
+    end                     
+  end
+  
+  def self.default_for_user_and_date(user, date)
+    self.for_user_project_and_date(user, nil, date)
+  end
+
+  # Checks a date string to make sure it is in format of +YYYY-MM-DD+, throwing
+  # a Rate::InvalidParameterException otherwise
+  def self.check_date_string(date)
+    raise Rate::InvalidParameterException.new("date must be a valid Date string (e.g. YYYY-MM-DD)") unless date.is_a?(String)
+    
+    begin
+      Date.parse(date)
+    rescue ArgumentError
+      raise Rate::InvalidParameterException.new("date must be a valid Date string (e.g. YYYY-MM-DD)")
+    end
+  end
+
+  def self.store_cache_timestamp(cache_name, timestamp)
+    Setting.plugin_redmine_rate = Setting.plugin_redmine_rate.merge({cache_name => timestamp})
+  end
+
+  def self.with_common_lockfile(force = false, &block)
+    # Wait 1 second after stealing a forced lock
+    options = {:retries => 0, :suspend => 1}
+    options[:max_age] = 1 if force
+    
+    Lockfile(lock_file, options) do
+      block.call
+    end
+  end
+
+  if Rails.env.test?
+    public
+    generator_for :date_in_effect => Date.today
+  end
+
+  def self.lock_file
+    Rails.root + 'tmp' + Rate::CACHING_LOCK_FILE_NAME
+  end
+end

data/app/views/rate_caches/index.html.erb

@@ -0,0 +1,21 @@
+<h2><%= l(:text_rate_caches_panel) %></h2>
+
+<div id="caching-run" class="splitcontentleft">
+  <p>
+    <%= l(:text_last_caching_run) %><%= h(@last_caching_run) %>
+  </p>
+
+  <p>
+    <%= button_to(l(:text_load_missing_caches), {:controller => 'rate_caches', :action => 'update', :cache => 'missing'}, :method => :put) %>
+  </p>
+</div>
+
+<div id="cache-clearing-run" class="splitcontentright">
+  <p>
+    <%= l(:text_last_cache_clearing_run) %><%= h(@last_cache_clearing_run) %>
+  </p>
+
+  <p>
+    <%= button_to(l(:text_clear_and_load_all_caches), {:controller => 'rate_caches', :action => 'update', :cache => 'reload'}, :method => :put) %>
+  </p>
+</div>

data/app/views/rates/_form.html.erb

@@ -0,0 +1,36 @@
+<% form_for(@rate) do |f| %>
+<table class="list">
+	<thead>
+	  <th style="width:15%"><%= l(:label_date) %></th>
+	  <th><%= l(:label_project) %></th>
+	  <th style="width:15%"><%= l(:rate_label_rate) %></th>
+	  <th style="width:5%"></th>
+	</thead>
+	<tbody>
+	<tr class="odd">
+      <td>
+        <%= f.text_field "date_in_effect", :size => 10  %><%= calendar_for('rate_date_in_effect') %>
+      </td>
+      <td>
+        <%= # TODO: move to controller once a hook is in place for the Admin panel
+          projects = Project.find(:all, :conditions => { :status => Project::STATUS_ACTIVE})
+  
+          select_tag("rate[project_id]", project_options_for_select_with_selected(projects, @rate.project))
+        %>
+      </td>
+      <td align="right">
+        <%= l(:rate_label_currency) %> <%= f.text_field "amount", :size => 10  %>
+      </td>
+      <td align="center">
+        <%= f.hidden_field "user_id" %>
+        <%= hidden_field_tag "back_url", @back_url %>
+        <% if @rate.unlocked? %>
+        <%= submit_tag((@rate.new_record? ? l(:button_add) : l(:button_update)), :class => 'button-small')-%>
+        <% else %>
+        <%= image_tag('locked.png') %>
+        <% end %>
+      </td>
+	</tr>
+	</tbody>
+</table>
+<% end %>

data/app/views/rates/_list.html.erb

@@ -0,0 +1,42 @@
+<table class="list">
+	<thead>
+      <%= rate_sort_header_tag("date_in_effect",
+                               :caption => l(:label_date),
+                               :default_order => 'desc',
+                               :style => "width: 15%",
+                               :method => :get,
+                               :update => "rate_history",
+                               :user_id => @user.id) %>
+      <%= rate_sort_header_tag("project_id",
+                               :caption => l(:label_project),
+                               :default_order => 'asc',
+                               :method => :get,
+                               :update => "rate_history",
+                               :user_id => @user.id) %>
+	  <th style="width:15%"><%= l(:rate_label_rate) %></th>
+	  <th style="width:5%"></th>
+	</thead>
+	<tbody>
+	<% @rates.each do |rate| %>
+	<tr class="<%= cycle 'odd', 'even' %>">
+      <td><%= h format_date(rate.date_in_effect) %></td>
+      <td>
+        <% if rate.project %>
+        <%= link_to(h(rate.project), :controller => 'projects', :action => 'show', :id => rate.project) %>
+        <% else %>
+        <em><%= l(:rate_label_default) %></em>
+        <% end %>
+      </td>
+      <td align="right"><%= h rate.amount %></td>
+      <td align="center">
+        <% if rate.unlocked? %>
+        <%= link_to image_tag('edit.png'), edit_rate_path(rate, :back_url => @back_url) %>
+        <%= link_to image_tag('delete.png'), rate_path(rate, :back_url => @back_url), :method => :delete, :confirm => l(:text_are_you_sure) %>
+        <% else %>
+        <%= image_tag('locked.png') %>
+        <% end %>
+      </td>
+	</tr>
+	</tbody>
+<% end; reset_cycle %>
+</table>

data/app/views/rates/create.js.rjs

@@ -0,0 +1,2 @@
+element = 'rate_' + @rate.project_id.to_s + '_' + @rate.user_id.to_s
+page.replace_html element, "<strong>#{link_to number_to_currency(@rate.amount), { :controller => 'users', :action => 'edit', :id => @rate.user, :tab => 'rates'} }</strong>"

data/app/views/rates/create_error.js.rjs

@@ -0,0 +1,5 @@
+content = render_flash_messages
+page.select("div.flash").each do |value, index|
+  page.hide value
+end
+page.insert_html :top, 'content', content

data/app/views/rates/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Editing rate</h1>
+
+<%= render :partial => 'rates/form' %>

data/app/views/rates/index.html.erb

@@ -0,0 +1,5 @@
+<div id="rate_history">
+<h1><%= l(:rate_label_rate_history) %></h1>
+
+<%= render :partial => 'list' %>
+</div>

data/app/views/rates/new.html.erb

@@ -0,0 +1,3 @@
+<h1><%= l(:rate_label_new_rate) %></h1>
+
+<%= render :partial => 'rates/form' %>

data/app/views/rates/show.html.erb

@@ -0,0 +1,23 @@
+<p>
+  <b>Amount:</b>
+  <%=h @rate.amount %>
+</p>
+
+<p>
+  <b>User:</b>
+  <%=h @rate.user_id %>
+</p>
+
+<p>
+  <b>Project:</b>
+  <%=h @rate.project_id %>
+</p>
+
+<p>
+  <b>Date in effect:</b>
+  <%=h @rate.date_in_effect %>
+</p>
+
+
+<%= link_to 'Edit', edit_rate_path(@rate) %> |
+<%= link_to 'Back', rates_path %>

data/app/views/users/_membership_rate.html.erb

@@ -0,0 +1,23 @@
+    <td id="rate_<%= membership.project.id %>_<%= membership.user.id %>">
+      <% rate = Rate.for(user, membership.project) %>
+
+      <% if rate.nil? || rate.default? %>
+        <% if rate && rate.default? %>
+        <em><%= number_to_currency(rate.amount) %></em>
+        <% end %>
+
+        <% remote_form_for(:rate, :url => rates_path(:format => 'js')) do |f| %>
+
+        <%= f.text_field :amount %>
+        <%= f.hidden_field :date_in_effect, :value => Date.today.to_s, :id => "" %>
+        <%= f.hidden_field :project_id, :value => membership.project.id %>
+        <%= f.hidden_field :user_id, :value => user.id %>
+        <%= hidden_field_tag "back_url", url_for(:controller => 'users', :action => 'edit', :id => user, :tab => 'memberships') %>
+
+        <%= submit_tag(l(:rate_label_set_rate), :class => "small") %>
+        <% end %>
+      <% else %>
+      <strong><%= link_to number_to_currency(rate.amount), { :action => 'edit', :id => user, :tab => 'rates'} %></strong>
+      <% end %>
+
+    </td>

data/app/views/users/_rates.html.erb

@@ -0,0 +1,17 @@
+<h1><%= l(:rate_label_new_rate) %></h1>
+
+<% @rate = Rate.new(:user => @user ) %>
+<% @back_url = url_for(:controller => 'users', :action => 'edit', :id => @user, :tab => 'rates') %>
+<%= render :partial => 'rates/form' %>
+
+<div id="rate_history">
+<h1><%= l(:rate_label_rate_history) %></h1>
+<%# TODO: Refactor out of the view once there is a hook in the controller (Post 0.8.0). %>
+<%# Can't expect everyone to upgrade at the moment %>
+<% sort_init "#{Rate.table_name}.date_in_effect", "desc" %>
+<% sort_update RatesController::ValidSortOptions %>
+
+<% @rates = Rate.history_for_user(@user, "#{Rate.table_name}.date_in_effect desc") %>
+
+<%= render :partial => 'rates/list' %>
+</div>

data/config/locales/de.yml

@@ -0,0 +1,18 @@
+de:
+  rate_label_rates: Betraege
+  rate_label_rate: Betrag
+  rate_label_rate_history: Betragsverlauf
+  rate_label_new_rate: Neuer Betrag
+  rate_label_currency: EUR
+  rate_error_user_not_found: Benutzer nicht gefunden
+  rate_label_set_rate: Betrag setzen
+  rate_label_default: Standard Betrag
+  rate_cost: Kosten
+  text_rate_caches_panel: "Betrags Cache"
+  text_no_cache_run: "kein Cache gefunden"
+  text_last_caching_run: "Zuletzt Cache erstellt: "
+  text_last_cache_clearing_run: "Last cache clearing run at: "
+  text_load_missing_caches: "Load Missing Caches"
+  text_clear_and_load_all_caches: "Clear and Load All Caches"
+  text_caches_loaded_successfully: "Caches loaded successfully"
+

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en:
+  rate_label_rates: Rates
+  rate_label_rate: Rate
+  rate_label_rate_history: Rate History
+  rate_label_new_rate: New Rate
+  rate_label_currency: $
+  rate_error_user_not_found: User not found
+  rate_label_set_rate: Set Rate
+  rate_label_default: Default Rate
+  rate_cost: Cost
+  text_rate_caches_panel: "Rate Caches"
+  text_no_cache_run: "no cache run found"
+  text_last_caching_run: "Last caching run at: "
+  text_last_cache_clearing_run: "Last cache clearing run at: "
+  text_load_missing_caches: "Load Missing Caches"
+  text_clear_and_load_all_caches: "Clear and Load All Caches"
+  text_caches_loaded_successfully: "Caches loaded successfully"
+

data/config/locales/fr.yml

@@ -0,0 +1,20 @@
+fr:
+  rate_label_rates: Tarifs
+  rate_label_rate: Tarif
+  rate_label_rate_history: Historique du tarif
+  rate_label_new_rate: Nouveau tarif
+  rate_label_currency: €
+  rate_error_user_not_found: Utilisateur introuvable
+  rate_label_set_rate: Parametrage du tarif
+  rate_label_default: Tarif par défaut
+  rate_error_user_not_found: Utilisateur non trouvé
+  rate_label_set_rate: Définir le tarif
+  rate_cost: Coût
+  text_rate_caches_panel: "Caches des tarifs"
+  text_no_cache_run: "pas de cache actif trouvé"
+  text_last_caching_run: "Dernier cache actif à : "
+  text_last_cache_clearing_run: "Dernier cache purgé à : "
+  text_load_missing_caches: "Charger les caches manquants"
+  text_clear_and_load_all_caches: "Recharger tous les caches"
+  text_caches_loaded_successfully: "Caches chargés avec succés"
+

data/config/locales/ru.yml

@@ -0,0 +1,9 @@
+ru:
+  rate_label_rates: Платежи
+  rate_label_rate: Платеж
+  rate_label_rate_history: История платежей
+  rate_label_new_rate: Новый платежe
+  rate_label_currency: $
+  rate_error_user_not_found: Пользователь не найден
+  rate_label_set_rate: Установить платеж
+  rate_label_default: Платеж по умолчанию

data/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :rates
+  map.connect 'rate_caches', :conditions => {:method => :put}, :controller => 'rate_caches', :action => 'update'
+end

data/init.rb

@@ -0,0 +1,49 @@
+require 'redmine'
+
+# Patches to the Redmine core
+require 'dispatcher'
+
+Dispatcher.to_prepare :redmine_rate do
+  gem 'lockfile'
+
+  require_dependency 'sort_helper'
+  SortHelper.send(:include, RateSortHelperPatch)
+
+  require_dependency 'time_entry'
+  TimeEntry.send(:include, RateTimeEntryPatch)
+
+  require_dependency 'users_helper'
+  UsersHelper.send(:include, RateUsersHelperPatch) unless UsersHelper.included_modules.include?(RateUsersHelperPatch)
+end
+
+# Hooks
+require 'rate_project_hook'
+require 'rate_memberships_hook'
+
+Redmine::Plugin.register :redmine_rate do
+  name 'Rate'
+  author 'Eric Davis'
+  url 'https://projects.littlestreamsoftware.com/projects/redmine-rate'
+  author_url 'http://www.littlestreamsoftware.com'
+  description "The Rate plugin provides an API that can be used to find the rate for a Member of a Project at a specific date.  It also stores historical rate data so calculations will remain correct in the future."
+  version '0.2.0'
+
+  requires_redmine :version_or_higher => '1.0.0'
+
+  # These settings are set automatically when caching
+  settings(:default => {
+             'last_caching_run' => nil
+           })
+
+  permission :view_rate, { }
+
+  menu :admin_menu, :rate_caches, { :controller => 'rate_caches', :action => 'index'}, :caption => :text_rate_caches_panel
+end
+
+require 'redmine_rate/hooks/timesheet_hook_helper'
+require 'redmine_rate/hooks/plugin_timesheet_views_timesheets_time_entry_row_class_hook'
+require 'redmine_rate/hooks/plugin_timesheet_views_timesheet_group_header_hook'
+require 'redmine_rate/hooks/plugin_timesheet_views_timesheet_time_entry_hook'
+require 'redmine_rate/hooks/plugin_timesheet_views_timesheet_time_entry_sum_hook'
+require 'redmine_rate/hooks/plugin_timesheet_view_timesheets_report_header_tags_hook'
+require 'redmine_rate/hooks/view_layouts_base_html_head_hook'

data/lang/de.yml

@@ -0,0 +1,9 @@
+# English strings go here
+rate_label_rates: Betraege
+rate_label_rate: Betrag
+rate_label_rate_history: Betragsverlauf
+rate_label_new_rate: Neuer Betrag
+rate_label_currency: EUR
+rate_error_user_not_found: Benutzer nicht gefunden
+rate_label_set_rate: Betrag setzen
+rate_label_default: Standard Betrag

data/lang/en.yml

@@ -0,0 +1,9 @@
+# English strings go here
+rate_label_rates: Rates
+rate_label_rate: Rate
+rate_label_rate_history: Rate History
+rate_label_new_rate: New Rate
+rate_label_currency: $
+rate_error_user_not_found: User not found
+rate_label_set_rate: Set Rate
+rate_label_default: Default Rate

data/lang/fr.yml

@@ -0,0 +1,8 @@
+rate_label_rates: Tarifs
+rate_label_rate: Tarif
+rate_label_rate_history: Historique du tarif
+rate_label_new_rate: Nouveau tarif
+rate_label_currency: €
+rate_error_user_not_found: Utilisateur introuvable
+rate_label_set_rate: Parametrage du tarif
+rate_label_default: Tarif par défaut