acts_as_featured 0.1.2

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'rspec', '~> 2.6.0'
+gem 'sqlite3'
+gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'activerecord', :require => 'active_record'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Brandan Lennox
+
+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,41 @@
+Acts as Featured
+================
+
+Designates an attribute on this model to indicate "featuredness," where only one record within a given scope may be featured at a time.
+
+Pass in the name of the attribute and an options hash:
+
+* `:scope` - If given, designates the scope in which this model is featured. This would typically be a `belongs_to` association.
+* `:create_scope` - If `true`, creates a named scope using the name of the attribute given here. If it's a symbol, creates a named scope using that symbol.
+
+Examples:
+
+    class Project < ActiveRecord::Base
+      # no two Projects will ever have their @featured attributes set simultaneously
+      acts_as_featured :featured
+    end
+
+    class Photo < ActiveRecord::Base
+      # each account gets a favorite photo
+      belongs_to :account
+      acts_as_featured :favorite, :scope => :account
+    end
+
+    class Article < ActiveRecord::Base
+      # creates a named scope called Article.featured to return the featured article
+      acts_as_featured :main, :create_scope => :featured
+    end
+
+Running Tests
+-------------
+
+It's RSpec:
+
+    rspec spec/acts_as_featured_spec.rb
+
+Make sure you run `bundle install` to get the development dependencies first.
+
+License
+-------
+
+See MIT-LICENSE.

data/acts_as_featured.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_featured/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_featured"
+  s.version     = ActsAsFeatured::VERSION
+  s.authors     = ["Brandan Lennox"]
+  s.email       = ["brandan@bclennox.com"]
+  s.homepage    = "https://github.com/bclennox/acts_as_featured"
+  s.date        = "2012-01-28"
+  s.summary     = %q{Designate a Rails model attribute as unique within a scope}
+  s.description = %q{Designates an attribute on this model to indicate "featuredness," where only one record within a given scope may be featured at a time.}
+
+  s.rubyforge_project = "acts_as_featured"
+
+  s.files = %w{
+    acts_as_featured.gemspec
+    Gemfile
+    MIT-LICENSE
+    README.markdown
+
+    lib/acts_as_featured.rb
+    lib/acts_as_featured/version.rb
+  }
+
+  s.test_files = %w{
+    spec/acts_as_featured_spec.rb
+    spec/models.rb
+    spec/spec_helper.rb
+  }
+
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sqlite3-ruby"
+end

data/lib/acts_as_featured.rb

@@ -0,0 +1,93 @@
+require 'acts_as_featured/version'
+
+module ActsAsFeatured
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    # Designates an attribute on this model to indicate "featuredness," where
+    # only one record within a given scope may be featured at a time.
+    #
+    # Pass in the name of the attribute and an options hash:
+    #
+    # * <tt>:scope</tt> - If given, designates the scope in which this model is featured. This would typically be a <tt>belongs_to</tt> association.
+    # * <tt>:create_scope</tt> - If <tt>true</tt>, creates a named scope using the name of the attribute given here. If it's a symbol, creates a named scope using that symbol.
+    #
+    #    class Project < ActiveRecord::Base
+    #      # no two Projects will ever have their @featured attributes set simultaneously
+    #      acts_as_featured :featured
+    #    end
+    #
+    #    class Photo < ActiveRecord::Base
+    #      # each account gets a favorite photo
+    #      belongs_to :account
+    #      acts_as_featured :favorite, :scope => :account
+    #    end
+    #
+    #    class Article < ActiveRecord::Base
+    #      # creates a named scope called Article.featured to return the featured article
+    #      acts_as_featured :main, :create_scope => :featured
+    #    end
+    def acts_as_featured(attribute, options = {})
+      cattr_accessor :featured_attribute
+      cattr_accessor :featured_attribute_scope
+
+      self.featured_attribute = attribute
+      self.featured_attribute_scope = options[:scope] || false
+
+      if scope_name = options[:create_scope]
+        scope_name = attribute if scope_name === true
+        scope scope_name, where(attribute => true).limit(1)
+      end
+
+      before_save :remove_featured_from_other_records
+      after_save :add_featured_to_first_record
+      before_destroy :add_featured_to_first_record_if_featured
+    end
+  end
+
+private
+
+  # <tt>before_save</tt> callback: If we're designating this record to be
+  # featured, we should clear that status on other records before saving this one.
+  def remove_featured_from_other_records
+    if scope && send(featured_attribute)
+      # I hope I find a better way to do this
+      scope.update_all(["#{featured_attribute} = ?", false], "id != #{id || 0}")
+    end
+  end
+
+  # <tt>after_save</tt> callback. If this save will result in no featured, just
+  # make the first record featured.
+  def add_featured_to_first_record
+    if scope && scope.count(:conditions => { featured_attribute => true }) == 0
+      scope.first.update_attribute(featured_attribute, true)
+    end
+  end
+
+  # <tt>before_destroy</tt> callback. If we destroy the featured, make the first
+  # unfeaturedmain the featured. If this was the last record, don't do anything.
+  def add_featured_to_first_record_if_featured
+    if scope && send(featured_attribute) && scope.count > 1
+      new_main = scope.find(:first, :conditions => { featured_attribute => false })
+      new_main.update_attribute(featured_attribute, true) unless new_main.nil?
+    end
+  end
+
+  def featured_attribute
+    @featured_attribute ||= self.class.featured_attribute
+  end
+
+  # Either the model class or the scope given to acts_as_featured (probably a
+  # belongs_to association).
+  def scope
+    association = self.class.featured_attribute_scope
+    @scope ||= if association
+      send(association).try(self.class.to_s.underscore.pluralize)
+    else
+      self.class
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsFeatured

data/lib/acts_as_featured/version.rb

@@ -0,0 +1,3 @@
+module ActsAsFeatured
+  VERSION = '0.1.2'
+end

data/spec/acts_as_featured_spec.rb

@@ -0,0 +1,107 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe ActsAsFeatured do
+  def featured(model)
+    model.find_all_by_featured(true)
+  end
+
+  describe "unscoped" do
+    before(:each) do
+      3.times { Thingy.create(:featured => false) }
+    end
+
+    after(:each) do
+      Thingy.delete_all
+    end
+
+    it 'should leave featured status alone when saving the currently featured thingy' do
+      originally_featured = Thingy.create(:featured => true)
+      featured(Thingy).first.should == originally_featured
+      originally_featured.save
+      featured(Thingy).first.should == originally_featured
+    end
+
+    it 'should remove featured status from the currently featured thingy when setting it on another thingy' do
+      originally_featured = Thingy.create(:featured => true)
+      will_be_featured = Thingy.create(:featured => false)
+
+      will_be_featured.featured = true
+      will_be_featured.save!
+
+      originally_featured.reload
+      will_be_featured.reload
+
+      featured(Thingy).should have(1).item
+      originally_featured.featured?.should be_false
+      will_be_featured.featured?.should be_true
+    end
+
+    it 'should set another thingy to be featured when removing featured status from the featured thingy' do
+      3.times { Thingy.create(:featured => false) }
+      originally_featured = Thingy.create(:featured => true)
+
+      originally_featured.featured = false
+      originally_featured.save!
+      originally_featured.reload
+
+      featured(Thingy).should have(1).item
+      originally_featured.featured?.should be_false
+    end
+
+    it 'should set another thingy to be featured when destroying the featured thingy' do
+      3.times { Thingy.create(:featured => false) }
+      originally_featured = Thingy.create(:featured => true)
+
+      originally_featured.destroy
+
+      featured(Thingy).should have(1).item
+    end
+  end
+
+  describe "with a scope" do
+    after(:each) do
+      ThingyAggregator.delete_all
+      ScopedThingy.delete_all
+    end
+
+    it 'should constrain featured status to scope' do
+      aggregator1 = ThingyAggregator.create
+      aggregator2 = ThingyAggregator.create
+
+      3.times { aggregator1.scoped_thingies.create(:featured => false) }
+      3.times { aggregator2.scoped_thingies.create(:featured => false) }
+      f1 = aggregator1.scoped_thingies.create(:featured => true)
+      f2 = aggregator2.scoped_thingies.create(:featured => true)
+
+      featured(ScopedThingy).should have(2).items
+
+      f1.update_attribute(:featured, false)
+
+      featured(ScopedThingy).should have(2).items
+      aggregator2.scoped_thingies.find_by_featured(true).should == f2
+    end
+
+    it 'should not explode when the scope is nil' do
+      expect {
+        ScopedThingy.create!(:featured => true)
+        featured(ScopedThingy).should have(1).item
+      }.not_to raise_error
+    end
+  end
+
+  describe "named scope" do
+    it 'should add a default named scope' do
+      DefaultNamedScopeThingy.should respond_to(:featured)
+    end
+
+    it 'should add a custom named scope' do
+      CustomNamedScopeThingy.should respond_to(:special)
+    end
+
+    it 'should return the featured thingy from the named scope' do
+      3.times { DefaultNamedScopeThingy.create!(:featured => false) }
+      t = DefaultNamedScopeThingy.create!(:featured => true)
+      DefaultNamedScopeThingy.featured.first.should == t
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'acts_as_featured')
+
+# a basic model
+class Thingy < ActiveRecord::Base
+  acts_as_featured :featured, :create_scope => true
+end
+
+# a model that belongs_to another model
+class ScopedThingy < ActiveRecord::Base
+  belongs_to :thingy_aggregator
+  acts_as_featured :featured, :scope => :thingy_aggregator
+end
+class ThingyAggregator < ActiveRecord::Base
+  has_many :scoped_thingies
+end
+
+# a model with a default named scope
+class DefaultNamedScopeThingy < ActiveRecord::Base
+  acts_as_featured :featured, :create_scope => true
+end
+
+# a model with a custom named scope
+class CustomNamedScopeThingy < ActiveRecord::Base
+  acts_as_featured :featured, :create_scope => :special
+end
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  [:thingies, :named_scope_thingies, :default_named_scope_thingies].each do |name|
+    create_table name, :force => true do |t|
+      t.boolean :featured
+    end
+  end
+
+  create_table :thingy_aggregators, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :scoped_thingies, :force => true do |t|
+    t.belongs_to :thingy_aggregator
+    t.boolean :featured
+  end
+end
+ActiveRecord::Migration.verbose = true

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => File.join(File.dirname(__FILE__), 'test.sqlite3'))
+
+require File.join(File.dirname(__FILE__), 'models')

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_featured
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Brandan Lennox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Designates an attribute on this model to indicate "featuredness," where only one record within a given scope may be featured at a time.
+email: 
+- brandan@bclennox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- acts_as_featured.gemspec
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- lib/acts_as_featured.rb
+- lib/acts_as_featured/version.rb
+- spec/acts_as_featured_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bclennox/acts_as_featured
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: acts_as_featured
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Designate a Rails model attribute as unique within a scope
+test_files: 
+- spec/acts_as_featured_spec.rb
+- spec/models.rb
+- spec/spec_helper.rb