openproject-ensure_project_hierarchy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c161be0488b95656f7e66701a9b044b4b22b7966
+  data.tar.gz: 909858bb807edc78dc8972e3fa8b31f0faf4e2d1
+SHA512:
+  metadata.gz: 15cb9043cf21680b755ff014488aac5d892de3643804eb67b1c67b1ae8107e8c4ea9c80d5bf46d5d478ba75f9af65ff4d4a13c967b9b1944971e11016d5b0393
+  data.tar.gz: 5cde86fab68912c5899aaf86838a8a4f0e5d267346bc44f2e6ae8b7cbfdc86228540e201ea3450457aa8a202a6b0b54b398d0b9e06649be0d3891d95abb23757

data/README.md

@@ -0,0 +1,35 @@
+# OpenProject Ensure Project Hierarchy Plugin
+
+This plugin ensures subproject identifiers are prefixed with their parent
+project's identifier.
+
+## Notes
+
+* Admins are allowed to set any identifier regardless of the parent project.
+* You cannot update the identifier of a project without changing the parent project to a matching value.
+
+## Requirements
+
+* OpenProject Version >= 3.0
+
+
+## Installation
+
+Create a file `Gemfile.plugins` in your OpenProject installation with the following content:
+
+	gem "openproject-plugins", :git => "https://github.com/opf/openproject-plugins.git", :branch => "stable" 
+	gem "openproject-ensure_project_hierarchy", :git => "https://github.com/oliverguenther/openproject-ensure_project_hierarchy.git", :branch => "stable"
+
+
+Please see the [OpenProject plugin overview](https://www.openproject.org/projects/openproject/wiki/OpenProject_Plug-Ins)
+for more details.
+
+## License
+
+Copyright (c) 2014 Oliver Günther (mail@oliverguenther.de)
+
+This plugin is forked from the [ChiliProject Ensure Project Hierarchy Plugin](https://github.com/thegcat/chiliproject_ensure_project_hierarchy) by Felix Schäfer.
+
+Copyright (c) 2011 Felix Schäfer
+
+This plugin is licensed under the MIT license. See COPYING for details.

data/app/views/settings/_openproject_ensure_project_hierarchy.html.erb

@@ -0,0 +1,10 @@
+<h3><%= l(:separator) %></h3>
+
+<p>
+  <label><%= l(:separator) %></label>
+  <%= text_field_tag("settings[separator]",
+    Setting.plugin_openproject_ensure_project_hierarchy[:separator], :size => 10)
+  %>
+  <br />
+  <em><%= t(:separator_desc, default_separator: Setting.plugin_openproject_ensure_project_hierarchy[:separator]) %></em>
+</p>

data/config/locales/de.yml

@@ -0,0 +1,8 @@
+# German strings go here for Rails i18n
+de:
+  activerecord:
+    errors:
+      messages:
+        prefix_invalid: "muss den Präfix \"%{prefix}\" haben"
+  separator: Trennzeichen
+  separator_desc: "Das Trennzeichen zwischen Nutzername und Projektname. Standard: \'%{default_separator}\'"

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+# English strings go here for Rails i18n
+en:
+  activerecord:
+    errors:
+      messages:
+        prefix_invalid: "must start with \"%{prefix}\""
+  separator: Separator
+  separator_desc: "The separator between username and the given project name. Defaults to \'%{default_separator}\'"

data/lib/open_project/ensure_project_hierarchy.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module EnsureProjectHierarchy
+    require "open_project/ensure_project_hierarchy/engine"
+  end
+end

data/lib/open_project/ensure_project_hierarchy/engine.rb

@@ -0,0 +1,24 @@
+module OpenProject::EnsureProjectHierarchy
+  class Engine < ::Rails::Engine
+    engine_name :openproject_ensure_project_hierarchy
+
+
+    def self.settings
+      { :partial => 'settings/openproject_ensure_project_hierarchy',
+        :default => {
+          :separator => '-',
+        }
+      }
+    end
+
+    include OpenProject::Plugins::ActsAsOpEngine
+
+    register 'openproject-ensure_project_hierarchy',
+      :author_url => 'https://github.com/oliverguenther/openproject-ensure_project_hierarchy',
+      :requires_openproject => '>= 3.0.0',
+      :settings => settings
+
+    patches [ :Project, :ProjectsController ]
+
+  end
+end

data/lib/open_project/ensure_project_hierarchy/patches.rb

@@ -0,0 +1,2 @@
+module OpenProject::EnsureProjectHierarchy::Patches
+end

data/lib/open_project/ensure_project_hierarchy/patches/project_patch.rb

@@ -0,0 +1,36 @@
+module OpenProject::EnsureProjectHierarchy
+  module Patches
+    module ProjectPatch
+
+      def self.included(base)
+        base.class_eval do
+          unloadable
+
+          include InstanceMethods
+
+          validate :identifier_hierarchy_correctness
+        end
+      end
+
+
+      module InstanceMethods
+
+        private
+
+        def identifier_hierarchy_correctness
+          return true if User.current.admin?
+
+          if parent && !identifier.start_with?([parent.identifier,
+            Setting.plugin_openproject_ensure_project_hierarchy[:separator]].join)
+
+            errors.add :identifier, :prefix_invalid, :prefix => "#{parent.identifier}-"
+            return false
+          end
+          true
+        end
+      end
+    end
+  end
+end
+
+Project.send(:include, OpenProject::EnsureProjectHierarchy::Patches::ProjectPatch)

data/lib/open_project/ensure_project_hierarchy/patches/projects_controller_patch.rb

@@ -0,0 +1,36 @@
+module OpenProject::EnsureProjectHierarchy
+  module Patches
+    module ProjectsControllerPatch
+
+      def self.included(base)
+        base.class_eval do
+          unloadable
+
+          include InstanceMethods
+
+          alias_method_chain :new, :default_identifier_for_new_subprojects
+        end
+      end
+
+
+      module InstanceMethods
+
+        private
+        
+        def new_with_default_identifier_for_new_subprojects
+          new_without_default_identifier_for_new_subprojects
+          if params[:parent_id]
+
+            parent_project = Project.find params[:parent_id]
+            @project.identifier = [parent_project.identifier,
+              Setting.plugin_openproject_ensure_project_hierarchy[:separator]].join
+
+            Rails.logger.info("[EnsureProjectHierarchy] Overriding project identifier to #{@project.identifier}")
+          end
+        end
+      end
+    end
+  end
+end
+
+ProjectsController.send(:include, OpenProject::EnsureProjectHierarchy::Patches::ProjectsControllerPatch)

data/lib/open_project/ensure_project_hierarchy/version.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module EnsureProjectHierarchy
+    VERSION = "0.1.0"
+  end
+end

data/lib/openproject-ensure_project_hierarchy.rb

@@ -0,0 +1 @@
+require 'open_project/ensure_project_hierarchy'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: openproject-ensure_project_hierarchy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Günther
+- Felix Schäfer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This plugin ensures subproject identifiers are prefixes with their parent
+  project's identifier.
+email: mail@oliverguenther.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/views/settings/_openproject_ensure_project_hierarchy.html.erb
+- config/locales/de.yml
+- config/locales/en.yml
+- lib/open_project/ensure_project_hierarchy.rb
+- lib/open_project/ensure_project_hierarchy/engine.rb
+- lib/open_project/ensure_project_hierarchy/patches.rb
+- lib/open_project/ensure_project_hierarchy/patches/project_patch.rb
+- lib/open_project/ensure_project_hierarchy/patches/projects_controller_patch.rb
+- lib/open_project/ensure_project_hierarchy/version.rb
+- lib/openproject-ensure_project_hierarchy.rb
+homepage: https://www.github.com/oliverguenther/openproject-ensure_project_hierarchy
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ensure Project Hierarchy Plugin
+test_files: []
+has_rdoc: