eztime 1.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov"
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Scharf
+
+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.textile

@@ -0,0 +1,60 @@
+h1. EZTime 
+
+h2. Installation
+
+  script/plugin install git@github.com:scharfie/eztime.git
+
+EZTime is a simple extension to the Date class in Ruby to provide easy
+formatting of dates and times.
+
+h2. Can't I just use strftime? 
+
+h3. Feature Support
+
+EZTime has a number of formatting features not available to strftime. 
+For example, what if you want to display the ordinal (st, nd, rd, th)
+for a date?  (i.e. 1st, 2nd, etc.)  With EZTime, ordinals are easy.
+
+How about displaying the meridian (AM/PM) in lowercase?  What about 
+only displaying the first letter (a/p)?  While strftime is powerful,
+there are simply some formatting options not available, which is a 
+shame.
+
+h3.  Simplicity
+
+EZTime is much easier to use than strftime because it doesn't require
+much memorization.  For example, isn't @:month/:day/:year@ easier than
+@%m/%d/%Y@ ?
+
+Not convinced?  How about @:day:ordinal of :month_name, :year@ 
+(_i.e. 20th of December, 2003_).
+
+h3.  Extensibility
+
+Perhaps the strongest feature of EZTime is that it can be "extended" by simply
+adding new methods to the EZTime module.  The reason this works is because EZTime
+eval's the formatting string after a simple substitution, replacing the :name 
+with a method call to that name.  The upside to this is that everything you put
+in the formatting string can be accessed by itself as a method call.
+
+h3.  Formatting variants
+
+Certain methods have one or more variants, all following a standard convention:
+* 'z': (prefix) element will include a leading 0 digit
+* 'l': (prefix) (lowercase L): element will be converted to all lowercase
+* 's': (prefix) small variants.  For example, smeridian will return 'A' or 'P'
+* '12': (suffix): element will be in 12-hour format
+
+See the documentation for the various methods for examples of these modifiers.
+
+h3.  Known Issues
+
+Currently, using quotes or apostrophes in an EZTime format string is not supported - 
+it results in compile errors.  If there is a need for either of these characters, 
+however, I will look into correcting the situation.
+
+h2. Credits
+
+EZTime was created by Chris Scharf (http://tiny.scharfie.com)
+
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "eztime"
+  gem.homepage = "http://github.com/scharfie/eztime"
+  gem.license = "MIT"
+  gem.summary = %Q{Easier date/time manipulation}
+  gem.description = %Q{Easier date/time manipulation}
+  gem.email = "scharfie@gmail.com"
+  gem.authors = ["Chris Scharf"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "eztime #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/eztime.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eztime}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Scharf"]
+  s.date = %q{2012-07-05}
+  s.description = %q{Easier date/time manipulation}
+  s.email = %q{scharfie@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "eztime.gemspec",
+    "init.rb",
+    "install.rb",
+    "lib/eztime.rb",
+    "test/helper.rb",
+    "test/test_eztime.rb"
+  ]
+  s.homepage = %q{http://github.com/scharfie/eztime}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Easier date/time manipulation}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'eztime'

data/lib/eztime.rb

@@ -0,0 +1,124 @@
+require 'date'
+
+# The following code was based on work found at:
+# http://www.bigbold.com/snippets/user/jswizard#post2368
+class Numeric
+  # Returns the cardinal (number) and ordinal (st, nd, rd, th, etc.)
+  # Pass include_cardinal as false to only return the ordinal
+  def ordinal(include_cardinal=true)
+    cardinal = self.to_i.abs
+    if (10...20).include?(cardinal) then
+      include_cardinal ? cardinal.to_s << 'th' : 'th'
+    else
+      ord = %w{th st nd rd th th th th th th}[cardinal % 10]
+      include_cardinal ? cardinal.to_s << ord : ord
+    end
+  end
+end
+
+module EZTime
+  public
+  # Returns only the lower two digits of the year
+  # (i.e. 2006 => 06)
+  def syear; year.to_s[-2..-1]; end
+  
+  # Returns the name of the month 
+  # (January, February, etc.)
+  def month_name; Date::MONTHNAMES[month]; end
+  
+  # Returns the abbreviated name of the month 
+  # (Jan, Feb, etc.)
+  def month_abbr; Date::ABBR_MONTHNAMES[month]; end
+  
+  # Returns the name of the weekday
+  # (Sunday, Monday, etc.)
+  def day_name; Date::DAYNAMES[wday]; end
+  
+  # Returns the abbreviated name of the weekday
+  # (Sun, Mon, etc.)
+  def day_abbr; Date::ABBR_DAYNAMES[wday]; end
+  
+  alias :nmonth :month_name
+  alias :amonth :month_abbr
+  
+  alias :nday   :day_name
+  alias :aday   :day_abbr
+
+  # Returns the month as a zero-padded string
+  # (i.e. June => 06)  
+  def zmonth; '%02d' % month; end
+  
+  # Returns the day as a zero-padded string
+  # (5 => 05)
+  def zday;   '%02d' % mday;  end
+  
+  # Returns the hour as a zero-padded string
+  # (3 => 03)
+  def zhour;  '%02d' % hour; end
+  
+  # Returns the hour in 12-hour format
+  # (5:00pm => 5)
+  def hour12;  hour % 12 == 0 ? 12 : hour % 12; end
+  
+  # Returns the hour in 12-hour format as a zero-padded string
+  # (5:00pm => 05)
+  def zhour12; '%02d' % hour12; end
+  
+  # Returns the minute as a zero-padded string 
+  # Note: If you need just the minute, use min
+  def minute;  '%02d' % min; end
+  
+  # Returns the second as a zero-padded string
+  # Note: If you need just the second, use sec
+  def second;  '%02d' % sec; end
+  
+  # Returns the meridian 
+  # (AM/PM)
+  def meridian;   hour >= 12 ? 'PM' : 'AM'; end
+  
+  # Returns the meridian in short form (first letter)
+  # (A/P)
+  def smeridian;  meridian[0].chr; end
+  
+  # Returns the meridian in lowercase
+  # (am/pm)
+  def lmeridian;  meridian.downcase; end
+  
+  # Returns the meridian in lowercase, short form (first letter)
+  # (a/p)
+  def lsmeridian; smeridian.downcase; end
+  
+  # Returns the ordinal of the day
+  # (1 => st, 2 => nd, 3 => rd, 4.. => th)
+  def ordinal; mday.ordinal(false); end
+  alias :ord :ordinal
+  
+  # Formats the date/time according to the formatting string format_str
+  # The formatting string consists of any of the methods defined in EZTime
+  # (such as meridian, ordinal, zhour, etc.) as well as any other methods 
+  # available to the object class.  The methods are named in the string by
+  # preceeded them with a single colon (:).  Any characters not preceeded by
+  # a colon will be passed through directly.
+  #
+  # Example
+  #
+  #   d = DateTime.civil(2003, 12, 20, 17, 30, 0) 
+  #   puts d.eztime(":day :nmonth :year at :hour12::minute::second :lmeridian")
+  #
+  #   Output: 20 December 2003 at 5:30:00 pm
+  def eztime(format_str)
+    eval("'" + format_str.gsub(/:([a-z_]{1,}[0-9]{0,2})/, '\' + \1.to_s + \'') + "'")
+  end
+end  
+
+# Include the EZTime module into the Time class
+class Time; include EZTime; end
+
+# Include the EZTime module into the Date class
+class Date; include EZTime; end
+
+# class DateTime
+#   include EZTime
+#   def ordinal; mday.ordinal(false); end
+#   def self.ordinal; mday.ordinal(false); end
+# end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'eztime'
+
+class Test::Unit::TestCase
+end

data/test/test_eztime.rb

@@ -0,0 +1,111 @@
+require 'helper'
+
+class EZTimeTest < Test::Unit::TestCase
+  def setup
+    # 20 December 2003 @ 5:45:23 PM
+    @stamp = DateTime.civil(2003, 12, 20, 17, 45, 23)
+    
+    # 1 Jan 2004 4:30:00 PM
+    @ny = DateTime.civil(2004, 1, 1, 16, 30, 0) 
+  end
+  
+  def test_constant
+    assert_equal 'pizza time', @stamp.eztime('pizza time')
+    assert_equal 'pizza : time', @stamp.eztime('pizza : time')
+    assert_equal 'pizza :::: time', @stamp.eztime('pizza :::: time')
+  end
+  
+  def test_month_day_year
+    assert_equal '12/20/2003', @stamp.eztime(':month/:day/:year')
+    assert_equal '2003-12-20', @stamp.eztime(':year-:month-:day')
+    assert_equal '12-03',      @stamp.eztime(':month-:syear')
+    
+    assert_equal '1/1/2004',   @ny.eztime(':month/:day/:year')
+    assert_equal '01/01/2004', @ny.eztime(':zmonth/:zday/:year')
+  end
+  
+  def test_named_months_and_days  
+    assert_equal 'December 20, 2003', @stamp.eztime(':month_name :day, :year')
+    assert_equal '20 December 03', @stamp.eztime(':day :month_name :syear')
+    
+    assert_equal 'Dec 20, 2003', @stamp.eztime(':month_abbr :day, :year')
+    assert_equal '20 Dec 03', @stamp.eztime(':day :month_abbr :syear')    
+    
+    1.upto(12) do |month|
+      assert_equal Date::MONTHNAMES[month], Date.civil(2003, month, 1).eztime(':month_name')
+      assert_equal Date::ABBR_MONTHNAMES[month], Date.civil(2003, month, 1).eztime(':month_abbr')
+    end
+    
+    0.upto(6) do |wday|
+      d = Date.civil(2006, 8, 6 + wday)
+      assert_equal wday, d.wday
+      assert_equal Date::DAYNAMES[wday], d.eztime(':day_name')
+      assert_equal Date::ABBR_DAYNAMES[wday], d.eztime(':day_abbr')
+    end
+  end
+  
+  def test_hour_minute_second_meridian
+    assert_equal '17:45:23 pm', @stamp.eztime(':hour::minute::second :lmeridian')
+    assert_equal '17:45:23 PM', @stamp.eztime(':hour::minute::second :meridian')
+    assert_equal '17:45:23 P',  @stamp.eztime(':hour::minute::second :smeridian')
+    assert_equal '17:45:23 p',  @stamp.eztime(':hour::minute::second :lsmeridian')
+    
+    # now test am/AM/A/a
+    @stamp2 = DateTime.civil(2003, 12, 12, 5, 45, 23)
+    assert_equal '5:45:23 am', @stamp2.eztime(':hour::minute::second :lmeridian')
+    assert_equal '5:45:23 AM', @stamp2.eztime(':hour::minute::second :meridian')
+    assert_equal '5:45:23 A',  @stamp2.eztime(':hour::minute::second :smeridian')
+    assert_equal '5:45:23 a',  @stamp2.eztime(':hour::minute::second :lsmeridian')    
+  end
+  
+  def test_everything
+    d = DateTime.civil(2000, 1, 1, 0, 0, 0)
+    0.upto(1440/5) do |min|
+      d += 300 if min > 0
+      assert_equal d.strftime('%I:%M'), d.eztime(':hour12::minute') 
+    end  
+
+    1.upto(31) do |day|
+      d = DateTime.civil(2000, 1, day, 0, 0, 0)
+      assert_equal d.strftime('%m/%d/%Y %A'), d.eztime(':zmonth/:zday/:year :nday')
+    end
+  end
+  
+  def test_all
+    assert_equal '05:45 PM on December 20th, 2003 (Saturday)', 
+      @stamp.eztime(':zhour12::minute :meridian on :month_name :day:ord, :year (:day_name)')
+      
+    assert_equal '20 December 03 was a Saturday.',
+      @stamp.eztime(':day :nmonth :syear was a :nday.')  
+  end
+  
+  def test_hours
+    0.upto(24) do |hour|
+      hour12 = hour
+      d = DateTime.civil(2000, 1, 1, hour, 0, 0)
+      meridian = d.hour >= 12 ? 'pm' : 'am'
+      hour12, meridian = 12, 'am' if d.hour == 0
+      hour12 -=12 if hour12 > 12
+      
+      expected = "#{hour12} #{d.hour} #{meridian}"
+      assert_equal expected, d.eztime(':hour12 :hour :lmeridian')
+    end
+  end
+  
+  def test_ordinals
+    assert_equal 'st', @ny.ord
+    assert_equal 'January 1st', @ny.eztime(':month_name :day:ord')
+    
+    ordinals = %w{
+      th st nd rd th th th th th th 
+      th th th th th th th th th th
+      th st nd rd th th th th th th 
+      th st nd rd th th th th th th       
+    }
+    
+    1.upto(31) do |mday|
+      d = Date.civil(2006, 1, mday)
+      assert_equal ordinals[mday], d.eztime(':ord'), "Failed on " + d.to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: eztime
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Chris Scharf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+description: Easier date/time manipulation
+email: scharfie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- eztime.gemspec
+- init.rb
+- install.rb
+- lib/eztime.rb
+- test/helper.rb
+- test/test_eztime.rb
+has_rdoc: true
+homepage: http://github.com/scharfie/eztime
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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.4.2
+signing_key: 
+specification_version: 3
+summary: Easier date/time manipulation
+test_files: []
+