activerecord_random 1.0.0.rc

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 3.0.1'
+
+group :development, :test do
+  gem 'mysql2', '~> 0.2'
+
+  if RUBY_VERSION =~ /1\.9\.\d/
+    gem('ruby-debug-base19', '=0.11.23') if RUBY_VERSION == '1.9.1'
+    gem 'ruby-debug19', '~> 0.11.0'
+  else
+    gem 'ruby-debug'
+  end
+
+  gem 'rspec', '~> 2.0'
+  gem 'factory_girl_rails', '~> 1.0.0'
+  gem 'database_cleaner', '~> 0.6.0'
+end

data/Gemfile.lock

@@ -0,0 +1,106 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.2)
+    database_cleaner (0.6.0)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.2)
+    factory_girl_rails (1.0)
+      factory_girl (~> 1.3)
+      rails (>= 3.0.0.beta4)
+    i18n (0.4.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mysql2 (0.2.6)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.4)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.1)
+  database_cleaner (~> 0.6.0)
+  factory_girl_rails (~> 1.0.0)
+  mysql2 (~> 0.2)
+  rspec (~> 2.0)
+  ruby-debug19 (~> 0.11.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gnomeslab, Lda.
+
+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,50 @@
+## Introduction
+
+ActiveRecord Random is a Ruby Gem that empowers your ActiveRecord Models with the ability to return a random record without using SQL RAND().
+
+## Compatibility
+
+Developed to be compatible with
+
+* **Rails:** v3.0.x
+* **Ruby:** v1.8.7, v1.9.1 or v1.9.2
+
+## Installation
+
+You can install ActiveRecord Random straight from Rubygems. Thanks to Bundler you just need to add this to your Gemfile
+
+<pre>
+  gem 'activerecord_random'
+</pre>
+
+## Examples
+
+Scenario: You have a collection of Questions (model name = Question) and you wish to randomly select one of them.
+
+<pre>
+  Question.random #=> random random instance of Question
+</pre>
+
+Alternatively you can use the :random finder:
+
+<pre>
+  Question.find(:random) #=> random instance of Question
+</pre>
+
+That simple
+
+## Documentation
+
+This gem's documentation documentation is available at **TODO**
+
+## License
+
+Copyright (c) 2010 Gnomeslab, Lda., released under the MIT license. For more information regarding MIT license, please check our [MIT license file](http://github.com/GnomesLab/activerecord_random/blob/master/MIT-LICENSE)
+
+## Feedback, issues and contributions
+
+If you have an issue with this Gem please create a ticket in our [issue tracker](http://gnomeslab.lighthouseapp.com/projects/63976-activerecord_random/overview).
+
+Feel free to fork this project at any time and submit your changes (along with their respective tests).
+
+Should you just wish to provide feedback or say hi, you can always contact us directly through diogo (dot) almeida (at) gnomeslab (dot) com

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Generate documentation for the ActiveRecord Random Ruby Gem'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecord Random'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.ruby_opts = '-w'
+  end
+
+  task :default => :spec
+rescue LoadError
+  raise 'RSpec could not be loaded. Run `bundle install` to get all development dependencies.'
+end
+
+# Rubygems
+namespace :rubygems do
+  gemspec = eval(File.read('activerecord_random.gemspec'))
+  Rake::GemPackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+
+  desc "build the gem and release it to rubygems.org"
+  task :release => :gem do
+    sh "rake spec"
+    sh "gem push pkg/activerecord_random-#{gemspec.version}.gem"
+  end
+end

data/lib/activerecord_random.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+
+  module Random #:nodoc:
+
+    # ActiveRecord::Base.random returns a random instance of self.
+    #
+    # This method does not use SQL RAND(). Instead, it performs a record count and then uses Ruby rand.
+    #
+    # Example
+    #   Question.random #=> Random instance of random
+    #
+    # ActiveRecord::Base.random is a safe method, thus when your model's table is empty it will simply return nil.
+    def random
+      where("id >= ?", rand(self.count + 1)).first
+    end
+
+  end # Random
+
+end # ActiveRecord
+
+ActiveRecord::Base.send :extend, ActiveRecord::Random

data/lib/ext/active_record/finder_methods/random.rb

@@ -0,0 +1,11 @@
+module ActiveRecord
+
+  module FinderMethods
+
+    def find(*args)
+      args == [:random] ? self.random : super(args)
+    end
+
+  end # FinderMethods
+
+end # ActiveRecord

data/spec/db/models.rb

@@ -0,0 +1,2 @@
+class Question < ActiveRecord::Base
+end

data/spec/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define(:version => 20101111160738) do
+
+  create_table "questions", :force => true do |t|
+    t.string   "title",     :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/factories/questions_factory.rb

@@ -0,0 +1,3 @@
+Factory.define(:question) do |q|
+  q.sequence(:title) { |n| "Question ##{n}" }
+end

data/spec/lib/activerecord_random_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe ActiveRecord::Random do
+
+  describe "Class Methods" do
+
+    it "returns a random instance of the invoked ActiveRecord Model" do
+      10.times { |n| Factory.create(:question) }
+      Question.random.should be_an_instance_of Question
+    end
+
+    it "returns nil when no records are found" do
+      Question.random.should be_nil
+    end
+
+  end # Class Methods
+
+  describe "Random finder" do
+
+    it "Question.find(:random) returns a random instance of Question" do
+      10.times { |n| Factory.create(:question) }
+      Question.find(:random).should be_an_instance_of Question
+    end
+
+    it "also returns nil when no records are found by the random finder" do
+      Question.find(:random).should be_nil
+    end
+
+  end # Random finder
+
+end # ActiveRecord::Random

data/spec/spec_helper.rb

@@ -0,0 +1,72 @@
+$:.unshift File.dirname(__FILE__) unless $:.include? File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '..') unless $:.include? File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'erb'
+  require 'init'
+  require 'logger'
+  require 'rspec'
+  require 'active_record'
+  require 'database_cleaner'
+  require 'factory_girl'
+
+  RSpec.configure do |config|
+    config.debug = true
+    # == Mock Framework
+    config.mock_with :rspec
+
+    # database_cleaner
+    config.before(:suite) do
+      DatabaseCleaner.strategy = :transaction
+      DatabaseCleaner.clean_with(:truncation)
+    end
+
+    config.before(:each) do
+      DatabaseCleaner.start
+    end
+
+    config.after(:each) do
+      DatabaseCleaner.clean
+    end
+  end
+rescue LoadError => load_error
+  puts "Please run bundle install"
+rescue StandardError => e
+  puts "Something went wrong while loading the environment."
+  throw e
+end
+
+# Requires supporting files with custom matchers and macros, etc, in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Requires all supporting factories
+Dir.glob(File.join(File.dirname(__FILE__), 'factories', '*_factory.rb')).each { |f| require f }
+
+# ActiveRecord Test database configurations
+database_yml_file = File.expand_path('../config/database.yml', __FILE__)
+
+begin
+  if File.exists?(database_yml_file)
+    active_record_configuration = YAML.load_file(database_yml_file)['test']
+    ActiveRecord::Base.establish_connection(active_record_configuration)
+
+    File.truncate(File.join(File.dirname(__FILE__), 'log', 'test.log'), 0)
+
+    ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), 'log', 'test.log'))
+
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+
+      load File.join(File.dirname(__FILE__), 'db', 'schema.rb')
+      load File.join(File.dirname(__FILE__), 'db' , 'models.rb')
+    end
+
+    # The config/database.yml is in the spec folder
+    DatabaseCleaner.app_root = File.expand_path('spec')
+  else
+    raise "Please create #{database_yml} first. Take a look at the database.sample.yml in the config folder."
+  end
+rescue StandardError => e
+  puts "Something went wrong while attempting to load your database file, or while configuring ActiveRecord."
+  throw e
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord_random
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0
+  - rc
+  version: 1.0.0.rc
+platform: ruby
+authors: 
+- Gnomeslab, Lda.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-12 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id006
+description: ActiveRecord Random is a Ruby Gem that empowers your ActiveRecord Models with the ability to return a random record without using SQL RAND().
+email: 
+- mail@gnomeslab.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/activerecord_random.rb
+- lib/ext/active_record/finder_methods/random.rb
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/db/models.rb
+- spec/db/schema.rb
+- spec/factories/questions_factory.rb
+- spec/lib/activerecord_random_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/GnomesLab/activerecord_random/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Returns a random instance of an ActiveRecord Model
+test_files: []
+