human_date 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,155 @@
+# human_date
+
+`human_date` allows you to display times and dates in a human format.
+
+```ruby
+date = Date.current # 2012-08-28
+
+human_date(date) # Today
+human_date(time + 1.day) # Tomorrow
+human_date(time - 1.day) # Yesterday
+human_date(time - 2.days) # Aug 26
+human_date(time - 1.year) # Aug 28, 2011
+
+# it works with times, too
+
+time = Time.now # 2012-08-28 17:20:54
+
+human_time(time) # 5:20 pm
+human_time(time - 1.day) # Yesterday
+# ...
+```
+
+`human_date` provides you with 5 states for your Time/Date objects:
+
+- `today` displays time only: `5:20 pm`
+
+- `tomorrow` displays: `Tomorrow`
+
+- `yesterday` displays: `Yesterday`
+
+- `current_year` displays the month and the day: `Aug 26`
+
+- `other_year` displays the month, the day and the year: `Aug 28, 2011`
+
+The default values can be overwriten in the locale file. See the I18n section for details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'human_date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install human_date
+
+## Usage
+
+- `human_date` for human dates
+
+- `human_time` for human times
+
+- `human_time_tag` generates HTML5 `<time>` tag
+
+### Date examples
+```ruby
+date = Date.current
+# 2012-08-28
+
+human_date(date)
+# Today
+
+human_time_tag(date)
+# <time datetime="2012-08-28">Today</time>
+
+human_time_tag(date, pubdate: true)
+# <time datetime="2012-08-28" pubdate="pubdate">Today</time>
+```
+
+### Time examples
+```ruby
+time = Time.zone.now
+# 2012-08-28 17:20:54
+
+human_time(time)
+# 5:20 pm
+
+human_time_tag(time)
+# <time datetime="2012-08-28T17:20:54">5:20 PM</time>
+
+```
+
+### Namespaces
+
+If you have several models and want each of them to have a different format (for example, for a `Post` you want to display 'Today' if it was posted today, but for a `Comment` you want to display something like '5:20 pm'), you can use namespaces.
+
+```ruby
+# config/locales/en.yml
+en:
+  posts:
+    time:
+      formats:
+        today: "Today"
+
+  comments:
+    time:
+      formats:
+        today: "%l:%M %p"
+```
+
+```ruby
+time = Time.now
+# 2012-08-28 17:20:54
+
+human_time(time, :posts)
+# Today
+
+human_time(time, :comments)
+# 5:20 pm
+
+human_time_tag(time, :posts)
+# <time datetime="2012-08-28T17:20:54">Today</time>
+
+human_time_tag(time, :comments)
+# <time datetime="2012-08-28T17:20:54">5:20 pm</time>
+
+human_time_tag(time, :comments, pubdate: true)
+# <time datetime="2012-08-28T17:20:54" pubdate="pubdate">5:20 pm</time>
+```
+
+## I18n
+
+You can overwrite the default values in your locale file.
+```ruby
+# config/locales/en.yml
+en:
+  date:
+    formats:
+      today: "Today"
+      tomorrow: "Tomorrow"
+      yesterday: "Yesterday"
+      current_year: "%h %e"
+      other_year: "%h %e, %Y"
+
+  time:
+    formats:
+      today: "%l:%M %p"
+      tomorrow: "Tomorrow"
+      yesterday: "Yesterday"
+      current_year: "%h %e"
+      previous_years: "%h %e, %Y"
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/config/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  date:
+    formats:
+      today: "Today"
+      tomorrow: "Tomorrow"
+      yesterday: "Yesterday"
+      current_year: "%h %e"
+      other_year: "%h %e, %Y"
+
+  time:
+    formats:
+      today: "%l:%M %p"
+      tomorrow: "Tomorrow"
+      yesterday: "Yesterday"
+      current_year: "%h %e"
+      other_year: "%h %e, %Y"

data/human_date.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/human_date/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alexander Zaytsev"]
+  gem.email         = ["alexander@say26.com"]
+  gem.description   = %q{View helpers to make your Dates and Times more human like}
+  gem.summary       = %q{Display dates and times for humans, not robots!}
+  gem.homepage      = "http://github.com/AlexanderZaytsev/human_date"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "human_date"
+  gem.require_paths = ["lib"]
+  gem.version       = HumanTime::VERSION
+
+  gem.add_development_dependency "activesupport"
+  gem.add_development_dependency "actionpack"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "timecop"
+  gem.add_development_dependency "tzinfo"
+end

data/lib/human_date/railtie.rb

@@ -0,0 +1,16 @@
+require 'human_date/view_helpers'
+
+
+module HumanTime
+  class Railtie < Rails::Railtie
+
+    initializer 'rails-i18n' do |app|
+      I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/../../app/config/locales'), '*.yml')]
+      I18n.load_path.flatten!
+    end
+
+    initializer 'human_date.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/human_date/version.rb

@@ -0,0 +1,3 @@
+module HumanTime
+  VERSION = "0.0.1"
+end

data/lib/human_date/view_helpers.rb

@@ -0,0 +1,55 @@
+include ActionView::Helpers::TagHelper
+
+module HumanDate
+  module ViewHelpers
+    def human_date(object, namespace = nil)
+      I18n.localize(object, format: format_for_object(object, namespace)).strip
+    end
+    alias_method :human_time, :human_date
+
+    def human_time_tag(object, namespace_or_options = nil, options = nil)
+      if namespace_or_options.is_a? Hash
+        namespace = nil
+        options = namespace_or_options
+      else
+        namespace = namespace_or_options
+        options ||= {}
+      end
+
+      options.merge! datetime: object.iso8601
+
+      content_tag :time, human_time(object, namespace), options
+    end
+
+  private
+    def format_for_object(object, namespace = nil)
+      if namespace
+        format_for_namespace(object, namespace)
+      else
+        format_name_for_object(object)
+      end
+    end
+
+    def format_for_namespace(object, namespace)
+      object_type = object.respond_to?(:sec) ? 'time' : 'date'
+      format_name = format_name_for_object(object)
+      I18n.translate "#{namespace}.#{object_type}.formats.#{format_name}"
+    end
+
+    def format_name_for_object(object)
+      date = object.to_date
+      if date == Date.current
+        format = :today
+      elsif date == Date.yesterday
+        format = :yesterday
+      elsif date == Date.tomorrow
+        format = :tomorrow
+      elsif date.year == Date.today.year
+        format = :current_year
+      elsif date.year != Date.today.year
+        format = :other_year
+      end
+      format
+    end
+  end
+end

data/lib/human_date.rb

@@ -0,0 +1,5 @@
+require 'active_support/core_ext'
+require 'action_view'
+require 'human_date/version'
+require 'human_date/railtie' if defined?(Rails)
+require 'human_date/view_helpers'

data/spec/human_date_spec.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+include HumanDate::ViewHelpers
+
+
+describe HumanDate::ViewHelpers do
+
+  before do
+    Timecop.freeze Time.parse('2012-08-28 17:20:54 +01:00').in_time_zone
+    @now = Time.zone.now
+    @today = Date.current
+  end
+
+  describe '#human_time' do
+    it 'returns date in human format' do
+      human_date(@today).should eq('Today')
+    end
+
+    it 'returns time in human format' do
+      human_time(@now).should eq('5:20 PM')
+    end
+
+    it 'works with namespaces' do
+      human_time(@now, :comments).should eq('17:20')
+    end
+
+    it 'works with locales' do
+      I18n.locale = :ru
+      human_time(@now).should eq('17:20:54')
+      I18n.locale = :en
+    end
+  end
+
+  describe '#human_time_tag' do
+    it 'returns <time> tag for time' do
+      human_time_tag(@now).should eq('<time datetime="2012-08-28T17:20:54+01:00">5:20 PM</time>')
+    end
+
+    it 'returns <time> tag for date' do
+      human_time_tag(@today).should eq('<time datetime="2012-08-28">Today</time>')
+    end
+
+    it 'allows passing options to <time> tag' do
+      human_time_tag(@today, pubdate: true).should eq('<time datetime="2012-08-28" pubdate="pubdate">Today</time>')
+    end
+
+    it 'allows using namespace' do
+      human_time_tag(@now, :comments).should eq('<time datetime="2012-08-28T17:20:54+01:00">17:20</time>')
+    end
+
+    it 'allows using namespace and passing options to <time> tag' do
+      human_time_tag(@now, :comments, pubdate: true).should eq('<time datetime="2012-08-28T17:20:54+01:00" pubdate="pubdate">17:20</time>')
+    end
+  end
+
+  describe '#format_name_for_object' do
+    it 'returns the valid format for Time' do
+      format_name_for_object(@now).should == :today
+      format_name_for_object(@now + 1.day).should == :tomorrow
+      format_name_for_object(@now - 1.day).should == :yesterday
+      format_name_for_object(@now - 2.days).should == :current_year
+      format_name_for_object(@now - 1.year).should == :other_year
+    end
+
+    it 'returns the valid format for Date' do
+      format_name_for_object(@today).should == :today
+      format_name_for_object(@today + 1.day).should == :tomorrow
+      format_name_for_object(@today - 1.day).should == :yesterday
+      format_name_for_object(@today - 2.days).should == :current_year
+      format_name_for_object(@today - 1.year).should == :other_year
+    end
+  end
+end

data/spec/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  date:
+    formats:
+      today: "Today"
+      current_year: "%h %e"
+      other_year: "%h %e, %Y"
+
+  time:
+    pm: 'PM'
+    am: 'AM'
+    formats:
+      today: "%l:%M %p"
+
+  comments:
+    time:
+      formats:
+        today:  "%H:%M"

data/spec/locales/ru.yml

@@ -0,0 +1,4 @@
+ru:
+  time:
+    formats:
+      today: "%H:%M:%S"

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'human_date'
+require 'timecop'
+
+I18n.locale = :en
+Time.zone = 'London'
+
+I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/locales'), '*.yml')]

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: human_date
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Zaytsev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153176320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153176320
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2153175900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153175900
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153175480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153175480
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2153175060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153175060
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: &2153174640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153174640
+description: View helpers to make your Dates and Times more human like
+email:
+- alexander@say26.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/config/locales/en.yml
+- human_date.gemspec
+- lib/human_date.rb
+- lib/human_date/railtie.rb
+- lib/human_date/version.rb
+- lib/human_date/view_helpers.rb
+- spec/human_date_spec.rb
+- spec/locales/en.yml
+- spec/locales/ru.yml
+- spec/spec_helper.rb
+homepage: http://github.com/AlexanderZaytsev/human_date
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Display dates and times for humans, not robots!
+test_files:
+- spec/human_date_spec.rb
+- spec/locales/en.yml
+- spec/locales/ru.yml
+- spec/spec_helper.rb