account_scopper 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sebastien Grosjean
+
+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,71 @@
+= Account Scopper
+
+Account Scopper aims to make conversion from a single account to multi-accounts application as easy as possible.
+
+Simply set your current_account before each request and the scoping will be done on it's own.
+
+== 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
+4. Add the class variable "current_account" to the model Account
+5. Initialize Account.current_account before every request (eg: app/controllers/application.rb)
+
+eg: 
+
+# app/model/account.rb
+
+class Account < ActiveRecord::Base
+  cattr_accessor :current_account
+  
+  has_many :users
+end
+
+# app/model/user.rb
+
+class User < ActiveRecord::Base  
+  belongs_to :account
+end
+
+# app/controllers/application.rb
+
+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
+
+== What it does
+
+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.
+
+== Warning
+
+If using manually generated database requests like find_by_sql, ... you'll have to do your own scoping
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Sebastien Grosjean. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "account_scopper"
+    gem.summary = "Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications."
+    gem.description = "Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications."
+    gem.email = "public@zencocoon.com"
+    gem.homepage = "http://github.com/ZenCocoon/account_scopper"
+    gem.authors = ["Sebastien Grosjean"]
+    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
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "account_scopper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/account_scopper.gemspec

@@ -0,0 +1,73 @@
+# 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{account_scopper}
+  s.version = "0.1.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.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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "account_scopper.gemspec",
+     "init.rb",
+     "lib/account_scopper.rb",
+     "spec/account_scopper_spec.rb",
+     "spec/boot.rb",
+     "spec/database.yml",
+     "spec/fixtures/account.rb",
+     "spec/fixtures/accounts.yml",
+     "spec/fixtures/user.rb",
+     "spec/fixtures/users.yml",
+     "spec/lib/load_fixtures.rb",
+     "spec/lib/load_models.rb",
+     "spec/lib/load_schema.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ZenCocoon/account_scopper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications.}
+  s.test_files = [
+    "spec/account_scopper_spec.rb",
+     "spec/boot.rb",
+     "spec/fixtures/account.rb",
+     "spec/fixtures/user.rb",
+     "spec/lib/load_fixtures.rb",
+     "spec/lib/load_models.rb",
+     "spec/lib/load_schema.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'account_scopper'

data/lib/account_scopper.rb

@@ -0,0 +1,58 @@
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+    class << self # Class methods
+      alias_method :orig_delete_all, :delete_all
+      def delete_all(conditions = nil)
+        if Account.current_account != nil && column_names.include?("account_id")
+          with_scope(:find => {:conditions => "account_id = "+Account.current_account.id.to_s}) do
+            orig_delete_all(conditions)
+          end
+        else
+          orig_delete_all(conditions)
+        end
+      end
+      
+      alias_method :orig_calculate, :calculate
+      def calculate(operation, column_name, options = {})
+        if Account.current_account != nil && column_names.include?("account_id")
+          with_scope(:find => {:conditions => ["account_id = ?", Account.current_account.id]}) do
+            orig_calculate(operation, column_name, options)
+          end
+        else
+          orig_calculate(operation, column_name, options)
+        end
+      end
+      
+      private
+        alias_method :orig_find_every, :find_every
+        def find_every(options)
+          if Account.current_account != nil && column_names.include?("account_id")
+            with_scope(:find => {:conditions => self.table_name+".`account_id` = "+Account.current_account.id.to_s}) do
+              orig_find_every(options)
+            end
+          else
+            orig_find_every(options)
+          end
+        end
+    end
+    
+    # Instance methods, they are called from an instance of a model (an object)
+    alias_method :orig_destroy, :destroy
+    def destroy
+      if !Account.current_account.nil? && respond_to?(:account_id)
+        orig_destroy if self.account_id == Account.current_account.id
+      else
+        orig_destroy
+      end
+    end
+    
+    private
+      alias_method :orig_create, :create
+      def create
+        if !Account.current_account.nil? && respond_to?(:account_id)
+          self.account_id = Account.current_account.id
+        end
+        orig_create
+      end
+  end
+end

data/spec/account_scopper_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AccountScopper" do
+  # Homemade fixtures method that doesn't depend on active support
+  fixtures :accounts, :users
+  
+  it "should proper set fixtures" do
+    Account.find_by_name("Localhost").should == accounts(:localhost)
+  end
+  
+  it "should have the current account initialized" do
+    Account.current_account.should == accounts(:localhost)
+  end
+  
+  it "should create user with account" do
+    u = User.create
+    u.account.should == accounts(:localhost)
+  end
+  
+  it "should force account while creating new user" do
+    u = User.create(:account_id => 2)
+    u.account.should == accounts(:localhost)
+  end
+
+  it "should find user within account" do
+    User.find(2).should == users(:marc)
+  end
+
+  it "should not find user having different account" do
+    lambda { User.find(3) }.should raise_error(ActiveRecord::RecordNotFound)
+  end
+  
+  it "should return only user from account" do
+    User.all.each do |user|
+      user.account.should == accounts(:localhost)
+    end
+  end
+  
+  it "should count only within account" do
+    User.count.should == User.all.size
+  end
+  
+  it "should delete all within account, not others" do
+    User.delete_all
+    User.count.should == 0
+    Account.current_account = nil
+    User.count.should > 0
+  end
+  
+  it "should delete all if no account defined" do
+    Account.current_account = nil
+    User.delete_all
+    User.count.should == 0
+  end
+  
+  it "should not allow to destroy foreign users" do
+    Account.current_account = nil
+    user = User.find_by_name('Stephane')
+    user.account.should_not == accounts(:localhost)
+    Account.current_account = accounts(:localhost)
+    user.destroy.should be_nil
+  end
+  
+  it "should allow to destroy if not account" do
+    Account.current_account = nil
+    user = User.find_by_name('Stephane')
+    user.destroy.should_not be_nil
+  end
+end

data/spec/boot.rb

@@ -0,0 +1,21 @@
+plugin_root = File.join(File.dirname(__FILE__), '..')
+version = ENV['RAILS_VERSION']
+version = nil if version and version == ""
+
+# first look for a symlink to a copy of the framework
+if !version and framework_root = ["#{plugin_root}/rails", "#{plugin_root}/../../rails"].find { |p| File.directory? p }
+  puts "found framework root: #{framework_root}"
+  # this allows for a plugin to be tested outside of an app and without Rails gems
+  $:.unshift "#{framework_root}/activesupport/lib", "#{framework_root}/activerecord/lib", "#{framework_root}/actionpack/lib"
+else
+  # simply use installed gems if available
+  puts "using Rails#{version ? ' ' + version : nil} gems"
+  require 'rubygems'
+  
+  if version
+    gem 'rails', version
+  else
+    gem 'actionpack'
+    gem 'activerecord'
+  end
+end

data/spec/database.yml

@@ -0,0 +1,21 @@
+sqlite2:
+  :adapter: sqlite
+  :database: ":memory:"
+
+sqlite3:
+  :adapter: sqlite3
+  :database: ":memory:"
+
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: account_scopper_test
+  :min_messages: ERROR
+
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: password
+  :database: account_scopper_test

data/spec/fixtures/account.rb

@@ -0,0 +1,5 @@
+class Account < ActiveRecord::Base
+  cattr_accessor :current_account
+  
+  has_many :users
+end

data/spec/fixtures/accounts.yml

@@ -0,0 +1,6 @@
+localhost:
+  id: 1
+  name: Localhost
+demo:
+  id: 2
+  name: Demo

data/spec/fixtures/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  belongs_to :account
+end

data/spec/fixtures/users.yml

@@ -0,0 +1,12 @@
+seb:
+  id: 1
+  account_id: 1
+  name: Seb
+marc:
+  id: 2
+  account_id: 1
+  name: Marc
+stephane:
+  id: 3
+  account_id: 2
+  name: Stephane

data/spec/lib/load_fixtures.rb

@@ -0,0 +1,13 @@
+require 'active_record/fixtures'
+
+def load_fixtures
+  Fixtures.create_fixtures(File.dirname(__FILE__) + "/../fixtures/", ActiveRecord::Base.connection.tables)
+end
+
+def fixtures(*args)
+  args.each do |fixture|
+    define_method fixture.to_s do |symbol|
+      eval(fixture.to_s.singularize.camelize).find(Fixtures.all_loaded_fixtures[fixture.to_s][symbol.to_s]["id"])
+    end
+  end
+end

data/spec/lib/load_models.rb

@@ -0,0 +1,5 @@
+def load_models
+  Dir[File.dirname(__FILE__) + "/../fixtures/*.rb"].entries.compact.each do |str|
+    load(str)
+  end
+end

data/spec/lib/load_schema.rb

@@ -0,0 +1,32 @@
+require 'active_record'
+
+def load_schema
+  ActiveRecord::Schema.verbose = false
+  
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/../database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/../debug.log")
+
+  db_adapter = ENV['DB']
+  
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+  
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/../schema.rb")
+  require File.dirname(__FILE__) + '/../../init.rb'
+end 

data/spec/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :accounts, :force => true do |t|
+    t.string :name
+  end
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.references :account
+  end
+end 

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+
+require 'boot' unless defined?(ActiveRecord)
+
+require File.dirname(__FILE__) + '/lib/load_schema'
+require File.dirname(__FILE__) + '/lib/load_models'
+require File.dirname(__FILE__) + '/lib/load_fixtures'
+
+Spec::Runner.configure do |config|  
+  load_models
+  
+  config.before do
+    load_schema
+    load_fixtures
+    Account.current_account = accounts(:localhost)
+  end
+
+  config.after do
+    Account.current_account = nil
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: account_scopper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sebastien Grosjean
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: "Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications."
+email: public@zencocoon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- account_scopper.gemspec
+- init.rb
+- lib/account_scopper.rb
+- spec/account_scopper_spec.rb
+- spec/boot.rb
+- spec/database.yml
+- spec/fixtures/account.rb
+- spec/fixtures/accounts.yml
+- spec/fixtures/user.rb
+- spec/fixtures/users.yml
+- spec/lib/load_fixtures.rb
+- spec/lib/load_models.rb
+- spec/lib/load_schema.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ZenCocoon/account_scopper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Account Scopper: Automatically scope your ActiveRecord's model by account. Ideal for multi-account applications."
+test_files: 
+- spec/account_scopper_spec.rb
+- spec/boot.rb
+- spec/fixtures/account.rb
+- spec/fixtures/user.rb
+- spec/lib/load_fixtures.rb
+- spec/lib/load_models.rb
+- spec/lib/load_schema.rb
+- spec/schema.rb
+- spec/spec_helper.rb