time_of_day_attr 1.0.1 → 2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e68d3a3113ec2f822baaf494be19917961776bb
-  data.tar.gz: 55033d8269193c077a111f956e0f66c45a185eb2
+  metadata.gz: 3c2d0f7310864cfe4dc2da656253d4fdc657c03d
+  data.tar.gz: 83f2e0bd9b341836d29921fd9eb9b08218696227
 SHA512:
-  metadata.gz: 65715383e95ff76d0b793e14d242200b42b9ef24042134619a3f3ea14e49c82ac80b483a57d73eedb7c40d9a46d31193dc777b985f724c9f8f3ba1fb92556506
-  data.tar.gz: f013b80172f9d1260b5cfe52a9d7fbd6bff9d83468ec11f2e770faca123f856cec8ad475084af4beba9bd174a953e9fd6a573c1207dda54c31bacb681b1b49d9
+  metadata.gz: 8bae930ff5660092fdf4b79c6e723445982dba160fab611528c3e42699ef0c827f15d9671196085b8e9154d8b40e95393c18a4273359d685fd7f9a934897d208
+  data.tar.gz: 79641b79ff5de0ab50312f5871255411eb448b6eb1e5833e2c81a3beabc9c6ce059a6f91d33de33ad8666dc4d87a92bab5a255807c35de11dbced73579f3cef2

data/README.md

@@ -1,7 +1,7 @@
 # Time of day attributes for your Rails model
 [![Gem Version](https://badge.fury.io/rb/time_of_day_attr.png)](http://badge.fury.io/rb/time_of_day_attr) [![Code Climate](https://codeclimate.com/github/clemenst/time_of_day_attr.png)](https://codeclimate.com/github/clemenst/time_of_day_attr) [![License](https://img.shields.io/npm/l/express.svg?style=flat)](http://clemenst.mit-license.org)
 
-This ruby gem converts time of day to seconds since midnight and back. The seconds value is stored in the database and can be used for calculations and validations. 
+This ruby gem converts time of day to seconds since midnight and back. The seconds value is stored in the database and can be used for calculations and validations.
 
 ## Installation
 
@@ -75,6 +75,37 @@ TimeOfDayAttr.l(business_hour.opening, format: :custom)
  => '09-00'
 ```
 
+### Prepending
+
+If you want to process the converted value in your model, you can use the prepend option:
+
+```ruby
+class BusinessHour < ActiveRecord::Base
+  attr_reader :tracked_opening, :tracked_closing
+
+  time_of_day_attr :opening
+  time_of_day_attr :closing, prepend: true
+
+  def opening=(value)
+    @tracked_opening = value
+    super(value)
+  end
+
+  def closing=(value)
+    @tracked_closing = value
+    super(value)
+  end
+end
+```
+
+```ruby
+business_hour = BusinessHour.new(opening: '9', closing: '9')
+business_hour.tracked_opening
+=> '9'
+business_hour.tracked_closing
+=> 32400
+```
+
 ### time of day field
 
 To get a text field with the converted value:

data/Rakefile

@@ -20,9 +20,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -34,5 +31,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
-task :default => :test
+task default: :test

data/lib/time_of_day_attr/active_record_ext.rb

@@ -1,35 +1,32 @@
+require 'active_record'
+
 module TimeOfDayAttr
   module ActiveRecordExt
     extend ActiveSupport::Concern
 
     module ClassMethods
-
       def time_of_day_attr(*attrs)
         options = attrs.extract_options!
-        options[:formats] ||= [:default, :hour]
-        attrs.each do |attr|
-          define_method("#{attr}=") do |value|
-            if value.is_a?(String)
-              delocalized_values = options[:formats].map do |format|
-                begin
-                  TimeOfDayAttr.delocalize(value, format: format)
-                rescue ArgumentError => e
-                  if 'argument out of range' == e.message
-                    super(nil)
-                    return
-                  end
-                  nil
-                end
+
+        writers = Module.new do
+          attrs.each do |attr|
+            define_method("#{attr}=") do |value|
+              if value.is_a?(String)
+                delocalized_value = TimeOfDayAttr.delocalize(value, options)
+                super(delocalized_value)
+              else
+                super(value)
               end
-              delocalized_value = delocalized_values.compact.first
-              super(delocalized_value)
-            else
-              super(value)
             end
           end
         end
+
+        if options[:prepend]
+          prepend writers
+        else
+          include writers
+        end
       end
-    
     end
   end
 end

data/lib/time_of_day_attr/form_builder_ext.rb

@@ -1,15 +1,18 @@
+require 'action_view'
+
 module TimeOfDayAttr
   module FormBuilderExt
     extend ActiveSupport::Concern
 
     def time_of_day_field(method, options = {})
-      unless options[:value]
-        value = object.send(method)
-        options[:value] = TimeOfDayAttr.localize(value, options.extract!(:format, :omit_minutes_at_full_hour))
+      options[:value] ||= begin
+        value = object.public_send(method)
+        TimeOfDayAttr.localize(value, options.extract!(:format, :omit_minutes_at_full_hour))
       end
       text_field(method, options)
     end
-
   end
 end
-ActionView::Helpers::FormBuilder.send(:include, TimeOfDayAttr::FormBuilderExt)
+ActiveSupport.on_load :action_view do
+  ActionView::Helpers::FormBuilder.send(:include, TimeOfDayAttr::FormBuilderExt)
+end

data/lib/time_of_day_attr/seconds.rb

@@ -0,0 +1,17 @@
+module TimeOfDayAttr
+  Seconds = Struct.new(:value) do
+    def to_time_of_day(time_format)
+      # Switch to beginning of year to prevent wrong conversion on the day of time change
+      # see https://en.wikipedia.org/wiki/Daylight_saving_time
+      time = Time.now.beginning_of_year.at_midnight + value.seconds
+
+      time_of_day = time.strftime(time_format)
+
+      if 24.hours.to_i == value
+        time_of_day.gsub(' 0', '24')
+      else
+        time_of_day
+      end
+    end
+  end
+end

data/lib/time_of_day_attr/time_of_day.rb

@@ -0,0 +1,18 @@
+module TimeOfDayAttr
+  TimeOfDay = Struct.new(:value) do
+    def to_seconds(time_format)
+      time = Time.strptime(value, time_format)
+      # Switch to beginning of year to prevent wrong conversion on the day of time change
+      # see https://en.wikipedia.org/wiki/Daylight_saving_time
+      time = time.change(month: 1, day: 1)
+
+      seconds = time.seconds_since_midnight.to_i
+
+      if seconds.zero? && value.starts_with?('24')
+        24.hours.to_i
+      else
+        seconds
+      end
+    end
+  end
+end

data/lib/time_of_day_attr/version.rb

@@ -1,3 +1,3 @@
 module TimeOfDayAttr
-  VERSION = '1.0.1'
+  VERSION = '2'.freeze
 end

data/lib/time_of_day_attr.rb

@@ -1,52 +1,51 @@
+require 'time_of_day_attr/time_of_day'
+require 'time_of_day_attr/seconds'
 require 'time_of_day_attr/active_record_ext'
-require 'action_view'
 require 'time_of_day_attr/form_builder_ext'
 
-files = Dir[File.join(File.dirname(__FILE__), '../config/locales/*.yml')]
-I18n.load_path.concat(files)
+formats = Dir[File.join(File.dirname(__FILE__), '../config/locales/*.yml')]
+I18n.load_path.concat(formats)
 
 module TimeOfDayAttr
+  DEFAULT_FORMATS = [:default, :hour].freeze
 
   class << self
-
     def delocalize(value, options = {})
-      format  = options[:format] || :default
-      format  = translate_format(format) if format.is_a?(Symbol)
-      time    = Time.strptime(value, format).change(month: 1, day: 1)
-      seconds = time.seconds_since_midnight.to_i
-      if seconds.zero? && value.starts_with?('24')
-        24.hours.to_i
-      else
-        seconds
+      time_of_day = TimeOfDay.new(value)
+
+      formats = options[:formats] || DEFAULT_FORMATS
+
+      delocalized_values = formats.map do |format|
+        begin
+          return time_of_day.to_seconds(time_format(format))
+        rescue ArgumentError => e
+          return nil if e.message.include?('out of range')
+          next
+        end
       end
+
+      delocalized_values.compact.first
     end
 
     def localize(value, options = {})
       return value unless value.respond_to?(:seconds)
-      format  = options[:format] || :default
-      format  = translate_format(format) if format.is_a?(Symbol)
-      # Switch to beginning of year to prevent wrong time on the day of time change
-      # see https://en.wikipedia.org/wiki/Daylight_saving_time
-      time    = Time.now.beginning_of_year.at_midnight + value.seconds
-      time_of_day = time.strftime(format)
-      if 24.hours.to_i == value
-        time_of_day.gsub!(' 0', '24')
-      end
-      if options[:omit_minutes_at_full_hour]
-        if time_of_day.end_with?('00')
-          time_of_day = time_of_day[0...-3]
-        end
-      end
-      time_of_day
+
+      format = options[:format] || DEFAULT_FORMATS.first
+
+      time_of_day = Seconds.new(value).to_time_of_day(time_format(format))
+
+      omit_minutes = options[:omit_minutes_at_full_hour] && time_of_day.end_with?('00')
+
+      omit_minutes ? time_of_day[0...-3] : time_of_day
     end
-    alias :l :localize
+    alias l localize
 
     private
 
-    def translate_format(format)
-      I18n.translate("time_of_day.formats.#{format}")
-    end
+    def time_format(format)
+      translate = format.is_a?(Symbol)
 
+      translate ? I18n.translate("time_of_day.formats.#{format}") : format
+    end
   end
-
 end

data/test/active_record_ext_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'active_record'
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+require_relative 'schema'
+require_relative 'models/business_hour'
+
+class ActiveRecordExtTest < ActiveSupport::TestCase
+  context 'time of day value' do
+    setup do
+      @business_hour = BusinessHour.new(opening: '9:00', closing: '17:00')
+    end
+
+    should 'be converted to seconds since midnight' do
+      assert_equal 32_400, @business_hour.opening
+      assert_equal 61_200, @business_hour.closing
+    end
+  end
+
+  context 'hour formatted time of day value' do
+    setup do
+      @business_hour = BusinessHour.new(opening: '9', closing: '17')
+    end
+
+    should 'be converted to seconds since midnight' do
+      assert_equal 32_400, @business_hour.opening
+      assert_equal 61_200, @business_hour.closing
+    end
+  end
+
+  context 'unsupported time of day value' do
+    setup do
+      @business_hour = BusinessHour.new(opening: 55_800)
+      @business_hour.opening = 'Nine'
+    end
+
+    should 'be converted to nil' do
+      assert_nil @business_hour.opening
+    end
+  end
+
+  context 'non string value' do
+    setup do
+      @business_hour = BusinessHour.new(opening: 55_800)
+    end
+
+    should 'not be converted' do
+      assert_equal 55_800, @business_hour.opening
+    end
+  end
+
+  context 'prepend option' do
+    setup do
+      @business_hour = BusinessHour.new(opening: '9', closing: '9')
+    end
+
+    should 'be supported' do
+      assert_equal '9', @business_hour.tracked_opening
+      assert_equal 32_400, @business_hour.opening
+
+      assert_equal 32_400, @business_hour.tracked_closing
+      assert_equal 32_400, @business_hour.closing
+    end
+  end
+end

data/test/models/business_hour.rb

@@ -1,3 +1,16 @@
 class BusinessHour < ActiveRecord::Base
-  time_of_day_attr :opening, :closing
+  attr_reader :tracked_opening, :tracked_closing
+
+  time_of_day_attr :opening
+  time_of_day_attr :closing, prepend: true
+
+  def opening=(value)
+    @tracked_opening = value
+    super(value)
+  end
+
+  def closing=(value)
+    @tracked_closing = value
+    super(value)
+  end
 end

data/test/schema.rb

@@ -1,8 +1,7 @@
 ActiveRecord::Migration.verbose = false
 
 ActiveRecord::Schema.define do
-  
-  create_table :business_hours, :force => true do |t|
+  create_table :business_hours, force: true do |t|
     t.integer :opening
     t.integer :closing
   end

data/test/test_helper.rb

@@ -1,12 +1,5 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require 'active_record'
 require 'minitest/autorun'
+require 'shoulda/context'
 require 'time_of_day_attr'
-
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-
-require File.expand_path('../schema', __FILE__)
-
-Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each { |f| require f }

data/test/time_of_day_attr_test.rb

@@ -1,71 +1,43 @@
 require 'test_helper'
 
 class TimeOfDayAttrTest < ActiveSupport::TestCase
-  
-  test 'delocalize time of day' do
-    assert_equal 36000, TimeOfDayAttr.delocalize('10:00')
-    assert_equal 55800, TimeOfDayAttr.delocalize('15:30')
-    assert_equal 61140, TimeOfDayAttr.delocalize('16:59')
-    assert_equal 32400, TimeOfDayAttr.delocalize('9:00')
-    assert_equal 32400, TimeOfDayAttr.delocalize('09:00')
-    assert_equal 32400, TimeOfDayAttr.delocalize('9', format: :hour)
+  context '::localize' do
+    should 'convert seconds to time of day' do
+      assert_equal ' 9:00', TimeOfDayAttr.localize(32_400)
+      assert_equal '14:45', TimeOfDayAttr.localize(53_100)
+    end
+
+    should 'omit minutes at full hour' do
+      assert_equal ' 9',      TimeOfDayAttr.localize(32_400, omit_minutes_at_full_hour: true)
+      assert_equal '14',      TimeOfDayAttr.localize(50_400, omit_minutes_at_full_hour: true)
+      assert_equal '14:45',   TimeOfDayAttr.localize(53_100, omit_minutes_at_full_hour: true)
+    end
+
+    should 'convert nil to nil' do
+      assert_nil TimeOfDayAttr.localize(nil)
+    end
+
+    should 'support 24 hours' do
+      assert_equal ' 0:00', TimeOfDayAttr.localize(0)
+      assert_equal '24:00', TimeOfDayAttr.localize(86_400)
+      assert_equal ' 0', TimeOfDayAttr.localize(0, omit_minutes_at_full_hour: true)
+      assert_equal '24', TimeOfDayAttr.localize(86_400, omit_minutes_at_full_hour: true)
+    end
+  end
+
+  context '::delocaize' do
+    should 'convert time of day to seconds' do
+      assert_equal 36_000, TimeOfDayAttr.delocalize('10:00')
+      assert_equal 55_800, TimeOfDayAttr.delocalize('15:30')
+      assert_equal 61_140, TimeOfDayAttr.delocalize('16:59')
+      assert_equal 32_400, TimeOfDayAttr.delocalize('9:00')
+      assert_equal 32_400, TimeOfDayAttr.delocalize('09:00')
+      assert_equal 32_400, TimeOfDayAttr.delocalize('9', formats: [:hour])
+    end
+
+    should 'convert out of range time of day to nil' do
+      assert_nil TimeOfDayAttr.delocalize('25:00')
+      assert_nil TimeOfDayAttr.delocalize('24:30')
+    end
   end
-
-  test 'localize time of day' do
-    assert_equal ' 9:00', TimeOfDayAttr.localize(32400)
-    assert_equal '14:45', TimeOfDayAttr.localize(53100)
-  end
-
-  test 'localize time of day and omit minutes at full hour' do
-    assert_equal ' 9',      TimeOfDayAttr.localize(32400, omit_minutes_at_full_hour: true)
-    assert_equal '14',      TimeOfDayAttr.localize(50400, omit_minutes_at_full_hour: true)
-    assert_equal '14:45',   TimeOfDayAttr.localize(53100, omit_minutes_at_full_hour: true)
-  end
-
-  test 'localizing nil should return nil' do
-    assert_nil TimeOfDayAttr.localize(nil)
-  end
-
-  test 'time of day attr setter should delocalize value' do
-    business_hour = BusinessHour.new(opening: '9:00', closing: '17:00')
-    assert_equal 32400, business_hour.opening
-    assert_equal 61200, business_hour.closing
-  end
-
-  test 'time of day attr setter should delocalize hour formatted value' do
-    business_hour = BusinessHour.new(opening: '9', closing: '17')
-    assert_equal 32400, business_hour.opening
-    assert_equal 61200, business_hour.closing
-  end
-
-  test 'time of day attr setter should ignore invalid formats' do
-    business_hour = BusinessHour.new(opening: 'Nine', closing: 'Five')
-    assert_nil business_hour.opening
-    assert_nil business_hour.closing
-    business_hour.opening = '9'
-    assert_equal 32400, business_hour.opening
-    business_hour.opening = 'Nine'
-    assert_nil business_hour.opening
-    business_hour.opening = '9:30'
-    assert_equal 34200, business_hour.opening
-    business_hour.opening = 55800
-    assert_equal 55800, business_hour.opening
-    business_hour.opening = nil
-    assert_nil business_hour.opening
-    business_hour.opening = '25:00'
-    assert_nil business_hour.opening
-    business_hour.opening = '24:30'
-    assert_nil business_hour.opening
-  end
-
-  test '24 should be usable' do
-    business_hour = BusinessHour.new(opening: '0', closing: '24')
-    assert_equal 0, business_hour.opening
-    assert_equal 86400, business_hour.closing
-    assert_equal ' 0:00', TimeOfDayAttr.localize(business_hour.opening)
-    assert_equal '24:00', TimeOfDayAttr.localize(business_hour.closing)
-    assert_equal ' 0', TimeOfDayAttr.localize(business_hour.opening, omit_minutes_at_full_hour: true)
-    assert_equal '24', TimeOfDayAttr.localize(business_hour.closing, omit_minutes_at_full_hour: true)
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_of_day_attr
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '2'
 platform: ruby
 authors:
 - Clemens Teichmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,13 +54,17 @@ files:
 - lib/time_of_day_attr.rb
 - lib/time_of_day_attr/active_record_ext.rb
 - lib/time_of_day_attr/form_builder_ext.rb
+- lib/time_of_day_attr/seconds.rb
+- lib/time_of_day_attr/time_of_day.rb
 - lib/time_of_day_attr/version.rb
+- test/active_record_ext_test.rb
 - test/models/business_hour.rb
 - test/schema.rb
 - test/test_helper.rb
 - test/time_of_day_attr_test.rb
 homepage: https://github.com/clemenst/time_of_day_attr
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -78,12 +82,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Time of day attributes for your Rails model
 test_files:
 - test/schema.rb
 - test/models/business_hour.rb
+- test/active_record_ext_test.rb
 - test/time_of_day_attr_test.rb
 - test/test_helper.rb