merb_sequel 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,4 @@
+merb_sequel
+=================
+
+A plugin for the Merb framework that provides ....

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+PLUGIN = "merb_sequel"
+NAME = "merb_sequel"
+VERSION = "0.0.4"
+AUTHOR = "Duane Johnson"
+EMAIL = "canadaduane@gmail.com"
+HOMEPAGE = "http://merb-plugins.rubyforge.org/merb_sequel/"
+SUMMARY = "Merb plugin that provides support for the Sequel database object"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.requirements << 'merb'
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb_sequel.rb
+Add your Merb rake tasks to lib/merb_sequel/merbtasks.rb

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

@@ -0,0 +1,82 @@
+require 'fileutils'
+
+module Merb
+  module Orms
+    module Sequel
+      class << self
+        def config_file() MERB_ROOT / "config" / "database.yml" end
+        def sample_dest() MERB_ROOT / "config" / "database.sample.yml" end
+        def sample_source() File.dirname(__FILE__) / "database.sample.yml" end
+      
+        def copy_sample_config
+          FileUtils.cp sample_source, sample_dest unless File.exists?(sample_dest)
+        end
+      
+        def config
+          @config ||=
+            begin
+              # Convert string keys to symbols
+              full_config = Erubis.load_yaml_file(config_file)
+              config = (Merb::Plugins.config[:merb_sequel] = {})
+              (full_config[MERB_ENV.to_sym] || full_config[MERB_ENV]).each { |k, v| config[k.to_sym] = v }
+              config
+            end
+        end
+      
+        # Database connects as soon as the gem is loaded
+        def connect
+          if File.exists?(config_file)
+            puts "Connecting to database..."
+            # Load the correct Sequel adapter and set it up according to the yaml file
+            case config[:adapter]
+            when 'mysql'
+              require "sequel/mysql"
+              host = config[:host] || 'localhost'
+              user = config[:user] || config[:username] || 'root'
+              password = config[:password]
+              # Use Sequel::Model.db to access this object
+              ::Sequel.mysql(config[:database], :host => host, :user => user, :password => password, :logger => MERB_LOGGER)
+            when 'postgresql'
+              require "sequel/postgres"
+              host = config[:host] || 'localhost'
+              user = config[:user] || config[:username] || 'root'
+              password = config[:password]
+              encoding = config[:encoding] || config[:charset] || nil
+              
+              if encoding
+                ::Sequel.postgres(config[:database], :host => host, :user => user, :password => password, :encoding => encoding, :logger => MERB_LOGGER)
+              else
+                ::Sequel.postgres(config[:database], :host => host, :user => user, :password => password, :logger => MERB_LOGGER)
+              end
+            when 'sqlite'
+              require "sequel/sqlite"
+              if config[:database]
+                ::Sequel.sqlite(config[:database], :logger => MERB_LOGGER)
+              else
+                ::Sequel.sqlite(:logger => MERB_LOGGER)
+              end
+            else
+              require "sequel/sqlite"
+              p full_config
+              puts "No adapter specified in config/database.yml... trying a memory-only sqlite database"
+              ::Sequel.sqlite
+            end
+          else
+            copy_sample_config
+            puts "No database.yml file found in #{MERB_ROOT}/config."
+            puts "A sample file was created called database.sample.yml for you to copy and edit."
+            exit(1)
+          end
+        end
+        
+        # Registering this ORM lets the user choose sequel as a session store
+        # in merb.yml's session_store: option.
+        def register_session_type
+          Merb::Server.register_session_type("sequel",
+            "merb/session/sequel_session",
+            "Using Sequel database sessions")
+        end
+      end
+    end
+  end
+end

data/lib/merb/orms/sequel/database.sample.yml

@@ -0,0 +1,17 @@
+---
+# This is a sample database file for the Sequel ORM
+:development: &defaults
+  :adapter: mysql
+  :database: sample_development
+  :username: teh_user
+  :password: secrets
+  :host: localhost
+  :socket: /tmp/mysql.sock
+
+:test:
+  <<: *defaults
+  :database: sample_test
+
+:production:
+  <<: *defaults
+  :database: sample_production

data/lib/merb/session/001_add_sessions_table.rb

@@ -0,0 +1,14 @@
+class AddSessionsTable < Sequel::Migration
+  def up
+    create_table :sessions do
+      primary_key :id
+      varchar     :session_id, :size => 32, :unique => true
+      timestamp   :created_at
+      text        :data
+    end
+  end
+  
+  def down
+    execute 'DROP TABLE sessions'
+  end
+end

data/lib/merb/session/sequel_session.rb

@@ -0,0 +1,129 @@
+module Merb
+  module SessionMixin
+    def setup_session
+      MERB_LOGGER.info("Setting up session")
+      before = cookies[_session_id_key]
+      @_session, cookies[_session_id_key] = Merb::SequelSession.persist(cookies[_session_id_key])
+      @_fingerprint = Marshal.dump(@_session.data).hash
+      @_new_cookie = cookies[_session_id_key] != before
+    end
+  
+    def finalize_session
+      MERB_LOGGER.info("Finalize session")
+      @_session.save if @_fingerprint != Marshal.dump(@_session.data).hash
+      set_cookie(_session_id_key, @_session.values[:session_id], _session_expiry) if (@_new_cookie || @_session.needs_new_cookie)
+    end
+  end
+
+  table_name = (Merb::Plugins.config[:sequel][:session_table_name] || "sessions")
+
+  class SequelSession < Sequel::Model(table_name.to_sym)
+    set_schema do
+      primary_key :id
+      varchar :session_id
+      varchar :data
+    end
+  
+    attr_accessor :needs_new_cookie
+  
+    class << self
+      # Generates a new session ID and creates a row for the new session in the database.
+      def generate
+        create(:session_id => Merb::SessionMixin::rand_uuid, :data => marshal({}))
+      end
+    
+      # Gets the existing session based on the <tt>session_id</tt> available in cookies.
+      # If none is found, generates a new session.
+      def persist(session_id)
+        if session_id
+          session = find_by_session_id(session_id)
+        end
+        unless session
+          session = generate
+        end
+        [session, session.values[:session_id]]
+      end
+    
+      # Don't try to reload ARStore::Session in dev mode.
+      def reloadable? #:nodoc:
+        false
+      end
+    
+      def data_column_size_limit
+        255
+      end
+    
+      def marshal(data)   Base64.encode64(Marshal.dump(data)) if data end
+      def unmarshal(data)
+        Marshal.load(Base64.decode64(data)) if data
+      end
+      
+      alias :create_table! :create_table
+      alias :drop_table! :drop_table
+    end
+  
+    # Regenerate the Session ID
+    def regenerate
+      update_attributes(:session_id => Merb::SessionMixin::rand_uuid)
+      self.needs_new_cookie = true
+    end 
+  
+    # Recreates the cookie with the default expiration time 
+    # Useful during log in for pushing back the expiration date 
+    def refresh_expiration
+      self.needs_new_cookie = true
+    end
+  
+    # Lazy-delete of session data 
+    def delete
+      self.data = {}
+    end
+  
+    def [](key)
+      data[key]
+    end
+  
+    def []=(key, val)
+      data[key] = val
+    end
+  
+    # Lazy-unmarshal session state.
+    def data
+      @data ||= self.class.unmarshal(@values[:data]) || {}
+    end
+  
+    # Has the session been loaded yet?
+    def loaded?
+      !! @data
+    end
+  
+  private
+    attr_writer :data
+  
+    before_save do # marshal_data!
+      # return false if !loaded?
+      @values[:data] = self.class.marshal(self.data)
+    end
+  
+    # Ensures that the data about to be stored in the database is not
+    # larger than the data storage column. Raises
+    # ActionController::SessionOverflowError.
+    # before_save do # raise_on_session_data_overflow!
+      # return false if !loaded?
+      # limit = self.class.data_column_size_limit
+      # if loaded? and limit and read_attribute(@@data_column_name).size > limit
+        # raise MerbController::SessionOverflowError
+      # end
+    # end
+  end
+
+  unless Sequel::Model.db.table_exists?(table_name.to_sym)
+    puts "Warning: The database did not contain a '#{table_name}' table for sessions."
+
+    SequelSession.class_eval do
+      create_table unless table_exists?
+    end
+
+    puts "Created sessions table."
+  end
+end

data/lib/merb_sequel.rb

@@ -0,0 +1,12 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  if Merb::Server.app_loaded?
+    puts "Warning: The merb_sequel gem must be loaded before the application"
+  else
+    require "merb/orms/sequel/connection"
+    Merb::Orms::Sequel.connect
+    Merb::Orms::Sequel.register_session_type
+  end
+  
+  Merb::Plugins.add_rakefiles "merbtasks"
+end

data/lib/merbtasks.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+
+namespace :sequel do
+  namespace :db do
+    desc "Perform migration using migrations in schema/migrations"
+    task :migrate => :merb_env do
+      Sequel::Migrator.apply(Merb::Orms::Sequel.connect, "schema/migrations", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    end
+  end
+  
+  namespace :sessions do
+    desc "Creates session migration"
+    task :create => :merb_env do
+      dest = File.join(MERB_ROOT, "schema", "migrations","001_add_sessions_table.rb")
+      source = File.join(File.dirname(__FILE__), "merb", "session","001_add_sessions_table.rb")
+      
+      FileUtils.cp source, dest unless File.exists?(dest)
+    end
+    
+    desc "Clears sessions"
+    task :clear => :merb_env do
+      table_name = (Merb::Plugins.config[:sequel][:session_table_name] || "sessions")
+      
+      Merb::Orms::Sequel.connect.execute("DELETE FROM #{table_name}")
+    end
+  end
+end

data/specs/merb_sequel_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_sequel" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/specs/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.1
+specification_version: 1
+name: merb_sequel
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+date: 2007-09-24 00:00:00 -07:00
+summary: Merb plugin that provides support for the Sequel database object
+require_paths: 
+- lib
+email: canadaduane@gmail.com
+homepage: http://merb-plugins.rubyforge.org/merb_sequel/
+rubyforge_project: 
+description: Merb plugin that provides support for the Sequel database object
+autorequire: merb_sequel
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Duane Johnson
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb
+- lib/merb_sequel.rb
+- lib/merbtasks.rb
+- lib/merb/orms
+- lib/merb/session
+- lib/merb/orms/sequel
+- lib/merb/orms/sequel/connection.rb
+- lib/merb/orms/sequel/database.sample.yml
+- lib/merb/session/001_add_sessions_table.rb
+- lib/merb/session/sequel_session.rb
+- specs/merb_sequel_spec.rb
+- specs/spec_helper.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: []
+
+extensions: []
+
+requirements: 
+- merb
+dependencies: []
+