believer 0.1.4 → 0.2

data/lib/believer/command.rb

@@ -18,23 +18,21 @@ module Believer
       {:record_class => @record_class}
     end
 
-    def connection
-      @record_class.connection
-    end
-
     def execute(name = 'cql.cql_record')
-      cql = to_cql
-      begin
-        start = Time.now
-        puts "Executing #{cql}"
-        res = connection.execute(cql)
-        #Rails.logger.debug "#{name} #{sprintf "%.3f", (Time.now - start)*1000.0} ms: #{cql}"
-        return res
-      rescue Cql::Protocol::DecodingError => e
-        # Decoding errors tend to #$%# up the connection, resulting in no more activity, so a reconnect is performed here.
-        # This is a known issue in cql-rb, and will be fixed in version 1.10
-        @record_class.reset_connection
-        raise e
+      @record_class.connection_pool.with do |connection|
+        cql = to_cql
+        begin
+          start = Time.now
+          puts "Executing #{cql}"
+          res = connection.execute(cql)
+          #Rails.logger.debug "#{name} #{sprintf "%.3f", (Time.now - start)*1000.0} ms: #{cql}"
+          return res
+        rescue Cql::Protocol::DecodingError => e
+          # Decoding errors tend to #$%# up the connection, resulting in no more activity, so a reconnect is performed here.
+          # This is a known issue in cql-rb, and will be fixed in version 1.10
+          @record_class.reset_connection(connection)
+          raise e
+        end
       end
 
     end

data/lib/believer/connection.rb

@@ -1,18 +1,37 @@
+require 'connection_pool'
+
 module Believer
   module Connection
     extend ::ActiveSupport::Concern
 
     module ClassMethods
 
-      def reset_connection
-        unless connection.nil?
-          connection.close
-          @client_connection = nil
+      def reset_connection(conn)
+        unless conn.nil?
+          conn.close
         end
       end
 
-      def connection
-        @client_connection ||= environment.create_connection(:connect_to_keyspace => true)
+      def connection_pool
+        Believer::Connection::Pool.instance.connection(environment)
+        #@client_connection ||= environment.create_connection(:connect_to_keyspace => true)
+      end
+
+    end
+
+    class Pool
+      include ::Singleton
+
+      # Retrieve a connection from the pool
+      # @param environment [Believer::Environment::BaseEnv] the environment with the connection configuration
+      def connection(environment)
+        unless @connection_pool
+          pool_config = environment.connection_pool_configuration
+          @connection_pool ||= ::ConnectionPool.new(pool_config) do
+            environment.create_connection(:connect_to_keyspace => true)
+          end
+        end
+        @connection_pool
       end
 
     end

data/lib/believer/cql_helper.rb

@@ -0,0 +1,20 @@
+module Believer
+
+  # Contains various methods for dealing with CQL statements
+  module CqlHelper
+
+    CQL_TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S%z'
+
+    # Converts a value to a CQL literal
+    # @param value [Object] the value to convert
+    def to_cql_literal(value)
+      return 'NULL' if value.nil?
+      return "'#{value}'" if value.is_a?(String)
+      return "#{value}" if value.is_a?(Numeric)
+      return "'#{value.strftime(CQL_TIMESTAMP_FORMAT)}'" if value.is_a?(Time) || value.is_a?(DateTime)
+      #return "#{value.to_i * 1000}" if value.is_a?(Time) || value.is_a?(DateTime)
+      return nil
+    end
+
+  end
+end

data/lib/believer/ddl.rb

@@ -5,15 +5,17 @@ module Believer
 
     module ClassMethods
       def create_table
-        cql = create_table_cql
-        puts "Creating table #{table_name} using CQL:\n#{cql}"
-        connection.execute(cql)
-        puts "Created table #{table_name}"
+        connection_pool.with do |connection|
+          cql = create_table_cql
+          puts "Creating table #{table_name} using CQL:\n#{cql}"
+          connection.execute(cql)
+          puts "Created table #{table_name}"
+        end
       end
 
       def create_table_cql
         s = "CREATE TABLE #{table_name} (\n"
-        col_statement_parts = columns.keys.map {|col| "#{col} #{columns[col].cql_column_type}"}
+        col_statement_parts = columns.keys.map {|col| "#{col} #{columns[col].cql_type}"}
         s << col_statement_parts.join(",\n")
 
         keys = []

data/lib/believer/delete.rb

@@ -1,9 +1,11 @@
 module Believer
+  # Creates CQL DELETE statements
   class Delete < ScopedCommand
 
+    # Creates the CQL
     def to_cql
-      cql = "DELETE FROM #{@record_class.table_name}"
-      cql << " WHERE #{@wheres.map { |wc| "#{wc.to_cql}" }.join(' AND ')}" if @wheres && @wheres.any?
+      cql = "DELETE FROM #{record_class.table_name}"
+      cql << " WHERE #{wheres.map { |wc| "#{wc.to_cql}" }.join(' AND ')}" if wheres.any?
       cql
     end
 

data/lib/believer/environment.rb

@@ -1,4 +1,5 @@
 #require "believer/environment/rails_env"
+#require "believer/environment/merb_env"
 
 module Believer
   module Environment
@@ -7,12 +8,13 @@ module Believer
     module ClassMethods
 
       def environment
-
         if @environment.nil?
           if self.superclass.respond_to?(:environment)
             @environment = self.superclass.environment
           elsif defined?(::Rails)
             @environment = ::Believer::Environment::RailsEnv.new
+          elsif defined?(::Merb)
+            @environment = ::Believer::Environment::MerbEnv.new
           end
         end
         @environment
@@ -25,29 +27,41 @@ module Believer
     end
 
     class BaseEnv
-      #def connection_configuration
-      #  {:host => '127.0.0.1'}
-      #end
-
+      # Default pool configuration
+      DEFAULT_POOL_CONFIG = {
+          :size => 1,
+          :timeout => 10
+      }
+
+      # Creates a new environment using the provided configuration
+      # @param config [Hash] the configuration
       def initialize(config = nil)
         @configuration = config.dup unless config.nil?
       end
 
+      # Returns the configuration. This configuration hash should contain the cql-rb client connection parameters.
+      # Optionally the connection_pool configuraton can be included in a :pool node.
       def configuration
         @configuration ||= load_configuration
       end
 
+      # Sets the configuration
       def configuration=(config)
         @configuration = config
       end
 
       def connection_configuration
-        @connection_configuration ||= configuration.reject {|k, v| k == :pool}
+        configuration.reject {|k, v| k == :pool}
+      end
+
+      # The connection_pool configuration, which should be a :pool node in the configuration.
+      def connection_pool_configuration
+        DEFAULT_POOL_CONFIG.merge(configuration[:pool].is_a?(Hash) ? configuration[:pool].symbolize_keys! : {})
       end
 
+      # Creates a new connection
       def create_connection(options = {})
         cc = connection_configuration
-
         if options[:connect_to_keyspace] && cc[:keyspace]
           connection = Cql::Client.connect(cc)
           connection.use(cc[:keyspace])
@@ -57,16 +71,32 @@ module Believer
         connection
       end
 
-      def create_keyspace(connection = nil)
-        conn = connection || create_connection
+      def create_keyspace(properties = {}, connection = nil)
+        conn = connection || create_connection(:connect_to_keyspace => false)
+
+        default_properties = {:replication => {:class => 'SimpleStrategy', :replication_factor => 1}}
+        ks_props = default_properties.merge(properties)
+
+        ks_props_s = ks_props.keys.map {|k|
+          v = ks_props[k]
+          v_s = nil
+          if v.is_a?(Hash)
+            v_s = v.to_json.gsub(/\"/) {|m| "'"}
+          elsif v.is_a?(String)
+            v_s = "'#{v}'"
+          else
+            v_s = v.to_s
+          end
+          "#{k} = #{v_s}"
+        }.join("\nAND ")
+
         ks_def = <<-KS_DEF
           CREATE KEYSPACE #{connection_configuration[:keyspace]}
-          WITH replication = {
-            'class': 'SimpleStrategy',
-            'replication_factor': 1
-          }
+          WITH #{ks_props_s}
         KS_DEF
 
+        puts ks_def
+
         conn.execute(ks_def)
       end
 

data/lib/believer/environment/merb_env.rb

@@ -0,0 +1,14 @@
+
+module Believer
+  module Environment
+    class MerbEnv < Believer::Environment::BaseEnv
+
+      def load_configuration
+        config_file = File.join(Merb.root, 'config', 'believer.yml')
+        config = HashWithIndifferentAccess.new(YAML::load(File.open(config_file.to_s)))
+        env_config = config[Merb.environment]
+        env_config
+      end
+    end
+  end
+end

data/lib/believer/environment/rails_env.rb

@@ -4,11 +4,10 @@ module Believer
     class RailsEnv < Believer::Environment::BaseEnv
 
       def load_configuration
-        config_file = Rails.root + "config/believer.yml"
-        config = YAML::load(File.open(config_file.to_s))
+        config_file = File.join(Rails.root, 'config', 'believer.yml')
+        config = HashWithIndifferentAccess.new(YAML::load(File.open(config_file.to_s)))
         env_config = config[Rails.env]
-        env_config = {}.merge(env_config).symbolize_keys
-        env_config[:logger] = Rails.logger
+        env_config[:logger] = Rails.logger unless Rails.logger.nil?
         env_config
       end
     end

data/lib/believer/insert.rb

@@ -1,7 +1,7 @@
 module Believer
 
   class Insert < Command
-    include Values
+    include CqlHelper
 
     attr_accessor :values
 

data/lib/believer/model_schema.rb

@@ -1,4 +1,6 @@
 module Believer
+
+  # Mostly *borrowed* from ActiveRecord::ModelSchema ;)
   module ModelSchema
     extend ActiveSupport::Concern
 
@@ -34,8 +36,8 @@ module Believer
 
     module ClassMethods
       # Guesses the table name (in forced lower-case) based on the name of the class in the
-      # inheritance hierarchy descending directly from ActiveRecord::Base. So if the hierarchy
-      # looks like: Reply < Message < ActiveRecord::Base, then Message is used
+      # inheritance hierarchy descending directly from Believer::Base. So if the hierarchy
+      # looks like: Reply < Message < Believer::Base, then Message is used
       # to guess the table name even when called on Reply. The rules used to do the guess
       # are handled by the Inflector class in Active Support, which knows almost all common
       # English inflections. You can add new inflections in config/initializers/inflections.rb.
@@ -45,14 +47,14 @@ module Believer
       #
       # ==== Examples
       #
-      #   class Invoice < ActiveRecord::Base
+      #   class Invoice < Believer::Base
       #   end
       #
       #   file                  class               table_name
       #   invoice.rb            Invoice             invoices
       #
-      #   class Invoice < ActiveRecord::Base
-      #     class Lineitem < ActiveRecord::Base
+      #   class Invoice < Believer::Base
+      #     class Lineitem < Believer::Base
       #     end
       #   end
       #
@@ -60,7 +62,7 @@ module Believer
       #   invoice.rb            Invoice::Lineitem   invoice_lineitems
       #
       #   module Invoice
-      #     class Lineitem < ActiveRecord::Base
+      #     class Lineitem < Believer::Base
       #     end
       #   end
       #
@@ -74,7 +76,7 @@ module Believer
       #
       # You can also set your own table name explicitly:
       #
-      #   class Mouse < ActiveRecord::Base
+      #   class Mouse < Believer::Base
       #     self.table_name = "mice"
       #   end
       #
@@ -82,7 +84,7 @@ module Believer
       # own computation. (Possibly using <tt>super</tt> to manipulate the default
       # table name.) Example:
       #
-      #   class Post < ActiveRecord::Base
+      #   class Post < Believer::Base
       #     def self.table_name
       #       "special_" + super
       #     end
@@ -93,10 +95,6 @@ module Believer
         @table_name
       end
 
-      def original_table_name #:nodoc:
-        deprecated_original_property_getter :table_name
-      end
-
       # Sets the table name explicitly. Example:
       #
       #   class Project < ActiveRecord::Base
@@ -111,11 +109,6 @@ module Believer
         @quoted_table_name   = nil
       end
 
-      def set_table_name(value = nil, &block) #:nodoc:
-        deprecated_property_setter :table_name, value, block
-        @quoted_table_name = nil
-      end
-
       # Returns a quoted version of the table name, used to construct SQL statements.
       def quoted_table_name
         @quoted_table_name ||= "`#{table_name}`"
@@ -144,33 +137,6 @@ module Believer
         "#{full_table_name_prefix}#{undecorated_table_name(name)}#{table_name_suffix}"
       end
 
-      def deprecated_property_setter(property, value, block)
-        if block
-          ActiveSupport::Deprecation.warn(
-              "Calling set_#{property} is deprecated. If you need to lazily evaluate " \
-            "the #{property}, define your own `self.#{property}` class method. You can use `super` " \
-            "to get the default #{property} where you would have called `original_#{property}`."
-          )
-
-          define_attr_method property, value, false, &block
-        else
-          ActiveSupport::Deprecation.warn(
-              "Calling set_#{property} is deprecated. Please use `self.#{property} = 'the_name'` instead."
-          )
-
-          define_attr_method property, value, false
-        end
-      end
-
-      def deprecated_original_property_getter(property)
-        ActiveSupport::Deprecation.warn("original_#{property} is deprecated. Define self.#{property} and call super instead.")
-
-        if !instance_variable_defined?("@original_#{property}") && respond_to?("reset_#{property}")
-          send("reset_#{property}")
-        else
-          instance_variable_get("@original_#{property}")
-        end
-      end
     end
   end
 end

data/lib/believer/order_by.rb

@@ -1,7 +1,12 @@
 module Believer
+
+  # Encapsulates the CQL ORDER BY clause
   class OrderBy
+
     attr_reader :field, :dir
 
+    # @param field [Symbol] the field to order by
+    # @param dir [Symbol] the order direction. Can be :asc or :desc. Default is :asc
     def initialize(field, dir = :asc)
       raise "Invalid field: #{field}" unless field.is_a?(Symbol) || field.is_a?(String)
       raise "Direction must be one of (:asc|:desc): #{dir}" unless dir == :asc || dir == :desc
@@ -9,10 +14,12 @@ module Believer
       @dir = dir
     end
 
+    # Creates the CQL ORDER BY clause
     def to_cql
-      "ORDER BY #{@field} #{@dir.present? ? @dir.to_s.upcase : 'ASC'}"
+      "ORDER BY #{@field} #{@dir.to_s.upcase}"
     end
 
+    # Inverts the direction of the order
     def inverse
       OrderBy.new(@field, @dir == :asc ? :desc : :asc)
     end

data/lib/believer/persistence.rb

@@ -1,11 +1,15 @@
 module Believer
 
+  # Defines persistence functionality for a class
   module Persistence
-
     extend ::ActiveSupport::Concern
 
     module ClassMethods
 
+      # Creates 1 or more new instances, and persists them to the database.
+      # An optional block can be provided which is called for each created model.
+      #
+      # @param attributes [Enumerable] the attributes. If this is an array, it is assumed multiple models should be created
       def create(attributes = nil, &block)
         if attributes.is_a?(Array)
           attributes.collect { |attr| create(attr, &block) }
@@ -23,6 +27,7 @@ module Believer
       Insert.new(:record_class => self.class, :values => self).execute
     end
 
+    # Destroys the model.
     def destroy
       Delete.new(:record_class => self.class).where(key_values).execute
     end