locale_dating 0.1.0 → 0.1.1

data/README.md

@@ -13,6 +13,7 @@ changed the default date parsing format from mm/dd/yyyy to dd/mm/yyyy. When lett
 on a form as text, Rails could no longer correctly parse a US date by default.
 
 Common solutions seem to result in:
+
 * explicitly converting the date to text and assigning to the form input
 * parsing the form's param in the controller action and assigning to the model
 
@@ -22,57 +23,66 @@ While solving this problem, we get some other nice benefits. More on that after
 
 Use the defined I18n locale formats from your application.
 
-    # /config/locales/en.yml
-    en:
-      date:
-        formats:
-          default: '%m/%d/%Y'
-          short: '%m/%d/%Y'
-          long: ! '%Y-%m-%d'
-          ymd: ! '%Y-%m-%d'
-      datetime:
-        formats:
-          default: '%m/%d/%Y'
-          short: '%m/%d/%Y'
-          long: ! '%m/%d/%Y %I:%M%p'
-      time:
-        am: am
-        formats:
-          default: ! '%m/%d/%Y %I:%M%p'
-          short: ! '%I:%M%p'
-          long: ! '%m/%d/%Y %I:%M%p'
-        pm: pm
+```yaml
+# /config/locales/en.yml
+en:
+  date:
+    formats:
+      default: '%m/%d/%Y'
+      short: '%m/%d/%Y'
+      long: ! '%Y-%m-%d'
+      ymd: ! '%Y-%m-%d'
+  datetime:
+    formats:
+      default: '%m/%d/%Y'
+      short: '%m/%d/%Y'
+      long: ! '%m/%d/%Y %I:%M%p'
+  time:
+    am: am
+    formats:
+      default: ! '%m/%d/%Y %I:%M%p'
+      short: ! '%I:%M%p'
+      long: ! '%m/%d/%Y %I:%M%p'
+    pm: pm
+```
 
 Specify which model attributes should be
 
-    # /app/models/person.rb
-    class Person < ActiveRecord::Base
-      locale_date :born_on
-      locale_datetime :last_seen_at
-      locale_time :start_time
-    end
+```ruby
+# /app/models/person.rb
+class Person < ActiveRecord::Base
+  locale_date :born_on
+  locale_datetime :last_seen_at
+  locale_time :start_time
+end
+```
 
 ## Behavior and Benefits
 
 LocaleDating doesn't override the model's attribute. So you can still access the native data type directly as needed.
 
-    p = Person.new
-    p.born_on = Date.new(2010, 10, 4)
+```ruby
+p = Person.new
+p.born_on = Date.new(2010, 10, 4)
+```
 
 LocaleDating creates wrapper methods for accessing the underlying value as text through your desired locale format.
 It uses locale's 'default' format if no format is specified.
 
 Because the attribute isn't overridden, you can specify multiple supported formats for a single attribute.
 
-    # /app/models/person.rb
-    class Person < ActiveRecord::Base
-      locale_datetime :last_seen_at
-      locale_datetime :last_seen_at, :format => :long
-      locale_datetime :last_seen_at, :format => :short, :ending => :shortened
-      locale_datetime :last_seen_at, :format => :special, :name => :last_seen_so_special
-    end
+```ruby
+# /app/models/person.rb
+class Person < ActiveRecord::Base
+  locale_datetime :last_seen_at
+  locale_datetime :last_seen_at, :format => :long
+  locale_datetime :last_seen_at, :format => :short, :ending => :shortened
+  locale_datetime :last_seen_at, :format => :special, :name => :last_seen_so_special
+end
+```
 
 Generated wrapper methods:
+
 * when using the default format on :last_seen_at, it will be 'last_seen_at_as_text'
 * when using the format :long on :last_seen_at, it will be 'last_seen_at_as_long'
 * when specifying the ending 'shortened', it will be 'last_seen_at_shortened'
@@ -80,10 +90,12 @@ Generated wrapper methods:
 
 In a view, you specify which version you want used by referencing the name like this:
 
-    <%= form_for @person do %>
-       <%= f.label :born_on_as_text, 'Born On' %>:
-       <%= f.text_field :born_on_as_text %><br />
-    <% end %>
+```erb
+<%= form_for @person do %>
+  <%= f.label :born_on_as_text, 'Born On' %>:
+  <%= f.text_field :born_on_as_text %><br />
+<% end %>
+```
 
 The input's value is the :born_on value converted to text using the locale specified format. The controller receives
 the user's modified text and passes it to the wrapper method. The wrapper method parses the text using the format

data/lib/locale_dating.rb

@@ -1,4 +1,7 @@
 module LocaleDating
+  # Exception used to prevent wrapper methods from unintentionally overwriting an existing method.
+  class MethodOverwriteError < RuntimeError; end
+
   # Respond to being included and extend the object with class methods.
   def self.included(base)
     base.extend ClassMethods
@@ -33,34 +36,29 @@ module LocaleDating
     #
     def locale_date(*args)
       options = args.extract_options!
-      locale_dating_naming_option_defaults(options)
+      locale_dating_naming_checks(args, options)
 
       # Loop through all the given attributes that should be wrapped using the same settings.
       args.each do |attrib|
-        getter_name = options[:name].try(:to_sym)
-        getter_name ||= "#{attrib}_#{options[:ending]}".to_sym
-        setter_name = "#{getter_name}=".to_sym
+        getter_name, setter_name = locale_dating_wrapper_method_names(attrib, options)
         # Define the code to execute when the method is called
         # Create new methods for get and set calls with blocks for implementation.
         class_eval do
           # == Create the GET methods
-          # EX: def date_of_birth_text()
+          # EX: def birth_date_as_text()
           define_method getter_name do
             value = self.send(attrib)
             I18n.l(value, :format => options[:format]) if value
           end
           # == Create the SET methods
-          # EX: def date_of_birth_text=()
+          # EX: def birth_date_as_text=()
           define_method setter_name do |value|
-            date_value = nil
             date_value = DateTime.strptime(value.to_s, I18n.t("date.formats.#{options[:format]}")) unless value.blank?
             # Keep the date from the given value and preserve the original time part
             self.send("#{attrib}=", date_value)
           end
         end
       end
-
-      #include InstanceMethods
     end
 
     # Define how to split out a single date_time column/attribute into two attributes that can set the date and
@@ -88,26 +86,23 @@ module LocaleDating
     #
     def locale_time(*args)
       options = args.extract_options!
-      locale_dating_naming_option_defaults(options)
+      locale_dating_naming_checks(args, options)
 
       # Loop through all the given attributes that should be wrapped using the same settings.
       args.each do |attrib|
-        getter_name = options[:name].try(:to_sym)
-        getter_name ||= "#{attrib}_#{options[:ending]}".to_sym
-        setter_name = "#{getter_name}=".to_sym
+        getter_name, setter_name = locale_dating_wrapper_method_names(attrib, options)
         # Define the code to execute when the method is called
         # Create new methods for get and set calls with blocks for implementation.
         class_eval do
           # == Create the GET methods
-          # EX: def date_of_birth_text()
+          # EX: def start_time_as_text()
           define_method getter_name do
             value = self.send(attrib)
             I18n.l(value.in_time_zone, :format => options[:format]) if value
           end
           # == Create the SET methods
-          # EX: def date_of_birth_text=()
+          # EX: def start_time_as_text=()
           define_method setter_name do |value|
-            time_value = nil
             if !value.blank?
               time_value = DateTime.strptime(value.to_s, I18n.t("time.formats.#{options[:format]}"))
               time_value = Time.zone.local(time_value.year, time_value.month, time_value.day,
@@ -118,8 +113,6 @@ module LocaleDating
           end
         end
       end
-
-      #include InstanceMethods
     end
 
     # Define how to split out a single date_time column/attribute into two attributes that can set the date and
@@ -147,26 +140,23 @@ module LocaleDating
     #
     def locale_datetime(*args)
       options = args.extract_options!
-      locale_dating_naming_option_defaults(options)
+      locale_dating_naming_checks(args, options)
 
       # Loop through all the given attributes that should be wrapped using the same settings.
       args.each do |attrib|
-        getter_name = options[:name].try(:to_sym)
-        getter_name ||= "#{attrib}_#{options[:ending]}".to_sym
-        setter_name = "#{getter_name}=".to_sym
+        getter_name, setter_name = locale_dating_wrapper_method_names(attrib, options)
         # Define the code to execute when the method is called
         # Create new methods for get and set calls with blocks for implementation.
         class_eval do
           # == Create the GET methods
-          # EX: def date_of_birth_text()
+          # EX: def completed_at_as_text()
           define_method getter_name do
             value = self.send(attrib)
             I18n.l(value.in_time_zone, :format => options[:format]) if value
           end
           # == Create the SET methods
-          # EX: def date_of_birth_text=()
+          # EX: def completed_at_as_text=()
           define_method setter_name do |value|
-            date_value = nil
             if !value.blank?
               date_value = DateTime.strptime(value.to_s, I18n.t("datetime.formats.#{options[:format]}"))
               date_value = Time.zone.local(date_value.year, date_value.month, date_value.day,
@@ -183,10 +173,27 @@ module LocaleDating
 
     private
     # Given the options for a locale_dating call, set the defaults for the naming convention to use.
-    def locale_dating_naming_option_defaults(options)
+    def locale_dating_naming_checks(args, options)
       options.reverse_merge!(:format => :default)
       options[:ending] ||= "as_#{options[:format]}".to_sym unless options[:format] == :default
       options[:ending] ||= :as_text
+      # error if multiple args used with :name option
+      raise MethodOverwriteError, "multiple attributes cannot be wrapped with an explicitly named method" if args.length > 1 && options.key?(:name)
+    end
+
+    # Return the getter and setter wrapper method names. Result is an array of [getter_name, setter_name].
+    # An exception is raised if the class already has a method with either name.
+    def locale_dating_wrapper_method_names(attr_name, options)
+      getter_name = options[:name].try(:to_sym)
+      getter_name ||= "#{attr_name}_#{options[:ending]}".to_sym
+      setter_name = "#{getter_name}=".to_sym
+      # Detect if the names overwrite existing methods on the generated instance and prevent it. (presumed to be unintentional)
+      class_eval do
+        raise MethodOverwriteError, "locale_dating setting would overwrite method '#{getter_name}' for attribute '#{attr_name}'" if self.respond_to?(getter_name)
+        raise MethodOverwriteError, "locale_dating setting would overwrite method '#{setter_name}' for attribute '#{attr_name}'" if self.respond_to?(setter_name)
+      end
+      # Return the values
+      [getter_name, setter_name]
     end
   end
 end

data/lib/locale_dating/version.rb

@@ -1,3 +1,3 @@
 module LocaleDating
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/dummy/test/unit/person_test.rb

@@ -114,6 +114,16 @@ class PersonTest < ActiveSupport::TestCase
     assert_equal nil, p.last_seen_at_as_text
   end
 
+  test "support assigning a nil value" do
+    p = Person.new(:born_on => Date.today, :start_time => Time.zone.now, :last_seen_at => DateTime.now)
+    p.born_on_as_text = nil
+    p.start_time_as_text = nil
+    p.last_seen_at_as_text = nil
+    assert_equal nil, p.born_on
+    assert_equal nil, p.start_time
+    assert_equal nil, p.last_seen_at
+  end
+
   #
   # Custom Date behavior
   #
@@ -253,4 +263,44 @@ class PersonTest < ActiveSupport::TestCase
                  p.start_time.to_time        # underlying UTC value
   end
 
+  #
+  # Set multiple attributes on one line
+  #
+  test "multiple attributes set at once" do
+    class MultipleDefaultAttributesSet
+      include LocaleDating
+      attr_accessor :some_date_1, :some_date_2
+      locale_date :some_date_1, :some_date_2
+    end
+    i = MultipleDefaultAttributesSet.new
+    assert i.respond_to?(:some_date_1_as_text)
+    assert i.respond_to?(:some_date_1_as_text=)
+    assert i.respond_to?(:some_date_2_as_text)
+    assert i.respond_to?(:some_date_2_as_text=)
+  end
+
+  test "multiple attributes cannot use :name" do
+    #TODO: Validate that an exception is raised. Raise exception for overwriting an existing method.
+    assert_raise LocaleDating::MethodOverwriteError do
+      class MultipleNamedAttributesSet
+        include LocaleDating
+        attr_accessor :some_datetime_1, :some_datetime_2
+        locale_datetime :some_datetime_1, :some_datetime_2, :name => :some_explicit_function_name
+      end
+    end
+  end
+
+  #
+  # Prevent unintentional method overwrites
+  #
+  test "exception when overwriting existing method" do
+    assert_raise LocaleDating::MethodOverwriteError do
+      class ExistingMethodFound
+        include LocaleDating
+        attr_accessor :some_time_1
+        def name(); 'howdy' end
+        locale_time :some_time_1, :name => :name
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: locale_dating
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mark Ericksen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-16 00:00:00 -06:00
+date: 2012-03-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,6 @@ extra_rdoc_files: []
 files: 
 - lib/locale_dating.rb
 - lib/locale_dating/version.rb
-- lib/tasks/locale_dating_tasks.rake
 - LICENSE
 - Rakefile
 - README.md

data/lib/tasks/locale_dating_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :locale_dating do
-#   # Task goes here
-# end