sequel_model 0.1

data/lib/sequel_model/base.rb

@@ -0,0 +1,97 @@
+module Sequel
+  class Model
+    # Returns the database associated with the Model class.
+    def self.db
+      @db ||= (superclass != Object) && superclass.db or
+      raise Error, "No database associated with #{self}"
+    end
+    
+    # Sets the database associated with the Model class.
+    def self.db=(db)
+      @db = db
+    end
+    
+    # Called when a database is opened in order to automatically associate the
+    # first opened database with model classes.
+    def self.database_opened(db)
+      @db = db if (self == Model) && !@db
+    end
+
+    # Returns the dataset associated with the Model class.
+    def self.dataset
+      @dataset || super_dataset or
+      raise Error, "No dataset associated with #{self}"
+    end
+    
+    def self.super_dataset # :nodoc:
+      superclass.dataset if superclass and superclass.respond_to? :dataset
+    end
+    
+    # Returns the columns in the result set in their original order.
+    #
+    # See Dataset#columns for more information.
+    def self.columns
+      @columns ||= @dataset.columns or
+      raise Error, "Could not fetch columns for #{self}"
+    end
+
+    # Sets the dataset associated with the Model class.
+    def self.set_dataset(ds)
+      @db = ds.db
+      @dataset = ds
+      @dataset.set_model(self)
+      @dataset.transform(@transform) if @transform
+    end
+    
+    # Returns the database assoiated with the object's Model class.
+    def db
+      @db ||= model.db
+    end
+
+    # Returns the dataset assoiated with the object's Model class.
+    #
+    # See Dataset for more information.
+    def dataset
+      model.dataset
+    end
+    
+    # Returns the columns associated with the object's Model class.
+    def columns
+      model.columns
+    end
+
+    # Serializes column with YAML or through marshalling.
+    def self.serialize(*columns)
+      format = columns.pop[:format] if Hash === columns.last
+      format ||= :yaml
+      
+      @transform = columns.inject({}) do |m, c|
+        m[c] = format
+        m
+      end
+      @dataset.transform(@transform) if @dataset
+    end
+  end
+
+  # Lets you create a Model class with its table name already set or reopen
+  # an existing Model.
+  #
+  # Makes given dataset inherited.
+  #
+  # === Example:
+  #   class Comment < Sequel::Model(:comments)
+  #     table_name # => :comments
+  #
+  #     # ...
+  #
+  #   end
+  def self.Model(source)
+    @models ||= {}
+    @models[source] ||= Class.new(Sequel::Model) do
+      meta_def(:inherited) do |c|
+        c.set_dataset(source.is_a?(Dataset) ? source : c.db[source])
+      end
+    end
+  end
+  
+end

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/hooks.rb

@@ -0,0 +1,122 @@
+module Sequel
+  class Model
+    # This Hash translates verbs to methodnames used in chain manipulation
+    # methods.
+    VERB_TO_METHOD = {:prepend => :unshift, :append => :push}
+
+    # Returns @hooks which is an instance of Hash with its hook identifier
+    # (Symbol) as key and the chain of hooks (Array) as value.
+    #
+    # If it is not already set it'll be with an empty set of hooks.
+    # This behaviour will change in the future to allow inheritance.
+    #
+    # For the time being, you should be able to do:
+    #
+    #   class A < Sequel::Model(:a)
+    #     before_save { 'Do something...' }
+    #   end
+    #
+    #   class B < A
+    #     @hooks = superclass.hooks.clone
+    #     before_save # => [#<Proc:0x0000c6e8@(example.rb):123>]
+    #   end
+    #
+    # In this case you should remember that the clone doesn't create any new
+    # instances of your chains, so if you change the chain here it changes in
+    # its superclass, too.
+    def self.hooks
+      @hooks ||= Hash.new { |h, k| h[k] = [] }
+    end
+
+    # Adds block to chain of Hooks for <tt>:before_save</tt>.
+    # It can either be prepended (default) or appended.
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.before_save(verb = :prepend, &block)
+      hooks[:before_save].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:before_save]
+    end
+    # Adds block to chain of Hooks for <tt>:before_create</tt>.
+    # It can either be prepended (default) or appended.
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.before_create(verb = :prepend, &block)
+      hooks[:before_create].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:before_create]
+    end
+    # Adds block to chain of Hooks for <tt>:before_update</tt>.
+    # It can either be prepended (default) or appended.
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.before_update(verb = :prepend, &block)
+      hooks[:before_update].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:before_update]
+    end
+    # Adds block to chain of Hooks for <tt>:before_destroy</tt>.
+    # It can either be prepended (default) or appended.
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.before_destroy(verb = :prepend, &block)
+      hooks[:before_destroy].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:before_destroy]
+    end
+
+    # Adds block to chain of Hooks for <tt>:after_save</tt>.
+    # It can either be prepended or appended (default).
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.after_save(verb = :append, &block)
+      hooks[:after_save].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:after_save]
+    end
+    # Adds block to chain of Hooks for <tt>:after_create</tt>.
+    # It can either be prepended or appended (default).
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.after_create(verb = :append, &block)
+      hooks[:after_create].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:after_create]
+    end
+    # Adds block to chain of Hooks for <tt>:after_update</tt>.
+    # It can either be prepended or appended (default).
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.after_update(verb = :append, &block)
+      hooks[:after_update].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:after_update]
+    end
+    # Adds block to chain of Hooks for <tt>:after_destroy</tt>.
+    # It can either be prepended or appended (default).
+    #
+    # Returns the chain itself.
+    #
+    # Valid verbs are <tt>:prepend</tt> and <tt>:append</tt>.
+    def self.after_destroy(verb = :append, &block)
+      hooks[:after_destroy].send VERB_TO_METHOD.fetch(verb), block if block
+      hooks[:after_destroy]
+    end
+
+    # Evaluates specified chain of Hooks through <tt>instance_eval</tt>.
+    def run_hooks(key)
+      model.hooks[key].each {|h| instance_eval(&h)}
+    end
+    
+    def self.has_hooks?(key)
+      hooks[key] && !hooks[key].empty?
+    end
+  end
+end

data/lib/sequel_model/plugins.rb

@@ -0,0 +1,44 @@
+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")
+          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,309 @@
+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)
+      @values[column] = value
+      @changed_columns << column unless @changed_columns.include?(column)
+    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(:taggins)
+    #     # composite key
+    #     set_primary_key :taggable_id, :tag_id
+    #   end
+    #
+    #   class Person < Sequel::Model(:person)
+    #     # 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 = {})
+      db.transaction do
+        obj = new(values, true)
+        obj.save
+        obj
+      end
+    end
+    
+    class << self
+      def create_with_params(params)
+        create(params.reject {|k, v| !columns.include?(k.to_sym)})
+      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 value for primary key.
+    def pkey
+      warn "Model#pkey is deprecated. Please use Model#pk instead."
+      @pkey ||= @values[self.class.primary_key]
+    end
+    
+    # Returns the primary key value identifying the model instance. Stock implementation.
+    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 = {}, new_record = false, &block)
+      @values = values
+      @changed_columns = []
+
+      @new = new_record
+      unless @new # determine if it's a new record
+        k = self.class.primary_key
+        # if there's no primary key for the model class, or
+        # @values doesn't contain a primary key value, then 
+        # we regard this instance as new.
+        @new = (k == nil) || (!(Array === k) && !@values[k])
+      end
+      
+      block[self] if block
+    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)
+      run_hooks(:before_save)
+      if @new
+        run_hooks(: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
+        run_hooks(:after_create)
+      else
+        run_hooks(: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
+        run_hooks(:after_update)
+      end
+      run_hooks(: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)
+      this.update(values)
+      values.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
+
+    # Like delete but runs hooks before and after delete.
+    def destroy
+      db.transaction do
+        run_hooks(:before_destroy)
+        delete
+        run_hooks(:after_destroy)
+      end
+    end
+    
+    # Deletes and returns self.
+    def delete
+      this.delete
+      self
+    end
+    
+    ATTR_RE = /^([a-zA-Z_]\w*)(=)?$/.freeze
+
+    def method_missing(m, *args) #:nodoc:
+      if m.to_s =~ ATTR_RE
+        att = $1.to_sym
+        write = $2 == '='
+        
+        # check whether the column is legal
+        unless columns.include?(att)
+          # if read accessor and a value exists for the column, we return it
+          if !write && @values.has_key?(att)
+            return @values[att]
+          end
+          
+          # otherwise, raise an error
+          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