time_ago_in_words 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17816bdfb96d3a2e1e9ba53f3dd6e2db69a31682
+  data.tar.gz: c68a369e2faeb1db7aed0dbe215eb63fbe72d492
+SHA512:
+  metadata.gz: 8eac441414aecb182c726f1bf80e7398f642a3c74a461cf78843207abb69ad8878e04e9f0d183703b460e4fdc011ba69a9e7eb6c5d715c368a59ca7722e52ff6
+  data.tar.gz: e80b0d1598bacb957ac0d493c54a60cd47a974448a2426a516ba1722b312526bd0fa942d463989f2fd8277e7622c052f0671a9295d969a4c29b15875a3eb99c3

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,3 @@
+--format documentation
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+script: 'bundle exec rake'

data/.yardopts

@@ -0,0 +1,6 @@
+--readme README.md
+--title 'TimeAgoInWords API Documentation'
+--charset utf-8
+-
+LICENSE.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [In git](https://github.com/elgalu/time_ago_in_words/compare/v0.0.1...HEAD)
+
+### New Features
+* n/a
+
+### Bugfixes
+* n/a
+
+### Chores
+* n/a
+
+## [v0.0.1](https://github.com/elgalu/time_ago_in_words/tree/v0.0.1)
+
+## First gem release
+
+### Features:
+* Humanize elapsed time from some Time instance to Time.now, e.g. '2 hours and 1 minute ago' (Leo Gallucci)

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Leo Gallucci
+
+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,97 @@
+# TimeAgoInWords
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+
+## Description
+
+Humanize elapsed time from some Time instance to Time.now, e.g. '2 hours and 1 minute ago'
+
+## Installation
+
+`$ gem install time_ago_in_words` or add to your [Gemfile][] this line: `gem 'time_ago_in_words'` then run [bundle install][]
+
+## Usage
+
+Just `require 'time_ago_in_words'` and then call Time#ago_in_words method:
+
+```ruby
+require 'rubygems' # if ruby 1.8.7
+require 'time_ago_in_words'
+
+# Comparing from now:
+(Time.now - 10).ago_in_words #=> "10 seconds ago"
+(Time.now - 1).ago_in_words  #=> "1 second ago"
+(Time.now - 60).ago_in_words #=> "1 minute ago"
+(Time.now - 63).ago_in_words #=> "1 minute and 3 seconds ago"
+
+# This is my current time so you can compare
+Time.now #=> 2013-03-06 02:19:23 -0300
+
+Time.local(1981,03,03,20,30,40).ago_in_words #=> "690 days and 5 hours ago"
+Time.local(2013,03,03,20,30,40).ago_in_words #=> "2 days and 5 hours ago"
+Time.local(2013,03,04,20,30,40).ago_in_words #=> "1 day and 5 hours ago"
+Time.local(2013,03,05,20,30,40).ago_in_words #=> "5 hours and 48 minutes ago"
+Time.local(2013,03,05,21,13,40).ago_in_words #=> "5 hours and 5 minutes ago"
+Time.local(2013,03,06,00,30,40).ago_in_words #=> "1 hour and 48 minutes ago"
+Time.local(2013,03,06,01,11,40).ago_in_words #=> "1 hour and 7 minutes ago"
+Time.local(2013,03,06,01,27,40).ago_in_words #=> "51 minutes and 43 seconds ago"
+Time.local(2013,03,06,02,19,20).ago_in_words #=> "3 seconds ago"
+```
+
+## Contributing
+
+1. Fork it.
+2. Make your feature addition or bug fix and create your feature branch.
+3. Update the [Change Log][].
+3. Add specs/tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, create a new Pull Request.
+5. Check that your pull request passes the [build][travis pull requests].
+
+### TODO
++ Add DateTime support. Currently only available for Time objects.
++ Add "N months ago"
++ Add "N years ago"
++ Add "N decades ago"
++ Add "N centuries ago"
++ Add more rspec Examples
++ Implement Time mocking for testing, instead of abusing Time.now on spec
++ Extract [time_ago_in_words][] and implement that alternative precision syntax, e.g. "less than a minute ago"
+
+## License
+
+Released under the MIT License. See the [LICENSE][] file for further details.
+
+## Links
+
+[RubyGems][] | [Documentation][] | [Source][] | [Bugtracker][] | [Build Status][] | [Dependency Status][] | [Code Climate][]
+
+
+[bundle install]: http://gembundler.com/man/bundle-install.1.html
+[Gemfile]: http://gembundler.com/man/gemfile.5.html
+[LICENSE]: LICENSE.md
+[Change Log]: CHANGELOG.md
+
+[RubyGems]: https://rubygems.org/gems/time_ago_in_words
+[Documentation]: http://rubydoc.info/gems/time_ago_in_words
+[Source]: https://github.com/elgalu/time_ago_in_words
+[Bugtracker]: https://github.com/elgalu/time_ago_in_words/issues
+
+[travis pull requests]: https://travis-ci.org/elgalu/time_ago_in_words/pull_requests
+
+[Gem Version]: https://rubygems.org/gems/time_ago_in_words
+[Build Status]: https://travis-ci.org/elgalu/time_ago_in_words
+[Dependency Status]: https://gemnasium.com/elgalu/time_ago_in_words
+[Code Climate]: https://codeclimate.com/github/elgalu/time_ago_in_words
+[Coverage Status]: https://coveralls.io/r/elgalu/time_ago_in_words
+
+[GV img]: https://badge.fury.io/rb/time_ago_in_words.png
+[BS img]: https://travis-ci.org/elgalu/time_ago_in_words.png
+[DS img]: https://gemnasium.com/elgalu/time_ago_in_words.png
+[CC img]: https://codeclimate.com/github/elgalu/time_ago_in_words.png
+[CS img]: https://coveralls.io/repos/elgalu/time_ago_in_words/badge.png?branch=master
+
+[time_ago_in_words]: http://apidock.com/rails/ActionView/Helpers/DateHelper/time_ago_in_words

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/time_ago_in_words.rb

@@ -0,0 +1,3 @@
+require 'time_ago_in_words/version'
+require 'time_ago_in_words/methods'
+require 'time_ago_in_words/core_ext/time'

data/lib/time_ago_in_words/core_ext/time.rb

@@ -0,0 +1,4 @@
+# Polite monkey patching to add Time#ago_in_words method
+class Time
+  include TimeAgoInWords
+end

data/lib/time_ago_in_words/methods.rb

@@ -0,0 +1,41 @@
+module TimeAgoInWords
+  # Convert elapsed seconds from Time.now to the current Time instance
+  #   into an English human readable text like '4 hours and 1 minute ago'
+  # It is not well suited for dates older than 1 year
+  #
+  # @return [String] the humanized elapsed time in pairs
+  #   Always returns a pair of words like:
+  #     '23 days and 3 hours ago'
+  #     '5 hours and 44 minutes ago'
+  #     ' 1 minute and 11 seconds ago'
+  #
+  #   Or just 1 when no hours/minutes/seconds available:
+  #     '23 days ago'
+  #     '17 hours ago'
+  #     '1 minute ago'
+  #     '1 second ago'
+  #
+  #   Ẃhen 0 seconds or Time instance is a future date, returns empty string:
+  #     ""
+  #
+  # @note Inspired from http://stackoverflow.com/a/4136485/511069
+  def ago_in_words
+    secs = Time.now - self
+    return 'just now' if secs > -1 && secs < 1
+    return '' if secs <= -1
+    return 'a very very long time ago' if secs > 60*60*24*100_000
+    ary = [[60, :seconds], [60, :minutes], [24, :hours], [100_000, :days]].map{ |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        "#{n.to_i} #{name}"
+      end
+    }.compact.reverse[0..1]
+    if ary.size == 1
+      ary.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part }
+    else
+      ary.map! {|part| part[0, 2].to_i == 1 ? part.chomp('s') : part[0, 2].to_i == 0 ? nil : part }
+    end
+    ary.compact!
+    ary.size == 0 ? '' : ary.join(' and ') << ' ago'
+  end
+end

data/lib/time_ago_in_words/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'time_ago_in_words'
+
+# Require this file using `require "spec_helper"` within each of your specs
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies.
+  config.order = 'random'
+end

data/spec/time_ago_in_words_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe TimeAgoInWords do
+  it 'should have a version number' do
+    TimeAgoInWords::VERSION.should_not be_nil
+  end
+
+  describe '#ago_in_words' do
+    context 'invalid dates' do
+      it "returns 'just now' when elapsed seconds are less than 1" do
+        Time.now.ago_in_words.should == 'just now'
+        (Time.now - 0.5).ago_in_words.should == 'just now'
+        (Time.now + 0.5).ago_in_words.should == 'just now'
+      end
+
+      it "returns empty string on future dates" do
+        (Time.now + 1.6).ago_in_words.should == ''
+        (Time.now + 100).ago_in_words.should == ''
+        (Time.now + 100_000).ago_in_words.should == ''
+      end
+
+      it "returns 'a very very long time ago' when more than 250 years ago" do
+        (Time.now - 60*60*24*100_001).ago_in_words.should == 'a very very long time ago'
+      end
+
+      it "can handle many days ago" do
+        (Time.now - 60*60*24*99_999).ago_in_words.should == '99999 days ago'
+      end
+
+      it "returns N seconds ago, N seconds ago!" do
+        (Time.now - 2).ago_in_words.should == '2 seconds ago'
+        (Time.now - 33).ago_in_words.should == '33 seconds ago'
+      end
+
+      it "returns 1 second/minute/hour/day ago when 1 ago!" do
+        (Time.now - 1).ago_in_words.should        == '1 second ago'
+        (Time.now - 60).ago_in_words.should       == '1 minute ago'
+        (Time.now - 60*60).ago_in_words.should    == '1 hour ago'
+        (Time.now - 60*60*24).ago_in_words.should == '1 day ago'
+      end
+
+      it "returns 1 second/minute/hour/day and 1 second/minute/hour/day ago when appropriate" do
+        (Time.now - 1 - 60).ago_in_words.should             == '1 minute and 1 second ago'
+        (Time.now - 1*60*60 - 60).ago_in_words.should       == '1 hour and 1 minute ago'
+        (Time.now - 1*60*60*24 - 60*60).ago_in_words.should == '1 day and 1 hour ago'
+      end
+
+      it "returns 1 second/minute/hour/day and 1 second/minute/hour/day ago ignoring third elements (residual irrelevant precisions)" do
+        (Time.now - 1*60*60 - 60 - 10).ago_in_words.should        == '1 hour and 1 minute ago'
+        (Time.now - 1*60*60*24 - 1*60*60 - 100).ago_in_words.should == '1 day and 1 hour ago'
+        (Time.now - 9*60*60*24 - 3*60*60 - 100).ago_in_words.should == '9 days and 3 hours ago'
+      end
+    end
+  end
+end

data/time_ago_in_words.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_ago_in_words/version'
+
+Gem::Specification.new do |spec|
+
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = "time_ago_in_words"
+  spec.version       = TimeAgoInWords::VERSION
+  spec.summary       = %q{Humanize elapsed time from some Time instance to Time.now, e.g. '2 hours and 1 minute ago'}
+  spec.description   = spec.summary
+
+  spec.required_ruby_version     = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 2'
+
+  spec.license       = 'MIT'
+
+  spec.authors       = ["Leo Gallucci"]
+  spec.email         = ["elgalu3@gmail.com"]
+  spec.homepage      = "https://github.com/elgalu/time_ago_in_words"
+
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "redcarpet", ">= 2.2"
+  spec.add_development_dependency "yard", ">= 0.8.5.2"
+  spec.add_development_dependency "simplecov", ">= 0.7.1"
+  spec.add_development_dependency 'coveralls', '>= 0.5.8'
+
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: time_ago_in_words
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leo Gallucci
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.5.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+description: Humanize elapsed time from some Time instance to Time.now, e.g. '2 hours
+  and 1 minute ago'
+email:
+- elgalu3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/time_ago_in_words.rb
+- lib/time_ago_in_words/core_ext/time.rb
+- lib/time_ago_in_words/methods.rb
+- lib/time_ago_in_words/version.rb
+- spec/spec_helper.rb
+- spec/time_ago_in_words_spec.rb
+- time_ago_in_words.gemspec
+homepage: https://github.com/elgalu/time_ago_in_words
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Humanize elapsed time from some Time instance to Time.now, e.g. '2 hours
+  and 1 minute ago'
+test_files:
+- spec/spec_helper.rb
+- spec/time_ago_in_words_spec.rb
+has_rdoc: