jiff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 951d699915d4ea5e0d75788428898e3a89a19c36
+  data.tar.gz: 24a37e3f47cff1c38493ca5642925916bfec0570
+SHA512:
+  metadata.gz: 987ca0406640756887c757990b1e761c07dc0a89622200c10b92bc093c63487c631a8794ef9b59d67013789e20be395022613d056815850450c9c14b0b061972
+  data.tar.gz: 77db212d00f873e8d6f471dd51ee4cd5657365505ade0669bc7cab9baa0256b9f752e69ad785322baafa98f925fa875debdaf2367b8918cc9b39a1da9336cca9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - "2.0.0"
+script:
+  - bundle exec rake all
+notifications:
+  email:
+    recipients:
+      - charlierevett@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Charlie Revett
+
+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,223 @@
+# Jiff
+
+[![Build Status](https://travis-ci.org/revett/jiff.svg?branch=master)](https://travis-ci.org/revett/jiff)
+
+Parse, validate, manipulate, and display dates in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jiff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jiff
+
+## Usage
+
+Create a new **Jiff** set to the current date/time:
+
+```ruby
+Jiff.new
+```
+
+Access the date/time object at any point:
+
+```ruby
+j = Jiff.new
+j.date
+# -> 1992-06-08 10:30:15 +0100
+```
+
+### Get
+
+Once you have created a **Jiff**, you can access any of the data within it. Overloaded getters and setters are used here, thus calling a method without parameters treats it as a `getter`, and calling them with a parameter treats it as a `setter`.
+
+*Note* - not all methods currently have `setter` functionality (see [#3](https://github.com/revett/jiff/issues/3)).
+
+#### .year
+
+Gets the year.
+
+```ruby
+Jiff.new.year
+# -> 2014
+```
+
+#### .quarter
+
+Gets the quarter (`1..4`).
+
+```ruby
+Jiff.new.quarter
+# -> 3
+```
+
+#### .month
+
+Gets the month (`1..12`).
+
+```ruby
+Jiff.new.month
+# -> 6
+```
+
+#### .week_of_year
+
+Gets the week of the year, where a week starts on Monday (`0..53`).
+
+`0` - week partially in previous year.      
+`1-52` - weeks fully in current year.       
+`53` - week partially in next year.       
+
+```ruby
+Jiff.new.week_of_year
+# -> 24
+```
+
+#### .day_of_year
+
+Gets the day of the year (`1..366`).
+
+```ruby
+Jiff.new.day_of_year
+# -> 260
+```
+
+#### .day_of_week
+
+Gets the day of the week (`1..7`), where `1` is Monday.
+
+```ruby
+Jiff.new.day_of_week
+# -> 2
+```
+
+#### .day
+
+Gets the day of the month (`1..31`).
+
+```ruby
+Jiff.new.day
+# -> 14
+```
+
+#### .hour
+
+Gets the hour (`0..23`).
+
+```ruby
+Jiff.new.hour
+# -> 15
+```
+
+#### .minute
+
+Gets the minutes (`0..59`).
+
+```ruby
+Jiff.new.minute
+# -> 31
+```
+
+#### .second
+
+Gets the seconds (`0..60`).
+
+```ruby
+Jiff.new.second
+# -> 55
+```
+
+#### .millisecond
+
+Gets the milliseconds (`0..999`).
+
+```ruby
+Jiff.new.millisecond
+# -> 456
+```
+
+### Manipulate
+
+After creating a **Jiff**, you can manipulate it in a number of ways. The [fluent interface](http://en.wikipedia.org/wiki/Fluent_interface) pattern, also known as [method chaining](http://en.wikipedia.org/wiki/Method_chaining), is used. Allowing you to write more readable code and do crazy stuff such as:
+
+```ruby
+Jiff.new.add(14, 'd').add(6, 'M').subtract(10, 'y').week_of_year
+# -> 39
+```
+
+#### .add
+
+Add a specific amount of time to your current **Jiff**:
+
+```ruby
+Jiff.new.add(amount, type)
+```
+
+To add time, pass the key of what time unit you want to add, and the amount you want to add.
+
+#### .subtract
+
+Subtract a specific amount of time from your current **Jiff**:
+
+```ruby
+Jiff.new.subtract(amount, type)
+```
+
+This is exactly the same as **.add**, only instead of adding time, it subtracts time.
+
+#### Keys
+
+|**Key**|**Description**|
+|-------|---------------|
+|y      |Year           |
+|M      |Month          |
+|w      |Week           |
+|d      |Day            |
+|h      |Hour           |
+|m      |Minute         |
+|s      |Second         |
+|ms     |Millisecond    |
+
+### Timezone
+
+Once you have created a **Jiff**, you can alter its timezone.
+
+#### .timezone
+
+Gets the timezone.
+
+```ruby
+Jiff.new.timezone
+# -> "BST"
+```
+
+#### .timezone(location)
+
+Sets the timezone.
+
+```ruby
+Jiff.new.timezone 'London'
+```
+
+## Contributing
+
+1. [Fork it!](https://github.com/revett/jiff/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](https://github.com/revett/jiff/pulls).
+
+Please create an [issue](https://github.com/revett/jiff/issues/new) if you find a bug or think of an enhancement that could be made.
+
+## Credits
+
+Heavily influenced by [Moment.js](http://momentjs.com/)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rake/rspec'
+
+task :default => :spec

data/jiff.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jiff"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Charlie Revett"]
+  spec.email         = ["charlierevett@gmail.com"]
+  spec.summary       = %q{Parse, validate, manipulate, and display dates in Ruby.}
+  spec.homepage      = "http://github.com/revett/jiff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake-rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "activesupport"
+end

data/lib/jiff.rb

@@ -0,0 +1,64 @@
+require 'time'
+require_relative 'jiff/manipulate'
+require_relative 'jiff/timezone'
+
+class Jiff
+  include Manipulate
+  include Timezone
+
+  attr_reader :date
+
+  def initialize
+    @date = Time.new
+  end
+
+  def day
+    date.day
+  end
+
+  def day_of_week
+    pattern '%u'
+  end
+
+  def day_of_year
+    date.yday
+  end
+
+  def hour
+    date.hour
+  end
+
+  def millisecond
+    pattern '%L'
+  end
+
+  def minute
+    date.min
+  end
+
+  def month
+    date.month
+  end
+
+  def quarter
+    ((month - 1) / 3) + 1
+  end
+
+  def second
+    date.sec
+  end
+
+  def week_of_year
+    (pattern '%W') + 1
+  end
+
+  def year
+    date.year
+  end
+
+  private
+
+  def pattern(format, to_int = true)
+    date.strftime(format).tap { |d| return d.to_i if to_int }
+  end
+end

data/lib/jiff/manipulate.rb

@@ -0,0 +1,32 @@
+module Manipulate
+  def add(amount, type)
+    manipulate(amount, type.to_sym, '+')
+  end
+
+  def subtract(amount, type)
+    manipulate(amount, type.to_sym, '-')
+  end
+
+  private
+
+  SECONDS = {
+    y:  31556926,
+    M:  2629743.83,
+    w:  604800,
+    d:  86400,
+    h:  3600,
+    m:  60,
+    s:  1,
+    ms: 0.001
+  }
+
+  def manipulate(amount, type, operator)
+    raise ArgumentError, 'Invalid Type' unless type_exist? type
+    @date = @date.send(operator, (amount * SECONDS[type]))
+    self
+  end
+
+  def type_exist?(type)
+    SECONDS.key? type
+  end
+end

data/lib/jiff/timezone.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/time'
+
+module Timezone
+  def timezone(value = nil)
+    return pattern('%Z', false) if value.nil?
+    @date = @date.in_time_zone value
+    self
+  end
+end

data/spec/jiff_spec.rb

@@ -0,0 +1,62 @@
+require_relative 'spec_helper'
+
+describe Jiff do
+  subject { Jiff.new }
+  let(:time) { Time.new(1992, 6, 8, 10, 30, 15) }
+
+  before { Timecop.freeze time }
+
+  after { Timecop.return }
+
+  describe '#date' do
+    specify { expect(subject.date).to eq time }
+  end
+
+  describe '#day' do
+    specify { expect(subject.day).to eq 8 }
+  end
+
+  describe '#day_of_week' do
+    specify { expect(subject.day_of_week).to eq 1 }
+  end
+
+  describe '#day_of_year' do
+    specify { expect(subject.day_of_year).to eq 160 }
+  end
+
+  describe '#hour' do
+    specify { expect(subject.hour).to eq 10 }
+  end
+
+  describe '#millisecond' do
+    specify { expect(subject.millisecond).to eq 0 }
+  end
+
+  describe '#minute' do
+    specify { expect(subject.minute).to eq 30 }
+  end
+
+  describe '#month' do
+    specify { expect(subject.month).to eq 6 }
+  end
+
+  describe '#quarter' do
+    specify { expect(subject.quarter).to eq 2 }
+  end
+
+  describe '#second' do
+    specify { expect(subject.second).to eq 15 }
+  end
+
+  describe '#week_of_year' do
+    specify { expect(subject.week_of_year).to eq 24 }
+  end
+
+  describe '#year' do
+    specify { expect(subject.year).to eq 1992 }
+  end
+
+  context 'check method chaining words' do
+    specify { expect(subject.add(2, 'w').subtract(2, 'd').day).to eq 20 }
+  end
+end

data/spec/manipulate_spec.rb

@@ -0,0 +1,95 @@
+require_relative 'spec_helper'
+
+describe Jiff do
+  subject { described_class.new }
+
+  let(:time) { Time.new(1992, 6, 8, 10, 30, 15) }
+
+  before { Timecop.freeze time }
+
+  after { Timecop.return }
+
+  describe '#add' do
+    context 'using a valid type' do
+      context 'adding 1 year' do
+        specify { expect(subject.add(1, 'y').year).to eq 1993 }
+      end
+
+      context 'adding 1 month' do
+        specify { expect(subject.add(1, 'M').month).to eq 7 }
+      end
+
+      context 'adding 1 week' do
+        specify { expect(subject.add(1, 'w').day).to eq 15 }
+      end
+
+      context 'adding 1 day' do
+        specify { expect(subject.add(1, 'd').day).to eq 9 }
+      end
+
+      context 'adding 1 hour' do
+        specify { expect(subject.add(1, 'h').hour).to eq 11 }
+      end
+
+      context 'adding 1 minute' do
+        specify { expect(subject.add(1, 'm').minute).to eq 31 }
+      end
+
+      context 'adding 1 second' do
+        specify { expect(subject.add(1, 's').second).to eq 16 }
+      end
+
+      context 'adding 1 millisecond' do
+        specify { expect(subject.add(1, 'ms').millisecond).to eq 1 }
+      end
+    end
+
+    context 'using an invalid type' do
+      specify do
+        expect{ subject.add(5, 'batman') }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#subtract' do
+    context 'using a valid type' do
+      context 'subtracting 1 year' do
+        specify { expect(subject.subtract(1, 'y').year).to eq 1991 }
+      end
+
+      context 'subtracting 1 month' do
+        specify { expect(subject.subtract(1, 'M').month).to eq 5 }
+      end
+
+      context 'subtracting 1 week' do
+        specify { expect(subject.subtract(1, 'w').day).to eq 1 }
+      end
+
+      context 'subtracting 1 day' do
+        specify { expect(subject.subtract(1, 'd').day).to eq 7 }
+      end
+
+      context 'subtracting 1 hour' do
+        specify { expect(subject.subtract(1, 'h').hour).to eq 9 }
+      end
+
+      context 'subtracting 1 minute' do
+        specify { expect(subject.subtract(1, 'm').minute).to eq 29 }
+      end
+
+      context 'subtracting 1 second' do
+        specify { expect(subject.subtract(1, 's').second).to eq 14 }
+      end
+
+      context 'subtracting 1 millisecond' do
+        specify { expect(subject.subtract(1, 'ms').millisecond).to eq 998 }
+      end
+    end
+
+    context 'using an invalid type' do
+      specify do
+        expect{ subject.subtract(5, 'batman') }.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require './lib/jiff'
+
+require 'timecop'
+require 'pry'

data/spec/timezone_spec.rb

@@ -0,0 +1,22 @@
+require_relative 'spec_helper'
+
+describe Jiff do
+  subject { described_class.new }
+
+  let(:bst_time) { Time.new(1992, 6, 8, 10, 30, 15) }
+  let(:gmt_time) { Time.new(1992, 1, 8, 10, 30, 15) }
+
+  describe '#timezone' do
+    context 'using GMT time' do
+      before { Timecop.freeze gmt_time }
+      specify { expect(subject.timezone('London').timezone).to eq 'GMT' }
+    end
+
+    context 'using BST time' do
+      before { Timecop.freeze bst_time }
+      specify { expect(subject.timezone('London').timezone).to eq 'BST' }
+    end
+  end
+
+  after { Timecop.return }
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: jiff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charlie Revett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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-nc
+  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: pry
+  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: activesupport
+  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'
+description: 
+email:
+- charlierevett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jiff.gemspec
+- lib/jiff.rb
+- lib/jiff/manipulate.rb
+- lib/jiff/timezone.rb
+- spec/jiff_spec.rb
+- spec/manipulate_spec.rb
+- spec/spec_helper.rb
+- spec/timezone_spec.rb
+homepage: http://github.com/revett/jiff
+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.14
+signing_key: 
+specification_version: 4
+summary: Parse, validate, manipulate, and display dates in Ruby.
+test_files:
+- spec/jiff_spec.rb
+- spec/manipulate_spec.rb
+- spec/spec_helper.rb
+- spec/timezone_spec.rb