redmine_extensions 0.0.13 → 0.0.14

data/lib/generators/redmine_extensions/entity/templates/edit.html.erb.erb

@@ -0,0 +1,17 @@
+<%%= title l(:heading_<%= model_name_underscored %>_edit) %>
+
+<%%= form_for([@project, @<%= model_name_underscored %>], html: {multipart: <%= acts_as_attachable? %>, id: '<%= model_name_underscored %>_form', class: 'tabular'}) do |f| %>
+  <%%= error_messages_for @<%= model_name_underscored %> %>
+
+  <div class="box">
+    <%%= render partial: 'form', locals: {<%= model_name_underscored %>: @<%= model_name_underscored %>} %>
+  </div>
+
+  <p>
+    <%%= submit_tag l(:button_update), title: l(:button_update) %>
+  </p>
+<%% end %>
+<%% ### PAGE CUSTOMS ########################################################## %>
+<%% content_for :sidebar do %>
+  <%%= render :partial => '<%= model_name_pluralize_underscored %>/sidebar' %>
+<%% end %>

data/lib/generators/redmine_extensions/entity/templates/en.yml.erb

@@ -0,0 +1,10 @@
+en:
+  heading_<%= model_name_underscored %>_new: New <%= model_name_underscored.titleize %>
+  heading_<%= model_name_underscored %>_edit: Edit <%= model_name_underscored.titleize %>
+  button_<%= model_name_underscored %>_new: New <%= model_name_underscored.titleize %>
+  label_<%= model_name_pluralize_underscored %>: <%= model_name_pluralize_underscored.titleize %>
+  label_<%= model_name_underscored %>: <%= model_name_underscored.titleize %>
+  permission_view_<%= model_name_pluralize_underscored %>: View <%= model_name_pluralize_underscored.titleize %>
+  permission_manage_<%= model_name_pluralize_underscored %>: Manage <%= model_name_pluralize_underscored.titleize %>
+  title_<%= model_name_underscored %>_new: Click to create new <%= model_name_underscored.titleize %>
+<%= db_columns.collect{|column_name, _| "\n  #{column_options[:lang_key]}: #{column_name.humanize}"  }.join %>

data/lib/generators/redmine_extensions/entity/templates/helper.rb.erb

@@ -0,0 +1,24 @@
+module <%= controller_class %>Helper
+
+  def render_api_<%= model_name_underscored %>(api, <%= model_name_underscored %>)
+    api.<%= model_name_underscored %> do
+      api.id <%= model_name_underscored %>.id
+      <%- db_columns.keys.each do |column_name| -%>
+      api.<%= column_name %> <%= model_name_underscored %>.<%= column_name %>
+      <%- end -%>
+      <%- if acts_as_customizable? -%>
+      render_api_custom_values <%= model_name_underscored %>.visible_custom_field_values, api
+      <%- end -%>
+      <%- if acts_as_attachable? -%>
+      api.array :attachments do
+        <%= model_name_underscored %>.attachments.each do |attachment|
+          render_api_attachment(attachment, api)
+        end
+      end if include_in_api_response?('attachments')
+      <%- end -%>
+
+      call_hook(:helper_render_api_<%= model_name_underscored %>, {api: api, <%= model_name_underscored %>: <%= model_name_underscored %>})
+    end
+  end
+
+end

data/lib/generators/redmine_extensions/entity/templates/hooks.rb.erb

@@ -0,0 +1,7 @@
+module <%= plugin_title %>
+  class <%= model_name %>Hooks < Redmine::Hook::ViewListener
+
+    render_on :view_custom_fields_form_<%= model_name_underscored %>_custom_field, partial: 'custom_fields/view_custom_fields_form_<%= model_name_underscored %>_custom_field'
+
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/index.api.rsb.erb

@@ -0,0 +1,5 @@
+api.array :<%= model_name_pluralize_underscored %>, api_meta(total_count: @entity_count, offset: @offset, limit: @limit) do
+  @entities.each do |<%= model_name_underscored %>|
+    render_api_<%= model_name_underscored %>(api, <%= model_name_underscored %>)
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/index.html.erb.erb

@@ -0,0 +1,5 @@
+<%%= render @query %>
+<%% ### PAGE CUSTOMS ########################################################## %>
+<%% content_for :sidebar do %>
+  <%%= render :partial => '<%= model_name_pluralize_underscored %>/sidebar' %>
+<%% end %>

data/lib/generators/redmine_extensions/entity/templates/mail_added.html.erb.erb

@@ -0,0 +1 @@
+<h1><%%= link_to(@<%= model_name_underscored %>.to_s, @<%= model_name_underscored %>_url) %></h1>

data/lib/generators/redmine_extensions/entity/templates/mail_added.text.erb.erb

@@ -0,0 +1,2 @@
+<%%= @<%= model_name_underscored %>.to_s %>
+<%%= @<%= model_name_underscored %>_url %>

data/lib/generators/redmine_extensions/entity/templates/mail_updated.html.erb.erb

@@ -0,0 +1 @@
+<h1><%%= link_to(@<%= model_name_underscored %>.to_s, @<%= model_name_underscored %>_url) %></h1>

data/lib/generators/redmine_extensions/entity/templates/mail_updated.text.erb.erb

@@ -0,0 +1,2 @@
+<%%= @<%= model_name_underscored %>.to_s %>
+<%%= @<%= model_name_underscored %>_url %>

data/lib/generators/redmine_extensions/entity/templates/mailer.rb.erb

@@ -0,0 +1,41 @@
+class <%= model_name %>Mailer < Mailer
+
+  helper :<%= model_name_pluralize_underscored %>
+
+  def <%= model_name_underscored %>_added(<%= model_name_underscored %>)
+    <%- if project? -%>
+    redmine_headers 'Project' => <%= model_name_underscored %>.project.identifier
+
+    <%- end -%>
+    <%- if author? -%>
+    @author = <%= model_name_underscored %>.author
+    <%- end -%>
+    @<%= model_name_underscored %> = <%= model_name_underscored %>
+    @<%= model_name_underscored %>_url = url_for(controller: '<%= model_name_pluralize_underscored %>', action: 'show', id: <%= model_name_underscored %>)
+
+    message_id <%= model_name_underscored %>
+    references <%= model_name_underscored %>
+
+    mail to: <%= model_name_underscored %>.notified_users,
+      subject: "#{l(:label_<%= model_name_underscored %>)}: #{<%= model_name_underscored %>.to_s}"
+  end
+
+  def <%= model_name_underscored %>_updated(<%= model_name_underscored %>)
+    <%- if project? -%>
+    redmine_headers 'Project' => <%= model_name_underscored %>.project.identifier
+
+    <%- end -%>
+    <%- if author? -%>
+    @author = <%= model_name_underscored %>.author
+    <%- end -%>
+    @<%= model_name_underscored %> = <%= model_name_underscored %>
+    @<%= model_name_underscored %>_url = url_for(controller: '<%= model_name_pluralize_underscored %>', action: 'show', id: <%= model_name_underscored %>)
+
+    message_id <%= model_name_underscored %>
+    references <%= model_name_underscored %>
+
+    mail to: <%= model_name_underscored %>.notified_users,
+      subject: "#{l(:label_<%= model_name_underscored %>)}: #{<%= model_name_underscored %>.to_s}"
+  end
+
+end

data/lib/generators/redmine_extensions/entity/templates/migration.rb.erb

@@ -0,0 +1,9 @@
+class Create<%= model_name_pluralize_underscored.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= model_name_pluralize_underscored %>, force: true do |t|
+      <%- db_columns.each do |column_name, column_attrs| -%>
+      t.<%= column_attrs[:type] %> :<%= column_name %>, null: <%= column_attrs[:null] %>
+      <%- end -%>
+    end
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/model.rb.erb

@@ -0,0 +1,137 @@
+class <%= model_name %> < ActiveRecord::Base
+  include Redmine::SafeAttributes
+
+  <%= 'belongs_to :project' if project? %>
+  <%= 'belongs_to :author, class_name: \'User\', foreign_key: \'author_id\'' if author? %>
+
+  scope :visible, lambda { |*args|
+    where(<%= model_name %>.visible_condition(args.shift || User.current, *args))<%= '.joins(:project)' if project? %>
+  }
+  <% if name_column? %>
+  scope :sorted, lambda { order("#{table_name}.<%= name_column %> ASC") }
+  <% end %>
+
+  <% if acts_as_searchable? %>
+  acts_as_searchable columns: [<%= string_columns.collect{|c, _| "\"\#{#{model_name}.table_name}.#{c}\"" }.join(', ') %>],
+                     date_column: :created_at
+  <%- end -%>
+  <%- if acts_as_customizable? -%>
+  acts_as_customizable
+  <%- end -%>
+  <%- if acts_as_attachable? -%>
+  acts_as_attachable
+  <%- end -%>
+  <%- if acts_as_event? -%>
+  acts_as_event title: ->(o){"#{l(:label_<%= model_name_underscored %>)} - #{o.to_s}"},
+    url: ->(o){{controller: '<%= model_name_pluralize_underscored %>', action: 'show', id: o, project_id: o.project}},
+    datetime: :created_at, description: :<%= description_column || name_column %>
+  <%- end -%>
+  <%- if acts_as_activity_provider? -%>
+  acts_as_activity_provider author_key: <%= author? ? ':author_id' : 'nil' %>, timestamp: "#{table_name}.created_at"
+  <%- end -%>
+  <%- if acts_as_watchable? -%>
+  acts_as_watchable
+  <%- end -%>
+
+  <%= 'validates :project_id, :presence => true' if project? %>
+  <%= 'validates :author_id, :presence => true' if author? %>
+
+  attr_protected :id
+
+  <%- if safe_columns.any? -%>
+  safe_attributes <%= safe_columns.collect{|column_name, _| "'#{column_name}'"}.join(', ') %>
+  <%- end -%>
+  <%- if acts_as_customizable? -%>
+  safe_attributes 'custom_field_values', 'custom_fields'
+  <%- end -%>
+  <%- if project? -%>
+  safe_attributes 'project_id', :if => lambda {|<%= model_name_underscored %>, user| <%= model_name_underscored %>.new_record? }
+  <%- end -%>
+
+  <%- if mail? -%>
+  after_create :send_create_notification
+  after_update :send_update_notification
+  <%- end -%>
+
+  def self.visible_condition(user, options={})
+  <%- if project? -%>
+    Project.allowed_to_condition(user, :<%= view_permission %>, options)
+  <%- else -%>
+    '1=1'
+  <%- end -%>
+  end
+
+  def self.css_icon
+    'icon icon-user'
+  end
+
+  <%- if !project? -%>
+  def project
+    nil
+  end
+  <%- end -%>
+
+  def visible?(user = nil)
+    user ||= User.current
+    user.allowed_to?(:<%= view_permission %>, self.project, global: true)
+  end
+
+  def editable?(user = nil)
+    user ||= User.current
+    user.allowed_to?(:<%= edit_permission %>, self.project, global: true)
+  end
+
+  def deletable?(user = nil)
+    user ||= User.current
+    user.allowed_to?(:<%= delete_permission %>, self.project, global: true)
+  end
+
+  def attachments_visible?(user = nil)
+    visible?(user)
+  end
+
+  def attachments_editable?(user = nil)
+    editable?(user)
+  end
+
+  def attachments_deletable?(user = nil)
+    deletable?(user)
+  end
+
+  <%- if name_column? -%>
+  def to_s
+    <%= name_column %>.to_s
+  end
+  <%- end -%>
+
+  def created_on
+    created_at
+  end
+
+  def updated_on
+    updated_at
+  end
+
+  <%- if mail? -%>
+  def notified_users
+    if project
+      project.notified_users.reject {|user| !visible?(user)}
+    else
+      [User.current]
+    end
+  end
+
+  def send_create_notification
+    # if Setting.notified_events.include?('<%= model_name_underscored %>_added')
+    <%= model_name %>Mailer.<%= model_name_underscored %>_added(self).deliver
+    # end
+  end
+
+  def send_update_notification
+    # if Setting.notified_events.include?('<%= model_name_underscored %>_updated')
+    <%= model_name %>Mailer.<%= model_name_underscored %>_updated(self).deliver
+    # end
+  end
+  <%- end -%>
+
+end

data/lib/generators/redmine_extensions/entity/templates/new.html.erb.erb

@@ -0,0 +1,17 @@
+<%%= title l(:heading_<%= model_name_underscored %>_new) %>
+
+<%%= form_for([@project, @<%= model_name_underscored %>], html: {multipart: <%= acts_as_attachable? %>, id: '<%= model_name_underscored %>_form', class: 'tabular'}) do |f| %>
+  <%%= error_messages_for @<%= model_name_underscored %> %>
+
+  <div class="box">
+    <%%= render partial: 'form', locals: {<%= model_name_underscored %>: @<%= model_name_underscored %>} %>
+  </div>
+
+  <p>
+    <%%= submit_tag l(:button_create), title: l(:button_create) %>
+  </p>
+<%% end %>
+<%% ### PAGE CUSTOMS ########################################################## %>
+<%% content_for :sidebar do %>
+  <%%= render :partial => '<%= model_name_pluralize_underscored %>/sidebar' %>
+<%% end %>

data/lib/generators/redmine_extensions/entity/templates/query.rb.erb

@@ -0,0 +1,41 @@
+class <%= model_name %>Query < EasyQuery
+
+  self.queried_class = <%= model_name %>
+
+  def entity
+    <%= model_name %>
+  end
+
+  def initialize_available_filters
+    <%- db_columns.each do |column_name, column_options| -%>
+    <%- if project? && column_name == 'project_id' -%>
+    if project.nil?
+      add_available_filter '<%= column_name %>', name: <%= model_name %>.human_attribute_name(:<%= column_name %>), type: :<%= column_options[:query_type] %>, values: all_projects_values
+    end
+    <%- else -%>
+    add_available_filter '<%= column_name %>', name: <%= model_name %>.human_attribute_name(:<%= column_name %>), type: :<%= column_options[:query_type] -%>
+    <%- end -%>
+    <%- end -%>
+    <%- if acts_as_customizable? -%>
+    add_custom_fields_filters(<%= model_name %>CustomField)
+    <%- end -%>
+  end
+
+  def available_columns
+    return @available_columns if @available_columns
+
+    <%- db_columns.each do |column_name, column_options| -%>
+    add_available_column '<%= column_options[:query_column_name] || column_name %>', caption: <%= model_name %>.human_attribute_name(:<%= column_name %>)
+      <%- end -%>
+    <%- if acts_as_customizable? -%>
+    @available_columns += <%= model_name %>CustomField.visible.collect {|cf| QueryCustomFieldColumn.new(cf) }
+    <%- end -%>
+
+    @available_columns
+  end
+
+  def default_list_columns
+    super.presence || <%= db_columns.collect{|column_name, column_options| (column_options[:query_column_name] || column_name).to_sym}[0..3].to_s %>.flat_map{|c| [c.to_s, c.to_sym]}
+  end
+
+end

data/lib/generators/redmine_extensions/entity/templates/routes.rb.erb

@@ -0,0 +1,12 @@
+<% if project? %>
+resources :projects do
+  resources :<%= model_name_pluralize_underscored %>
+end
+<% end %>
+resources :<%= model_name_pluralize_underscored %> do
+  collection do
+    get 'bulk_edit'
+    post 'bulk_update'
+    get 'context_menu'
+  end
+end

data/lib/generators/redmine_extensions/entity/templates/show.api.rsb.erb

@@ -0,0 +1 @@
+render_api_<%= model_name_underscored %>(api, @<%= model_name_underscored %>)

data/lib/generators/redmine_extensions/entity/templates/show.html.erb.erb

@@ -0,0 +1,38 @@
+<%%= title @<%= model_name_underscored %> %>
+<div class="issue">
+  <table class="attributes">
+    <%%= issue_fields_rows do |rows| %>
+<%- safe_columns.each_with_index do |column, idx| -%>
+<%- next if description_column? && column[0] == description_column -%>
+<%- if idx % 2 == 0 -%>
+      <%% rows.left <%= model_name %>.human_attribute_name(:<%= column[0] %>), format_object(@<%= model_name_underscored %>.<%= column[0] %>) %>
+<%- else -%>
+      <%% rows.right <%= model_name %>.human_attribute_name(:<%= column[0] %>), format_object(@<%= model_name_underscored %>.<%= column[0] %>) %>
+<%- end -%>
+<%- end -%>
+    <%% end %>
+    <%%= render_custom_fields_rows(@<%= model_name_underscored %>) %>
+    <%%= call_hook(:view_<%= model_name_pluralize_underscored %>_show_details_bottom, :<%= model_name_underscored %> => @<%= model_name_underscored %>) %>
+  </table>
+<%- if description_column? -%>
+  <%% if !@<%= model_name_underscored %>.<%= description_column %>.blank? %>
+    <hr />
+    <div class="description">
+      <p><strong><%%= <%= model_name %>.human_attribute_name(:<%= description_column %>) %></strong></p>
+      <div class="wiki">
+        <%%= textilizable @<%= model_name_underscored %>, :<%= description_column %>, attachments: @<%= model_name_underscored %>.attachments %>
+      </div>
+    </div>
+  <%% end %>
+<%- end -%>
+<%- if acts_as_attachable? -%>
+  <%% if @<%= model_name_underscored %>.attachments.any? -%>
+    <hr />
+    <%%= link_to_attachments @<%= model_name_underscored %>, :thumbnails => true %>
+  <%% end %>
+<%- end -%>
+</div>
+<%% ### PAGE CUSTOMS ########################################################## %>
+<%% content_for :sidebar do %>
+  <%%= render :partial => '<%= model_name_pluralize_underscored %>/sidebar' %>
+<%% end %>

data/lib/generators/redmine_extensions/plugin/USAGE

@@ -0,0 +1,11 @@
+Description:
+    The plugin generator creates stubs for a new Redmine plugin.
+    Plugin is prepared for use in Redmine and Easy Redmine as well.
+
+Example:
+    rails g redmine_extensions:plugin NameOfNewPlugin
+      create  plugins/name_of_new_plugin/app/controllers
+      ...
+
+Help:
+     rails g redmine_extensions:plugin --help

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

@@ -0,0 +1,57 @@
+module RedmineExtensions
+  class PluginGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    attr_reader :plugin_path, :plugin_name_underscored, :plugin_pretty_name, :plugin_title
+
+    def initialize(*args)
+      super
+      @plugin_name_underscored = file_name.underscore
+      @plugin_pretty_name = plugin_name_underscored.titleize
+      @plugin_path = "plugins/#{plugin_name_underscored}"
+      @plugin_title = @plugin_name_underscored.camelize
+    end
+
+    def copy_templates
+      empty_directory "#{plugin_path}/app"
+      empty_directory "#{plugin_path}/app/controllers"
+      empty_directory "#{plugin_path}/app/helpers"
+      empty_directory "#{plugin_path}/app/models"
+      empty_directory "#{plugin_path}/app/views"
+      empty_directory "#{plugin_path}/db/migrate"
+      empty_directory "#{plugin_path}/db/data"
+      empty_directory "#{plugin_path}/assets/images"
+      empty_directory "#{plugin_path}/assets/javascripts"
+      empty_directory "#{plugin_path}/assets/stylesheets"
+      empty_directory "#{plugin_path}/config/locales"
+      empty_directory "#{plugin_path}/lib/#{plugin_name_underscored}"
+
+      empty_directory "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/controllers"
+      empty_directory "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/helpers"
+      empty_directory "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/models"
+      empty_directory "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/others"
+
+      template '.gitkeep', "#{plugin_path}/app/controllers/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/app/helpers/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/app/models/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/app/views/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/db/migrate/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/assets/images/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/assets/javascripts/.gitkeep"
+      template '.gitkeep', "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/others/.gitkeep"
+
+      #template 'Gemfile', "#{plugin_path}/Gemfile"
+      template 'init.rb.erb', "#{plugin_path}/init.rb"
+      template 'en.yml', "#{plugin_path}/config/locales/en.yml"
+      template 'routes.rb.erb', "#{plugin_path}/config/routes.rb"
+      template 'hooks.rb.erb', "#{plugin_path}/lib/#{plugin_name_underscored}/hooks.rb"
+      template 'internals.rb.erb', "#{plugin_path}/lib/#{plugin_name_underscored}/internals.rb"
+      template 'issue_patch.example.erb', "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/models/issue_patch.example"
+      template 'issues_controller_patch.example.erb', "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/controllers/issues_controller_patch.example"
+      template 'issues_helper_patch.example.erb', "#{plugin_path}/lib/#{plugin_name_underscored}/redmine_patch/helpers/issues_helper_patch.example"
+    end
+
+    hook_for :entity, as: :entity, in: :redmine_extensions, type: :boolean
+
+  end
+end

data/lib/generators/redmine_extensions/plugin/templates/Gemfile

@@ -0,0 +1 @@
+gem 'redmine_extensions', '~> 0.0.12'

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

@@ -0,0 +1,2 @@
+en:
+  label: Hello

data/lib/generators/{easy_redmine_plugin → redmine_extensions/plugin}/templates/init.rb.erb

@@ -1,9 +1,9 @@
 Redmine::Plugin.register :<%= plugin_name_underscored %> do
-  name :<%= plugin_name_underscored %>_plugin_name
-  author :<%= plugin_name_underscored %>_plugin_author
-  author_url :<%= plugin_name_underscored %>_plugin_author_url
-  description :<%= plugin_name_underscored %>_plugin_description
-  version '2014'
+  name '<%= plugin_pretty_name %>'
+  author ''
+  author_url ''
+  description ''
+  version '<%= Date.today.strftime('%Y.01.01') %>'
 
   #into easy_settings goes available setting as a symbol key, default value as a value
   settings easy_settings: {  }
@@ -12,10 +12,10 @@ end
 
 Dir[File.dirname(__FILE__) + '/lib/<%= plugin_name_underscored %>/redmine_patch/*/*.rb'].each {|file| require file }
 
-# this block is runed once just after easyproject is started
-# means after all plugins(easy) are initialized
+# this block is executed once just after Redmine is started
+# means after all plugins are initialized
 # it is place for plain requires, not require_dependency
-# it should contain hooks, permissions - base class in redmine is required thus is not reloaded
+# it should contain hooks, permissions - base class in Redmine is required thus is not reloaded
 ActiveSupport.on_load(:easyproject, yield: true) do
 
   require '<%= plugin_name_underscored %>/internals'
@@ -29,6 +29,6 @@ end
 # in this block should be used require_dependency, but only if necessary.
 # better is to place a class in file named by rails naming convency and let it be loaded automatically
 # Here goes query registering, custom fields registering and so on
-# ActionDispatch::Reloader.to_prepare do
-#
-# end
+ActionDispatch::Reloader.to_prepare do
+
+end

data/lib/generators/redmine_extensions/plugin/templates/internals.rb.erb

@@ -0,0 +1,4 @@
+# Use this module for static methods
+module <%= plugin_title %>
+
+end

data/lib/redmine_extensions/easy_entity_formatters/easy_entity_formatter.rb

@@ -0,0 +1,27 @@
+class EasyEntityFormatter
+
+  def initialize(view_context)
+    @view_context = view_context
+  end
+
+  def view
+    @view_context
+  end
+
+  def l(*args)
+    view.l(*args)
+  end
+
+  def format_column(column, entity)
+    format_object column.value_object(entity)
+  end
+
+  def format_object(value)
+    view.format_object(value)
+  end
+
+  def ending_buttons?
+    false
+  end
+
+end