active_record_handlersocket 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in active_record_handlersocket.gemspec
+gemspec
+gem 'ruby-debug', '0.10.0'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Takayuki Sugita
+
+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,86 @@
+active_record_handlersocket
+===========================
+
+HandlerSocket for ActiveRecord; depends handlersocket gem https://github.com/miyucy/handlersocket
+
+
+**Underconstruction**
+
+usage
+------------------------------------------------------------
+
+Update your `config/database.yml` of rails project. (Available to set database same as AR read/write database.)
+
+```
+development_hs_read:
+  host:     localhost
+  port:     9998
+  database: active_record_handler_socket
+```
+
+Define HandlerSocket index setting on your ActiveReocrd Model.
+
+```ruby
+class Person < ActiveRecord::Base
+  handlersocket :id, "PRIMARY", %W[id name age]
+end
+```
+
+Call `hsfind_by_#{key}` of `hsfind_multi_by_#{key}` to get record(s) as ActiveRecord Object.
+
+```ruby
+Person.hsfind_by_id(1)
+#=> #<Person id: 1, name: "Bob Marley", age: 36>
+
+Person.hsfind_multi_by_id(1, 2)
+#=> [
+#   #<Person id: 1, name: "Bob Marley", age: 36>,
+#   #<Person id: 2, name: "Pharrell Wiiliams", age: 41>
+# ]
+```
+
+
+development
+------------------------------------------------------------
+
+Dev dependencies
+
+```sh
+mkdir vendor
+bundle install --path=vendor
+```
+
+Prepare DB
+
+```sh
+rake db:prepare
+```
+
+create following items on MySQL.
+
+ key             | value
+-----------------|------------------------------------------
+ user            | rails
+ database (dev)  | active_record_handler_socket
+ database (test) | active_record_handler_socket_test
+ tables          | people, hobbies
+
+
+Try example on console
+
+```sh
+bundle exec irb
+```
+
+```ruby
+require 'examples/init'
+#=> true
+
+Person.create(:name => "Bob Marley", :age => 36, :status => false)
+
+Person.find_by_id(1)
+#=> #<Person id: 1, name: "Bob Marley", age: 36, status: false>
+Person.hsfind_by_id(1)
+#=> #<Person id: 1, name: "Bob Marley", age: 36, status: false>
+```
+

data/Rakefile

@@ -0,0 +1,87 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = ["-cfs"]
+end
+
+namespace :db do
+  USER = "rails"
+
+  DATABASES = %W[
+    active_record_handler_socket
+    active_record_handler_socket_test
+  ]
+
+  TABLES = {
+    :people  => %W[
+      id     int(11)      NOT NULL AUTO_INCREMENT,
+      name   varchar(255) DEFAULT '',
+      age    int(11)      DEFAULT NULL,
+      status tinyint(1)   NOT NULL DEFAULT '1',
+      PRIMARY KEY (id)
+    ].join(" "),
+    :hobbies => %W[
+      id         int(11)          NOT NULL AUTO_INCREMENT,
+      person_id  int(11)          NOT NULL,
+      title      varchar(255)     DEFAULT '',
+      created_at datetime DEFAULT NULL,
+      updated_at datetime DEFAULT NULL,
+      PRIMARY KEY (id),
+      KEY index_hobbies_on_person_id (person_id)
+    ].join(" ")
+  }
+
+  def mysql(query, options = {})
+    _user = options[:user] || USER
+    _db   = options[:database]
+
+    puts ""
+
+    begin
+      sh %Q|mysql -u #{_user} #{_db} -e "#{query}"|
+    rescue => e
+      puts e.message
+    end
+  end
+
+  desc "create user for active_record_handler_socket"
+  task :create_user do
+    mysql "GRANT ALL PRIVILEGES ON *.* TO '#{USER}'@'localhost' WITH GRANT OPTION", :user => "root"
+    mysql "SHOW GRANTS FOR 'rails'@'localhost'", :user => "root"
+  end
+
+  desc "create databases for active_record_handler_socket"
+  task :create_databases do
+    DATABASES.each do |database|
+      mysql "CREATE DATABASE #{database} DEFAULT CHARACTER SET 'utf8'"
+    end
+
+    mysql "SHOW DATABASES"
+  end
+
+  desc "create tables for active_record_handler_socket"
+  task :create_tables do
+    DATABASES.each do |database|
+      TABLES.each do |table, schema|
+        mysql "CREATE TABLE #{table} (#{schema}) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8", :database => database
+      end
+
+      mysql "SHOW TABLES", :database => database
+    end
+  end
+
+  desc "run db tasks}"
+  task :prepare do
+    %W[
+      db:create_user
+      db:create_databases
+      db:create_tables
+    ].each do |task|
+      Rake::Task[task].invoke
+    end
+  end
+end

data/active_record_handlersocket.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_record_handlersocket/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_record_handlersocket"
+  s.version     = ActiveRecordHandlersocket::VERSION
+  s.authors     = ["Takayuki Sugita"]
+  s.email       = ["sugilog@gmail.com"]
+  s.homepage    = "https://github.com/sugilog/active_record_handlersocket"
+  s.summary     = %q{HandlerSocket for ActiveRecord}
+  s.description = %q{Easy-to-use handlersocket from existing ActiveRecord Models}
+
+  s.files         = `git ls-files`.split("\n").select{|f| f !~ /^examples\// }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "activerecord", "~> 2.3.12"
+  s.add_runtime_dependency "handlersocket", "~> 0.0.2"
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+
+  if RUBY_VERSION >= "1.8.7"
+    s.add_development_dependency "mysql2"
+    s.add_development_dependency "rspec"
+    s.add_development_dependency "factory_girl"
+    s.add_development_dependency "database_cleaner"
+  else
+    s.add_development_dependency "mysql2", '0.2.18'
+    s.add_development_dependency "rspec", "~> 2.11.0"
+    s.add_development_dependency "factory_girl", "2.3.2"
+    s.add_development_dependency "database_cleaner", "0.9.1"
+  end
+end

data/lib/active_record_handlersocket.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'handlersocket'
+
+%W[
+  manager
+  finder 
+  connection
+  active_record_handler_socket
+  base
+].each do |file|
+  require File.join("active_record_handlersocket", file)
+end
+

data/lib/active_record_handlersocket/active_record_handler_socket.rb

@@ -0,0 +1,15 @@
+module ActiveRecordHandlerSocket
+  def self.included(c)
+    [
+      Manager,
+      Finder,
+      Connection
+    ].each do |_module|
+      c.extend _module
+      c.extend _module::PrivateMethods
+      c.private_class_method *_module::PrivateMethods.instance_methods(false)
+    end
+
+    c.__send__ :hs_establish_connection
+  end
+end

data/lib/active_record_handlersocket/base.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class Base
+    include ActiveRecordHandlerSocket
+  end
+end

data/lib/active_record_handlersocket/connection.rb

@@ -0,0 +1,44 @@
+module ActiveRecordHandlerSocket
+  module Connection
+    def hs_reconnect!
+      hs_read_connection.reconnect
+      hs_reset_opened_indexes
+      hs_active?
+    end
+
+    # XXX: stable_point cannot return correct status before open_index.
+    #      connection establish with unknown port -> call stable_point -> retrun true
+    def hs_active?
+      [
+        hs_read_connection.stable_point
+      ].all?
+    end
+
+    module PrivateMethods
+      mattr_reader :hs_connections
+      @@hs_connections = {}
+
+      # TODO: writeread connection
+      def hs_establish_connection(name = nil)
+        case name
+        when nil
+          hs_establish_connection("#{RAILS_ENV}_hs_read")
+        else
+          if config = ActiveRecord::Base.configurations[name]
+            config = config.symbolize_keys
+
+            @@hs_connections.update(
+              :read => HandlerSocket.new(:host => config[:host], :port => config[:port].to_s)
+            )
+          else
+            raise ArgumentError, "unknown configuration: #{name}"
+          end
+        end
+      end
+
+      def hs_read_connection
+        @@hs_connections[:read]
+      end
+    end
+  end
+end

data/lib/active_record_handlersocket/finder.rb

@@ -0,0 +1,104 @@
+module ActiveRecordHandlerSocket
+  class CannotConnectError < StandardError; end
+
+  module Finder
+    def method_missing(method_name, *args, &block)
+      case method_name.to_s
+      when /^hsfind_(by|multi_by)_([_a-zA-Z]\w*)$/
+        finder = :first if $1 == "by"
+        finder = :multi if $1 == "multi_by"
+        key    = $2
+        hsfind(finder, key, args)
+      else
+        super
+      end
+    end
+
+    def hsfind(finder, key, args)
+      index_key = hs_index_key(key)
+      setting   = hs_fetch_key(index_key)
+
+      options  = args.extract_options!
+      id       = setting[:id]
+      operator = options[:operator] || "="
+
+      hs_open_index(index_key)
+
+      case finder
+      # XXX: experimental
+      when :multi
+        _args = args.map{|arg|
+          _arg = []
+          _arg << setting[:id]
+          _arg << operator
+          _arg << [arg]
+          _arg << options[:limit] if options[:limit]
+          _arg
+        }
+
+        results = hs_read_connection.execute_multi(_args)
+
+        results.map{|result|
+          hs_instantiate(index_key, result)
+        }.flatten
+      when :first
+        result = hs_read_connection.execute_single(setting[:id], operator, args)
+        hs_instantiate(index_key, result).first
+      else
+        # XXX: Not Support
+      end
+    end
+
+    module PrivateMethods
+      def hs_open_index(index_key)
+        setting = hs_fetch_key(index_key)
+
+        if setting[:opened]
+          return
+        end
+
+        config   = configurations["#{RAILS_ENV}_hs_read"].symbolize_keys
+
+        id       = setting[:id]
+        database = config[:database]
+        table    = table_name
+        index    = setting[:index]
+        fields   = setting[:fields].join(",")
+
+        signal = hs_read_connection.open_index(id, database, table, index, fields)
+
+        case
+        when signal == 0
+          setting[:opened] = true
+        when signal > 0
+          error = hs_read_connection.error
+          raise ArgumentError, "invalid setting given: #{error}"
+        else
+          hs_reset_opened_indexes
+          error = hs_read_connection.error
+          raise ActiveRecordHandlerSocket::CannotConnectError, "connection lost: #{error}"
+        end
+      end
+
+      def hs_instantiate(index_key, result_on_single)
+        signal, result = result_on_single
+
+        case
+        when signal == 0
+          setting = hs_fetch_key(index_key)
+          fields  = setting[:fields]
+
+          result.map do |record|
+            attrs = Hash[ *fields.zip(record).flatten ]
+            instantiate(attrs)
+          end
+        when signal > 0
+          raise ArgumentError, "invalid argument given: #{result}"
+        else
+          hs_reset_opened_indexes
+          raise ActiveRecordHandlerSocket::CannotConnectError, result
+        end
+      end
+    end
+  end
+end

data/lib/active_record_handlersocket/manager.rb

@@ -0,0 +1,46 @@
+module ActiveRecordHandlerSocket
+  class UnknownIndexError < StandardError; end
+
+  module Manager
+    module PrivateMethods
+      mattr_reader :hs_indexes, :hs_index_count_cache
+      @@hs_indexes = {}
+      @@hs_index_count_cache = 0
+
+      def handlersocket(key, index, fields)
+        index_key = hs_index_key(key)
+
+        if @@hs_indexes.has_key?(index_key)
+          warn "#{self.name} handlersocket: #{key} was updated"
+        end
+
+        @@hs_indexes.update(
+          index_key => {
+            :id     => hs_index_count,
+            :index  => index,
+            :fields => fields,
+            :opened => false
+          }
+        )
+      end
+
+      def hs_index_key(key)
+        [self.name, key].join(":")
+      end
+
+      def hs_fetch_key(index_key)
+        @@hs_indexes[index_key] or raise UnknownIndexError, "unknown key given: #{index_key}"
+      end
+
+      def hs_index_count
+        @@hs_index_count_cache += 1
+      end
+
+      def hs_reset_opened_indexes
+        @@hs_indexes.each do |_, setting|
+          setting[:opened] = false
+        end
+      end
+    end
+  end
+end