rails_admin_select2 0.0.1.pre → 0.0.2.pre

data/app/views/rails_admin/main/_form_select2_tags.html.erb

@@ -0,0 +1,6 @@
+<%- tags_value = field.value || '' %>
+<%- tags_predefined = "[%s]" % field.tags.map{ |t| "\"#{t.to_s}\"" }.join(',') %>
+<%= form.hidden_field(field.method_name, { :class => 'select2', :style => 'width:75%', :value => tags_value }) %>
+<script type="text/javascript">
+  $(<%= "#{field.abstract_model.to_s.underscore}_#{field.method_name}" %>).select2({ tags: <%= tags_predefined.html_safe %> });
+</script>

data/lib/rails_admin_select2/version.rb

@@ -1,7 +1,7 @@
 module RailsAdminSelect2
   MAJOR = '0'
   MINOR = '0'
-  PATCH = '1'
+  PATCH = '2'
   PRE = 'pre'
   VERSION = [ MAJOR, MINOR, PATCH, PRE ].join('.')
 end

data/lib/rails_admin_select2.rb

@@ -8,34 +8,115 @@ module RailsAdmin
     module Fields
       module Types
         # Add support for select2 input fields to RailsAdmin.
+        #
+        # Select2 home with demos: http://ivaynberg.github.io/select2/.
         class Select2 < RailsAdmin::Config::Fields::Base
           RailsAdmin::Config::Fields::Types::register(self)
+          # For relations, render a (multi)select select2 field.
+          # For strings, render a hidden field for tagging (if :tags is an array).
           def initialize(parent, name, properties)
             super(parent, name, properties)
-            @meta = abstract_model.model.reflect_on_association(name)
-            if not [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many].include? @meta.macro
-              raise RuntimeError.new('Cannot render select2 for association %s#%s of type %s.' % [@meta.class_name, @meta.name, @meta.macro])
-            end            
+            # Mongoid allows field aliases (:as).
+            # Map both names and aliases to field meta information.
+            @fields = Hash[*(abstract_model.model.fields.map{|k,v| [[k.to_sym,v],[v.options[:as].try(:to_sym),v]]}.flatten)].delete_if{|k,v| k.nil?}
+            @relation = abstract_model.model.reflect_on_association(name)
+            @arity = {
+              :embeds_one              => :one,
+              :embedded_in             => :one,
+              :embeds_many             => :many,
+              :belongs_to              => :one,
+              :has_one                 => :one,
+              :has_many                => :many,
+              :has_and_belongs_to_many => :many
+            }
+          end
+          # If tags have been supplied, render a select2 field for tagging.
+          # See http://ivaynberg.github.io/select2/#tags.
+          #
+          # The tags supplied will be available as choices in the tagging field,
+          # new tags can be added.
+          #
+          # To render a tagging field without predefined choices, supply []
+          # to tags, like so:
+          #
+          #     config.model "Model" do
+          #       edit do
+          #         field do
+          #           tags []
+          #         end
+          #       end
+          #     end
+          #
+          # If no tags have been supplied, a collection of associated objects
+          # will be rendered for selection. See the :collection instance option.
+          #
+          # To disable tagging (the default) explicitly, set tags to nil.
+          register_instance_option(:tags) do
+            tagging? ? [] : nil
           end
           register_instance_option(:partial) do
-            :form_select2
+            tagging? ? :form_select2_tags : :form_select2
           end
+          # If true, allow selecting multiple associated objects.
+          # 
+          # This will be true, if the association macro is one of
+          # :has_many, :has_and_belongs_to_many, or :embeds_many.
+          # 
+          # Raise a RuntimeError if tagging? has been enabled.
           register_instance_option(:multiple?) do
-            [:has_many, :has_and_belongs_to_many].include? @meta.macro
+            if tagging?
+              raise RuntimeError.new "cannot render select2 because #{abstract_model.model.to_s}##{@name} does not define a relation"
+            end
+            @arity[@relation.macro] == :many
           end
+          # Per default, assemble a collection of all objects for this
+          # association by class name.
+          #
+          # For instance, if the association to render is article.article_group,
+          # the collection used for the select2 field will contain all ArticleGroups.
+          # 
+          # If :tags have been supplied, a tagging field will be rendered
+          # and no collection is required/will be assembled.
           register_instance_option(:collection) do
-            @meta.class_name.safe_constantize.all.map{ |object| [ object.name, object.id ] }
+            return nil if tagging?
+            @relation.class_name.safe_constantize.all.map{ |object| [ object.name, object.id ] }
           end
-          # For Mongoid, the method_name required is <name>_id[s],
-          # e.g. children_ids or parent_id.
+          # For Mongoid, the method_name for referenced associations is <name>_id[s],
+          # e.g. children_ids or parent_id; for embedded documents it is <name> or 
+          # <name>s, respectively.
           #
-          # To construct method_name, start with the association name and
-          # append '_id' or '_ids' for :belongs_to and all other types
-          # of associations, respectively.
+          # Return #{name} for embedded documents, #{name}_id for referenced documents;
+          # append 's', if the association references multiple documents.
           #
-          # TODO Does this work in AR, too?
+          # TODO How does this work in AR?
           def method_name
-            '%s_%s' % [ @meta.name.to_s.singularize, multiple? ? 'ids' : 'id' ]
+            return @name if tagging?
+            embedded = [ :embeds_one, :embeds_many, :embedded_in ].include? @relation.macro
+            m = embedded ? @relation.name.to_s.singularize : "#{@relation.name.to_s.singularize}_id"
+            multiple? ? m.pluralize : m
+          end
+          
+          private
+
+          # Return true, if this tagging should be enabled for this field.
+          # 
+          # For tagging to be enabled, the type of the field must be
+          # Mongoid::Fields::Standard and the type of the attribute
+          # must be String.
+          #
+          # Tagging is not supported for relation fields (associations).
+          def tagging?
+            # The name of a relation and the name of the field
+            # storing values for the relation differ (<name>_id[s] vs <name>).
+            # If @fields does not contain a value for @name,
+            # this field is a relation and tagging is not supported.
+            return false unless @fields.has_key?(@name)
+            # Tagging requires a field of type Mongoid::Fields::Standard
+            # with an attribute of type String.
+            klass = @fields[@name].class
+            type = @fields[@name].options[:type]
+            # TODO allow type of String and Array?
+            klass == Mongoid::Fields::Standard && [ ::String ].include?(type)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_select2
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.2.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_admin
@@ -50,6 +50,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/views/rails_admin/main/_form_select2_tags.html.erb
 - app/views/rails_admin/main/_form_select2.html.erb
 - lib/rails_admin_select2/version.rb
 - lib/rails_admin_select2/engine.rb
@@ -68,6 +69,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 652118273
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -81,4 +85,3 @@ signing_key:
 specification_version: 3
 summary: Select2 for rails_admin
 test_files: []
-has_rdoc: