date_range_formatter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b9d15a59e9a2f2722de95a887f608f331b19ccb
-  data.tar.gz: dba7ef1ea9eacb33388e2c6faac32392adedc36f
+  metadata.gz: e002e59aee2911d9192d69da6ed4ab83f1091538
+  data.tar.gz: fb8a825c58f5ea82b846fab2fabb4ef334bf4120
 SHA512:
-  metadata.gz: 003892b478ce3da5fa3a40e9be54799a39e8b6fe51b4381f02b8db697d13d622984e12ced13f0d2db94f477e326de7086a04125c2cff024e5326001124a7ccfc
-  data.tar.gz: cc238fe9dc7ed77488f613d2d4c710aa8dbb6de6a2d6aa79274adb7e9cedcbc1f11481c032903b378e7fcba4519b53c792fc37739d1f7d97d85c806c2319d58e
+  metadata.gz: 46c3ed5474248d53be8ea36c90b90a71e21632e4361420d89f64e6bbdb8b54a2bf2a2266af107787cfaa4a2ef5b457261a6e78152533e54fea393b7dbf2a7851
+  data.tar.gz: a98d262d8a491a608e4eee483bff1ca7ba746618e2b0bc8e8dae05cc41b01ed90901080842cbd387f20d058d889d30a8aa1ef678c4cc121b2a1a05fdfc5cb4c5

data/README.md

@@ -1,4 +1,59 @@
-date_range_formatter
-====================
+# Date Range Formatter
 
 [![Build Status](https://travis-ci.org/darkleaf/date_range_formatter.svg?branch=master)](https://travis-ci.org/darkleaf/date_range_formatter)
+[![Gem Version](https://badge.fury.io/rb/date_range_formatter.svg)](http://badge.fury.io/rb/date_range_formatter)
+[![Build Status](https://drone.io/github.com/darkleaf/date_range_formatter/status.png)](https://drone.io/github.com/darkleaf/date_range_formatter/latest)
+
+This gem makes working with dates more pretty. It works well with Ruby application and most frameworks like  [Ruby on Rails](https://github.com/rails/rails "Ruby on Rails").
+
+## Installation
+Very simple. Just add this code to Gemfile:
+
+    gem 'date_range_formatter'
+
+## Usage
+
+Imagine the situation when you need to show dates of some stuff at your website. For example:
+
+    1 - 9 May 2014
+    2 January 2015
+    15 July 2016 - 13 February 2017
+
+To show this dates in this format you need to describe the format of displaying dates like 'default' in your locale file:
+
+```yaml
+en:
+  date_range:
+    default: # it's the 'format'
+      separator: " - " # added ' - ' symbol to the date ranges
+      month: "%B"
+      year: "%Y"
+      same_months: "%{from_day}-%{until_day} %{month} %{year}"
+      same_years: "%{from_day} %{from_month} - %{until_day} %{until_month} %{year}"
+```
+
+After that you should call the module DateRangeFormatter with arguments wchich describes the range of dates and format to display. For example, we have date_beginning, date_ending and format by default:
+
+```ruby
+DateRangeFormatter.format('2013-01-14', '2013-02-15')
+#=> '14 January - 15 February 2013'
+
+DateRangeFormatter.format_range(['2013-02-20', '2013-01-14', '2013-01-15'])
+#=> '14 January - 20 February 2013'
+```
+
+If you want to show dates by another format, you can call it:
+
+```ruby
+date_beginning = Date.new(2013, 01, 14)
+date_ending = Date.new(2014, 02, 15)
+date_range_str = DateRangeFormatter.format(date_beginning, date_ending, 'short')
+```
+
+That's all. Enjoy yout profit!
+
+## Other
+
+This idea was appeared by looking at the [article](https://coderwall.com/p/fkg-ng). Thanks to [@mbillard](https://github.com/mbillard).
+
+

data/lib/date_range_formatter/version.rb

@@ -1,3 +1,3 @@
 module DateRangeFormatter
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/date_range_formatter.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/string/conversions.rb'
 require 'active_support/i18n'
 
 I18n.load_path << "#{File.dirname(__FILE__)}/locale/en.yml"
@@ -6,6 +7,15 @@ module DateRangeFormatter
 
   class << self
     def format(date_beginning, date_ending, format = :default)
+      format_range [date_beginning, date_ending], format
+    end
+
+    def format_range(enumerable_range, format = :default)
+      return if enumerable_range.none?
+      sorted_range = enumerable_range.map(&:to_date).sort
+      date_beginning = sorted_range.first
+      date_ending = sorted_range.last
+
       f = Formatter.new date_beginning, date_ending, format
       f.to_s
     end
@@ -21,7 +31,7 @@ module DateRangeFormatter
     end
 
     def to_s
-      return I18n.l from_date, format: format if same_days?
+      return I18n.t 'same_days', same_days_data.merge(scope: ['date_range', format]) if same_days?
       return I18n.t 'same_months', same_months_data.merge(scope: ['date_range', format]) if same_months?
       return I18n.t 'same_years', same_years_data.merge(scope: ['date_range', format]) if same_years?
 
@@ -44,6 +54,14 @@ module DateRangeFormatter
     end
 
     private
+    def same_days_data
+      {
+          day: from_date.day,
+          month: formatted_month(from_date),
+          year: formatted_year(from_date),
+      }
+    end
+
     def same_months_data
       {
         from_day: from_date.day,

data/lib/locale/en.yml

@@ -4,5 +4,6 @@ en:
       separator: " - "
       month: "%B"
       year: "%Y"
+      same_days: "%{day} %{month} %{year}"
       same_months: "%{from_day}-%{until_day} %{month} %{year}"
       same_years: "%{from_day} %{from_month} - %{until_day} %{until_month} %{year}"

data/test/lib/date_range_formatter_test.rb

@@ -5,11 +5,9 @@ class DateRangeFormatterTest < TestHelper
   end
 
   def test_same_days
-    date_beginning = Date.new(2013, 01, 14)
-    date_ending = Date.new(2013, 01, 14)
-    date_range_str = DateRangeFormatter.format(date_beginning, date_ending)
+    date_range_str = DateRangeFormatter.format('2013-01-14', '2013-01-14')
 
-    assert_equal '2013-01-14', date_range_str
+    assert_equal '14 January 2013', date_range_str
   end
 
   def test_same_months

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: date_range_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mikhail Kuzmin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Date range formatter