account_scopper 0.1.0 → 0.2.0

data/README.rdoc

@@ -4,13 +4,28 @@ Account Scopper aims to make conversion from a single account to multi-accounts
 
 Simply set your current_account before each request and the scoping will be done on it's own.
 
+== Install
+
+If new to gemcutter first run
+
+  sudo gem install gemcutter
+  sudo gemcutter tumble
+
+Then run
+
+  sudo gem install account_scopper
+  
+If using rails, in your `config/environment.rb`
+
+  config.gem 'account_scopper'
+
 == Usage
 
 To convert your application, you will need to make few changes :
 
 1. Create an Account model and Accounts table
 2. Add account_id to your existing models (except Account of course)
-3. Make relationship between Account and other models
+3. Define relationship between Account and other models
 4. Add the class variable "current_account" to the model Account
 5. Initialize Account.current_account before every request (eg: app/controllers/application.rb)
 
@@ -18,31 +33,31 @@ eg:
 
 # app/model/account.rb
 
-class Account < ActiveRecord::Base
-  cattr_accessor :current_account
+  class Account < ActiveRecord::Base
+    cattr_accessor :current_account
   
-  has_many :users
-end
+    has_many :users
+  end
 
 # app/model/user.rb
 
-class User < ActiveRecord::Base  
-  belongs_to :account
-end
+  class User < ActiveRecord::Base  
+    belongs_to :account
+  end
 
 # app/controllers/application.rb
 
-class ApplicationController < ActionController::Base
-  before_filter :set_current_account
-  # ...
+  class ApplicationController < ActionController::Base
+    before_filter :set_current_account
+    # ...
 
-  private
-    # Don't forget that @current_account should be properly setup to be an Account object
-    # for this purpose you can use the plugin AccountLocation from David Heinemeier Hansson
-    def set_current_account
-      Account.current_account = @current_account
-    end
-end
+    private
+      # Don't forget that @current_account should be properly setup to be an Account object
+      # for this purpose you can use the plugin AccountLocation from David Heinemeier Hansson
+      def set_current_account
+        Account.current_account = @current_account
+      end
+  end
 
 == What it does
 
@@ -51,6 +66,16 @@ The plugin overwrite few methods from ActiveRecord::Base
 To have a better understanding of what it does, the best way is still to look
 at the code itself and the tests.
 
+== Helpers
+
+As account_scopper scopes all database requests, `validates_uniqueness_of` will also scope to the current account.
+
+In some cases, you may like to make sure that somethings remain unique to your whole system.
+
+(eg: the user login or email if logging in from a common page for all accounts)
+
+For this purpose, you can use `validates_global_uniqueness_of`. This validations will make sure your attribute is unique over all accounts.
+
 == Warning
 
 If using manually generated database requests like find_by_sql, ... you'll have to do your own scoping

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "public@zencocoon.com"
     gem.homepage = "http://github.com/ZenCocoon/account_scopper"
     gem.authors = ["Sebastien Grosjean"]
+    gem.add_dependency "activerecord", ">= 2.3.4"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/account_scopper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{account_scopper}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastien Grosjean"]
-  s.date = %q{2009-11-11}
+  s.date = %q{2009-11-17}
   s.description = %q{Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications.}
   s.email = %q{public@zencocoon.com}
   s.extra_rdoc_files = [
@@ -62,11 +62,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.4"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
+      s.add_dependency(%q<activerecord>, [">= 2.3.4"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
+    s.add_dependency(%q<activerecord>, [">= 2.3.4"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end
 end

data/lib/account_scopper.rb

@@ -55,4 +55,78 @@ module ActiveRecord # :nodoc:
         orig_create
       end
   end
+
+  module Validations
+    module ClassMethods
+      # Allow to validates uniqueness without scoping to the current account.
+      def validates_global_uniqueness_of(*attr_names)
+        configuration = { :case_sensitive => true }
+        configuration.update(attr_names.extract_options!)
+
+        validates_each(attr_names,configuration) do |record, attr_name, value|
+
+          # The check for an existing value should be run from a class that
+          # isn't abstract. This means working down from the current class
+          # (self), to the first non-abstract class. Since classes don't know
+          # their subclasses, we have to build the hierarchy between self and
+          # the record's class.
+          class_hierarchy = [record.class]
+          while class_hierarchy.first != self
+            class_hierarchy.insert(0, class_hierarchy.first.superclass)
+          end
+
+          # Now we can work our way down the tree to the first non-abstract
+          # class (which has a database table to query from).
+          finder_class = class_hierarchy.detect { |klass| !klass.abstract_class? }
+
+          column = finder_class.columns_hash[attr_name.to_s]
+
+          if value.nil?
+            comparison_operator = "IS ?"
+          elsif column.text?
+            comparison_operator = "#{connection.case_sensitive_equality_operator} ?"
+            value = column.limit ? value.to_s.mb_chars[0, column.limit] : value.to_s
+          else
+            comparison_operator = "= ?"
+          end
+
+          sql_attribute = "#{record.class.quoted_table_name}.#{connection.quote_column_name(attr_name)}"
+
+          if value.nil? || (configuration[:case_sensitive] || !column.text?)
+            condition_sql = "#{sql_attribute} #{comparison_operator}"
+            condition_params = [value]
+          else
+            condition_sql = "LOWER(#{sql_attribute}) #{comparison_operator}"
+            condition_params = [value.mb_chars.downcase]
+          end
+
+          if scope = configuration[:scope]
+            Array(scope).map do |scope_item|
+              scope_value = record.send(scope_item)
+              condition_sql << " AND " << attribute_condition("#{record.class.quoted_table_name}.#{scope_item}", scope_value)
+              condition_params << scope_value
+            end
+          end
+
+          unless record.new_record?
+            condition_sql << " AND #{record.class.quoted_table_name}.#{record.class.primary_key} <> ?"
+            condition_params << record.send(:id)
+          end
+
+          # Remove current account to prevent scopping
+          account = Account.current_account
+          Account.current_account = nil
+
+          finder_class.with_exclusive_scope do
+            if finder_class.exists?([condition_sql, *condition_params])
+              record.errors.add(attr_name, :taken, :default => configuration[:message], :value => value)
+            end
+          end
+
+          # Restore current account
+          Account.current_account = account
+        end
+      end
+    end
+  end
 end

data/spec/account_scopper_spec.rb

@@ -66,4 +66,19 @@ describe "AccountScopper" do
     user = User.find_by_name('Stephane')
     user.destroy.should_not be_nil
   end
+  
+  it "should validates_uniqueness_of within account" do
+    u = User.create(:name => "Seb")
+    u.errors.on(:name).should == "has already been taken"
+  end
+  
+  it "should not validates_uniqueness_of without scoping the current account" do
+    u = User.create(:name => "Stephane")
+    u.valid?.should be_true
+  end
+  
+  it "should validates_global_uniqueness_of wihtout scoping the current account" do
+    u = User.create(:login => "stephane")
+    u.errors.on(:login).should == "has already been taken"
+  end
 end

data/spec/fixtures/user.rb

@@ -1,3 +1,6 @@
 class User < ActiveRecord::Base
   belongs_to :account
+  
+  validates_uniqueness_of :name
+  validates_global_uniqueness_of :login
 end

data/spec/fixtures/users.yml

@@ -2,11 +2,14 @@ seb:
   id: 1
   account_id: 1
   name: Seb
+  login: seb
 marc:
   id: 2
   account_id: 1
   name: Marc
+  login: marc
 stephane:
   id: 3
   account_id: 2
   name: Stephane
+  login: stephane

data/spec/schema.rb

@@ -4,6 +4,7 @@ ActiveRecord::Schema.define(:version => 0) do
   end
   create_table :users, :force => true do |t|
     t.string :name
+    t.string :login
     t.references :account
   end
 end 

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ require File.dirname(__FILE__) + '/lib/load_schema'
 require File.dirname(__FILE__) + '/lib/load_models'
 require File.dirname(__FILE__) + '/lib/load_fixtures'
 
+require File.dirname(__FILE__) + "/../init"
+
 Spec::Runner.configure do |config|  
   load_models
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: account_scopper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sebastien Grosjean
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 +02:00
+date: 2009-11-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.4
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development