jiff 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4eb447fe9a1cedb307d125b3a539bb4b9531c2a
-  data.tar.gz: 0f512b71e0472e52bd6960692b1efd57f56511cc
+  metadata.gz: daee8f43df0fc3c4d69cca0a2e2dfbb2e7021fe0
+  data.tar.gz: 5b9a63c3a463851d5465870a9f5be7a0824f7c48
 SHA512:
-  metadata.gz: 2b1a4823a2c04cf41cdbf740f47bccc402b4fadbd6f122319d450353aac39e51bbd8169676626c2adeb010d25a063fff1839beb92e594b70f8fb48935db263b5
-  data.tar.gz: 5fb29273e843b3ce4425b3e700639fcb7d66c4201c5df5188edf972cc8bdf0bc7c11bf119ec51d0f1c98b01e3ad711f2aef449f59acaa1af733ecd6978ae8ded
+  metadata.gz: 8e94cef432291f0c14dd3157e32afb9b5f4eb189f1df4c2dace6da56087d707d85a59d4bcdf990fca2ace4b0980d98e1449aeb1b618244086660f634774f29d8
+  data.tar.gz: 244d48d43198c2c6e79f940b278615ffcb6cac2ee783c74aae5926100ceb733cacb69006eace31cdd9bc2fe8ea99844d323bf97f9adc8406aa87ab815232e75d

data/README.md

@@ -28,7 +28,7 @@ Create a new **Jiff** set to the current date/time:
 Jiff.new
 ```
 
-Create a new **Jiff** set to an unix timestamp:
+or create one using an unix timestamp:
 
 ```ruby
 Jiff.new 1414612800
@@ -193,6 +193,22 @@ This is exactly the same as **.add**, only instead of adding time, it subtracts
 |s      |second         |
 |ms     |millisecond    |
 
+### Nearest
+
+You can round any Jiff to the nearest; hour, minute or second.
+
+```ruby
+j = Jiff.new
+
+j.date
+# -> 2014-10-29 22:41:59 +0000
+
+j.nearest('hour').date
+# -> 2014-10-29 23:00:00 +0000
+```
+
+To round, pass the key of the time unit you want to round to (see table above).
+
 ### Timezone
 
 Once you have created a **Jiff**, you can alter its timezone.

data/jiff.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "jiff"
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ["Charlie Revett"]
   spec.email         = ["charlierevett@gmail.com"]
   spec.summary       = %q{Parse, validate, manipulate, and display dates in Ruby.}

data/lib/jiff.rb

@@ -1,9 +1,11 @@
 require 'time'
 require_relative 'jiff/manipulate'
+require_relative 'jiff/nearest'
 require_relative 'jiff/timezone'
 
 class Jiff
   include Manipulate
+  include Nearest
   include Timezone
 
   attr_reader :date

data/lib/jiff/manipulate.rb

@@ -1,42 +1,18 @@
+require_relative 'time_unit'
+
 module Manipulate
-  def add(amount, type)
-    manipulate(amount, convert_type(type), '+')
+  def add(amount, key)
+    manipulate(amount, TimeUnit.new(key), '+')
   end
 
-  def subtract(amount, type)
-    manipulate(amount, convert_type(type), '-')
+  def subtract(amount, key)
+    manipulate(amount, TimeUnit.new(key), '-')
   end
 
   private
 
-  SECONDS = {
-    'y'  => 31556926,
-    'M'  => 2629743.83,
-    'w'  => 604800,
-    'd'  => 86400,
-    'h'  => 3600,
-    'm'  => 60,
-    's'  => 1,
-    'ms' => 0.001
-  }
-
-  def convert_type(type)
-    return type if type.length <= 2
-    %w(month millisecond).include?(type) ? handle_special_type(type)
-                                         : type.downcase[0]
-  end
-
-  def handle_special_type(type)
-    type == 'month' ? 'M' : 'ms'
-  end
-
-  def manipulate(amount, type, operator)
-    raise ArgumentError, 'Invalid Type' unless type_exist? type
-    @date = @date.send(operator, (amount * SECONDS[type]))
+  def manipulate(amount, time_unit, operator)
+    @date = @date.send(operator, (amount * time_unit.seconds))
     self
   end
-
-  def type_exist?(type)
-    SECONDS.key? type
-  end
 end

data/lib/jiff/nearest.rb

@@ -0,0 +1,16 @@
+require_relative 'time_unit'
+
+module Nearest
+  def nearest(key)
+    @date = round TimeUnit.new(key)
+    self
+  end
+
+  private
+
+  def round(time_unit)
+    raise ArgumentError, 'Time unit not allowed' unless time_unit.nearest_allowed?
+    Time.at((@date.to_f / time_unit.seconds).round * time_unit.seconds)
+  end
+end
+

data/lib/jiff/time_unit.rb

@@ -0,0 +1,44 @@
+class TimeUnit
+  def initialize(key)
+    convert(key).tap do |k|
+      raise ArgumentError, 'Invalid key' unless type_exist? k
+      @key = k
+    end
+  end
+
+  def nearest_allowed?
+    %w(d h m s).include? @key
+  end
+
+  def seconds
+    SECONDS[@key]
+  end
+
+  private
+
+  SECONDS = {
+    'y'  => 31556926,
+    'M'  => 2629743.83,
+    'w'  => 604800,
+    'd'  => 86400,
+    'h'  => 3600,
+    'm'  => 60,
+    's'  => 1,
+    'ms' => 0.001
+  }
+
+  def convert(key)
+    return key if key.length <= 2
+    key.downcase!
+    %w(month millisecond).include?(key) ? handle_special(key)
+                                        : key.downcase[0]
+  end
+
+  def handle_special(key)
+    key == 'month' ? 'M' : 'ms'
+  end
+
+  def type_exist?(key)
+    SECONDS.key? key
+  end
+end

data/spec/jiff_spec.rb

@@ -1,7 +1,7 @@
 require_relative 'spec_helper'
 
 describe Jiff do
-  subject { Jiff.new }
+  subject { described_class.new }
   let(:time) { Time.new(1992, 6, 8, 10, 30, 15) }
 
   before { Timecop.freeze time }

data/spec/nearest_spec.rb

@@ -0,0 +1,35 @@
+require_relative 'spec_helper'
+
+describe Jiff do
+  subject { described_class.new }
+
+  let(:time) { Time.new(2014, 6, 8, 10, 18, 31) + 0.700 }
+
+  before { Timecop.freeze time }
+
+  after { Timecop.return }
+
+  describe '#nearest' do
+    context 'hour' do
+      let(:expected) { Time.new(2014, 6, 8, 10, 0, 0) }
+      specify { expect(subject.nearest('hour').date).to eq expected }
+      specify { expect(subject.nearest('h').date).to eq expected }
+    end
+
+    context 'minute' do
+      let(:expected) { Time.new(2014, 6, 8, 10, 19, 0) }
+      specify { expect(subject.nearest('minute').date).to eq expected }
+      specify { expect(subject.nearest('m').date).to eq expected }
+    end
+
+    context 'second' do
+      let(:expected) { Time.new(2014, 6, 8, 10, 18, 32) }
+      specify { expect(subject.nearest('second').date).to eq expected }
+      specify { expect(subject.nearest('s').date).to eq expected }
+    end
+
+    context 'using disallowed time unit' do
+      specify { expect{ subject.nearest('year') }.to raise_error ArgumentError }
+    end
+  end
+end

data/spec/time_unit_spec.rb

@@ -0,0 +1,43 @@
+require_relative 'spec_helper'
+
+describe TimeUnit do
+  subject { described_class }
+  describe '.new' do
+    context 'using valid key' do
+      let(:key) { 'second' }
+      specify { expect(subject.new(key).seconds).to eq 1 }
+    end
+
+    context 'using a shorthand key' do
+      let(:key) { 'm' }
+      specify { expect(subject.new(key).seconds).to eq 60 }
+    end
+
+    context 'using an invalid key' do
+      let(:key) { 'batman' }
+      specify { expect{ subject.new key }.to raise_error ArgumentError }
+    end
+
+    context 'using a special key' do
+      specify { expect(subject.new('M').seconds).to eq 2629743.83 }
+      specify { expect(subject.new('ms').seconds).to eq 0.001 }
+    end
+  end
+
+  describe '#nearest_allowed?' do
+    context 'using an allowed key' do
+      specify { expect(subject.new('m').seconds).to eq 60 }
+      specify { expect(subject.new('minute').seconds).to eq 60 }
+    end
+
+    context 'using a disallowed key' do
+      let(:key) { 'batman' }
+      specify { expect{ subject.new(key) }.to raise_error ArgumentError }
+    end
+  end
+
+  describe '#seconds' do
+    let(:key) { 'day' }
+    specify { expect(subject.new(key).seconds).to eq 86400 }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jiff
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Charlie Revett
@@ -138,10 +138,14 @@ files:
 - jiff.gemspec
 - lib/jiff.rb
 - lib/jiff/manipulate.rb
+- lib/jiff/nearest.rb
+- lib/jiff/time_unit.rb
 - lib/jiff/timezone.rb
 - spec/jiff_spec.rb
 - spec/manipulate_spec.rb
+- spec/nearest_spec.rb
 - spec/spec_helper.rb
+- spec/time_unit_spec.rb
 - spec/timezone_spec.rb
 homepage: http://github.com/revett/jiff
 licenses:
@@ -170,5 +174,7 @@ summary: Parse, validate, manipulate, and display dates in Ruby.
 test_files:
 - spec/jiff_spec.rb
 - spec/manipulate_spec.rb
+- spec/nearest_spec.rb
 - spec/spec_helper.rb
+- spec/time_unit_spec.rb
 - spec/timezone_spec.rb