activerecord-turntable 1.0.0

data/lib/active_record/turntable/shard.rb

@@ -0,0 +1,48 @@
+module ActiveRecord::Turntable
+  class Shard
+    DEFAULT_CONFIG = {
+      "connection" => (defined?(Rails) ? Rails.env : "development")
+    }.with_indifferent_access
+
+    def initialize(shard_spec)
+      @config = DEFAULT_CONFIG.merge(shard_spec)
+      @name = @config["connection"]
+    end
+
+    def connection_pool
+      @connection_pool ||= retrieve_connection_pool
+    end
+
+    def connection
+      connection = connection_pool.connection
+      connection.turntable_shard_name = name
+      connection
+    end
+
+    def name
+      @name
+    end
+
+    private
+
+    def retrieve_connection_pool
+      ActiveRecord::Base.turntable_connections[name] ||=
+        begin
+          config = ActiveRecord::Base.configurations[Rails.env]["shards"][name]
+          raise ArgumentError, "Unknown database config: #{name}, have #{ActiveRecord::Base.configurations.inspect}" unless config
+          ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec_for(config))
+        end
+    end
+
+    def spec_for(config)
+      begin
+        require "active_record/connection_adapters/#{config['adapter']}_adapter"
+      rescue LoadError => e
+        raise "Please install the #{config['adapter']} adapter: `gem install activerecord-#{config['adapter']}-adapter` (#{e})"
+      end
+      adapter_method = "#{config['adapter']}_connection"
+      ActiveRecord::Base::ConnectionSpecification.new(config, adapter_method)
+    end
+  end
+end
+

data/lib/active_record/turntable/sql_tree_patch.rb

@@ -0,0 +1,199 @@
+require 'sql_tree'
+require 'active_support/core_ext/kernel/reporting'
+
+module SQLTree
+  class << self
+    attr_accessor :identifier_quote_field_char
+  end
+  self.identifier_quote_field_char = '`'
+end
+
+class SQLTree::Token
+  KEYWORDS << 'BINARY'
+  KEYWORDS << 'LIMIT'
+  KEYWORDS << 'OFFSET'
+  const_set('BINARY', Class.new(SQLTree::Token::Keyword))
+  const_set('LIMIT', Class.new(SQLTree::Token::Keyword))
+  const_set('OFFSET', Class.new(SQLTree::Token::Keyword))
+end
+
+class SQLTree::Tokenizer
+  def tokenize_quoted_string(&block) # :yields: SQLTree::Token::String
+    string = ''
+    until next_char.nil? || current_char == "'"
+      string << (current_char == "\\" ? instance_eval("%@\\#{next_char.gsub('@', '\@')}@") : current_char)
+    end
+    handle_token(SQLTree::Token::String.new(string), &block)
+  end
+end
+
+module SQLTree::Node
+  class Base
+    def quote_field_name(field_name)
+      "#{SQLTree.identifier_quote_field_char}#{field_name}#{SQLTree.identifier_quote_field_char}"
+    end
+  end
+
+  class SelectQuery < Base
+    child :offset
+
+    def to_sql(options = {})
+      raise "At least one SELECT expression is required" if self.select.empty?
+      sql = (self.distinct) ? "SELECT DISTINCT " : "SELECT "
+      sql << select.map { |s| s.to_sql(options) }.join(', ')
+      sql << " FROM "     << from.map { |f| f.to_sql(options) }.join(', ') if from
+      sql << " WHERE "    << where.to_sql(options) if where
+      sql << " GROUP BY " << group_by.map { |g| g.to_sql(options) }.join(', ') if group_by
+      sql << " ORDER BY " << order_by.map { |o| o.to_sql(options) }.join(', ') if order_by
+      sql << " HAVING "   << having.to_sql(options) if having
+      sql << " LIMIT "    << limit.map {|f| f.to_sql(options) }.join(', ') if limit
+      sql << " OFFSET "   << offset.to_sql(options) if offset
+      return sql
+    end
+
+    def self.parse(tokens)
+      select_node = self.new
+      tokens.consume(SQLTree::Token::SELECT)
+
+      if SQLTree::Token::DISTINCT === tokens.peek
+        tokens.consume(SQLTree::Token::DISTINCT)
+        select_node.distinct = true
+      end
+
+      select_node.select   = parse_list(tokens, SQLTree::Node::SelectDeclaration)
+      select_node.from     = self.parse_from_clause(tokens)   if SQLTree::Token::FROM === tokens.peek
+      select_node.where    = self.parse_where_clause(tokens)  if SQLTree::Token::WHERE === tokens.peek
+      if SQLTree::Token::GROUP === tokens.peek
+        select_node.group_by = self.parse_group_clause(tokens)
+        select_node.having   = self.parse_having_clause(tokens) if SQLTree::Token::HAVING === tokens.peek
+      end
+      select_node.order_by = self.parse_order_clause(tokens) if SQLTree::Token::ORDER === tokens.peek
+      if SQLTree::Token::LIMIT === tokens.peek and list = self.parse_limit_clause(tokens)
+        select_node.offset = list.shift if list.size > 1
+        select_node.limit  = list.shift
+      end
+      select_node.offset = self.parse_offset_clause(tokens) if SQLTree::Token::OFFSET === tokens.peek
+      return select_node
+    end
+
+    def self.parse_limit_clause(tokens)
+      tokens.consume(SQLTree::Token::LIMIT)
+      self.parse_list(tokens, SQLTree::Node::Expression)
+    end
+
+    def self.parse_offset_clause(tokens)
+      tokens.consume(SQLTree::Token::OFFSET)
+      Expression.parse(tokens)
+    end
+  end
+
+  class SubQuery < SelectQuery
+    def to_sql(options = {})
+      "("+super(options)+")"
+    end
+
+    def self.parse(tokens)
+      tokens.consume(SQLTree::Token::LPAREN)
+      select_node = super(tokens)
+      tokens.consume(SQLTree::Token::RPAREN)
+      return select_node
+    end
+  end
+
+  class TableReference < Base
+    def to_sql(options={})
+      sql = (SQLTree::Node::SubQuery === table) ? table.to_sql : quote_field_name(table)
+      sql << " AS " << quote_field_name(table_alias) if table_alias
+      return sql
+    end
+
+    def self.parse(tokens)
+      if SQLTree::Token::Identifier === tokens.peek
+        tokens.next
+        table_reference = self.new(tokens.current.literal)
+        if SQLTree::Token::AS === tokens.peek || SQLTree::Token::Identifier === tokens.peek
+          tokens.consume(SQLTree::Token::AS) if SQLTree::Token::AS === tokens.peek
+          table_reference.table_alias = tokens.next.literal
+        end
+        return table_reference
+      elsif SQLTree::Token::SELECT === tokens.peek(2)
+        table_reference = self.new(SQLTree::Node::SubQuery.parse(tokens))
+        if SQLTree::Token::AS === tokens.peek || SQLTree::Token::Identifier === tokens.peek
+          tokens.consume(SQLTree::Token::AS) if SQLTree::Token::AS === tokens.peek
+          table_reference.table_alias = tokens.next.literal
+        end
+        table_reference
+      else
+        raise SQLTree::Parser::UnexpectedToken.new(tokens.current)
+      end
+    end
+  end
+
+  class Expression < Base
+    class BinaryOperator < SQLTree::Node::Expression
+      TOKEN_PRECEDENCE[2] << SQLTree::Token::BETWEEN
+      silence_warnings do
+        TOKENS = TOKEN_PRECEDENCE.flatten
+      end
+
+      def self.parse_rhs(tokens, precedence, operator = nil)
+        if ['IN', 'NOT IN'].include?(operator)
+          if SQLTree::Token::SELECT === tokens.peek(2)
+            return SQLTree::Node::SubQuery.parse(tokens)
+          else
+            return List.parse(tokens)
+          end
+        elsif ['IS', 'IS NOT'].include?(operator)
+          tokens.consume(SQLTree::Token::NULL)
+          return SQLTree::Node::Expression::Value.new(nil)
+        elsif ['BETWEEN'].include?(operator)
+          expr = parse_atomic(tokens)
+          operator = parse_operator(tokens)
+          rhs      = parse_rhs(tokens, precedence, operator)
+          expr     = self.new(:operator => operator, :lhs => expr, :rhs => rhs)
+          return expr
+        else
+          return parse(tokens, precedence + 1)
+        end
+      end
+    end
+
+    class PrefixOperator < SQLTree::Node::Expression
+      TOKENS << SQLTree::Token::BINARY
+    end
+
+    class Field < Variable
+      def to_sql(options = {})
+        @table.nil? ? quote_field_name(@name) : quote_field_name(@table) + '.' + quote_field_name(@name)
+      end
+    end
+  end
+
+  class InsertQuery < Base
+
+    def to_sql(options = { })
+      sql = "INSERT INTO #{ table.to_sql(options)} "
+      sql << '(' + fields.map { |f| f.to_sql(options) }.join(', ') + ') ' if fields
+      sql << 'VALUES'
+      sql << values.map do |value|
+               ' (' + value.map { |v| v.to_sql(options) }.join(', ') + ')'
+             end.join(',')
+      sql
+    end
+
+    def self.parse_value_list(tokens)
+      values = []
+      tokens.consume(SQLTree::Token::VALUES)
+      tokens.consume(SQLTree::Token::LPAREN)
+      values << parse_list(tokens)
+      tokens.consume(SQLTree::Token::RPAREN)
+      while SQLTree::Token::COMMA === tokens.peek
+        tokens.consume(SQLTree::Token::COMMA)
+        tokens.consume(SQLTree::Token::LPAREN)
+        values << parse_list(tokens)
+        tokens.consume(SQLTree::Token::RPAREN)
+      end
+      return values
+    end
+  end
+end

data/lib/active_record/turntable/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Turntable
+    VERSION = "1.0.0"
+  end
+end

data/lib/activerecord-turntable.rb

@@ -0,0 +1,2 @@
+require 'active_record'
+require 'active_record/turntable'

data/lib/generators/active_record/turntable/install_generator.rb

@@ -0,0 +1,14 @@
+module ActiveRecord::Turntable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../templates", __FILE__)
+
+      desc "Creates turntable configuration file (config/turntable.yml)"
+      class_option :orm
+
+      def copy_locale
+        copy_file "turntable.yml", "config/turntable.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/turntable.yml

@@ -0,0 +1,40 @@
+#
+# ActiveRecord::Turntable configuration file
+#
+
+development:
+  clusters:
+    user_cluster:
+      algorithm: range
+      shards:
+        - connection: user_shard_1
+          less_than: 100
+        - connection: user_shard_2
+          less_than: 200
+        - connection: user_shard_3
+          less_than: 300
+
+test:
+  clusters:
+    user_cluster:
+      algorithm: range
+      shards:
+        - connection: user_shard_1
+          less_than: 20000
+        - connection: user_shard_2
+          less_than: 40000
+        - connection: user_shard_3
+          less_than: 10000000
+
+production:
+  clusters:
+    user_cluster:
+      algorithm: range
+      shards:
+        - connection: user_shard_1
+          less_than: 20000
+        - connection: user_shard_2
+          less_than: 40000
+        - connection: user_shard_3
+          less_than: 10000000
+

data/sample_app/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/schema*
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/sample_app/Gemfile

@@ -0,0 +1,41 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.2'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'mysql2'
+
+gem 'activerecord-turntable', '1.0.0'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+gem 'pry-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'

data/sample_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.