redmine-generators 0.0.1

data/lib/redmine/generators/scaffold_controller_generator.rb

@@ -0,0 +1,39 @@
+require "redmine/generators/plugin_name_attribute"
+require "redmine/generators/sortable_headers"
+require "redmine/generators/remoteable_links"
+require "rails/generators/erb/scaffold/scaffold_generator"
+Rails::Generators.lookup %w(rails:scaffold_controller)
+
+module Redmine
+  module Generators
+    class ScaffoldControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+      include PluginNameAttribute
+
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+      class_option :author, type: :boolean, default: true, desc: "Add author User relation"
+      class_option :project, type: :boolean, default: true, desc: "Add project model relation"
+      class_option :authorize, type: :boolean, default: true, desc: "Add permissions"
+      class_option :pagination, type: :boolean, default: true, desc: "Add pagination"
+      class_option :sort, type: :boolean, default: true, desc: "Add sorting"
+      class_option :remote, type: :boolean, default: true, desc: "User javascript ajax views"
+
+      def initialize(*args)
+        super
+        Erb::Generators::ScaffoldGenerator.send :include, SortableHeaders
+        Erb::Generators::ScaffoldGenerator.send :include, RemoteableLinks
+      end
+
+      def self.base_name
+        "rails"
+      end
+
+      protected
+      def sort_initializer
+        unsortable = [:text, :references, :belongs_to]
+        sort_fields = attributes.map { |a| a.name unless unsortable.include? a.type }.compact
+        "sort_init \"updated_at\"\n    sort_update %w(#{sort_fields.join " "} created_at updated_at)"
+      end
+    end
+  end
+end

data/lib/redmine/generators/scaffold_generator.rb

@@ -0,0 +1,51 @@
+require "redmine/generators/plugin_name_attribute"
+require "redmine/generators/remoteable_links"
+Rails::Generators.lookup %w(rails:scaffold)
+
+module Redmine
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
+      include PluginNameAttribute
+      include RemoteableLinks
+
+      class_option :author, type: :boolean, default: true, desc: "Add author User relation"
+      class_option :project, type: :boolean, default: true, desc: "Add project model relation"
+      class_option :project_module, type: :boolean, default: true, desc: "Add a project module"
+      class_option :project_menu, type: :boolean, default: true, desc: "Add a project menu"
+      class_option :authorize, type: :boolean, default: true, desc: "Add permissions"
+      class_option :pagination, type: :boolean, default: true, desc: "Add pagination"
+      class_option :sort, type: :boolean, default: true, desc: "Add sorting"
+      class_option :translation, type: :boolean, default: true, desc: "Add translations"
+      class_option :remote, type: :boolean, default: true, desc: "User javascript ajax views"
+
+      remove_hook_for :assets
+      remove_hook_for :stylesheet_engine
+
+      hook_for :scaffold_controller, required: true
+      
+      hook_for :resource_route, required: true
+      hook_for :translation, required: true
+
+      hook_for :project_module, required: true
+      hook_for :project_menu, required: true
+
+      def add_js_views
+        template "_model.html.erb", "app/views/#{plural_table_name}/_#{singular_table_name}.html.erb"
+        return false unless options[:remote]
+        %w(_form show new create edit update destroy).each do |view|
+          view_file = "#{view}.js.erb"
+          template view_file, "app/views/#{plural_table_name}/#{view_file}"
+        end
+      end
+
+      protected
+      def remote_option
+        options[:remote]
+      end
+
+      def created_by
+        options[:author] ? "#{singular_table_name}.author" : "User.anonymous"
+      end
+    end
+  end
+end

data/lib/redmine/generators/sortable_headers.rb

@@ -0,0 +1,18 @@
+require "active_support/concern"
+
+module Redmine
+  module Generators
+    module SortableHeaders
+      extend ActiveSupport::Concern
+
+      def sortable_header(name, caption = "field_#{name}", order = nil)
+        if parent_options[:sort]
+          order = ", " + key_value(:default_order, %("#{order}")) if order
+          %(<%= sort_header_tag "#{name}", caption: l(:#{caption})#{order} %>)
+        else
+          "<th><%= l(:#{caption}) %></th>"
+        end
+      end
+    end
+  end
+end

data/lib/redmine/generators/templates/active_record/model/migration.rb

@@ -0,0 +1,27 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% if parent_options[:author] -%>
+      t.integer :author_id, <%= key_value :default, "0" %>, <%= key_value :null, "false" %>
+<% end -%>
+<% if parent_options[:project] -%>
+      t.integer :project_id, <%= key_value :default, "0" %>, <%= key_value :null, "false" %>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+<% if parent_options[:author] -%>
+    add_index :<%= table_name %>, :author_id
+<% end -%>
+<% if parent_options[:project] -%>
+    add_index :<%= table_name %>, :project_id
+<% end -%>
+  end
+end

data/lib/redmine/generators/templates/active_record/model/model.rb

@@ -0,0 +1,25 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+  unloadable
+
+<% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+<% if parent_options[:author] -%>
+  belongs_to :author, <%= key_value :class_name, '"User"' %>, <%= key_value :foreign_key, '"author_id"' %>
+<% end -%>
+<% if parent_options[:project] -%>
+  belongs_to :project
+<% end -%>
+<% if !accessible_attributes.empty? -%>
+  attr_accessible <%= accessible_attributes.map {|a| ":#{a.name}" }.sort.join(', ') %>
+<% else -%>
+  # attr_accessible :title, :body
+<% end -%>
+<% if parent_options[:project] || parent_options[:author] -%>
+
+  validates <%= [(":project" if parent_options[:project]), (":author" if parent_options[:author])].compact.join ", " %>, <%= key_value :presence, "true" %>
+
+<% end -%>
+end
+<% end -%>

data/lib/redmine/generators/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= labelled_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= error_messages_for "<%= singular_table_name %>" %>
+
+  <div class="box tabular">
+<% attributes.each do |attribute| -%>
+    <p><%%= f.<%= attribute.field_type %> :<%= attribute.name %> %></p>
+<% end -%>
+  </div>
+
+  <p class="buttons">
+    <%%= f.submit %>
+  </p>
+<%% end %>

data/lib/redmine/generators/templates/erb/scaffold/edit.html.erb

@@ -0,0 +1,6 @@
+<h2><%%= link_to l(:label_<%= singular_table_name %>_plural), <%= index_helper %>_path %>
+  &#187; <%%= l(:label_<%= singular_table_name %>_edit) %></h2>
+
+<%%= render "form" %>
+
+<%% html_title l(:label_<%= singular_table_name %>_edit) -%>

data/lib/redmine/generators/templates/erb/scaffold/index.html.erb

@@ -0,0 +1,33 @@
+<div class="contextual">
+  <%%= link_to l(:label_<%= singular_table_name %>_new), new_<%= singular_table_name %>_path, <%= key_value :class, '"icon icon-add"' %><%= maybe_remote %> %>
+</div>
+
+<h2><%%= l(:label_<%= singular_table_name %>_plural) %></h2>
+
+<%% if @<%= plural_table_name %>.empty? %>
+  <p class="nodata"><%%= l(:label_no_data) %></p>
+<%% end %>
+
+<div class="autoscroll">
+  <table class="list <%= plural_table_name %>" style="<%%= "display: none;" if @<%= plural_table_name %>.empty? %>">
+    <thead>
+      <tr>
+<% attributes.each do |attribute| -%>
+        <%= sortable_header attribute.name %>
+<% end -%>
+        <%= sortable_header "created_at", :field_created_on, "desc" %>
+        <%= sortable_header "updated_at", :field_updated_on, "desc" %>
+        <th></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%%= render @<%= plural_table_name %> %>
+    </tbody>
+  </table>
+</div>
+<% if parent_options[:pagination] -%>
+
+<p class="pagination"><%%= pagination_links_full @<%= singular_table_name %>_pages %></p>
+<% end -%>
+
+<%% html_title l(:label_<%= singular_table_name %>_plural) -%>

data/lib/redmine/generators/templates/erb/scaffold/new.html.erb

@@ -0,0 +1,6 @@
+<h2><%%= link_to l(:label_<%= singular_table_name %>_plural), <%= index_helper %>_path %>
+  &#187; <%%= l(:label_<%= singular_table_name %>_new) %></h2>
+
+<%%= render "form" %>
+
+<%% html_title l(:label_<%= singular_table_name %>_new) -%>

data/lib/redmine/generators/templates/erb/scaffold/show.html.erb

@@ -0,0 +1,17 @@
+<div class="contextual">
+  <%%= link_to l(:label_<%= singular_table_name %>_edit), edit_<%= singular_table_name %>_path(@<%= singular_table_name %>), <%= key_value :class, '"icon icon-edit"' %><%= maybe_remote %> %>
+</div>
+
+<h2><%%= link_to l(:label_<%= singular_table_name %>_plural), <%= index_helper %>_path %>
+  &#187; <%%= l(:label_<%= singular_table_name %>) %></h2>
+
+<div class="box">
+<% attributes.each do |attribute| -%>
+<p>
+  <b><%= attribute.human_name %>:</b>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+<% end -%>
+</div>
+
+<%% html_title l(:label_<%= singular_table_name %>) -%>

data/lib/redmine/generators/templates/rails/scaffold/_form.js.erb

@@ -0,0 +1,14 @@
+<%%= labelled_form_for(@<%= singular_table_name %><%= maybe_remote %>) do |f| %>
+  <%%= error_messages_for "<%= singular_table_name %>" %>
+
+  <div class="box tabular">
+<% attributes.each do |attribute| -%>
+    <p><%%= f.<%= attribute.field_type %> :<%= attribute.name %> %></p>
+<% end -%>
+  </div>
+
+  <p class="buttons">
+    <%%= f.submit %>
+    <%%= submit_tag l(:button_cancel), <%= key_value :onclick, '"hideModal(this);"' %>, <%= key_value :type, '"button"' %> %>
+  </p>
+<%% end %>

data/lib/redmine/generators/templates/rails/scaffold/_model.html.erb

@@ -0,0 +1,12 @@
+<tr id="<%%= dom_id <%= singular_table_name %> %>" class="<%%= cycle "odd", "even" %>">
+<% attributes.each do |attribute| -%>
+  <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+  <td><%%= authoring <%= singular_table_name %>.created_at, <%= created_by %> %>.</td>
+  <td><%%= l(:label_updated_time, time_tag(<%= singular_table_name %>.updated_at)).html_safe %>.</td>
+  <td class="buttons">
+    <%%= link_to l(:button_show), <%= singular_table_name %><%= maybe_remote %> %>
+    <%%= link_to l(:button_edit), edit_<%= singular_table_name %>_path(<%= singular_table_name %>), <%= key_value :class, '"icon icon-edit"' %><%= maybe_remote %> %>
+    <%%= link_to l(:button_delete), <%= singular_table_name %>, <%= key_value :method, ":delete" %>, <%= key_value :data, "{ #{key_value :confirm, "l(:text_are_you_sure)"} }" %>, <%= key_value :class, '"icon icon-del"' %><%= maybe_remote %> %>
+  </td>
+</tr>

data/lib/redmine/generators/templates/rails/scaffold/create.js.erb

@@ -0,0 +1,13 @@
+<%% if @<%= singular_table_name %>.valid? %>
+  hideModal();
+  if ($(".<%= plural_table_name %>.list").length) {
+    $(".nodata").hide();
+    $(".<%= plural_table_name %>").show();
+    $("<%%= j render(@<%= singular_table_name %>, formats: [:html]) %>").prependTo(".<%= plural_table_name %> tbody").effect("highlight");
+  } else {
+    window.location.href = "<%%= url_for @<%= singular_table_name %> %>";
+  }
+<%% else %>
+  $("#errorExplanation").remove();
+  $("<%%= j error_messages_for("<%= singular_table_name %>") %>").prependTo("#new_<%= singular_table_name %>");
+<%% end %>

data/lib/redmine/generators/templates/rails/scaffold/destroy.js.erb

@@ -0,0 +1 @@
+$("#<%%= dom_id @<%= singular_table_name %> %>").fadeOut();

data/lib/redmine/generators/templates/rails/scaffold/edit.js.erb

@@ -0,0 +1,7 @@
+<%% html = capture do %>
+  <h3 class="title"><%%= l(:label_<%= singular_table_name %>_edit) %></h3>
+  <%%= render partial: "form" %>
+<%% end %>
+
+$("#ajax-modal").html("<%%= j html %>").find(".box").css("z-index", "auto");
+showModal("ajax-modal", "600px");

data/lib/redmine/generators/templates/rails/scaffold/new.js.erb

@@ -0,0 +1,7 @@
+<%% html = capture do %>
+  <h3 class="title"><%%= l(:label_<%= singular_table_name %>_new) %></h3>
+  <%%= render partial: "form" %>
+<%% end %>
+
+$("#ajax-modal").html("<%%= j html %>").find(".box").css("z-index", "auto");
+showModal("ajax-modal", "600px");

data/lib/redmine/generators/templates/rails/scaffold/show.js.erb

@@ -0,0 +1,19 @@
+<%% html = capture do %>
+  <h3 class="title"><%%= l(:label_<%= singular_table_name %>) %></h3>
+
+  <div class="box">
+<% attributes.each do |attribute| -%>
+    <p>
+      <b><%= attribute.human_name %>:</b>
+      <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+    </p>
+<% end -%>
+  </div>
+
+  <p class="buttons">
+    <%%= submit_tag l(:button_cancel), <%= key_value :onclick, '"hideModal(this);"' %>, <%= key_value :type, '"button"' %> %>
+  </p>
+<%% end %>
+
+$("#ajax-modal").html("<%%= j html %>").find(".box").css("z-index", "auto");
+showModal("ajax-modal", "600px");

data/lib/redmine/generators/templates/rails/scaffold/update.js.erb

@@ -0,0 +1,12 @@
+<%% if @<%= singular_table_name %>.valid? %>
+  hideModal();
+  if ($(".<%= plural_table_name %>.list").length) {
+    $("#<%%= dom_id @<%= singular_table_name %> %>").replaceWith("<%%= j render(@<%= singular_table_name %>) %>");
+    $("#<%%= dom_id @<%= singular_table_name %> %>").effect("highlight");
+  } else {
+    window.location.href = "<%%= url_for @<%= singular_table_name %> %>";
+  }
+<%% else %>
+  $("#errorExplanation").remove();
+  $("<%%= j error_messages_for("<%= singular_table_name %>") %>").prependTo("#edit_<%= singular_table_name %>_<%%= @<%= singular_table_name %>.id %>");
+<%% end %>

data/lib/redmine/generators/templates/redmine/plugin/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+# Plugin-specific gems

data/lib/redmine/generators/templates/redmine/plugin/en.yml

@@ -0,0 +1,3 @@
+# English strings go here for Rails i18n
+en:
+  # my_label: "My label"

data/lib/redmine/generators/templates/redmine/plugin/init.rb

@@ -0,0 +1,13 @@
+require "<%= name %>"
+require "<%= name %>/version"
+
+Redmine::Plugin.register :<%= name %> do
+  name "<%= name.titleize %>"
+  author "<%= user_name %>"
+  description "<%= name.titleize %>"
+  version <%= class_name %>::VERSION
+  url ""
+  author_url ""
+  requires_redmine version_or_higher: "<%= redmine_version %>"
+  settings partial: "<%= name %>", default: {}
+end

data/lib/redmine/generators/templates/redmine/plugin/plugin.rb

@@ -0,0 +1,4 @@
+require "redmine"
+
+module <%= class_name %>
+end  

data/lib/redmine/generators/templates/redmine/plugin/routes.rb

@@ -0,0 +1,5 @@
+# Plugin's routes
+# See: http://guides.rubyonrails.org/routing.html
+RedmineApp::Application.routes.draw do
+
+end

data/lib/redmine/generators/templates/redmine/plugin/version.rb

@@ -0,0 +1,3 @@
+module <%= class_name %>
+  VERSION = "0.0.1"
+end

data/lib/redmine/generators/templates/redmine/scaffold_controller/controller.rb

@@ -0,0 +1,96 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  unloadable
+  
+  respond_to :html, :json
+<% if options[:remote] -%>
+  respond_to :js, only: [:show, :new, :create, :edit, :update, :destroy]
+<% end -%>
+
+<% if options[:project] -%>
+  before_filter :find_project_by_project_id
+<% end -%>
+  before_filter :find_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+<% if options[:authorize] -%>
+  before_filter :authorize
+<% end -%>
+<% if options[:sort] -%>
+
+  include SortHelper
+  helper :sort
+<% end -%>
+
+  def index
+<% if options[:sort] -%>
+    <%= sort_initializer %>
+<% end -%>
+<% if options[:project] -%>
+    <%= "@#{singular_table_name}_pages, " if options[:pagination] %>@<%= plural_table_name %> = <%= "paginate " if options[:pagination] %><%= "#{class_name}.where(project_id: @project)" %><%= ".order(sort_clause)" if options[:sort] %>
+<% else -%>
+    <%= "@#{singular_table_name}_pages, " if options[:pagination] %>@<%= plural_table_name %> = <%= "paginate " if options[:pagination] %><%= orm_class.all(class_name) %><%= ".order(sort_clause)" if options[:sort] %>
+<% end -%>
+    respond_with @<%= plural_table_name %>
+  end
+
+  def show
+    respond_with @<%= singular_table_name %>
+  end
+
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+    respond_with @<%= singular_table_name %>
+  end
+
+  def edit
+    respond_with @<%= singular_table_name %>
+  end
+
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "params[:#{singular_table_name}]") %>
+<% if options[:project] -%>
+    @<%= singular_table_name %>.project = @project
+<% end -%>
+<% if options[:author] -%>
+    @<%= singular_table_name %>.author = User.current
+<% end -%>
+    if @<%= singular_table_name %>.save && !request.xhr?
+      flash[:notice] = l(:label_<%= singular_table_name %>_created)
+    end
+    respond_with @<%= singular_table_name %>
+  end
+
+  def update
+    if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %> && !request.xhr?
+      flash[:notice] = l(:label_<%= singular_table_name %>_updated)
+    end
+    respond_with @<%= singular_table_name %>
+  end
+
+  def destroy
+    @<%= orm_instance.destroy %>
+    flash[:notice] = l(:label_<%= singular_table_name %>_deleted) unless request.xhr?
+    respond_with @<%= singular_table_name %>, location: <%= index_helper %>_path
+  end
+
+<% if options[:project] -%>
+  # Override url/path convenience methods options to include project
+  def url_options
+    super.reverse_merge project_id: @project
+  end
+<% end -%>
+
+  private
+  def find_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+<% if options[:project] -%>
+    render_404 unless @<%= singular_table_name %>.project_id == @project.id
+<% end -%>
+  rescue ActiveRecord::RecordNotFound
+    render_404
+  end
+end
+<% end -%>