Redmine Plugin Extension and Development电子书

Redmine Plugin Extension and Development

Table of Contents

Redmine Plugin Extension and Development

Credits

About the Author

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers and more

Why Subscribe?

Free Access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Downloading the example code

Errata

Piracy

Questions

1. Introduction to Redmine Plugins

An introduction to our sample plugin

Generating a new plugin

Using custom gemsets in our plugin

Generating models and controllers

Diving into the initialization file

Plugin attributes

Initialization checks

Checking for a specific Redmine version

Ensuring the existence of other plugins

Extending core Redmine features

Working with Redmine menus

Initializing named permissions

Project module availability

Adding custom events to the activity stream

Registering custom text formatting macros

Summary

2. Extending Redmine Using Hooks

Understanding hooks

View hooks

Controller hooks

Model hooks

Helper hooks

A sample view hook implementation

Identifying the callback

Integrating the hook

Creating the view partial

Summary

3. Permissions and Security

Summarizing Redmine's permission system

Declaring custom permissions

Ensuring access restrictions in models, views, and controllers

Understanding custom content access control

Managing user whitelists

Restricting access via whitelists

Enforcing the whitelist

Summary

4. Attaching Files to Models

Model preparation

Enabling attachments in our views

Controller modifications to accommodate attachments

Listing and managing attachments

Managing attachment permissions

Summary

5. Making Models Searchable

Registering our plugin

Preparing our models to be searched

Configuring search options

Filtering search results using custom permissions

Including article content in the search

Summary

6. Interacting with the Activity Stream

Overview of the activity stream

Preparing our model

Registering our model

Configuring an activity provider

Customizing activity entries

Summary

7. Managing Plugin Settings

An overview of Redmine's global plugin settings

Enabling settings management

Configuration management

Exposing plugin methods to the settings partial

Accessing our settings

Summary

8. Testing Your Plugin

Testing infrastructure layout

Basics of test fixtures

Working around a Redmine testing issue

Running tests

Writing functional tests

Writing integration tests

Writing unit tests

Preparing a test database

Continuous integration with Travis

Summary

A. Releasing Your Plugin

Managing your plugin's source code

Starting a blog

Publishing your plugin on redmine.org

Announcing your plugin on redmine.org

Summary

Index