hobo_bootstrap_ui 2.0.0.pre6 → 2.0.0.pre7

data/VERSION

@@ -1 +1 @@
-2.0.0.pre6
+2.0.0.pre7

data/taglibs/name_one_bootstrap.dryml

@@ -0,0 +1,71 @@
+<!-- An `<input type="text">` with auto-completion. Allows the user to chose the target of a `belongs_to` association by name.
+
+This tag relies on an autocompleter being defined in a controller.  A simple example:
+
+    <form with="&ProjectMembership.new">
+      <name-one:user>
+    </form>
+
+    class ProjectMembership < ActiveRecord::Base
+      hobo_model
+      belongs_to :user
+    end
+
+    class User < ActiveRecord::Base
+      hobo_user_model
+      has_many :project_memberships, :accessible => true, :dependent => :destroy
+    end
+
+    class UsersController < ApplicationController
+      autocomplete
+    end
+
+The route used by the autocompleter looks something like `/users/complete_name`.  The first part of this route is specified by the `complete-target` attribute, and the second part is specified by the `completer` attribute.
+
+`complete-target` specifies the controller for the route.  It can be specified by either supplying a model class or a model.  If a model is supplied, the id of the model is passed as a parameter to the controller.  (`?id=7`, for example)  The default for this attribute is the class of the context.   In other words, the class that contains the `has_many / has_one`, not the class with the `belongs_to`.
+
+`completer` specifies the action for the route.   `name-one` prepends `complete_` to the value given here.  This should be exactly the same as the first parameter to `autocomplete` in your controller.   As an example:  `autocomplete :email_address` would correspond to `completer="email_address"`.  The default for this attribute is the name field for the model being searched, which is usually `name`, but not always.
+
+The query string is passed to the controller in the `term` parameter.  (`?term=hello` for example).
+
+For more information on how to customize the controller, see the [controller manual](http://cookbook.hobocentral.net/manual/controllers#autocompleters)
+
+Here's a more complex example.  This used to be a part of [agility](http://cookbook.hobocentral.net/tutorials/agility) until it was simplified.
+
+    class ProjectsController < ApplicationController
+      autocomplete :new_member_name do
+        project = find_instance
+        hobo_completions :name, User.without_project(project).is_not(project.owner)
+      end
+    end
+
+Note that this was added to the projects controller, rather than the users controller as in the first example.  You can read this as: create an auto-complete action called `new_member_name` that finds users that are not already members of the project, and not the owner of the project, and completes the :name field.
+
+    <name-one:user complete-target="&@project" completer="new_member_name"/>
+
+We're using an object as the complete-target rather than a class.   This allows the `find_instance` in our controller action to function.
+
+There's another example of `<name-one>` use in the [recipes](http://cookbook.hobocentral.net/recipes/36-using-a-name-one-one-a).
+
+### Attributes:
+
+All other attributes are passed through to the `<typeahead>` that provides the core functionality for this widget.
+
+- `complete-target`, `completer`: see above
+- `min-chars`: The minimum number of characters that must be entered in the input field before an Ajax request is made.   A compatibility alias for `data-minLength`
+- `nil-value`: If there is no current value, this text will appear greyed out inside the control, and will disappear when text is entered.   This is a compatibility alias for `placeholder`.
+
+  -->
+<def tag="name-one-bootstrap" attrs="complete-target, completer, min-chars">
+<%
+  complete_target ||= this_field_reflection.klass
+  completer ||= (complete_target.is_a?(Class) ? complete_target : complete_target.class).name_attribute
+  begin
+    source = polymorphic_url(complete_target, :action => "complete_#{completer}", :routing_type => :path)
+  rescue NoMethodError => e
+    source = polymorphic_url(complete_target.class, :action => "complete_#{completer}", :routing_type => :path, :id => complete_target._?.id)
+  end
+  value = name(:no_wrapper => true, :if_present => true)
+-%>
+  <typeahead completer-path="&source" data-minLength="&min_chars || 1" merge/>
+</def>

data/taglibs/overrides.dryml

@@ -4,3 +4,8 @@
     <search-results/>
   </modal>
 </def>
+
+<!-- alias `<name-one>` to `<name-one-bootstrap>` -->
+<def tag="name-one">
+  <name-one-bootstrap merge/>
+</def>

data/taglibs/select_one_or_new.dryml

@@ -14,11 +14,8 @@ You also need to modify the create action of the new record. projects_controller
 
     def create
       hobo_create do
-        if request.xhr?
-          @this = Story.new(:project => @project) 
-        else
-          create_response
-        end
+        @this = Story.new(:project => @project)  if request.xhr?
+        create_response
       end
     end
 

data/taglibs/typeahead.dryml

@@ -0,0 +1,50 @@
+<!--
+This is the [Bootstrap typeahead](http://twitter.github.com/bootstrap/javascript.html#typeahead).
+
+If you do not provide a `source` option, this tag will essentially provide a default similar to this:
+
+    <typeahead:project source="&Project.find(:all, :limit => 5000).map {|p| p.name}" />
+
+The javascript options supported by Bootstrap typeahead may be provided either as a function name or a javascript snippet.   For example, case sensitive match:
+
+    <typeahead matcher="arguments[0].indexOf(this.query)>=0"/>
+
+### Attributes
+
+You may only supply one of `data-source`, `source`, or `completer-path`
+
+- `source`: the list of items that may be matched, as a Ruby array.
+- `source-function`: a Javascript function that returns the list of items for a query.  See the Bootstrap typeahead documentation for more details
+- `completer-path`: the path to a hobo autocomplete action.  See `<name-one>` for more information.  In fact, you're better off using `<name-one>` directly.
+
+Other attributes:
+
+- `items`: The max number of items to display in the dropdown.
+- `minLength`: The minimum character length needed before triggering autocomplete suggestions
+- `placeholder`: the placeholder to display when the input has no value
+- `matcher`, `sorter`, `updater`, `highlighter`: javascript functions
+
+-->
+<def tag="typeahead" attrs="nil-value, completer-path, source-function">
+<%
+  options, attributes = attributes.partition_hash(%w(minLength items source))
+  events, attributes = attributes.partition_hash(%w(source matcher sorter updater highlighter))
+
+  if !completer_path
+    options['source'] ||= source_function || begin
+                          complete_target = this_field_reflection.klass
+                          complete_target.find(:all, :limit => 5000).*.send(complete_target.name_attribute)
+                        end
+  end
+
+
+  attributes["name"] ||= param_name_for_this
+  attributes["value"] ||= name(:no_wrapper => true, :if_present => true)
+
+  attributes["placeholder"] ||= nil_value
+  add_data_rapid!(attributes, "typeahead", :options => options, :events => events, :completer_path => completer_path)
+ %>
+  <wrap tag="span" class="field-with-errors" when="&!this_parent.errors[this_field].empty?">
+    <input type="text" data-provide="typeahead" merge-attrs/>
+  </wrap>
+</def>

data/vendor/assets/javascripts/hobo-bootstrap-ui/hjq-typeahead.js

@@ -0,0 +1,14 @@
+/* typeahead */
+(function($) {
+   $.fn.hjq_typeahead = function(annotations) {
+     var opts = this.hjq('getOptions', annotations);
+     if(annotations.completer_path) {
+       opts.source = function (query, process) {
+         return $.get(annotations.completer_path, { term: query }, function (data) {
+           return process(data);
+         });
+       };
+     }
+     this.typeahead(opts);
+   };
+})( jQuery );

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hobo_bootstrap_ui
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre6
+  version: 2.0.0.pre7
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hobo_bootstrap
@@ -41,9 +41,12 @@ files:
 - screenshots/select_one_or_new.png
 - taglibs/hobo_bootstrap_ui.dryml
 - taglibs/modal.dryml
+- taglibs/name_one_bootstrap.dryml
 - taglibs/overrides.dryml
 - taglibs/select_one_or_new.dryml
+- taglibs/typeahead.dryml
 - vendor/assets/javascripts/hobo-bootstrap-ui/hjq-modal.js
+- vendor/assets/javascripts/hobo-bootstrap-ui/hjq-typeahead.js
 - vendor/assets/javascripts/hobo_bootstrap_ui.js
 - vendor/assets/stylesheets/hobo_bootstrap_ui.css
 homepage: https://github.com/Hobo/hobo_bootstrap_ui