leases 0.0.2 → 1.0.0

data/.travis.yml

@@ -1,5 +1,17 @@
 language: ruby
 rvm:
- - 1.9.2
- - 1.9.3
- - ruby-head
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=master"
+
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"
+    - rvm: ruby-head

data/Gemfile

@@ -2,3 +2,16 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in leases.gemspec
 gemspec
+
+rails_version = ENV["RAILS_VERSION"] || "default"
+
+rails = case rails_version
+when "master"
+  {github: "rails/rails"}
+when "default"
+  ">= 3.2.0"
+else
+  "~> #{rails_version}"
+end
+
+gem "rails", rails

data/README.md

@@ -4,6 +4,18 @@
 
 Database multi-tenancy for Rails.
 
+## Supported Rails versions
+
+- Rails 3.1.x
+- Rails 3.2.x
+- Rails 4.0.x
+
+## Supported Ruby versions
+
+- Ruby 1.9.3
+- Ruby 2.0.0
+- Ruby 2.1.1
+
 ## Installation
 
 Add this line to your Gemfile and run `bundle`.
@@ -81,6 +93,22 @@ end
 
 We're using `apartment` for managing and switching databases. This is a fantastic gem that you should check out: https://github.com/influitive/apartment. Apartment supports MySQL and PostgreSQL.
 
+## Background processing
+
+We recommend using `apartment-sidekiq` to process background jobs (https://github.com/influitive/apartment-sidekiq). This is a zero-configuration gem that enables background processing in a tenant context.
+
+Doing it yourself is also possible, here is a simple example:
+
+```ruby
+class SomeWorker
+  def some_process(account_id)
+    Account.find(account_id).visit do
+      # Your processing here
+    end
+  end
+end
+```
+
 ## Migrating
 
 ```

data/leases.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'bundler', '>= 1.0.0'
+  gem.add_development_dependency 'bundler',     '>= 1.3.0'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '>= 2.11'
+  gem.add_development_dependency 'rspec',       '>= 2.11'
   gem.add_development_dependency 'rspec-rails', '>= 2.11'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'with_model'
 
-  gem.add_dependency 'apartment', '~> 0.21.0'
+  gem.add_dependency 'apartment', '>= 0.24.2'
 end

data/lib/leases/controller.rb

@@ -11,9 +11,13 @@ module Leases
 
     module ClassMethods
 
+      ##
       # Uses a leaser as the context in a controller.
       #
-      # => visit_as :current_account
+      # === Example
+      #
+      # visit_as :current_account
+      #
       def visit_as(leaser)
         around_filter do |c, block|
           c.send(leaser).visit(&block)
@@ -22,8 +26,11 @@ module Leases
 
     end
 
+    ##
+    # Returns the current leaser. This is also a helper method.
+    #
     def current_leaser
-      Thread.current[:leaser]
+      Leases.current
     end
 
   end

data/lib/leases/model/base.rb

@@ -11,8 +11,10 @@ module Leases
 
       end
 
+      ##
       # Name of the leaser, used for naming the database.
       # This can be set in the leaser_options. Must be unique.
+      #
       def leaser_name
         name = self.class.leases_options[:name]
 
@@ -25,26 +27,38 @@ module Leases
         end
       end
 
+      ##
       # Enter the leaser-context.
       #
-      # => account.enter
+      # === Example
+      #
+      # account.enter
+      #
       def enter
         Apartment::Database.switch(leaser_name)
-        Thread.current[:leaser] = self
+        Leases.current = self
       end
 
+      ##
       # Leave the leaser-context.
       #
-      # => account.leave
+      # === Example
+      #
+      # account.leave
+      #
       def leave
-        Thread.current[:leaser] = nil
+        Leases.current = nil
         Apartment::Database.reset
       end
 
+      ##
       # Visit a leaser by entering and leaving.
       # Very useful for executing code in a leaser-context
       #
-      # => account.visit { User.find(1) }
+      # === Example
+      #
+      # account.visit { User.find(1) }
+      #
       def visit(&block)
         enter
         begin
@@ -54,18 +68,26 @@ module Leases
         end
       end
 
+      ##
       # Create a new lease.
       # This is usually called when a model is created.
       #
-      # => account.lease!
+      # === Example
+      #
+      # account.lease!
+      #
       def lease!
         Apartment::Database.create(leaser_name)
       end
 
+      ##
       # Break a lease.
       # This is usually called when a model is destroyed.
       #
-      # => account.break!
+      # === Example
+      #
+      # account.break!
+      #
       def break!
         Apartment::Database.drop(leaser_name)
       end

data/lib/leases/model/callbacks.rb

@@ -4,6 +4,17 @@ module Leases
 
       extend ActiveSupport::Concern
 
+      ##
+      # Model callbacks
+      #
+      # === Examples
+      #
+      # on_enter :do_something
+      # on_leave :do_something
+      # on_lease :do_something
+      # on_break :do_something
+      #
+
       included do
 
         ## Callbacks
@@ -15,12 +26,6 @@ module Leases
 
         define_model_callbacks :enter, :leave, :lease, :break
 
-        # Define callback aliases
-        #
-        # => on_enter :method
-        # => on_leave :method
-        # => on_lease :method
-        # => on_break :method
         class << self
           alias :on_enter :after_enter
           alias :on_leave :after_leave

data/lib/leases/model.rb

@@ -8,6 +8,15 @@ module Leases
 
     module ClassMethods
 
+      ##
+      # Marks model as a leaser.
+      #
+      # === Examples
+      #
+      # leases
+      # leases :name => :slug
+      # leases :name => Proc.new { |c| "acount_#{c.id}" }
+      #
       def leases(options={})
         include Base
         include Callbacks
@@ -18,6 +27,16 @@ module Leases
         self.leases_options = options
       end
 
+      ##
+      # Marks model as a shared model.
+      # This prevents the model being multi-tenant.
+      #
+      # === Example
+      #
+      # class User < ActiveRecord::Base
+      #   shared_by_leasers
+      # end
+      #
       def shared_by_leasers
         Apartment.excluded_models ||= []
         Apartment.excluded_models += [self.name]

data/lib/leases/version.rb

@@ -1,3 +1,3 @@
 module Leases
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

data/lib/leases.rb

@@ -10,9 +10,13 @@ module Leases
   attr_accessor :leasers
   self.leasers = []
 
+  ##
   # Add leaser to array of leasers.
   #
-  # => leasing(Account)
+  # === Example
+  #
+  # leasing(Account)
+  #
   def leasing(object)
     self.leasers << object.name
     self.leasers.uniq!
@@ -22,6 +26,17 @@ module Leases
     object
   end
 
+  ##
+  # Leaser names currently used in the app
+  #
+  # === Example
+  #
+  # Leases.leaser_names
+  #
+  # === Returns
+  #
+  # [Array] List of leaser names
+  #
   def leaser_names(preload=true)
     Rails.application.eager_load! if preload
 
@@ -31,4 +46,31 @@ module Leases
     end.flatten
   end
 
+  ##
+  # Returns the current leaser.
+  # This method uses Thread.current and is completely thread-safe.
+  #
+  # === Example
+  #
+  # Leases.current
+  #
+  # === Returns
+  #
+  # [Object] The current leaser
+  #
+  def current
+    Thread.current[:leaser]
+  end
+
+  ##
+  # Sets the current leaser.
+  #
+  # === Example
+  #
+  # Leases.current = account
+  #
+  def current=(leaser)
+    Thread.current[:leaser] = leaser
+  end
+
 end

data/spec/leases_spec.rb

@@ -31,4 +31,15 @@ describe Leases do
 
   end
 
+  describe :current do
+
+    it 'should get current leaser from Thread' do
+      account = Account.create
+
+      Leases.current = account
+      Leases.current.should == account
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -28,5 +28,6 @@ end
 
 module Dummy
   class Application < Rails::Application
+    config.secret_token = '6623f46b9f15d3ac359e2322b7977cdf'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leases
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,17 +112,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.24.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.24.2
 description: Database multi-tenancy for Rails.
 email:
 - mail@arjen.me
@@ -162,12 +162,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4143158918345724043
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4143158918345724043
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24