nbrew-simple_time_select 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.2a / 2009-06-07
+Added start_hour and end_hour options

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Anthony Amoyal
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,64 @@
+SIMPLE TIME SELECT PLUGIN
+
+Ever wanted a time select component with only one select field? This simple plugin 
+gives you that component and allows you to set minute intervals. If you set your
+minute interval to 15, you get options such as:
+"6:00 PM", "6:15 PM", "6:30 PM", etc.
+
+If no minute interval is specified, the control defaults to a 15 minute interval. 
+As you can see from the sample values above, this control also implements an AM/PM time
+format.
+
+Also note that this component is great if you ONLY want the time from a user. As is, the code
+prevents the hidden date fields associated with the time_select helper from being created. This means
+that a couple lines of code on the controller side are necessary to make this work. See USAGE for details.
+
+USAGE:
+
+To create the time select:
+
+  <%= time_select "event", "time", { :default => Time.now.change(:hour => 21), :simple_time_select => true, :minute_interval => 20, :time_separator => "" } %>
+
+Don't forget to include the time_separator option.  Otherwise you will get an extra colon outside of the select field.
+
+Simple time select also takes a start_hour and end_hour option to be specified in military format (between 0-23).
+
+<%= time_select "event", "time", { :default => Time.now.change(:hour => 21), :simple_time_select => true, :minute_interval => 20, :time_separator => "", :start_hour => 10, :end_hour => 14 } %>
+
+The start hour behaves as you would expect but the end_hour may not.  If you specify the end_hour as 10, your time select will include 10:15, 10:30, 10:45.  So the end_hour sets the last hour that the time select will include. Email me if you don't like this.
+
+When the time is submitted, you will have the value in params on the controller side as shown below:
+  
+  params[:event][:"time(i)"]
+
+Simply add these lines of code to your handler to play nicely with ActiveRecord:
+
+  params[:event][:time] = Time.parse(params[:event][:"time(i)"])
+  params[:event].delete(:"time(i)")
+
+Now the time will be correct, but the date will be the current date.  Here are a couple options for changing the date:
+
+1) Change the date in your controller (replace anything in < > with your own variables):
+  
+  params[:event][:time] = params[:event][:time].change(:year => <year_var>, :day => <day_var>, :month => <month_var>)
+  *I do not use this method, you may need to cast params[:event][:time] to a Time object before applying "change" to it.
+
+2) Change the date in an ActiveRecord callback in your model.  This is my preferred method:
+
+  def before_validation
+    # Assuming date is your Date variable
+    self.time = self.time.change(:year => date.year, :day => date.day, :month => date.month)
+  end
+
+Feel free to send any questions to tonyamoyal@gmail.com
+
+Author: Tony Amoyal <tonyamoyal@gmail.com>
+
+Modifications by:
+
+ - Rich Sturim <rich@sturim.org>
+ - Nathan Hyde <nhyde@bigdrift.com>
+  
+
+Homepage:
+http://github.com/tamoyal/simple_time_select/tree/master

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the simple_time_select plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the simple_time_select plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Simple Time Select'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "nbrew-simple_time_select"
+    gemspec.summary = "Twelve hour time select from a single input for hour, minute and second. Does not modify month, day and year inputs."
+    gemspec.description = "A time select component using only ONE select field."
+    gemspec.email = "tonyamoyal@gmail.com"
+    gemspec.homepage = "http://github.com/nbrew/simple_time_select"
+    gemspec.authors = ["Anthony Amoyal"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/about.yml

@@ -0,0 +1,7 @@
+author: Tony Amoyal
+summary: Alternative to time_select provided by Rails.
+homepage: http://www.tonyamoyal.com
+plugin: http://github.com/tamoyal/simple_time_select/tree/master
+license: MIT
+version: 0.2a
+rails_version: 2.3.0+

data/init.rb

@@ -0,0 +1 @@
+require "simple_time_select"

data/lib/simple_time_select.rb

@@ -0,0 +1,81 @@
+module ActionView::Helpers
+  class DateTimeSelector
+     def select_minute_with_simple_time_select
+        return select_minute_without_simple_time_select unless @options[:simple_time_select].eql? true
+        
+        # Although this is a datetime select, we only care about the time.  Assume that the date will
+        # be set by some other control, and the date represented here will be overriden
+        
+        val_minutes = @datetime.kind_of?(Time) ? @datetime.min + @datetime.hour*60 : @datetime
+        
+        @options[:time_separator] = ""
+        
+        # Default is 15 minute intervals
+        minute_interval = 15
+        if @options[:minute_interval] 
+          minute_interval = @options[:minute_interval] 
+        end
+
+        start_minute = 0
+        # @options[:start_hour] should be specified in military
+        # i.e. 0-23
+        if @options[:start_hour]
+          start_minute = @options[:start_hour] * 60
+        end
+        
+        end_minute = 1439
+        # @options[:end_hour] should be specified in military
+        # i.e. 0-23
+        if @options[:end_hour]
+          end_minute = ( @options[:end_hour] + 1 ) * 60 - 1  
+        end
+        
+        if @options[:use_hidden] || @options[:discard_minute]
+          build_hidden(:minute, val)
+        else
+          minute_options = []
+          start_minute.upto(end_minute) do |minute|
+            if minute%minute_interval == 0
+              ampm = minute < 720 ? ' AM' : ' PM'
+              hour = minute/60
+              minute_padded = zero_pad_num(minute%60)
+              hour_padded = zero_pad_num(hour)
+              ampm_hour = ampm_hour(hour)
+              
+              val = "#{hour_padded}:#{minute_padded}:00"
+              minute_options << ((val_minutes == minute) ? 
+                %(<option value="#{val}" selected="selected">#{ampm_hour}:#{minute_padded}#{ampm}</option>\n) :
+                %(<option value="#{val}">#{ampm_hour}:#{minute_padded}#{ampm}</option>\n)
+              )
+            end
+          end
+          build_select(:minute, minute_options)
+        end
+      end
+      alias_method_chain :select_minute, :simple_time_select
+      
+      
+      def select_hour_with_simple_time_select
+        return select_hour_without_simple_time_select unless @options[:simple_time_select].eql? true
+        # Don't build the hour select
+        #build_hidden(:hour, val)
+      end
+      alias_method_chain :select_hour, :simple_time_select
+      
+      def select_second_with_simple_time_select
+        return select_second_without_simple_time_select unless @options[:simple_time_select].eql? true
+        # Don't build the seconds select
+        #build_hidden(:second, val)
+      end
+      alias_method_chain :select_second, :simple_time_select
+     
+  end
+end
+
+def ampm_hour(hour)
+  return hour == 12 ? 12 : (hour == 0 ? 12 : (hour / 12 == 1 ? hour % 12 : hour))
+end
+
+def zero_pad_num(num)
+  return num < 10 ? '0' + num.to_s : num.to_s
+end

data/nbrew-simple_time_select.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nbrew-simple_time_select}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anthony Amoyal"]
+  s.date = %q{2010-05-19}
+  s.description = %q{A time select component using only ONE select field.}
+  s.email = %q{tonyamoyal@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "MIT_LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "about.yml",
+     "init.rb",
+     "lib/simple_time_select.rb",
+     "nbrew-simple_time_select.gemspec",
+     "pkg/simple_time_select-0.0.0.gem",
+     "test/simple_time_select_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/nbrew/simple_time_select}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Twelve hour time select from a single input for hour, minute and second. Does not modify month, day and year inputs.}
+  s.test_files = [
+    "test/simple_time_select_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/simple_time_select_test.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class String
+  def nstrip
+    self.gsub(/\n+/, '')
+  end
+
+  def nstrip!
+    self.gsub!(/\n+/, '')
+  end
+  
+  def strip_selected
+    self.gsub(" selected=\"selected\"", '')
+  end
+end
+
+class SimpleTimeSelectTest < Test::Unit::TestCase
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormOptionsHelper
+  include ActionView::Helpers::DateHelper
+  
+  def test_ampm_hour
+    assert_equal(12, ampm_hour(0), "ampm_hour test 12 AM")
+    assert_equal(5, ampm_hour(5), "ampm_hour test 5 AM")
+    assert_equal(12, ampm_hour(12), "ampm_hour test 12 PM")
+    assert_equal(5, ampm_hour(17), "ampm_hour test 5 PM")
+    assert_equal(11, ampm_hour(23), "ampm_hour test 11 PM")
+  end
+  
+  def test_zero_pad_num
+    assert_equal('00', zero_pad_num(0))
+    assert_equal('01', zero_pad_num(1))
+    assert_equal('10', zero_pad_num(10))
+  end
+  
+  def test_simple_time_select_default
+    # Default time is 9:00pm
+    time = Time.now.change(:hour => 21)
+    
+    options = []
+    0.upto(23) do |hour|
+      meridiem = hour < 12 ? 'AM' : 'PM'
+      0.upto(3) do |minute|
+        options.push  [ ampm_hour(hour).to_s+":"+zero_pad_num(minute*15)+" "+meridiem, zero_pad_num(hour)+":"+zero_pad_num(minute*15)+":00" ]
+      end
+    end
+    expected = select_tag 'date[minute]', options_for_select(options, "21:00:00"), :id => 'date_minute'  
+    actual = select_minute time, :simple_time_select => true
+    assert_equal(expected.nstrip, actual.nstrip, "Simple Time Select generation")
+  end
+
+  def test_usual_time_select
+    # Default time is 9:00pm
+    time = Time.now.change(:hour => 21)
+
+    options = options_for_select((0..59).to_a.map { |m| "%02d" % m }, "00")
+    expected = select_tag 'date[minute]', options, :id => 'date_minute'
+    expected.nstrip!
+
+    # The select_tag helper puts selected="selected" after the value in the options tag
+    # whereas the select_minute helper puts selected="selected" before the value in the options tag.
+    # Therefore the html can be correct, but this test will not validate. To fix this, I am just removing
+    # selected="selected" from both before I compare
+    expected = expected.strip_selected
+    
+    actual = select_minute time, :simple_time_select => false
+    actual = actual.strip_selected
+    assert_equal(expected, actual.nstrip, "Usual time select with explicit option")
+
+    actual = select_minute time
+    actual = actual.strip_selected
+    assert_equal(expected, actual.nstrip, "Usual time select with no options")
+  end
+  
+  def test_start_and_end_hour
+    time = Time.now.change(:hour => 21)
+    # 10 AM to 2 PM
+    output = select_minute time, :simple_time_select => true, :start_hour => 10, :end_hour => 14
+    puts "#{output.inspect}"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require 'test_help'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: nbrew-simple_time_select
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Anthony Amoyal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A time select component using only ONE select field.
+email: tonyamoyal@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- CHANGELOG
+- MIT_LICENSE
+- README
+- Rakefile
+- VERSION
+- about.yml
+- init.rb
+- lib/simple_time_select.rb
+- nbrew-simple_time_select.gemspec
+- pkg/simple_time_select-0.0.0.gem
+- test/simple_time_select_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/nbrew/simple_time_select
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Twelve hour time select from a single input for hour, minute and second. Does not modify month, day and year inputs.
+test_files: 
+- test/simple_time_select_test.rb
+- test/test_helper.rb