openproject-plugins 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82f6dd65effd37dc2d14bea60a33b61ccdc78655
+  data.tar.gz: 879a92f8812e7c07d835802b56307453cf04d6d9
+SHA512:
+  metadata.gz: 8b1583c4f8c496217155e355a87ba08c423655331f2391929c730b254cce44e5985387c9f4b4b566865cbc83836de8f4ae233aef06cd00fe397493743ed8844b
+  data.tar.gz: 768a7f518c111bd89ae8f5ddd081c7486721a534839dc75d3d343630e9cca1048a5cd3ce7604f58635b6d2068cde8cdb389cc740b584c329fd79fe9ba63aaaa3

data/README.md

@@ -0,0 +1,71 @@
+<!---- copyright
+OpenProject is a project management system.
+
+Copyright (C) 2012-2013 the OpenProject Team
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License version 3.
+
+See doc/COPYRIGHT.md for more details.
+
+++-->
+
+# OpenProject Plugins Plugin
+
+This plugin aims to make writing plugins easier. It provides a generator for creating a basic plugin structure and a module that simplifies setting up the plugin Rails engine. Thus, it is also a dependency for many plugins.
+
+## Usage
+
+Make sure to include the plugins plugin before all other plugins in your Gemfile, otherwise the module used by the plugin Rails engines (`OpenProject::Plugins::ActsAsOpEngine`) is not available when a plugin is being loaded.
+
+### Generator
+
+    bundle exec rails generate open_project:plugin <plugin name> <target folder>
+
+The generator will create a new subfolder within `<target folder>`, named `openproject-<plugin name>`.
+
+Example:
+
+    bundle exec rails generate open_project:plugin xls_export .
+
+### ActsAsOpEngine
+
+The generated engine uses `ActsAsOpEngine` by default, so just have a look at this file.
+For more information on how to use `ActsAsOpEngine`, just see the comments in its [source code](lib/open_project/plugins/acts_as_op_engine.rb).
+It offers methods to load patches and register assets besides others.
+
+#### Example
+```ruby
+module OpenProject::RepositoryAuthentication
+  class Engine < ::Rails::Engine
+    engine_name :openproject_repository_authentication
+
+    include OpenProject::Plugins::ActsAsOpEngine
+
+    register 'openproject-repository_authentication',
+             :author_url => 'http://finn.de',
+             :requires_openproject => '>= 3.0.0pre6'
+
+    patches [:SysController]
+  end
+end
+```
+
+## Get in Contact
+
+OpenProject is supported by its community members, both companies as well as individuals. There are different possibilities of getting help:
+* OpenProject [support page](https://www.openproject.org/projects/openproject/wiki/Support)
+* E-Mail Support - info@openproject.org
+
+## Start Collaborating
+
+Join the OpenProject community and start collaborating. We envision building a platform to share ideas, contributions, and discussions around OpenProject and project collaboration. Each commitment is noteworthy as it helps to improve the software and the project.
+More details will be added on the OpenProject Community [contribution page](https://www.openproject.org/projects/openproject/wiki/Contribution).
+
+In case you find a bug or need a feature, please report at https://www.openproject.org/projects/plugin-plugins/issues
+
+## License
+
+(c) 2013 - Finn GmbH
+
+This plugin is licensed under the GNU GPL v3. See doc/COPYRIGHT.md for details.

data/lib/generators/open_project/plugin/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Creates a new plugin with the given name in the specified directory
+
+Usage:
+    rails generate open_project:plugin NAME DIRECTORY
+
+Example:
+    rails generate open_project:plugin stuff ~/
+
+    This will create:
+        ~/openproject-stuff
+        ~/openproject-stuff/CHANGELOG.md
+        ~/openproject-stuff/openproject-stuff.gemspec
+        ~/openproject-stuff/lib
+        ~/openproject-stuff/lib/openproject-stuff.rb
+        ~/openproject-stuff/lib/open_project
+        ~/openproject-stuff/lib/open_project/stuff.rb
+        ~/openproject-stuff/lib/open_project/stuff
+        ~/openproject-stuff/lib/open_project/stuff/engine.rb

data/lib/generators/open_project/plugin/plugin_generator.rb

@@ -0,0 +1,55 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+class OpenProject::PluginGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :plugin_name, :type => :string, :default => "openproject-new-plugin"
+  argument :root_folder, :type => :string, :default => "vendor/gems"
+
+  # every public method is run when the generator is invoked
+  def generate_plugin
+    plugin_dir
+    lib_dir
+  end
+
+  def full_name
+    @full_name ||= begin
+      "openproject-#{plugin_name}"
+    end
+  end
+
+  private
+  def raise_on_params
+    puts plugin_name
+    puts root_folder
+  end
+
+  def plugin_path
+    "#{root_folder}/openproject-#{plugin_name}"
+  end
+
+  def plugin_dir
+    @plugin_dir ||= begin
+      directory('', plugin_path, :recursive => false)
+    end
+  end
+
+  def lib_path
+    "#{plugin_path}/lib"
+  end
+
+  def lib_dir
+    @lib_dir ||= begin
+      directory('lib', lib_path)
+    end
+  end
+end

data/lib/generators/open_project/plugin/templates/%full_name%.gemspec.tt

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'open_project/<%= plugin_name %>/version'
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "<%= full_name %>"
+  s.version     = OpenProject::<%= plugin_name.camelcase %>::VERSION
+  s.authors     = "Finn GmbH"
+  s.email       = "info@finn.de"
+  s.homepage    = "http://www.finn.de"
+  s.summary     = FIXME
+  s.description = FIXME
+  s.license     = FIXME # e.g. "MIT" or "GPLv3"
+
+  s.files = Dir["{app,config,db,lib}/**/*"] + %w(CHANGELOG.md README.md)
+
+  s.add_dependency "rails", "~> 3.2.14"
+end

data/lib/generators/open_project/plugin/templates/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+* `#<ticket number>` Create plugin

data/lib/generators/open_project/plugin/templates/README.md.tt

@@ -0,0 +1,7 @@
+# OpenProject <%= plugin_name.gsub('_',' ').titlecase %> Plugin
+
+FIXME Add description and check issue tracker link below
+
+## Issue Tracker
+
+https://www.openproject.org/projects/<%= plugin_name.gsub('_','-') %>/issues

data/lib/generators/open_project/plugin/templates/lib/%full_name%.rb.tt

@@ -0,0 +1 @@
+require 'open_project/<%= plugin_name %>'

data/lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%.rb.tt

@@ -0,0 +1,5 @@
+module OpenProject
+  module <%= plugin_name.camelcase %>
+    require "open_project/<%= plugin_name %>/engine"
+  end
+end

data/lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%/engine.rb.tt

@@ -0,0 +1,13 @@
+module OpenProject::<%= plugin_name.camelcase %>
+  class Engine < ::Rails::Engine
+    engine_name :openproject_<%= plugin_name %>
+
+    include OpenProject::Plugins::ActsAsOpEngine
+
+    register 'OpenProject <%= plugin_name.gsub('_', ' ').titleize %>',
+             '<%= full_name %>',
+             :author_url => 'http://finn.de',
+             :requires_openproject => '>= 3.0.0pre13'
+
+  end
+end

data/lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%/version.rb.tt

@@ -0,0 +1,5 @@
+module OpenProject
+  module <%= plugin_name.camelcase %>
+    VERSION = "0.0.1"
+  end
+end

data/lib/open_project/plugins.rb

@@ -0,0 +1,16 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+module OpenProject
+  module Plugins
+    require 'open_project/plugins/engine'
+  end
+end

data/lib/open_project/plugins/acts_as_op_engine.rb

@@ -0,0 +1,129 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+module OpenProject::Plugins
+  module ActsAsOpEngine
+
+    def self.included(base)
+      base.send(:define_method, :name) do
+        ActiveSupport::Inflector.demodulize(base).downcase
+      end
+
+      # Don't use the PatchRegistry for now, as the core classes doesn't notify of class loading
+      # Use the old config.to_prepare method, but we can hopefully someday switch to on-demand
+      # patching once the PatchRegistry works.
+
+      # base.send(:define_method, :patch) do |target, patch|
+      #   OpenProject::Plugins::PatchRegistry.register(target, patch)
+      # end
+
+      # Disable LoadDependency for the same reason
+      # base.send(:define_method, :load_dependent) do |target, *dependencies|
+      #   OpenProject::Plugins::LoadDependency.register(target, *dependencies)
+      # end
+
+      # Patch classes
+      #
+      # Looks for patches via autoloading in
+      # <plugin root>/lib/openproject/<plugin name>/patches/<patched_class>_patch.rb
+      # Make sure the patch module has the name the Rails autoloading expects.
+      #
+      # Example:
+      #  patches [:IssuesController]
+      # This looks for OpenProject::XlsExport::Patches::IssuesControllerPatch
+      #  in openproject/xls_export/patches/issues_controller_patch.rb
+      base.send(:define_method, :patches) do |patched_classes|
+        plugin_name = engine_name
+        base.config.to_prepare do
+          patched_classes.each do |klass_name|
+            plugin_module = plugin_name.sub(/^openproject_/, '').camelcase
+            patch = "OpenProject::#{plugin_module}::Patches::#{klass_name.to_s}Patch".constantize
+            klass = klass_name.to_s.constantize
+            klass.send(:include, patch) unless klass.included_modules.include?(patch)
+          end
+        end
+      end
+
+      # Define assets provided by the plugin
+      base.send(:define_method, :assets) do |assets|
+        base.initializer '#{engine_name}.precompile_assets' do |app|
+          app.config.assets.precompile += assets.to_a
+        end
+      end
+
+      # Register a plugin with OpenProject
+      #
+      # Uses Gem specification for plugin name, author etc.
+      #
+      # gem_name:      The gem name, used for querying the gem for metadata like author
+      # options:       An options Hash, at least :requires_openproject is recommended to
+      #                define the minimal version of OpenProject the plugin is compatible with
+      #                Another common option is :author_url.
+      base.send(:define_method, :register) do |gem_name, options|
+        base.initializer "#{engine_name}.register_plugin" do
+          spec = Bundler.environment.specs[gem_name][0]
+
+          Redmine::Plugin.register engine_name.to_sym do
+            name spec.summary
+            author spec.authors.kind_of?(Array) ? spec.authors[0] : spec.authors
+            description spec.description
+            version spec.version
+            url spec.homepage
+
+            options.each do |name, value|
+              send(name, value)
+            end
+          end
+        end
+
+        # Workaround to ensure settings are available after unloading in development mode
+        plugin_name = engine_name
+        if options.include? :settings
+          base.class_eval do
+            config.to_prepare do
+              Setting.create_setting("plugin_#{plugin_name}",
+                                     { 'serialized' => true }.merge(options[:settings]))
+              Setting.create_setting_accessors("plugin_#{plugin_name}")
+            end
+          end
+        end
+      end
+
+      base.class_eval do
+        config.autoload_paths += Dir["#{config.root}/lib/"]
+
+        config.before_configuration do |app|
+          # This is required for the routes to be loaded first
+          # as the routes should be prepended so they take precedence over the core.
+          app.config.paths['config/routes'].unshift File.join(config.root, "config", "routes.rb")
+        end
+
+        initializer "#{engine_name}.remove_duplicate_routes", :after => "add_routing_paths" do |app|
+          # removes duplicate entry from app.routes_reloader
+          # As we prepend the plugin's routes to the load_path up front and rails
+          # adds all engines' config/routes.rb later, we have double loaded the routes
+          # This is not harmful as such but leads to duplicate routes which decreases performance
+          app.routes_reloader.paths.uniq!
+        end
+
+        initializer "#{engine_name}.register_test_paths" do |app|
+          app.config.plugins_to_test_paths << self.root
+        end
+
+        # adds our factories to factory girl's load path
+        initializer "#{engine_name}.register_factories", :after => "factory_girl.set_factory_paths" do |app|
+          FactoryGirl.definition_file_paths << File.expand_path(self.root.to_s + '/spec/factories') if defined?(FactoryGirl)
+        end
+      end
+    end
+
+  end
+end

data/lib/open_project/plugins/engine.rb

@@ -0,0 +1,38 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+require 'rails/engine'
+
+module OpenProject::Plugins
+  class Engine < ::Rails::Engine
+
+    engine_name :openproject_plugins
+
+    require 'open_project/plugins/patch_registry'
+    require 'open_project/plugins/load_dependency'
+    require 'open_project/plugins/acts_as_op_engine'
+
+    config.after_initialize do
+      spec = Bundler.environment.specs['openproject-plugins'][0]
+
+      Redmine::Plugin.register :openproject_plugins do
+        name 'OpenProject Plugins'
+        author ((spec.authors.kind_of? Array) ? spec.authors[0] : spec.authors)
+        author_url spec.homepage
+        url 'https://www.openproject.org/projects/plugins'
+        description spec.description
+        version spec.version
+
+        requires_openproject ">= 3.0.0pre8"
+      end
+    end
+  end
+end

data/lib/open_project/plugins/load_dependency.rb

@@ -0,0 +1,24 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+module OpenProject::Plugins
+  module LoadDependency
+    def self.register(target, *dependencies)
+
+      ActiveSupport.on_load(target) do
+        dependencies.each do |dependency|
+          require_dependency dependency
+        end
+      end
+
+    end
+  end
+end

data/lib/open_project/plugins/patch_registry.rb

@@ -0,0 +1,33 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+module OpenProject::Plugins
+  module PatchRegistry
+    def self.register(target, patch)
+      #patches[target] << patch
+
+      ActiveSupport.on_load(target) do
+        require_dependency patch
+        constant = patch.camelcase.constantize
+
+        target.to_s.camelcase.constantize.send(:include, constant)
+      end
+    end
+
+    protected
+
+    def self.patches
+      @patches ||= Hash.new do |h, k|
+        h[k] = []
+      end
+    end
+  end
+end

data/lib/open_project/plugins/version.rb

@@ -0,0 +1,16 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+module OpenProject
+  module Plugins
+    VERSION = "1.0.2"
+  end
+end

data/lib/openproject-plugins.rb

@@ -0,0 +1,12 @@
+#-- copyright
+# OpenProject is a project management system.
+#
+# Copyright (C) 2012-2013 the OpenProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See doc/COPYRIGHT.md for more details.
+#++
+
+require 'open_project/plugins'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: openproject-plugins
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Finn GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 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.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: |2
+      This plugin aims to make writing plugins easier. It provides a generator for creating a
+      basic plugin structure and a module that simplifies setting up the plugin Rails engine.
+      Thus, it is also a dependency for many openproject plugins.
+email: info@finn.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/open_project/plugins.rb
+- lib/open_project/plugins/load_dependency.rb
+- lib/open_project/plugins/version.rb
+- lib/open_project/plugins/engine.rb
+- lib/open_project/plugins/patch_registry.rb
+- lib/open_project/plugins/acts_as_op_engine.rb
+- lib/openproject-plugins.rb
+- lib/generators/open_project/plugin/plugin_generator.rb
+- lib/generators/open_project/plugin/USAGE
+- lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%/engine.rb.tt
+- lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%/version.rb.tt
+- lib/generators/open_project/plugin/templates/lib/open_project/%plugin_name%.rb.tt
+- lib/generators/open_project/plugin/templates/lib/%full_name%.rb.tt
+- lib/generators/open_project/plugin/templates/%full_name%.gemspec.tt
+- lib/generators/open_project/plugin/templates/README.md.tt
+- lib/generators/open_project/plugin/templates/CHANGELOG.md
+- README.md
+homepage: http://www.finn.de
+licenses:
+- GPLv3
+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.1.0
+signing_key: 
+specification_version: 4
+summary: OpenProject Plugins Plugin
+test_files: []
+has_rdoc: