remarkable_devise 1.0.0.alpha3 → 1.0.0

data/README.markdown

@@ -15,18 +15,81 @@ Add the require after the remarkable/active_record line in your spec_heplers.rb:
     require 'remarkable/devise'
 
 ## Usage
+
+Suppose that we require authentication of users. And we want to use Devise. The problem that we face a number of requirements:
+
+* The user must be authorized by email or login
+* Password should contain 8 to 20 characters
+* After 3 unsuccessful attempts to authenticate, the account should be locked in 5 hours
+* and much more
+
+Following the BDD way, we first write a specs:
    
     # spec/models/user_spec.rb   
     describe User do
-      should_be_a_database_authenticatable
-      should_be_a_token_authenticatable
-      should_be_a_confirmable
-      should_be_a_recoverable
-      should_be_a_rememberable
-      should_be_a_trackable
-      should_be_a_validatable
+      it { should be_a_confirmable(:confirm_within => 2.days) }
+      it { should be_a_rememberable(:remember_for => 2.weeks) }
+      it { should be_a_validatable(:password_length => 8..20) }
+      it { should be_a_timeoutable(:timeout_in => 15.minutes) }
+      it { should be_a_token_authenticatable(:token_authentication_key => :auth_token) }
+      it { should be_a_trackable }
+      it { should be_a_registerable }
+      it { should be_a_recoverable }
+
+      should_be_a_lockable do |o|
+        o.lock_strategy = :failed_attempts
+        o.maximum_attempts => 3
+        o.unlock_strategy => :time
+      end
+  
+      should_be_a_database_authenticatable do |o|
+        o.stretches = 20
+        o.encryptor = :clearance_sha1
+        o.params_authenticatable = false
+        o.authentication_keys = [:email, :login]
+      end
     end
 
+After number of steps (red/green/refactor) we will get the following
+result (assuming that you are familiar with how to use Devise and
+know what to do):
+     
+     # app/models/user.rb
+     class User < ActiveRecord::Base
+       devise :database_authenticatable, :stretches => 20, :encryptor => :clearance_sha1, 
+       :authentication_keys => [:email, :login], :params_authenticatable => false
+  
+       devise :confirmable, :confirm_within => 2.days
+       devise :recoverable
+       devise :rememberable, :remember_for => 2.weeks, :extend_remember_period => true
+       devise :trackable
+       devise :validatable, :password_length => 8..20
+       devise :token_authenticatable, :token_authentication_key => :auth_token
+       devise :timeoutable, :timeout_in => 15.minutes
+       
+       devise :lockable, :maximum_attempts => 3, :lock_strategy => :failed_attempts, 
+       :unlock_strategy => :time, :unlock_in => 5.hours
+       
+       devise :registerable
+     end
+
+     # rspec spec/models/user_spec.rb --format=documentation
+     User
+       should be a confirmable within 2 days
+       should be a rememberable with 14 days remember period and with extendable remember period
+       should be a validatable with password length 8..20
+       should be a timeoutable within 900 seconds
+       should be a token authenticatable with :auth_token as authentication key
+       should be a trackable
+       should be a registerable
+       should be a recoverable
+       should be a lockable with :failed_attempts lock strategy, with :time unlock strategy, with unlock in 5 hours, and with 3 maxumum attempts
+       should be a database authenticatable with [:email, :login] as authentication keys, without params authenticatable, with password stretches 20, and with :clearance_sha1 password encryptor
+
+## Documentation
+
+Coming soon
+
 ## See alse
 
 * [http://github.com/remarkable/remarkable](http://github.com/remarkable/remarkable)

data/lib/remarkable/devise/matchers/base_matcher.rb

@@ -8,6 +8,23 @@ module Remarkable
           subject_class.column_names.include?(column_name)
         end
 
+        def options_match?
+          actual = get_devise_model_options(@options.keys)
+
+          return actual == @options, :actual => actual.inspect
+        end
+
+        def get_devise_model_options(keys)
+          keys.inject({}) do |hash, key|
+            hash[key] = subject_class.send(key.to_sym)
+            hash
+          end
+        end
+
+        def interpolation_options
+          { :options => @options.inspect }
+        end
+
         def method_missing(m, *args)
           if m.to_s.match(/has_(.+)_column?/)
             return has_column?($1)

data/lib/remarkable/devise/matchers/be_a_confirmable_matcher.rb

@@ -2,8 +2,12 @@ module Remarkable
   module Devise
     module Matchers
       class BeAConfirmableMatcher < Base
+        arguments
+        
         assertion :included?, :has_confirmation_token_column?, :has_confirmed_at_column?,
-        :has_confirmation_sent_at_column?
+        :has_confirmation_sent_at_column?, :options_match?
+
+        optional :confirm_within
 
         protected
 
@@ -12,8 +16,8 @@ module Remarkable
         end
       end
 
-      def be_a_confirmable
-        BeAConfirmableMatcher.new
+      def be_a_confirmable(*args, &block)
+        BeAConfirmableMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/remarkable/devise/matchers/be_a_database_authenticatable_matcher.rb

@@ -1,8 +1,15 @@
+require File.join(File.dirname(__FILE__), 'be_an_authenticatable_matcher')
+
 module Remarkable
   module Devise
     module Matchers
-      class BeADatabaseAuthenticatableMatcher < Base
-        assertion :included?, :has_email_column?, :has_encrypted_password_column?, :has_password_salt_column?
+      class BeADatabaseAuthenticatableMatcher < BeAnAuthenticatableMatcher
+        arguments
+
+        assertion :included?, :has_email_column?, :has_encrypted_password_column?, :has_password_salt_column?,
+        :options_match?
+
+        optionals :stretches, :encryptor
 
         protected
         
@@ -11,8 +18,8 @@ module Remarkable
         end
       end
       
-      def be_a_database_authenticatable
-        BeADatabaseAuthenticatableMatcher.new
+      def be_a_database_authenticatable(*args, &block)
+        BeADatabaseAuthenticatableMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/remarkable/devise/matchers/be_a_lockable_matcher.rb

@@ -0,0 +1,34 @@
+module Remarkable
+  module Devise
+    module Matchers
+      class BeALockableMatcher < Base
+        arguments
+        
+        assertion :included?, :has_failed_attempts_column?, :has_unlock_token_column?, :has_locked_at_column?,
+        :options_match?
+
+        optionals :maximum_attempts, :lock_strategy, :unlock_strategy, :unlock_in
+
+        protected
+
+        def included?
+          subject_class.ancestors.include?(::Devise::Models::Lockable)
+        end
+
+        def has_failed_attempts_column?
+          return true if subject_class.lock_strategy == :none
+          super
+        end
+
+        def has_unlock_token_column?
+          return true unless [:email, :both].include?(subject_class.unlock_strategy)
+          super
+        end
+      end
+
+      def be_a_lockable(*args, &block)
+        BeALockableMatcher.new(*args, &block).spec(self)
+      end
+    end
+  end
+end

data/lib/remarkable/devise/matchers/be_a_registerable_matcher.rb

@@ -0,0 +1,19 @@
+module Remarkable
+  module Devise
+    module Matchers
+      class BeARegisterableMatcher < Base
+        assertion :included?
+
+        protected
+
+        def included?
+          subject_class.ancestors.include?(::Devise::Models::Registerable)
+        end
+      end
+
+      def be_a_registerable
+        BeARegisterableMatcher.new.spec(self)
+      end
+    end
+  end
+end

data/lib/remarkable/devise/matchers/be_a_rememberable_matcher.rb

@@ -2,7 +2,11 @@ module Remarkable
   module Devise
     module Matchers
       class BeARememberableMatcher < Base
-        assertions :included?, :has_remember_token_column?, :has_remember_created_at_column?
+        arguments
+        
+        assertions :included?, :has_remember_token_column?, :has_remember_created_at_column?, :options_match?
+
+        optionals :remember_for, :extend_remember_period, :cookie_domain
 
         protected
 
@@ -11,8 +15,8 @@ module Remarkable
         end
       end
 
-      def be_a_rememberable
-        BeARememberableMatcher.new
+      def be_a_rememberable(*args, &block)
+        BeARememberableMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/remarkable/devise/matchers/be_a_timeoutable_matcher.rb

@@ -0,0 +1,23 @@
+module Remarkable
+  module Devise
+    module Matchers
+      class BeATimeoutableMatcher < Base
+        arguments
+        
+        assertion :included?, :options_match?
+
+        optional :timeout_in
+
+        protected
+
+        def included?
+          subject_class.ancestors.include?(::Devise::Models::Timeoutable)
+        end
+      end
+
+      def be_a_timeoutable(*args, &block)
+        BeATimeoutableMatcher.new(*args, &block).spec(self)
+      end
+    end
+  end
+end

data/lib/remarkable/devise/matchers/be_a_token_authenticatable_matcher.rb

@@ -2,8 +2,12 @@ module Remarkable
   module Devise
     module Matchers
       class BeATokenAuthenticatableMatcher < Base
-        assertions :included?, :has_authentication_token_column?
+        arguments
+        
+        assertions :included?, :has_authentication_token_column?, :options_match?
 
+        optionals :token_authentication_key
+        
         protected
 
         def included?
@@ -11,8 +15,8 @@ module Remarkable
         end
       end
 
-      def be_a_token_authenticatable
-        BeATokenAuthenticatableMatcher.new
+      def be_a_token_authenticatable(*args, &block)
+        BeATokenAuthenticatableMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/remarkable/devise/matchers/be_a_validatable_matcher.rb

@@ -2,7 +2,11 @@ module Remarkable
   module Devise
     module Matchers
       class BeAValidatableMatcher < Base
-        assertion :included?
+        arguments
+        
+        assertion :included?, :options_match?
+
+        optionals :password_length, :email_regexp
 
         protected
 
@@ -11,8 +15,8 @@ module Remarkable
         end
       end
 
-      def be_a_validatable
-        BeAValidatableMatcher.new
+      def be_a_validatable(*args, &block)
+        BeAValidatableMatcher.new(*args, &block).spec(self)
       end
     end
   end

data/lib/remarkable/devise/matchers/be_an_authenticatable_matcher.rb

@@ -0,0 +1,19 @@
+module Remarkable
+  module Devise
+    module Matchers
+      class BeAnAuthenticatableMatcher < Base
+        arguments
+        
+        assertion :has_authenticatable_module_included?, :options_match?
+
+        optionals :authentication_keys, :params_authenticatable
+        
+        protected
+
+        def has_authenticatable_module_included?
+          subject_class.ancestors.include?(::Devise::Models::Authenticatable)
+        end
+      end
+    end
+  end
+end

data/lib/remarkable/devise/version.rb

@@ -1,7 +1,7 @@
 module Remarkable
   module Devise
     module Version
-      STRING = '1.0.0.alpha3'
+      STRING = '1.0.0'
     end
   end
 end

data/locale/en.yml

@@ -4,18 +4,37 @@ en:
       be_a_database_authenticatable:
         description: "be a database authenticatable"
         expectations:
+          has_authenticatable_module_included: "%{subject_name} to have Devise :authenticatable model"
           included: "%{subject_name} to include Devise :database_authenticatable model"
+          options_match: "%{subject_name} to be a database authenticatable with options %{options}, got %{actual}"
           has_email_column: "%{subject_name} to have email column"
           has_encrypted_password_column: "%{subject_name} to have encrypted_password column"
           has_password_salt_column: "%{subject_name} to have password_salt column"
+          stretches_match: "%{subject_name} to have password stretches equal to %{stretches}, got %{actual}"
+          encryptor_match: "%{subject_name} to have %{encryptor} password encryptor, got %{actual}"
+        optionals:
+          stretches:
+            positive: "with password stretches %{inspect}"
+          encryptor:
+            positive: "with %{inspect} password encryptor"
+          authentication_keys:
+            positive: "with %{inspect} as authentication keys"
+          params_authenticatable:
+            positive: "with params authenticatable"
+            negative: "without params authenticatable"
       
       be_a_confirmable:
         description: "be a confirmable"
         expectations:
           included: "%{subject_name} to include Devise :confirmable model"
+          options_match: "%{subject_name} to be a confirmable with options %{options}, got %{actual}"
           has_confirmation_token_column: "%{subject_name} to have confirmation_token column"
           has_confirmed_at_column: "%{subject_name} to have confirmed_at column"
           has_confirmation_sent_at_column: "%{subject_name} to have confirmation_sent_at column"
+          confirmation_period_matches: "%{subject_name} to have %{confirm_within} of confirmation period, got %{actual}"
+        optionals:
+          confirm_within:
+            positive: "within %{inspect}"
 
       be_a_recoverable:
         description: "be a recoverable"
@@ -29,6 +48,15 @@ en:
           included: "%{subject_name} to include Devise :rememberable model"
           has_remember_token_column: "%{subject_name} to have remember_token column"
           has_remember_created_at_column: "%{subject_name} to have remember_created_at column"
+          options_match: "%{subject_name} to be rememberable with options %{options}, got %{actual}"
+        optionals:
+          remember_for:
+            positive: "with %{inspect} remember period"
+          extend_remember_period:
+            positive: "with extendable remember period"
+            negative: "without extandable remember period"
+          cookie_domain:
+            positive: "with %{inspect} cookie domain"
 
       be_a_trackable:
         description: "be a trackable"
@@ -44,9 +72,51 @@ en:
         description: "be a validatable"
         expectations:
           included: "%{subject_name} to include Devise :validatable model"
+          options_match: "%{subject_name} to be a validatable with options %{options}, got %{actual}"
+        optionals:
+          password_length: 
+            positive: "with password length %{inspect}"
+          email_regexp:
+            positive: "with email regexp %{inspect}"
 
       be_a_token_authenticatable:
         description: "be a token authenticatable"
         expectations:
           included: "%{subject_name} to include Devise :token_authenticatable model"
           has_authentication_token_column: "%{subject_name} to have authentication_token column"
+          options_match: "%{subject_name} to be a token authenticatable with options %{options}, got %{actual}"
+        optionals:
+          token_authentication_key:
+            positive: "with %{inspect} as token authentication key"
+      
+      be_a_timeoutable:
+        description: "be a timeoutable"
+        expectations:
+          included: "%{subject_name} to include Devise :timeoutable model"
+          options_match: "%{subject_name} to be a timeoutable with options %{options}, got %{actual}"
+        optionals:
+          timeout_in: 
+            positive: "within %{inspect}"
+
+      be_a_lockable:
+        description: "be a lockable"
+        expectations:
+          included: "%{subject_name} to have Devise :lockable model"
+          has_failed_attempts_column: "%{subject_name} to have failed_attempts column"
+          has_unlock_token_column: "%{subject_name} to have unlock_token column"
+          has_locked_at_column: "%{subject_name} to have locked_at column"
+          options_match: "%{subject_name} to be a lockable with options %{options}, got %{actual}"
+        optionals:
+          maximum_attempts:
+            positive: "with %{inspect} maximum attempts"
+          lock_strategy:
+            positive: "with %{inspect} lock strategy"
+          unlock_strategy:
+            positive: "with %{inspect} unlock strategy"
+          unlock_in:
+            positive: "with unlock in %{inspect}"
+
+      be_a_registerable:
+        description: "be a registerable"
+        expectations:
+          included: "%{subject_name} to have Devise :registerable model"