redmine-more_view_hooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4ec1b8064eee5a8d9e4883051a8112d2b64c8c5
+  data.tar.gz: 6eb0ab718c2a6157664f8b8106f6701c1391a346
+SHA512:
+  metadata.gz: 62a4584954d0f9685a220b73d6913a92e2284ffa2d4823606f60a197e109d3987bdf9cf6ec34a9d0bdf0b402657330210d210e48b285fe79251d338dc605381b
+  data.tar.gz: f655718cd3a94c8ebc5f71ef49e66fd711c7764c795faa3c73a0eabab93e2bac229a683a8551d880df891574e4d7c39d1e65735c70a94c7d488a56ccb82989c6

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rubocop.yml

@@ -0,0 +1,8 @@
+StringLiterals:
+  EnforcedStyle: "double_quotes"
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonas Thiel
+
+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,64 @@
+# redmine-more_view_hooks
+
+Allows adding more view hooks into Redmine's templates
+
+## Installation
+
+Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
+
+```ruby
+gem "redmine-more_view_hooks"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+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.
+
+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) %>
+  # 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
+```
+
+To bring this to live we need to add this new view hook into Redmine's base layout template.
+Using this gem you can inject every needed view hooks into every possible template.
+The needed hook can be achieved using the following statement:
+
+```ruby
+MoreViewHooks.add(
+  # first the name of the new view hook
+  :layout_base_logged_as_before,
+  # now some Deface options to determine the correct position of the hook
+  virtual_path:  "layouts/base",
+  insert_before: "#top-menu erb[loud]:contains('if User.current.logged?'):contains('content_tag')"
+)
+```
+
+For more information about the Deface options please have a look at [their documentation](https://github.com/spree/deface#usage).
+
+The correct place to register new view hooks would be when initializing your Redmine plugin.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop]

data/lib/more_view_hooks/default_additional_hooks.rb

@@ -0,0 +1,21 @@
+MoreViewHooks.instance_eval do
+  add(:view_projects_contextual,
+      virtual_path: "projects/show",
+      insert_top:   "div.contextual"
+  )
+
+  add(:view_projects_show_top,
+      virtual_path:  "projects/show",
+      insert_before: "div.splitcontentleft"
+  )
+
+  add(:view_projects_show_bottom,
+      virtual_path: "projects/show",
+      insert_after: "div.splitcontentright"
+  )
+
+  add(:view_projects_show_sidebar_top,
+      virtual_path:  "projects/_sidebar",
+      insert_before: "erb[silent]:contains('if @total_hours.present?')"
+  )
+end

data/lib/more_view_hooks/engine.rb

@@ -0,0 +1,10 @@
+require "more_view_hooks/redmine_plugin"
+
+module MoreViewHooks
+  # Simple engine to support the Redmine plugin
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      RedminePlugin.new
+    end
+  end
+end

data/lib/more_view_hooks/hook.rb

@@ -0,0 +1,18 @@
+module MoreViewHooks
+  # Describes a preconfigured view hook which will be later applied
+  # by using the elegant Deface gem
+  class Hook
+    attr_reader :deface_options
+
+    def initialize(hook_name, context, options)
+      @deface_options = options.merge(
+        text: "<%= call_hook(:#{hook_name}, #{context || '{}'}) %>",
+        name: "more_view_hooks_#{hook_name}"
+      )
+    end
+
+    def apply!
+      Deface::Override.new(deface_options)
+    end
+  end
+end

data/lib/more_view_hooks/hook_collection.rb

@@ -0,0 +1,25 @@
+module MoreViewHooks
+  # Manages hooks to be applied into Redmine's templates
+  class HookCollection
+    def initialize
+      @hooks   = {}
+      @applied = false
+    end
+
+    # Applies all registered view hooks
+    def apply!
+      @hooks.values.each(&:apply!)
+      @applied = true
+    end
+
+    # Registers a new view hook
+    # @param name [String]
+    # @param options [Hash] for Defaced
+    def add(name, options)
+      fail ArgumentError, "A view hook '#{name}' already exists" if @hooks[name]
+      context = options.delete(:context)
+      hook = @hooks[name] = Hook.new(name, context, options)
+      hook.apply! if @applied
+    end
+  end
+end

data/lib/more_view_hooks/infos.rb

@@ -0,0 +1,11 @@
+module MoreViewHooks
+  module Infos
+    NAME        = "redmine-more_view_hooks"
+    DESCRIPTION = "Allows adding more view hooks into Redmine's templates"
+    LICENSE     = "MIT"
+    URL         = "https://github.com/neopoly/redmine-more_view_hooks"
+    AUTHORS     = {
+      "Jonas Thiel" => "jt@neopoly.de"
+    }.freeze
+  end
+end

data/lib/more_view_hooks/redmine_plugin.rb

@@ -0,0 +1,33 @@
+module MoreViewHooks
+  # Registers this gems a Redmine plugin and applies the needed patches
+  class RedminePlugin
+    include MoreViewHooks::Infos
+
+    def initialize
+      register!
+      boot!
+    end
+
+    private
+
+    def register!
+      Redmine::Plugin.register :more_view_hooks do
+        name NAME
+        author AUTHORS.keys.join(", ")
+        description DESCRIPTION
+        version VERSION
+        url URL
+        author_url URL
+        directory Engine.root
+      end
+    end
+
+    def boot!
+      MoreViewHooks.hooks.apply!
+    end
+
+    def mirror_assets!
+      @plugin.mirror_assets
+    end
+  end
+end

data/lib/more_view_hooks/version.rb

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

data/lib/redmine-more_view_hooks.rb

@@ -0,0 +1,22 @@
+require "deface"
+
+require "more_view_hooks/version"
+require "more_view_hooks/infos"
+require "more_view_hooks/engine"
+require "more_view_hooks/hook"
+require "more_view_hooks/hook_collection"
+
+# Redmine plugin to allow injecting more view hooks
+module MoreViewHooks
+  def hooks
+    @hooks ||= HookCollection.new
+  end
+  module_function :hooks
+
+  def add(*args)
+    hooks.add(*args)
+  end
+  module_function :add
+
+  require "more_view_hooks/default_additional_hooks"
+end

data/redmine-more_view_hooks.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "more_view_hooks/version"
+require "more_view_hooks/infos"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine-more_view_hooks"
+  spec.version       = MoreViewHooks::VERSION
+  spec.authors       = MoreViewHooks::Infos::AUTHORS.keys
+  spec.email         = MoreViewHooks::Infos::AUTHORS.values
+  spec.summary       = MoreViewHooks::Infos::DESCRIPTION
+  spec.description   = MoreViewHooks::Infos::DESCRIPTION
+  spec.homepage      = MoreViewHooks::Infos::URL
+  spec.license       = MoreViewHooks::Infos::LICENSE
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.2.0"
+  spec.add_dependency "deface", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: redmine-more_view_hooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows adding more view hooks into Redmine's templates
+email:
+- jt@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/more_view_hooks/default_additional_hooks.rb
+- lib/more_view_hooks/engine.rb
+- lib/more_view_hooks/hook.rb
+- lib/more_view_hooks/hook_collection.rb
+- lib/more_view_hooks/infos.rb
+- lib/more_view_hooks/redmine_plugin.rb
+- lib/more_view_hooks/version.rb
+- lib/redmine-more_view_hooks.rb
+- redmine-more_view_hooks.gemspec
+homepage: https://github.com/neopoly/redmine-more_view_hooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Allows adding more view hooks into Redmine's templates
+test_files: []
+has_rdoc: