redmine-more_view_hooks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4ec1b8064eee5a8d9e4883051a8112d2b64c8c5
-  data.tar.gz: 6eb0ab718c2a6157664f8b8106f6701c1391a346
+  metadata.gz: 36a45bd7ab30331d67d0c2862e7f49632f35e807
+  data.tar.gz: e1553577e226189fe1bd9d94dcce99adbbd291f1
 SHA512:
-  metadata.gz: 62a4584954d0f9685a220b73d6913a92e2284ffa2d4823606f60a197e109d3987bdf9cf6ec34a9d0bdf0b402657330210d210e48b285fe79251d338dc605381b
-  data.tar.gz: f655718cd3a94c8ebc5f71ef49e66fd711c7764c795faa3c73a0eabab93e2bac229a683a8551d880df891574e4d7c39d1e65735c70a94c7d488a56ccb82989c6
+  metadata.gz: 96257c2dbcdb8b10a2448b73f0890b5da7fd6f06f385de6754e3e477a46d91792617defb67a692060115ffe40fd0a7286cc4d02bb5faf300e0b1338d91e20c08
+  data.tar.gz: 3e0767cfae4bfa9b04a3960fd8e886fa9b57f809ecc9a948c991892ccb040e25a36ebcda0af2e99e3965d4ee3187663f2f1f9b7fc7c6adf45850b85ca6c1afed

data/.rubocop.yml

@@ -6,3 +6,7 @@ Style/FileName:
 
 Documentation:
   Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/rubocop.rake

data/README.md

@@ -1,5 +1,19 @@
+[github]: https://github.com/neopoly/redmine-more_view_hooks
+[doc]: http://rubydoc.info/github/neopoly/redmine-more_view_hooks/master/file/README.md
+[gem]: https://rubygems.org/gems/redmine-more_view_hooks
+[gem-badge]: https://img.shields.io/gem/v/redmine-more_view_hooks.svg
+[inchpages]: https://inch-ci.org/github/neopoly/redmine-more_view_hooks
+[inchpages-badge]: https://inch-ci.org/github/neopoly/redmine-more_view_hooks.svg?branch=master&style=flat
+
 # redmine-more_view_hooks
 
+[![Gem Version][gem-badge]][gem]
+[![Inline docs][inchpages-badge]][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
 Allows adding more view hooks into Redmine's templates
 
 ## Installation
@@ -20,20 +34,20 @@ Restart the Redmine application
 
 ## Usage
 
-Redmine already includes a concept of "view hooks", but not every place one can think already
-as such a hook. E.g. a hook before the user login status in the top menu is missing.
+Redmine already includes a concept of "view hooks", but not every place already
+has such a hook. For example, a hook before the user login status in the top menu is missing.
 
 Let's *assume* the needed view hook would already exists at the desired position and would be called `layout_base_logged_as_before`.
 In this case one can simple write a new view hook listener as [natively supported from Redmine](http://www.redmine.org/projects/redmine/wiki/Hooks):
 
 ```ruby
 class Hooks < Redmine::Hook::ViewListener
-  # Redmine run's this method whenever a <%= call_hook(:layout_base_logged_as_before) %>
+  # Redmine runs this method whenever a <%= call_hook(:layout_base_logged_as_before) %>
   # is included into the templates.
   # Attention: This view hook doesn't exists in Redmine and must be realized using this gem
   def layout_base_logged_as_before(context)
     content_tag :span, "Some additional content"
-  ends
+  end
 end
 ```
 
@@ -55,9 +69,41 @@ For more information about the Deface options please have a look at [their docum
 
 The correct place to register new view hooks would be when initializing your Redmine plugin.
 
+### Avoiding hook definitions with identical names
+
+Redmine allows multiple hook definitions with identical names across separate hook listeners.
+
+`MoreViewHooks.add` disallows hook definitions using the same name. So this won't work:
+
+```ruby
+MoreViewHooks.add(:unique_name, ...)
+
+# raises "A view hook 'unique_name' already exists (ArgumentError)"
+MoreViewHooks.add(:unique_name, ...)
+```
+
+Note: Defining a hook via `MoreViewHooks.add` re-using an existing Redmine hook name should work without problems.
+
+Here is an example how to avoid duplicate hook names:
+
+```ruby
+unless Redmine::Hook.hook_listeners(:view_projects_show_left).any?
+  MoreViewHooks.add(:view_projects_show_left,
+    virtual_path: "projects/show",
+    insert_top:   "div.contextual"
+  )
+end
+```
+
+## Tested Redmine versions
+
+* Redmine 1.x
+* Redmine 2.x
+* Redmine 3.0 - 3.2
+
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/redmine-more_view_hooks/fork )
+1. Fork it ( https://github.com/neopoly/redmine-more_view_hooks/fork )
 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`)

data/Rakefile

@@ -3,6 +3,4 @@
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
-
 task default: [:rubocop]

data/lib/more_view_hooks/default_additional_hooks.rb

@@ -14,8 +14,15 @@ MoreViewHooks.instance_eval do
       insert_after: "div.splitcontentright"
   )
 
-  add(:view_projects_show_sidebar_top,
-      virtual_path:  "projects/_sidebar",
-      insert_before: "erb[silent]:contains('if @total_hours.present?')"
-  )
+  if redmine_version_at_least?("3.1")
+    add(:view_projects_show_sidebar_top,
+        virtual_path:  "projects/_sidebar",
+        insert_before: "erb[silent]:contains('if User.current.allowed_to?(:view_time_entries, @project)')"
+    )
+  else
+    add(:view_projects_show_sidebar_top,
+        virtual_path:  "projects/_sidebar",
+        insert_before: "erb[silent]:contains('if @total_hours.present?')"
+    )
+  end
 end

data/lib/more_view_hooks/redmine_plugin.rb

@@ -23,6 +23,7 @@ module MoreViewHooks
     end
 
     def boot!
+      MoreViewHooks.load_default_additional_hooks!
       MoreViewHooks.hooks.apply!
     end
 

data/lib/more_view_hooks/version.rb

@@ -1,3 +1,3 @@
 module MoreViewHooks
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/redmine-more_view_hooks.rb

@@ -18,5 +18,13 @@ module MoreViewHooks
   end
   module_function :add
 
-  require "more_view_hooks/default_additional_hooks"
+  def redmine_version_at_least?(other)
+    Gem::Version.new(::Redmine::VERSION) > Gem::Version.new(other)
+  end
+  module_function :redmine_version_at_least?
+
+  def load_default_additional_hooks!
+    require "more_view_hooks/default_additional_hooks"
+  end
+  module_function :load_default_additional_hooks!
 end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+
+  namespace :rubocop do
+    desc "Generate a configuration file acting as a TODO list."
+    task :auto_gen_config do
+      exec "bundle exec rubocop --auto-gen-config"
+    end
+  end
+
+rescue LoadError
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine-more_view_hooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonas Thiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -101,6 +101,7 @@ files:
 - lib/more_view_hooks/redmine_plugin.rb
 - lib/more_view_hooks/version.rb
 - lib/redmine-more_view_hooks.rb
+- rakelib/rubocop.rake
 - redmine-more_view_hooks.gemspec
 homepage: https://github.com/neopoly/redmine-more_view_hooks
 licenses:
@@ -127,4 +128,3 @@ signing_key:
 specification_version: 4
 summary: Allows adding more view hooks into Redmine's templates
 test_files: []
-has_rdoc: