merb_sequel 1.0.0 → 1.0.9

data/CHANGELOG

@@ -0,0 +1,20 @@
+== 1.0.9 "Get official" 2009-11-10
+
+* Moved to gihub.com/merb and to merb_sequel
+* Added Merb::Sequel::VERSION constant
+* Moved to jeweler to match with Merb
+
+== 1.0.8
+
+* Dropped support for Sequel versions < 2.7.0
+
+== 1.0.7
+
+* Add support for ActiveModel via active_model plugin for Sequel > 3.5.0 or
+Merb::Orms::Sequel::Model::ActiveModelCompatibility module. Added
+:load_activemodel_compatibility configuration option to handle ActiveModel
+compatibility loading. See README for
+more information.
+* Removed Merb::Orms::Sequel::ModelExtensions in favour to Merb::Orms::Sequel::Model::ActiveModelCompatibility
+* Added spec.opts
+* Fixing session storage

data/README.rdoc

@@ -0,0 +1,139 @@
+= merb_sequel
+
+A plug-in for the Merb framework that provides support for Sequel models.
+
+This is fork of the code in the official merb-plugins 
+(http://github.com/wycats/merb-plugins) repository. I did separate repository 
+and Gem to allow faster and more independent release cycle to keep up with the 
+Sequel monthly releases.
+
+Plug-in is compatible with Merb 0.9.9 and higher and Sequel 1.4.0 and 
+higher including 2.x.x and <b>3.x.x</b>.
+
+<b>Any issues please report to http://github.com/pk/merb_sequel/issues</b>.
+
+
+== Install
+Since version 1.0.6 I've moved gem hosting to Gemcutter. So now you need 
+to install gem with:
+
+gem install pk-merb_sequel --source http://gemcutter.org
+
+For versions <= 1.0.5 I used GitHub:
+
+gem install pk-merb_sequel --source http://gems.github.com
+
+
+=== Merb < 1.1
+Add pk-merb_sequel as a dependency to your <b>config/dependencies.rb</b>:
+
+dependency 'pk-merb_sequel', :require_as => 'merb_sequel'
+
+<b>Because of Merb < 1.1 ORM plugin loading mechanism you neeed to change init.rb</b>:
+
+use_orm :sequel
+
+to
+
+Merb.orm = :sequel
+
+If you don't do this Merb will complain that there is no merb_sequel gem also 
+if you have merb_sequel installed it will load your system wide gem instead of
+the pk-merb_sequel gem.
+
+
+=== Merb >= 1.1, add it as a dependency to your <b>Gemfile</b>:
+    
+gem 'pk-merb_sequel', :require_as => 'merb_sequel'
+
+Add Sequel as you ORM of choice to init.rb:
+
+use_orm :sequel
+
+
+== Compatibility
+
+=== Ruby 1.8.7:
+Sequel 2.11.0:: All pass
+Sequel 2.12.0:: All pass
+Sequel 3.0.0::  All pass
+Sequel 3.5.0::  All pass
+
+=== Ruby 1.9.1:
+Sequel 2.11.0:: All pass except session spec failing due to Marshall issues.
+Sequel 2.12.0:: All pass except session spec failing due to Marshall issues.
+Sequel 3.0.0::  All pass except session spec failing due to Marshall issues.
+Sequel 3.5.0::  All pass except session spec failing due to Marshall issues.
+
+=== ActiveModel compatibility
+In Merb > 1.0.13 we use ActiveModel interface for the ORM plugins. merb_sequel
+now supports this for all versions of Sequel by including compatibilit layers
+by default or loading active model plugin when using Sequel > 3.5.0
+
+You can use configuration to not load compatibility layer:
+Merb::Plugins.config[:merb_sequel][:load_activemodel_compatibility] = false
+
+== RSpec transactional examples
+
+If you want to cut significantly runtime of your test suite which is using 
+Sequel you can enable transactional examples. Just add following line to 
+your spec_helper.rb or any spec you want to be transactional:
+
+    require 'merb_sequel/rspec/sequel'
+
+Now <b>each example is wrapped in a Sequel transaction and when example finishes
+Sequel::Error::Rollback is raised which cause transaction to rollback</b>.
+
+== Connection options & Settings
+
+Settings:
+
+* :load_activemodel_compatibility. By default is set to true. If set to false, ActiveModelCompatibility is not loaded.
+
+Merb Sequel plug-in uses config/database.yml for connection configuration.
+
+Options are:
+
+* adapter. :sqlite is assumed by default.
+* database, default is "hey_dude_configure_your_database". In case of SQLite this 
+  should be either :memory: or file path for SQLite.
+* db_type: default is nil. Use "mssql" to connect to MSSQL using ODBC.
+* encoding or charset, default is utf8.
+* host. localhost is assumed by default.
+* logger default is Merb.logger
+* password. <b>WARNING: default password is an empty string</b>.
+* socket Use socket to connect to DB. 
+* username or user, default is an empty string
+
+
+== Generators
+
+After you install the plug-in, merb-gen can generate Sequel models for you:
+
+    merb-gen model --orm=sequel Article
+
+same with the resources
+
+    merb-gen resource --orm=sequel Article
+
+
+<b>Note that if you have specified that you use Sequel in init.rb or environment
+specific init file (for instance, environments/development.rb)
+via use_orm :sequel, you don't need to specify --orm option explicitly when
+using merb-gen</b>.
+
+
+== Contributors
+
+Originally written by Duane Johnson (canadaduane at gmail.com).
+
+Contributions by:
+* Wayne E. Seguin
+* Lance Carlson
+* Jacob Dunphy
+* Lori Holden
+* Pavel Kunc
+* e-mac
+* Piotr Usewicz
+
+Maintained by Pavel Kunc (pavel.kunc at gmail.com)

data/Rakefile

@@ -1,77 +1,48 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require "rake/rdoctask"
-require "extlib"
-require 'merb-core/tasks/merb_rake_helper'
-require "spec/rake/spectask"
-
-##############################################################################
-# Package && release
-##############################################################################
-RUBY_FORGE_PROJECT  = "merb"
-PROJECT_URL         = "http://merbivore.com"
-PROJECT_SUMMARY     = "Merb plugin that provides support for Sequel and Sequel::Model"
-PROJECT_DESCRIPTION = PROJECT_SUMMARY
-
-GEM_AUTHOR = "Wayne E. Seguin, Lance Carlson, Lori Holden"
-GEM_EMAIL  = "wayneeseguin@gmail.com, lancecarlson@gmail.com, email@loriholden.com"
-
-GEM_NAME    = "merb_sequel"
-PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-GEM_VERSION = (Merb::MORE_VERSION rescue "1.0.0") + PKG_BUILD
-
-RELEASE_NAME    = "REL #{GEM_VERSION}"
-
-require "extlib/tasks/release"
-
-spec = Gem::Specification.new do |s|
-  s.rubyforge_project = RUBY_FORGE_PROJECT
-  s.name = GEM_NAME
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
-  s.summary = PROJECT_SUMMARY
-  s.description = PROJECT_DESCRIPTION
-  s.author = GEM_AUTHOR
-  s.email = GEM_EMAIL
-  s.homepage = PROJECT_URL
-  s.add_dependency("merb-core", ">= 0.9.9")
-  s.add_dependency("sequel",    ">= 1.4.0")
-  s.files = %w(LICENSE README Rakefile TODO Generators) + Dir.glob("{lib}/**/*")
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
+require "rubygems"
+require "rake"
+
+# Assume a typical dev checkout to fetch the current merb-core version
+require File.expand_path('../../merb/merb-core/lib/merb-core/version', __FILE__)
+
+# Load this library's version information
+require File.expand_path('../lib/merb_sequel/version', __FILE__)
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.version     = Merb::Sequel::VERSION
+    gemspec.name        = "merb_sequel"
+    gemspec.description = "Merb plugin that provides support for Sequel"
+    gemspec.summary     = "Merb plugin that provides support for Sequel"
+    gemspec.authors     = [ "Wayne E. Seguin", "Lance Carlson", "Lori Holden", "Pavel Kunc" ]
+    gemspec.email       = "wayneeseguin@gmail.com, lancecarlson@gmail.com, email@loriholden.com, pavel.kunc@gmail.com"
+    gemspec.homepage    = "http://github.com/merb/merb_sequel"
+    gemspec.files       = %w(CHANGELOG LICENSE Rakefile README.rdoc TODO Generators) + Dir['{lib,spec}/**/*']
+    # Runtime dependencies
+    gemspec.add_dependency "merb-core", ">= 0.9.9"
+    gemspec.add_dependency "sequel",    ">= 2.7.0"
+    # Development dependencies
+    gemspec.add_development_dependency "rspec", ">= 1.2.9"
+  end
 
-desc "Install the gem"
-task :install do
-  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
-end
+  Jeweler::GemcutterTasks.new
 
-desc "Uninstall the gem"
-task :uninstall do
-  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-desc "Create a gemspec file"
-task :gemspec do
-  File.open("#{GEM_NAME}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
-  end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-desc "Run all examples (or a specific spec with TASK=xxxx)"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_opts  = ["-cfs"]
-  t.spec_files = begin
-    if ENV["TASK"] 
-      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
-    else
-      FileList['spec/**/*_spec.rb']
-    end
-  end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
 desc 'Default: run spec examples'

data/lib/generators/templates/migration/schema/migrations/%file_name%.rb

@@ -1,6 +1,6 @@
-# For details on Sequel migrations see 
-# http://sequel.rubyforge.org/
-# http://sequel.rubyforge.org/rdoc/classes/Sequel/Database.html#M000607
+# For details on Sequel migrations see:
+#   * http://sequel.rubyforge.org/
+#   * http://sequel.rubyforge.org/rdoc-plugins/classes/Sequel/Migration.html
 
 class <%= class_name %> < Sequel::Migration
 

data/lib/generators/templates/resource_controller/app/controllers/%file_name%.rb

@@ -25,9 +25,10 @@ class <%= class_name %> < Application
   # POST /<%= resource_path %>
   def create
     @<%= singular_model %> = <%= model_class_name %>.new(params[:<%= singular_model %>])
-    if @<%= singular_model %>.save
+    begin
+      @<%= singular_model %>.save
       redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>, @<%= singular_model %>)
-    else
+    rescue Sequel::ValidationFailed
       render :new
     end
   end
@@ -44,10 +45,11 @@ class <%= class_name %> < Application
   def update
     @<%= singular_model %> = <%= model_class_name %>[params[:id]]
     raise NotFound unless @<%= singular_model %>
-    if @<%= singular_model %>.update(params[:<%= singular_model %>])
+    begin
+      @<%= singular_model %>.update(params[:<%= singular_model %>])
       redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>, @<%= singular_model %>)
-    else
-      raise BadRequest
+    rescue Sequel::ValidationFailed
+      render :edit
     end
   end
 
@@ -55,12 +57,13 @@ class <%= class_name %> < Application
   def destroy
     @<%= singular_model %> = <%= model_class_name %>[params[:id]]
     raise NotFound unless @<%= singular_model %>
-    if @<%= singular_model %>.destroy
+    begin
+      @<%= singular_model %>.destroy
       redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>s)
-    else
+    rescue Sequel::Error
       raise BadRequest
     end
   end
 
 end
-<% end -%>
+<% end -%>

data/lib/merb/orms/sequel/connection.rb

@@ -10,6 +10,14 @@ module Merb
         def config_file() Merb.dir_for(:config) / "database.yml" end
         def sample_dest() Merb.dir_for(:config) / "database.yml.sample" end
         def sample_source() File.dirname(__FILE__) / "database.yml.sample" end
+
+        # Determine if we use Sequel 3 or not
+        #
+        # ==== Returns
+        # Bool:: True if using Sequel >= 2.12.0 or False
+        def new_sequel?
+          !!(/^(2.12|3)/ =~ ::Sequel.version)
+        end
       
         def copy_sample_config
           FileUtils.cp sample_source, sample_dest unless File.exists?(sample_dest)
@@ -19,7 +27,7 @@ module Merb
           @config ||= begin
             # Convert string keys to symbols
             full_config = Erubis.load_yaml_file(config_file)
-            config = (Merb::Plugins.config[:merb_sequel] = {})
+            config = Merb::Plugins.config[:merb_sequel]
             (full_config[Merb.environment.to_sym] || full_config[Merb.environment] || full_config[:development]).each do |key, value|
               config[key.to_sym] = value
             end
@@ -66,6 +74,7 @@ module Merb
           options[:database] = config[:database] || "hey_dude_configure_your_database"
           # MSSQL support
           options[:db_type] = config[:db_type]  if config[:db_type]
+          options[:socket] = config[:socket] if config[:socket]
           options[:logger]   = Merb.logger
           options
         end

data/lib/merb/orms/sequel/model.rb

@@ -0,0 +1,38 @@
+module Merb
+  module Orms
+    module Sequel
+      module Model
+
+        # This code has been taken from Sequel 3.5.0
+        # Sequel::Plugins::ActiveModel
+        # http://sequel.rubyforge.org/rdoc-plugins/classes/Sequel/Plugins/ActiveModel.html
+        module ActiveModelCompatibility
+          # Record that an object was destroyed, for later use by
+          # destroyed?
+          def after_destroy
+            super
+            @destroyed = true
+          end
+
+          # Whether the object was destroyed by destroy.  Not true
+          # for objects that were deleted.
+          def destroyed?
+            @destroyed == true
+          end
+
+          # An alias for new?
+          def new_record?
+            new?
+          end
+
+          # With the ActiveModel plugin, Sequel model objects are already
+          # compliant, so this returns self.
+          def to_model
+            self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/merb/session/sequel_session.rb

@@ -1,10 +1,10 @@
 require 'sequel'
+require 'sequel/extensions/migration' if Merb::Orms::Sequel.new_sequel? 
 require 'merb-core/dispatch/session'
-require 'base64'
 
 module Merb
 
-  Merb::Plugins.config[:merb_sequel][:session_table_name] ||= "sessions"
+  Merb::Plugins.config[:merb_sequel][:session_table_name] ||= 'sessions'
 
   # Default session migration run if a sessions table does not yet exist.
   #
@@ -48,18 +48,26 @@ module Merb
       # ContainerSession:: The session corresponding to the ID.
       def retrieve_session(session_id)
         if item = find(:session_id => session_id)
-          item.data
+          Marshal.load(item.data.unpack('m').first)
         end
       end
 
       # ==== Parameters
       # session_id<String>:: ID of the session to set.
       # data<ContainerSession>:: The session to set.
-      def store_session(session_id, data)
-        if item = find(:session_id => session_id)
-          item.update(:data => data)
-        else
-          create(:session_id => session_id, :data => data, :created_at => Time.now)
+      def store_session(session_id, session_data)
+        session_data = session_data.empty? ? nil : [Marshal.dump(session_data)].pack('m')
+        begin
+          if item = self.find(:session_id => session_id)
+            item.update(:data => session_data)
+          else
+            item = self.new(:session_id => session_id,
+                            :data => session_data,
+                            :created_at => Time.now)
+            item.save
+          end
+        rescue => e
+          Merb.logger.error("#{e.message} when trying to save #{session_data}")
         end
       end
 
@@ -70,49 +78,20 @@ module Merb
           item.delete
         end
       end
-    
-      # ==== Returns
-      # Integer:: The maximum length of the 'data' column.
-      def data_column_size_limit
-        512 # TODO - figure out how much space we actually have
-      end
-
-      alias :create_table! :create_table
-      alias :drop_table! :drop_table
-    end
-
-    # Lazy-unserialize session state.
-    def data
-      @data ||= (@values[:data] ? Marshal.load(@values[:data]) : {})
-    end
-    
-    # Virtual attribute writer - override.
-    def data=(hsh)
-      @data = hsh if hsh.is_a?(Hash)
-    end
-
-    # Has the session been loaded yet?
-    def loaded?
-      !!@data
-    end
 
-    before_save do 
-      @values[:data] = Marshal.dump(self.data)
-      if @values[:data].size > self.class.data_column_size_limit
-        raise Merb::SessionMixin::SessionOverflow
-      end    
+      unless Merb::Orms::Sequel.new_sequel?
+        alias :create_table! :create_table
+        alias :drop_table! :drop_table
+      end
     end
-    
   end
   
   class SequelSession < SessionStoreContainer
-    
     # The session store type
     self.session_store_type = :sequel
     
     # The store object is the model class itself
     self.store = SequelSessionStore
-    
   end
 
 end