has_default 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,81 @@
+# HasDefault
+
+Specify a "default" instance that is to be returned for an ActiveRecord model when Model.default is called.
+
+# Installation
+
+Install the has_default gem
+
+    gem install bradgessler-has_default
+    
+Then configure in rails
+
+    config.gem 'bradgessler-has_default',
+      :lib => 'has_default',
+      :source => 'http://gems.github.com'
+
+For whatever model you need to set a default for, run the a similar migration
+
+    class AddDefaultsToModels < ActiveRecord::Migration
+      def self.up
+        change_table :plans do |t|
+          t.boolean :default
+        end
+        add_index :plans, :default, :unique => true
+      end
+
+      def self.down
+        remove_index :plans, :default
+        change_table :plans do |t|
+          t.remove :default
+        end
+      end
+    end
+    
+# Example
+
+    class Plan
+      has_many :accounts
+      has_default
+    end
+
+    class Account
+      belongs_to :plan
+  
+      before_validate :set_default_plan, :unless => Proc.new{|a| a.plan.present? }
+  
+    protected
+      def set_default_plan
+        self.plan = Plan.default
+      end
+    end
+
+    Plan.create(:name => 'Free', :default => true)
+    Plan.create(:name => 'Medium')
+    Plan.create(:name => 'High')
+
+    Account.new.plan.name # => 'Free'
+    Plan.find_by_name('High').update_attribute(:default, true)
+    Account.new.plan.name # => 'High'
+
+# License
+
+Copyright (c) 2009 Brad Gessler, released under the MIT license
+
+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/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/*.rb']
+  t.fail_on_error = false
+end
+
+desc 'Generate documentation for the has_default plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasDefault'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "has_default"
+    gemspec.summary = "Specify a default instance to be returned for an ActiveRecord model"
+    gemspec.description = ""
+    gemspec.email = "brad@conden.se"
+    gemspec.homepage = "http://github.com/bradgessler/has_default"
+    gemspec.authors = ["Brad Gessler"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/init.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/lib/has_default'
+
+ActiveRecord::Base.send :include, HasDefault::ActiveRecord

data/lib/has_default.rb

@@ -0,0 +1,40 @@
+module HasDefault
+  module ActiveRecord
+    def self.included(base)
+      base.send :extend, ActMacro
+    end
+    
+    module ActMacro
+      def has_default(opts={})
+        write_inheritable_attribute :default_column, opts[:column] || 'default'
+
+        class_inheritable_reader :default_column
+        
+        self.send :extend, ClassMethods
+        self.send :include, HasDefault::ActiveRecord::Callbacks
+        self.send :include, HasDefault::ActiveRecord::InstanceMethods
+        
+        after_save :clear_default_scope
+      end
+    end
+    
+    module ClassMethods
+      def default
+        first(:conditions => [ "`#{default_column}` = ?", true ]) || first
+      end
+    end
+    
+    module Callbacks
+    private
+      # Clears default on everything except for the model being saved if its set to be the new default
+      def clear_default_scope
+        if self.send(self.class.default_column)
+          self.class.update_all([ "`#{self.class.default_column}` = ?", nil ], [ "#{self.class.primary_key} <> ? ", self.send(self.class.primary_key)])
+        end
+      end
+    end
+    
+    module InstanceMethods
+    end
+  end
+end

data/spec/default.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'spec'
+
+gem 'activerecord', '>= 1.15.4.7794'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+require "#{File.dirname(__FILE__)}/../init"
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :drinks do |t|
+      t.column :name, :string
+      t.column :default, :boolean
+      t.column :created_at, :datetime      
+      t.column :updated_at, :datetime
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Drink < ActiveRecord::Base
+  has_default
+end
+
+describe "has_default" do
+  before(:each) do
+    setup_db
+    Drink.create([
+      {:name => 'Small'},
+      {:name => 'Medium'},
+      {:name => 'Large'}
+    ])
+  end
+  
+  after(:each) do
+    teardown_db
+  end
+  
+  it "should have default" do
+    Drink.should respond_to(:default)
+  end
+  
+  it "should give first record if no default" do
+    Drink.default.should eql(Drink.first)
+  end
+  
+  it "should set default" do
+    Drink.last.update_attribute(:default, true)
+    Drink.last.should be_default
+  end
+  
+  it "should only allow one default" do
+    Drink.last.update_attribute(:default, true)
+    Drink.first.update_attribute(:default, true)    
+    Drink.all(:conditions => {:default => true}).should have(1).item
+    Drink.first.should be_default
+  end
+end

data/tasks/acts_as_default_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_default do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: has_default
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Brad Gessler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: brad@conden.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/has_default.rb
+- tasks/acts_as_default_tasks.rake
+has_rdoc: true
+homepage: http://github.com/bradgessler/has_default
+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: Specify a default instance to be returned for an ActiveRecord model
+test_files: 
+- spec/default.rb