datetime_helper 1.0.4 → 1.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmU2ZDI0YzgzNGJjMDQ0MjYzMDAwNzU4ZTU5ZDhiZWM4YzkzMTk5Nw==
+    ZDMxOTMyOTgzYjIyMGQ1MDhlODBkN2U3YTJjNTYzMTkwYzFlOTQ4OA==
   data.tar.gz: !binary |-
-    MTg1ZTNiZGQxYjdhM2RmMDg2YWI4MmNlZmE0NTU3ZjZhZGJjYmE2MQ==
+    MmEwMzBjOTM3NGI4MmM3YTI1MjU4NDNjYWM0MjlhNGYwMWFkYWQ2YQ==
 SHA512:
   metadata.gz: !binary |-
-    YzRhN2RmY2I2MTgwYTY3YzJjMTc5NWIyNzgxMDhjOTA0MDk5NjBlYThmYjBh
-    NGY2ODg1ZWJiZTAwNzY5MTllN2FmOGY1ZGYzYTA3ZDAyOTE2ZTc2YWQ1ZTc2
-    OTBhMGY0ODFmOTZkZDc1YWEyNWRlMTBjZDhmOTUxZjRkMDgyYjM=
+    ZTk0OWY0YmU1NzI2OGY1M2M2NWVlNGQzM2MzZDEyY2I3NjhmYWRhODQwZjNl
+    NDEyMWIxMGY4ZGY4YzVhYTA3ZGJlNjkwZWY3ZWJlZTM1ZmI1NzIyYjYxOTFl
+    YjNlZWE4MTFmMzQ3NWFhODhkYmZmMzUyNjk4ZjBhZWMwMTBjNjg=
   data.tar.gz: !binary |-
-    NGQ3Mzg4NGNlNDgyZWJjYzljMGE4M2Q0MmY1YTBlZGZmNDhiYmZlMGRlNTk3
-    NDUxYTAxMTUyNWRmYzMxNmNmODA0YTJjMzY0NmI5MDFjZTc4NDY2NzIzODE4
-    ZmE2YjAzYWFjZjVjZTE2MDAyYjI2YWZkZWI5NmRiNDFiZWRiYjg=
+    Mjg0M2MxNmI3NGJkZWU5YzY4ZmMzYTFmNWQzNmIwM2FmMDU0YmY1ZmJlYzEx
+    YTlkOTU2NjU5NjY2YTNkM2Q4OWYzNzNkNzI2MjdhNzc5ZDU2YmVmMzEyYWZj
+    ZTI5MDM1ZjExY2I2ZjlhYThhYWZjYmM3OWNkN2I5ZGU5ODc4OTQ=

data/README.md

@@ -7,7 +7,7 @@ A collection of useful utilities for projects that have to deal with dates, 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`.
+4. `ActiveModel::Serializer` helper methods called `enforce_zulu_time` and `enforce_iso8601_date` that allow formatting and aliasing.
 
 Each feature can be required individually so you can use the `rspec` matcher, `ActiveModel` validator, or `ActiveModel::Serializer` helper in isolation.
 
@@ -99,8 +99,11 @@ extend DatetimeHelper::Serialisers
 
 enforce_zulu_time :updated_at
 enforce_iso8601_date :enable_date
+enforce_zulu_time :published_at, :published_date
 ```
 
+The last case will also alias the api attribute `published_at` to the table attribute `published_date`.
+
 or if you have a bunch of 'em
 
 ```ruby
@@ -147,3 +150,7 @@ The `Datetime Helper` is © 2015 Westfield Labs and is available for use under t
 |`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    |
+|`1.0.3`| Change enforce_iso8601_date to work with   |
+|       | date-time objects                          |
+|`1.0.4`| Anchor strings in RSpec matchers           |
+|`1.0.5`| Add aliasing to serializer formatting      |

data/contributing.md

@@ -2,14 +2,14 @@
 
 "Brother I got a 12 step plan for you…" - The Alabama Three
 
-0. Raise an issue in this project outling the change you'd like to make. You'll need the `issue_number`
+0. Raise an issue in this project outlining the change you'd like to make. You'll need the `issue_number`
 1. Fork this project into your own Github account
 2. Create your feature branch (`git checkout -b {issue_number}_my-new-feature`)
 4. Push to the branch (`git push -u origin {issue_number}_my-new-feature`)
-5. Write rspec tests to formalise the outcomes of your change
+5. Write RSpec tests to formalise the outcomes of your change
 6. write the code to implement the changes, ensuring that the tests eventually pass
 7. Commit your changes (`git commit -am '{issue_number} Added some feature'`)
 8. Push to the branch (`git push -u origin my-new-feature`)
 9. Create a new Pull Request using Github's built-in mechanisms.
 10. Wait for a code review to come back, or an approval.
-11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of sotware development history.
+11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of software development history.

data/lib/datetime_helper/serialisers/active_model_serialiser_helper.rb

@@ -2,16 +2,18 @@ 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?
+    # Allow optional aliasing
+    def enforce_zulu_time(api_attribute, table_column = api_attribute)
+      define_method(api_attribute) do
+        object.send(table_column).utc.iso8601 unless object.send(table_column).nil?
       end
     end
 
     # Enforces that a Date is serialized as iso8601 format
-    def enforce_iso8601_date(attribute)
-      define_method(attribute) do
-        object.send(attribute).strftime('%F') unless object.send(attribute).nil?
+    # Allow optional aliasing
+    def enforce_iso8601_date(api_attribute, table_column = api_attribute)
+      define_method(api_attribute) do
+        object.send(table_column).strftime('%F') unless object.send(table_column).nil?
       end
     end
 

data/lib/datetime_helper/version.rb

@@ -1,3 +1,3 @@
 module DatetimeHelper
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/spec/serialisers/active_model_serialiser_helper_spec.rb

@@ -3,11 +3,14 @@ require "datetime_helper/active_model_serialiser"
 
 class TestSerialiser < ActiveModel::Serializer
   extend DatetimeHelper::Serialisers
-  attributes :updated_at, :enabled_date, :enabled_time
+  attributes :updated_at, :enabled_date, :enabled_time,
+    :aliased_time, :aliased_date
 
   enforce_zulu_time :updated_at
   enforce_iso8601_date :enabled_date
   enforce_iso8601_date :enabled_time
+  enforce_zulu_time :aliased_time, :updated_at
+  enforce_iso8601_date :aliased_date, :enabled_date
 end
 
 class TestItemNoTime
@@ -35,27 +38,32 @@ 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[:aliased_time]).to eq subject[:updated_at] }
   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 }
+    it { expect(subject[:aliased_time]).to eq subject[:updated_at] }
   end
 
   context 'with a nil time' do
     let(:item)     { TestItemNoTime.new }
     it { expect(subject[:updated_at]).to be_nil}
+    it { expect(subject[:aliased_time]).to eq subject[:updated_at] }
   end
 
   context 'with a date' do
     let(:item)     { TestItem.new }
 
     it { expect(subject[:enabled_date]).to be_an_iso_formatted_date }
+    it { expect(subject[:aliased_date]).to eq subject[:enabled_date] }
   end
 
   context 'with a nil date' do
     let(:item)     { TestItemNoTime.new }
     it { expect(subject[:enabled_date]).to be_nil}
+    it { expect(subject[:aliased_date]).to eq subject[:enabled_date] }
   end
 
   context 'with a date-time' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datetime_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - davesag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec