time_jawn 1.1.1 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2Q3Zjk3MjhhNGY0OGY2MTg5YzUxMWU2NDlmZmM0MjdmMzI4NmM2NQ==
+    ZGZiZjdlNDRiOTc1YzY4NTcyM2ZiNzA5NmI0ZTNiN2EwMzVlNDg0NA==
   data.tar.gz: !binary |-
-    ZjQ2MzVhNjJiNjlkYjFlZDAyOGU5NzJhNDRmMDg1OGJkYWRjNDNmZQ==
+    NDAxNTQxODRlYWY1ZDFkNTM2ZDk4MGY4YzdiMzBjYThhYmY1NTNkMw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzNiYWNhNjZkMzBjYzM2M2JjZmU1MzdhZjQ0MDE3ODFkYjAzNDMyODhkYTgw
-    MjE5NmZjOWE4ODVjZDY5ZTU3NmE1YmFmMjAwZWU0YmNmNDBlZmE1NmQwYzk4
-    YmIxMDk3YTA2NGUwNWEyOWM4N2FhNTBlNzM3NWIzNzBiYmI1ZWU=
+    ODA1OWU3YjAyNjI4NjMyNzBiYmY5YWI2YTVhYmNhYzUzY2Y2ZTAzOGQzZjVl
+    NzgyYTE1ZTcwZDY1NzM1NWU4NDc4MGM5MDJhNTcyZTZjZWYxMWFiNWQ4OWY2
+    MWIxNGQ2NmIyNTFiNjFmZDAxNTdhNTFhZTYwYmJhZDFiMWNlMjQ=
   data.tar.gz: !binary |-
-    NTFjMDlhYTE2NTUwYmU0MmJhMzdhOWZlNDkzNzFhMzg3NzZhYWJjODk0MGIz
-    NWVmODdlOWZhNzM4OTRkNWE4YjdiNGZiZmI2ODBiNTg2NDdjNTQ5NDc2ZmE0
-    ZTA0NzA0ZWE1YmMwOTY0ZGU2MmY4NTM2N2I5MTAyMGU3ZDcwZTY=
+    MWM4MDY2OGU3Y2EwY2U3YjFhMGQxY2ZiMTMzNTAxYjY2OWE1OWRiNzI2M2Vk
+    YWNjNTk2NWM4YWQ3ZTg0M2RiYzBhYjFmZjc1YWI0NTFlODljNGU4Y2Y2MDli
+    YTlhZmVkOWM4OGE1OTMzYmRmY2Y0MTM2MjhlOGEyZGU2YzQxNDI=

data/lib/time_jawn/time_jawn.rb

@@ -1,46 +1,12 @@
 # The base module of the TimeJawn gem. Everything in here assumes that your model has a valid time zone
 # in a attribute name time_zone or has been delegating one to somewhere else.
 module TimeJawn
+  require 'time_jawn/time_jawn_private_class_methods'
   # Automatically runs and adds ClassMethods to ActiveRecord::Base
   def self.included(base)
     base.send :extend, ClassMethods
   end
   
-
-  # Defines private methods necessary for TimeJawn to work. 
-  module TimeJawnPrivateClassMethods
-    # Locates all of an ActiveRecord class' DateTime Attributes and returns them as an array of symbols.
-    def _datetime_attributes
-      ActiveSupport::Deprecation.warn "_datetime_attributes will be made private in a future version."
-      klass = name.constantize
-
-      datetime_attributes = []
-      klass.columns.each do |column|
-         datetime_attributes << column.name.to_sym if column.type == :datetime
-      end
-      return datetime_attributes
-    end
-
-    private
-
-    # generates an instance method called "local_#{attribute}" that calls the _to_local instance method.
-    def _generate_to_local(attribute)
-      define_method(:"local_#{attribute}") { _to_local(send(attribute)) }
-    end
-
-    # generates an instance method called "local_#{attribute}=" that calls either the _add_zone or _change_zone
-    # instance methods depending on teh class of the input.
-    def _generate_to_local_with_assignment(attribute)
-      define_method(:"local_#{attribute}=") do |time_or_string_value|
-        if time_or_string_value.is_a? String
-          write_attribute(attribute, _add_zone(time_or_string_value))
-        else
-          write_attribute(attribute, _change_zone(time_or_string_value))
-        end
-      end
-    end
-  end
-  
   # Defines methods that will attached to all ActiveRecord classes.
   module ClassMethods
     include TimeJawnPrivateClassMethods
@@ -54,14 +20,12 @@ module TimeJawn
     #     class Event<ActiveRecord::Base
     #       has_time_zone    :this_is_my_time_zone
     #     end 
-    def has_time_zone(time_zone_attribute_name=:time_zone)
-      @time_zone_attribute_name = time_zone_attribute_name
+    def has_time_zone(time_zone_attribute_name=:time_zone, options_hash={})
+      _set_instance_variables(time_zone_attribute_name, options_hash)
       send :include, InstanceMethods
     end
   end
 
-  
-  
   #Defines methods that will be added to instances of classes that have previously called has_time_zone.
   module InstanceMethods
     # This method generates a series of methods on instances by calling the _generate_to_local and
@@ -97,7 +61,8 @@ module TimeJawn
     #
     # You can see examples of how these methods work in the specs folder.
     def self.included(base)
-      (base.send :_datetime_attributes).each do |attribute|
+      date_time_attributes = base.send(:_class_date_attributes_or_arguments)
+      date_time_attributes.each do |attribute|
         base.send(:_generate_to_local, attribute)
         base.send(:_generate_to_local_with_assignment, attribute)
       end

data/lib/time_jawn/time_jawn_private_class_methods.rb

@@ -0,0 +1,65 @@
+# Defines private methods necessary for TimeJawn to work. 
+module TimeJawnPrivateClassMethods
+  # Locates all of an ActiveRecord class' DateTime Attributes and returns them as an array of symbols.
+  def _datetime_attributes
+    ActiveSupport::Deprecation.warn "_datetime_attributes will be made private in a future version."
+    klass = name.constantize
+
+    datetime_attributes = []
+    klass.columns.each do |column|
+       datetime_attributes << column.name.to_sym if column.type == :datetime
+    end
+    return datetime_attributes
+  end
+
+  private
+  
+  def _set_instance_variables(time_zone_attribute_name, options_hash)
+    @time_zone_attribute_name = _evaluate_time_zone_attribute_name(time_zone_attribute_name)
+    @time_jawn_date_time_attributes = _evaluate_time_jawn_date_time_attributes(time_zone_attribute_name, options_hash)
+  end
+
+  def _evaluate_time_zone_attribute_name(time_zone_attribute_name)
+    if time_zone_attribute_name.kind_of?(Hash)
+      :time_zone
+    else
+      time_zone_attribute_name
+    end
+  end
+
+  def _evaluate_time_jawn_date_time_attributes(time_zone_attribute_name, options_hash)
+    if options_hash.fetch(:time_attributes, false)
+      @time_jawn_date_time_attributes = options_hash.fetch(:time_attributes, nil)
+    elsif time_zone_attribute_name.kind_of?(Hash)
+      @time_jawn_date_time_attributes = time_zone_attribute_name.fetch(:time_attributes, nil)
+    else
+      @time_jawn_date_time_attributes = nil
+    end
+  end
+
+  # generates an instance method called "local_#{attribute}" that calls the _to_local instance method.
+  def _generate_to_local(attribute)
+    define_method(:"local_#{attribute}") { _to_local(send(attribute)) }
+  end
+
+  # generates an instance method called "local_#{attribute}=" that calls either the _add_zone or _change_zone
+  # instance methods depending on teh class of the input.
+  def _generate_to_local_with_assignment(attribute)
+    define_method(:"local_#{attribute}=") do |time_or_string_value|
+      if time_or_string_value.is_a? String
+        write_attribute(attribute, _add_zone(time_or_string_value))
+      else
+        write_attribute(attribute, _change_zone(time_or_string_value))
+      end
+    end
+  end
+
+  # returns all of the date_time attributes for a class unless it is specified in the class.
+  def _class_date_attributes_or_arguments
+    if @time_jawn_date_time_attributes
+      @time_jawn_date_time_attributes
+    else
+      _datetime_attributes
+    end
+  end
+end

data/spec/time_jawn_spec.rb

@@ -210,3 +210,61 @@ describe Event do
     it { should respond_to :_change_zone }
   end
 end
+
+describe Occurrence do
+  before do
+    @occurrence1 = Occurrence.find_by_name('Eastern Time (US & Canada)')
+  end
+  
+  context "Ocurrence instance attribute accessor" do
+    describe "time_zone_attribute_name" do
+      it 'should respond with the time_zone attribute name as defined in the class.' do
+        expect( @occurrence1.class.time_zone_attribute_name ).to eq :time_zone
+      end
+    end
+  end
+
+  context "Occurrence should have time_jawn methods, except for local_updated_at, since it is not specified in the model" do
+    subject { @occurrence1 }
+
+    it { should respond_to :local_start_time }
+    it { should respond_to :local_created_at }
+    it { should_not respond_to :local_updated_at }
+    it { should respond_to :local_start_time= }
+    it { should respond_to :local_created_at= }
+    it { should_not respond_to :local_updated_at= }
+    it { should respond_to :current_time }
+    it { should respond_to :_to_local }
+    it { should respond_to :_add_zone }
+    it { should respond_to :_change_zone }
+  end
+end
+
+describe Occasion do
+  before do
+    @occasion1 = Occasion.find_by_name('Eastern Time (US & Canada)')
+  end
+
+  context "Occasion instance attribute accessor" do
+    describe "time_zone_attribute_name" do
+      it 'should respond with the time_zone attribute name as defined in the class.' do
+        expect( @occasion1.class.time_zone_attribute_name ).to eq :t_z
+      end
+    end
+  end
+
+  context "Occasion should have time_jawn methods, except for local_updated_at, since it is not specified in the model, even though it has a non_conventional attribute" do
+    subject { @occasion1 }
+
+    it { should respond_to :local_start_time }
+    it { should_not respond_to :local_created_at }
+    it { should_not respond_to :local_updated_at }
+    it { should respond_to :local_start_time= }
+    it { should_not respond_to :local_created_at= }
+    it { should_not respond_to :local_updated_at= }
+    it { should respond_to :current_time }
+    it { should respond_to :_to_local }
+    it { should respond_to :_add_zone }
+    it { should respond_to :_change_zone }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_jawn
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mark Platt
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - lib/time_jawn.rb
 - lib/time_jawn/time_jawn.rb
+- lib/time_jawn/time_jawn_private_class_methods.rb
 - spec/time_jawn_spec.rb
 homepage: http://tammantech.com
 licenses: