dm-devise 0.1.0

data/dm-devise.gemspec

@@ -0,0 +1,105 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-devise}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jared Morgan"]
+  s.date = %q{2010-07-06}
+  s.description = %q{dm-devise adds DataMapper support to devise (http://github.com/plataformatec/devise) for authentication support for Rails}
+  s.email = %q{jmorgan@morgancreative.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "dm-devise.gemspec",
+     "lib/devise/orm/data_mapper.rb",
+     "lib/devise/orm/data_mapper/compatibility.rb",
+     "lib/devise/orm/data_mapper/date_time.rb",
+     "lib/devise/orm/data_mapper/dm-validations.rb",
+     "lib/devise/orm/data_mapper/schema.rb",
+     "lib/devise/orm/data_mapper_active_model.rb",
+     "lib/dm-devise/version.rb",
+     "lib/generators/data_mapper/devise_generator.rb",
+     "test/orm/data_mapper.rb",
+     "test/orm/data_mapper_active_model.rb",
+     "test/overrides/data_mapper_test.rb",
+     "test/overrides/dm_validations_test.rb",
+     "test/rails_app/app/data_mapper/admin.rb",
+     "test/rails_app/app/data_mapper/shim.rb",
+     "test/rails_app/app/data_mapper/user.rb",
+     "test/rails_app/app/data_mapper_active_model/admin.rb",
+     "test/rails_app/app/data_mapper_active_model/shim.rb",
+     "test/rails_app/app/data_mapper_active_model/user.rb",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/config/environment.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jm81/dm-devise}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Support for using DataMapper ORM with devise}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/app/data_mapper/admin.rb",
+     "test/rails_app/app/data_mapper/shim.rb",
+     "test/rails_app/app/data_mapper/user.rb",
+     "test/rails_app/app/data_mapper_active_model/admin.rb",
+     "test/rails_app/app/data_mapper_active_model/shim.rb",
+     "test/rails_app/app/data_mapper_active_model/user.rb",
+     "test/overrides/data_mapper_test.rb",
+     "test/overrides/dm_validations_test.rb",
+     "test/orm/data_mapper.rb",
+     "test/orm/data_mapper_active_model.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<dm-migrations>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<dm-validations>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<dm-serializer>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<dm-timestamps>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<dm-rails>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<warden>, ["~> 0.10.7"])
+      s.add_runtime_dependency(%q<bcrypt-ruby>, ["~> 2.1.2"])
+    else
+      s.add_dependency(%q<dm-core>, ["~> 1.0.0"])
+      s.add_dependency(%q<dm-migrations>, ["~> 1.0.0"])
+      s.add_dependency(%q<dm-validations>, ["~> 1.0.0"])
+      s.add_dependency(%q<dm-serializer>, ["~> 1.0.0"])
+      s.add_dependency(%q<dm-timestamps>, ["~> 1.0.0"])
+      s.add_dependency(%q<dm-rails>, ["~> 1.0.0"])
+      s.add_dependency(%q<warden>, ["~> 0.10.7"])
+      s.add_dependency(%q<bcrypt-ruby>, ["~> 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["~> 1.0.0"])
+    s.add_dependency(%q<dm-migrations>, ["~> 1.0.0"])
+    s.add_dependency(%q<dm-validations>, ["~> 1.0.0"])
+    s.add_dependency(%q<dm-serializer>, ["~> 1.0.0"])
+    s.add_dependency(%q<dm-timestamps>, ["~> 1.0.0"])
+    s.add_dependency(%q<dm-rails>, ["~> 1.0.0"])
+    s.add_dependency(%q<warden>, ["~> 0.10.7"])
+    s.add_dependency(%q<bcrypt-ruby>, ["~> 2.1.2"])
+  end
+end
+

data/lib/devise/orm/data_mapper.rb

@@ -0,0 +1,23 @@
+require 'devise/orm/data_mapper/compatibility'
+require 'devise/orm/data_mapper/schema'
+require 'devise/orm/data_mapper/date_time'
+require 'devise/orm/data_mapper/dm-validations'
+
+module Devise
+  module Orm
+    module DataMapper
+      module Hook
+        def devise_modules_hook!
+          extend Schema
+          include Compatibility
+          yield
+          return unless Devise.apply_schema
+          devise_modules.each { |m| send(m) if respond_to?(m, true) }
+        end
+      end
+    end
+  end
+end
+
+DataMapper::Model.append_extensions(Devise::Models)
+DataMapper::Model.append_extensions(Devise::Orm::DataMapper::Hook)

data/lib/devise/orm/data_mapper/compatibility.rb

@@ -0,0 +1,69 @@
+module Devise
+  module Orm
+    module DataMapper
+      module Compatibility
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          # Hooks for confirmable
+          def before_create(*args)
+            wrap_hook(:before, :create, *args)
+          end
+
+          def after_create(*args)
+            wrap_hook(:after, :create, *args)
+          end
+
+          def before_save(*args)
+            wrap_hook(:before, :save, *args)
+          end
+
+          def wrap_hook(action, method, *args)
+            options = args.extract_options!
+
+            args.each do |callback|
+              callback_method = :"#{callback}_callback_wrap"
+              send action, method, callback_method
+              class_eval <<-METHOD, __FILE__, __LINE__ + 1
+                def #{callback_method}
+                  #{callback} if #{options[:if] || true}
+                end
+              METHOD
+            end
+          end
+
+          # Add ActiveRecord like finder
+          def find(*args)
+            case args.first
+            when :first, :all
+              send(args.shift, *args)
+            else
+              get(*args)
+            end
+          end
+        end
+
+        def changed?
+          dirty?
+        end
+
+        def save(options=nil)
+          if options.is_a?(Hash) && options[:validate] == false
+            save!
+          else
+            # valid? checking isn't added automatically with ActiveModel
+            valid? && super()
+          end
+        end
+
+        def update_attributes(*args)
+          update(*args)
+        end
+
+        def invalid?
+          !valid?
+        end
+      end
+    end
+  end
+end

data/lib/devise/orm/data_mapper/date_time.rb

@@ -0,0 +1,6 @@
+# Add DateTime#gmtime method if needed.
+class DateTime
+  unless method_defined?(:gmtime)
+    delegate :gmtime, :to => :to_time
+  end
+end

data/lib/devise/orm/data_mapper/dm-validations.rb

@@ -0,0 +1,55 @@
+module DataMapper
+  module Validate
+
+    # Monkey-patch ValidationErrors to support generation of error message from
+    # a Symbol. This does not translate, consistent with normal DataMapper
+    # operation. Set DataMapper::Validate::ValidationErrors.default_error_messages
+    # if alternate messages are needed (after devise has been initialized).
+    class ValidationErrors
+      alias_method :original_add, :add
+
+      # If the message is a Symbol, allow +default_error_message+ to generate
+      # the message, including translation.
+      def add(field_name, message)
+        if message.kind_of?(Symbol)
+          message = self.class.default_error_message(message, field_name)
+        end
+        original_add(field_name, message) unless errors[field_name].include?(message)
+      end
+    end
+  end
+end
+
+# Default error messages consistent with ActiveModel messages and devise
+# expectations.
+DataMapper::Validate::ValidationErrors.default_error_messages = {
+  :absent => '%s must be absent',
+  :inclusion => '%s is not included in the list',
+  :exclusion => '%s is reserved',
+  :invalid => '%s is invalid',
+  :confirmation => "%s doesn't match confirmation",
+  :accepted => '%s must be accepted',
+  :nil => '%s must not be nil',
+  :empty => "%s can't be empty",
+  :blank => "%s can't be blank",
+  :length_between => '%s must be between %s and %s characters long',
+  :too_long => '%s is too long (maximum is %s characters)',
+  :too_short => '%s is too short (minimum is %s characters)',
+  :wrong_length => '%s "is the wrong length (should be %s characters)"',
+  :taken => '%s has already been taken',
+  :not_a_number => '%s is not a number',
+  :not_an_integer => '%s must be an integer',
+  :greater_than => '%s must be greater than %s',
+  :greater_than_or_equal_to => '%s must be greater than or equal to %s',
+  :equal_to => '%s must be equal to %s',
+  :not_equal_to => '%s must not be equal to %s',
+  :less_than => '%s must be less than %s',
+  :less_than_or_equal_to => '%s must be less than or equal to %s',
+  :value_between => '%s must be between %s and %s',
+  :odd => 'must be odd',
+  :even => 'must be even',
+  :primitive => '%s must be of type %s',
+  :not_found => '%s not found',
+  :already_confirmed => '%s was already confirmed',
+  :not_locked => '%s was not locked'
+}

data/lib/devise/orm/data_mapper/schema.rb

@@ -0,0 +1,31 @@
+module Devise
+  module Orm
+    module DataMapper
+      module Schema
+        include Devise::Schema
+
+        SCHEMA_OPTIONS = {
+          :null  => :required,
+          :limit => :length
+        }
+
+        # Tell how to apply schema methods. This automatically maps :limit to
+        # :length and :null to :required.
+        def apply_devise_schema(name, type, options={})
+          SCHEMA_OPTIONS.each do |old_key, new_key|
+            next unless options.key?(old_key)
+            if :null == old_key
+              # :required is opposite of :null
+              options[new_key] = !options.delete(old_key)
+            else
+              options[new_key] = options.delete(old_key)
+            end
+          end
+
+          options.delete(:default) if options[:default].nil?
+          property name, type, options
+        end
+      end
+    end
+  end
+end

data/lib/devise/orm/data_mapper_active_model.rb

@@ -0,0 +1,41 @@
+require 'devise/orm/data_mapper/compatibility'
+require 'devise/orm/data_mapper/schema'
+require 'devise/orm/data_mapper/date_time'
+
+module Devise
+  module Orm
+    module DataMapper
+      module Hook
+        def devise_modules_hook!
+          extend Schema
+          include Compatibility
+          include ActiveModel::Validations
+          class << self; attr_reader :descendants; end;
+
+          def self.validates_uniqueness_of(*fields)
+            validates_with UniquenessValidator, _merge_attributes(fields)
+          end
+          
+          yield
+          return unless Devise.apply_schema
+          devise_modules.each { |m| send(m) if respond_to?(m, true) }
+        end
+      end
+
+      class UniquenessValidator < ActiveModel::EachValidator
+        def validate_each(target, attribute, value)
+          resource = ::DataMapper.repository(target.repository.name) { target.model.first(attribute => value) }
+          if resource.nil? || (target.saved? && resource.key == target.key)
+            return true
+          else
+            target.errors.add(attribute, :taken)
+            return false
+          end
+        end
+      end
+    end
+  end
+end
+
+DataMapper::Model.append_extensions(Devise::Models)
+DataMapper::Model.append_extensions(Devise::Orm::DataMapper::Hook)

data/lib/dm-devise/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Devise
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/generators/data_mapper/devise_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/devise/orm_helpers'
+
+module DataMapper
+  module Generators
+    class DeviseGenerator < Rails::Generators::NamedBase
+      include Devise::Generators::OrmHelpers
+
+      def generate_model
+        invoke "data_mapper:model", [name] unless model_exists?
+      end
+
+      def inject_devise_content
+        inject_into_file model_path, model_contents, :after => "include DataMapper::Resource\n"
+      end
+    end
+  end
+end

data/test/orm/data_mapper.rb

@@ -0,0 +1,31 @@
+require 'rails/test_help'
+
+DataMapper.auto_migrate!
+
+class ActiveSupport::TestCase
+  setup do
+    User.all.destroy!
+    Admin.all.destroy!
+  end
+end
+
+module DataMapper
+  module Validate
+    class ValidationErrors
+
+      # ActiveModel prepends field names in +#full_messages+, and so the
+      # expected result of calling errors[field_name] will not include the
+      # field name in the message. However, DM expects the field name to be
+      # included in the original message. Assuming that the field name will
+      # begin the message, just strip it out (plus the following space) for
+      # testing purposes. This has no effect on #full_messages.
+      def [](property_name)
+        if property_errors = errors[property_name.to_sym]
+          property_errors.collect do |message|
+            message[(property_name.to_s.length + 1)..-1]
+          end
+        end
+      end
+    end
+  end
+end

data/test/orm/data_mapper_active_model.rb

@@ -0,0 +1,10 @@
+require 'rails/test_help'
+
+DataMapper.auto_migrate!
+
+class ActiveSupport::TestCase
+  setup do
+    User.all.destroy!
+    Admin.all.destroy!
+  end
+end

data/test/overrides/data_mapper_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+# This file contains test cases that override devise tests, in the cases that
+# the difference is values from DM versus those expected by devise is not
+# particularly important and getting DM to pass the original devise tests would
+# be difficult.
+#
+# This file contains tests shared by both data_mapper and
+# data_mapper_active_model ORM setups.
+# Tests specific to the data_mapper orm which uses dm-validations are in dm_validations_test.rb
+# Tests specific to the data_mapper_active_model orm which uses ActiveModel
+# validations would be in active_model_test.rb, but there aren't any (I would
+# be rather surprised if there ever were any).
+#
+# For each test, an explanation is given as to why I chose to override the test,
+# and the original assertion is commented above the DM-specific assertion.
+
+class TrackableHooksTest < ActionController::IntegrationTest
+
+  undef test_current_and_last_sign_in_timestamps_are_updated_on_each_sign_in
+
+  # DataMapper uses a DateTime type where ActiveRecord uses Time. The test is
+  # that the tested properties are being set, so just check for kind_of?(DateTime)
+  # instead of kind_of?(Time)
+  test "current and last sign in timestamps are updated on each sign in" do
+    user = create_user
+    assert_nil user.current_sign_in_at
+    assert_nil user.last_sign_in_at
+
+    sign_in_as_user
+    user.reload
+
+    # assert_kind_of Time, user.current_sign_in_at
+    # assert_kind_of Time, user.last_sign_in_at
+    assert_kind_of DateTime, user.current_sign_in_at
+    assert_kind_of DateTime, user.last_sign_in_at
+
+    assert_equal user.current_sign_in_at, user.last_sign_in_at
+    assert user.current_sign_in_at >= user.created_at
+
+    visit destroy_user_session_path
+    new_time = 2.seconds.from_now
+    Time.stubs(:now).returns(new_time)
+
+    sign_in_as_user
+    user.reload
+    assert user.current_sign_in_at > user.last_sign_in_at
+  end
+end
+