arunthampi-friendly 0.5.1

data/lib/friendly/indexer.rb

@@ -0,0 +1,50 @@
+module Friendly
+  class Indexer
+    class << self
+      attr_accessor :objects_per_iteration
+
+      def populate(klass, *fields)
+        instance.populate(klass, klass.storage_proxy.index_for_fields(fields))
+      end
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    self.objects_per_iteration = 100
+
+    attr_reader :datastore, :translator
+
+    def initialize(datastore  = Friendly.datastore, translator = Translator.new)
+      @datastore  = datastore
+      @translator = translator
+    end
+
+    def populate(klass, index)
+      count  = 0
+      loop do
+        rows = datastore.all(klass, Query.new(:offset! => count, 
+                                              :limit!  => objects_per_iteration, 
+                                              :order!  => :added_id.asc))
+        rows.each do |attrs|
+          begin
+            index.create(translator.to_object(klass, attrs))
+          rescue Sequel::DatabaseError
+            # we can safely swallow this exception because if we've gotten
+            # to this point, we can be pretty sure that it's a duplicate
+            # key error, which just means that the object already exists
+            # in the index
+          end
+        end
+        break if rows.length < objects_per_iteration
+        count += objects_per_iteration
+      end
+    end
+
+    protected
+      def objects_per_iteration
+        self.class.objects_per_iteration
+      end
+  end
+end

data/lib/friendly/memcached.rb

@@ -0,0 +1,48 @@
+module Friendly
+  class Memcached
+    attr_reader :cache
+
+    def initialize(cache)
+      @cache = cache
+    end
+
+    def set(key, value)
+      @cache.set(key, value)
+    end
+
+    def get(key)
+      @cache.get(key)
+    rescue ::Memcached::NotFound
+      if block_given?
+        miss(key) { yield }
+      end
+    end
+
+    def multiget(keys)
+      return {} if keys.empty?
+
+      hits         = @cache.get(keys)
+      missing_keys = keys - hits.keys
+
+      if !missing_keys.empty? && block_given?
+        missing_keys.each do |missing_key|
+          hits.merge!(missing_key => miss(missing_key) { yield(missing_key) })
+        end
+      end
+
+      hits
+    end
+
+    def delete(key)
+      cache.delete(key)
+    rescue ::Memcached::NotFound
+    end
+
+    protected
+      def miss(key)
+        value = yield
+        @cache.set(key, value)
+        value
+      end
+  end
+end

data/lib/friendly/newrelic.rb

@@ -0,0 +1,6 @@
+Friendly::Memcached.class_eval do
+  add_method_tracer :miss, "Friendly::Memcached/miss"
+  add_method_tracer :get, "Friendly::Memcached/get"
+  add_method_tracer :multiget, "Friendly::Memcached/multiget"
+end
+

data/lib/friendly/query.rb

@@ -0,0 +1,42 @@
+module Friendly
+  class Query
+    attr_reader :conditions, :limit, :order, 
+                :preserve_order, :offset, :uuid_klass,
+                :page, :per_page
+
+    def initialize(parameters, uuid_klass = UUID)
+      @uuid_klass = uuid_klass
+      @conditions = parameters.reject { |k,v| k.to_s =~ /!$/ }
+      @page       = (parameters[:page!] || 1).to_i
+      
+      [:per_page!, :limit!, :offset!, :order!, :preserve_order!].each do |p|
+        instance_variable_set("@#{p.to_s.gsub(/!/, '')}", parameters[p])
+      end
+
+      handle_pagination if per_page
+      convert_ids_to_uuids
+    end
+
+    def preserve_order?
+      preserve_order
+    end
+
+    def offset?
+      offset
+    end
+
+    protected
+      def convert_ids_to_uuids
+        if conditions[:id] && conditions[:id].is_a?(Array)
+          conditions[:id] = conditions[:id].map { |i| uuid_klass.new(i) }
+        elsif conditions[:id]
+          conditions[:id] = uuid_klass.new(conditions[:id])
+        end
+      end
+
+      def handle_pagination
+        @limit  = per_page
+        @offset = (page - 1) * per_page
+      end
+  end
+end

data/lib/friendly/scope.rb

@@ -0,0 +1,100 @@
+module Friendly
+  class Scope
+    attr_reader :klass, :parameters
+
+    def initialize(klass, parameters)
+      @klass      = klass
+      @parameters = parameters
+    end
+
+    # Fetch all documents at this scope.
+    #
+    # @param [Hash] extra_parameters add extra parameters to this query.
+    #
+    def all(extra_parameters = {})
+      klass.all(params(extra_parameters))
+    end
+
+    # Fetch the first document at this scope.
+    #
+    # @param [Hash] extra_parameters add extra parameters to this query.
+    #
+    def first(extra_parameters = {})
+      klass.first(params(extra_parameters))
+    end
+
+    # Paginate the documents at this scope.
+    #
+    # @param [Hash] extra_parameters add extra parameters to this query.
+    # @return WillPaginate::Collection
+    #
+    def paginate(extra_parameters = {})
+      klass.paginate(params(extra_parameters))
+    end
+
+    # Build an object at this scope.
+    #
+    #   e.g.
+    #     Post.scope(:name => "James").build.name # => "James"
+    #
+    # @param [Hash] extra_parameters add extra parameters to this query.
+    #
+    def build(extra_parameters = {})
+      klass.new(params_without_modifiers(extra_parameters))
+    end
+
+    # Create an object at this scope.
+    #
+    #   e.g.
+    #     @post = Post.scope(:name => "James").create
+    #     @post.new_record? # => false
+    #     @post.name # => "James"
+    #
+    # @param [Hash] extra_parameters add extra parameters to this query.
+    #
+    def create(extra_parameters = {})
+      klass.create(params_without_modifiers(extra_parameters))
+    end
+
+    # Override #respond_to? so that we can return true when it's another named_scope.
+    #
+    # @override
+    #
+    def respond_to?(method_name, include_private = false)
+      klass.has_named_scope?(method_name) || super
+    end
+
+    # Use method_missing to respond to other named scopes on klass.
+    # 
+    # @override
+    #
+    def method_missing(method_name, *args, &block)
+      respond_to?(method_name) ? chain_with(method_name) : super
+    end
+
+    # Chain with another one of klass's named_scopes.
+    #
+    # @param [Symbol] scope_name The name of the scope to chain with.
+    #
+    def chain_with(scope_name)
+      self + klass.send(scope_name)
+    end
+
+    # Create a new Scope that is the combination of self and other, where other takes priority
+    #
+    # @param [Friendly::Scope] other The scope to merge with.
+    #
+    def +(other_scope)
+      self.class.new(klass, parameters.merge(other_scope.parameters))
+    end
+
+    protected
+      def params(extra)
+        parameters.merge(extra)
+      end
+
+      def params_without_modifiers(extra)
+        params(extra).reject { |k,v| k.to_s =~ /!$/ }
+      end
+  end
+end

data/lib/friendly/scope_proxy.rb

@@ -0,0 +1,43 @@
+module Friendly
+  class ScopeProxy
+    attr_reader :klass, :scope_klass, :scopes
+
+    def initialize(klass, scope_klass = Scope)
+      @klass       = klass
+      @scope_klass = scope_klass
+      @scopes      = {}
+    end
+
+    def add_named(name, parameters)
+      scopes[name] = parameters
+      add_scope_method_to_klass(name)
+    end
+
+    def get(name)
+      scopes[name]
+    end
+
+    def get_instance(name)
+      scope_klass.new(klass, get(name))
+    end
+
+    def ad_hoc(parameters)
+      scope_klass.new(klass, parameters)
+    end
+
+    def has_named_scope?(name)
+      scopes.has_key?(name)
+    end
+
+    protected
+      def add_scope_method_to_klass(scope_name)
+        klass.class_eval do
+          eval <<-__END__
+            def self.#{scope_name}
+              scope_proxy.get_instance(:#{scope_name})
+            end
+          __END__
+        end
+      end
+  end
+end

data/lib/friendly/sequel_monkey_patches.rb

@@ -0,0 +1,34 @@
+require 'sequel'
+
+# Out of the box, Sequel uses IS TRUE/FALSE for boolean parameters
+# This prevents MySQL from using indexes.
+#
+# This patch fixes that.
+module Sequel
+  module SQL
+    class BooleanExpression
+      def self.from_value_pairs(pairs, op=:AND, negate=false)
+        pairs = pairs.collect do |l,r|
+          ce = case r
+          when Range
+            new(:AND, new(:>=, l, r.begin), new(r.exclude_end? ? :< : :<=, l, r.end))
+          when Array, ::Sequel::Dataset, SQLArray
+            new(:IN, l, r)
+          when NegativeBooleanConstant
+            new(:"IS NOT", l, r.constant)
+          when BooleanConstant
+            new(:IS, l, r.constant)
+          when NilClass
+            new(:IS, l, r)
+          when Regexp
+            StringExpression.like(l, r)
+          else
+            new(:'=', l, r)
+          end
+          negate ? invert(ce) : ce
+        end
+        pairs.length == 1 ? pairs.at(0) : new(op, *pairs)
+      end
+    end
+  end
+end

data/lib/friendly/storage.rb

@@ -0,0 +1,31 @@
+module Friendly
+  class Storage
+    def create(document)
+      raise NotImplementedError, "#{self.class.name}#create is not implemented."
+    end
+
+    def update(document)
+      raise NotImplementedError, "#{self.class.name}#update is not implemented."
+    end
+
+    def destroy(document)
+      raise NotImplementedError, "#{self.class.name}#destroy is not implemented."
+    end
+
+    def first(conditions)
+      raise NotImplementedError, "#{self.class.name}#first is not implemented."
+    end
+
+    def all(conditions)
+      raise NotImplementedError, "#{self.class.name}#all is not implemented."
+    end
+
+    def count(query)
+      raise NotImplementedError, "#{self.class.name}#count is not implemented."
+    end
+
+    def satisfies?(conditions)
+      raise NotImplementedError, "#{self.class.name}#satisfies? is not implemented."
+    end
+  end
+end

data/lib/friendly/storage_factory.rb

@@ -0,0 +1,24 @@
+module Friendly
+  class StorageFactory
+    attr_reader :table_klass, :index_klass, :cache_klass
+
+    def initialize(table_klass = DocumentTable, index_klass = Index,
+                   cache_klass = Cache)
+      @table_klass = table_klass
+      @index_klass = index_klass
+      @cache_klass = cache_klass
+    end
+
+    def document_table(*args)
+      table_klass.new(*args)
+    end
+
+    def index(*args)
+      index_klass.new(*args)
+    end
+
+    def cache(*args)
+      cache_klass.cache_for(*args)
+    end
+  end
+end

data/lib/friendly/storage_proxy.rb

@@ -0,0 +1,111 @@
+require 'friendly/storage_factory'
+require 'friendly/table_creator'
+
+module Friendly
+  class StorageProxy
+    attr_reader :klass, :storage_factory, :tables, :table_creator, :caches
+
+    def initialize(klass, storage_factory = StorageFactory.new,
+                    table_creator=TableCreator.new)
+      super()
+      @klass           = klass
+      @storage_factory = storage_factory
+      @table_creator   = table_creator
+      @tables          = [storage_factory.document_table(klass)]
+      @caches          = []
+    end
+
+    def first(conditions)
+      first_from_cache(conditions) do
+        index_for(conditions).first(conditions)
+      end
+    end
+
+    def all(query)
+      objects = perform_all(query).compact
+      if query.preserve_order?
+        order = query.conditions[:id]
+        objects.sort { |a,b| order.index(a.id) <=> order.index(b.id) }
+      else
+        objects
+      end
+    end
+
+    def count(query)
+      index_for(query).count(query)
+    end
+
+    def add(*args)
+      tables << storage_factory.index(klass, *args)
+    end
+
+    def cache(fields, options = {})
+      caches << storage_factory.cache(klass, fields, options)
+    end
+
+    def create(document)
+      each_store { |s| s.create(document) }
+    end
+
+    def update(document)
+      each_store { |s| s.update(document) }
+    end
+
+    def destroy(document)
+      stores.reverse.each { |i| i.destroy(document) }
+    end
+
+    def create_tables!
+      tables.each { |t| table_creator.create(t) }
+    end
+
+    def index_for(conditions)
+      index = tables.detect { |i| i.satisfies?(conditions) }
+      if index.nil?
+        raise MissingIndex, "No index found to satisfy: #{conditions.inspect}."
+      end
+      index
+    end
+
+    def index_for_fields(fields)
+      tables.detect do |t|
+        t.respond_to?(:fields) && t.fields == fields
+      end.tap do |i|
+        raise MissingIndex, "No index found matching #{fields.join(", ")}." if i.nil?
+      end
+    end
+
+    protected
+      def each_store
+        stores.each { |s| yield(s) }
+      end
+
+      def stores
+        tables + caches
+      end
+
+      def first_from_cache(query)
+        cache = cache_for(query)
+        if cache
+          cache.first(query) { yield }
+        else
+          yield
+        end
+      end
+
+      def cache_for(query)
+        caches.detect { |c| c.satisfies?(query) }
+      end
+
+      def perform_all(query)
+        cache = cache_for(query)
+        if cache
+          cache.all(query) do |missing_key|
+            index_for(query).first(Query.new(:id => missing_key.split("/").last))
+          end
+        else
+          index_for(query).all(query)
+        end
+      end
+  end
+end