rfc-3339-attributes 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Fingertips, Manfred Stienstra <manfred@fngtps.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,9 @@
+=== RFC-3339-Attributes
+
+A simple Rails plugin which adds an rfc_3339_attributes and a validates_rf_3339_format_of method
+to ActiveRecord::Base. This makes it possible to validate DateTime columns.
+
+  class Member < ActiveRecord::Base
+    rfc_3339_attributes :measured_at
+    validates_rf_3339_format_of :measured_at
+  end

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "rfc-3339-attributes"
+    s.summary = s.description = "A tiny Rails plugin to allow validation on RFC-3339 datetime attributes."
+    s.homepage = "http://fingertips.github.com"
+    s.email = "manfred@fngtps.com"
+    s.authors = ["Manfred Stienstra"]
+  end
+rescue LoadError
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/active_record/rfc_3339_attributes.rb

@@ -0,0 +1,42 @@
+module ActiveRecord
+  module RFC3339Attributes
+    RFC_3339_REGEXP = /^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(\.\d*)?(Z|(([+-]\d\d):\d\d))$/
+    
+    def rfc_3339_attributes(*attr_names)
+      attr_names.each do |attr_name|
+        define_method "#{attr_name}=" do |time|
+          @attributes_cache.delete(attr_name.to_s)
+          instance_variable_set("@#{attr_name}_before_type_cast", time)
+          
+          if time.respond_to?(:in_time_zone)
+            time = time.in_time_zone
+          elsif parsed_time = Time.zone.parse(time.to_s)
+            time = parsed_time.in_time_zone
+          end
+          
+          @attributes[attr_name.to_s] = time
+        end
+      end
+    end
+    
+    def validates_rf_3339_format_of(*attr_names)
+      configuration = {
+        :on => :save,
+        :with => RFC_3339_REGEXP,
+        :message => "should be a valid RFC 3339 timestamp"
+      }.update(attr_names.extract_options!)
+      
+      send(validation_method(configuration[:on] || :save), configuration) do |record|
+        attr_names.each do |attr_name|
+          value_before_type_cast = record.send(:instance_variable_get, "@#{attr_name}_before_type_cast")
+          next if value_before_type_cast.acts_like?(:time)
+          if value_before_type_cast.blank? and !configuration[:allow_blank]
+            record.errors.add(attr_name, :invalid, :default => "can't be blank", :value => value_before_type_cast)
+          elsif value_before_type_cast.to_s !~ configuration[:with]
+            record.errors.add(attr_name, :invalid, :default => configuration[:message], :value => value_before_type_cast)
+          end
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'active_record/rfc_3339_attributes'
+ActiveRecord::Base.send(:extend, ActiveRecord::RFC3339Attributes)

data/test/rfc_3339_attributes_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class Member < ActiveRecord::Base
+  rfc_3339_attributes :measured_at
+  
+  validates_rf_3339_format_of :measured_at
+end
+
+class RFC3339AttributesValidationTest < ActiveSupport::TestCase
+  def setup
+    RFC3339AttributesTest::Initializer.setup_database
+    @member = Member.new
+  end
+  
+  def teardown
+    RFC3339AttributesTest::Initializer.teardown_database
+  end
+  
+  test "accepts valid timestamps" do
+    %w{
+      2010-03-21T21:20:56+01:00
+    }.each do |timestamp|
+      assert_valid_timestamp(timestamp)
+    end
+  end
+  
+  test "rejects invalid timestamps" do
+    %w{
+      invalid
+    }.each do |timestamp|
+      assert_invalid_timestamp(timestamp)
+    end
+  end
+  
+  private
+  
+  def assert_valid_timestamp(timestamp)
+    @member.measured_at = timestamp
+    @member.valid?
+    assert @member.errors.on(:measured_at).blank?, "Expected `#{timestamp}' to be valid"
+  end
+  
+  def assert_invalid_timestamp(timestamp)
+    @member.measured_at = timestamp
+    @member.valid?
+    assert !@member.errors.on(:measured_at).blank?, "Expected `#{timestamp}' to be invalid"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+module RFC3339AttributesTest
+  module Initializer
+    VENDOR_RAILS = File.expand_path('../../../../../vendor/rails', __FILE__)
+    OTHER_RAILS = File.expand_path('../../../rails', __FILE__)
+    PLUGIN_ROOT = File.expand_path('../../', __FILE__)
+    
+    def self.rails_directory
+      if File.exist?(VENDOR_RAILS)
+        VENDOR_RAILS
+      elsif File.exist?(OTHER_RAILS)
+        OTHER_RAILS
+      end
+    end
+    
+    def self.load_dependencies
+      if rails_directory
+        $:.unshift(File.join(rails_directory, 'activesupport', 'lib'))
+        $:.unshift(File.join(rails_directory, 'activerecord', 'lib'))
+      else
+        require 'rubygems' rescue LoadError
+      end
+      
+      require 'test/unit'
+      
+      require 'active_support/all'
+      require 'active_support/core_ext'
+      require 'active_support/test_case'
+      require 'active_record'
+      require 'active_record/test_case'
+      require 'active_record/base' # this is needed because of dependency hell
+      
+      $:.unshift File.expand_path('../../lib', __FILE__)
+      require File.join(PLUGIN_ROOT, 'rails', 'init')
+    end
+    
+    def self.configure_database
+      Time.zone = 'UTC'
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+      ActiveRecord::Migration.verbose = false
+    end
+    
+    def self.setup_database
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :members do |t|
+          t.column :measured_at, :datetime
+        end
+      end
+    end
+    
+    def self.teardown_database
+      ActiveRecord::Base.connection.tables.each do |table|
+        ActiveRecord::Base.connection.drop_table(table)
+      end
+    end
+    
+    def self.start
+      load_dependencies
+      configure_database
+    end
+  end
+end
+
+RFC3339AttributesTest::Initializer.start

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rfc-3339-attributes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A tiny Rails plugin to allow validation on RFC-3339 datetime attributes.
+email: manfred@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/active_record/rfc_3339_attributes.rb
+- rails/init.rb
+- test/rfc_3339_attributes_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://fingertips.github.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A tiny Rails plugin to allow validation on RFC-3339 datetime attributes.
+test_files: 
+- test/rfc_3339_attributes_test.rb
+- test/test_helper.rb