friendly_timestamp 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46ffda3910a6655ce1efc5b0b890a5dd8c356625
+  data.tar.gz: 0492b42d48ce76723331b5eaf4b6a7ae5a08ee97
+SHA512:
+  metadata.gz: 7debde53f8dcaead2f86f0c60e02a5fadcc1f8fd3f960c842722b96b1ba89d8e62d6f864ea6228f637d4485c800a858c3588c5572b9daf36ee9355b0ec2bceed
+  data.tar.gz: 22f1c27987239c89bdc16eb0e5b9ae6afd1aea48598b77fd9493a555b8db8f4df4d7c123333e977e6c89cdb297e88825298db10a3dc54355e7366444992be1e8

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kuroun.seung@rackspace.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in friendly_timestamp.gemspec
+gem 'activesupport'
+gem 'rspec-rails', '3.5.2'
+gem 'pry-byebug', '3.4.0'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kuroun
+
+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/app/assets/javascripts/friendly_timestamp.js

@@ -0,0 +1,33 @@
+var get_cookie, set_cookie;
+
+$(document).ready(function() {
+  var d, n;
+  d = new Date;
+  n = d.getTimezoneOffset();
+  return set_cookie('fts_offset', n, 30);
+});
+
+set_cookie = function(cname, cvalue, exdays) {
+  var d;
+  d = new Date;
+  d.setTime(d.getTime() + exdays * 24 * 60 * 60 * 1000);
+  return document.cookie = cname + '=' + cvalue + ';expires=' + d.toUTCString() + ';path=/';
+};
+
+get_cookie = function(cname) {
+  var c, ca, i, name;
+  name = cname + '=';
+  ca = document.cookie.split(';');
+  i = 0;
+  while (i < ca.length) {
+    c = ca[i];
+    while (c.charAt(0) === ' ') {
+      c = c.substring(1);
+    }
+    if (c.indexOf(name) === 0) {
+      return c.substring(name.length, c.length);
+    }
+    i++;
+  }
+  return '';
+};

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "friendly_timestamp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/friendly_timestamp.rb

@@ -0,0 +1,87 @@
+require 'friendly_timestamp/engine'
+require 'friendly_timestamp/version'
+require 'active_support/all'
+require 'pry'
+
+ONE_MINUTE = 60
+ONE_HOUR = ONE_MINUTE * 60
+ONE_DAY = ONE_HOUR * 24
+ONE_WEEK = ONE_DAY * 7
+ONE_MONTH = ONE_DAY * 30
+ONE_YEAR = ONE_DAY * 365
+
+class Time
+  def friendly_format
+    # convert time to local time
+    # using minute format if less hour
+    # using hour format if less than a day
+    # using full format otherwise (Thurs, Nov 12th 2016)
+    case (Time.now - self).to_i.abs
+    when 0...ONE_MINUTE
+      'a moment ago'
+    when ONE_MINUTE...ONE_HOUR
+      minute_format
+    when ONE_HOUR...ONE_DAY
+      hour_format
+    when ONE_DAY...ONE_WEEK
+      day_format
+    when ONE_WEEK...ONE_MONTH
+      week_format
+    when ONE_MONTH...ONE_YEAR
+      month_format
+    when ONE_YEAR...ONE_YEAR * 5
+      year_format
+    else
+      full_format
+    end
+  end
+
+  def minute_format
+    in_minutes = diff_utc / ONE_MINUTE
+    "#{word_form(in_minutes, 'minute')} ago"
+  end
+
+  def hour_format
+    in_hours = diff_utc / ONE_HOUR
+    "#{word_form(in_hours, 'hour')} ago"
+  end
+
+  def day_format
+    in_days = diff_utc / ONE_DAY
+    "#{word_form(in_days, 'day')} ago"
+  end
+
+  def week_format
+    in_weeks = diff_utc / ONE_WEEK
+    "#{word_form(in_weeks, 'week')} ago"
+  end
+
+  def month_format
+    in_months = diff_utc / ONE_MONTH
+    "#{word_form(in_months, 'month')} ago"
+  end
+
+  def year_format
+    in_years = diff_utc / ONE_YEAR
+    "#{word_form(in_years, 'year')} ago"
+  end
+
+  def full_format(mn_offset = 0)
+    # multiplle -1 here because js represent time difference varies from how rails represents
+    # get offset in hour
+    hour_offset = (-1 * mn_offset.to_f / 60)
+    fts_local_time = in_time_zone hour_offset
+    fts_local_time.strftime("%a, %b #{fts_local_time.day.ordinalize} %Y at %H:%M %Z")
+  end
+
+  private
+
+  def word_form(num, word)
+    word = num.round > 1 ? word.pluralize : word.singularize
+    num > num.round ? "more than #{num.round} #{word}" : "less than #{num.round} #{word}"
+  end
+
+  def diff_utc
+    (Time.now - self).to_f.abs
+  end
+end

data/lib/friendly_timestamp/engine.rb

@@ -0,0 +1,5 @@
+require 'rails/engine'
+
+module FriendlyTimestamp
+  class Engine < Rails::Engine; end
+end

data/lib/friendly_timestamp/version.rb

@@ -0,0 +1,3 @@
+module FriendlyTimestamp
+  VERSION = :'1.0.1'
+end

data/spec/friendly_timestamp_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Time do
+  it 'has a version number' do
+    expect(FriendlyTimestamp::VERSION).not_to be nil
+  end
+
+  describe 'word_form' do
+    # make sure that return more than or less than phrase
+    # make sure that number is no decimal form
+    # make sure that it returns appropriate singular and plural form of word
+    word = 'minute'
+    context 'when number after decimal point is equal or more than 5' do
+      num = 1.5
+      it 'is supposed to be rounded up' do
+        expect(Time.now.send(:word_form, num, word)).to eq 'less than 2 minutes'
+      end
+    end
+
+    context 'when number after decimal point is less than 5' do
+      num = 1.4
+      it 'is supposed to be rounded down' do
+        expect(Time.now.send(:word_form, num, word)).to eq 'more than 1 minute'
+      end
+    end
+  end
+
+  describe '#friendly_format' do
+    context 'when less than a minute' do
+      time = Time.now - 30
+      it 'returns string of moment ago' do
+        expect(time.friendly_format).to eq 'a moment ago'
+      end
+    end
+
+    context 'when from 1 minute to less 60 minute' do
+      time = Time.now - 60
+      it 'returns in minute format' do
+        expect(time.friendly_format).to include '1 minute ago'
+      end
+    end
+
+    context 'when from 1 hour to less than 24 hours' do
+      time = Time.now - 60 * 60
+      it 'returns in hour format' do
+        expect(time.friendly_format).to include '1 hour ago'
+      end
+    end
+
+    context 'when from 1 day to less than 7 days' do
+      time = Time.now - 60 * 60 * 24
+      it 'return in day format' do
+        expect(time.friendly_format).to include '1 day ago'
+      end
+    end
+
+    context 'when from 1 week to less than 4 weeks' do
+      time = Time.now - 60 * 60 * 24 * 7
+      it 'returns in week format' do
+        expect(time.friendly_format).to include '1 week ago'
+      end
+    end
+
+    context 'when from 1 month to less than 12 months' do
+      time = Time.now - 60 * 60 * 24 * 30
+      it 'returns in month format' do
+        expect(time.friendly_format).to include '1 month ago'
+      end
+    end
+
+    context 'when from 1 year to less than 10 years' do
+      time = Time.now - 60 * 60 * 24 * 365
+      it 'returns in year format' do
+        expect(time.friendly_format).to include '1 year ago'
+      end
+    end
+
+    context 'when more than or equal 5 years' do
+      time = Time.now - 60 * 60 * 24 * 365 * 5
+      it 'returns full format' do
+        # match regular expression (Thu, Nov 17th 2016 at 17:50 UTC)
+        expect(time.friendly_format).to match(/((Sun)|(Mon)|(Tue)|(Wed)|(Thu)|(Fri)|(Sat))(,\s)((Jan)|(Feb)|(Mar)|(Apr)|(May)|(Jun)|(Jul)|(Aug)|(Sep)|(Oct)|(Nov)|(Dec))(\s)[0-9]{1,2}((st)|(nd)|(rd)|(th))(\s)[0-9]{4}(\s)(at)(\s)[0-9]{1,2}(:)[0-9]{1,2}(\s)[A-Z]{3}/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'friendly_timestamp'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: friendly_timestamp
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Kuroun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+description: 
+email:
+- kuroun.seung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- app/assets/javascripts/friendly_timestamp.js
+- bin/console
+- bin/setup
+- lib/friendly_timestamp.rb
+- lib/friendly_timestamp/engine.rb
+- lib/friendly_timestamp/version.rb
+- spec/friendly_timestamp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kuroun/friendly_timestamp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for display time and date based on local time zone in verbal informal
+  saying like more than two day ago, less one week ago...etc. It also provides method
+  for full format of date and time in local time zone as well.
+test_files: []