time_jawn 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6a4e6f180be9199ca277acb30b77eb1c669e5d2
-  data.tar.gz: 7d4358869e51cdc0c2beabca8d190b88b0d413e3
+  metadata.gz: 43cab13ed141d58f7c5c1548f44add5d884b78ec
+  data.tar.gz: f77795556c4518bf255f72c2a5a7b722f73e0b12
 SHA512:
-  metadata.gz: 267b4c81102f5f0802a19fd994588328e9dd58c5ea7f01f3b070cc36c33a0e885d3da624c6bad842a816dc47d64a2af0627ad2e404cd15faeddd6dd0425fb53e
-  data.tar.gz: cad1e579ac4eacce73346c287be8d4d95bd3dfec0ec173b5852311ac46ec71038eaecb423f5d5e8183a64fd6b0de4e7d97c5a415e630c04e4328af9482070f22
+  metadata.gz: 0ceff171264974bf5b9a05f861bd15c79b32fe5b51d8b41d16283eccf5c70992e649e8ef53f29558bece9a64bc04ca780747eb264b48f3f299e36e44873329e2
+  data.tar.gz: a7f703ff5859bb5f580b14e4b6695dca293e5149c8f4969ca2bfccb9cc009b8cafd407da64f11575e885cf846ca26ca4339b2408e3eeaf7006f6bc45ef091894

data/lib/time_jawn/time_jawn.rb

@@ -1,5 +1,6 @@
-# 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.
+# 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'
 
@@ -15,26 +16,31 @@ module TimeJawn
     include TimeJawnPrivateClassMethods
     attr_reader :time_zone_attribute_name
     # When called it loads the methods located in InstanceMethods.
-    # It is typically included in a model's rb file so that instances of that class gain the InstanceMethods at each instantiation.
+    # It is typically included in a model's rb file so that instances of that
+    # class gain the InstanceMethods at each instantiation.
     #     class Event<ActiveRecord::Base
     #       has_time_zone
     #     end
-    # Optionally you may pass the name of your time zone attribute in as a symbol.
+    # Optionally you may pass the name of your time zone attribute in as a
+    # symbol.
     #     class Event<ActiveRecord::Base
-    #       has_time_zone    :this_is_my_time_zone
-    def has_time_zone(time_zone_attribute_name=:time_zone, options_hash={})
-      _set_instance_variables(time_zone_attribute_name, options_hash)
-      send :include, InstanceMethods
+    #       has_time_zone   named: :this_is_my_time_zone
+    #     end
+    def has_time_zone(options_hash={})
+      set_instance_variables(options_hash)
+      send(:include, InstanceMethods)
     end
   end
 
-  #Defines methods that will be added to instances of classes that have previously called has_time_zone.
+  #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
-    #  _generate_to_local_with_assignment that are private on teh parent class. The methods that are created are called
-    # local_#{attribue} and local_#{attribute}= the attribute portion their names are completed by enumerating
-    # the datetime_attributes of the class. Twice as many methods as there are DateTime attributes will
-    # be created.
+    # This method generates a series of methods on instances by calling the
+    # enerate_to_local and generate_to_local_with_assignment that are private on
+    # the parent class. The methods that are created are called
+    # local_#{attribue} and local_#{attribute}= the attribute portion their
+    # names are completed by enumerating the datetime_attributes of the class.
+    # Twice as many methods as there are DateTime attributes will be created.
     #
     #    :created_at, and :updated_at
     #
@@ -43,54 +49,65 @@ module TimeJawn
     #     local_created_at=
     #     local_updated_at=
     #
-    # The local_#{attribue} methods will take the value stored in the attribute indicated by the methods name
-    # and apply a time zone conversion to it. This is useful for displaying the local time (according to the object).
+    # The local_#{attribue} methods will take the value stored in the attribute
+    # indicated by the methods name and apply a time zone conversion to it. This
+    #  is useful for displaying the local time (according to the object).
     #
-    # local_#{attribute}= methods are assignment shortcuts. They behave a little differently than you would expect.
-    # They do not take a local time and convert it into utc (or whatever, ActiveSupport will handle that for us),
-    # what these assigment methods do is take any sort of string that looks like a time, or any sort of time or datetime
-    # object lop off whatever timezone is being fed in and glue the instances local timezone on the end before applying
-    # it to the appropriate attribute. This is convenient for some one in one time zone setting a value for an instance
-    # that represents a different time zone. For example:
+    # local_#{attribute}= methods are assignment shortcuts. They behave a little
+    # differently than you would expect. They do not take a local time and
+    # convert it into utc (or whatever, ActiveSupport will handle that for us),
+    # what these assigment methods do is take any sort of string that looks like
+    # a time, or any sort of time or datetime object lop off whatever timezone
+    # is being fed in and glue the instances local timezone on the end before
+    # applying it to the appropriate attribute. This is convenient for some one
+    # in one time zone setting a value for an instance that represents a
+    # different time zone. For example:
     #
-    #     I am in Philadelphia (EST), my application is set to UTC, and I want to set the time on an Alarm instance that
-    #     goes off in San Francisco (PST). I want that time to be 6PM. In Philadlephia I choose 6PM (local), the applications assumes I
-    #     meant 6PM UTC (2PM EST and 11AM PST). That is not what I intended, I intended on 6PM PST, and now my Alarm is all wrong.
-    #     The assignment methods turn 6PM (set in EST, and processed in UTC) into 6PM PST (or 9PM EST, 1AM UTC) the expected time. The
-    #     Alarm goes off as expected!*
+    #     I am in Philadelphia (EST), my application is set to UTC, and I want
+    #     to set the time on an Alarm instance that  goes off in San Francisco
+    #     (PST). I want that time to be 6PM. In Philadlephia I choose 6PM
+    #     (local), the applications assumes I meant 6PM UTC (2PM EST and 11AM
+    #     PST). That is not what I intended, I intended on 6PM PST, and now my
+    #     Alarm is all wrong. The assignment methods turn 6PM (set in EST, and
+    #     processed in UTC) into 6PM PST (or 9PM EST, 1AM UTC) the expected
+    #     time. The Alarm goes off as expected!*
     #
     #     *Times in this example may be wrong since I put them in myself.
     #
     # You can see examples of how these methods work in the specs folder.
     def self.included(base)
-      date_time_attributes = base.send(:_class_date_attributes_or_arguments)
+      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)
+        base.send(:generate_to_local, attribute)
+        base.send(:generate_to_local_with_assignment, attribute)
       end
     end
+
     # Returns the current time according to the instance.
     def current_time
-      _to_local(DateTime.current)
+      to_local(DateTime.current)
     end
-    # converts a time object into it's local counter part (they will have the same value but differnt presentation.)
-    def _to_local(time)
-      ActiveSupport::Deprecation.warn "_to_local will be made private in a future version."
+
+    private
+
+    # converts a time object into it's local counter part (they will have the
+    # same value but differnt presentation.)
+    def to_local(time)
       time.in_time_zone(self.send(self.class.time_zone_attribute_name))
     end
 
-    # Given a string that looks like a time. It will convert that string into a time object that matches the time but with
-    # the instances time zone appended.
-    def _add_zone(time_string)
-      ActiveSupport::Deprecation.warn "_add_zone will be made private in a future version."
+    # Given a string that looks like a time. It will convert that string into a
+    # time object that matches the time but with the instances time zone
+    # appended.
+    def add_zone(time_string)
       Time.zone = self.send(self.class.time_zone_attribute_name)
       Time.zone.parse(Time.parse(time_string).strftime(DATE_FORMAT))
     end
 
-    # Returns a string representation of a time object suitable for consumption by add_zone.
-    def _change_zone(time)
-      ActiveSupport::Deprecation.warn "_change_zone will be made private in a future version."
-      _add_zone(time.strftime(DATE_FORMAT))
+    # Returns a string representation of a time object suitable for consumption
+    # by add_zone.
+    def change_zone(time)
+      add_zone(time.strftime(DATE_FORMAT))
     end
   end
 end

data/lib/time_jawn/time_jawn_private_class_methods.rb

@@ -1,61 +1,44 @@
 # 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
-    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
+  # Locates all of an ActiveRecord class' DateTime Attributes and returns them
+  # as an array of symbols.
+  def datetime_attributes
+    name.constantize.columns.map do |column|
+       next unless column.type == :datetime
+       column.name.to_sym
+    end.compact
   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
+  def set_instance_variables(options_hash)
+    @time_zone_attribute_name = options_hash.fetch(:named, :time_zone)
+    @time_jawn_date_time_attributes = options_hash.fetch(:time_attributes, nil)
   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)) }
+  # 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)
+  # generates an instance method called "local_#{attribute}=" that calls either
+  # the add_zone or _change_zone instance methods depending on the 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))
+        write_attribute(attribute, add_zone(time_or_string_value))
       else
-        write_attribute(attribute, _change_zone(time_or_string_value))
+        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
-    @time_jawn_date_time_attributes || _datetime_attributes
+  # returns all of the date_time attributes for a class unless it is specified
+  # in the class.
+  def class_date_attributes_or_arguments
+    @time_jawn_date_time_attributes || datetime_attributes
   end
 end

data/spec/time_jawn_spec.rb

@@ -2,16 +2,27 @@ require 'spec_helper'
 
 describe Happening do
   before(:each){
-      @happening1 = Happening.find_by_name('Eastern Time (US & Canada)')
-      @happening2 = Happening.find_by_name('Pacific/Honolulu')
-      Time.zone = 'UTC'
+    @happening1 =
+      Happening.new(
+        start_time: DateTime.new+6725.years+3.months+1.minute,
+        time_zone: 'Eastern Time (US & Canada)',
+        name:'Eastern Time (US & Canada)',
+        updated_at: DateTime.new+6725.years+1.minute,
+        created_at: DateTime.new+6725.years+1.minute
+      )
+
+    @happening2 =
+      Happening.new(
+        start_time: DateTime.new+6725.years+3.months,
+        time_zone: 'Pacific/Honolulu', name:'Pacific/Honolulu',
+        updated_at: DateTime.new+6725.years,
+        created_at: DateTime.new+6725.years
+      )
+
+    Time.zone = 'UTC'
   }
+
   context 'class method' do
-    describe "datetime_attributes" do
-      it "returns an array of all datetime objects for the class" do
-        expect(Happening._datetime_attributes).to eq [:start_time, :created_at, :updated_at]
-      end
-    end
     describe "has_time_zone" do
       it "does not have instance methods until called" do
         expect(Happening.instance_methods.include? :local_start_time).to eq false
@@ -34,12 +45,8 @@ describe Happening do
       end
     end
   end
-  context 'static instance methods' do
-
-    describe "self.included(base)" do
-      pending "How do you test this? I suppose if the dynamic tests exist this worked. Seems shoddy."
-    end
 
+  context 'static instance methods' do
     describe "current_time" do
       it "returns a time with zone object reflecting the current local time of the instance" do
         Timecop.freeze
@@ -47,39 +54,8 @@ describe Happening do
         Timecop.return
       end
     end
-
-    describe "_to_local(time)" do
-      it "returns a time with zone that has been coverted to reflect the local time" do
-        expect(@happening1.start_time).to eq 'Mon, 01 Apr 2013 00:01:00 UTC +00:00'
-        expect(@happening1._to_local(@happening1.start_time)).to eq 'Sun, 31 Mar 2013 20:01:00 EDT -04:00'
-        expect(@happening1._to_local(@happening1.start_time).to_s).to eq "2013-03-31 20:01:00 -0400"
-      end
-    end
-
-    describe "_add_zone(time_string)" do
-      it "returns a time with zone object that reflects the time value passed in time_string with time zone information of instance appended" do
-        expect(@happening1._add_zone("2013-08-19 12:34:56")).to eq 'Mon, 19 Aug 2013 12:34:56 EDT -04:00'
-        expect(@happening2._add_zone("2013-08-19 12:34:56")).to eq 'Mon, 19 Aug 2013 12:34:56 HST -10:00'
-        expect(@happening1._add_zone("2013-11-11 12:34:56")).to eq 'Mon, 11 Nov 2013 12:34:56 EST -05:00'
-        expect(@happening2._add_zone("2013-11-11 12:34:56")).to eq 'Mon, 11 Nov 2013 12:34:56 HST -10:00'
-      end
-    end
-
-    describe "_change_zone(time)" do
-      it "returns a time with zone object that has had only it's time zone switched to local time of instance" do
-        Time.zone = 'Rangoon'
-        time = Time.zone.parse("Wed, 28 Aug 2015 15:16:16")
-        expect(time.to_s.split(' ')[2]).to eq ('+0630')
-        expect(time.to_s.split(' ')[2]).to_not eq ('-0400')
-        expect(@happening1._change_zone(time)).to_not eq time
-        expect(@happening1._change_zone(time).to_s.split(' ')[0]).to eq time.to_s.split(' ')[0]
-        expect(@happening1._change_zone(time).to_s.split(' ')[1]).to eq time.to_s.split(' ')[1]
-        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to_not eq time.to_s.split(' ')[2]
-        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to_not eq ('+0630')
-        expect(@happening1._change_zone(time).to_s.split(' ')[2]).to eq ('-0400')
-      end
-    end
   end
+
   context 'dynamic instance methods' do
     describe "local_start_time" do
       it "returns a time with zone object that reflects the value of start_time altered to the instance's time zone" do
@@ -185,7 +161,6 @@ describe Happening do
 
         @happening1.local_created_at = "2013-11-11 12:34:56"
         expect(@happening1.created_at).to eq Time.parse("2013-11-11 12:34:56 -0500")
-
       end
     end
   end
@@ -195,6 +170,7 @@ describe Event do
   before do
     @event1 = Event.find_by_name('Eastern Time (US & Canada)')
   end
+
   context "Event should have time_jawn methods even though it has a non_conventional attribute" do
     subject { @event1 }
 
@@ -205,9 +181,6 @@ describe Event do
     it { should respond_to :local_created_at= }
     it { should 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
 
@@ -234,9 +207,6 @@ describe Occurrence do
     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
 
@@ -263,8 +233,5 @@ describe Occasion do
     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,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: time_jawn
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Mark Platt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: TimeJawn makes class instances time zone aware. It doesn't care one iota
@@ -102,17 +102,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: TimeJawn makes time zone aware class instances.