rand-orders 0.0.3

data/.gitignore

@@ -0,0 +1,26 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+/.idea
+.rvmrc
+.rbenv
+doc/
+yardoc/
+Gemfile.lock
+*.sqlite3
+/spec/db/mysql.yml
+/spec/db/postgresql.yml
+/spec/db/sqlite.yml

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--readme README.md
+-
+README.md
+LICENSE

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem "activerecord", :require => "active_record"
+gem "sqlite3"
+gem "pg"
+gem "mysql"#, '2.8.1'
+gem "activerecord-mysql-adapter"
+gem "activerecord-postgresql-adapter"
+
+# Specify your gem's dependencies in rand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 santaux
+
+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/README.md

@@ -0,0 +1,68 @@
+# Rand::Orders
+
+This gem provides several methods to fetch random records from database.
+
+## Tests
+
+To run tests, first, please create and fill with correct values these configuration files:
+
+* ./spec/db/mysql.yml
+* ./spec/db/postgresql.yml
+* ./spec/db/sqlite.yml
+
+You could find configuration examples into ./spec/db directory.
+Then you need to create these databases by internal rake task for each database:
+
+    ADAPTER=sqlite bundle exec rake test:db:migrate
+    ADAPTER=postgresql bundle exec rake test:db:migrate
+    ADAPTER=mysql bundle exec rake test:db:migrate
+
+The you could run them and check that all is fine:
+
+    $ rspec spec/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rand-orders'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rand-orders
+
+## Usage
+
+```ruby
+# It will work for any ActiveRecord inherited class:
+( For example, this model has 'amount' integer field)
+class Item < ActiveRecord::Base; end
+
+# Let's get some records ordered randomly:
+Item.random
+
+# Or get some random records with field value between 2 and 5:
+# (This is the same as: Item.where("amount > 2 AND amount < 5").random)
+Item.random_in_range(:amount, (2..5)) #
+
+# Also we can fetch from database only the fields equal to some value:
+# (This is the same as: Item.where(:amount => 1).random)
+Item.random_equal(:amount, 1)
+
+# If we want to get values only from one of fields, use 'select_random' method:
+# (This is the same as: Item.random.pluck(:amount))
+Item.select_random(:amount)
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'yard'
+require './spec/db/db_creator'
+
+# Generates documentation:
+YARD::Rake::YardocTask.new
+
+# RSpec executing:
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+namespace :test do
+  desc "Create database and table for specs"
+  namespace :db do
+    task :migrate do
+      adapter_name = ENV['ADAPTER'] || 'sqlite'
+      db_creator = DBCreator.new(adapter_name)
+      db_creator.migrate
+    end
+  end
+end

data/lib/rand.rb

@@ -0,0 +1,11 @@
+require "rand/version"
+require "rand/orders"
+require "active_record"
+
+class ActiveRecord::Relation
+  include Rand::Orders::Relation
+end
+
+class ActiveRecord::Base
+  extend Rand::Orders::Base
+end

data/lib/rand/orders.rb

@@ -0,0 +1,104 @@
+module Rand
+  module Orders
+    module Relation
+      ##
+      # Returns randomly sorted records from database.
+      #
+      # == Returns:
+      # ActiveRecord::Relation object with order(...) statement.
+      # == Example:
+      # Item.where(:user_id => 1).random
+      def random
+        relation = clone
+        relation.order_values += [random_clause]
+        relation
+      end
+
+      ##
+      # Returns randomly sorted records from database with field value
+      # in specified range.
+      #
+      # == Parameters:
+      # field_name::
+      #   A name of the field
+      # range::
+      #   Range object with MIN and MAX values for specified field.
+      #
+      # == Returns:
+      # ActiveRecord::Relation object with order(...) and 
+      # where("#{field_name} > #{range.min} AND #{field_name} < #{range.max}") statements
+      # == Example:
+      # Item.random_in_range(:amount, (2..5)).limit(10)
+      def random_in_range(field_name, range)
+        relation = random
+        relation.where_values += build_where("#{field_name} > #{range.min} AND #{field_name} < #{range.max}", [])
+        relation
+      end
+
+      ##
+      # Returns randomly sorted records from database with field value
+      # equal to specified parameter.
+      #
+      # == Parameters:
+      # field_name::
+      #   A name of the field or range comparing.
+      # value::
+      #   A value of the specified field.
+      #
+      # == Returns:
+      # ActiveRecord::Relation object with order(...) and where(field_name => value) statements
+      # == Example:
+      # Item.random_equal(:user_id, 1)
+      def random_equal(field_name, value)
+        relation = random
+        relation.where_values += build_where({field_name.to_sym => value}, [])
+        relation
+      end
+
+      ##
+      # Returns randomly sorted array of specified field values.
+      #
+      # == Parameters:
+      # field_name::
+      #   A name of the field to return.
+      #
+      # == Returns:
+      # Array of the specified field values.
+      # == Example:
+      # Item.select_random(:amount)
+      def select_random(field_name)
+        random.pluck(field_name)
+      end
+
+      # Sets random clause for each database.
+      def random_clause
+        case connection.adapter_name
+          when /mysql/i
+            'RAND()'
+          when /sqlite|postgres/i
+            'RANDOM()'
+          else
+            raise "Rand::Orders Error: Unknown adapter!"
+        end
+      end
+    end
+
+    module Base
+      def random
+        relation.random
+      end
+
+      def random_in_range(field_name, range)
+        relation.random_in_range(field_name, range)
+      end
+
+      def random_equal(field_name, value)
+        relation.random_equal(field_name, value)
+      end
+
+      def select_random(field_name)
+        relation.select_random(field_name)
+      end
+    end
+  end
+end

data/lib/rand/version.rb

@@ -0,0 +1,5 @@
+module Rand
+  module Orders
+    VERSION = "0.0.3"
+  end
+end

data/rand-orders.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rand/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rand-orders"
+  gem.version       = Rand::Orders::VERSION
+  gem.authors       = ["santaux"]
+  gem.email         = ["santaux@gmail.com"]
+  gem.description   = %q{Simple gem which provides random ordering for mysql, postgresql and sqlite}
+  gem.summary       = %q{Simple gem which provides random ordering for mysql, postgresql and sqlite}
+  gem.homepage      = "http://github.com/santaux/rand"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "pg"
+  gem.add_development_dependency "mysql2"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "redcarpet", "~> 1.17"
+  gem.add_development_dependency "yard", "~> 0.7.5"
+  gem.add_development_dependency "rspec-core", "~> 2.0"
+  gem.add_development_dependency "rspec-expectations", "~> 2.0"
+  gem.add_development_dependency "rr", "~> 1.0"
+  gem.add_development_dependency "machinist", ">= 2.0.0.beta2"
+  gem.add_development_dependency "faker"
+end

data/spec/db/db_creator.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+require 'rubygems'
+require 'active_record'
+require 'active_support/inflector'
+
+class DBCreator
+
+  attr_reader :adapter, :adapter_name
+
+  def initialize(adapter_name)
+    @adapter_name = adapter_name
+    @adapter = "#{adapter_name.to_s}_adapter".camelize.constantize.new
+  end
+
+  def migrate
+    @adapter.parse_config(@adapter_name)
+    @adapter.create_db
+    @adapter.establish_connection
+    @adapter.create_tables
+  end
+
+  def establish_connection
+    @adapter.parse_config(@adapter_name)
+    @adapter.establish_connection
+  end
+
+  def connection
+    @_connection ||= ActiveRecord::Base.connection
+  end
+
+  def table_exists?
+    connection.table_exists? 'items'
+  end
+end
+
+class DBAdapter
+
+  attr_reader :config
+
+  def parse_config(config_name)
+    path = File.dirname(File.expand_path(__FILE__)) + "/#{config_name}.yml"
+    @config = YAML::load(File.open(path))['test']
+  end
+
+  def establish_connection
+    ActiveRecord::Base.establish_connection(@config)
+  end
+
+  def create_db
+    raise "Do something with me. I'm abstract"
+  end
+
+  def create_tables
+    ActiveRecord::Base.connection.create_table(:items, :force => true) do |t|
+      t.string   "name"
+      t.integer  "amount"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+end
+
+class MysqlAdapter < DBAdapter
+  def create_db
+    %x{mysql -e 'create database #{@config['database']};' -h localhost -u #{ENV['USERNAME'] || @config['username']} --password=#{ENV['PASSWORD'] || @config['password']}}
+  end
+end
+
+class PostgresqlAdapter < DBAdapter
+  def create_db
+    %x{createdb --owner=#{ENV['USERNAME'] || @config['username']} #{@config['database']}}
+  end
+end
+
+class SqliteAdapter < DBAdapter
+  def create_db
+    %x{touch ./#{@config['database']}}
+  end
+end

data/spec/db/mysql.yml.example

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql2
+  host: localhost
+  port: 5432
+  database: rand_orders_test
+  username: root
+  password:

data/spec/db/postgresql.yml.example

@@ -0,0 +1,8 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  host: localhost
+  port: 5432
+  database: rand_orders_test
+  username: postgres
+  password:

data/spec/db/sqlite.yml.example

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: development.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/fixtures/blueprints.rb

@@ -0,0 +1,8 @@
+require 'machinist/active_record'
+require 'faker'
+require './spec/fixtures/item'
+
+Item.blueprint do
+  name { Faker::Lorem.word }
+  amount { rand(1..20) }
+end

data/spec/fixtures/item.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+
+class Item < ActiveRecord::Base; end

data/spec/rand-orders/rand_orders_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require 'fixtures/item'
+require 'db/db_creator'
+require 'rand'
+
+describe Rand::Orders do
+  %w[sqlite postgresql mysql].each do |adapter|
+    context adapter do
+      before(:all) do
+        @db_creator = DBCreator.new adapter
+        @db_creator.establish_connection
+      end
+
+      before(:each) do
+        Item.delete_all
+
+        @items = []
+        5.times { |i| @items << Item.make!(amount: i) }
+      end
+
+      context "random method" do
+        it "should return 5 records" do
+          Item.random.size.should be_equal(5)
+        end
+      end
+
+      context "random_in_range method" do
+        it "should return 2 records" do
+          Item.random_in_range(:amount, (2..5)).size.should be_equal(2)
+        end
+      end
+
+      context "random_equal method" do
+        it "should return item with amount equal 1" do
+          Item.random_equal(:amount, 1).first.amount.should be_equal(1)
+        end
+      end
+
+      context "select_random method" do
+        it "should return only selected field" do
+          Item.select_random(:amount).first.class.should be_equal(Fixnum)
+        end
+      end
+    end
+  end
+end

data/spec/rand-orders/stubed_rand_orders_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require 'fixtures/item'
+require 'db/db_creator'
+
+describe Rand::Orders do
+  %w[sqlite postgresql mysql].each do |adapter|
+    context adapter do
+      before(:all) do
+        @db_creator = DBCreator.new adapter
+        @db_creator.establish_connection
+      end
+
+      before(:each) do
+        Item.delete_all
+
+        @items = []
+        5.times { |i| @items << Item.make!(amount: i) }
+
+        stub(Item).random { Item.all }
+        stub(Item).random_in_range { Item.all[1..2] }
+        stub(Item).random_equal { Item.all[1] }
+        stub(Item).select_random { |field| Item.pluck(field) }
+      end
+
+      context "random method" do
+        it "should return 5 records" do
+          Item.random.size.should be_equal(5)
+        end
+      end
+
+      context "random_in_range method" do
+        it "should return 2 records" do
+          Item.random_in_range(:amount, (2..3)).size.should be_equal(2)
+        end
+      end
+
+      context "random_equal method" do
+        it "should return item with amount equal 1" do
+          Item.random_equal(:amount, 1).amount.should be_equal(1)
+        end
+      end
+
+      context "select_random method" do
+        it "should return only selected field" do
+          Item.select_random(:amount).first.class.should be_equal(Fixnum)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rand'
+require 'machinist'
+require 'fixtures/blueprints'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: rand-orders
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- santaux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: machinist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem which provides random ordering for mysql, postgresql and sqlite
+email:
+- santaux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rand.rb
+- lib/rand/orders.rb
+- lib/rand/version.rb
+- pkg/rand-orders-0.0.1.gem
+- pkg/rand-orders-0.0.2.gem
+- rand-orders.gemspec
+- spec/db/db_creator.rb
+- spec/db/mysql.yml.example
+- spec/db/postgresql.yml.example
+- spec/db/sqlite.yml.example
+- spec/fixtures/blueprints.rb
+- spec/fixtures/item.rb
+- spec/rand-orders/rand_orders_spec.rb
+- spec/rand-orders/stubed_rand_orders_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/santaux/rand
+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'
+      segments:
+      - 0
+      hash: -843775351796594452
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -843775351796594452
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple gem which provides random ordering for mysql, postgresql and sqlite
+test_files:
+- spec/db/db_creator.rb
+- spec/db/mysql.yml.example
+- spec/db/postgresql.yml.example
+- spec/db/sqlite.yml.example
+- spec/fixtures/blueprints.rb
+- spec/fixtures/item.rb
+- spec/rand-orders/rand_orders_spec.rb
+- spec/rand-orders/stubed_rand_orders_spec.rb
+- spec/spec_helper.rb
+has_rdoc: