check_out 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Nick Ragaz
+
+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.md

@@ -0,0 +1,55 @@
+CheckOut
+============
+
+Let users `check out` Active Record instances and then release them when they're done editing.
+
+Using `include CheckOut` in a model's class definition provides the following features:
+
+  * Scopes:
+    1. `checked_out_to(user)`
+    2. `checked_out`
+    3. `released` (inverse of `checked_out`)
+    4. `available_to(user)`
+  * Collection / scope methods:
+    1. `check_out_all(user)`
+    2. `release_all_checkouts(user)` (`user` is optional)
+  * Instance methods:
+    1. `checked_out?`
+    2. `checked_out_to?(user)`
+    3. `check_out(user)`
+    4. `release(user)` (`user` is optional)
+    5. `update_attributes_and_release(attributes)`
+
+The model must have the following columns:
+
+  * `checked_out_by_user_id` (integer)
+  * `checked_out_by_user_type` (string)
+  * `checked_out_at` (datetime)
+
+Requires Rails ~> 3 and Ruby 1.9.2.
+
+Usage
+-----
+
+  create_table "jobs" do |t|
+    t.integer :checked_out_by_user_id
+    t.string :checked_out_by_user_type
+    t.datetime :checked_out_at
+  end
+  
+  class Job < ActiveRecord::Base
+    include CheckOut
+  end
+  
+  # in 'edit' action
+  
+  job.checkout(user) # => job.checked_out_at = Time.now, etc.
+  
+  # in 'update' action
+  
+  job = Job.available_to(user).find(params[:id])
+  job.update_attributes_and_release(params[:job])
+  
+The challenging thing is knowing when to release the record if the user decides not to make any changes (i.e. cancels) or just closes their browser.
+
+I've found that by including `Job.release_all_checkouts(current_user)` in the 'index' action, I can avoid almost all conflicts. I also add an "unlock" action for manually overriding an existing checkout. A link to 'unlock' appears in a flash message if a user tries to edit a record that is already checked out.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WasNewRecord'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/check_out.rb

@@ -0,0 +1,140 @@
+require 'active_support/concern'
+
+module CheckOut
+  extend ActiveSupport::Concern
+
+  class AlreadyCheckedOutError < Exception; end
+
+  class NotYoursError < Exception; end
+
+  included do
+    belongs_to :checked_out_by_user, polymorphic: true
+  
+    scope :checked_out_to, lambda { |u=nil|
+      u ?
+        where(
+          checked_out_by_user_id: u.id,
+          checked_out_by_user_type: u.class.name
+        ) :
+        checked_out
+    }
+  
+    scope :checked_out,
+          where("#{table_name}.checked_out_by_user_id IS NOT NULL OR #{table_name}.checked_out_by_user_type IS NOT NULL OR #{table_name}.checked_out_at IS NOT NULL")
+        
+    scope :released,
+          where("#{table_name}.checked_out_by_user_id IS NULL AND #{table_name}.checked_out_by_user_type IS NULL AND #{table_name}.checked_out_at IS NULL")
+  
+    scope :released_or_checked_out_by, lambda { |u|
+      where("#{table_name}.checked_out_by_user_id IS NULL OR (#{table_name}.checked_out_by_user_id = ? AND #{table_name}.checked_out_by_user_type = ?)", u.id, u.class.name)
+    }
+  
+    scope :available_to, lambda { |u| released_or_checked_out_by(u) }
+  end
+
+
+  module ClassMethods
+    def check_out_all(user)
+      ids = select("#{table_name}.id").map(&:id)
+    
+      unscoped do
+        where(id: ids).
+        update_all(
+          checked_out_by_user_id: user.id,
+          checked_out_by_user_type: user.class.name,
+          checked_out_at: Time.zone.now
+        )
+      end unless ids.empty?
+    end
+    alias :check_out_all_to :check_out_all
+  
+    def release_all_checkouts(user=nil)
+      if user
+        ids = select("#{table_name}.id").where(
+          checked_out_by_user_id: user.id,
+          checked_out_by_user_type: user.class.name
+        ).map(&:id)
+      else
+        ids = select("#{table_name}.id").checked_out.map(&:id)
+      end
+    
+      unscoped do
+        changes = {
+          checked_out_by_user_id: nil,
+          checked_out_by_user_type: nil,
+          checked_out_at: nil
+        }
+      
+        where(id: ids).update_all(changes)
+      end unless ids.empty?
+    end
+    alias :release_all_checkouts_from :release_all_checkouts
+  end
+  
+  
+  def checked_out_to?(user)
+    checked_out? &&
+    checked_out_by_user_type == user.class.name &&
+    checked_out_by_user_id == user.id
+  end
+  
+  def checked_out?
+    checked_out_at?
+  end
+
+  def checkout(check_out_to_user)
+    changes = {}
+  
+    if checked_out? && checked_out_by_user_id != check_out_to_user.id
+      raise AlreadyCheckedOutError, "#{self.class} #{self.id} is already checked out by #{checked_out_by_user_type} #{checked_out_by_user_id}"
+    elsif checked_out? && checked_out_by_user_id == check_out_to_user.id
+      changes[:checked_out_at] = 
+        write_attribute(:checked_out_at, current_time_from_proper_timezone)
+    else
+      changes[:checked_out_by_user_id] =
+        write_attribute(:checked_out_by_user_id, check_out_to_user.id)
+      changes[:checked_out_by_user_type] =
+        write_attribute(:checked_out_by_user_type, check_out_to_user.class.name)
+      changes[:checked_out_at] =
+        write_attribute(:checked_out_at, current_time_from_proper_timezone)
+    end
+  
+    self.class.unscoped do
+      self.class.update_all changes, { id: self.id }
+    end
+  end
+  alias :check_out   :checkout
+  alias :checkout_to :checkout
+
+  def release(releasing_user=nil)
+    if releasing_user && releasing_user.id == checked_out_by_user_id
+      release
+    elsif releasing_user
+      raise NotYoursError, "#{self.class} #{self.id} is not checked out by #{releasing_user.class.name} #{releasing_user.id} and cannot be released"
+    end
+  
+    changes = {}
+    changes[:checked_out_by_user_id] =
+      write_attribute(:checked_out_by_user_id, nil)
+    changes[:checked_out_by_user_type] =
+      write_attribute(:checked_out_by_user_type, nil)
+    changes[:checked_out_at] = write_attribute(:checked_out_at, nil)
+  
+    self.checked_out_by_user = nil
+  
+    self.class.unscoped do
+      self.class.update_all changes, { id: self.id }
+    end
+  end
+  alias :release_from :release
+
+  def update_attributes_and_release(params={})
+    params = params.merge(
+      checked_out_by_user_id: nil,
+      checked_out_at: nil,
+      checked_out_by_user_type: nil
+    )
+    
+    update_attributes params
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: check_out
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ragaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70352053378760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70352053378760
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70352053378280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70352053378280
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70352053377900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70352053377900
+description: Let users `check out` Active Record instances and then release them when
+  they're done editing.
+email: nick.ragaz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/check_out.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/nragaz/check_out
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Let users `check out` Active Record instances and then release them when
+  they're done editing.
+test_files: []