redmine-project_overview_page 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7108b35be21c95ed2bbd58a52387a338719f8f62
+  data.tar.gz: 1f71454abacd16bfeb307b51de98159e857b51ea
+SHA512:
+  metadata.gz: f7381b78804aa36f7525f9abce2212b7250b81715cebd0b788b2528dd76a6d33f669f7476de3ff9610ac91f139f03be4c01811984fb38ddeb49842facd7d24a6
+  data.tar.gz: faea83f5b82ead21f21ee6acd45518e2301351f768d265898605ba3032113cf63b21e062e2d91f858dbd78e0e12832c771aa1eb1df065d326d6606d54df5d36b

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,32 @@
+# redmine-project_overview_page
+
+Uses special wiki pages as the projects start page and it's sidebar
+
+## Installation
+
+Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
+
+```ruby
+gem "redmine-project_overview_page"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Restart the Redmine application
+
+## Usage
+
+No further steps needed. You can configure the plugin using Redmine's native plugin
+configuration page.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redmine-project_overview_page/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/app/views/settings/_project_overview_page_settings.html.erb

@@ -0,0 +1,11 @@
+<p>
+  <%= label_tag :settings_overview, l(:project_overview_page_settings_overview) %>
+  <%= text_field_tag "settings[overview]", @settings["overview"] %>
+  <span class="hint"><%= l(:project_overview_page_settings_overview_hint) %></span>
+</p>
+
+<p>
+  <%= label_tag :settings_sidebar, l(:project_overview_page_settings_sidebar) %>
+  <%= text_field_tag "settings[sidebar]", @settings["sidebar"] %>
+  <span class="hint"><%= l(:project_overview_page_settings_sidebar_hint) %></span>
+</p>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  project_overview_page_sidebar_label: "Sidebar"
+  project_overview_page_settings_overview: "Overview page"
+  project_overview_page_settings_overview_hint: "The identifer for the wiki page to use as overview"
+  project_overview_page_settings_sidebar: "Sidebar page"
+  project_overview_page_settings_sidebar_hint: "The identifer for the wiki page to use as sidebar"

data/lib/project_overview_page/engine.rb

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

data/lib/project_overview_page/hooks.rb

@@ -0,0 +1,75 @@
+module ProjectOverviewPage
+  class Hooks < Redmine::Hook::ViewListener
+    include ::AttachmentsHelper
+
+    def view_projects_show_top(context)
+      page = find_wiki_page(context, overview_id)
+
+      return unless page
+      %(<div class="wiki">#{render_content_for_page(context, page)}</div>)
+    end
+
+    def view_projects_show_sidebar_top(context)
+      page = find_wiki_page(context, sidebar_id)
+      return unless page
+      %(<div class="wiki">#{render_content_for_page(context, page)}</div>)
+    end
+
+    def view_projects_contextual(ctx)
+      edit_page_link(ctx, overview_id) +
+        edit_page_link(ctx, sidebar_id, "project_overview_page_sidebar_label")
+    end
+
+    private
+
+    def overview_id
+      settings["overview"]
+    end
+
+    def sidebar_id
+      settings["sidebar"]
+    end
+
+    def settings
+      Setting.plugin_project_overview_page
+    end
+
+    def render_content_for_page(context, page)
+      # this rendering must be done through the current view content
+      # otherwise textile macros and etc. won't be available
+      context[:controller].view_context.textilizable(
+        page.content,
+        :text,
+        attachments: page.attachments,
+        project: context[:project]
+      )
+    end
+
+    def edit_page_link(context, id, label = nil)
+      if find_wiki_page(context, id)
+        page_link(context, id, :edit, label)
+      else
+        page_link(context, id, :add, label)
+      end
+    end
+
+    def page_link(context, id, action, label)
+      link_to(
+        l(label || "button_#{action}"),
+        edit_link_path(context, id),
+        class: "icon icon-#{action}",
+        accesskey: accesskey(action.to_sym)
+      )
+    end
+
+    def find_wiki_page(context, title)
+      (project = context[:project]) &&
+        project.wiki &&
+        project.wiki.find_page(title)
+    end
+
+    def edit_link_path(context, id)
+      edit_project_wiki_page_path(project_id: context[:project].id, id: id)
+    end
+  end
+end

data/lib/project_overview_page/infos.rb

@@ -0,0 +1,12 @@
+module ProjectOverviewPage
+  module Infos
+    NAME        = "redmine-project_overview_page"
+    DESCRIPTION = "Uses special wiki pages as the projects start page and" \
+                  " it's sidebar"
+    LICENSE     = "MIT"
+    URL         = "https://github.com/neopoly/redmine-project_overview_page"
+    AUTHORS     = {
+      "Jonas Thiel" => "jt@neopoly.de"
+    }.freeze
+  end
+end

data/lib/project_overview_page/redmine_plugin.rb

@@ -0,0 +1,38 @@
+module ProjectOverviewPage
+  # Registers this gems a Redmine plugin and applies the needed patches
+  class RedminePlugin
+    include ProjectOverviewPage::Infos
+
+    DEFAULT_SETTINGS = {
+      "overview" => "WikiStart",
+      "sidebar"  => "OverviewSidebar"
+    }.freeze
+
+    SETTING_PARTIAL = "settings/project_overview_page_settings"
+
+    def initialize
+      register!
+      boot!
+    end
+
+    private
+
+    def register!
+      Redmine::Plugin.register :project_overview_page do
+        name NAME
+        author AUTHORS.keys.join(", ")
+        description DESCRIPTION
+        version VERSION
+        url URL
+        author_url URL
+        directory Engine.root
+
+        settings default: DEFAULT_SETTINGS, partial:  SETTING_PARTIAL
+      end
+    end
+
+    def boot!
+      require "project_overview_page/hooks"
+    end
+  end
+end

data/lib/project_overview_page/version.rb

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

data/lib/redmine-project_overview_page.rb

@@ -0,0 +1,8 @@
+require "project_overview_page/version"
+require "project_overview_page/infos"
+require "project_overview_page/engine"
+
+# Redmine plugin to support a special wiki page which will be used as
+# the project's overview page and it's sidebar
+module ProjectOverviewPage
+end

data/redmine-project_overview_page.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "project_overview_page/version"
+require "project_overview_page/infos"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine-project_overview_page"
+  spec.version       = ProjectOverviewPage::VERSION
+  spec.authors       = ProjectOverviewPage::Infos::AUTHORS.keys
+  spec.email         = ProjectOverviewPage::Infos::AUTHORS.values
+  spec.summary       = ProjectOverviewPage::Infos::DESCRIPTION
+  spec.description   = ProjectOverviewPage::Infos::DESCRIPTION
+  spec.homepage      = ProjectOverviewPage::Infos::URL
+  spec.license       = ProjectOverviewPage::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 "redmine-more_view_hooks"
+
+  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-project_overview_page
+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: redmine-more_view_hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: Uses special wiki pages as the projects start page and it's sidebar
+email:
+- jt@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/settings/_project_overview_page_settings.html.erb
+- config/locales/en.yml
+- lib/project_overview_page/engine.rb
+- lib/project_overview_page/hooks.rb
+- lib/project_overview_page/infos.rb
+- lib/project_overview_page/redmine_plugin.rb
+- lib/project_overview_page/version.rb
+- lib/redmine-project_overview_page.rb
+- redmine-project_overview_page.gemspec
+homepage: https://github.com/neopoly/redmine-project_overview_page
+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: Uses special wiki pages as the projects start page and it's sidebar
+test_files: []
+has_rdoc: