format_for_extensions 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,18 +1,18 @@
-= format_for
+= format_for_extensions
 
-Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for to dynamically define reusable formats for any field you want.
+Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for_extensions to dynamically define reusable formats for any field you want.
 
-By default, format_for comes with smart formats for email addresses and postal codes.  Even better, no code repetition!  Use constructs that make sense such as "validates_email_for :account_owner" and "validates_postal_code_for :address_postal_code".
+By default, format_for_extensions comes with smart formats for email addresses and postal codes.  Even better, no code repetition!  Use constructs that make sense such as "validates_email_for :account_owner" and "validates_postal_code_for :address_postal_code".
 
 
 == System Requirements
-format_for should work with Rails 2.3.5 and above.  However, I have not yet tested this with Rails 3.1. 
+format_for_extensions should work with Rails 2.3.5 and above.  However, I have not yet tested this with Rails 3.1. 
 
 
 == Installation
-Modify your Gemfile to include format_for:
+Modify your Gemfile to include format_for_extensions:
   
-  gem 'format_for'
+  gem 'format_for_extensions'
 
 Run `bundle install`.  You thought it would be harder?
 
@@ -30,11 +30,11 @@ By default, ArValidationExtensions supports email and postal code formats.  Thes
 
 === Configuration
 
-Default configurations are specified in the gem's config/ar_validation_extensions.yml file.  If you wish to modify the default regular expressions or messages reported when validation fails, simply copy this file to the config directory in your Rails root folder.  You can also manually create [rails_root]/config/ar_validation_extensions.yml if you'd like to.
+Default configurations are specified in the gem's config/format_for_extensions.yml file.  If you wish to modify the default regular expressions or messages reported when validation fails, simply copy this file to the config directory in your Rails root folder.  You can also manually create [rails_root]/config/format_for_extensions.yml if you'd like to.
 
 The format of this file is as follows:
 
-  # ar_validation_extensions.yml
+  # format_for_extensions.yml
   en:
     email:
       regex: /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/
@@ -46,9 +46,9 @@ If you modify this file, you will need to bounce your application server (or res
 
 
 === The Hotness
-You can dynamically create your own format validators!  For instance, add this to your [rails_root]/config/ar_validation_extensions.yml file:
+You can dynamically create your own format validators!  For instance, add this to your [rails_root]/config/format_for_extensions.yml file:
 
-  # ar_validation_extensions.yml
+  # format_for_extensions.yml
   en:
     hotness:
       regex: /^hot/
@@ -69,7 +69,7 @@ As you might have guessed, the gem is driven off of the configuration file.  The
 - Support some other highly repetitious fields, such as phone number.
 
 
-== Contributing to format_for
+== Contributing to format_for_extensions
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/config/format_for_extensions.yml

@@ -1,9 +1,9 @@
 # Default validation configurations...
 en:
   postal_code:
-    regex: /^[0-9]{5}(-[0-9]{4})?|[ABCEGHJKLMNPRSTVXY]\d[A-Z] *\d[A-Z]\d?$/
+    regexp: "^[0-9]{5}(-[0-9]{4})?|[ABCEGHJKLMNPRSTVXY]\d[A-Z] *\d[A-Z]\d?$"
     message: "is invalid.  Valid formats: 94105-0011 or 94105 or T2X 1V4 or T2X1V4"
 
   email:
-    regex: /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/
+    regexp: "^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$"
     message: "is invalid.  The address should be in a format similar to 'user@example.com'."

data/format_for_extensions.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{format_for_extensions}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karle Durante"]
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "format_for_extensions.gemspec",
     "lib/format_for_extensions.rb",
     "lib/format_for_extensions/config.rb",
+    "pkg/format_for_extensions-0.1.0.gem",
     "test/helper.rb",
     "test/lib/format_for_extensions/test_config.rb",
     "test/models/abstract_model.rb",

data/lib/format_for_extensions/config.rb

@@ -19,6 +19,16 @@ module FormatForExtensions
       end
       
       @@config[locale]
-    end      
+    end
+    
+    # Returns the configured fields
+    def self.fields
+      values.keys
+    end
+    
+    # returns the configured properties (of the first field)
+    def self.properties
+      values[fields.first].keys
+    end
   end
 end

data/lib/format_for_extensions.rb

@@ -11,7 +11,8 @@ module FormatForExtensions
         require 'format_for_extensions/config'
         
         begin
-          FIELDS = FormatForExtensions::Config.values.keys
+          FIELDS = FormatForExtensions::Config.fields
+          PROPERTIES = FormatForExtensions::Config.properties
         rescue Exception => e
           puts "Exception loading config: #{e.inspect}"
           raise(RuntimeError, "Your format_for_extensions.yml file seems to be invalid, perhaps you've mis-keyed something?")
@@ -19,11 +20,11 @@ module FormatForExtensions
         
         FIELDS.each do |field|
           define_method("validates_#{field}_for") do |*attr_names|
-            configuration = {:with => self.send("#{field}_regex"),
+            configuration = {:with => self.send("#{field}_regexp"),
                              :message => self.send("#{field}_message")
                             }
                             
-            # Add in user supplied options (yes, users can still override the regex and 
+            # Add in user supplied options (yes, users can still override the regexp and 
             # message with custom options)
             configuration.update(attr_names.extract_options!)
 
@@ -33,22 +34,19 @@ module FormatForExtensions
         end
 
         # Compose accessor methods for each of the specified field types
-        # e.g. postal_code_regex, postal_code_message, etc...
-        ['postal_code', 'email'].each do |field|
-          define_method("#{field}_regex".to_sym) do
-            regex = FormatForExtensions::Config.values[field]['regex']
-            raise(ArgumentError, "Your format_for_extensions.yml is missing the mapping '#{field}: regex:'") if regex.blank?
-            
-            return eval(regex)
-          end
-
-          define_method("#{field}_message".to_sym) do
-            message = FormatForExtensions::Config.values[field]['message']
-            raise(ArgumentError, "Your format_for_extensions.yml is missing the mapping '#{field}: message:'") if message.blank?
+        # e.g. postal_code_regexp, postal_code_message, etc...
+        FIELDS.each do |field|
+          PROPERTIES.each do |property|
+            define_method("#{field}_#{property}".to_sym) do
+              value = FormatForExtensions::Config.values[field][property]
+              
+              raise(ArgumentError, "Your format_for_extensions.yml is missing the mapping '#{property}' for '#{field}'") if value.blank?
             
-            return message
+              return property == 'regexp' ? Regexp.new(value) : value
+            end
           end
         end
+        
       end
     end
   end

data/test/lib/format_for_extensions/test_config.rb

@@ -2,11 +2,31 @@ require 'helper'
 require 'format_for_extensions/config'
 
 class TestConfig < Test::Unit::TestCase
-  should "load the default yml file if an override has not been specified" do
-    config = FormatForExtensions::Config.values
+  context "When loading the default yml file" do
+    context "and inspecting field values" do
+      setup {@config = FormatForExtensions::Config.values}
+      should "return the postal code message" do
+        assert_equal "is invalid.  Valid formats: 94105-0011 or 94105 or T2X 1V4 or T2X1V4", @config['postal_code']['message']
+      end
+      
+      should "return the email message" do
+        assert_equal "is invalid.  The address should be in a format similar to 'user@example.com'.", @config['email']['message']
+      end
+    end
     
-    assert_equal "is invalid.  Valid formats: 94105-0011 or 94105 or T2X 1V4 or T2X1V4", config['postal_code']['message']
-    assert_equal "is invalid.  The address should be in a format similar to 'user@example.com'.", config['email']['message']
+    should "return the configured fields" do
+      fields = FormatForExtensions::Config.fields
+      ['postal_code', 'email'].each do |field|
+        assert fields.include?(field)
+      end
+    end
+    
+    should "return the configured properties" do
+      properties = FormatForExtensions::Config.properties
+      ['regexp', 'message'].each do |property|
+        assert properties.include?(property)
+      end
+    end
   end
   
 end

data/test/test_format_for_extensions.rb

@@ -14,7 +14,7 @@ class TestFormatForExtensions < Test::Unit::TestCase
   
       should "define data accessor methods for each configured field" do
         @fields.each do |field|
-          assert ActiveRecord::Base.respond_to?("#{field}_regex")
+          assert ActiveRecord::Base.respond_to?("#{field}_regexp")
           assert ActiveRecord::Base.respond_to?("#{field}_message")
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: format_for_extensions
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Karle Durante
@@ -130,6 +130,7 @@ files:
 - format_for_extensions.gemspec
 - lib/format_for_extensions.rb
 - lib/format_for_extensions/config.rb
+- pkg/format_for_extensions-0.1.0.gem
 - test/helper.rb
 - test/lib/format_for_extensions/test_config.rb
 - test/models/abstract_model.rb