redmine_extensions 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9dafb1894abe51656840de62914a350b3c9d78c
-  data.tar.gz: 6dcbff3717bfac6323606d4dffd6bb959ae5bf42
+  metadata.gz: 23ca96f77329db75217df08f43cdf52bbd7ed2e8
+  data.tar.gz: 16757b5cddacb84ec7d1bbe0637d034bfa8aeaaf
 SHA512:
-  metadata.gz: 491d56cfee43c1daed176f2f94551daf40d02fb4718d215fb37743e634a8b439dd53f6db1c18f0be6a654c584ca0b6ebea8027018669b80a4077bd57b1e15d69
-  data.tar.gz: 0f2b44330b8a107a674b06652acd5bc82f91354c60f58065ffec60e76d1a30903ae0d1552695b1f634f37cf379bef2e859d32517870f890b66423051cd11db37
+  metadata.gz: 1fcd410c0f9f7d0a095aff4547322f1681f7a940f25ccc0c46303f670c895386141a09c99d76198880c1fc00b02922b4d944eb25b7ce888520bf9798aeed466c
+  data.tar.gz: 4d0a6f90ea945c090d2be5a823814e402525ad1a4850b401f4bf365049bf48a0ccc988a1bd4ede7ac1dea47c9f380bb16da452689c3d589052ead86d18250733

data/Rakefile

@@ -37,7 +37,7 @@ task :generate_test_plugin do
   require RedmineExtensions::Engine.root.join('spec', 'support', 'plugin_generator').to_s
   PluginGenerator.generate_test_plugin!
 end
-RSpec::Core::RakeTask.new(spec: :generate_test_plugin) do |spec|
+RSpec::Core::RakeTask.new(spec: [:generate_test_plugin, 'app:redmine:plugins:migrate']) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.exclude_pattern = 'spec/redmine/**/*_spec.rb'
 end

data/app/helpers/redmine_extensions/application_helper.rb

@@ -205,7 +205,27 @@ module RedmineExtensions
 
     end
 
-
+    # Returns a multiselect autocomplete input tag tailored for selecting 1..N values from defined source by +jsonpath_or_array+.
+    # Preselected will be values in +selected_values+ parameter, or if those are empty, and +select_first_value+ option is set,
+    # it will select first value from source. See warning from this parameter!
+    # Additional options on the input tag can be passed as a hash with +options+.
+    # These options will be passed to the handling javascript.
+    # Available format for +selected_values+:
+    # * Array of values. It will search for the values in available_values for values names assigned.
+    # * Array of objects in format: {id: <value send in form>, value: <label - user shown value>}
+    # Available options are:
+    # * +multiple+ - tells if more than one value can be selected.
+    # * +preload+ - tells if values should be preloaded all at once - in one request - if jsonpathh is a source, this parameter expect it to return all available values.
+    # * +load_immediately+ - tells if values should be loaded immediatelly after page loaded, or wait for first use of the field.
+    #                       Warning! if this option is false, selected values passed in first format will be ignored till it is loaded.
+    #                         Please use second format for proper functionality.
+    # * +show_toggle_button+ - only valid with <tt>multiple: true, preload: true</tt> options set. Shows toggle button to expand select to the multiselect tag.
+    # * +select_first_value+ - if selectd_values are empty, with this option first available value will be selected.
+    #                          Available only with <tt>preload: true</tt> option.
+    #                          With <tt>load_immediately: false</tt> it will appear kinda weird for user because it will select the value after user starts to interact with input.
+    #                           please consider if this is what you want.
+    # * +rootElement+ - Has sence only if jsonpath is used for available values. It tells if the json response has values wrapped under root element.
+    #                     For response like <tt>{projects: [[<name>, <id>], [<name2>, <id2>]]}</tt> user option <tt>rootElement: 'projects'</tt>
     def autocomplete_field_tag(name, jsonpath_or_array, selected_values, options = {})
       options.reverse_merge!({select_first_value: false, show_toggle_button: false, load_immediately: false, preload: true, multiple: true})
       options[:id] ||= sanitize_to_id(name)
@@ -224,5 +244,29 @@ module RedmineExtensions
       end
     end
 
+    # Returns a multiselect autocomplete input tag tailored for accessing a specified attribute (identified by +method+) on an object
+    # assigned to the template (identified by +object+). Additional options on the input tag can be passed as a
+    # hash with +options+. These options will be passed to the handling javascript as in the example shown.
+    # Available values for select are passed as +choices+ attribute. It can be Array of values, or json path for later loading or autocomplete.
+    # Please see autocomplete_field_tag documentation for more information about options and available values format combinations.
+    # HTML options can be passed as a hash with +html_options+. These options will be passed to the input element.
+    #
+    # ==== Examples
+    #   autocomplete_field(:issue, :tag_ids, Tag.all.pluck(:name, :id), multiple: true, show_toggle_button: true)
+    #   # => <span class="easy-multiselect-tag-container"> \
+    #         <input type="text" id="issue_tags"  /> \
+    #         <button type="button" tabindex="-1" class="..." role="button" ...>
+    #           <span class="ui-button-icon-primary ui-icon ui-icon-triangle-1-s"></span><span class="ui-button-text">&nbsp;</span>
+    #         </button>
+    #         <a class="icon icon-add clear-link"></a> # toggle button to the multiselect tag from show_toggle_button option
+    #         ...(wraping service tags)
+    #           <input type="hidden" name="issue[tag_ids][]" value="#{@issue.tag_ids.first}" />
+    #           <input type="hidden" name="issue[tag_ids][]" value="#{@issue.tag_ids.second}" />
+    #         ...(wraping service tags end)
+    #        </span>
+    def autocomplete_field(object_name, method, choices, options={}, html_options={})
+      Tags::AutocompleteField.new(object_name, method, self, choices, options, html_options).render
+    end
+
   end
 end

data/lib/generators/redmine_extensions/entity/USAGE

@@ -1,6 +1,6 @@
 Description:
-    The plugin generator creates stubs for a new Redmine plugin.
-    Plugin is prepared for use in Redmine and Easy Redmine as well.
+    The entity generator creates new entity for Redmine plugin.
+    New entity is prepared for use in Redmine and Easy Redmine as well.
 
 Example:
     rails g redmine_extensions:entity NameOfNewPlugin Post

data/lib/generators/redmine_extensions/entity/entity_generator.rb

@@ -49,6 +49,9 @@ module RedmineExtensions
       template 'edit.html.erb.erb', "#{plugin_path}/app/views/#{model_name_pluralize_underscored}/edit.html.erb"
       template 'edit.js.erb.erb', "#{plugin_path}/app/views/#{model_name_pluralize_underscored}/edit.js.erb"
 
+      template 'controller_spec.rb.erb', "#{plugin_path}/test/spec/controllers/#{model_name_pluralize_underscored}_controller_spec.rb"
+      template 'factories.rb.erb', "#{plugin_path}/test/factories/#{model_name_underscored}.rb"
+
       if File.exists?("#{plugin_path}/config/locales/en.yml")
         original_langfile = YAML.load_file("#{plugin_path}/config/locales/en.yml")
 

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

@@ -15,7 +15,7 @@
     </ul>
   </li>
   <%% end %>
-  <li><%%= context_menu_link l(:button_delete), <%= model_name_pluralize_underscored %>_path(ids: @<%= model_name_underscored %>_ids, back_url: @back), method: :delete, data: {confirm: l(:text_are_you_sure)}, class: 'icon icon-del', disabled: !@can[:delete] %></li>
+  <li><%%= context_menu_link l(:button_delete), <%= model_name_underscored %>_path(id: @<%= model_name_underscored %>_ids, back_url: @back), method: :delete, data: {confirm: l(:text_are_you_sure)}, class: 'icon icon-del', disabled: !@can[:delete] %></li>
 
   <%%= call_hook(:view_<%= model_name_pluralize_underscored %>_context_menu_end, {<%= model_name_underscored %>: @<%= model_name_underscored %>, <%= model_name_pluralize_underscored %>: @<%= model_name_pluralize_underscored %>, can: @can, back: @back, project: @project}) %>
 </ul>

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

@@ -0,0 +1,78 @@
+require Rails.root.join('plugins', 'easyproject', 'easy_plugins', 'easy_extensions/test/spec/spec_helper')
+
+describe <%= controller_class %>Controller, logged: true do
+  let(:<%= model_name_underscored %>) { FactoryGirl.create(:<%= model_name_underscored %>) }
+  let(:<%= model_name_pluralize_underscored %>) { FactoryGirl.create_list(:<%= model_name_underscored %>, 5) }
+
+  before(:each) do
+    role = Role.non_member
+    role.add_permission! :view_<%= model_name_pluralize_underscored %>
+    role.add_permission! :manage_<%= model_name_pluralize_underscored %>
+  end
+
+  render_views
+
+  it 'index' do
+    <%= model_name_pluralize_underscored %>
+
+    get :index
+    expect(response).to have_http_status(:success)
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/index')
+  end
+
+  it 'show' do
+    get :index, {id: <%= model_name_underscored %>}
+    expect(response).to have_http_status(:success)
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/show')
+  end
+
+  it 'new' do
+    get :new
+    expect(response).to have_http_status(:success)
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/new')
+  end
+
+  it 'create with invalid' do
+    post :create, {<%= model_name_underscored %>: {}}
+    expect(response).to have_http_status(:success)
+    expect(assigns[:<%= model_name_underscored %>]).to be_a_new(<%= model_name %>)
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/new')
+  end
+
+  it 'create with valid' do
+    post :create, {<%= model_name_underscored %>: FactoryGirl.attributes_for(:<%= model_name_underscored %>)}
+    expect(response).to have_http_status(:success)
+    expect(assigns[:<%= model_name_underscored %>]).not_to be_a_new(<%= model_name %>)
+    expect(response).to redirect_to(<%= model_name_underscored %>_path(assigns[:<%= model_name_underscored %>]))
+  end
+
+  it 'edit' do
+    get :edit, {id: <%= model_name_underscored %>}
+    expect(response).to have_http_status(:success)
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/edit')
+  end
+
+  it 'update with invalid' do
+    put :update, {<%= model_name_underscored %>: {url: ''}}
+    expect(response).to have_http_status(:success)
+    expect(assigns[:<%= model_name_underscored %>].valid?).to be false
+    expect(response).to render_template('<%= model_name_pluralize_underscored %>/edit')
+  end
+
+  it 'update with valid' do
+    put :update, {<%= model_name_underscored %>: {url: 'http://tlapmazon.easy:123'}}
+    expect(response).to have_http_status(:success)
+    expect(assigns[:<%= model_name_underscored %>].valid?).to be true
+    expect(response).to redirect_to(<%= model_name_underscored %>_path(assigns[:<%= model_name_underscored %>]))
+  end
+
+  it 'destroy' do
+    <%= model_name_underscored %>
+    <%= model_name_pluralize_underscored %>
+
+    expect(<%= model_name %>.count).to eq(6)
+    expect {delete :destroy, {id: <%= model_name_underscored %>}}.to change(<%= model_name %>, :count).by(-1)
+    expect(response).to redirect_to(<%= model_name_pluralize_underscored %>_path)
+    expect(response).to redirect_to(<%= model_name_pluralize_underscored %>_path)
+  end
+end

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

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+
+  factory :<%= model_name_underscored %> do
+      <%- string_columns.each_key do |c| -%>
+      sequence(:<%= c %>) { | n | "<%= c %>-#{n}"}
+          <%-  end -%>
+      <%= 'association :author, factory: :user' if author? %>
+      <%= 'project' if project? %>
+
+  end
+
+end

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

@@ -3,5 +3,7 @@
 <%%= context_menu context_menu_<%= model_name_pluralize_underscored %>_path(:project_id => @project) %>
 <%% content_for :sidebar do %>
   <%%= render :partial => '<%= model_name_pluralize_underscored %>/sidebar' %>
+  <% if Redmine::Plugin.installed?(:easy_extensions) %>
   <%%= render :partial => 'sidebar/saved_easyqueries_by_type', :locals => {:query_class => @query.class, :project => @project} %>
+  <% end %>
 <%% end %>

data/lib/generators/redmine_extensions/plugin/USAGE

@@ -1,5 +1,5 @@
 Description:
-    The plugin generator creates stubs for a new Redmine plugin.
+    The plugin generator creates stubs for new Redmine plugin.
     Plugin is prepared for use in Redmine and Easy Redmine as well.
     You can use --customer flag to generate a special plugin if you can make just a few changes to code. Backup this plugin before Redmine or Easy Redmine upgrade and move back for keep you changes.
 

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

@@ -46,7 +46,7 @@ module RedmineExtensions
       template 'Gemfile.erb', "#{plugin_path}/Gemfile"
       template 'init.rb.erb', "#{plugin_path}/init.rb"
       template 'javascript.js', "#{plugin_path}/assets/javascripts/#{plugin_name_underscored}.js"
-      template 'stylesheet.js', "#{plugin_path}/assets/stylesheets/#{plugin_name_underscored}.css"
+      template 'stylesheet.css', "#{plugin_path}/assets/stylesheets/#{plugin_name_underscored}.css"
       template 'en.yml.erb', "#{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"

data/lib/redmine_extensions/engine.rb

@@ -57,6 +57,9 @@ module RedmineExtensions
       ActiveSupport.on_load(:active_record) do
         include RedmineExtensions::RailsPatches::ActiveRecord
       end
+      ActiveSupport.on_load(:action_view) do
+        default_form_builder.send(:include, RedmineExtensions::RailsPatches::FormBuilderPatch)
+      end
     end
 
     initializer 'redmine_extensions.initialize_easy_plugins', after: :load_config_initializers do

data/lib/redmine_extensions/rails_patches/form_builder_patch.rb

@@ -0,0 +1,12 @@
+module RedmineExtensions
+  module RailsPatches
+    module FormBuilderPatch
+
+      # See documentation for autocomplete_field in helper
+      def autocomplete_field(method, choices, options={}, html_options={})
+        @template.autocomplete_field(@object_name, method, choices, objectify_options(options), html_options)
+      end
+
+    end
+  end
+end

data/lib/redmine_extensions/tags/autocomplete_field.rb

@@ -0,0 +1,28 @@
+require 'action_view/helpers/tags/placeholderable'
+
+module RedmineExtensions
+  module Tags
+    class AutocompleteField < ActionView::Helpers::Tags::Base
+      include ActionView::Helpers::Tags::Placeholderable
+
+      def initialize(object_name, method_name, template_object, choices, options, html_options)
+        @choices = block_given? ? template_object.capture { yield || "" } : choices
+        @choices = @choices.to_a if @choices.is_a?(Range)
+
+        options[:multiple] = true unless options.key?(:multiple)
+
+        @html_options = html_options
+
+        super(object_name, method_name, template_object, html_options.merge(options))
+      end
+
+      def render
+        options = @options.stringify_keys
+        options["value"] = options.fetch("value") { value_before_type_cast(object) }
+        add_default_name_and_id(options)
+        @template_object.autocomplete_field_tag(options.delete('name'), @choices, options.delete('value'), options.symbolize_keys)
+      end
+
+    end
+  end
+end

data/lib/redmine_extensions/version.rb

@@ -1,3 +1,3 @@
 module RedmineExtensions
-  VERSION = '0.1.16'
+  VERSION = '0.1.17'
 end

data/spec/features/autocomplete_spec.rb

@@ -8,6 +8,13 @@ RSpec.describe 'autocomplete', type: :feature, js: true do
       expect(page).to have_css('input#default[type="text"]')
       expect(page).to have_css('input[type="hidden"][name="default"][value="value1"]', visible: false)
     end
+
+    it 'generate autocomplete_field in form_for' do
+      visit '/dummy_autocompletes'
+      binding.pry
+      expect(page).to have_css('input#dummy_entities_autocomplete[type="text"]')
+      expect(page).to have_css('input[type="hidden"][name="dummy_entity[array_of_dummies][]"][value="value1"]', visible: false)
+    end
   end
 
 end

data/spec/support/plugin_generator.rb

@@ -15,11 +15,60 @@ module PluginGenerator
   end
 
   def self.generate_autocomplete!
+    generate_dummy_entity!
     generate_autocomplete_controller!
     generate_autocomplete_routes!
     generate_autocomplete_view!
   end
 
+  def self.generate_dummy_entity!
+    File.open( Rails.root.join('plugins', 'dummy_plugin', 'db', 'migrate', '20162010160230_create_dummy_entities.rb'), 'w' ) do |file|
+      file.write( <<-END_RUBY )
+        class CreateDummyEntities < ActiveRecord::Migration
+          def change
+            create_table :dummy_entities do |t|
+              t.string :name
+              t.integer :value
+              t.references :project, index: true
+              t.text :array_of_dummies
+            end
+          end
+        end
+      END_RUBY
+    end
+
+    File.open( Rails.root.join('plugins', 'dummy_plugin', 'app', 'models', 'dummy_entity.rb'), 'w' ) do |file|
+      file.write( <<-END_RUBY )
+        class DummyEntity < ActiveRecord::Base
+          include Redmine::SafeAttributes
+          safe_attributes 'name',
+                          'value',
+                          'project_id',
+                          'array_of_dummies'
+
+          attr_protected :id
+
+          serialize :array_of_dummies, Array
+        end
+      END_RUBY
+    end
+
+    File.open(Rails.root.join('plugins', 'dummy_plugin', 'app', 'controllers', 'dummy_entities_controller.rb'), 'w') do |file|
+      file.write( <<-END_RUBY )
+        class DummyEntitiesController < ApplicationController
+          def index
+          end
+
+          def create
+            @entity = DummyEntity.new
+            @entity.safe_attributes = params[:dummy_entity]
+            @entity.save
+          end
+        end
+      END_RUBY
+    end
+  end
+
   def self.generate_autocomplete_controller!
     File.open(Rails.root.join('plugins', 'dummy_plugin', 'app', 'controllers', 'dummy_autocompletes_controller.rb'), 'w') do |file|
       file.write( <<-END_RUBY )
@@ -33,7 +82,10 @@ module PluginGenerator
 
   def self.generate_autocomplete_routes!
     File.open(Rails.root.join('plugins', 'dummy_plugin', 'config', 'routes.rb'), 'w') do |file|
-      file.write("resources :dummy_autocompletes")
+      file.write( <<-END_ROUTES )
+        resources :dummy_autocompletes
+        resources :dummy_entities
+      END_ROUTES
     end
   end
 
@@ -41,11 +93,15 @@ module PluginGenerator
     dir = Rails.root.join('plugins', 'dummy_plugin', 'app', 'views', 'dummy_autocompletes')
     Dir.mkdir dir
     File.open(dir.join('index.html.erb'), 'w') do |file|
-      file.write( <<-END_RUBY )
+      file.write( <<-END_ERB )
         <%= form_tag('/dummy_autocompletes', id: 'autocompletes_form') do %>
           <%= autocomplete_field_tag('default', ['value1', 'value2'], ['value1']) %>
         <% end %>
-      END_RUBY
+
+        <%= form_for(DummyEntity.new(array_of_dummies: ['value1'])) do |f| %>
+          <%= f.autocomplete_field(:array_of_dummies, ['value1', 'value2'], {}, id: 'dummy_entities_autocomplete') %>
+        <% end %>
+      END_ERB
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Easy Software Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,10 +168,12 @@ files:
 - lib/generators/redmine_extensions/entity/templates/_sidebar.html.erb.erb
 - lib/generators/redmine_extensions/entity/templates/context_menu.html.erb.erb
 - lib/generators/redmine_extensions/entity/templates/controller.rb.erb
+- lib/generators/redmine_extensions/entity/templates/controller_spec.rb.erb
 - lib/generators/redmine_extensions/entity/templates/custom_field.rb.erb
 - lib/generators/redmine_extensions/entity/templates/edit.html.erb.erb
 - lib/generators/redmine_extensions/entity/templates/edit.js.erb.erb
 - lib/generators/redmine_extensions/entity/templates/en.yml.erb
+- lib/generators/redmine_extensions/entity/templates/factories.rb.erb
 - lib/generators/redmine_extensions/entity/templates/helper.rb.erb
 - lib/generators/redmine_extensions/entity/templates/hooks.rb.erb
 - lib/generators/redmine_extensions/entity/templates/index.api.rsb.erb
@@ -228,9 +230,11 @@ files:
 - lib/redmine_extensions/query_outputs/list_output.rb
 - lib/redmine_extensions/query_outputs/tiles_output.rb
 - lib/redmine_extensions/rails_patches/active_record.rb
+- lib/redmine_extensions/rails_patches/form_builder_patch.rb
 - lib/redmine_extensions/rails_patches/route_set_generator_patch.rb
 - lib/redmine_extensions/redmine_patches/controllers/application_controller_patch.rb
 - lib/redmine_extensions/redmine_patches/patches.rb
+- lib/redmine_extensions/tags/autocomplete_field.rb
 - lib/redmine_extensions/version.rb
 - lib/tasks/redmine_extensions_tasks.rake
 - spec/factories/easy_queries.rb