datetime_helper 1.0.1 → 1.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDFmZGQ5MjZiYmFiNWYzYWMxMjM1YTBjYmM1Y2VhMTJmZDY4MGExYg==
+    NmZjYmI4OWEwZTBhYzk4ZDBiYTVmZTBmZDhhZGM3N2NiZDlkZTU0OQ==
   data.tar.gz: !binary |-
-    MGM5MTFhOWMzYjdhYTVjMGVkZjcxNDdiN2E0ODY4MjA2MTc2MDg4Zg==
+    NTJlOGNmYzUzNTU3NTQ4ZWUyNDg3MDMzY2QzZTRiNDU0MTQ3NGEwZQ==
 SHA512:
   metadata.gz: !binary |-
-    NjczNzkyNDhmMTUwYzAyYTY4ZDdjNTg4MTkxZGRiZWZjOWM3NTIxYWMyM2Q0
-    Y2NiZjMzYzEyODVkYmRjNzYzOWExZDM3ZjNlMGVkMTdkOTQ3ZTkxMzM0YjZl
-    ZmQxY2QzYjgzMTQ0ZjNjODM4OTgwODJhZTg2NGM2NWFmZmU0ZTA=
+    NzFiY2VlODg2YzdhNzQ2NmZmNzY0ODRlMDIyODcyNWRlMjkyZmU0NjhiOWVk
+    NjNjNGFmMGU5MWYzZjdjNmU0Yzg1ZDQ3MmRlMmJlNzJhYjIxZjQwNDgwMjY0
+    NGYyMzZjNTVhNWI3ZDYzNWIxZWY4NWYzOTkwNTA1YTgzZTg5Y2Y=
   data.tar.gz: !binary |-
-    YWMwMzNhY2M1OTdmOTI1OTU3MjcwODA1MmFiYjkxY2RkZGEyYzJlMmVjYzNl
-    OTFkNTAwYTdmNTAxOTc0MmI2Mzk4ZmZjNmMwM2RjZGY0MjI0ODUzYWZmNThl
-    MDFkZmMwZmQyZTEyMDM2MmRlNWQ4ZmM2N2QxYjJlMzRjZTI0OGM=
+    OGQ1MWRhNjZlNjMyYzFiMTFiY2ViMTNiMWViZWNjZjA0YTI1Y2ZkZjE5Yzdi
+    NmIwMWRmOTY1YjhhNmE5ZTAzMzQyYjJhYmUxYTRiOTM4NGI5NWNlM2VmMGZk
+    MDMyZjRkNmZkNzdmYTkzYTg4ZDAzNmJjNjliMmJlNzkyMjQ5Y2U=

data/README.md

@@ -4,7 +4,7 @@ A collection of useful utilities for projects that have to deal with dates, time
 
 ## Features
 
-1. A base method called `is_zulu_time?`, 
+1. A base method called `is_zulu_time?`,
 2. `rspec` matchers `be_zulu_time`, `be_an_iso_formatted_date`, and `be_an_iso_formatted_time`
 3. An `ActiveModel` validator called `zulu_time`, and
 4. An `ActiveModel::Serializer` helper method called `enforce_zulu_time`.
@@ -88,7 +88,7 @@ This will verify that a `Time` is supplied at `UTC+0`,
 or that a `DateTime` has `.zone == "+00:00"`,
 or that a `String` is in Zulu Time format.
 
-### Enforcing `ActiveModel::Serializer`  Zulu Time string formats
+### Enforcing `ActiveModel::Serializer`  Zulu Time and iso8601 Date String Formats
 
 First be sure you `require 'datetime_helper/active_model_serialiser'`
 
@@ -98,6 +98,7 @@ Then you can put this in your serialisers:
 extend DatetimeHelper::Serialisers
 
 enforce_zulu_time :updated_at
+enforce_iso8601_date :enable_date
 ```
 
 or if you have a bunch of 'em
@@ -106,9 +107,11 @@ or if you have a bunch of 'em
 extend DatetimeHelper::Serialisers
 
 %w(updated_at deleted_at).each { |attribute| enforce_zulu_time attribute }
+%w(date enable_date).each { |attribute| enforce_iso8601_date attribute }
 ```
 
-This will ensure that the serialised output is a proper Zulu Time formatted string.
+This will ensure that the serialised output is a proper Zulu time formatted
+string and iso8601 formatted date string.
 
 ## To build
 
@@ -143,3 +146,4 @@ The `Datetime Helper` is © 2015 Westfield Labs and is available for use under t
 |`0.0.3`| Added the `ActiveModel::Serializer` helper |
 |`1.0.0`| Cleaned up for first official release      |
 |`1.0.1`| Enhanced matchers, and validator           |
+|`1.0.2`| Add iso8601 date format for serializers    |

data/lib/datetime_helper/active_model_serialiser.rb

@@ -1,3 +1,3 @@
 require 'active_model_serializers'
 require_relative "../datetime_helper"
-require_relative "serialisers/zulu_time_active_model_serialiser_helper"
+require_relative "serialisers/active_model_serialiser_helper"

data/lib/datetime_helper/serialisers/active_model_serialiser_helper.rb

@@ -0,0 +1,19 @@
+module DatetimeHelper
+  module Serialisers
+
+    # Enforces that a DateTime is serialised as zulu time format
+    def enforce_zulu_time(attribute)
+      define_method(attribute) do
+        object.send(attribute).utc.iso8601 unless object.send(attribute).nil?
+      end
+    end
+
+    # Enforces that a Date is serialized as iso8601 format
+    def enforce_iso8601_date(attribute)
+      define_method(attribute) do
+        object.send(attribute).iso8601 unless object.send(attribute).nil?
+      end
+    end
+
+  end
+end

data/lib/datetime_helper/version.rb

@@ -1,3 +1,3 @@
 module DatetimeHelper
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/serialisers/{zulu_time_active_model_serialiser_helper_spec.rb → active_model_serialiser_helper_spec.rb}

@@ -3,22 +3,25 @@ require "datetime_helper/active_model_serialiser"
 
 class TestSerialiser < ActiveModel::Serializer
   extend DatetimeHelper::Serialisers
-  attributes :updated_at
-  
+  attributes :updated_at, :enabled_date
+
   enforce_zulu_time :updated_at
+  enforce_iso8601_date :enabled_date
 end
 
 class TestItemNoTime
   include ActiveModel::SerializerSupport
-  attr_reader :updated_at
+  attr_reader :updated_at, :enabled_date
   def initialize(options = {})
     @updated_at = nil
+    @enabled_date = nil
   end
 end
 
 class TestItem < TestItemNoTime
   def initialize(options = {})
     @updated_at = options[:updated_at] || Time.now.utc
+    @enabled_date = options[:enabled_date] || Time.now.to_date
   end
 end
 
@@ -28,12 +31,12 @@ describe DatetimeHelper::Serialisers do
 
   context 'with a UTC time' do
     let(:item)     { TestItem.new }
-    it { expect(subject[:updated_at]).to be_zulu_time}
+    it { expect(subject[:updated_at]).to be_zulu_time }
   end
 
   context 'with a local time' do
-    let(:item)     { TestItem.new updated_at:  Time.now.getlocal }
-    it { expect(subject[:updated_at]).to be_zulu_time}
+    let(:item)     { TestItem.new updated_at: Time.now.getlocal }
+    it { expect(subject[:updated_at]).to be_zulu_time }
   end
 
   context 'with a nil time' do
@@ -41,4 +44,15 @@ describe DatetimeHelper::Serialisers do
     it { expect(subject[:updated_at]).to be_nil}
   end
 
+  context 'with a date' do
+    let(:item)     { TestItem.new }
+
+    it { expect(subject[:enabled_date]).to be_an_iso_formatted_date }
+  end
+
+  context 'with a nil date' do
+    let(:item)     { TestItemNoTime.new }
+    it { expect(subject[:enabled_date]).to be_nil}
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datetime_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - davesag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -117,13 +117,13 @@ files:
 - lib/datetime_helper/matchers/iso_date_and_time_rspec_matchers.rb
 - lib/datetime_helper/matchers/zulu_time_rspec_matcher.rb
 - lib/datetime_helper/rspec.rb
-- lib/datetime_helper/serialisers/zulu_time_active_model_serialiser_helper.rb
+- lib/datetime_helper/serialisers/active_model_serialiser_helper.rb
 - lib/datetime_helper/validators/zulu_time_active_model_validator.rb
 - lib/datetime_helper/version.rb
 - spec/datetime_helper_spec.rb
 - spec/matchers/iso_date_and_time_rspec_matcher_spec.rb
 - spec/matchers/zulu_time_rspec_matcher_spec.rb
-- spec/serialisers/zulu_time_active_model_serialiser_helper_spec.rb
+- spec/serialisers/active_model_serialiser_helper_spec.rb
 - spec/spec_helper.rb
 - spec/validators/zulu_time_active_model_validator_spec.rb
 homepage: https://github.com/westfieldlabs/datetime_helper
@@ -155,6 +155,6 @@ test_files:
 - spec/datetime_helper_spec.rb
 - spec/matchers/iso_date_and_time_rspec_matcher_spec.rb
 - spec/matchers/zulu_time_rspec_matcher_spec.rb
-- spec/serialisers/zulu_time_active_model_serialiser_helper_spec.rb
+- spec/serialisers/active_model_serialiser_helper_spec.rb
 - spec/spec_helper.rb
 - spec/validators/zulu_time_active_model_validator_spec.rb

data/lib/datetime_helper/serialisers/zulu_time_active_model_serialiser_helper.rb

@@ -1,13 +0,0 @@
-# Enforces that a DateTime is serialised as zulu time
-
-module DatetimeHelper
-  module Serialisers
-
-    def enforce_zulu_time(attribute)
-      define_method(attribute) do
-        object.send(attribute).utc.iso8601 unless object.send(attribute).nil?
-      end
-    end
-
-  end
-end