acts_as_pickable 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+= Version 0.1.0
+* Gem existence started

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Maciej Mensfeld
+
+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/Manifest

@@ -0,0 +1,10 @@
+CHANGELOG.rdoc
+Gemfile
+MIT-LICENSE
+Manifest
+README.md
+Rakefile
+init.rb
+lib/acts_as_pickable.rb
+spec/acts_as_pickable_spec.rb
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,39 @@
+# ActsAsPickable
+## Install
+
+    gem install acts_as_pickable
+
+and in your Gemfile:
+    
+    gem 'acts_as_pickable'
+
+Model declaration:
+
+    class CoolClass < ActiveRecord::Base
+        acts_as_pickable :column_name (default - :picked)
+    end    
+
+## About
+
+Simple Rails gem allowing ActiveRecord models to be picked (selected).
+
+Requirements
+
+    table.boolean :picked, :default => false
+
+## Example
+
+    Example? Look into spec dir for rspec file :)    
+
+## 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) 2011 Maciej Mensfeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('acts_as_pickable', '0.1.0') do |p|
+  p.description    = "Rails gem allowing ActiveRecord models have always one element picked (selected)."
+  p.url            = "https://github.com/mensfeld/Acts-as-Pickable"
+  p.author         = "Maciej Mensfeld"
+  p.email          = "maciej@mensfeld.pl"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["rspec >=2.0.0", "active_record"]
+end
+

data/acts_as_pickable.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_pickable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maciej Mensfeld"]
+  s.cert_chain = ["/home/mencio/.cert_keys/gem-public_cert.pem"]
+  s.date = %q{2011-04-23}
+  s.description = %q{Rails gem allowing ActiveRecord models have always one element picked (selected).}
+  s.email = %q{maciej@mensfeld.pl}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.md", "lib/acts_as_pickable.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "MIT-LICENSE", "Manifest", "README.md", "Rakefile", "init.rb", "lib/acts_as_pickable.rb", "spec/acts_as_pickable_spec.rb", "spec/spec_helper.rb", "acts_as_pickable.gemspec"]
+  s.homepage = %q{https://github.com/mensfeld/Acts-as-Pickable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_pickable", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_pickable}
+  s.rubygems_version = %q{1.5.2}
+  s.signing_key = %q{/home/mencio/.cert_keys/gem-private_key.pem}
+  s.summary = %q{Rails gem allowing ActiveRecord models have always one element picked (selected).}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<active_record>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<active_record>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'acts_as_pickable'
+

data/lib/acts_as_pickable.rb

@@ -0,0 +1,96 @@
+module Acts
+  module AsPickable
+
+    def self.included(base)
+      base.extend AddActsAsMethod
+    end
+
+    module AddActsAsMethod
+
+      def acts_as_pickable(column = :picked)
+        class_eval <<-END
+          after_create :set_as_picked
+          after_destroy :pick_new_one
+          include Acts::AsPickable::InstanceMethods
+        END
+
+        cattr_accessor :pickable_column
+        self.pickable_column = column
+      end
+    end
+
+    module InstanceMethods
+
+      def self.included(aClass)
+        aClass.extend ClassMethods
+      end
+      
+      module ClassMethods
+
+        # Select new picked element
+        def new_picked
+          c = self.count
+          return nil if c == 0
+          if c == 1
+            return self.first
+          end
+
+          self.all.each do |q|
+            q.send("#{self.pickable_column}=",false)
+            q.save
+          end
+
+          s = self.random
+
+          s.send("#{self.pickable_column}=",true)
+          s.save
+          s
+        end
+
+        def random(skip_cache = false)
+          if ActiveRecord::Base.connection.adapter_name == 'SQLite'
+            rand = "Random()"
+          else
+            rand = "Rand()"
+          end
+
+          unless skip_cache
+            order(rand).first
+          else
+            uncached do
+              order(rand).first
+            end
+          end
+        end
+
+        def picked
+          self.where(self.pickable_column => true).first
+        end
+
+      end
+
+      # Sets current object as picked
+      def set_as_picked
+        self.class.where(self.class.pickable_column => true).each  do |q|
+          if q.send(self.class.pickable_column)
+            q.send("#{self.class.pickable_column}=", false)
+            q.save
+          end
+        end
+        self.send("#{self.class.pickable_column}=", true)
+        self.save
+      end
+
+      private
+
+      def pick_new_one
+        if self.send(self.class.pickable_column)
+          self.class.where("id <> ?", self.id).first.set_as_picked if self.class.count > 0
+        end
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::AsPickable)

data/spec/acts_as_pickable_spec.rb

@@ -0,0 +1,213 @@
+require 'spec_helper'
+
+ROOT = File.expand_path(File.dirname(__FILE__))
+
+class CoolElement < ActiveRecord::Base
+  acts_as_pickable
+end
+
+class CoolerElement < ActiveRecord::Base
+  acts_as_pickable :selected
+end
+
+describe CoolElement do
+  subject { CoolElement }
+  before(:each){ subject.destroy_all }
+
+  context "when there is no elements" do
+    it "should return nothing" do
+      subject.new_picked.should == nil
+    end
+  end
+
+  context "when there is only one element" do
+
+    it "should be returned all the time" do
+      c = subject.create
+      10.times do
+        subject.picked.should == c
+      end
+    end
+
+    it "should be picked all the time" do
+      c = subject.create
+      10.times do
+        subject.new_picked.should == c
+      end
+    end
+  
+    context "and we destroy it" do
+      it "should return nothing" do
+        c = subject.create
+        c.destroy
+        subject.picked.should == nil
+      end
+    end
+
+  end
+
+  context "when we have a lot of elements" do
+    it "should pick each time a new one" do
+      n = subject.create
+      n.save!
+      n.reload
+      n.picked.should == true
+      s = subject.create
+      s.save!
+      n.reload
+      10.times do
+        if n != s
+          n.should_not eql s
+        else
+          s = subject.new_daylee
+          n.reload
+          next
+        end
+        n.should_not eql s
+      end
+    end
+  
+    it "should set as picked when created" do
+      n = subject.create
+      n.save!
+      n.reload
+      n.picked.should == true
+    end
+
+    it "should pick a new when old picked is deleted" do
+      10.times do
+        subject.delete_all
+        b = subject.create
+        n = subject.create
+        subject.picked.should == n
+        subject.picked.destroy
+        b.reload
+        subject.picked.should == b
+      end
+    end
+
+    it "force all to be daylee and pick new daylee" do
+        subject.delete_all
+        b = subject.create
+        n = subject.create
+        c = subject.create
+        b.picked = true
+        n.picked = true
+        b.save!
+        n.save!
+        c.save!
+        c.reload
+        n.reload
+        b.reload
+        subject.new_picked
+        subject.all.each do |s|
+          if subject.picked != s
+            s.picked.should == false
+          end
+        end
+    end
+
+  end
+
+end
+
+describe CoolerElement do
+  subject { CoolerElement }
+  before(:each){ subject.destroy_all }
+
+  context "when there is no elements" do
+    it "should return nothing" do
+      subject.new_picked.should == nil
+    end
+  end
+
+  context "when there is only one element" do
+
+    it "should be returned all the time" do
+      c = subject.create
+      10.times do
+        subject.picked.should == c
+      end
+    end
+
+    it "should be picked all the time" do
+      c = subject.create
+      10.times do
+        subject.new_picked.should == c
+      end
+    end
+
+    context "and we destroy it" do
+      it "should return nothing" do
+        c = subject.create
+        c.destroy
+        subject.picked.should == nil
+      end
+    end
+
+  end
+
+  context "when we have a lot of elements" do
+    it "should pick each time a new one" do
+      n = subject.create
+      n.save!
+      n.reload
+      n.selected.should == true
+      s = subject.create
+      s.save!
+      n.reload
+      10.times do
+        if n != s
+          n.should_not eql s
+        else
+          s = subject.new_daylee
+          n.reload
+          next
+        end
+        n.should_not eql s
+      end
+    end
+
+    it "should set as picked when created" do
+      n = subject.create
+      n.save!
+      n.reload
+      n.selected.should == true
+    end
+
+    it "should pick a new when old picked is deleted" do
+      10.times do
+        subject.delete_all
+        b = subject.create
+        n = subject.create
+        subject.picked.should == n
+        subject.picked.destroy
+        b.reload
+        subject.picked.should == b
+      end
+    end
+
+    it "force all to be daylee and pick new daylee" do
+        subject.delete_all
+        b = subject.create
+        n = subject.create
+        c = subject.create
+        b.selected = true
+        n.selected = true
+        b.save!
+        n.save!
+        c.save!
+        c.reload
+        n.reload
+        b.reload
+        subject.new_picked
+        subject.all.each do |s|
+          if subject.picked != s
+            s.selected.should == false
+          end
+        end
+    end
+
+  end
+
+end

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 'rubygems'
+require 'sqlite3'
+require 'active_record'
+require 'acts_as_pickable'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database  => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+    create_table :cool_elements do |table|
+        table.boolean :picked, :default => 0
+    end
+
+    create_table :cooler_elements do |table|
+        table.boolean :selected, :default => 0
+    end
+
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_pickable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZtYWNp
+  ZWoxGDAWBgoJkiaJk/IsZAEZFghtZW5zZmVsZDESMBAGCgmSJomT8ixkARkWAnBs
+  MB4XDTExMDQwOTA5NDcyMloXDTEyMDQwODA5NDcyMlowPzEPMA0GA1UEAwwGbWFj
+  aWVqMRgwFgYKCZImiZPyLGQBGRYIbWVuc2ZlbGQxEjAQBgoJkiaJk/IsZAEZFgJw
+  bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0+nG3V4/exIeiJ0IN+
+  wVfq8Utcu4Qpo+58EIVMIu3FiK+8w6MBvatZnUrRu12pqWLw9xrUkCiYeRErD+jF
+  AmdggIM/tu9CcjvURXH7VeTzOVA+pnV+eJWMD61o8HljFVcb/nyEYYVKErtr9/O4
+  QrIGv5lnszq1PMj2sBMy2gOP1YnzawncMLmkpp/T5SU4JZ5gAktGMRVz8RxmZzF5
+  6NVqFLbuqSRSU5U//WJvZVJt8dycCGgQzBM4Vi3nkOWyjIF0BANf1TqnlU2u6s8d
+  UK1AoDZfg5feef5e8eqoomHebX1opNGM/SOQhu3LRgax4rJfnl6VS3I2wighohsf
+  AgcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGlrWBqxVieAPk7NEzBDp
+  kM+iAMMwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQAJMoyBaJs8boiz
+  lFpbw6MWjk+7ZhqoHpFrWEV4nzb5GzyHZ7GU/pa1fSEQR0SCs+LnTLQbAYNQyUTT
+  O+UsTuA7xzI//v6cSodv3Q9NbfoDlou74xv1NXorWoosQFMpVWrXv+c/1RqU3cq4
+  WUr+rRiveEXG4tXOwkrpX8KH8xVp2vQZcGw3AXPqhzfqDGzpHd6ws3lk+8HoSrSo
+  2L68tDoxraF2Z2toAg9vfFw1+mOeDk1xVIPVcBy3tJxstHfHGHlQuMiRiDQX2b2D
+  YYU8UWVt2841IwB5Dgl4O+atXhe9ZTBO0W32pl4Bq5CP9lhQRT1KL7sxfznJlF7Y
+  BH3YFsdk
+  -----END CERTIFICATE-----
+
+date: 2011-04-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Rails gem allowing ActiveRecord models have always one element picked (selected).
+email: maciej@mensfeld.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.md
+- lib/acts_as_pickable.rb
+files: 
+- CHANGELOG.rdoc
+- Gemfile
+- MIT-LICENSE
+- Manifest
+- README.md
+- Rakefile
+- init.rb
+- lib/acts_as_pickable.rb
+- spec/acts_as_pickable_spec.rb
+- spec/spec_helper.rb
+- acts_as_pickable.gemspec
+has_rdoc: true
+homepage: https://github.com/mensfeld/Acts-as-Pickable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_pickable
+- --main
+- README.md
+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: "1.2"
+requirements: []
+
+rubyforge_project: acts_as_pickable
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Rails gem allowing ActiveRecord models have always one element picked (selected).
+test_files: []
+