record_select 0.0.2 → 0.0.3

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in record_select.gemspec
+# Specify your gem's dependencies in recordselect.gemspec
 gemspec

data/README.md

@@ -1,29 +0,0 @@
-# RecordSelect
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'record_select'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install record_select
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/app/helpers/record_select_helper.rb

@@ -1,187 +1,187 @@
-module RecordSelect
-  module Helpers
-    # Print this from your layout to include everything necessary for RecordSelect to work.
-    # Well, not everything. You need Prototype too.
-    def record_select_includes
-      includes = ''
-      includes << stylesheet_link_tag('record_select/record_select')
-      includes << javascript_include_tag('record_select/record_select')
-      includes
-    end
+module RecordSelectHelper
+  # Print this from your layout to include everything necessary for RecordSelect to work.
+  # Well, not everything. You need Prototype too.
+  def record_select_includes
+    includes = ''
+    includes << stylesheet_link_tag('record_select/record_select')
+    includes << javascript_include_tag('record_select/record_select')
+    includes
+  end
 
-    # Adds a link on the page that toggles a RecordSelect widget from the given controller.
-    #
-    # *Options*
-    # +onselect+::  JavaScript code to handle selections client-side. This code has access to two variables: id, label. If the code returns false, the dialog will *not* close automatically.
-    # +params+::    Extra URL parameters. If any parameter is a column name, the parameter will be used as a search term to filter the result set.
-    def link_to_record_select(name, controller, options = {})
-      options[:params] ||= {}
-      options[:params].merge!(:controller => controller, :action => :browse)
-      options[:onselect] = "function(id, label) {#{options[:onselect]}}" if options[:onselect]
-      options[:html] ||= {}
-      options[:html][:id] ||= "rs_#{rand(9999)}"
+  # Adds a link on the page that toggles a RecordSelect widget from the given controller.
+  #
+  # *Options*
+  # +onselect+::  JavaScript code to handle selections client-side. This code has access to two variables: id, label. If the code returns false, the dialog will *not* close automatically.
+  # +params+::    Extra URL parameters. If any parameter is a column name, the parameter will be used as a search term to filter the result set.
+  def link_to_record_select(name, controller, options = {})
+    options[:params] ||= {}
+    options[:params].merge!(:controller => controller, :action => :browse)
+    options[:onselect] = "function(id, label) {#{options[:onselect]}}" if options[:onselect]
+    options[:html] ||= {}
+    options[:html][:id] ||= "rs_#{rand(9999)}"
 
-      assert_controller_responds(options[:params][:controller])
+    assert_controller_responds(options[:params][:controller])
 
-      html = link_to_function(name, '', options[:html])
-      html << javascript_tag("new RecordSelect.Dialog(#{options[:html][:id].to_json}, #{url_for(options[:params].merge(:escape => false)).to_json}, {onselect: #{options[:onselect] || ''}})")
+    html = link_to_function(name, '', options[:html])
+    html << javascript_tag("new RecordSelect.Dialog(#{options[:html][:id].to_json}, #{url_for(options[:params].merge(:escape => false)).to_json}, {onselect: #{options[:onselect] || ''}})")
 
-      return html
-    end
+    return html
+  end
 
-    # Adds a RecordSelect-based form field. The field submits the record's id using a hidden input.
-    #
-    # *Arguments*
-    # +name+:: the input name that will be used to submit the selected record's id.
-    # +current+:: the currently selected object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
-    #
-    # *Options*
-    # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
-    # +params+::      A hash of extra URL parameters
-    # +id+::          The id to use for the input. Defaults based on the input's name.
-    # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
-    def record_select_field(name, current, options = {})
-      options[:controller] ||= current.class.to_s.pluralize.underscore
-      options[:params] ||= {}
-      options[:id] ||= name.gsub(/[\[\]]/, '_')
-      options[:js_params] ||= "null"
-      options[:ass_value] = true if options[:ass_value].nil?
-
-      controller = assert_controller_responds(options[:controller])
-
-      id = label = ''
-      if options[:ass_value]
-        if current and not current.new_record?
-          id = current.id
-          label = label_for_field(current, controller)
-        end
-      else
-        id = current.object_id
-        label = current
-      end
-
-      url = url_for({:action => :browse, :controller => options[:controller], :escape => false, :format => :js}.merge(options[:params]))
-
-      html = text_field_tag(name, nil, :autocomplete => 'off', :id => options[:id], :class => options[:class],
-                            :onfocus => "this.focused=true", :onblur => "this.focused=false", :placeholder => options[:placeholder])
-      html << javascript_tag("jQuery(#{("#"+options[:id]).to_json}).recordSelectSingle(#{url.to_json}, {
-                               id: #{id.to_json},
-                               label: #{label.to_json},
-                               ass_value: #{options[:ass_value]},
-                               openEvents: #{options[:open_events].try(:to_json) || 'null'},
-                               onchange: #{options[:onchange] || ''.to_json},
-                               js_params: #{options[:js_params]}
-                             });")
-
-      return html
+  # Adds a RecordSelect-based form field. The field submits the record's id using a hidden input.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected record's id.
+  # +current+:: the currently selected object. provide a new record if there're none currently selected and you have not passed the optional :controller argument.
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set. Optional if you have standard resource controllers (e.g. UsersController for the User model), in which case the controller will be inferred from the class of +current+ (the second argument)
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  # +onchange+::    A JavaScript function that will be called whenever something new is selected. It should accept the new id as the first argument, and the new label as the second argument. For example, you could set onchange to be "function(id, label) {alert(id);}", or you could create a JavaScript function somewhere else and set onchange to be "my_function" (without the parantheses!).
+  def record_select_field(name, current, options = {})
+    options[:controller] ||= current.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
+
+    controller = assert_controller_responds(options[:controller])
+
+    id = label = ''
+    if current and not current.new_record?
+      id = current.id
+      label = label_for_field(current, controller)
     end
 
-    # Assists with the creation of an observer for the :onchange option of the record_select_field method.
-    # Currently only supports building an Ajax.Request based on the id of the selected record.
-    #
-    # options[:url] should be a hash with all the necessary options *except* :id. that parameter
-    # will be provided based on the selected record.
-    #
-    # Question: if selecting users, what's more likely?
-    #   /users/5/categories
-    #   /categories?user_id=5
-    def record_select_observer(options = {})
-      fn =  "function(id, value) {"
-      fn <<   "var url = #{url_for(options[:url].merge(:id => ":id:")).to_json}.replace(/:id:/, id);"
-      fn <<   "jQuery.get(url);"
-      fn << "}"
-    end
+    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
 
-    # Adds a RecordSelect-based form field for multiple selections. The values submit using a list of hidden inputs.
-    #
-    # *Arguments*
-    # +name+:: the input name that will be used to submit the selected records' ids. empty brackets will be appended to the name.
-    # +current+:: pass a collection of existing associated records
-    #
-    # *Options*
-    # +controller+::  The controller configured to provide the result set.
-    # +params+::      A hash of extra URL parameters
-    # +id+::          The id to use for the input. Defaults based on the input's name.
-    def record_multi_select_field(name, current, options = {})
-      options[:controller] ||= current.first.class.to_s.pluralize.underscore
-      options[:params] ||= {}
-      options[:id] ||= name.gsub(/[\[\]]/, '_')
+    html = text_field_tag(name, nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
+    html << javascript_tag("$(#{options[:id].to_json}).singleRecordSelect(#{url.to_json}, {id: #{id.to_json}, label: #{label.to_json}, onchange: #{options[:onchange] || ''.to_json}});")
 
-      controller = assert_controller_responds(options[:controller])
+    return html
+  end
 
-      current = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
+  # Assists with the creation of an observer for the :onchange option of the record_select_field method.
+  # Currently only supports building an Ajax.Request based on the id of the selected record.
+  #
+  # options[:url] should be a hash with all the necessary options *except* :id. that parameter
+  # will be provided based on the selected record.
+  #
+  # Question: if selecting users, what's more likely?
+  #   /users/5/categories
+  #   /categories?user_id=5
+  def record_select_observer(options = {})
+    fn = ""
+    fn << "function(id, value) {"
+    fn <<   "var url = #{url_for(options[:url].merge(:id => ":id:")).to_json}.replace(/:id:/, id);"
+    fn <<   "jQuery.get(url);"
+    fn << "}"
+  end
 
-      url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+  # Adds a RecordSelect-based form field for multiple selections. The values submit using a list of hidden inputs.
+  #
+  # *Arguments*
+  # +name+:: the input name that will be used to submit the selected records' ids. empty brackets will be appended to the name.
+  # +current+:: pass a collection of existing associated records
+  #
+  # *Options*
+  # +controller+::  The controller configured to provide the result set.
+  # +params+::      A hash of extra URL parameters
+  # +id+::          The id to use for the input. Defaults based on the input's name.
+  def record_multi_select_field(name, current, options = {})
+    options[:controller] ||= current.first.class.to_s.pluralize.underscore
+    options[:params] ||= {}
+    options[:id] ||= name.gsub(/[\[\]]/, '_')
 
-      html = text_field_tag("#{name}[]", nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
-      html << content_tag('ul', '', :class => 'record-select-list');
-      html << javascript_tag("new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, {current: #{current.to_json}});")
+    controller = assert_controller_responds(options[:controller])
 
-      return html
-    end
+    current = current.inject([]) { |memo, record| memo.push({:id => record.id, :label => label_for_field(record, controller)}) }
+
+    url = url_for({:action => :browse, :controller => options[:controller], :escape => false}.merge(options[:params]))
+
+    html = text_field_tag("#{name}[]", nil, :autocomplete => 'off', :id => options[:id], :class => options[:class], :onfocus => "this.focused=true", :onblur => "this.focused=false")
+    html << content_tag('ul', '', :class => 'record-select-list');
+    html << javascript_tag("new RecordSelect.Multiple(#{options[:id].to_json}, #{url.to_json}, {current: #{current.to_json}});")
+
+    return html
+  end
 
-    # A helper to render RecordSelect partials
-    def render_record_select(file, options = {}) #:nodoc:
-      options[:file] = controller.send(:record_select_path_of, file)
-      options[:use_full_path] = false
+  # A helper to render RecordSelect partials
+  def render_record_select(options = {}) #:nodoc:
+    controller.send(:render_record_select, options) do |options|
       render options
     end
+  end
 
-    # Provides view access to the RecordSelect configuration
-    def record_select_config #:nodoc:
-      controller.send :record_select_config
-    end
+  # Provides view access to the RecordSelect configuration
+  def record_select_config #:nodoc:
+    controller.send :record_select_config
+  end
 
-    # The id of the RecordSelect widget for the given controller.
-    def record_select_id(controller = nil) #:nodoc:
-      controller ||= params[:controller]
-      "record-select-#{controller.gsub('/', '_')}"
-    end
+  # The id of the RecordSelect widget for the given controller.
+  def record_select_id(controller = nil) #:nodoc:
+    controller ||= params[:controller]
+    "record-select-#{controller.gsub('/', '_')}"
+  end
 
-    def record_select_search_id(controller = nil) #:nodoc:
-      "#{record_select_id(controller)}-search"
+  def record_select_search_id(controller = nil) #:nodoc:
+    "#{record_select_id(controller)}-search"
+  end
+
+  private
+  # render the record using the renderer and add a link to select the record
+  def render_record_in_list(record, controller_path)
+    text = render_record_from_config(record)
+    if record_select_config.link?
+      url_params = {:controller => controller_path, :action => :select, :id => record.id, :escape => false}
+      link_to_remote text, {
+          :url => url_params,
+          :method => :post,
+          :before => 'jQuery(this).toggleClass("selected")',
+          :condition => "jQuery(this).recordSelect_notify()"
+        }, :href => url_params
+    else
+      text
     end
+  end
 
-    private
 
-    # uses renderer (defaults to record_select_config.label) to determine how the given record renders.
-    def render_record_from_config(record, renderer = record_select_config.label)
-      case renderer
-        when Symbol, String
-        # return full-html from the named partial
-        render :partial => renderer.to_s, :locals => {:record => record}
+  # uses renderer (defaults to record_select_config.label) to determine how the given record renders.
+  def render_record_from_config(record, renderer = record_select_config.label)
+    case renderer
+    when Symbol, String
+      # return full-html from the named partial
+      render :partial => renderer.to_s, :locals => {:record => record}
 
-        when Proc
-        # return an html-cleaned descriptive string
-        h renderer.call(record)
-      end
+    when Proc
+      # return an html-cleaned descriptive string
+      h renderer.call(record)
     end
+  end
 
-    # uses the result of render_record_from_config to snag an appropriate record label
-    # to display in a field.
-    #
-    # if given a controller, searches for a partial in its views path
-    def label_for_field(record, controller = self.controller)
-      renderer = controller.record_select_config.label
-      case renderer
-        when Symbol, String
-        # find the <label> element and grab its innerHTML
-        description = render_record_from_config(record, File.join(controller.controller_path, renderer.to_s))
-        description.match(/<label[^>]*>(.*)<\/label>/)[1]
-
-        when Proc
-        # just return the string
-        render_record_from_config(record, renderer)
-      end
+  # uses the result of render_record_from_config to snag an appropriate record label
+  # to display in a field.
+  #
+  # if given a controller, searches for a partial in its views path
+  def label_for_field(record, controller = self.controller)
+    renderer = controller.record_select_config.label
+    case renderer
+    when Symbol, String
+      # find the <label> element and grab its innerHTML
+      description = render_record_from_config(record, File.join(controller.controller_path, renderer.to_s))
+      description.match(/<label[^>]*>(.*)<\/label>/)[1]
+
+    when Proc
+      # just return the string
+      render_record_from_config(record, renderer)
     end
+  end
 
-    def assert_controller_responds(controller_name)
-      controller_name = "#{controller_name.camelize}Controller"
-      controller = controller_name.constantize
-      unless controller.uses_record_select?
-        raise "#{controller_name} has not been configured to use RecordSelect."
-      end
-      controller
+  def assert_controller_responds(controller_name)
+    controller_name = "#{controller_name.camelize}Controller"
+    controller = controller_name.constantize
+    unless controller.uses_record_select?
+      raise "#{controller_name} has not been configured to use RecordSelect."
     end
+    controller
   end
 end

data/init.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/lib/localization'
 require File.dirname(__FILE__) + '/lib/extensions/active_record'
 
 ActionController::Base.send(:include, RecordSelect)
-ActionView::Base.send(:include, RecordSelectHelper)
+ActionView::Base.send(:include, RecordSelect::Helpers)
 ActionView::Helpers::FormBuilder.send(:include, RecordSelect::FormBuilder)
 
 ['stylesheets', 'images', 'javascripts'].each do |asset_type|

data/lib/recordselect_custom.rb

@@ -0,0 +1,33 @@
+module RecordSelect
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    # Enables and configures RecordSelect on your controller.
+    #
+    # *Options*
+    # +model+::     defaults based on the name of the controller
+    # +per_page+::  records to show per page when browsing
+    # +notify+::    a method name to invoke when a record has been selected.
+    # +order_by+::  a SQL string to order the search results
+    # +search_on+:: an array of searchable fields
+    # +full_text_search+::  a boolean for whether to use a %?% search pattern or not. default is false.
+    # +label+::     a proc that accepts a record as argument and returns an option label. default is to call record.to_label instead.
+    # +include+::   as for ActiveRecord::Base#find. can help with search conditions or just help optimize rendering the results.
+    #
+    # You may also pass a block, which will be used as options[:notify].
+    def record_select(options = {})
+      options[:model] ||= self.to_s.split('::').last.sub(/Controller$/, '').pluralize.singularize.underscore
+      @record_select_config = RecordSelect::Config.new(options.delete(:model), options)
+      self.send :include, RecordSelect::Actions
+      self.send :include, RecordSelect::Conditions
+    end
+
+    attr_reader :record_select_config
+
+    def uses_record_select?
+      !record_select_config.nil?
+    end
+  end
+end

data/lib/recordselect_custom/version.rb

@@ -0,0 +1,3 @@
+module RecordselectCustom
+  VERSION = "0.0.3"
+end

data/{record_select.gemspec → recordselect_custom.gemspec}

@@ -5,11 +5,11 @@ require 'record_select/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "record_select"
-  gem.version       = RecordSelect::VERSION
+  gem.version       = RecordselectCustom::VERSION
   gem.authors       = ["lion"]
   gem.email         = ["lion3139@gmail.com"]
-  gem.description   = %q{just test}
-  gem.summary       = %q{just test}
+  gem.description   = %q{just for test}
+  gem.summary       = %q{just for test}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: record_select
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - lion
@@ -19,7 +19,7 @@ date: 2014-12-17 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
-description: just test
+description: just for test
 email: 
 - lion3139@gmail.com
 executables: []
@@ -59,13 +59,14 @@ files:
 - lib/record_select/config.rb
 - lib/record_select/form_builder.rb
 - lib/record_select/helpers.rb
-- lib/record_select/version.rb
+- lib/recordselect_custom.rb
+- lib/recordselect_custom/version.rb
 - lib/views/_browse.html
 - lib/views/_browse.rhtml
 - lib/views/_list.rhtml
 - lib/views/_search.rhtml
 - lib/views/browse.rjs
-- record_select.gemspec
+- recordselect_custom.gemspec
 - test/recordselect_test.rb
 - uninstall.rb
 has_rdoc: true
@@ -101,6 +102,6 @@ rubyforge_project:
 rubygems_version: 1.3.9.5
 signing_key: 
 specification_version: 3
-summary: just test
+summary: just for test
 test_files: 
 - test/recordselect_test.rb

data/lib/record_select/version.rb

@@ -1,3 +0,0 @@
-module RecordSelect
-  VERSION = "0.0.2"
-end