ucb_rails 0.0.3 → 0.0.4

data/app/controllers/ucb_rails/admin/users_controller.rb

@@ -54,12 +54,8 @@ class UcbRails::Admin::UsersController < UcbRails::Admin::BaseController
   end
 
   def typeahead_search
-    tokens = params.fetch(:query).to_s.strip.split(/\s+/)
-    wheres = tokens.map { |e| 'first_last_name like ?' }.join(' and ')
-    values = tokens.map { |e| "%#{e}%" }
-    where = ["#{wheres}", *values]
-    results = UcbRails::User.where(*where).limit(10)
-    render json: results.map { |r| {uid: r.uid, first_last_name: r.first_last_name} }
+    uta = UcbRails::UserTypeahead.new
+    render json: uta.results(params.fetch(:query))
   end
   
   private

data/app/helpers/ucb_rails/ldap_person_search_helper.rb

@@ -18,4 +18,7 @@ module UcbRails::LdapPersonSearchHelper
     @ldap_person_search_existing_uids ||= (@lps_existing_uids || []).map(&:to_s)
   end
   
+  def lps_matches
+    @lps_entries.size.zero? ? '' : "Matches: #{@lps_entries.size}"
+  end
 end

data/app/helpers/ucb_rails/lps_typeahead_helper.rb

@@ -1,50 +1,19 @@
+# Helper class that produces a person search widget than includes typeahead and
+# CalNet lookup functionality.
 module UcbRails::LpsTypeaheadHelper
-  
+
+  # @option options [Symbol] :name (:person_search) the name of the <input> field
+  # @option options [String] :label ('User') the text of the field label
+  # @option options [Boolean] :required (false) is the field required
+  # @option options [String] :value (params[:name]) the value of the field
+  # @option options [String] :placeholder ('Type name to search') the html +placeholder+ attribute
+  # @option options [String] :hint ('Click icon to search CalNet') hint text
+  # @option options [String] :result_link_text ('Select') the text of the link button in search results
+  # @option options [String] :result_link_class ('lps-typeahead-item') class to be added the the results link
+  # @option options [String] :uid_dom_id ('uid') the dom-id of the (hidden) uid <input>
+  # @option options [String] :search_url ('/ucb_rails/admin/users/typeahead_search') the search url for typeahead
   def lps_typeahead_search_field(options={})
-    name = options.delete(:name) || 'person_search'
-    required = options.delete(:required)
-    label = options.delete(:label) || 'User'
-    value = options.delete(:value) || params[name]
-    placeholder = options.delete(:placeholder) || 'Type name to search'
-    hint = options.delete(:hint) || 'Click icon to search CalNet'
-    
-    result_link_text = options.delete(:result_link_text) || 'Select'
-    result_link_class = options.delete(:result_link_class) || 'lps-typeahead-item'
-    
-    uid_dom_id = options.delete(:uid_dom_id) || 'uid'
-    search_url = options.delete(:search_url) || typeahead_search_ucb_rails_admin_users_path
-    
-    content_tag(:div, class: 'control-group lps-typeahead') do
-      label_tag(name, class: label_classes(required)) do
-        required_marker(required) +
-        label
-         
-      end +
-      content_tag(:div, class: 'controls') do
-        content_tag(:div, class: 'input-append') do
-          text_field_tag(name, value, placeholder: placeholder, class: 'typeahead-lps-search', data: { uid_dom_id: uid_dom_id, url: search_url }) +
-          content_tag(:span, class: 'add-on') do
-            icon('search', class: 'ldap-person-search', data: {search_field_name: name, result_link_text: result_link_text, result_link_class: result_link_class})
-          end
-        end +
-        content_tag(:p, hint, class: 'help-block')
-      end
-    end
+    UcbRails::Renderer::LpsTypeaheadSearchField.new(self, options).html
   end
   
-  private
-  
-  def label_classes(required)
-    Array['control-label'].tap do |klasses|
-      klasses << 'required' if required
-    end
-  end
-  
-  def required_marker(required)
-    if required
-      content_tag(:abbr, '*', title: 'required') + ' '
-    else
-      ''
-    end
-  end
 end

data/app/helpers/ucb_rails/renderer/lps_typeahead_search_field.rb

@@ -0,0 +1,90 @@
+module UcbRails
+  module Renderer
+    
+    class LpsTypeaheadSearchField < Base
+      
+      attr_accessor :name, :label, :required, :value, :placeholder, :hint, :result_link_text, :result_link_class, :uid_dom_id, :search_url
+      
+      def initialize(template, options={})
+        super
+        parse_options
+      end
+      
+      def html
+        content_tag(:div, class: 'control-group lps-typeahead') do
+          label_html +
+          content_tag(:div, class: 'controls') do
+            content_tag(:div, class: 'input-append') do
+              text_field_html +
+              span_html
+            end +
+            content_tag(:p, hint, class: 'help-block')
+          end
+        end
+      end
+      
+      private
+      
+      def label_html
+        required_marker = required ? content_tag(:abbr, '*', title: 'required') + ' ' : ''
+        label_classes = 'control-label'
+        label_classes << ' required' if required
+        
+        label_tag(name, class: label_classes) do
+          required_marker +
+          label
+        end
+      end
+            
+      def text_field_html
+        text_field_tag(name, value, {
+          autocomplete: 'off',
+          class: 'typeahead-lps-search',
+          placeholder: placeholder,
+          data: {
+            uid_dom_id: uid_dom_id,
+            url: search_url
+          }
+        })
+      end
+      
+      def span_html
+        span_options = {
+          class: 'add-on ldap-person-search',
+          data: {
+            search_field_name: name,
+            result_link_text: result_link_text,
+            result_link_class: result_link_class
+          }
+        }
+        content_tag(:span, span_options) do
+          icon('search')
+        end
+      end
+      
+      def parse_options
+        self.name = options.delete(:name) || 'person_search'
+        self.label = options.delete(:label) || 'User'
+        self.required = options.delete(:required)
+        self.value = options.delete(:value) || params[name]
+        self.placeholder = options.delete(:placeholder) || 'Type name to search'
+        self.hint = options.delete(:hint) || 'Click icon to search CalNet'
+        self.result_link_text = options.delete(:result_link_text) || 'Select'
+        self.result_link_class = options.delete(:result_link_class) || 'lps-typeahead-item'
+        self.uid_dom_id = options.delete(:uid_dom_id) || 'uid'
+        self.search_url = options.delete(:search_url) || typeahead_search_ucb_rails_admin_users_path
+        
+        validate_options
+      end
+      
+      def validate_options
+        return if options.blank?
+        
+        msg = "Unknown lps_typeahead_search_field option(s): #{options.keys.map(&:inspect).join(', ')}. "
+        msg << "Did you mean one of :name, :required, :label, :value, :placeholder, :hint, :result_link_text, :result_link_class, :uid_dom_id, :search_url"
+        raise ArgumentError, msg
+      end
+      
+    end
+  end
+end

data/app/models/ucb_rails/user_typeahead.rb

@@ -0,0 +1,81 @@
+module UcbRails
+
+  # Class for getting results for ldap person search typeahead fields.
+  #
+  # By default it will search the UcbRails::User table, but this is configurable:
+  #
+  # @example
+  #   class MyController < ApplicationController
+  # 
+  #     def search
+  #       uta = UserTypeahead.new
+  #       render :json uta.results('art')
+  #     end
+  #
+  #   end
+  #
+  class UserTypeahead
+    attr_accessor :klass, :search_column, :uid_column, :first_last_name_column, :limit
+    
+    # Constructor
+    #
+    # @example
+    #   UserTypeahead.new
+    #   UserTypeahead.new(klass: Faculty, search_column: 'full_name', uid_column: 'net_id', limit: 25)
+    # @param options [Hash]
+    # @option options [Object] :klass (UcbRails::User) the (+ActiveRecord+) class to search
+    # @option options [Symbol] :search_column (:first_last_name) the column to search
+    # @option options [Symbol] :uid_column (:uid) the column holding the +uid+
+    # @option options [Symbol] :first_last_name (search_column) the column holding the first/last names
+    # @option options [FixNum] :limit (10) number of rows to return
+    # @return [UcbRails::UserTypeahead]
+    def initialize(options={})
+      self.klass = options.delete(:klass) || UcbRails::User
+      self.search_column = options.delete(:search_column) || :first_last_name
+      self.limit = options.delete(:limit) || 10
+      self.uid_column = options.delete(:uid_column) || :uid
+      self.first_last_name_column = options.delete(:first_last_name_column) || search_column
+      validate_options(options)
+    end
+    
+    # Returns the data matching _query_.
+    # @example
+    #   uta = UserTypeahead.new
+    #   uta.results('art')        #=> [{uid: '1', first_last_name: 'Art Andrews'}, ...]
+    # @param query [String] search term to match name fields on
+    # @return [Array(Hash)] 
+    def results(query)
+      klass
+        .where(where(query))
+        .limit(limit)
+        .map { |row| row_to_hash(row) }
+    end
+    
+    private
+    
+    def where(query)
+      tokens = query.to_s.strip.split(/\s+/)
+      wheres = tokens.map { |e| "#{search_column} like ?" }.join(' and ')
+      values = tokens.map { |e| "%#{e}%" }
+      
+      ["#{wheres}", *values]
+    end
+    
+    def row_to_hash(row)
+      {
+        uid: row.send(uid_column),
+        first_last_name: row.send(first_last_name_column)
+      }
+    end
+    
+    def validate_options(options)
+      if options.present?
+        msg = "Unknown UcbRails::UserTypeahead.new option(s): #{options.keys.map(&:inspect).join(', ')}. "
+        msg << "Did you mean one of :klass, :search_column, :uid_column, :first_last_name_column, :limit"
+        raise ArgumentError, msg
+      end
+      
+    end
+  end
+  
+end

data/app/views/ucb_rails/lps/_modal.html.haml

@@ -1,6 +1,9 @@
 = modal(id: 'lps-modal') do
-  = modal_header('Search For Person')
-  = modal_body do
+  = modal_header do
+    %h3.title Search For Person
     = render partial: 'ucb_rails/lps/form'
+  = modal_body do
     #lps-results
-  = modal_footer
+  = modal_footer do
+    #matches.pull-left
+    = modal_footer_close_button

data/app/views/ucb_rails/lps/_results.html.haml

@@ -1,21 +1,34 @@
-- if @lps_entries.empty?
-  %p No records were found.
-- else 
-  = ucbr_table_tag(class: 'table-condensed') do
-    %thead
-      %tr
-        %th{style: 'width="1%"'}
-        %th First Name
-        %th Last Name
-        %th Email
-        %th Department
-    %tbody
-      - @lps_entries.each do |entry|
-      -   entry_id = "ldap_uid_#{entry.uid}" 
-        %tr{id: entry_id, class: ldap_entry_class(entry)}
-          %td= link_to_ldap_person_entry(entry) 
-          %td= entry.first_name 
-          %td= entry.last_name 
-          %td= entry.email 
-          %td= entry.departments 
+= ucbr_table_tag(class: 'table-condensed') do
+  %thead
+    %tr
+      %th{style: 'width="1%"'}
+      %th First Name
+      %th Last Name
+      %th Email
+      %th Department
+  %tbody
+    - @lps_entries.each do |entry|
+    -   entry_id = "ldap_uid_#{entry.uid}" 
+      %tr{id: entry_id, class: ldap_entry_class(entry)}
+        %td= link_to_ldap_person_entry(entry) 
+        %td= entry.first_name 
+        %td= entry.last_name 
+        %td= entry.email 
+        %td= entry.departments 
 
+:javascript
+  $('#lps-modal table').dataTable({
+    "bPaginate": false,
+    "bFilter": false,
+    "bInfo": false,
+    "oLanguage": {
+      "sEmptyTable": "No matches for your search."
+    },
+    "aaSorting": [ [1, "asc"], [2, "asc"] ],
+    "aoColumnDefs": [
+      { "bSortable": false, "aTargets": [ 0 ] },   // selection link
+      { "aDataSort": [ 1, 2 ], "aTargets": [ 1 ] }, // first name
+      { "aDataSort": [ 2, 1 ], "aTargets": [ 2 ] }, // last name
+      { "aDataSort": [ 3, 1, 2 ], "aTargets": [ 3 ] }, // department
+    ]
+  });

data/app/views/ucb_rails/lps/search.js.haml

@@ -1,2 +1,3 @@
 - results = render :partial => 'ucb_rails/lps/results'
-$('#lps-results').html('#{j results}');
+$('#lps-results').html('#{j results}');
+$('#matches').html('#{lps_matches}');

data/lib/generators/ucb_rails/templates/app/assets/javascripts/ucb_rails/lps.js

@@ -5,12 +5,12 @@ $(function() {
     $('#first_name').val('');
     $('#last_name').val('');
     $("#lps-results").empty();
+    $('#matches').empty();
   }
   
   function setHiddenField(link, dataAttribute) {
     var selector = '#' + dataAttribute;
     var value = link.data(dataAttribute);
-    
     $(selector).val(value);
   }
 
@@ -32,7 +32,6 @@ $(function() {
   // open search dialog
   $('.ldap-person-search').click(function() {
     $('#lps-modal').modal('show');
-    $('#first_name').focus();
     
     var link = $(this);
     setHiddenFields(link);
@@ -42,11 +41,10 @@ $(function() {
   // Clear button
   $('#lps-clear').click(function() {
     clearLdapPersonSearchForm();
-  }); 
+  });
 
   // modal shown
-  $("#lps-modal").on('show', function() {
-    //clearLdapPersonSearchForm();
+  $("#lps-modal").on('shown', function() {
     $("#first_name").focus();
   });
   

data/lib/generators/ucb_rails/templates/app/assets/stylesheets/ucb_rails.css.scss

@@ -25,6 +25,11 @@ table {
 #lps-modal {
   width: 750px;
   
+  .title {
+    margin-top: 10px;
+    margin-bottom: 15px;
+  }
+  
   form {
     input[type="text"] {
       width: 140px;
@@ -44,7 +49,7 @@ table {
 }
 
 div.control-group.lps-typeahead {
-  i.ldap-person-search {
+  span.ldap-person-search {
     cursor: pointer;
   }
 

data/lib/ucb_rails/version.rb

@@ -1,3 +1,3 @@
 module UcbRails
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ucb_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -208,17 +208,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bootstrap-view-helpers
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +242,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -250,7 +250,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: user_announcements
   requirement: !ruby/object:Gem::Requirement
@@ -546,6 +546,7 @@ files:
 - app/helpers/ucb_rails/lps_typeahead_helper.rb
 - app/helpers/ucb_rails/renderer/base.rb
 - app/helpers/ucb_rails/renderer/ldap_person_search_result_link.rb
+- app/helpers/ucb_rails/renderer/lps_typeahead_search_field.rb
 - app/models/ucb_rails/ldap_person/entry.rb
 - app/models/ucb_rails/ldap_person/finder.rb
 - app/models/ucb_rails/ldap_person/test_finder.rb
@@ -557,7 +558,7 @@ files:
 - app/models/ucb_rails/user_session_manager/in_people_ou.rb
 - app/models/ucb_rails/user_session_manager/in_people_ou_add_to_users_table.rb
 - app/models/ucb_rails/user_session_manager/ldap_person_user_wrapper.rb
-- app/models/ucb_rails/user_table_active.rb
+- app/models/ucb_rails/user_typeahead.rb
 - app/views/ucb_rails/admin/users/_form.html.haml
 - app/views/ucb_rails/admin/users/_user.html.haml
 - app/views/ucb_rails/admin/users/edit.html.haml

data/app/models/ucb_rails/user_table_active.rb

@@ -1,3 +0,0 @@
-class UcbRails::ActiveInUserTable
-  
-end