redmine-generators 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Greg Thornton
+
+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,112 @@
+# Redmine Generators
+
+[![Build Status](https://travis-ci.org/xdissent/redmine-generators.png?branch=master)](https://travis-ci.org/xdissent/redmine-generators)
+[![Gem Version](https://badge.fury.io/rb/redmine-generators.png)](http://badge.fury.io/rb/redmine-generators)
+
+Helpful generators for [Redmine](http://redmine.org) plugin authors.
+
+## Crash Course
+
+Recreate the [Redmine plugin tutorial](http://www.redmine.org/projects/redmine/wiki/Plugin_Tutorial)
+using the `redmine:plugin` and `redmine:scaffold` generators:
+
+```console
+$ git clone https://github.com/redmine/redmine.git; cd redmine
+$ echo "development:\n  adapter: sqlite3\n  database: db/dev.db" > config/database.yml
+$ echo 'gem "redmine-generators", group: :development' >> Gemfile.local
+$ bundle --without rmagick   # Or whatever
+$ rails g redmine:plugin polls
+$ rails g redmine:scaffold polls poll question yes:integer no:integer
+$ rake generate_secret_token db:migrate redmine:plugins:migrate
+$ REDMINE_LANG=en rake redmine:load_default_data
+```
+
+Add a `vote` method to the `Poll` model in `plugins/redmine_polls/app/models/poll.rb`:
+
+```ruby
+def vote(answer)
+  increment(answer == "yes" ? :yes : :no)
+end
+```
+
+Create a `vote` action for the `PollsController` in `plugins/redmine_polls/app/controllers/polls_controller.rb`:
+
+```ruby
+def vote
+  @poll.vote params[:answer]
+  flash[:notice] = "Voted #{params[:answer]}" if @poll.save && !request.xhr?
+  respond_with(@poll) do |format|
+    format.js { render action: :show }
+  end
+end
+```
+
+Create a member route in `plugins/redmine_polls/config/routes.rb` for the new
+`vote` action:
+
+```ruby
+scope "/projects/:project_id" do
+  resources :polls do
+    post "vote", on: :member
+  end
+end
+```
+
+Add the `vote` method to the `respond_to :js` and `before_filter :find_poll`
+statements:
+
+```ruby
+respond_to :js, only: [:show, :new, :create, :edit, :update, :destroy, :vote]
+# ...
+before_filter :find_poll, only: [:show, :edit, :update, :destroy, :vote]
+```
+
+Add voting links to `plugins/redmine_polls/app/views/polls/show.html.erb`:
+
+```erb
+<p>
+  <b>Vote:</b>
+  <%= link_to "Yes", vote_poll_path(@poll, answer: "yes"), method: :post %> |
+  <%= link_to "No", vote_poll_path(@poll, answer: "no"), method: :post %>
+</p>
+```
+
+And basically the same for `plugins/redmine_polls/app/views/polls/show.js.erb` 
+but using `remote: true` for AJAX links:
+
+```erb
+<p>
+  <b>Vote:</b>
+  <%= link_to "Yes", vote_poll_path(@poll, answer: "yes"), method: :post, remote: true %> |
+  <%= link_to "No", vote_poll_path(@poll, answer: "no"), method: :post, remote: true %>
+</p>
+```
+
+Finally, add a `:vote_polls` Redmine permission to the `:polls` project module 
+in `plugins/redmine_polls/init.rb`:
+
+```ruby
+  project_module :polls do
+    # ...
+    permission :vote_polls, polls: [:vote]
+  end
+```
+
+Start the rails server if you haven't already with `rails s`. Grant voting 
+access to whichever roles you'd like at 
+[http://localhost:3000/roles/permissions](http://localhost:3000/roles/permissions),
+create a project with the `:polls` module enabled, and start polling!
+
+
+## Available Generators
+
+* `redmine:plugin`
+* `redmine:project_menu`
+* `redmine:project_module`
+* `redmine:resource_route`
+* `redmine:scaffold`
+* `redmine:scaffold_controller`
+* `redmine:translation`
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RedmineGenerators'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/redmine-generators.rb

@@ -0,0 +1,4 @@
+require "redmine/generators"
+
+module RedmineGenerators
+end

data/lib/redmine-generators/version.rb

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

data/lib/redmine/generators.rb

@@ -0,0 +1,12 @@
+require "rails/generators"
+require "redmine/generators/plugin_support"
+
+module Redmine
+  module Generators
+    class << self
+      attr_accessor :plugin
+    end
+
+    Rails::Generators.send :include, PluginSupport
+  end
+end

data/lib/redmine/generators/plugin_generator.rb

@@ -0,0 +1,88 @@
+require "redmine/generators/plugin_name_attribute"
+require "rails/generators/named_base"
+
+module Redmine
+  module Generators
+    class PluginGenerator < Rails::Generators::NamedBase
+
+      def create_root
+        empty_directory '.'
+      end
+
+      def init_rb
+        template "init.rb"
+      end
+
+      def config
+        empty_directory "config"
+      end
+
+      def routes
+        template "routes.rb", "config/routes.rb"
+      end
+
+      def locales
+        empty_directory "config/locales"
+      end
+
+      def translations
+        template "en.yml", "config/locales/en.yml"
+      end
+
+      def plugin_lib
+        empty_directory "lib"
+        empty_directory "lib/#{name}"
+        template "plugin.rb", "lib/#{name}.rb"
+        template "version.rb", "lib/#{name}/version.rb"
+      end
+
+      def app_folders
+        empty_directory "app"
+        empty_directory_with_gitkeep "app/models"
+        empty_directory_with_gitkeep "app/controllers"
+        empty_directory_with_gitkeep "app/helpers"
+        empty_directory_with_gitkeep "app/views"
+      end
+
+      def gemfile
+        template "Gemfile"
+      end
+
+      def initialize(args = [], options = {}, config = {})
+        args[0] = ideal_plugin_name(args[0]) if config[:behavior] == :invoke
+        super args, options, config
+        if ideal_plugin_path.exist? && behavior == :invoke
+          raise "Plugin #{name} already exists." 
+        end
+        self.destination_root = ideal_plugin_path
+      end
+
+      protected
+      def ideal_plugin_name(pname = name)
+        "redmine_" + pname.gsub(/^(redmine|chiliproject)_/, "")
+      end
+
+      def ideal_plugin_path
+        Rails.root.join "plugins", ideal_plugin_name
+      end
+
+      def redmine_version
+        require "redmine/version"
+        "#{Redmine::VERSION::MAJOR}.#{Redmine::VERSION::MINOR}.#{Redmine::VERSION::TINY}"
+      end
+
+      def user_name
+        `git config --global --get user.name`.strip
+      end
+
+      def empty_directory_with_gitkeep(destination, config = {})
+        empty_directory(destination, config)
+        git_keep(destination)
+      end
+
+      def git_keep(destination)
+        create_file("#{destination}/.gitkeep")
+      end
+    end
+  end
+end

data/lib/redmine/generators/plugin_name_attribute.rb

@@ -0,0 +1,42 @@
+require "active_support/concern"
+
+module Redmine
+  module Generators
+    module PluginNameAttribute
+      extend ActiveSupport::Concern
+
+      def initialize(args = [], options = {}, config = {})
+        self.plugin_name = args.shift unless plugin_name
+        plugin_destination = plugin_destination_root
+        raise "Invalid plugin name #{plugin_name}" if bail_on_missing? && !plugin_destination
+        super
+        self.destination_root = plugin_destination
+      end
+
+      protected
+      def bail_on_missing?
+        true
+      end
+
+      def plugin_name=(name)
+        Redmine::Generators.plugin = name
+      end
+
+      def plugin_name
+        Redmine::Generators.plugin
+      end
+
+      def possible_plugin_names
+        %W(#{plugin_name} redmine_#{plugin_name} chiliproject_#{plugin_name})
+      end
+
+      def plugin_destination_root
+        possible_plugin_paths.find { |p| p.exist? }
+      end
+
+      def possible_plugin_paths
+        possible_plugin_names.map { |p| Rails.root.join "plugins", p }
+      end
+    end
+  end
+end

data/lib/redmine/generators/plugin_support.rb

@@ -0,0 +1,32 @@
+require "active_support/concern"
+
+module Redmine
+  module Generators
+    module PluginSupport
+      extend ActiveSupport::Concern
+
+      included do
+        templates_path << File.expand_path("../templates", __FILE__)
+        
+        class << self
+          def lookup_with_redmine(namespaces)
+            redmine_names = namespaces.select { |ns| ns.start_with? "redmine:" }
+            redmine_names.each do |ns|
+              require "redmine/generators/#{ns.split(":").last}_generator"
+            end
+            lookup_without_redmine (namespaces - redmine_names)
+          end
+          alias_method_chain :lookup, :redmine
+
+          def lookup_with_redmine!
+            Dir[File.expand_path("../*_generator.rb", __FILE__)].each do |path|
+              require File.join("redmine/generators", File.basename(path, ".rb"))
+            end
+            lookup_without_redmine!
+          end
+          alias_method_chain :lookup!, :redmine
+        end
+      end
+    end
+  end
+end

data/lib/redmine/generators/project_menu_generator.rb

@@ -0,0 +1,21 @@
+require "redmine/generators/plugin_name_attribute"
+Rails::Generators.lookup %w(rails:model)
+
+module Redmine
+  module Generators
+    class ProjectMenuGenerator < Rails::Generators::ModelGenerator
+      include PluginNameAttribute
+      
+      remove_hook_for :orm
+
+      def add_project_menu
+        menu = %(  menu :project_menu, :#{plural_table_name}, {controller: "#{plural_table_name}", action: "index" }, caption: :label_#{singular_table_name}_plural, param: :project_id\n)
+        sentinel = /Redmine::Plugin\.register\s+:\w+\s+do\s?\n/
+
+        in_root do
+          inject_into_file "init.rb", menu, after: sentinel
+        end
+      end
+    end
+  end
+end

data/lib/redmine/generators/project_module_generator.rb

@@ -0,0 +1,25 @@
+require "redmine/generators/plugin_name_attribute"
+Rails::Generators.lookup %w(rails:model)
+
+module Redmine
+  module Generators
+    class ProjectModuleGenerator < Rails::Generators::ModelGenerator
+      include PluginNameAttribute
+      
+      remove_hook_for :orm
+
+      def add_project_module
+        pm = "  project_module :#{plural_table_name} do\n"
+        pm << "    permission :view_#{plural_table_name}, #{plural_table_name}: [:index, :show]\n"
+        pm << "    permission :manage_#{plural_table_name}, #{plural_table_name}: [:new, :create, :edit, :update, :destroy]\n"
+        pm << "  end\n"
+
+        sentinel = /Redmine::Plugin\.register\s+:\w+\s+do\s?\n/
+
+        in_root do
+          inject_into_file "init.rb", pm, after: sentinel
+        end
+      end
+    end
+  end
+end

data/lib/redmine/generators/remoteable_links.rb

@@ -0,0 +1,18 @@
+require "active_support/concern"
+
+module Redmine
+  module Generators
+    module RemoteableLinks
+      extend ActiveSupport::Concern
+
+      protected
+      def maybe_remote
+        ", " + key_value(:remote, "true") if remote_option
+      end
+
+      def remote_option
+        parent_options[:remote]
+      end
+    end
+  end
+end

data/lib/redmine/generators/resource_route_generator.rb

@@ -0,0 +1,19 @@
+require "redmine/generators/plugin_name_attribute"
+Rails::Generators.lookup %w(rails:resource_route)
+
+module Redmine
+  module Generators
+    class ResourceRouteGenerator < Rails::Generators::ResourceRouteGenerator
+      include PluginNameAttribute
+
+      class_option :project, type: :boolean, default: true, desc: "Add project model relation"
+
+      private
+      def route(*args)
+        return super unless options[:project]
+        indented = route_string.split("\n").map { |l| "  #{l}" }.compact.join "\n"
+        super %(scope "/projects/:project_id" do\n#{indented}\n  end)
+      end
+    end
+  end
+end