formatted-dates 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/CHANGELOG

@@ -0,0 +1,8 @@
+19 August 2008
+- - - - - - - -
+Initial Release
+
+22 August 2008
+- - - - - - - -
+Add filter param - Paul Campbell
+Add 'today' support - Paul Campbell

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Paul Campbell
+
+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,78 @@
+h1. FormattedDates
+
+I flippin' hate mucking about with strftime everytime I want to format dates. I hate adding new methods messing up my models. I hate .to_formatted_string.
+
+This formatted_dates plugin is a quick acts_as hook into strftime for date fields your Rails models.
+
+h2. Installation
+
+Add this to config/environment.rb :
+
+<pre><code>config.gem 'formatted-dates', :lib => 'formatted_dates', :version => '0.0.1', :source => 'http://gemcutter.org'</code></pre>
+
+and run:
+
+sudo rake gems:install
+
+or
+
+./script/plugin install git://github.com/paulca/formatted-dates.git
+
+h2. Example
+
+In yer model:
+
+<pre><code>Account < ActiveRecord::Base
+  format_dates :timestamps
+end</code></pre>
+
+This will give you access to new methods with _formatted appended to the end of any standard Rails timestamps in your model (eg. created_at, updated_at, created_on, updated_on):
+
+They format using the default of "%e %B, %Y", which gives something like this:
+  updated_on_formatted => "9 April, 2003"
+  
+You can provide your own string to pass to strftime:
+
+<pre><code>Account < ActiveRecord::Base
+  format_dates :timestamps, :format => "%m/%d/%Y"
+end</code></pre>
+
+And you can pass in other date fields from your model to be formatted:
+
+<pre><code>Account < ActiveRecord::Base
+  format_dates [:timestamps, :registered_on, :last_login_date], :format => "%m/%d/%Y"
+end</code></pre>
+
+You can also format multiple fields differently:
+
+<pre><code>Account < ActiveRecord::Base
+  format_dates :timestamps
+  format_dates :registered_on, :format => "%I:%M%p"
+  format_dates :last_login_date, :format => "%m/%d/%Y"
+end</code></pre>
+
+If you want to display the time for 'today' differently you can do so:
+<pre><code>Account < ActiveRecord::Base
+  format_dates :created_on, :today => "%l:%M%p"
+end<code></pre>
+
+And if you want to filter the resulting string, you can do so too:
+
+If you want to display the time for 'today' differently you can do so:
+<pre><code>Account < ActiveRecord::Base
+  format_dates :created_on, :today => "%l:%M%p", :filter => :downcase # => '10:10pm'
+emd</code></pre>
+
+Finally, you can alias your formatted dates to a nice short, memorable name:
+
+<pre><code>Account < ActiveRecord::Base
+  format_dates :created_on, :as => :date
+end</code></pre>
+
+This gives you a method @account.date that is equivalent to created_on_formatted
+
+Copyright (c) 2008, 2009 Paul Campbell, released under the MIT license.
+
+Follow me on Twitter: http://www.twitter.com/paulca
+
+More ramblings on http://www.pabcas.com

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "formatted-dates"
+    gemspec.summary = "A simple acts_as style plugin for easily formatting of dates within Rails models"
+    gemspec.description = "A Rails plugin that provides _formatted methods for date fields."
+    gemspec.email = "paul@rslw.com"
+    gemspec.homepage = "http://github.com/paulca/formatted-dates"
+    gemspec.authors = ["Paul Campbell"]
+  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.0.1

data/formatted-dates.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{formatted-dates}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Campbell"]
+  s.date = %q{2009-10-11}
+  s.description = %q{A Rails plugin that provides _formatted methods for date fields.}
+  s.email = %q{paul@rslw.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "formatted-dates.gemspec",
+     "lib/formatted_date.rb",
+     "rails/init.rb",
+     "spec/formatted_date_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/paulca/formatted-dates}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{A simple acts_as style plugin for easily formatting of dates within Rails models}
+  s.test_files = [
+    "spec/formatted_date_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/formatted_date.rb

@@ -0,0 +1,46 @@
+module FormattedDate
+  
+  def self.included(base) 
+     base.extend FormatDatesMethod
+   end
+
+  
+  module FormatDatesMethod
+    
+    TIMESTAMPS = [:created_at, :updated_at, :created_on, :updated_on]
+    
+    def format_dates(args = [], options = {})
+        format = options[:format] || "%e %B, %Y"
+        filter_date = options[:filter] || nil
+        as = options[:as] || nil
+        today = options[:today] || nil
+        args = [args].flatten
+        
+        if args.include?(:timestamps)
+          TIMESTAMPS.each do |timestamp|
+            args << timestamp
+          end
+        end
+      
+      args.each do |date_method|
+        class_eval "
+          def #{date_method}_formatted
+            return \"\" if respond_to?(:#{date_method}) and #{date_method}.nil?
+            return_date = #{date_method}.strftime(\"#{format}\").strip if respond_to?(:#{date_method})
+            "+ (today ? "return_date = #{date_method}.strftime(\"#{today}\").strip if respond_to?(:#{date_method}) and #{date_method}.to_date == Date.today" : '')+"
+            "+(filter_date ? "return_date = return_date.#{filter_date}" : '')+"
+            return_date
+          end
+        "
+      end
+      
+      unless args.empty?
+        if as
+          class_eval "alias_method :#{as}, :#{args.first}_formatted"
+        end
+      end
+    end
+
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'formatted_date'
+ActiveRecord::Base.send(:include, FormattedDate)

data/spec/formatted_date_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/../lib/formatted_date.rb'
+require File.dirname(__FILE__) + '/../../../../config/environment.rb'
+
+class TestModel
+  include FormattedDate
+  format_dates :test_date
+  format_dates :test_date_with_format, :format => "%m/%d/%Y"
+  format_dates :timestamps
+  format_dates :created_at, :as => :date
+  format_dates :now, :today => "%l:%M%p", :as => :nice, :filter => :downcase
+  format_dates [:multi_one, :multi_two], :format => "%m/%d/%Y"
+  format_dates :nil_date
+
+  def nil_date
+    nil
+  end
+
+  def now
+    Time.parse('18:18')
+  end
+  
+  def multi_one
+    Date.parse('1 April 2008')
+  end
+  
+  def multi_two
+    Date.parse('2 April 2008')
+  end
+  
+  def created_at
+    Date.parse('1 April 2003')
+  end
+  
+  def updated_at
+    Date.parse('2 April 2003')
+  end
+  
+  def test_date
+    Date.parse("9 April 2003")
+  end
+  
+  def test_date_with_format
+    Date.parse("9 April 2003")
+  end
+end
+
+describe FormattedDate do
+  before(:each) do
+    @test_model = TestModel.new
+  end
+  
+  it "should ignore a nil date" do
+    @test_model.nil_date_formatted.should == ""
+  end
+  
+  it "should be a Date (my test mocky thing)" do
+    @test_model.test_date.should be_a_kind_of(Date)
+  end
+  
+  it "should format the test date correctly" do
+    @test_model.test_date_formatted.should == '9 April, 2003'
+  end
+  
+  it "should format the test date with a format option" do
+    @test_model.test_date_with_format_formatted.should == '04/09/2003'
+  end
+  
+  it "should format the timestamps" do
+    @test_model.created_at_formatted.should == '1 April, 2003'
+  end
+  
+  it "should format the timestamps" do
+    @test_model.updated_at_formatted.should == '2 April, 2003'
+  end
+  
+  it "should not format created_on" do
+    @test_model.created_on_formatted.should be_nil
+  end
+  
+  it "should not format updated_on" do
+    @test_model.updated_on_formatted.should be_nil
+  end
+  
+  it "should add a date method" do
+    @test_model.date.should == '1 April, 2003'
+  end
+  
+  it "should show today differently" do
+    @test_model.nice.should == '6:18pm'
+  end
+  
+  it "should format multi one" do
+    @test_model.multi_one_formatted.should == '04/01/2008'
+  end
+  
+  it "should format multi one" do
+    @test_model.multi_two_formatted.should == '04/02/2008'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: formatted-dates
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A Rails plugin that provides _formatted methods for date fields.
+email: paul@rslw.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- CHANGELOG
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- formatted-dates.gemspec
+- lib/formatted_date.rb
+- rails/init.rb
+- spec/formatted_date_spec.rb
+has_rdoc: true
+homepage: http://github.com/paulca/formatted-dates
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A simple acts_as style plugin for easily formatting of dates within Rails models
+test_files: 
+- spec/formatted_date_spec.rb