formatter-date 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a1d1b7ed3503913cbdf6b9b495f683639888cbb
+  data.tar.gz: a0a7c966c14714e23ed248c0766e9bf1c10d6a2a
+SHA512:
+  metadata.gz: e8ceec176d6c5da892ee830537a32adc056cc739c947f695624b05fcf80b69f224d5ebc8814ee99733a085cba135735653eb1d34461364af917cd1a1a31a0df6
+  data.tar.gz: 4b6f9973a336b95739816e897479efbbe69cac118b76228b8c863d529a64da892663f2b66b5794d35263efd5a4a18d30ff58e3db386fb76d6616c5fa826ffaf2

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,77 @@
+AllCops:
+  Exclude:
+    - Gemfile
+    - bin/**/*
+    - vendor/**/*
+
+Encoding:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+  Exclude:
+    - test/**/*
+
+LineLength:
+  Max: 80
+
+# Class
+ClassLength:
+  Max: 80
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+AccessModifierIndentation:
+  EnforcedStyle: indent
+
+# Error
+RaiseArgs:
+  EnforcedStyle: exploded
+
+SignalException:
+  EnforcedStyle: semantic
+
+# Method
+MethodLength:
+  Max: 10
+
+SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    reduce: 'inject'
+    detect: 'find'
+    find_all: 'select'
+
+# Parameter
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+BracesAroundHashParameters:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Block
+BlockNesting:
+  Max: 3
+
+# Brackets
+SpaceInsideBrackets:
+  Enabled: true
+
+# Hash
+IndentHash:
+  EnforcedStyle: consistent
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+
+# String
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: 'bundle exec rake ci'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Terje Larsen
+
+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,56 @@
+# formatter-date
+
+Format Time/DateTime with time zone offset
+
+[![Gem Version](https://badge.fury.io/rb/formatter-date.svg)](http://badge.fury.io/rb/formatter-date)
+[![Build
+Status](https://travis-ci.org/terlar/formatter-date.svg)](https://travis-ci.org/terlar/formatter-date)
+[![Code Climate](https://codeclimate.com/github/terlar/formatter-date.png)](https://codeclimate.com/github/terlar/formatter-date)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formatter-date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formatter-date
+
+## Usage
+
+```ruby
+# By default it will use the ISO8601 formatting.
+formatter = Formatter::Date.new('Asia/Karachi')
+formatter.format(Time.now) # "2015-02-22T03:48:07+05:00"
+
+# Available formats iso8601, xmlschema, jisx0301, rfc3339
+formatter = Formatter::Date.new('Asia/Karachi', :jisx0301)
+formatter.format(Time.now) # "H27.02.22T03:48:07+05:00"
+
+# You can also provide fractional seconds to be used with formats
+formatter = Formatter::Date.new('Asia/Karachi', :iso8601, 2)
+formatter.format(Time.now) # 2015-02-22T03:48:07.46+05:00
+
+# Provide a custom string formatting (delegates to strftime)
+formatter = Formatter::Date.new('Asia/Karachi', '%FT%T%:z')
+formatter.format(Time.now) # "2015-02-22T03:48:07+05:00"
+
+# Get configured time zone identifier
+formatter.identifier # "Asia/Karachi"
+
+# Get configured time zone offset
+formatter.offset # (5/24)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/terlar/formatter-date/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :test
+task test: 'test:all'
+task ci: %w(rubocop test:all)
+
+namespace :test do
+  desc 'Run all tests'
+  Rake::TestTask.new :all do |t|
+    t.test_files = Rake::FileList['test/*_test.rb']
+  end
+
+  desc 'Run unit tests'
+  Rake::TestTask.new :unit do |t|
+    t.test_files = Rake::FileList['test/unit_test.rb']
+  end
+
+  desc 'Run integration tests'
+  Rake::TestTask.new :integration do |t|
+    t.test_files = Rake::FileList['test/integration_test.rb']
+  end
+end

data/formatter-date.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/formatter/date/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'formatter-date'
+  gem.version       = Formatter::Date::VERSION.dup
+  gem.authors       = ['Terje Larsen']
+  gem.email         = 'terlar@gmail.com'
+  gem.description   = 'Date formatter with time zone support'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/terlar/formatter-date'
+  gem.license       = 'MIT'
+
+  gem.require_paths = %w(lib)
+  gem.files         = `git ls-files`.split($RS)
+  gem.test_files    = gem.files.grep(/^test\//)
+  gem.extra_rdoc_files = %w(LICENSE README.md)
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_runtime_dependency 'tzinfo'
+
+  gem.add_development_dependency 'bundler', '~> 1.6'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rubocop'
+end

data/lib/formatter/date/version.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Formatter
+  class Date
+
+    # Gem version
+    VERSION = '0.1.0'
+
+  end
+end

data/lib/formatter/date.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+require 'tzinfo'
+require 'delegate'
+
+module Formatter
+  # Date formatter with time zone support.
+  class Date
+    # Wrapper class around TZInfo::TimeOrDateTime that only accepts
+    # Time or DateTime.
+    class TimeOrDateTime < DelegateClass(TZInfo::TimeOrDateTime)
+      def initialize(object)
+        case object
+        when Time
+          object = object.utc
+        when DateTime
+          object = object.new_offset Rational(0, 24)
+        else
+          fail ArgumentError, "invalid Time or DateTime: #{object.inspect}"
+        end
+
+        super TZInfo::TimeOrDateTime.wrap(object)
+      end
+    end
+
+    # Initialize a formatter with the desired options.
+    #
+    # :time_zone specifies which time zone to use when formatting.
+    #
+    # :format specifies which format to use, it can either be a symbol of a
+    # predefined format or a string with a custom format which will be
+    # delegated to DateTime#strftime.
+    #
+    # :fraction is length of fractional seconds to be used with predefined
+    # formats.
+    #
+    # @param [String|TZInfo::Timezone] time_zone
+    # @param [Symbol|String] format
+    # @param [Integer] fraction (0)
+    #
+    # @return [undefined]
+    #
+    # @api public
+    def initialize(time_zone, format = :iso8601, fraction = 0)
+      self.time_zone = time_zone
+      @formatter = formatter_for format, fraction
+    end
+
+    # Format Time or DateTime with formatter
+    #
+    # @param [Time|DateTime] time_or_datetime
+    #
+    # @return [String]
+    #
+    # @api public
+    def format(time_or_datetime)
+      formatter.call with_offset(time_or_datetime)
+    end
+
+    # Configured time zone identifier
+    #
+    # @return [String]
+    #
+    # @api public
+    def identifier
+      time_zone.identifier
+    end
+
+    # Configured time zone offset
+    #
+    # @return [Rational]
+    #
+    # @api public
+    def offset
+      time_zone.current_period.utc_total_offset_rational
+    end
+
+    private
+
+    attr_reader :time_zone, :formatter
+
+    def time_zone=(time_zone)
+      case time_zone
+      when String
+        @time_zone = TZInfo::Timezone.get time_zone
+      when TZInfo::DataTimezone
+        @time_zone = time_zone
+      else
+        fail ArgumentError, "invalid time zone: #{time_zone.inspect}"
+      end
+    end
+
+    def formatter_for(format, fraction)
+      case format
+      when Symbol
+        if format_method? format
+          return -> datetime { datetime.send format, fraction }
+        end
+      when String
+        return -> datetime { datetime.strftime format }
+      end
+
+      fail ArgumentError, "invalid value for format: #{format.inspect}"
+    end
+
+    def format_method?(method)
+      %i(iso8601 xmlschema jisx0301 rfc3339).include? method
+    end
+
+    def with_offset(time_or_datetime)
+      TimeOrDateTime.new(time_or_datetime).to_datetime.new_offset offset
+    end
+  end
+end

data/lib/formatter-date.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'formatter/date'

data/test/integration_test.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+
+require_relative 'test_helper'
+
+class IntegrationTest < Minitest::Test
+  attr_reader :time_zone, :format
+
+  def setup
+    @time_zone = 'Europe/Stockholm'
+    @format = :iso8601
+  end
+
+  def formatter
+    Formatter::Date.new time_zone, format
+  end
+
+  def test_can_initialize_with_string
+    @time_zone = 'Asia/Karachi'
+    assert_equal 'Asia/Karachi', formatter.identifier
+  end
+
+  def test_can_initialize_with_tzinfo_timezone
+    @time_zone = TZInfo::Timezone.get('Asia/Karachi')
+    assert_equal 'Asia/Karachi', formatter.identifier
+  end
+
+  def test_fails_initialization_with_invalid_time_zone
+    @time_zone = nil
+
+    error = assert_raises ArgumentError do
+      formatter
+    end
+
+    assert_includes error.message, 'nil'
+  end
+
+  def test_fails_initialization_with_invalid_format
+    @format = :unknown
+
+    error = assert_raises ArgumentError do
+      formatter
+    end
+    assert_includes error.message, ':unknown'
+
+    @format = 5
+    error = assert_raises ArgumentError do
+      formatter
+    end
+    assert_includes error.message, '5'
+  end
+
+  def test_identifier
+    assert_equal time_zone, formatter.identifier
+  end
+
+  def test_offset
+    assert_equal Rational(1, 24), formatter.offset
+  end
+
+  def test_formats_time_with_offset
+    input = Time.new(2010, 1, 1, 10, 0, 0, '+00:00')
+
+    expected = '2010-01-01T11:00:00+01:00'
+    actual = formatter.format input
+
+    assert_equal expected, actual
+  end
+
+  def test_formats_datetime_with_offset
+    input = DateTime.new(2010, 1, 1, 10, 0, 0, Rational(0, 24))
+
+    expected = '2010-01-01T11:00:00+01:00'
+    actual = formatter.format input
+
+    assert_equal expected, actual
+  end
+
+  def test_defaults_format_to_iso8601
+    formatter = Formatter::Date.new time_zone
+    input = Time.new(2010, 1, 1, 10, 0, 0, '+00:00')
+
+    expected = '2010-01-01T11:00:00+01:00'
+    actual = formatter.format input
+
+    assert_equal expected, actual
+  end
+
+  def test_format_with_fractional_seconds
+    formatter = Formatter::Date.new time_zone, :iso8601, 2
+    input = Time.new(2010, 1, 1, 10, 0, 0, '+00:00')
+
+    expected = '2010-01-01T11:00:00.00+01:00'
+    actual = formatter.format input
+
+    assert_equal expected, actual
+  end
+
+  def test_format_with_custom_string
+    @format = '%Y%m%dT%H%M%S%z'
+    input = Time.new(2010, 1, 1, 10, 0, 0, '+00:00')
+
+    expected = '20100101T110000+0100'
+    actual = formatter.format input
+
+    assert_equal expected, actual
+  end
+
+  %w(iso8601 xmlschema jisx0301 rfc3339).each do |format|
+    define_method :"test_format_with_#{format}" do
+      @format = format.to_sym
+
+      input = DateTime.new(2010, 1, 1, 10, 0, 0, formatter.offset)
+
+      expected = input.send(format)
+      actual = formatter.format input
+
+      assert_equal expected, actual
+    end
+  end
+
+  def test_fails_formatting_with_invalid_time
+    error = assert_raises ArgumentError do
+      formatter.format('invalid time')
+    end
+
+    assert_includes error.message, '"invalid time"'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'formatter-date'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: formatter-date
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Terje Larsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: minitest
+  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: rubocop
+  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: Date formatter with time zone support
+email: terlar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- formatter-date.gemspec
+- lib/formatter-date.rb
+- lib/formatter/date.rb
+- lib/formatter/date/version.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/terlar/formatter-date
+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.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Date formatter with time zone support
+test_files:
+- test/integration_test.rb
+- test/test_helper.rb