mysql2_model 0.1.1

data/lib/mysql2_model/container.rb

@@ -0,0 +1,167 @@
+module Mysql2Model
+  
+  # include this module in your class to inherit all of this awsomeness
+  # @example
+  #   class MyClass
+  #     include Mysql2Model::Container
+  #   end
+  module Container
+    
+    def self.included(base)
+      base.extend Forwardable
+      base.extend ClassMethods
+      base.extend Mysql2Model::Composer
+      #@TODO Do we need the delegators in the instance? ...not sure.
+      base.def_delegators :default_repository_config, :database, :username, :host, :password
+      base.class_eval do 
+        class << self
+          extend Forwardable
+          def_delegators :default_repository_config, :database, :username, :host, :password
+        end
+      end
+    end
+    
+    # @raise [ArgumentError] Row must be a Hash
+    # @param [Hash] row Expects a row from a Mysql2 resultset
+    def initialize(row)
+      raise ArgumentError, "must be a hash" unless row.is_a?(Hash)
+      @attributes = row
+    end
+    
+    def default_repository_config # @private
+      self.class.default_repository_config
+    end
+  
+    def respond_to?(method) # @private
+      return true if @attributes.key?(method)
+      super
+    end
+
+    # Delegate the id to the attribute :id insted of the Object_id
+    def id
+      @attributes[:id]
+    end
+  
+    # Provide dynamic accessors to the internal attributes only
+    def method_missing(method, *args, &block)
+      if @attributes.key?(method)
+        @attributes[method]
+      else
+        super
+      end
+    end
+    
+    #member notation convenience method
+    def [](method)
+      @attributes[method]
+    end
+    #member notation convenience method
+    def []=(method,value)
+      @attributes[method] = value
+    end
+  
+    #datamapper style resource convenience method
+    def attribute_get(method)
+      @attributes[method]
+    end
+    
+    #datamapper style resource convenience method
+    def attribute_set(method,value)
+      @attributes[method]=value
+    end
+    
+    module ClassMethods
+      
+      def default_repository_config # @private
+        OpenStruct.new(Mysql2Model::Client.repositories[default_repository_name][:config])
+      end
+      
+      # Define which repository or repositories act as the destination(s) of your model.
+      # @example Single Repository
+      #   class MyClass
+      #     include Mysql2Model::Container
+      #     self.default_repository_name
+      #       :infrastructure
+      #     end
+      #   end
+      # @example Multiple Repositories
+      #   class MyClass
+      #     include Mysql2Model::Container
+      #     self.default_repository_name
+      #       [:db1,:db2,:db3]
+      #     end
+      #   end
+      # @todo Should probably rename this to just default_repository since Array != Symbol or just "repository"; "default_repository_name" came from Datamapper
+      # @abstract
+      def default_repository_name
+        :default
+      end
+      
+      # Your models repository client via the cache
+      def client
+        Mysql2Model::Client[default_repository_name]
+      end
+
+      # @param [String] statement Uncomposed MySQL Statement
+      # @param [Array] args arguements for composure
+      # @yieldparam [String] composed_sql Composed MySQL Statement
+      # @yieldreturn the return of the block
+      def with_composed_sql(statement='',*args)
+        composed_sql = compose_sql(statement,*args).strip
+        log.info("SQL:[#{composed_sql}]")
+        yield composed_sql
+      end
+      
+      # @return the sum of adding the first value from each of the rows
+      #   primarily useful with count queries running against multiple repos
+      # @todo considering renaming value_sum => value, value => value_for_each, but what happens if value is a String instead of Numeric?
+      # @todo Remove the block pattern, we will need to utilize the block for the evented query pattern
+      def value_sum(statement='',*args)
+        statement = yield if block_given?
+        with_composed_sql(statement,*args) do |sql|
+          client.query(sql).inject(0) { |sum,row|
+            sum += row.first.last
+          }
+        end
+      end
+      
+      # Useful with queries that only return one result, like a COUNT.
+      # @return [Object] only the first value from the row when there is only one row
+      # @return [Array] that contains the first value from each row if multiple rows are returned; as in a COUNT against multiple repos
+      # @todo Remove the block pattern, we will need to utilize the block for the evented query pattern
+      def value(statement='',*args)
+        statement = yield if block_given?
+        with_composed_sql(statement,*args) do |composed_sql|
+          if (rv = client.query(composed_sql)).count > 1
+            rv.map {|row| row.first.last }
+          else
+            rv.first.first.last
+          end
+        end
+      end
+
+      # Flavor the behavior by returning the resultset as instances of self instead of Mysql2::Result
+      def query(statement='',*args)
+        statement = yield if block_given?
+        with_composed_sql(statement,*args) do |composed_sql|
+          response = client.query(composed_sql)
+          if response.respond_to?(:map)
+            response.map do |row|
+              # @todo Patch Mysql2 to support loading the primitives directly into custom class :as => CustomClass, and remove this map
+              # @todo This is defeating Mysql2's lazy loading, but it's good for proof-of-concept
+              self.new(row)
+            end
+          else
+            response
+          end
+        end
+      end
+      alias_method :execute, :query #allow the user to choose whether they want the mysql2 DSL or activerecord DSL
+      
+      def log # @private
+        Mysql2Model::LOGGER
+      end
+      
+    end
+  end
+end

data/lib/mysql2_model.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/date_time'
+require 'mysql2'
+require 'forwardable'
+require 'logging'
+
+module Mysql2Model
+  VERSION = File.read(File.expand_path(File.dirname(__FILE__) + '/../VERSION')).strip
+  LOGGER = Logging.logger(STDOUT)
+  LOGGER.level = :info
+end
+
+require 'mysql2_model/config'
+require 'mysql2_model/client'
+require 'mysql2_model/container'
+require 'mysql2_model/composer'

data/mysql2_model.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mysql2_model}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["donnoman"]
+  s.date = %q{2010-09-03}
+  s.description = %q{Provides a class suitable to be used as a model, that includes connection management, variable interpolation, object coercion and helper methods to support using direct MySQL statements for database interaction.}
+  s.email = %q{donnoman@donovanbray.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".yardopts",
+     "CHANGELOG.md",
+     "Gemfile",
+     "Gemfile.lock",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/mtdb.rb",
+     "examples/repositories.yml",
+     "examples/subscriber.rb",
+     "lib/mysql2_model.rb",
+     "lib/mysql2_model/client.rb",
+     "lib/mysql2_model/composer.rb",
+     "lib/mysql2_model/config.rb",
+     "lib/mysql2_model/container.rb",
+     "mysql2_model.gemspec",
+     "spec/mysql2_model/client_spec.rb",
+     "spec/mysql2_model/composer_spec.rb",
+     "spec/mysql2_model/config_spec.rb",
+     "spec/mysql2_model/container_spec.rb",
+     "spec/mysql2_model_spec.rb",
+     "spec/repositories.yml.fixture",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/donnoman/mysql2_model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Mysql2Model provides a container for creating model code based on MySQL Statements utilizing the Mysql2 client}
+  s.test_files = [
+    "spec/mysql2_model/client_spec.rb",
+     "spec/mysql2_model/container_spec.rb",
+     "spec/mysql2_model/config_spec.rb",
+     "spec/mysql2_model/composer_spec.rb",
+     "spec/mysql2_model_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/mtdb.rb",
+     "examples/subscriber.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mysql2>, ["~> 0.2"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_runtime_dependency(%q<builder>, ["~> 2.1.2"])
+      s.add_runtime_dependency(%q<logging>, ["~> 1"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3"])
+    else
+      s.add_dependency(%q<mysql2>, ["~> 0.2"])
+      s.add_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_dependency(%q<builder>, ["~> 2.1.2"])
+      s.add_dependency(%q<logging>, ["~> 1"])
+      s.add_dependency(%q<rspec>, ["~> 1.3"])
+    end
+  else
+    s.add_dependency(%q<mysql2>, ["~> 0.2"])
+    s.add_dependency(%q<activesupport>, ["~> 2.3"])
+    s.add_dependency(%q<builder>, ["~> 2.1.2"])
+    s.add_dependency(%q<logging>, ["~> 1"])
+    s.add_dependency(%q<rspec>, ["~> 1.3"])
+  end
+end
+

data/spec/mysql2_model/client_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mysql2Model::Client do
+  describe "repositories" do
+    it "should have repositories" do
+      Mysql2Model::Client.repositories[:default].should_not be_nil
+    end
+  end
+  describe "getting repositories" do
+    it "should have a :default repository that is a 'Mysql2::Client'" do
+      Mysql2Model::Client[:default].class.name.should eql("Mysql2::Client")
+    end
+  end
+  describe "setting repositories" do
+    it "should add the :mtdb1 repository" do
+      Mysql2Model::Client[:mtdb1] = YAML.load(File.read(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml')))[:repositories][:default]
+      Mysql2Model::Client[:mtdb1].class.name.should eql("Mysql2::Client")
+    end
+  end
+  describe "load_repos" do
+    context "forced" do
+      it "should load_repos subsequent times" do
+        rv = YAML.load(File.new(Mysql2Model::Config.repository_path, 'r'))
+        YAML.should_receive(:load).twice.and_return(rv)
+        2.times do
+          Mysql2Model::Client.load_repos(true)
+        end
+      end
+    end
+    context "not forced" do
+      it "should not load_repos again" do
+        YAML.should_not_receive(:load)
+        Mysql2Model::Client.load_repos
+      end
+    end
+  end
+end
+
+class M2MClient
+  include Mysql2Model::Container
+  def self.all
+    query("SELECT * FROM mysql2_model_test")
+  end
+end
+
+describe M2MClient do
+  describe "default_repository_name" do
+    before :each do
+      Mysql2Model::Config.should_receive(:repository_path).any_number_of_times.and_return(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml'))
+      Mysql2Model::Client.load_repos(true)
+    end
+    describe "with multiple repositories" do
+      before :each do 
+        Mysql2Model::Client[:default2] = YAML.load(File.read(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml')))[:repositories][:default]
+        Mysql2Model::Client[:default3] = YAML.load(File.read(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml')))[:repositories][:default]      
+        M2MClient.stub!(:default_repository_name).and_return([:default,:default2,:default3])
+      end
+      it "should return single resultset of merged rows" do
+        M2MClient.all.size.should eql(6)
+      end
+      it "should add the values returned" do
+        M2MClient.value_sum("SELECT COUNT(*) from mysql2_model_test").should eql(6)
+      end
+      it "should return an array of values" do
+        M2MClient.value("SELECT COUNT(*) from mysql2_model_test").should eql([2,2,2])
+      end
+    end
+    describe "with single repository" do
+      before :each do 
+        M2MClient.stub!(:default_repository_name).and_return(:default)
+      end
+      it "should return single resultset" do
+        M2MClient.all.size.should eql(2)
+      end
+      it "should add the values returned" do
+        M2MClient.value_sum("SELECT COUNT(*) from mysql2_model_test").should eql(2)
+      end
+      it "should return the value" do
+        M2MClient.value("SELECT COUNT(*) from mysql2_model_test").should eql(2)
+      end
+    end
+  end
+end
+

data/spec/mysql2_model/composer_spec.rb

@@ -0,0 +1,123 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class M2MComposer
+  include Mysql2Model::Container
+end
+
+describe M2MComposer do
+  describe "compose_sql" do
+    context "string" do
+      it "should return the string" do
+        M2MComposer.compose_sql("one two three 4").should eql("one two three 4")
+      end
+    end
+    context "array" do
+      it "should assemble use multiple arguments as the array" do
+        M2MComposer.compose_sql("%s %s %s %d",'one','two','three',4).should eql("one two three 4")
+      end
+      it "should support passing in an array" do
+        M2MComposer.compose_sql(["one two three 4",'one','two','three',4]).should eql("one two three 4")
+      end
+      it "should support passing in an array and single string" do
+        #or should this raise?
+        M2MComposer.compose_sql(["one two three 4"]).should eql("one two three 4")
+      end      
+      it "should support printf style substitution" do
+        M2MComposer.compose_sql("%s %s %s %d",'one','two','three',4).should eql("one two three 4")
+      end
+      it "should support ? placeholders" do 
+        M2MComposer.compose_sql("? ? ? ?",'one','two','three',4).should eql("one two three 4")
+      end
+      it "should support named bind variables" do
+        M2MComposer.compose_sql(":uno :dos :tres :cuatro :uno :dos :tres :cuatro",:uno => 'one', :dos => 'two',:tres => 'three', :cuatro => 4).should eql("one two three 4 one two three 4")
+      end
+      it "should raise an error with mismatched number of replacements" do
+        lambda { M2MComposer.compose_sql("? ? ? ?",'one','two','three') }.should raise_error(Mysql2Model::PreparedStatementInvalid)
+      end
+    end
+  end
+  describe M2MComposer do
+
+    before :each do
+      @client = Mysql2Model::Client[:default]
+    end
+
+    describe "query" do
+      it "should be composed with a string" do
+        @client.should_receive(:query).with("SELECT 1").and_return([])
+        M2MComposer.query("SELECT 1")
+      end
+      it "should be composed with multiple arguments" do
+        @client.should_receive(:query).with("one two three 4").and_return([])
+        M2MComposer.query("%s %s %s %d",'one','two','three',4)
+      end
+      it "should be composed with an array" do
+        @client.should_receive(:query).with("one two three 4").and_return([])
+        M2MComposer.query(["%s %s %s %d",'one','two','three',4])
+      end
+      context "with a block" do
+        it "should be composed when in an array" do
+          @client.should_receive(:query).with("one two three 4").and_return([])
+          M2MComposer.query do 
+            ["%s %s %s %d",'one','two','three',4]
+          end
+        end
+        it "should be composed when a string" do
+          @client.should_receive(:query).with("one two three 4").and_return([])
+          M2MComposer.query do 
+            "one two three 4"
+          end
+        end
+      end
+
+    end
+
+    describe "value" do
+      it "should be composed with a string" do
+        @client.should_receive(:query).with("SELECT 1").and_return([])
+        M2MComposer.query("SELECT 1")
+      end
+      it "should be composed with multiple arguments" do
+        @client.should_receive(:query).with("one two three 4").and_return([])
+        M2MComposer.query("%s %s %s %d",'one','two','three',4)
+      end
+      it "should be composed with an array" do
+        @client.should_receive(:query).with("one two three 4").and_return([])
+        M2MComposer.query(["%s %s %s %d",'one','two','three',4])
+      end
+      context "with a block" do
+        it "should be composed when in an array" do
+          @client.should_receive(:query).with("one two three 4").and_return([])
+          M2MComposer.query do 
+            ["%s %s %s %d",'one','two','three',4]
+          end
+        end
+        it "should be composed when a string" do
+          @client.should_receive(:query).with("one two three 4").and_return([])
+          M2MComposer.query do 
+            "one two three 4"
+          end
+        end
+      end
+    end 
+
+    describe "convert" do
+      context "time" do
+        it "should convert a time" do
+          M2MComposer.convert(Time.utc(2000,1,2,20,15,1)).should eql("2000-01-02 20:15:01")
+        end
+        it "should convert a date" do
+          M2MComposer.convert(Date.new(2000,1,2)).should eql("2000-01-02")
+        end
+        it "should convert a datetime" do
+          M2MComposer.convert(DateTime.new(2000,1,2,20,15,1)).should eql("2000-01-02 20:15:01")
+        end
+        it "should convert a time via query" do
+          M2MComposer.query("UPDATE mysql2_model_test SET created_at = '?' WHERE id = 1",Time.utc(2000,1,2,20,15,1))
+          M2MComposer.value("SELECT created_at FROM mysql2_model_test WHERE id = 1").should eql(Time.utc(2000,1,2,20,15,1))
+        end
+      end
+    end
+    
+  end
+end

data/spec/mysql2_model/config_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mysql2Model::Config do
+  describe "repository_path" do
+    it "should be muteable" do
+      Mysql2Model::Config.repository_path = 'databases.yml'
+      Mysql2Model::Config.repository_path.should eql('databases.yml')
+    end
+  end
+end

data/spec/mysql2_model/container_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class M2MContainer
+  include Mysql2Model::Container
+  
+  def self.default_repository_array
+    [database,username,password,host]
+  end
+  
+  def default_repository_array
+    [database,username,password,host]
+  end
+end
+
+describe M2MContainer do
+  before :each do
+     Mysql2Model::Config.should_receive(:repository_path).any_number_of_times.and_return(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml.fixture'))
+     Mysql2Model::Client.load_repos(true)
+  end
+  describe "class" do
+    it "should have direct access to the default_repository hash members" do
+      M2MContainer.default_repository_array.should eql(['mysql2_model_test','root','gibberish','localhost'])
+    end
+  end
+  describe "instance" do
+    it "should have direct access to the default_repository hash members" do
+      M2MContainer.new({}).default_repository_array.should eql(['mysql2_model_test','root','gibberish','localhost'])
+    end
+  end
+end
+
+describe M2MContainer, "mysql2 methods" do
+  before :each do
+    Mysql2Model::Config.should_receive(:repository_path).any_number_of_times.and_return(File.expand_path(File.dirname(__FILE__) + '/../repositories.yml'))
+    Mysql2Model::Client.load_repos(true) #fooling with the class repository path, need to make sure we don't use the fixture
+  end
+  describe "query" do
+    it "should return an array with a member named 'test'" do
+      M2MContainer.query("SELECT * FROM mysql2_model_test").first.name.should eql('test')
+    end
+  end
+  
+  describe "value" do
+    it "should return only the first value of the first row" do
+      M2MContainer.value("SELECT COUNT(*) FROM mysql2_model_test").should eql(2)
+    end
+  end
+end

data/spec/mysql2_model_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Mysql2Model" do
+  it "should report the same version as in the VERSION file" do
+    Mysql2Model::VERSION.to_s.should == IO.read(File.expand_path(File.dirname(__FILE__) + "/../VERSION")).strip
+  end
+end

data/spec/repositories.yml.fixture

@@ -0,0 +1,26 @@
+:repositories:
+  :default:
+    :database: mysql2_model_test
+    :username: root
+    :password: gibberish
+    :host: localhost
+  :secondary: 
+    :database: mysql2_model_test
+    :username: root
+    :password: gibberish
+    :host: localhost
+  :m1:
+    :database: mysql2_model_test
+    :username: root
+    :password: gibberish
+    :host: localhost
+  :m2:
+    :database: mysql2_model_test
+    :username: root
+    :password: gibberish
+    :host: localhost
+  :m3:
+    :database: mysql2_model_test
+    :username: root
+    :password: gibberish
+    :host: localhost

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mysql2_model'
+require 'spec'
+require 'spec/autorun'
+require 'ruby-debug'
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    Mysql2Model::Config.repository_path = File.join(File.dirname(__FILE__), 'repositories.yml')
+    Mysql2Model::LOGGER.level = :fatal
+    client = Mysql2::Client.new(YAML.load(File.read(Mysql2Model::Config.repository_path))[:repositories][:default])
+    client.query %[ DROP TABLE IF EXISTS mysql2_model_test ]
+    client.query %[
+      CREATE TABLE IF NOT EXISTS mysql2_model_test (
+        id MEDIUMINT NOT NULL AUTO_INCREMENT,
+        name VARCHAR(40),
+        value VARCHAR(40),
+        created_at DATETIME,
+        updated_at DATETIME,
+        PRIMARY KEY (id)
+      )
+    ]
+    client.query %[
+      INSERT INTO mysql2_model_test (
+        name, value, updated_at, created_at
+      )
+
+      VALUES (
+        'test', 'garbage', NOW(), NOW()
+      )
+    ]
+    client.query %[
+      INSERT INTO mysql2_model_test (
+        name, value, updated_at, created_at
+      )
+
+      VALUES (
+        'test2', 'garbage2', NOW(), NOW()
+      )
+    ]
+  end
+end