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
Redmine Plugin Extension and Development
Copyright © 2014 Packt Publishing
All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.
Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.
Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.
First published: March 2014
Production Reference: 1120314
Published by Packt Publishing Ltd.
Livery Place
35 Livery Street
Birmingham B3 2PB, UK.
ISBN 978-1-78328-874-8
www.packtpub.com
Author
Alex Bevilacqua
Reviewers
Shamasis Bhattacharya
Petr PospĂĆĄil
Kevin Vicrey
Mischa The Evil
Acquisition Editors
Akram Hussain
Neha Nagwekar
Content Development Editor
Larissa Pinto
Technical Editors
Aman Preet Singh
Nachiket Vartak
Copy Editors
Alisha Aranha
Brandt D'Mello
Adithi Shetty
Project Coordinator
Jomin Varghese
Proofreader
Maria Gould
Graphics
Ronak Dhruv
Indexer
Monica Ajmera Mehta
Production Coordinator
Alwin Roy
Cover Work
Alwin Roy
Alex Bevilacqua is an advocate for open standards, as well as a passionate and enthusiastic open source developer with over 10 years of experience. He is skilled in Ruby, Python, C#, Flash, Flex, JavaScript, and others.
He is the author of a number of Redmine extensions and plugins; two of the most popular being the Redmine Knowledgebase and the Redmine Dropbox Attachments plugin.
He currently works for a leading digital marketing company in Toronto where he works on process automation, data collection, and aggregation initiatives. His personal blog can be found at http://www.alexbevi.com.
Shamasis Bhattacharya has been a part of FusionCharts since 2008. As a JavaScript architect, he heads the JavaScript development team and spends most of his time a...