redmine-project_overview_page 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7108b35be21c95ed2bbd58a52387a338719f8f62
4
+ data.tar.gz: 1f71454abacd16bfeb307b51de98159e857b51ea
5
+ SHA512:
6
+ metadata.gz: f7381b78804aa36f7525f9abce2212b7250b81715cebd0b788b2528dd76a6d33f669f7476de3ff9610ac91f139f03be4c01811984fb38ddeb49842facd7d24a6
7
+ data.tar.gz: faea83f5b82ead21f21ee6acd45518e2301351f768d265898605ba3032113cf63b21e062e2d91f858dbd78e0e12832c771aa1eb1df065d326d6606d54df5d36b
@@ -0,0 +1,2 @@
1
+ Gemfile.lock
2
+ pkg
@@ -0,0 +1,8 @@
1
+ StringLiterals:
2
+ EnforcedStyle: "double_quotes"
3
+
4
+ Style/FileName:
5
+ Enabled: false
6
+
7
+ Documentation:
8
+ Enabled: false
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in candy_check.gemspec
4
+ gemspec
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Jonas Thiel
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,32 @@
1
+ # redmine-project_overview_page
2
+
3
+ Uses special wiki pages as the projects start page and it's sidebar
4
+
5
+ ## Installation
6
+
7
+ Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
8
+
9
+ ```ruby
10
+ gem "redmine-project_overview_page"
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ ```
16
+ $ bundle
17
+ ```
18
+
19
+ Restart the Redmine application
20
+
21
+ ## Usage
22
+
23
+ No further steps needed. You can configure the plugin using Redmine's native plugin
24
+ configuration page.
25
+
26
+ ## Contributing
27
+
28
+ 1. Fork it ( https://github.com/[my-github-username]/redmine-project_overview_page/fork )
29
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
30
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
31
+ 4. Push to the branch (`git push origin my-new-feature`)
32
+ 5. Create a new Pull Request
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env rake
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rubocop/rake_task"
5
+
6
+ RuboCop::RakeTask.new
7
+
8
+ task default: [:rubocop]
@@ -0,0 +1,11 @@
1
+ <p>
2
+ <%= label_tag :settings_overview, l(:project_overview_page_settings_overview) %>
3
+ <%= text_field_tag "settings[overview]", @settings["overview"] %>
4
+ <span class="hint"><%= l(:project_overview_page_settings_overview_hint) %></span>
5
+ </p>
6
+
7
+ <p>
8
+ <%= label_tag :settings_sidebar, l(:project_overview_page_settings_sidebar) %>
9
+ <%= text_field_tag "settings[sidebar]", @settings["sidebar"] %>
10
+ <span class="hint"><%= l(:project_overview_page_settings_sidebar_hint) %></span>
11
+ </p>
@@ -0,0 +1,6 @@
1
+ en:
2
+ project_overview_page_sidebar_label: "Sidebar"
3
+ project_overview_page_settings_overview: "Overview page"
4
+ project_overview_page_settings_overview_hint: "The identifer for the wiki page to use as overview"
5
+ project_overview_page_settings_sidebar: "Sidebar page"
6
+ project_overview_page_settings_sidebar_hint: "The identifer for the wiki page to use as sidebar"
@@ -0,0 +1,10 @@
1
+ require "project_overview_page/redmine_plugin"
2
+
3
+ module ProjectOverviewPage
4
+ # Simple engine to support the Redmine plugin
5
+ class Engine < ::Rails::Engine
6
+ config.to_prepare do
7
+ RedminePlugin.new
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,75 @@
1
+ module ProjectOverviewPage
2
+ class Hooks < Redmine::Hook::ViewListener
3
+ include ::AttachmentsHelper
4
+
5
+ def view_projects_show_top(context)
6
+ page = find_wiki_page(context, overview_id)
7
+
8
+ return unless page
9
+ %(<div class="wiki">#{render_content_for_page(context, page)}</div>)
10
+ end
11
+
12
+ def view_projects_show_sidebar_top(context)
13
+ page = find_wiki_page(context, sidebar_id)
14
+ return unless page
15
+ %(<div class="wiki">#{render_content_for_page(context, page)}</div>)
16
+ end
17
+
18
+ def view_projects_contextual(ctx)
19
+ edit_page_link(ctx, overview_id) +
20
+ edit_page_link(ctx, sidebar_id, "project_overview_page_sidebar_label")
21
+ end
22
+
23
+ private
24
+
25
+ def overview_id
26
+ settings["overview"]
27
+ end
28
+
29
+ def sidebar_id
30
+ settings["sidebar"]
31
+ end
32
+
33
+ def settings
34
+ Setting.plugin_project_overview_page
35
+ end
36
+
37
+ def render_content_for_page(context, page)
38
+ # this rendering must be done through the current view content
39
+ # otherwise textile macros and etc. won't be available
40
+ context[:controller].view_context.textilizable(
41
+ page.content,
42
+ :text,
43
+ attachments: page.attachments,
44
+ project: context[:project]
45
+ )
46
+ end
47
+
48
+ def edit_page_link(context, id, label = nil)
49
+ if find_wiki_page(context, id)
50
+ page_link(context, id, :edit, label)
51
+ else
52
+ page_link(context, id, :add, label)
53
+ end
54
+ end
55
+
56
+ def page_link(context, id, action, label)
57
+ link_to(
58
+ l(label || "button_#{action}"),
59
+ edit_link_path(context, id),
60
+ class: "icon icon-#{action}",
61
+ accesskey: accesskey(action.to_sym)
62
+ )
63
+ end
64
+
65
+ def find_wiki_page(context, title)
66
+ (project = context[:project]) &&
67
+ project.wiki &&
68
+ project.wiki.find_page(title)
69
+ end
70
+
71
+ def edit_link_path(context, id)
72
+ edit_project_wiki_page_path(project_id: context[:project].id, id: id)
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,12 @@
1
+ module ProjectOverviewPage
2
+ module Infos
3
+ NAME = "redmine-project_overview_page"
4
+ DESCRIPTION = "Uses special wiki pages as the projects start page and" \
5
+ " it's sidebar"
6
+ LICENSE = "MIT"
7
+ URL = "https://github.com/neopoly/redmine-project_overview_page"
8
+ AUTHORS = {
9
+ "Jonas Thiel" => "jt@neopoly.de"
10
+ }.freeze
11
+ end
12
+ end
@@ -0,0 +1,38 @@
1
+ module ProjectOverviewPage
2
+ # Registers this gems a Redmine plugin and applies the needed patches
3
+ class RedminePlugin
4
+ include ProjectOverviewPage::Infos
5
+
6
+ DEFAULT_SETTINGS = {
7
+ "overview" => "WikiStart",
8
+ "sidebar" => "OverviewSidebar"
9
+ }.freeze
10
+
11
+ SETTING_PARTIAL = "settings/project_overview_page_settings"
12
+
13
+ def initialize
14
+ register!
15
+ boot!
16
+ end
17
+
18
+ private
19
+
20
+ def register!
21
+ Redmine::Plugin.register :project_overview_page do
22
+ name NAME
23
+ author AUTHORS.keys.join(", ")
24
+ description DESCRIPTION
25
+ version VERSION
26
+ url URL
27
+ author_url URL
28
+ directory Engine.root
29
+
30
+ settings default: DEFAULT_SETTINGS, partial: SETTING_PARTIAL
31
+ end
32
+ end
33
+
34
+ def boot!
35
+ require "project_overview_page/hooks"
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,3 @@
1
+ module ProjectOverviewPage
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,8 @@
1
+ require "project_overview_page/version"
2
+ require "project_overview_page/infos"
3
+ require "project_overview_page/engine"
4
+
5
+ # Redmine plugin to support a special wiki page which will be used as
6
+ # the project's overview page and it's sidebar
7
+ module ProjectOverviewPage
8
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "project_overview_page/version"
5
+ require "project_overview_page/infos"
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = "redmine-project_overview_page"
9
+ spec.version = ProjectOverviewPage::VERSION
10
+ spec.authors = ProjectOverviewPage::Infos::AUTHORS.keys
11
+ spec.email = ProjectOverviewPage::Infos::AUTHORS.values
12
+ spec.summary = ProjectOverviewPage::Infos::DESCRIPTION
13
+ spec.description = ProjectOverviewPage::Infos::DESCRIPTION
14
+ spec.homepage = ProjectOverviewPage::Infos::URL
15
+ spec.license = ProjectOverviewPage::Infos::LICENSE
16
+
17
+ spec.files = `git ls-files -z`.split("\x0")
18
+ spec.executables = spec.files.grep(/^bin\//) { |f| File.basename(f) }
19
+ spec.test_files = spec.files.grep(/^(test|spec|features)\//)
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "rails", "~> 4.2.0"
23
+ spec.add_dependency "redmine-more_view_hooks"
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.7"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rubocop"
28
+ end
metadata ADDED
@@ -0,0 +1,130 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: redmine-project_overview_page
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jonas Thiel
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-03-19 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 4.2.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 4.2.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: redmine-more_view_hooks
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.7'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.7'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: Uses special wiki pages as the projects start page and it's sidebar
84
+ email:
85
+ - jt@neopoly.de
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rubocop.yml"
92
+ - Gemfile
93
+ - LICENSE.txt
94
+ - README.md
95
+ - Rakefile
96
+ - app/views/settings/_project_overview_page_settings.html.erb
97
+ - config/locales/en.yml
98
+ - lib/project_overview_page/engine.rb
99
+ - lib/project_overview_page/hooks.rb
100
+ - lib/project_overview_page/infos.rb
101
+ - lib/project_overview_page/redmine_plugin.rb
102
+ - lib/project_overview_page/version.rb
103
+ - lib/redmine-project_overview_page.rb
104
+ - redmine-project_overview_page.gemspec
105
+ homepage: https://github.com/neopoly/redmine-project_overview_page
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.4.6
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Uses special wiki pages as the projects start page and it's sidebar
129
+ test_files: []
130
+ has_rdoc: