human_attributes 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 282f2534047a15a9d75f50f7a92c8fa5ba414d8a
-  data.tar.gz: 3d8b7f1973cf61c0840987faa76d0f9f6a71c14d
+  metadata.gz: 6852d543a6bd4e642ae907b2ad208261151c26d8
+  data.tar.gz: bee00b07e2bb8bbc6dd2995b92c03e3e64fbe42f
 SHA512:
-  metadata.gz: f057cfda8bba4f6ad6553f85ebf82fed78af75b5c88f26312c5a7932d61627ea6f0a8dee39191ff4dc5443b9243980ae82c3e852df2b31fcc4d3dac8f2ad83ed
-  data.tar.gz: cd593d5a11fae7e0aff811dfe6def1660e12ffdba94e8954220b1fe38c8e04804c92146271b09ae5b7e34e0f18750bd9aaa1cee6d1958aab18d254fbaa1b66e0
+  metadata.gz: 6d86cc67c665b2ba71de7a755dca9f9955880a726be5161fd21e6fe21bc7d74f16637ea91ac75d69fdb7287812d67b7bddcb11ff8d7f710101fedb4bcc2fb8e2
+  data.tar.gz: a49ef0b112c2a756960b5d8408c0ef13a5f8696f55c3f4d24918a69cd1ec51aa4303875c382b6552ab8e6c2ffebdb9a57951824b790cfdb8d4859dcbe981bd90

data/CHANGELOG.md

@@ -2,8 +2,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v0.2.0
+
+##### Added
+
+* DateTime formatter
+
 ### v0.1.1
 
+##### Fixed
+
 * Broken specs. Shame on me :(
 
 ### v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    human_attributes (0.1.1)
+    human_attributes (0.2.0)
       enumerize (~> 1, >= 1.1.1)
       factory_girl_rails (~> 4.6)
       rails (~> 4.2, >= 4.2.0)

data/README.md

@@ -7,6 +7,7 @@ It's a Gem to convert ActiveRecord models' attributes and methods to human reada
 - [Formatters](#formatters)
   - [Numeric](#numeric)
   - [Date](#date)
+  - [DateTime](#datetime)
   - [Boolean](#boolean)
   - [Enumerize](#enumerize)
   - [Custom Formatter](#custom-formatter)
@@ -109,13 +110,62 @@ purchase.created_at = "04/06/1984 09:20:00"
 purchase.updated_at = "04/06/1984 09:20:00"
 ```
 
+And `/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  date:
+    formats:
+      default: "%Y-%m-%d"
+      short: "%b %d"
+```
+
 And having...
 
 ```ruby
 class Purchase < ActiveRecord::Base
   humanize :expired_at, date: { format: :short }
   humanize :created_at, date: true
-  humanize :updated_at, , date: { format: "%Y" }
+  humanize :updated_at, date: { format: "%Y" }
+end
+```
+
+You can do...
+
+```ruby
+purchase.human_expired_at #=> "04 Jun"
+purchase.human_created_at #=> "1984-06-04"
+purchase.human_updated_at #=> "1984"
+```
+
+#### DateTime
+
+With...
+
+```ruby
+pruchase = Purchase.new
+purchase.expired_at = "04/06/1984 09:20:00"
+purchase.created_at = "04/06/1984 09:20:00"
+purchase.updated_at = "04/06/1984 09:20:00"
+```
+
+And `/your_app/config/locales/en.yml`
+
+```yaml
+en:
+  time:
+    formats:
+      default: "%a, %d %b %Y %H:%M:%S %z"
+      short: "%d %b %H:%M"
+```
+
+And having...
+
+```ruby
+class Purchase < ActiveRecord::Base
+  humanize :expired_at, datetime: { format: :short }
+  humanize :created_at, datetime: true
+  humanize :updated_at, datetime: { format: "%Y" }
 end
 ```
 
@@ -127,8 +177,6 @@ purchase.human_created_at #=> "Mon, 04 Jun 1984 09:20:00 +0000"
 purchase.human_updated_at #=> "1984"
 ```
 
-The options you can use with the date type are the same as in [Rails guides](http://guides.rubyonrails.org/v4.2/i18n.html#adding-date-time-formats)
-
 #### Boolean
 
 With...
@@ -316,17 +364,27 @@ The `humanize_attributes` method will infer from the attribute's data type which
 With our `Purchase` model we will get:
 
 ```ruby
-purchase.human_id
-purchase.human_paid
-purchase.human_quantity
-purchase.human_commission
-purchase.human_amount
-purchase.human_expired_at
-purchase.expired_at_to_short_date
-purchase.human_created_at
-purchase.created_at_to_short_date
-purchase.human_updated_at
-purchase.updated_at_to_short_date
+human_id => Purchase: #1
+human_paid => Yes
+human_commission => 1000.990%
+human_quantity => 1
+human_expired_at => Fri, 06 Apr 1984 09:00:00 +0000
+expired_at_to_short_date => Apr 06
+expired_at_to_long_date => Apr 06
+expired_at_to_short_datetime => 06 Apr 09:00
+expired_at_to_long_datetime => 06 Apr 09:00
+human_amount => $2,000,000.95
+human_created_at => Sat, 10 Dec 2016 21:18:15 +0000
+created_at_to_short_date => Dec 10
+created_at_to_long_date => Dec 10
+created_at_to_short_datetime => 10 Dec 21:18
+created_at_to_long_datetime => 10 Dec 21:18
+human_updated_at => Sat, 10 Dec 2016 21:18:15 +0000
+updated_at_to_short_date => Dec 10
+updated_at_to_long_date => Dec 10
+updated_at_to_short_datetime => 10 Dec 21:18
+updated_at_to_long_datetime => 10 Dec 21:18
+human_state => Pending
 ```
 
 > You can pass to `humanize_attributes` the option `only: [:attr1, :attr2]` to humanize specific attributes. The `except` option works in similar way.

data/lib/human_attributes/active_record_extension.rb

@@ -33,8 +33,11 @@ module HumanAttributes
       def humanize_from_type(col)
         if col.name == "id"
           humanize(:id, custom: { formatter: ->(_o, value) { "#{model_name.human}: ##{value}" } })
-        elsif [:date, :datetime].include?(col.type)
+        elsif col.type == :date
           humanize_date(col.name)
+        elsif col.type == :datetime
+          humanize_date(col.name)
+          humanize_datetime(col.name)
         elsif [:decimal, :float, :integer].include?(col.type)
           humanize(col.name, delimiter: true)
         elsif col.type == :boolean
@@ -45,6 +48,13 @@ module HumanAttributes
       def humanize_date(attr_name)
         humanize(attr_name, date: true)
         humanize(attr_name, date: { format: :short, suffix: "to_short_date" })
+        humanize(attr_name, date: { format: :short, suffix: "to_long_date" })
+      end
+
+      def humanize_datetime(attr_name)
+        humanize(attr_name, datetime: true)
+        humanize(attr_name, datetime: { format: :short, suffix: "to_short_datetime" })
+        humanize(attr_name, datetime: { format: :short, suffix: "to_long_datetime" })
       end
     end
   end

data/lib/human_attributes/config.rb

@@ -48,6 +48,11 @@ module HumanAttributes
         category: :date,
         suffix: :to_human_date
       },
+      {
+        name: :datetime,
+        category: :datetime,
+        suffix: :to_human_datetime
+      },
       {
         name: :boolean,
         category: :boolean,

data/lib/human_attributes/engine.rb

@@ -14,6 +14,7 @@ module HumanAttributes
       require_relative "./formatters/base"
       require_relative "./formatters/numeric"
       require_relative "./formatters/date"
+      require_relative "./formatters/datetime"
       require_relative "./formatters/boolean"
       require_relative "./formatters/enumerize"
       require_relative "./formatters/custom"

data/lib/human_attributes/formatters/date.rb

@@ -2,7 +2,9 @@ module HumanAttributes
   module Formatters
     class Date < Base
       def apply(_instance, value)
-        I18n.l(value, options)
+        I18n.l(value.to_date, options)
+      rescue
+        nil
       end
     end
   end

data/lib/human_attributes/formatters/datetime.rb

@@ -0,0 +1,11 @@
+module HumanAttributes
+  module Formatters
+    class Datetime < Base
+      def apply(_instance, value)
+        I18n.l(value.to_datetime, options)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/human_attributes/version.rb

@@ -1,3 +1,3 @@
 module HumanAttributes
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/dummy/spec/lib/active_record_extension_spec.rb

@@ -291,47 +291,56 @@ RSpec.describe "ActiveRecordExtension" do
       end
     end
 
-    context "with date format" do
+    context "with date and datetime formats" do
       before { purchase.expired_at = "04/06/1984 09:20:00" }
+      before { purchase.created_at = "04/06/1985 09:20:00" }
 
       context "passing custom format" do
         before do
           class Purchase < ActiveRecord::Base
             humanize :expired_at, date: { format: "%Y" }
+            humanize :created_at, datetime: { format: "%Y" }
           end
         end
 
         it { expect(purchase.human_expired_at).to eq("1984") }
+        it { expect(purchase.human_created_at).to eq("1985") }
       end
 
       context "without options" do
         before do
           class Purchase < ActiveRecord::Base
             humanize :expired_at, date: true
+            humanize :created_at, datetime: true
           end
         end
 
-        it { expect(purchase.human_expired_at).to eq("Mon, 04 Jun 1984 09:20:00 +0000") }
+        it { expect(purchase.human_expired_at).to eq("1984-06-04") }
+        it { expect(purchase.human_created_at).to eq("Tue, 04 Jun 1985 09:20:00 +0000") }
       end
 
       context "with short format" do
         before do
           class Purchase < ActiveRecord::Base
             humanize :expired_at, date: { format: :short }
+            humanize :created_at, datetime: { format: :short }
           end
         end
 
-        it { expect(purchase.human_expired_at).to eq("04 Jun 09:20") }
+        it { expect(purchase.human_expired_at).to eq("Jun 04") }
+        it { expect(purchase.human_created_at).to eq("04 Jun 09:20") }
       end
 
       context "with long format" do
         before do
           class Purchase < ActiveRecord::Base
             humanize :expired_at, date: { format: :long }
+            humanize :created_at, datetime: { format: :long }
           end
         end
 
-        it { expect(purchase.human_expired_at).to eq("June 04, 1984 09:20") }
+        it { expect(purchase.human_expired_at).to eq("June 04, 1984") }
+        it { expect(purchase.human_created_at).to eq("June 04, 1985 09:20") }
       end
     end
   end
@@ -352,11 +361,11 @@ RSpec.describe "ActiveRecordExtension" do
       it { expect(purchase.human_commission).to eq("1,000.99") }
       it { expect(purchase.human_amount).to eq("2,000,000.95") }
       it { expect(purchase.human_expired_at).to eq("Fri, 06 Apr 1984 09:00:00 +0000") }
-      it { expect(purchase.expired_at_to_short_date).to eq("06 Apr 09:00") }
+      it { expect(purchase.expired_at_to_short_datetime).to eq("06 Apr 09:00") }
       it { expect(purchase).to respond_to(:human_created_at) }
-      it { expect(purchase).to respond_to(:created_at_to_short_date) }
+      it { expect(purchase).to respond_to(:created_at_to_short_datetime) }
       it { expect(purchase).to respond_to(:human_updated_at) }
-      it { expect(purchase).to respond_to(:updated_at_to_short_date) }
+      it { expect(purchase).to respond_to(:updated_at_to_short_datetime) }
     end
 
     context "with only option" do
@@ -372,11 +381,11 @@ RSpec.describe "ActiveRecordExtension" do
       it { expect(purchase).not_to respond_to(:human_commission) }
       it { expect(purchase.human_amount).to eq("2,000,000.95") }
       it { expect(purchase).not_to respond_to(:human_expired_at) }
-      it { expect(purchase).not_to respond_to(:expired_at_to_short_date) }
+      it { expect(purchase).not_to respond_to(:expired_at_to_short_datetime) }
       it { expect(purchase).not_to respond_to(:human_created_at) }
-      it { expect(purchase).not_to respond_to(:created_at_to_short_date) }
+      it { expect(purchase).not_to respond_to(:created_at_to_short_datetime) }
       it { expect(purchase).not_to respond_to(:human_updated_at) }
-      it { expect(purchase).not_to respond_to(:updated_at_to_short_date) }
+      it { expect(purchase).not_to respond_to(:updated_at_to_short_datetime) }
     end
 
     context "with except option" do
@@ -392,11 +401,11 @@ RSpec.describe "ActiveRecordExtension" do
       it { expect(purchase.human_commission).to eq("1,000.99") }
       it { expect(purchase).not_to respond_to(:human_amount) }
       it { expect(purchase.human_expired_at).to eq("Fri, 06 Apr 1984 09:00:00 +0000") }
-      it { expect(purchase.expired_at_to_short_date).to eq("06 Apr 09:00") }
+      it { expect(purchase.expired_at_to_short_datetime).to eq("06 Apr 09:00") }
       it { expect(purchase).to respond_to(:human_created_at) }
-      it { expect(purchase).to respond_to(:created_at_to_short_date) }
+      it { expect(purchase).to respond_to(:created_at_to_short_datetime) }
       it { expect(purchase).to respond_to(:human_updated_at) }
-      it { expect(purchase).to respond_to(:updated_at_to_short_date) }
+      it { expect(purchase).to respond_to(:updated_at_to_short_datetime) }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Platanus
@@ -164,6 +164,7 @@ files:
 - lib/human_attributes/formatters/boolean.rb
 - lib/human_attributes/formatters/custom.rb
 - lib/human_attributes/formatters/date.rb
+- lib/human_attributes/formatters/datetime.rb
 - lib/human_attributes/formatters/enumerize.rb
 - lib/human_attributes/formatters/numeric.rb
 - lib/human_attributes/formatters_builder.rb