sequel 1.3 → 1.4.0

data/lib/sequel_model/caching.rb

@@ -0,0 +1,42 @@
+module Sequel
+  class Model
+    def self.set_cache(store, opts = {})
+      @cache_store = store
+      if (ttl = opts[:ttl])
+        set_cache_ttl(ttl)
+      end
+      
+      meta_def(:[]) do |*args|
+        if (args.size == 1) && (Hash === (h = args.first))
+          return dataset[h]
+        end
+        
+        unless obj = @cache_store.get(cache_key_from_values(args))
+          obj = dataset[primary_key_hash((args.size == 1) ? args.first : args)]
+          @cache_store.set(cache_key_from_values(args), obj, cache_ttl)
+        end
+        obj
+      end
+      
+      class_def(:set) {|v| store.delete(cache_key); super}
+      class_def(:save) {store.delete(cache_key); super}
+      class_def(:delete) {store.delete(cache_key); super}
+    end
+    
+    def self.set_cache_ttl(ttl)
+      @cache_ttl = ttl
+    end
+    
+    def self.cache_store
+      @cache_store
+    end
+    
+    def self.cache_ttl
+      @cache_ttl ||= 3600
+    end
+    
+    def self.cache_key_from_values(values)
+      "#{self}:#{values.join(',')}"
+    end
+  end
+end

data/lib/sequel_model/eager_loading.rb

@@ -0,0 +1,169 @@
+# Eager loading makes it so that you can load all associated records for a
+# set of objects in a single query, instead of a separate query for each object.
+#
+# The basic idea for how it works is that the dataset is first loaded normally.
+# Then it goes through all associations that have been specified via .eager.
+# It loads each of those associations separately, then associates them back
+# to the original dataset via primary/foreign keys.  Due to the necessity of
+# all objects being present, you need to use .all to use eager loading, as it
+# can't work with .each.
+#
+# This implementation avoids the complexity of extracting an object graph out
+# of a single dataset, by building the object graph out of multiple datasets,
+# one for each association.  By using a separate dataset for each association,
+# it avoids problems such as aliasing conflicts and creating cartesian product
+# result sets if multiple *_to_many eager associations are requested.
+#
+# One limitation of using this method is that you cannot filter the dataset
+# based on values of columns in an associated table, since the associations are loaded
+# in separate queries.  To do that you need to load all associations in the
+# same query, and extract an object graph from the results of that query.
+#
+# You can cascade the eager loading (loading associations' associations)
+# with no limit to the depth of the cascades.  You do this by passing a hash to .eager
+# with the keys being associations of the current model and values being
+# associations of the model associated with the current model via the key.
+#
+# The associations' order, if defined, is respected.  You cannot eagerly load
+# an association with a block argument, as the block argument is evaluated in
+# terms of a specific instance of the model, and no specific instance exists
+# when eagerly loading.
+module Sequel::Model::Associations::EagerLoading
+  # Add associations to the list of associations to eagerly load.
+  # Associations can be a symbol or a hash with symbol keys (for cascaded
+  # eager loading). Examples:
+  #
+  #  Album.eager(:artist).all
+  #  Album.eager(:artist, :genre).all
+  #  Album.eager(:artist).eager(:genre).all
+  #  Artist.eager(:albums=>:tracks).all
+  #  Artist.eager(:albums=>{:tracks=>:genre}).all
+  def eager(*associations)
+    raise(ArgumentError, 'No model for this dataset') unless @opts[:models] && model = @opts[:models][nil]
+    opt = @opts[:eager]
+    opt = opt ? opt.dup : {}
+    check = Proc.new do |a|
+      raise(ArgumentError, 'Invalid association') unless reflection = model.association_reflection(a)
+      raise(ArgumentError, 'Cannot eagerly load associations with block arguments') if reflection[:block]
+    end
+    associations.flatten.each do |association|
+      case association
+        when Symbol
+          check.call(association)
+          opt[association] = nil
+        when Hash
+          association.keys.each{|assoc| check.call(assoc)}
+          opt.merge!(association)
+        else raise(ArgumentError, 'Associations must be in the form of a symbol or hash')
+      end
+    end
+    ds = clone(:eager=>opt)
+    ds.add_callback(:post_load, :eager_load) unless @opts[:eager] 
+    ds
+  end
+  
+  private
+    # Eagerly load all specified associations 
+    def eager_load(a)
+      return if a.empty?
+      # Current model class
+      model = @opts[:models][nil]
+      # All associations to eager load
+      eager_assoc = @opts[:eager]
+      # Key is foreign/primary key name symbol
+      # Value is hash with keys being foreign/primary key values (generally integers)
+      #  and values being an array of current model objects with that
+      #  specific foreign/primary key
+      key_hash = {}
+      # array of attribute_values keys to monitor
+      keys = []
+      # Reflections for all associations to eager load
+      reflections = eager_assoc.keys.collect{|assoc| model.association_reflection(assoc)}
+
+      # Populate keys to monitor
+      reflections.each do |reflection|
+        key = reflection[:type] == :many_to_one ? reflection[:key] : model.primary_key
+        next if key_hash[key]
+        key_hash[key] = {}
+        keys << key
+      end
+      
+      # Associate each object with every key being monitored
+      a.each do |r|
+        keys.each do |key|
+          ((key_hash[key][r[key]] ||= []) << r) if r[key]
+        end
+      end
+      
+      # Iterate through eager associations and assign instance variables
+      # for the association for all model objects
+      reflections.each do |reflection|
+        assoc_class = model.send(:associated_class, reflection)
+        assoc_name = reflection[:name]
+        # Proc for setting cascaded eager loading
+        cascade = Proc.new do |d|
+          if c = eager_assoc[assoc_name]
+            d = d.eager(c)
+          end
+          if c = reflection[:eager]
+            d = d.eager(c)
+          end
+          d
+        end
+        case rtype = reflection[:type]
+          when :many_to_one
+            key = reflection[:key]
+            h = key_hash[key]
+            keys = h.keys
+            # No records have the foreign key set for this association, so skip it
+            next unless keys.length > 0
+            ds = assoc_class.filter(assoc_class.primary_key=>keys)
+            ds = cascade.call(ds)
+            ds.all do |assoc_object|
+              h[assoc_object.pk].each do |object|
+                object.instance_variable_set(:"@#{assoc_name}", assoc_object)
+              end
+            end
+          when :one_to_many, :many_to_many
+            if rtype == :one_to_many
+              fkey = key = reflection[:key]
+              h = key_hash[model.primary_key]
+              reciprocal = model.send(:reciprocal_association, reflection)
+              ds = assoc_class.filter(key=>h.keys)
+            else
+              assoc_table = assoc_class.table_name
+              left = reflection[:left_key]
+              right = reflection[:right_key]
+              right_pk = (reflection[:right_primary_key] || :"#{assoc_table}__#{assoc_class.primary_key}")
+              join_table = reflection[:join_table]
+              fkey = (opts[:left_key_alias] ||= :"x_foreign_key_x")
+              table_selection = (opts[:select] ||= assoc_table.all)
+              key_selection = (opts[:left_key_select] ||= :"#{join_table}__#{left}___#{fkey}")
+              h = key_hash[model.primary_key]
+              ds = assoc_class.select(table_selection, key_selection).inner_join(join_table, right=>right_pk, left=>h.keys)
+            end
+            if order = reflection[:order]
+              ds = ds.order(order)
+            end
+            ds = cascade.call(ds)
+            ivar = :"@#{assoc_name}"
+            h.values.each do |object_array|
+              object_array.each do |object|
+                object.instance_variable_set(ivar, [])
+              end
+            end
+            ds.all do |assoc_object|
+              fk = if rtype == :many_to_many
+                assoc_object.values.delete(fkey)
+              else
+                assoc_object[fkey]
+              end
+              h[fk].each do |object|
+                object.instance_variable_get(ivar) << assoc_object
+                assoc_object.instance_variable_set(reciprocal, object) if reciprocal
+              end
+            end
+        end
+      end
+    end
+end

data/lib/sequel_model/hooks.rb

@@ -0,0 +1,55 @@
+module Sequel
+  class Model
+    HOOKS = [
+      :after_initialize,
+      :before_create,
+      :after_create,
+      :before_update,
+      :after_update,
+      :before_save,
+      :after_save,
+      :before_destroy,
+      :after_destroy
+    ]
+    
+    # Some fancy code generation here in order to define the hook class methods...
+    HOOK_METHOD_STR = %Q{
+      def self.%s(method = nil, &block)
+        unless block
+          (raise SequelError, 'No hook method specified') unless method
+          block = proc {send method}
+        end
+        add_hook(%s, &block)
+      end
+    }
+    
+    def self.def_hook_method(m) #:nodoc:
+      instance_eval(HOOK_METHOD_STR % [m.to_s, m.inspect])
+    end
+    
+    HOOKS.each {|h| define_method(h) {}}
+    HOOKS.each {|h| def_hook_method(h)}
+    
+    # Returns the hooks hash for the model class.
+    def self.hooks #:nodoc:
+      @hooks ||= Hash.new {|h, k| h[k] = []}
+    end
+    
+    def self.add_hook(hook, &block) #:nodoc:
+      chain = hooks[hook]
+      chain << block
+      define_method(hook) do 
+        return false if super == false
+        chain.each {|h| break false if instance_eval(&h) == false}
+      end
+    end
+
+    # Returns true if the model class or any of its ancestors have defined
+    # hooks for the given hook key. Notice that this method cannot detect 
+    # hooks defined using overridden methods.
+    def self.has_hooks?(key)
+      has = hooks[key] && !hooks[key].empty?
+      has || ((self != Model) && superclass.has_hooks?(key))
+    end
+  end
+end

data/lib/sequel_model/plugins.rb

@@ -0,0 +1,47 @@
+module Sequel
+  module Plugins; end
+  
+  class Model
+    class << self
+      # Loads a plugin for use with the model class, passing optional arguments
+      # to the plugin.
+      def is(plugin, *args)
+        m = plugin_module(plugin)
+        if m.respond_to?(:apply)
+          m.apply(self, *args)
+        end
+        if m.const_defined?("InstanceMethods")
+          class_def(:"#{plugin}_opts") {args.first}
+          include(m::InstanceMethods)
+        end
+        if m.const_defined?("ClassMethods")
+          meta_def(:"#{plugin}_opts") {args.first}
+          metaclass.send(:include, m::ClassMethods)
+        end
+        if m.const_defined?("DatasetMethods")
+          unless @dataset
+            raise Sequel::Error, "Plugin cannot be applied because the model class has no dataset"
+          end
+          dataset.meta_def(:"#{plugin}_opts") {args.first}
+          dataset.metaclass.send(:include, m::DatasetMethods)
+        end
+      end
+      alias_method :is_a, :is
+    
+      # Returns the module for the specified plugin. If the module is not 
+      # defined, the corresponding plugin gem is automatically loaded.
+      def plugin_module(plugin)
+        module_name = plugin.to_s.gsub(/(^|_)(.)/) {$2.upcase}
+        if not Sequel::Plugins.const_defined?(module_name)
+          require plugin_gem(plugin)
+        end
+        Sequel::Plugins.const_get(module_name)
+      end
+
+      # Returns the gem name for the given plugin.
+      def plugin_gem(plugin)
+        "sequel_#{plugin}"
+      end
+    end
+  end
+end

data/lib/sequel_model/pretty_table.rb

@@ -0,0 +1,73 @@
+module Sequel
+  # Prints nice-looking plain-text tables
+  # +--+-------+
+  # |id|name   |
+  # |--+-------|
+  # |1 |fasdfas|
+  # |2 |test   |
+  # +--+-------+
+  module PrettyTable
+    def self.records_columns(records)
+      columns = []
+      records.each do |r|
+        if Array === r && (k = r.keys)
+          return k
+        elsif Hash === r
+          r.keys.each {|k| columns << k unless columns.include?(k)}
+        end
+      end
+      columns
+    end
+    
+    def self.column_sizes(records, columns)
+      sizes = Hash.new {0}
+      columns.each do |c|
+        s = c.to_s.size
+        sizes[c.to_sym] = s if s > sizes[c.to_sym]
+      end
+      records.each do |r|
+        columns.each do |c|
+          s = r[c].to_s.size
+          sizes[c.to_sym] = s if s > sizes[c.to_sym]
+        end
+      end
+      sizes
+    end
+    
+    def self.separator_line(columns, sizes)
+      l = ''
+      '+' + columns.map {|c| '-' * sizes[c]}.join('+') + '+'
+    end
+    
+    def self.format_cell(size, v)
+      case v
+      when Bignum, Fixnum
+        "%#{size}d" % v
+      when Float
+        "%#{size}g" % v
+      else
+        "%-#{size}s" % v.to_s
+      end
+    end
+    
+    def self.data_line(columns, sizes, record)
+      '|' + columns.map {|c| format_cell(sizes[c], record[c])}.join('|') + '|'
+    end
+    
+    def self.header_line(columns, sizes)
+      '|' + columns.map {|c| "%-#{sizes[c]}s" % c.to_s}.join('|') + '|'
+    end
+    
+    def self.print(records, columns = nil) # records is an array of hashes
+      columns ||= records_columns(records)
+      sizes = column_sizes(records, columns)
+      
+      puts separator_line(columns, sizes)
+      puts header_line(columns, sizes)
+      puts separator_line(columns, sizes)
+      records.each {|r| puts data_line(columns, sizes, r)}
+      puts separator_line(columns, sizes)
+    end
+  end
+end
+

data/lib/sequel_model/record.rb

@@ -0,0 +1,336 @@
+module Sequel
+  class Model
+    attr_reader :values
+    attr_reader :changed_columns
+    
+    # Returns value of attribute.
+    def [](column)
+      @values[column]
+    end
+    # Sets value of attribute and marks the column as changed.
+    def []=(column, value)
+      # If it is new, it doesn't have a value yet, so we should
+      # definitely set the new value.
+      # If the column isn't in @values, we can't assume it is
+      # NULL in the database, so assume it has changed.
+      if new? || !@values.include?(column) || value != @values[column]
+        @changed_columns << column unless @changed_columns.include?(column)
+        @values[column] = value
+      end
+    end
+
+    # Enumerates through all attributes.
+    #
+    # === Example:
+    #   Ticket.find(7).each { |k, v| puts "#{k} => #{v}" }
+    def each(&block)
+      @values.each(&block)
+    end
+    # Returns attribute names.
+    def keys
+      @values.keys
+    end
+
+    # Returns value for <tt>:id</tt> attribute.
+    def id
+      @values[:id]
+    end
+
+    # Compares model instances by values.
+    def ==(obj)
+      (obj.class == model) && (obj.values == @values)
+    end
+
+    # Compares model instances by pkey.
+    def ===(obj)
+      (obj.class == model) && (obj.pk == pk)
+    end
+
+    # Returns key for primary key.
+    def self.primary_key
+      :id
+    end
+    
+    # Returns primary key attribute hash.
+    def self.primary_key_hash(value)
+      {:id => value}
+    end
+    
+    # Sets primary key, regular and composite are possible.
+    #
+    # == Example:
+    #   class Tagging < Sequel::Model
+    #     # composite key
+    #     set_primary_key :taggable_id, :tag_id
+    #   end
+    #
+    #   class Person < Sequel::Model
+    #     # regular key
+    #     set_primary_key :person_id
+    #   end
+    #
+    # <i>You can even set it to nil!</i>
+    def self.set_primary_key(*key)
+      # if k is nil, we go to no_primary_key
+      if key.empty? || (key.size == 1 && key.first == nil)
+        return no_primary_key
+      end
+      
+      # backwards compat
+      key = (key.length == 1) ? key[0] : key.flatten
+
+      # redefine primary_key
+      meta_def(:primary_key) {key}
+      
+      unless key.is_a? Array # regular primary key
+        class_def(:this) do
+          @this ||= dataset.filter(key => @values[key]).limit(1).naked
+        end
+        class_def(:pk) do
+          @pk ||= @values[key]
+        end
+        class_def(:pk_hash) do
+          @pk ||= {key => @values[key]}
+        end
+        class_def(:cache_key) do
+          pk = @values[key] || (raise Error, 'no primary key for this record')
+          @cache_key ||= "#{self.class}:#{pk}"
+        end
+        meta_def(:primary_key_hash) do |v|
+          {key => v}
+        end
+      else # composite key
+        exp_list = key.map {|k| "#{k.inspect} => @values[#{k.inspect}]"}
+        block = eval("proc {@this ||= self.class.dataset.filter(#{exp_list.join(',')}).limit(1).naked}")
+        class_def(:this, &block)
+        
+        exp_list = key.map {|k| "@values[#{k.inspect}]"}
+        block = eval("proc {@pk ||= [#{exp_list.join(',')}]}")
+        class_def(:pk, &block)
+        
+        exp_list = key.map {|k| "#{k.inspect} => @values[#{k.inspect}]"}
+        block = eval("proc {@this ||= {#{exp_list.join(',')}}}")
+        class_def(:pk_hash, &block)
+        
+        exp_list = key.map {|k| '#{@values[%s]}' % k.inspect}.join(',')
+        block = eval('proc {@cache_key ||= "#{self.class}:%s"}' % exp_list)
+        class_def(:cache_key, &block)
+
+        meta_def(:primary_key_hash) do |v|
+          key.inject({}) {|m, i| m[i] = v.shift; m}
+        end
+      end
+    end
+    
+    def self.no_primary_key #:nodoc:
+      meta_def(:primary_key) {nil}
+      meta_def(:primary_key_hash) {|v| raise Error, "#{self} does not have a primary key"}
+      class_def(:this)      {raise Error, "No primary key is associated with this model"}
+      class_def(:pk)        {raise Error, "No primary key is associated with this model"}
+      class_def(:pk_hash)   {raise Error, "No primary key is associated with this model"}
+      class_def(:cache_key) {raise Error, "No primary key is associated with this model"}
+    end
+    
+    # Creates new instance with values set to passed-in Hash ensuring that
+    # new? returns true.
+    def self.create(values = {}, &block)
+      db.transaction do
+        obj = new(values, &block)
+        obj.save
+        obj
+      end
+    end
+    
+    # Updates the instance with the supplied values with support for virtual
+    # attributes, ignoring any values for which no setter method is available.
+    def update_with_params(values)
+      c = columns
+      values.each do |k, v| m = :"#{k}="
+        send(m, v) if c.include?(k) || respond_to?(m)
+      end
+      save_changes
+    end
+    alias_method :update_with, :update_with_params
+
+    class << self
+      def create_with_params(params)
+        record = new
+        record.update_with_params(params)
+        record
+      end
+      alias_method :create_with, :create_with_params
+    end
+    
+    # Returns (naked) dataset bound to current instance.
+    def this
+      @this ||= self.class.dataset.filter(:id => @values[:id]).limit(1).naked
+    end
+    
+    # Returns a key unique to the underlying record for caching
+    def cache_key
+      pk = @values[:id] || (raise Error, 'no primary key for this record')
+      @cache_key ||= "#{self.class}:#{pk}"
+    end
+
+    # Returns primary key column(s) for object's Model class.
+    def primary_key
+      @primary_key ||= self.class.primary_key
+    end
+    
+    # Returns the primary key value identifying the model instance. If the
+    # model's primary key is changed (using #set_primary_key or #no_primary_key)
+    # this method is redefined accordingly.
+    def pk
+      @pk ||= @values[:id]
+    end
+    
+    # Returns a hash identifying the model instance. Stock implementation.
+    def pk_hash
+      @pk_hash ||= {:id => @values[:id]}
+    end
+    
+    # Creates new instance with values set to passed-in Hash.
+    #
+    # This method guesses whether the record exists when
+    # <tt>new_record</tt> is set to false.
+    def initialize(values = nil, from_db = false, &block)
+      @changed_columns = []
+      unless from_db
+        @values = {}
+        if values
+          values.each do |k, v| m = :"#{k}="
+            if respond_to?(m)
+              send(m, v)
+              values.delete(k)
+            end
+          end
+          values.inject(@values) {|m, kv| m[kv[0].to_sym] = kv[1]; m}
+          # @values.merge!(values)
+        end
+      else
+        @values = values || {}
+      end
+
+      k = primary_key
+      @new = !from_db
+      
+      block[self] if block
+      after_initialize
+    end
+    
+    # Initializes a model instance as an existing record. This constructor is 
+    # used by Sequel to initialize model instances when fetching records.
+    def self.load(values)
+      new(values, true)
+    end
+    
+    # Returns true if the current instance represents a new record.
+    def new?
+      @new
+    end
+    alias :new_record? :new?
+    
+    # Returns true when current instance exists, false otherwise.
+    def exists?
+      this.count > 0
+    end
+    
+    # Creates or updates the associated record. This method can also
+    # accept a list of specific columns to update.
+    def save(*columns)
+      before_save
+      if @new
+        before_create
+        iid = model.dataset.insert(@values)
+        # if we have a regular primary key and it's not set in @values,
+        # we assume it's the last inserted id
+        if (pk = primary_key) && !(Array === pk) && !@values[pk]
+          @values[pk] = iid
+        end
+        if pk
+          @this = nil # remove memoized this dataset
+          refresh
+        end
+        @new = false
+        after_create
+      else
+        before_update
+        if columns.empty?
+          this.update(@values)
+          @changed_columns = []
+        else # update only the specified columns
+          this.update(@values.reject {|k, v| !columns.include?(k)})
+          @changed_columns.reject! {|c| columns.include?(c)}
+        end
+        after_update
+      end
+      after_save
+      self
+    end
+    
+    # Saves only changed columns or does nothing if no columns are marked as 
+    # chanaged.
+    def save_changes
+      save(*@changed_columns) unless @changed_columns.empty?
+    end
+
+    # Updates and saves values to database from the passed-in Hash.
+    def set(values)
+      v = values.inject({}) {|m, kv| m[kv[0].to_sym] = kv[1]; m}
+      this.update(v)
+      v.each {|k, v| @values[k] = v}
+    end
+    alias_method :update, :set
+    
+    # Reloads values from database and returns self.
+    def refresh
+      @values = this.first || raise(Error, "Record not found")
+      self
+    end
+    alias_method :reload, :refresh
+
+    # Like delete but runs hooks before and after delete.
+    def destroy
+      db.transaction do
+        before_destroy
+        delete
+        after_destroy
+      end
+    end
+    
+    # Deletes and returns self.
+    def delete
+      this.delete
+      self
+    end
+    
+    ATTR_RE = /^([a-zA-Z_]\w*)(=)?$/.freeze
+    EQUAL_SIGN = '='.freeze
+
+    def method_missing(m, *args) #:nodoc:
+      if m.to_s =~ ATTR_RE
+        att = $1.to_sym
+        write = $2 == EQUAL_SIGN
+        
+        # check whether the column is legal
+        unless @values.has_key?(att) || columns.include?(att)
+          raise Error, "Invalid column (#{att.inspect}) for #{self}"
+        end
+
+        # define the column accessor
+        Thread.exclusive do
+          if write
+            model.class_def(m) {|v| self[att] = v}
+          else
+            model.class_def(m) {self[att]}
+          end
+        end
+        
+        # call the accessor
+        respond_to?(m) ? send(m, *args) : super(m, *args)
+      else
+        super(m, *args)
+      end
+    end
+  end
+end