calendar_date_select 1.12 → 1.13

data/History.txt

@@ -1,3 +1,15 @@
+ == Version 1.13
+ * Lots of code clean up!
+ * Moved test suite over to rspec
+ * CalendarDateSelect.default_options implemented.  Use CalendarDateSelect.default_options.update(...) to set the default_options for your app.
+ * calendar_date_select and calendar_date_select_tag accept an :image parameter.
+ * Backwards compatibility hook for Rails 2.1
+ * RDOC!
+ * Don't try to focus a hidden or disabled element (closes #129 - thanks Bruno)
+ * Call onchange callback when clearing the calendar (closes #137 - thanks Chewi)
+ * Fixed issue that made :db format worthless (closes #135, thanks Andreas Zecher)
+ * dramatic optimization for calendar initial-rendering (thanks Yehudab, Bompus)
+
 == Version 1.12 ==
  * Updated for compatibility with Rails 2.2
  

data/Manifest.txt

@@ -7,6 +7,7 @@ js_test/unit/cds_helper_methods.html
 js_test/unittest.js
 lib/calendar_date_select/calendar_date_select.rb
 lib/calendar_date_select/includes_helper.rb
+lib/calendar_date_select/form_helpers.rb
 lib/calendar_date_select.rb
 Manifest.txt
 MIT-LICENSE
@@ -34,6 +35,8 @@ public/stylesheets/calendar_date_select/red.css
 public/stylesheets/calendar_date_select/silver.css
 Rakefile
 Readme.txt
-test/functional/calendar_date_select_test.rb
-test/functional/helper_methods_test.rb
-test/test_helper.rb
+spec/
+spec/calendar_date_select
+spec/calendar_date_select/calendar_date_select_spec.rb
+spec/calendar_date_select/form_helpers_spec.rb
+spec/spec_helper.rb

data/lib/calendar_date_select.rb

@@ -1,17 +1,26 @@
 require "calendar_date_select/calendar_date_select.rb"
+require "calendar_date_select/form_helpers.rb"
 require "calendar_date_select/includes_helper.rb"
 
 if Object.const_defined?(:Rails) && File.directory?(Rails.root + "/public")
-  ActionView::Helpers::FormHelper.send(:include, CalendarDateSelect::FormHelper)
-  ActionView::Base.send(:include, CalendarDateSelect::FormHelper)
+  ActionView::Helpers::FormHelper.send(:include, CalendarDateSelect::FormHelpers)
+  ActionView::Base.send(:include, CalendarDateSelect::FormHelpers)
   ActionView::Base.send(:include, CalendarDateSelect::IncludesHelper)
-
+  
+  # Filthy backwards compatibility hooks... grumble
   if ([Rails::VERSION::MAJOR, Rails::VERSION::MINOR] <=> [2, 2]) == -1
-    puts "This version of calendar date select (#{CalendarDateSelect.version}) requires Rails 2.2"
-    puts "To use an earlier version of rails, use calendar_date_select version 1.11.x"
-    exit
-  end
+    ActionView::Helpers::InstanceTag.class_eval do
+      def self.new_with_backwards_compatibility(object_name, method_name, template_object, object = nil)
+        new(object_name, method_name, template_object, nil, object)
+      end
+    end
     
+  else
+    ActionView::Helpers::InstanceTag.class_eval do
+      class << self; alias new_with_backwards_compatibility new; end
+    end
+  end
+
   # install files
   unless File.exists?(RAILS_ROOT + '/public/javascripts/calendar_date_select/calendar_date_select.js')
     ['/public', '/public/javascripts/calendar_date_select', '/public/stylesheets/calendar_date_select', '/public/images/calendar_date_select', '/public/javascripts/calendar_date_select/locale'].each do |dir|

data/lib/calendar_date_select/calendar_date_select.rb

@@ -1,5 +1,5 @@
-class CalendarDateSelect
-  VERSION = '1.12'
+module CalendarDateSelect
+  VERSION = '1.13'
   FORMATS = {
     :natural => {
       :date => "%B %d, %Y",
@@ -11,10 +11,10 @@ class CalendarDateSelect
       :javascript_include => "format_hyphen_ampm"
     },
     :iso_date => {
-      :date => "%Y-%m-%d", 
+      :date => "%Y-%m-%d",
       :time => " %H:%M",
       :javascript_include => "format_iso_date"
-    }, 
+    },
     :finnish => {
       :date => "%d.%m.%Y",
       :time => " %H:%M",
@@ -27,12 +27,12 @@ class CalendarDateSelect
     },
     :euro_24hr => {
       :date => "%d %B %Y",
-      :time => " %H:%M", 
+      :time => " %H:%M",
       :javascript_include => "format_euro_24hr"
     },
     :euro_24hr_ymd => {
       :date => "%Y.%m.%d",
-      :time => " %H:%M", 
+      :time => " %H:%M",
       :javascript_include => "format_euro_24hr_ymd"
     },
     :italian => {
@@ -42,182 +42,75 @@ class CalendarDateSelect
     },
     :db => {
       :date => "%Y-%m-%d",
-      :time => "%H:%M",
+      :time => " %H:%M",
       :javascript_include => "format_db"
     }
   }
-  
-  cattr_accessor :image
-  @@image = "calendar_date_select/calendar.gif"
-  
-  cattr_reader :format
-  @@format = FORMATS[:natural]
-  
-  class << self
-    def format=(format)
-      raise "CalendarDateSelect: Unrecognized format specification: #{format}" unless FORMATS.has_key?(format)
-      @@format = FORMATS[format]
-    end
-    
-    def javascript_format_include
-      @@format[:javascript_include] && "calendar_date_select/#{@@format[:javascript_include]}"
-    end
-    
-    def date_format_string(time=false)
-      @@format[:date] + ( time ? @@format[:time] : "" )
-    end
-    
-    def format_date(date)
-      if Date===date
-        date.strftime(date_format_string(false))
-      else
-        date.strftime(date_format_string(true))
-      end
-    end
-    
-    def has_time?(value)
-      /[0-9]:[0-9]{2}/.match(value.to_s)
-    end
+
+  # Returns the default_options hash.  These options are by default provided to every calendar_date_select control, unless otherwise overrided.
+  # 
+  # Example:
+  #   # At the bottom of config/environment.rb:
+  #   CalendarDateSelect.default_options.update(
+  #     :popup => "force",
+  #     :month_year => "label",
+  #     :image => "custom_calendar_picker.png"
+  #   )
+  def self.default_options
+    @default_options ||= { :image => "calendar_date_select/calendar.gif" }
   end
-  
-  module FormHelper
-    def calendar_date_select_tag( name, value = nil, options = {})
-      calendar_options = calendar_date_select_process_options(options)
-      value = format_time(value, calendar_options)
-      
-      calendar_options.delete(:format)
-      
-      options[:id] ||= name
-      tag = calendar_options[:hidden] || calendar_options[:embedded] ? 
-        hidden_field_tag(name, value, options) :
-        text_field_tag(name, value, options)
-      
-      calendar_date_select_output(tag, calendar_options)
-    end
-    
-    def format_time(value, options = {})
-      if value.respond_to?("strftime")
-        if options[:format]
-          value = value.strftime(options[:format])
-        else
-          if options.has_key? :time
-            value = value.strftime(CalendarDateSelect.date_format_string(options[:time]))
-          else
-            value = CalendarDateSelect.format_date(value)
-          end
-        end
-      end
-      value
-   end
-    
-    # extracts any options passed into calendar date select, appropriating them to either the Javascript call or the html tag.
-    def calendar_date_select_process_options(options)
-      calendar_options = {}
-      callbacks = [:before_show, :before_close, :after_show, :after_close, :after_navigate]
-      for key in [:time, :valid_date_check, :embedded, :buttons, :clear_button, :format, :year_range, :month_year, :popup, :hidden, :minute_interval] + callbacks
-        calendar_options[key] = options.delete(key) if options.has_key?(key)
-      end
-      
-      # if passing in mixed, pad it with single quotes
-      calendar_options[:time] = "'mixed'" if calendar_options[:time].to_s=="mixed"
-      calendar_options[:month_year] = "'#{calendar_options[:month_year]}'" if calendar_options[:month_year]
-      
-      # if we are forcing the popup, automatically set the readonly property on the input control.
-      if calendar_options[:popup].to_s == "force"
-        calendar_options[:popup] = "'force'"
-        options[:readonly] = true 
-      end
-      
-      if (vdc=calendar_options.delete(:valid_date_check))
-        if vdc.include?(";") || vdc.include?("function")
-          throw ":valid_date_check function is missing a 'return' statement.  Try something like: :valid_date_check => 'if (date > new(Date)) return true; else return false;'" unless vdc.include?("return");
-        end
-        
-        vdc = "return(#{vdc})" unless vdc.include?("return")
-        vdc = "function(date) { #{vdc} }" unless vdc.include?("function")
-        calendar_options[:valid_date_check] = vdc
-      end
-      
-      calendar_options[:popup_by] ||= "this" if calendar_options[:hidden]
-      
-      # surround any callbacks with a function, if not already done so
-      for key in callbacks
-        calendar_options[key] = "function(param) { #{calendar_options[key]} }" unless calendar_options[key].include?("function") if calendar_options[key]
-      end
-      
-      calendar_options[:year_range] = format_year_range(calendar_options[:year_range] || 10)
-      calendar_options
-    end
-    
-    def calendar_date_select(object, method, options={})
-      obj = options[:object] || instance_variable_get("@#{object}")
-      
-      if !options.include?(:time) && obj.class.respond_to?("columns_hash")
-        column_type = (obj.class.columns_hash[method.to_s].type rescue nil)
-        options[:time] = true if column_type == :datetime
-      end
-      
-      use_time = options[:time]
-      
-      if options[:time].to_s=="mixed"
-        use_time = false if Date===(obj.respond_to?(method) && obj.send(method))
-      end
-      
-      calendar_options = calendar_date_select_process_options(options)
-      
-      options[:value] ||= 
-        if(obj.respond_to?(method) && obj.send(method).respond_to?(:strftime))
-          obj.send(method).strftime(CalendarDateSelect.date_format_string(use_time))
-        elsif obj.respond_to?("#{method}_before_type_cast") 
-          obj.send("#{method}_before_type_cast")
-        elsif obj.respond_to?(method)
-          obj.send(method).to_s
-        else
-          nil
-        end
 
-      tag = ActionView::Helpers::InstanceTag.new(object, method, self, options.delete(:object))
-      calendar_date_select_output(
-        tag.to_input_field_tag( (calendar_options[:hidden] || calendar_options[:embedded]) ? "hidden" : "text", options), 
-        calendar_options
-      )
-    end  
-    
-    def calendar_date_select_output(input, calendar_options = {})
-      out = input
-      if calendar_options[:embedded]
-        uniq_id = "cds_placeholder_#{(rand*100000).to_i}"
-        # we need to be able to locate the target input element, so lets stick an invisible span tag here we can easily locate
-        out << content_tag(:span, nil, :style => "display: none; position: absolute;", :id => uniq_id)
-        
-        out << javascript_tag("new CalendarDateSelect( $('#{uniq_id}').previous(), #{options_for_javascript(calendar_options)} ); ")
-      else
-        out << " "
-        
-        out << image_tag(CalendarDateSelect.image, 
-            :onclick => "new CalendarDateSelect( $(this).previous(), #{options_for_javascript(calendar_options)} );",
-            :style => 'border:0px; cursor:pointer;')
-      end
-      
-      out
-    end
-    
-  private
-    def format_year_range(year) # nodoc
-      return year unless year.respond_to?(:first)
-      return "[#{year.first}, #{year.last}]" unless year.first.respond_to?(:strftime)
-      return "[#{year.first.year}, #{year.last.year}]"
+  # Set the picker image.  Provide the image url the same way you would provide it to image_tag
+  def self.image=(value)
+    default_options[:image] = value
+  end
+
+  # Returns the options for the given format
+  #
+  # Example:
+  #   CalendarDateSelect.format = :italian
+  #   puts CalendarDateSelect.format[:date]
+  #     => "%d/%m/%Y"
+  def self.format
+    @format ||= FORMATS[:natural]
+  end
+
+  # Set the format.  To see a list of available formats, CalendarDateSelect::FORMATS.keys, or open lib/calendar_date_select/calendar_date_select.rb
+  #
+  # (e.g. CalendarDateSelect.format = :italian)
+  def self.format=(format)
+    raise "CalendarDateSelect: Unrecognized format specification: #{format}" unless FORMATS.has_key?(format)
+    @format = FORMATS[format]
+  end
+
+  def self.date_format_string(time = false)
+    format[:date] + (time ? format[:time] : "")
+  end
+
+  def self.format_date(date)
+    if date.is_a?(Date)
+      date.strftime(date_format_string(false))
+    else
+      date.strftime(date_format_string(true))
     end
   end
-end
 
+  def self.format_time(value, options = {})
+    return value unless value.respond_to?("strftime")
+    if options[:time]
+      format_date(value)
+    else
+      format_date(value.to_date)
+    end
+  end
 
-module ActionView
-  module Helpers
-    class FormBuilder
-      def calendar_date_select(method, options = {})
-        @template.calendar_date_select(@object_name, method, options.merge(:object => @object))
-      end
+  # Detects the presence of time in a date, string
+  def self.has_time?(value)
+    case value
+    when DateTime, Time then true
+    when Date           then false
+    else
+      /[0-9]:[0-9]{2}/.match(value.to_s) ? true : false
     end
   end
 end

data/lib/calendar_date_select/form_helpers.rb

@@ -0,0 +1,222 @@
+# Various helpers available for use in your view
+module CalendarDateSelect::FormHelpers
+  
+  # Similar to text_field_tag, but adds a calendar picker, naturally.
+  #
+  # == Arguments
+  #
+  #   +name+ - the html name of the tag
+  #   +value+ - When specified as a string, uses value verbatim.  When Date, DateTime, Time, it converts it to a string basd off the format set by CalendarDateSelect#format=
+  #   +options+ - ...
+  #
+  # == Options
+  # 
+  # === :embedded
+  # 
+  # Put the calendar straight into the form, rather than using a popup type of form.
+  # 
+  #   <%= calendar_date_select_tag "name", "2007-01-01", :embedded => true %>
+  # 
+  # === :hidden
+  # 
+  # Use a hidden element instead of a text box for a pop up calendar.  Not compatible with :embedded => true.  You'll probably want to use an onchange callback to do something with the value.
+  # 
+  #   <span id='cds_value' /> 
+  #   <%= calendar_date_select_tag "hidden_date_selector", "", :hidden => "true", :onchange => "$('cds_value').update($F(this));" %>
+  # 
+  # === :image
+  # 
+  # Specify an alternative icon to use for the date picker.
+  # 
+  # To use /images/groovy.png:
+  # 
+  #   <%= calendar_date_select_tag "altered_image", "", :image => "groovy.png" %>
+  # 
+  # === :minute_interval
+  # 
+  # Specifies the minute interval used in the hour/minute selector.  Default is 5.
+  # 
+  #   <%= calendar_date_select_tag "month_year_selector_label", "", :minute_interval => 15 %>
+  # 
+  # === :month_year
+  # 
+  # Customize the month and year selectors at the top of the control.
+  # 
+  # Valid values:
+  #  * "dropdowns" (default) - Use a separate dropdown control for both the month and year
+  #  * "label" - Use static text to show the month and the year.
+  # 
+  #    <%= calendar_date_select_tag "month_year_selector_label", "", :month_year => "label" %>
+  # 
+  # === :popup => 'force'
+  # 
+  # Forces the user to use the popup calendar by making it's text-box read-only and causing calendar_date_select to override it's default behavior of not allowing selection of a date on a target element that is read-only.
+  # 
+  #   <%= calendar_date_select_tag "name", "2007-01-01", :popup => "force" %>
+  # 
+  # === :time
+  # 
+  # Show time in the controls.  There's three options:
+  # 
+  #  * +true+ - show an hour/minute selector.
+  #  * +false+ - don't show an hour/minute selector.
+  #  * +"mixed"+ - Show an hour/minute selector, but include a "all day" option - allowing them to choose whether or not to specify a time.
+  # 
+  # === :year_range
+  # 
+  # Limit the year range.  You can pass in an array or range of ruby Date/Time objects or FixNum's.
+  # 
+  #   <%= calendar_date_select_tag "e_date", nil, :year_range => 10.years.ago..0.years.from_now %>
+  #   <%= calendar_date_select_tag "e_date", nil, :year_range => [0.years.ago, 10.years.from_now] %>
+  #   <%= calendar_date_select_tag "e_date", nil, :year_range => 2000..2007 %>
+  #   <%= calendar_date_select_tag "e_date", nil, :year_range => [2000, 2007] %>
+  # 
+  # == CALLBACKS
+  # 
+  # The following callbacks are available:
+  # 
+  #  * before_show / after_show
+  #  * before_close / after_close
+  #  * after_navigate - Called when navigating to a different month. Passes first parameter as a date object refering to the current month viewed
+  #  * onchange - Called when the form input value changes 
+  # 
+  #   <%= calendar_date_select_tag "event_demo", "", 
+  #     :before_show => "log('Calendar Showing');" ,
+  #     :after_show => "log('Calendar Shown');" ,
+  #     :before_close => "log('Calendar closing');" ,
+  #     :after_close => "log('Calendar closed');",
+  #     :after_navigate => "log('Current month is ' + (param.getMonth()+1) + '/' + (param.getFullYear()));",
+  #     :onchange => "log('value changed to - ' + $F(this));"
+  # 
+  # }}}
+  # 
+  # All callbacks are executed within the context of the target input element.  If you'd like to access the CalendarDateSelect object itself, you can access it via "this.calendar_date_select".
+  # 
+  # For example:
+  # 
+  #   <%= calendar_date_select_tag "event_demo", "", :after_navigate => "alert('The current selected month is ' + this.calendar_date_select.selected_date.getMonth());" ,
+  def calendar_date_select_tag( name, value = nil, options = {})
+    options, javascript_options = calendar_date_select_process_options(options)
+    value = CalendarDateSelect.format_time(value, javascript_options)
+
+    javascript_options.delete(:format)
+
+    options[:id] ||= name
+    tag = javascript_options[:hidden] || javascript_options[:embedded] ?
+      hidden_field_tag(name, value, options) :
+      text_field_tag(name, value, options)
+
+    calendar_date_select_output(tag, options, javascript_options)
+  end
+
+  # Similar to the difference between +text_field_tag+ and +text_field+, this method behaves like +text_field+
+  #
+  # It receives the same options as +calendar_date_select_tag+.  Need for time selection is automatically detected by checking the corresponding column meta information of Model#columns_hash
+  def calendar_date_select(object, method, options={})
+    obj = options[:object] || instance_variable_get("@#{object}")
+
+    if !options.include?(:time) && obj.class.respond_to?("columns_hash")
+      column_type = (obj.class.columns_hash[method.to_s].type rescue nil)
+      options[:time] = true if column_type == :datetime
+    end
+
+    use_time = options[:time]
+
+    if options[:time].to_s=="mixed"
+      use_time = false if Date===(obj.respond_to?(method) && obj.send(method))
+    end
+
+    options, javascript_options = calendar_date_select_process_options(options)
+
+    options[:value] ||=
+      if(obj.respond_to?(method) && obj.send(method).respond_to?(:strftime))
+        obj.send(method).strftime(CalendarDateSelect.date_format_string(use_time))
+      elsif obj.respond_to?("#{method}_before_type_cast")
+        obj.send("#{method}_before_type_cast")
+      elsif obj.respond_to?(method)
+        obj.send(method).to_s
+      else
+        nil
+      end
+
+    tag = ActionView::Helpers::InstanceTag.new_with_backwards_compatibility(object, method, self, options.delete(:object))
+    calendar_date_select_output(
+      tag.to_input_field_tag( (javascript_options[:hidden] || javascript_options[:embedded]) ? "hidden" : "text", options),
+      options,
+      javascript_options
+    )
+  end
+
+  private
+    # extracts any options passed into calendar date select, appropriating them to either the Javascript call or the html tag.
+    def calendar_date_select_process_options(options)
+      options, javascript_options = CalendarDateSelect.default_options.merge(options), {}
+      callbacks = [:before_show, :before_close, :after_show, :after_close, :after_navigate]
+      for key in [:time, :valid_date_check, :embedded, :buttons, :clear_button, :format, :year_range, :month_year, :popup, :hidden, :minute_interval] + callbacks
+        javascript_options[key] = options.delete(key) if options.has_key?(key)
+      end
+
+      # if passing in mixed, pad it with single quotes
+      javascript_options[:time] = "'mixed'" if javascript_options[:time].to_s=="mixed"
+      javascript_options[:month_year] = "'#{javascript_options[:month_year]}'" if javascript_options[:month_year]
+
+      # if we are forcing the popup, automatically set the readonly property on the input control.
+      if javascript_options[:popup].to_s == "force"
+        javascript_options[:popup] = "'force'"
+        options[:readonly] = true
+      end
+
+      if (vdc=javascript_options.delete(:valid_date_check))
+        if vdc.include?(";") || vdc.include?("function")
+          raise ArgumentError, ":valid_date_check function is missing a 'return' statement.  Try something like: :valid_date_check => 'if (date > new(Date)) return true; else return false;'" unless vdc.include?("return");
+        end
+
+        vdc = "return(#{vdc})" unless vdc.include?("return")
+        vdc = "function(date) { #{vdc} }" unless vdc.include?("function")
+        javascript_options[:valid_date_check] = vdc
+      end
+
+      javascript_options[:popup_by] ||= "this" if javascript_options[:hidden]
+
+      # surround any callbacks with a function, if not already done so
+      for key in callbacks
+        javascript_options[key] = "function(param) { #{javascript_options[key]} }" unless javascript_options[key].include?("function") if javascript_options[key]
+      end
+
+      javascript_options[:year_range] = format_year_range(javascript_options[:year_range] || 10)
+      [options, javascript_options]
+    end
+
+    def calendar_date_select_output(input, options = {}, javascript_options = {})
+      out = input
+      if javascript_options[:embedded]
+        uniq_id = "cds_placeholder_#{(rand*100000).to_i}"
+        # we need to be able to locate the target input element, so lets stick an invisible span tag here we can easily locate
+        out << content_tag(:span, nil, :style => "display: none; position: absolute;", :id => uniq_id)
+        out << javascript_tag("new CalendarDateSelect( $('#{uniq_id}').previous(), #{options_for_javascript(javascript_options)} ); ")
+      else
+        out << " "
+        out << image_tag(options[:image],
+            :onclick => "new CalendarDateSelect( $(this).previous(), #{options_for_javascript(javascript_options)} );",
+            :style => 'border:0px; cursor:pointer;')
+      end
+      out
+    end
+
+    def format_year_range(year) # nodoc
+      return year unless year.respond_to?(:first)
+      return "[#{year.first}, #{year.last}]" unless year.first.respond_to?(:strftime)
+      return "[#{year.first.year}, #{year.last.year}]"
+    end
+end
+
+# Helper method for form builders
+module ActionView
+  module Helpers
+    class FormBuilder
+      def calendar_date_select(method, options = {})
+        @template.calendar_date_select(@object_name, method, options.merge(:object => @object))
+      end
+    end
+  end
+end

data/lib/calendar_date_select/includes_helper.rb

@@ -1,38 +1,29 @@
-class CalendarDateSelect
-  module IncludesHelper
-    def calendar_date_select_stylesheets(options = {})
-      options.assert_valid_keys(:style, :format, :locale)
-      
-      style = options[:style]
-      cds_css_file = style ? "calendar_date_select/#{style}" : "calendar_date_select/default"
-      return cds_css_file
-    end
-
-    def calendar_date_select_javascripts(options = {})
-      options.assert_valid_keys(:style, :format, :locale)
-      
-      style = options[:style]
-      locale = options[:locale]
-      cds_css_file = style ? "calendar_date_select/#{style}" : "calendar_date_select/default"
-      
-      output = []
-      output << "calendar_date_select/calendar_date_select"
-      output << "calendar_date_select/locale/#{locale}" if locale
-      output << CalendarDateSelect.javascript_format_include if CalendarDateSelect.javascript_format_include
-      return output
-    end
+module CalendarDateSelect::IncludesHelper
+  # returns the selected calendar_date_select stylesheet (not an array)
+  def calendar_date_select_stylesheets(options = {})
+    options.assert_valid_keys(:style)
+    "calendar_date_select/#{options[:style] || "default"}"
+  end
 
-    def calendar_date_select_includes(*args)
-      return "" if @cds_already_included
-      @cds_already_included=true
-      
-      options = (Hash === args.last) ? args.pop : {}
-      options.assert_valid_keys(:style, :format, :locale)
-      options[:style] ||= args.shift
+  # returns an array of javascripts needed for the selected locale, date_format, and calendar control itself.
+  def calendar_date_select_javascripts(options = {})
+    options.assert_valid_keys(:format, :locale)
+    files = ["calendar_date_select/calendar_date_select"]
+    files << "calendar_date_select/locale/#{options[:locale]}" if options[:locale]
+    files << "calendar_date_select/#{CalendarDateSelect.format[:javascript_include]}" if CalendarDateSelect.format[:javascript_include]
+    files
+  end
 
-      js = javascript_include_tag(*calendar_date_select_javascripts(options))
-      css = stylesheet_link_tag(*calendar_date_select_stylesheets(options))
-      "#{js}\n#{css}\n"
-    end
+  # returns html necessary to load javascript and css to make calendar_date_select work
+  def calendar_date_select_includes(*args)
+    return "" if @cds_already_included
+    @cds_already_included=true
+    
+    options = (Hash === args.last) ? args.pop : {}
+    options.assert_valid_keys(:style, :format, :locale)
+    options[:style] ||= args.shift
+    
+    javascript_include_tag(*calendar_date_select_javascripts(:locale => options[:locale], :format => options[:format])) + "\n" +
+    stylesheet_link_tag(*calendar_date_select_stylesheets(:style => options[:style])) + "\n"
   end
 end

data/public/javascripts/calendar_date_select/calendar_date_select.js

@@ -1,4 +1,4 @@
-// CalendarDateSelect version 1.12 - a prototype based date picker
+// CalendarDateSelect version 1.13 - a prototype based date picker
 // Questions, comments, bugs? - see the project page: http://code.google.com/p/calendardateselect
 if (typeof Prototype == 'undefined') alert("CalendarDateSelect Error: Prototype could not be found. Please make sure that your application's layout includes prototype.js (.g. <%= javascript_include_tag :defaults %>) *before* it includes calendar_date_select.js (.g. <%= calendar_date_select_includes %>).");
 if (Prototype.Version < "1.6") alert("Prototype 1.6.0 is required.  If using earlier version of prototype, please use calendar_date_select version 1.8.3");
@@ -15,9 +15,8 @@ Element.addMethods({
 Element.buildAndAppend = function(type, options, style)
 {
   var e = $(document.createElement(type));
-  $H(options).each(function(pair) { eval("e." + pair.key + " = pair.value" ); });
-  if (style) 
-    $H(style).each(function(pair) { eval("e.style." + pair.key + " = pair.value" ); });
+  $H(options).each(function(pair) { e[pair.key] = pair.value });
+  if (style) e.setStyle(style);
   return e;
 };
 nil = null;
@@ -345,9 +344,11 @@ CalendarDateSelect.prototype = {
   updateFooter:function(text) { if (!text) text = this.dateString(); this.footer_div.purgeChildren(); this.footer_div.build("span", {innerHTML: text }); },
   clearDate:function() {
     if ((this.target_element.disabled || this.target_element.readOnly) && this.options.get("popup") != "force") return false;
+    var last_value = this.target_element.value;
     this.target_element.value = "";
     this.clearSelectedClass();
     this.updateFooter('&#160;');
+    if (last_value!=this.target_element.value) this.callback("onchange");
   },
   updateSelectedDate:function(partsOrElement, via_click) {
     var parts = $H(partsOrElement);
@@ -429,7 +430,7 @@ CalendarDateSelect.prototype = {
     Event.stopObserving(document, "keypress", this.keyPress_handler);
     this.calendar_div.remove(); this.closed = true;
     if (this.iframe) this.iframe.remove();
-    if (this.target_element.type!="hidden") this.target_element.focus();
+    if (this.target_element.type != "hidden" && ! this.target_element.disabled) this.target_element.focus();
     this.callback("after_close");
   },
   closeIfClickedOut: function(e) {

data/public/javascripts/calendar_date_select/locale/de.js

@@ -6,5 +6,6 @@ Date.first_day_of_week = 1;
 _translations = {
   "OK": "OK",
   "Now": "Jetzt",
-  "Today": "Heute"
+  "Today": "Heute",
+  "Clear": "Löschen"
 }

data/spec/calendar_date_select/calendar_date_select_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CalendarDateSelect do
+  it "should detect presence of time in a string" do
+    CalendarDateSelect.has_time?("January 7, 2007").should == false
+    CalendarDateSelect.has_time?("January 7, 2007 5:50pm").should == true
+    CalendarDateSelect.has_time?("January 7, 2007 5:50 pm").should == true
+    CalendarDateSelect.has_time?("January 7, 2007 16:30 pm").should == true
+    
+    CalendarDateSelect.has_time?(Date.parse("January 7, 2007 3:00 pm")).should == false
+    CalendarDateSelect.has_time?(Time.parse("January 7, 2007 3:00 pm")).should == true
+    CalendarDateSelect.has_time?(DateTime.parse("January 7, 2007 3:00 pm")).should == true
+  end
+end

data/spec/calendar_date_select/form_helpers_spec.rb

@@ -0,0 +1,156 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe CalendarDateSelect::FormHelpers do
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::JavaScriptHelper
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+
+  include CalendarDateSelect::FormHelpers
+
+  before(:each) do
+    @controller = ActionController::Base.new
+    @request = OpenStruct.new
+    @controller.request = @request
+
+    @model = OpenStruct.new
+  end
+
+  describe "mixed mode" do
+    it "should not output a time when the value is a Date" do
+      @model.start_datetime = Date.parse("January 2, 2007")
+      output = calendar_date_select(:model, :start_datetime, :time => "mixed")
+      output.should_not match(/12:00 AM/)
+    end
+
+    it "should output a time when the value is a Time" do
+      @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
+      output = calendar_date_select(:model, :start_datetime, :time => "mixed")
+      output.should match(/12:00 AM/)
+    end
+  end
+
+  it "should render a time when time is passed as 'true'" do
+    @model.start_datetime = Date.parse("January 2, 2007")
+    output = calendar_date_select(:model, :start_datetime, :time => "true")
+    output.should match(/12:00 AM/)
+  end
+
+  it "should time_false__model_returns_time__should_render_without_time" do
+    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
+    output = calendar_date_select(:model, :start_datetime)
+    output.should_not match(/12:00 AM/)
+  end
+
+  it "should _nil_model__shouldnt_populate_value" do
+    @model = nil
+    output = calendar_date_select(:model, :start_datetime)
+
+    output.should_not match(/value/)
+  end
+
+  it "should _vdc__should_auto_format_function" do
+    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
+    output = calendar_date_select(:model,
+      :start_datetime,
+      :valid_date_check => "date < new Date()"
+    )
+    output.should include("valid_date_check:function(date) { return(date &lt; new Date()) }")
+
+    output = calendar_date_select(:model,
+      :start_datetime,
+      :valid_date_check => "return(date < new Date())"
+    )
+    output.should include("valid_date_check:function(date) { return(date &lt; new Date()) }")
+    output = calendar_date_select(:model,
+      :start_datetime,
+      :valid_date_check => "function(p) { return(date < new Date()) }"
+    )
+    output.should include("valid_date_check:function(p) { return(date &lt; new Date()) }")
+  end
+
+  it "should raise an error if the valid_date_check function is missing a return statement" do
+    message = ":valid_date_check function is missing a 'return' statement.  Try something like: :valid_date_check => 'if (date > new(Date)) return true; else return false;'"
+    lambda {
+      output = calendar_date_select(:model,
+        :start_datetime,
+        :valid_date_check => "date = 5; date < new Date());"
+      )
+    }.should raise_error(ArgumentError, message)
+
+    lambda {
+      output = calendar_date_select(:model,
+        :start_datetime,
+        :valid_date_check => "function(p) { date = 5; date < new Date()); }"
+      )
+    }.should raise_error(ArgumentError, message)
+  end
+
+  it "should render the year_range argument correctly" do
+    output = calendar_date_select(:model, :start_datetime)
+    output.should include("year_range:10")
+    output = calendar_date_select(:model, :start_datetime, :year_range => 2000..2010)
+    output.should include("year_range:[2000, 2010]")
+    output = calendar_date_select(:model, :start_datetime, :year_range => (15.years.ago..5.years.ago))
+    output.should include("year_range:[#{15.years.ago.year}, #{5.years.ago.year}]")
+  end
+
+  it "should disregard the :object parameter when nil" do
+    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
+    output = calendar_date_select(:model, :start_datetime, :time => true, :object => nil)
+    output.should include(CalendarDateSelect.format_date(@model.start_datetime))
+  end
+
+  it "should regard :object parameter" do
+    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
+    output = calendar_date_select(:lame_o, :start_datetime, :time => true, :object => @model)
+    output.should include(CalendarDateSelect.format_date(@model.start_datetime))
+  end
+
+  it "should respect parameters provided in default_options" do
+    new_options = CalendarDateSelect.default_options.merge(:popup => "force")
+    CalendarDateSelect.stub!(:default_options).and_return(new_options)
+    calendar_date_select_tag(:name, "").should include("popup:'force'")
+  end
+
+  it "should respect the :image option" do
+    output = calendar_date_select_tag(:name, "Some String", :image => "boogy.png")
+    output.should include("boogy.png")
+  end
+
+  it "should not pass the :image option as a javascript option" do
+    output = calendar_date_select_tag(:name, "Some String", :image => "boogy.png")
+    output.should_not include("image:")
+  end
+
+  describe "calendar_date_select_tag" do
+    it "should use the string verbatim when provided" do
+      output = calendar_date_select_tag(:name, "Some String")
+
+      output.should include("Some String")
+    end
+
+    it "should not render the time when time is false (or nil)" do
+      time = Time.parse("January 2, 2007 12:01:23 AM")
+      output = calendar_date_select_tag(:name, time, :time => false)
+
+      output.should_not match(/12:01 AM/)
+      output.should include(CalendarDateSelect.format_date(time.to_date))
+    end
+
+    it "should render the time when :time => true" do
+      time = Time.parse("January 2, 2007 12:01:23 AM")
+      output = calendar_date_select_tag(:name, time, :time => true)
+
+      output.should include(CalendarDateSelect.format_date(time))
+    end
+
+    it "should render the time when :time => 'mixed'" do
+      time = Time.parse("January 2, 2007 12:01:23 AM")
+      output = calendar_date_select_tag(:name, time, :time => 'mixed')
+
+      output.should include(CalendarDateSelect.format_date(time))
+    end
+  end
+end

data/{test/test_helper.rb → spec/spec_helper.rb}

@@ -1,6 +1,9 @@
 require "rubygems"
 
-require 'test/unit'
+require 'spec'
+
+gem 'activesupport', ">= 2.2.0"
+gem 'actionpack', ">= 2.2.0"
 
 require 'active_support'
 require 'action_pack'
@@ -9,10 +12,14 @@ require 'action_view'
 
 require 'ostruct'
 
+ActionView::Helpers::InstanceTag.class_eval do
+  class << self; alias new_with_backwards_compatibility new; end
+end
+
 $: << (File.dirname(__FILE__) + "/../lib")
 require "calendar_date_select"
 
-class Object
+class String
   def to_regexp
     is_a?(Regexp) ? self : Regexp.new(Regexp.escape(self.to_s))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: calendar_date_select
 version: !ruby/object:Gem::Version 
-  version: "1.12"
+  version: "1.13"
 platform: ruby
 authors: 
 - Tim Harper
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-29 00:00:00 -07:00
+date: 2008-11-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - js_test/unittest.js
 - lib/calendar_date_select/calendar_date_select.rb
 - lib/calendar_date_select/includes_helper.rb
+- lib/calendar_date_select/form_helpers.rb
 - lib/calendar_date_select.rb
 - Manifest.txt
 - MIT-LICENSE
@@ -70,9 +71,11 @@ files:
 - public/stylesheets/calendar_date_select/silver.css
 - Rakefile
 - Readme.txt
-- test/functional/calendar_date_select_test.rb
-- test/functional/helper_methods_test.rb
-- test/test_helper.rb
+- spec/
+- spec/calendar_date_select
+- spec/calendar_date_select/calendar_date_select_spec.rb
+- spec/calendar_date_select/form_helpers_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://code.google.com/p/calendardateselect/
 post_install_message: 
@@ -96,9 +99,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: calendar_date_select
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: ""
-test_files: 
-- test/test_helper.rb
+test_files: []
+

data/test/functional/calendar_date_select_test.rb

@@ -1,157 +0,0 @@
-  require File.join(File.dirname(__FILE__), '../test_helper.rb')
-
-class HelperMethodsTest < Test::Unit::TestCase
-  include ActionView::Helpers::FormHelper
-  include ActionView::Helpers::JavaScriptHelper
-  include ActionView::Helpers::AssetTagHelper
-  include ActionView::Helpers::TagHelper
-  include ActionView::Helpers::FormTagHelper
-  
-  include CalendarDateSelect::FormHelper
-  
-  def setup
-    @controller = ActionController::Base.new
-    @request = OpenStruct.new
-    @controller.request = @request
-    
-    @model = OpenStruct.new
-  end
-  
-  def test_mixed_time__model_returns_date__should_render_without_time
-    @model.start_datetime = Date.parse("January 2, 2007")
-    output = calendar_date_select(:model, :start_datetime, :time => "mixed")
-    assert_no_match(/12:00 AM/, output, "Shouldn't have outputted a time")
-  end
-  
-  def test_mixed_time__model_returns_time__should_render_with_time
-    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
-    output = calendar_date_select(:model, :start_datetime, :time => "mixed")
-    assert_match(/12:00 AM/, output, "Should have outputted a time")
-  end
-  
-  def test_time_true__model_returns_date__should_render_with_time
-    @model.start_datetime = Date.parse("January 2, 2007")
-    output = calendar_date_select(:model, :start_datetime, :time => "true")
-    assert_match(/12:00 AM/, output, "Should have outputted a time")
-  end
-  
-  def test_time_false__model_returns_time__should_render_without_time
-    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
-    output = calendar_date_select(:model, :start_datetime)
-    assert_no_match(/12:00 AM/, output, "Shouldn't have outputted a time")
-  end
-  
-  def test__nil_model__shouldnt_populate_value
-    @model = nil
-    output = calendar_date_select(:model, :start_datetime)
-    
-    assert_no_match(/value/, output)
-  end
-  
-  def test__vdc__should_auto_format_function
-    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
-    output = calendar_date_select(:model, 
-      :start_datetime, 
-      :valid_date_check => "date < new Date()"
-    )
-    assert_match("valid_date_check:function(date) { return(date &lt; new Date()) }", output)
-    
-    output = calendar_date_select(:model, 
-      :start_datetime, 
-      :valid_date_check => "return(date < new Date())"
-    )
-    assert_match("valid_date_check:function(date) { return(date &lt; new Date()) }", output)
-    output = calendar_date_select(:model, 
-      :start_datetime, 
-      :valid_date_check => "function(p) { return(date < new Date()) }"
-    )
-    assert_match("valid_date_check:function(p) { return(date &lt; new Date()) }", output)
-  end
-  
-  def test__vdc__excluded_return__should_raise_error
-    throw_message = ":valid_date_check function is missing a 'return' statement.  Try something like: :valid_date_check => 'if (date > new(Date)) return true; else return false;'"
-    assert_throws throw_message.to_sym do
-      output = calendar_date_select(:model, 
-        :start_datetime, 
-        :valid_date_check => "date = 5; date < new Date());"
-      )
-    end
-    
-    assert_throws throw_message.to_sym do
-      output = calendar_date_select(:model, 
-        :start_datetime, 
-        :valid_date_check => "function(p) { date = 5; date < new Date()); }"
-      )
-    end
-  end
-  
-  def test__year_range__formats_correctly
-    output = calendar_date_select(:model, :start_datetime)
-    assert_match("year_range:10", output)
-    output = calendar_date_select(:model, :start_datetime, :year_range => 2000..2010)
-    assert_match("year_range:[2000, 2010]", output)
-    output = calendar_date_select(:model, :start_datetime, :year_range => (15.years.ago..5.years.ago))
-    assert_match("year_range:[#{15.years.ago.year}, #{5.years.ago.year}]", output)
-  end
-
-  def test__tag__formats_text_correctly_string
-    time = "January 2, 2007 12:01:23 AM"
-    output = calendar_date_select_tag(:name, time)
-
-    assert_match(time, output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_date
-    time = Date.new(2007, 01, 02)
-    output = calendar_date_select_tag(:name, time)
-
-    assert_no_match(/12:01 AM/, output, "Should not have outputted a time")
-    assert_match(CalendarDateSelect.format_date(time), output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_time
-    time = Time.parse("January 2, 2007 12:01:23 AM")
-    output = calendar_date_select_tag(:name, time)
-
-    assert_match(CalendarDateSelect.format_date(time), output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_with_time_option
-    time = Time.parse("January 2, 2007 12:01:23 AM")
-    output = calendar_date_select_tag(:name, time, :time => true)
-
-    assert_match(CalendarDateSelect.format_date(time), output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_with_mixed_option
-    time = Time.parse("January 2, 2007 12:01:23 AM")
-    output = calendar_date_select_tag(:name, time, :time => 'mixed')
-
-    assert_match(CalendarDateSelect.format_date(time), output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_time_as_date
-    time = Time.parse("January 2, 2007 12:01:23 AM")
-    output = calendar_date_select_tag(:name, time, :time => false)
-
-    assert_no_match(/12:01 AM/, output, "Should not have outputted a time")
-    assert_match(time.strftime(CalendarDateSelect.date_format_string(false)), output, "Should have outputted a correctly formatted time")
-  end
-
-  def test__tag__formats_text_correctly_time_with_format
-    time = Time.parse("January 2, 2007 12:01:00 AM")
-    output = calendar_date_select_tag(:name, time, :format => "%Y-%m-%d")
-
-    assert_no_match(/12:01 AM/, output, "Should not have outputted a time")
-    assert_match('2007-01-02', output, "Should have outputted a correctly formatted time")
-  end
-  
-  def test__nil_object_option__should_disregard
-    @model.start_datetime = Time.parse("January 2, 2007 12:00 AM")
-    output = calendar_date_select(:model, :start_datetime, :time => true, :object => nil)
-    assert_match(CalendarDateSelect.format_date(@model.start_datetime), output, "Should have outputted a time")
-  end  
-
-end
-
-

data/test/functional/helper_methods_test.rb

@@ -1,15 +0,0 @@
-require File.join(File.dirname(__FILE__), '../test_helper.rb')
-
-class HelperMethodsTest < Test::Unit::TestCase
-  def setup
-    
-  end
-  
-  def test_has_time
-    assert( ! CalendarDateSelect.has_time?("January 7, 2007"))
-    assert(CalendarDateSelect.has_time?("January 7, 2007 5:50pm"))
-    assert(CalendarDateSelect.has_time?("January 7, 2007 5:50 pm"))
-    assert(CalendarDateSelect.has_time?("January 7, 2007 16:30 pm"))
-  end
-  
-end