time_will_tell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d045ed7cc8e6baa8ef712946a170497f1d1ade3
+  data.tar.gz: 72c9d0576641152da145b5b6297c8d6d04cea39a
+SHA512:
+  metadata.gz: 860917b1eea35691792b65bf095e24bcdb24767712a4ccbca01f4f05d9466b67b03246bdc9195debcb0b4af799a82a70b52f42079afea36c3d33cf3117f0d90f
+  data.tar.gz: d7744d0cba56ef69ed4c189fc660d64349be7ec67fcf7a39e309e7d5f6170ee156afe041117a3a2bb7bad0e14be82399595b7cefef9528dd111b385790b93da9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michel Billard
+
+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,29 @@
+# TimeWillTell
+
+Specialized conversions of dates and times to strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'time_will_tell'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_will_tell
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/time_will_tell/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")

data/lib/generators/USAGE

@@ -0,0 +1,3 @@
+To copy the default TimeWillTell locale file to your Rails App just do:
+
+    rails generate time_will_tell:install

data/lib/generators/install_generator.rb

@@ -0,0 +1,12 @@
+module TimeWillTell
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy TimeWillTell default files"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_locales
+        directory "config/locales"
+      end
+    end
+  end
+end

data/lib/generators/time_will_tell/templates/config/locales/time_will_tell.en.yml

@@ -0,0 +1,23 @@
+en:
+  time_will_tell:
+    date_range:
+      different_months_same_year: "%{from_month} %{from_day} %{sep} %{to_month} %{to_day}, %{year}"
+      different_years: "%{from_month} %{from_day}, %{from_year} %{sep} %{to_month} %{to_day}, %{to_year}"
+      same_month: "%{month} %{from_day} %{sep} %{to_day}, %{year}"
+      same_date: "%{month} %{from_day}, %{year}"
+
+    distance_in_words:
+      template: "%{count} %{unit}"
+      template_long: "%{rest} and %{last}"
+
+      units:
+        second: second
+        minute: minute
+        hour: hour
+        day: day
+        month: month
+        year: year
+
+      special:
+        half_an_hour: half an hour
+        and_a_half: and a half

data/lib/time_will_tell/helpers/date_helper.rb

@@ -0,0 +1,71 @@
+module TimeWillTell
+  module Helpers
+    module DateHelper
+
+      DISTANCES_OF_TIME = [
+        { unit: :year,   minutes_per_unit: 365*24*60 },
+        { unit: :month,  minutes_per_unit: 30*24*60 },
+        { unit: :day,    minutes_per_unit: 24*60 },
+        { unit: :hour,   minutes_per_unit: 60 },
+        { unit: :minute, minutes_per_unit: 1 }
+      ].freeze
+
+      def exact_distance_of_time_in_words(from_time, to_time, options = {})
+        options = {
+          scope: :'time_will_tell.distance_in_words'
+        }.merge!(options)
+
+        include_seconds = options.fetch(:include_seconds, false)
+
+        from_time, to_time = to_time, from_time if from_time > to_time
+        timespan = to_time - from_time
+        distance_in_minutes = (timespan / 60.0).to_i
+
+        distance_in_words = []
+
+        I18n.with_options scope: options[:scope] do |locale|
+          DISTANCES_OF_TIME.each do |distance_of_time|
+            unit =             distance_of_time[:unit]
+            minutes_per_unit = distance_of_time[:minutes_per_unit].to_f
+
+            count = (distance_in_minutes / minutes_per_unit).to_i
+
+            next if count == 0
+
+            if count == 30 && unit == :minute
+              if distance_in_words.empty?
+                distance_in_words << locale.t(:'special.half_an_hour')
+              else
+                distance_in_words << locale.t(:'special.and_a_half')
+              end
+            else
+              distance_in_words << pluralize_unit_with_locale(count, unit, locale)
+            end
+
+            distance_in_minutes -= count * minutes_per_unit
+          end
+
+          if include_seconds && (seconds_count = (timespan % 60).to_i) > 0
+            distance_in_words << pluralize_unit_with_locale(seconds_count, 'second', locale)
+          end
+
+          if distance_in_words.length > 2
+            locale.t(:template_long, rest: distance_in_words[0..-2].join(' '), last: distance_in_words.last)
+          else
+            distance_in_words.join(' ')
+          end
+        end
+      end
+
+      private
+
+      # Simplified reimplementation of Rails' ActionView::Helpers::TextHelper::pluralize
+      def pluralize_unit_with_locale(count, unit, locale)
+        singular = locale.t(:"units.#{unit}")
+        unit_word = count == 1 ? singular : singular.pluralize
+        locale.t(:template, count: count, unit: unit_word)
+      end
+
+    end
+  end
+end

data/lib/time_will_tell/helpers/date_range_helper.rb

@@ -0,0 +1,47 @@
+module TimeWillTell
+  module Helpers
+    module DateRangeHelper
+
+      def date_range(from_date, to_date, options = {})
+        format    = options.fetch(:format, :short)
+        scope     = options.fetch(:scope, 'time_will_tell.date_range')
+        separator = options.fetch(:separator, '—')
+
+        month_names = format.to_sym == :short ? I18n.t("date.abbr_month_names") : I18n.t("date.month_names")
+
+        from_date, to_date = to_date, from_date if from_date > to_date
+        from_day   = from_date.day
+        from_month = month_names[from_date.month]
+        from_year  = from_date.year
+        to_day     = to_date.day
+
+        dates = { from_day: from_day, sep: separator }
+
+        if from_date == to_date
+          template = :same_date
+          dates.merge!(month: from_month, year: from_year)
+        elsif from_date.month == to_date.month && from_date.year == to_date.year
+          template = :same_month
+          dates.merge!(to_day: to_day, month: from_month, year: from_year)
+        else
+          to_month = month_names[to_date.month]
+
+          dates.merge!(from_month: from_month, to_month: to_month, to_day: to_day)
+
+          if from_date.year == to_date.year
+            template = :different_months_same_year
+            dates.merge!(year: from_year)
+          else
+            to_year = to_date.year
+
+            template = :different_years
+            dates.merge!(from_year: from_year, to_year: to_year)
+          end
+        end
+
+        I18n.t("#{scope}.#{template}", dates)
+      end
+
+    end
+  end
+end

data/lib/time_will_tell/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+require 'time_will_tell/helpers/date_helper'
+require 'time_will_tell/helpers/date_range_helper'
+
+module TimeWillTell
+  class Railtie < Rails::Railtie
+    config.eager_load_namespaces << TimeWillTell::Helpers::DateHelper
+    config.eager_load_namespaces << TimeWillTell::Helpers::DateRangeHelper
+  end
+end

data/lib/time_will_tell/version.rb

@@ -0,0 +1,3 @@
+module TimeWillTell
+  VERSION = "0.0.1".freeze
+end

data/lib/time_will_tell.rb

@@ -0,0 +1,2 @@
+require 'time_will_tell/version'
+require 'time_will_tell/railtie' if defined?(Rails)

data/spec/fixtures/locales/time_will_tell.fr.yml

@@ -0,0 +1,53 @@
+fr:
+  date:
+    abbr_month_names:
+      - ~
+      - jan.
+      - fév.
+      - mar.
+      - avr.
+      - mai
+      - juin
+      - juil.
+      - août
+      - sept.
+      - oct.
+      - nov.
+      - déc.
+    month_names:
+      - ~
+      - janvier
+      - février
+      - mars
+      - avril
+      - mai
+      - juin
+      - juillet
+      - août
+      - septembre
+      - octobre
+      - novembre
+      - décembre
+
+  time_will_tell:
+    date_range:
+      different_months_same_year: "%{from_day} %{from_month} %{sep} %{to_day} %{to_month} %{year}"
+      different_years: "%{from_day} %{from_month} %{from_year} %{sep} %{to_day} %{to_month} %{to_year}"
+      same_month: "%{from_day} %{sep} %{to_day} %{month} %{year}"
+      same_date: "%{from_day} %{month} %{year}"
+
+    distance_in_words:
+      template: "%{count} %{unit}"
+      template_long: "%{rest} et %{last}"
+
+      units:
+        second: seconde
+        minute: minute
+        hour: heure
+        day: jour
+        month: mois
+        year: an
+
+      special:
+        half_an_hour: une demie heure
+        and_a_half: et demie

data/spec/helpers/date_helper_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe TimeWillTell::Helpers::DateHelper do
+  # A helper instance with the DateHelper module included
+  let(:helper) do
+    Class.new do
+      include TimeWillTell::Helpers::DateHelper
+    end.new
+  end
+
+  SECOND = 1
+  MINUTE = 60 * SECOND
+  HOUR   = 60 * MINUTE
+  DAY    = 24 * HOUR
+  MONTH  = 30 * DAY
+  YEAR   = 365 * DAY
+
+  describe '#exact_distance_of_time_in_words' do
+    {
+      [2 * HOUR + 33 * MINUTE + 44 * SECOND] => '2 hours 33 minutes',
+      [1 * HOUR + 30 * MINUTE] => '1 hour and a half',
+      [3 * YEAR + 11 * MONTH + 21 * SECOND, include_seconds: true] => '3 years 11 months and 21 seconds',
+      [45 * DAY + 1 * MINUTE] => '1 month 15 days and 1 minute',
+      [1 * DAY + 2 * HOUR + 30 * MINUTE + 5 * SECOND, include_seconds: true] => '1 day 2 hours and a half and 5 seconds',
+      [30 * MINUTE] => 'half an hour',
+    }.each do |args, expected|
+      it "outputs '#{expected}'" do
+        timespan = args[0]
+        options  = args[1]
+
+        from_time = Time.now
+        to_time   = from_time + timespan
+
+        expect(
+          helper.exact_distance_of_time_in_words(*[from_time, to_time, options].compact)
+        ).to eq expected
+      end
+    end
+
+    it 'swaps from_time and to_time to get a positive timespan' do
+      to_time = Time.now
+      from_time = Time.now + (4 * DAY + 15 * MINUTE)
+
+      expect(
+        helper.exact_distance_of_time_in_words(from_time, to_time)
+      ).to eq '4 days 15 minutes'
+    end
+
+    context 'with a custom locale' do
+      let(:locale) { :fr }
+
+      {
+        [2 * HOUR + 33 * MINUTE + 44 * SECOND] => '2 heures 33 minutes',
+        [1 * HOUR + 30 * MINUTE] => '1 heure et demie',
+        [3 * YEAR + 11 * MONTH + 21 * SECOND, include_seconds: true] => '3 ans 11 mois et 21 secondes',
+        [45 * DAY + 1 * MINUTE] => '1 mois 15 jours et 1 minute',
+        [1 * DAY + 2 * HOUR + 30 * MINUTE + 5 * SECOND, include_seconds: true] => '1 jour 2 heures et demie et 5 secondes',
+        [30 * MINUTE] => 'une demie heure',
+      }.each do |args, expected|
+        it "outputs '#{expected}'" do
+          timespan = args[0]
+          options  = args[1]
+
+          from_time = Time.now
+          to_time   = from_time + timespan
+
+          I18n.with_locale locale do
+            expect(
+              helper.exact_distance_of_time_in_words(*[from_time, to_time, options].compact)
+            ).to eq expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/helpers/date_range_helper_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe TimeWillTell::Helpers::DateRangeHelper do
+  # A helper instance with the DateRangeHelper module included
+  let(:helper) do
+    Class.new do
+      include TimeWillTell::Helpers::DateRangeHelper
+    end.new
+  end
+
+  describe '#date_range' do
+    {
+      # short form
+      [Date.new(2012, 10, 3), Date.new(2012, 10, 8)] => 'Oct 3 — 8, 2012',
+      [Date.new(2013, 1, 30), Date.new(2013, 2, 5)] => 'Jan 30 — Feb 5, 2013',
+      [Date.new(2012, 12, 26), Date.new(2013, 1, 3)] => 'Dec 26, 2012 — Jan 3, 2013',
+      [Date.new(2013, 8, 24), Date.new(2013, 8, 24)] => 'Aug 24, 2013',
+      [Date.new(2014, 2, 10), Date.new(2015, 2, 10)] => 'Feb 10, 2014 — Feb 10, 2015',
+
+      # long form
+      [Date.new(2012, 10, 3), Date.new(2012, 10, 8), format: :long] => 'October 3 — 8, 2012',
+      [Date.new(2013, 1, 30), Date.new(2013, 2, 5), format: :long] => 'January 30 — February 5, 2013',
+      [Date.new(2012, 12, 26), Date.new(2013, 1, 3), format: :long] => 'December 26, 2012 — January 3, 2013',
+      [Date.new(2013, 8, 24), Date.new(2013, 8, 24), format: :long] => 'August 24, 2013',
+      [Date.new(2014, 2, 10), Date.new(2015, 2, 10), format: :long] => 'February 10, 2014 — February 10, 2015',
+    }.each do |args, expected|
+      it "outputs '#{expected}" do
+        from_date = args[0]
+        to_date   = args[1]
+        options   = args[2]
+
+        expect(
+          helper.date_range(*[from_date, to_date, options].compact)
+        ).to eq expected
+      end
+    end
+
+    it 'swaps from_date and to_date to get a positive range' do
+      from_date = Date.new(2014, 3, 17)
+      to_date   = Date.new(2000, 1, 1)
+
+      expect(
+        helper.date_range(from_date, to_date)
+      ).to eq 'Jan 1, 2000 — Mar 17, 2014'
+    end
+
+    it 'accepts a custom separator' do
+      from_date = Date.new(2013, 10, 31)
+      to_date   = Date.new(2013, 12, 25)
+
+      expect(
+        helper.date_range(from_date, to_date, separator: '~')
+      ).to eq 'Oct 31 ~ Dec 25, 2013'
+    end
+
+    context 'with a custom locale' do
+      let(:locale) { :fr }
+
+      {
+        # short form
+        [Date.new(2012, 10, 3), Date.new(2012, 10, 8)] => '3 — 8 oct. 2012',
+        [Date.new(2013, 1, 30), Date.new(2013, 2, 5)] => '30 jan. — 5 fév. 2013',
+        [Date.new(2012, 12, 26), Date.new(2013, 1, 3)] => '26 déc. 2012 — 3 jan. 2013',
+        [Date.new(2013, 8, 24), Date.new(2013, 8, 24)] => '24 août 2013',
+        [Date.new(2014, 2, 10), Date.new(2015, 2, 10)] => '10 fév. 2014 — 10 fév. 2015',
+
+        # long form
+        [Date.new(2012, 10, 3), Date.new(2012, 10, 8), format: :long] => '3 — 8 octobre 2012',
+        [Date.new(2013, 1, 30), Date.new(2013, 2, 5), format: :long] => '30 janvier — 5 février 2013',
+        [Date.new(2012, 12, 26), Date.new(2013, 1, 3), format: :long] => '26 décembre 2012 — 3 janvier 2013',
+        [Date.new(2013, 8, 24), Date.new(2013, 8, 24), format: :long] => '24 août 2013',
+        [Date.new(2014, 2, 10), Date.new(2015, 2, 10), format: :long] => '10 février 2014 — 10 février 2015',
+      }.each do |args, expected|
+        it "outputs '#{expected}'" do
+          from_date = args[0]
+          to_date   = args[1]
+          options   = args[2]
+
+          I18n.with_locale locale do
+            expect(
+              helper.date_range(*[from_date, to_date, options].compact)
+            ).to eq expected
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+require 'time_will_tell'
+
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '../lib/generators/time_will_tell/templates/config/locales/*.yml') ]
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), './fixtures/locales/*.yml') ]
+I18n.default_locale = :en
+
+# Require this file using `require 'spec_helper'` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+end

data/time_will_tell.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_will_tell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_will_tell"
+  spec.version       = TimeWillTell::VERSION
+  spec.authors       = ["Michel Billard"]
+  spec.email         = ["michel@mbillard.com"]
+  spec.summary       = %q{Specialized conversions of dates and times to strings.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://github.com/mbillard/time_will_tell"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties', '>= 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: time_will_tell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Billard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- michel@mbillard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/USAGE
+- lib/generators/install_generator.rb
+- lib/generators/time_will_tell/templates/config/locales/time_will_tell.en.yml
+- lib/time_will_tell.rb
+- lib/time_will_tell/helpers/date_helper.rb
+- lib/time_will_tell/helpers/date_range_helper.rb
+- lib/time_will_tell/railtie.rb
+- lib/time_will_tell/version.rb
+- spec/fixtures/locales/time_will_tell.fr.yml
+- spec/helpers/date_helper_spec.rb
+- spec/helpers/date_range_helper_spec.rb
+- spec/spec_helper.rb
+- time_will_tell.gemspec
+homepage: http://github.com/mbillard/time_will_tell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Specialized conversions of dates and times to strings.
+test_files:
+- spec/fixtures/locales/time_will_tell.fr.yml
+- spec/helpers/date_helper_spec.rb
+- spec/helpers/date_range_helper_spec.rb
+- spec/spec_helper.rb