redmine_refresh 0.3.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redmine_refresh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jbbarth
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+Redmine Refresh plugin
+======================
+
+This plugins adds an automatic refresh on "Issues" lists and "My Page".
+
+Screenshot
+----------
+
+With this plugin you'll have a clickable link on these pages for enabling/disabling automatic refresh. Here's an example on an Issues list:
+
+![redmine_refresh screenshot](http://jbbarth.com/screenshots/redmine_refresh.png)
+
+Installation
+------------
+
+This plugin is compatible with Redmine 2.1.x and 2.2.x, and should be compatible with future versions.
+
+Add this line to your redmine's Gemfile.local:
+
+    gem 'redmine_refresh'
+
+And then execute:
+
+    $ bundle install
+
+And restart your Redmine instance.
+
+This gem aims at working inside a Redmine instance. Any other usage is discouraged.
+
+Note that general instructions for plugins [here](http://www.redmine.org/wiki/redmine/Plugins) don't apply here.
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/overrides/issues/index.rb

@@ -0,0 +1,5 @@
+Deface::Override.new :virtual_path  => 'issues/index',
+                     :original      => '402b3096154c5706049c1de2f9fedeaa63f6b618',
+                     :name          => 'add-refresh-link-to-issues-list',
+                     :insert_top    => 'div.contextual',
+                     :partial       => 'redmine_refresh/refresher'

data/app/overrides/my/page.rb

@@ -0,0 +1,5 @@
+Deface::Override.new :virtual_path  => 'my/page',
+                     :original      => '7b02b984dabd756a62959aeea9c05db9d378bf7a',
+                     :name          => 'add-refresh-link-to-my-page',
+                     :insert_top    => 'div.contextual',
+                     :partial       => 'redmine_refresh/refresher'

data/app/views/redmine_refresh/_refresher.html.erb

@@ -0,0 +1,51 @@
+<%
+  interval = RedmineRefresh.refresh_interval_for(User.current, params[:refresh])
+  should_be_refreshed = RedmineRefresh.refresh_status_for_controller(User.current, controller.controller_name)
+  should_be_refreshed ||= params[:refresh].present?
+  should_be_refreshed = false if params[:norefresh]
+  RedmineRefresh.save_refresh_status_for_controller(User.current, controller.controller_name, should_be_refreshed)
+%>
+<script type="text/javascript">
+//<![CDATA[
+  //ADAPTED FROM:
+  //http://www.dynamicdrive.com/dynamicindex6/refresh.htm
+
+  //configure refresh interval (in seconds)
+  var countDownTime = <%= interval + 1 %>;
+  var counter;
+
+  function countDown() {
+    countDownTime--;
+    $('#refresher_seconds').html(countDownTime);
+    //refresh
+    if (countDownTime <= 0) {
+      countDownTime = <%= interval %>
+      clearTimeout(counter);
+      window.location.reload();
+    } else {
+      counter = setTimeout("countDown()", 1000);
+    }
+  }
+
+  function stopCountDown(url) {
+    clearTimeout(counter);
+    window.location.href = url
+  }
+
+  function startCountDown(url) {
+    window.location.href = url
+  }
+
+<% if should_be_refreshed %>
+  $(function() { countDown(); })
+<% end %>
+//]]>
+</script>
+
+<% opts = {:class => 'icon icon-reload', :id => 'refresher'} %>
+<% if should_be_refreshed %>
+  <%= link_to_function l(:refresh_in, content_tag(:span, interval, :id => 'refresher_seconds')).html_safe,
+                       "startCountDown('#{url_for(params.merge(:norefresh => 1).except(:refresh))}')", opts %>
+<% else %>
+  <%= link_to_function l(:automatic_refresh), "stopCountDown('#{url_for(params.merge(:refresh => interval).except(:norefresh))}')", opts %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  refresh_in: "Refresh in %{value}s"
+  automatic_refresh: "Automatic refresh"

data/config/locales/fr.yml

@@ -0,0 +1,3 @@
+fr:
+  refresh_in: "Actualisation dans %{value}s"
+  automatic_refresh: "Actualisation automatique"

data/config/locales/zh.yml

@@ -0,0 +1,9 @@
+zh:
+  refresh_in: "刷新频率 %{value}s"
+  automatic_refresh: "自动刷新"
+  
+# Simplified Chinese strings go here for Rails i18n  
+# Author： Steven.W
+# Based on file: en.yml
+
+

data/init.rb

@@ -0,0 +1,19 @@
+# Little hack for using the 'deface' gem in redmine:
+# - redmine plugins are not railties nor engines, so deface overrides in app/overrides/ are not detected automatically
+# - deface doesn't support direct loading anymore ; it unloads everything at boot so that reload in dev works
+# - hack consists in adding "app/overrides" path of the plugin in Redmine's main #paths
+# TODO: see if it's complicated to turn a plugin into a Railtie or find something a bit cleaner
+Rails.application.paths["app/overrides"] ||= []
+Rails.application.paths["app/overrides"] << File.expand_path("../app/overrides", __FILE__)
+
+Redmine::Plugin.register :redmine_refresh do
+  name 'Redmine Refresh plugin'
+  description 'This is a plugin for Redmine'
+  url 'https://github.com/jbbarth/redmine_refresh'
+  author 'Jean-Baptiste BARTH'
+  author_url 'mailto:jeanbaptiste.barth@gmail.com'
+  #TODO: make it depend on redmine_refresh/version
+  version '0.3.0'
+  requires_redmine :version_or_higher => '2.1.0'
+  #settings :default => { }, :partial => 'settings/sudo_settings'
+end

data/lib/redmine_refresh/version.rb

@@ -0,0 +1,3 @@
+module RedmineRefresh
+  VERSION = "0.3.0"
+end

data/lib/redmine_refresh.rb

@@ -0,0 +1,48 @@
+require "redmine_refresh/version"
+
+module RedmineRefresh
+  # Run the classic redmine plugin initializer after rails boot
+  class Plugin < ::Rails::Engine
+    config.after_initialize do
+      require File.expand_path("../../init", __FILE__)
+    end
+  end
+
+  extend self #... so we can call RedmineRefresh.<method> directly
+
+  DEFAULT_INTERVAL = 120
+
+  def refresh_interval_for(user, refresh_param = nil)
+    interval = DEFAULT_INTERVAL
+    user_interval = user.pref[:refresh_interval].to_i
+    #if parameter is provided
+    if refresh_param.to_i >= 10
+      interval = refresh_param.to_i
+      #save it if modified
+      if interval != user_interval
+        user.pref[:refresh_interval] = interval
+        user.pref.save
+      end
+    #if not, get the user's
+    elsif user_interval >= 10
+      interval = user_interval
+    end
+    interval
+  end
+
+  #if should_be_refreshed != RedmineRefresh.refresh_status_for_controller(controller.controller_name)
+  def refresh_status_for_controller(user, controller = nil)
+    controller = controller.to_s
+    controller.present? && user.pref[:refresh_status].is_a?(Hash) && user.pref[:refresh_status][controller]
+  end
+
+  def save_refresh_status_for_controller(user, controller, current_refresh_status)
+    user_refresh_status = refresh_status_for_controller(user, controller)
+    controller = controller.to_s
+    if controller.present? && user_refresh_status != current_refresh_status
+      user.pref[:refresh_status] ||= Hash.new
+      user.pref[:refresh_status][controller] = current_refresh_status
+      user.pref.save
+    end
+  end
+end

data/redmine_refresh.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redmine_refresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine_refresh"
+  spec.version       = RedmineRefresh::VERSION
+  spec.authors       = ["jbbarth"]
+  spec.email         = ["jeanbaptiste.barth@gmail.com"]
+  spec.description   = %q{Adds an automatic refresh option to Redmine's issues list}
+  spec.summary       = %q{Adds an automatic refresh option to Redmine's issues list}
+  spec.homepage      = "https://github.com/jbbarth/redmine_refresh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "deface"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+# Load the normal Rails helper
+require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')

data/test/unit/redmine_refresh_test.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RedmineRefreshTest < ActiveSupport::TestCase
+  fixtures :users, :user_preferences
+
+  setup do
+    @user = User.find(1) #permissions don't matter
+  end
+
+  context "#refresh_interval_for" do
+    should "return 120 by default " do
+      assert_equal 120, RedmineRefresh.refresh_interval_for(@user)
+    end
+
+    should "return second params if >= 10" do
+      assert_equal 10, RedmineRefresh.refresh_interval_for(@user, "10")
+      assert_equal 12, RedmineRefresh.refresh_interval_for(@user, 12)
+    end
+
+    should "not return second param if not >= 10" do
+      assert_equal 120, RedmineRefresh.refresh_interval_for(@user, 9)
+      assert_equal 120, RedmineRefresh.refresh_interval_for(@user, "abcd")
+      assert_equal 120, RedmineRefresh.refresh_interval_for(@user, -20)
+    end
+
+    should "save parameter in user preferences if modified and valid" do
+      assert_equal nil, @user.reload.pref[:refresh_interval]
+      RedmineRefresh.refresh_interval_for(@user, "10")
+      assert_equal 10, @user.reload.pref[:refresh_interval]
+      RedmineRefresh.refresh_interval_for(@user, "30")
+      assert_equal 30, @user.reload.pref[:refresh_interval]
+      RedmineRefresh.refresh_interval_for(@user, "abc")
+      assert_equal 30, @user.reload.pref[:refresh_interval]
+    end
+
+    should "not save user preferences if parameter is untouched" do
+      RedmineRefresh.refresh_interval_for(@user, "10")
+      assert_equal 10, @user.reload.pref[:refresh_interval]
+      @user.pref.stubs(:save).raises(Exception, "This shouldn't be called !")
+      assert_nothing_raised do
+        RedmineRefresh.refresh_interval_for(@user, "10")
+      end
+    end
+
+    should "get the user preference if no valid parameter provided" do
+      @user.pref[:refresh_interval] = 30
+      @user.pref.save
+      assert_equal 30, RedmineRefresh.refresh_interval_for(@user)
+    end
+
+    should "not get the user preference if a valid parameter is provided" do
+      @user.pref[:refresh_interval] = 30
+      @user.pref.save
+      assert_equal 30, @user.reload.pref[:refresh_interval]
+      assert_equal 50, RedmineRefresh.refresh_interval_for(@user, "50")
+    end
+  end
+
+  context "#refresh_status_for_controller" do
+    should "return false if no controller provided" do
+      assert !RedmineRefresh.refresh_status_for_controller(@user)
+    end
+
+    should "return false by default" do
+      assert !RedmineRefresh.refresh_status_for_controller(@user, "my")
+    end
+
+    should "proxy to user preferences for refresh_status" do
+      @user.pref[:refresh_status] = {"my" => true}
+      @user.pref.save
+      @user.reload
+      assert RedmineRefresh.refresh_status_for_controller(@user, "my")
+      assert !RedmineRefresh.refresh_status_for_controller(@user, "other")
+    end
+
+    should "be falsy for not-logged user" do
+      @user = User.anonymous
+      @user.pref[:refresh_status] = {"my" => true}
+      assert !RedmineRefresh.refresh_status_for_controller(@user, "my")
+    end
+  end
+
+  context "#save_refresh_status_for_controller" do
+    setup do
+      @user.pref[:refresh_status] = {"my" => true}
+      @user.pref.save
+      @user.reload
+    end
+
+    should "save refresh_status for this controller if needed" do
+      RedmineRefresh.save_refresh_status_for_controller(@user, "my", false)
+      @user.reload
+      assert !RedmineRefresh.refresh_status_for_controller(@user, "my")
+    end
+
+    should "not save refresh_status for this controller if not changed" do
+      @user.pref.stubs(:save).raises(Exception, "This shouldn't be called !")
+      assert_nothing_raised do
+        RedmineRefresh.save_refresh_status_for_controller(@user, "my", true)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: redmine_refresh
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- jbbarth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds an automatic refresh option to Redmine's issues list
+email:
+- jeanbaptiste.barth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/overrides/issues/index.rb
+- app/overrides/my/page.rb
+- app/views/redmine_refresh/_refresher.html.erb
+- config/locales/en.yml
+- config/locales/fr.yml
+- config/locales/zh.yml
+- init.rb
+- lib/redmine_refresh.rb
+- lib/redmine_refresh/version.rb
+- redmine_refresh.gemspec
+- test/test_helper.rb
+- test/unit/redmine_refresh_test.rb
+homepage: https://github.com/jbbarth/redmine_refresh
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3202885522513128351
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3202885522513128351
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds an automatic refresh option to Redmine's issues list
+test_files:
+- test/test_helper.rb
+- test/unit/redmine_refresh_test.rb