rails3_sequel 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Rachot Moragraan <janechii@gmail.com>
+
+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.md

@@ -0,0 +1,100 @@
+Rails 3 Sequel integration
+==========================
+
+*What works so far:*
+
++ Generators
+  - Models
+  - Migrations
+  - Observers
+  - Scaffolding Controllers - Sequel specific methods
+
++ Rake tasks
+  - mostly everything except anything that has to do with database creation (db:create, test:prepare, etc)
+
++ Railties
+  - uses database.yml configuration
+  - db connection
+  - query logging
+  - controller logging
+  - sane default sequel options and plugins for Rails
+
++ Gemspec
+
+*What is still need done:*
+
++ More testing
++ i18n
++ Session Store
++ more rake tasks
+
+Installation
+------------
+
+Build from the gem spec:
+
+    gem build rails3_sequel.gemspec
+
+Install:
+
+    gem install rails3_sequel-x.x.x.gem
+
+Usage - Railties
+----------------
+
+In your config/application.rb, take out the require "all" line and choose what frameworks you want to include like this:
+
+    require "action_controller/railtie"
+    require "action_mailer/railtie"
+    require "active_resource/railtie"
+    require "rails/test_unit/railtie"
+
+    # most importantly :)
+    require 'rails3_sequel/railtie'
+
+This way Rails wont load activerecord.
+
+Config options:
+
+    # set false to turn off Rails SQL logging
+    # true by default
+    config.rails_fancy_pants_logging = false
+
+    # specify your own loggers
+    config.loggers << Logger.new('test.log')
+
+    # shortcut to log_warn_duration in Sequel
+    config.log_warn_duration
+
+These options may be useful in the production configuration file. Rails does not log any SQL in production mode, but you may want to still log long running queries or queries with errors (which are supported by Sequel).
+
+Rake tasks usage.... todo
+
+Usage - Generators
+------------------
+
+Basics:
+
+    rails g scaffold cat name:String:pk specie:String:pk age:Integer
+
+Will use name and specie as composite primary key.
+
+
+Generator options (set in config/application.rb):
+
+    config.generators do |g|
+      g.orm :sequel, :autoincrement => true, :migration => true, :timestamps => false
+
+The above will always generate migration files, with autoincrement/serial field named "id", but no automatic timstamp fields updated_at or created_at.
+
+more to come...
+
+License
+-------
+
+MIT
+
+Credits
+-------
+
+Based partially on rails_sequel by Piotr Usewicz: http://github.com/pusewicz/rails_sequel

data/VERSION

@@ -0,0 +1 @@
+alpha

data/lib/rails/generators/sequel/active_model.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_model'
+
+module Sequel
+  module Generators
+    class ActiveModel < Rails::Generators::ActiveModel
+      def self.all(klass)
+        "#{klass}.all" 
+      end
+
+      def self.find(klass, params=nil)
+        "#{klass}[#{params}]"
+      end
+
+      def self.build(klass, params=nil)
+        if params then
+          "#{klass}.new(#{params})"
+        else
+          "#{klass}.new"
+        end
+      end
+
+      def save
+        # probably will set raise_on_save_failure to false by default when using Rails
+        "#{name}.save"
+      end
+
+      def update_attributes(params=nil)
+        "#{name}.update(#{params}) != false"
+      end
+
+      def errors
+        "#{name}.errors"
+      end
+
+      def destroy
+        "#{name}.destroy"
+      end
+    end
+  end
+end

data/lib/rails/generators/sequel/generated_attribute.rb

@@ -0,0 +1,64 @@
+module Rails
+  module Generators
+    class GeneratedAttribute
+      attr_accessor :name, :type
+
+      def initialize(name, type)
+        @name = name
+        @type = type.to_sym
+      end
+
+      def create_definition
+        case type
+          when :Text then "String :#{name}, :text => true"
+          when :Boolean then "TrueClass :#{name}"
+          else "#{type} :#{name}"
+        end
+      end
+
+      def alter_definition
+        case type
+          when :Text then "String, :text => true"
+          when :Boolean then "TrueClass"
+          else type
+        end
+      end
+
+      def field_type
+        @field_type ||= case type
+          when :Integer, :Float, :BigDecimal, :FixNum, :Numeric   then :text_field
+          when :DateTime, :Time                                   then :datetime_select
+          when :Date                                              then :date_select
+          when :String                                            then :text_field
+          when :Text                                              then :text_area
+          when :Boolean, :TrueClass, :FalseClass                  then :check_box
+          else
+            :text_field
+        end
+      end
+
+      def default
+        @default ||= case type
+          when :integer                     then 1
+          when :float                       then 1.5
+          when :decimal                     then "9.99"
+          when :datetime, :timestamp, :time then Time.now.to_s(:db)
+          when :date                        then Date.today.to_s(:db)
+          when :string                      then "MyString"
+          when :text                        then "MyText"
+          when :boolean                     then false
+          else
+            ""
+        end
+      end
+
+      def human_name
+        name.to_s.humanize
+      end
+
+      def reference?
+        false
+      end
+    end
+  end
+end

data/lib/rails/generators/sequel/migration/migration_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/sequel'
+
+module Sequel
+  module Generators
+    class MigrationGenerator < Base
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      def create_migration_file
+        set_local_assigns!
+        migration_template 'migration.rb', "db/migrate/#{file_name}.rb"
+      end
+
+      protected
+
+      attr_reader :migration_action
+
+      def set_local_assigns!
+        if file_name =~ /^(add|drop)_.*_(?:to|from)_(.*)/
+          @migration_action = $1
+          @table_name = $2.pluralize
+        end
+      end
+
+    end
+  end
+end

data/lib/rails/generators/sequel/migration/templates/migration.rb

@@ -0,0 +1,17 @@
+Class.new(Sequel::Migration) do
+  def up
+    Sequel::Model.db.alter_table :<%= table_name %> do
+<% for a in attributes do -%>
+      <%= migration_action %>_column :<%= a.name %><% if migration_action == 'add' %>, <%= a.alter_definition %><% end %>
+<% end -%>
+    end
+  end
+
+  def down
+    Sequel::Model.db.alter_table :<%= table_name %> do
+<% for a in attributes.reverse do -%>
+      <%= migration_action == 'add' ? 'drop' : 'add' %>_column :<%= a.name %><% if migration_action == 'drop' %>, <%= a.alter_definition %><% end %>
+<% end -%>
+    end
+  end
+end

data/lib/rails/generators/sequel/model/model_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/sequel'
+
+module Sequel
+  module Generators
+    class ModelGenerator < Base
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      check_class_collision
+
+      class_option :autoincrement, :type => :boolean
+      class_option :migration, :type => :boolean
+      class_option :timestamps, :type => :boolean
+      # TODO: parent option?
+
+      def create_migration_file
+        return unless options[:migration] && options[:parent].nil?
+        migration_template 'migration.rb', "db/migrate/create_#{table_name}.rb"
+      end
+
+      def create_model_file
+        template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+
+    end
+  end
+end

data/lib/rails/generators/sequel/model/templates/migration.rb

@@ -0,0 +1,22 @@
+Class.new(Sequel::Migration) do
+  def up
+    create_table :<%= table_name %> do
+<% if options[:autoincrement] then -%>
+      primary_key :id
+<% end -%>
+
+<% for a in attributes do -%>
+      <%= a.create_definition %>
+<% end -%>
+<% if options[:timestamps] then -%>
+      DateTime :created_at
+      DateTime :updated_at
+<% end -%>
+      <%= cpk %>
+    end
+  end
+
+  def down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/rails/generators/sequel/model/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < Sequel::Model
+end

data/lib/rails/generators/sequel/observer/observer_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/sequel'
+
+module Sequel
+  module Generators
+    class ObserverGenerator < Base
+      check_class_collision :suffix => "Observer"
+
+      def create_observer_file
+        template 'observer.rb', File.join('app/models', class_path, "#{file_name}_observer.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/rails/generators/sequel/observer/templates/observer.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Observer < ActiveModel::Observer
+end

data/lib/rails/generators/sequel.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/named_base'
+require 'rails/generators/migration'
+
+require 'rails/generators/sequel/active_model'
+
+# override Rails::Generators::GeneratedAttribute
+require 'rails/generators/sequel/generated_attribute'
+
+module Sequel
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(base_name, generator_name, 'templates'), File.dirname(__FILE__))
+      end
+
+      def cpk
+        if @primary_keys and !@primary_keys.empty? then
+          "primary_key([#{@primary_keys.map {|pk| ':' + pk}.join(', ')}])"
+        end
+      end
+
+      protected
+
+      def parse_attributes!
+        @primary_keys ||= []
+
+        self.attributes = (attributes || []).map do |key_value|
+          name, type, pk = key_value.split(':')
+          @primary_keys << name unless pk.nil?
+          Rails::Generators::GeneratedAttribute.new(name, type)
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+  end
+end

data/lib/rails3_sequel/database.rb

@@ -0,0 +1,25 @@
+module Rails
+  module Sequel
+    module Database    
+      mattr_reader :configurations
+
+      def self.configurations= (config)
+        @@configurations = config
+
+        for key,env in @@configurations do
+          # some translations
+          env['adapter'] = case env['adapter']
+            when 'postgresql' then 'postgres'
+            when 'sqlite3'    then 'sqlite'
+            else env['adapter']
+          end
+        end
+      end
+
+      # Connects to database using constructed Database Connection URI
+      def self.connect
+        ::Sequel.connect(self.configurations[Rails.env])
+      end
+    end
+  end
+end

data/lib/rails3_sequel/logging.rb

@@ -0,0 +1,27 @@
+module Rails
+  module Sequel
+    module Logging
+      def log_duration (duration, message)
+        @controller_runtime ||= 0
+        @controller_runtime += duration
+        ActiveSupport::Notifications.instrument('sequel.sql', 
+          :sql => message,
+          :name => 'SQL',
+          :duration => duration * 1000
+        )
+        super(duration, message)
+      end
+
+      def log_each (level, message)
+        # Rails logging is handled by the log subscriber
+        less_rails = @loggers - [Rails.logger]
+        less_rails.each { |logger| logger.send(level, message) }
+      end
+
+      def reset_runtime
+        rt, @controller_runtime = @controller_runtime, 0
+        rt.to_f * 1000
+      end
+    end
+  end
+end

data/lib/rails3_sequel/railtie.rb

@@ -0,0 +1,58 @@
+require 'rails'
+require 'active_model/railtie'
+
+# For now, action_controller must always be present with
+# rails, so let's make sure that it gets required before
+# here. This is needed for correctly setting up the middleware.
+# In the future, this might become an optional require.
+require "action_controller/railtie"
+
+require 'sequel'
+require 'rails3_sequel/database'
+require 'rails3_sequel/logging'
+require 'rails3_sequel/railties/controller_runtime'
+require 'rails3_sequel/railties/log_subscriber'
+
+module Rails
+  module Sequel
+    class Railtie < Rails::Railtie
+      log_subscriber :sequel, Rails::Sequel::Railties::LogSubscriber.new
+
+      config.generators.orm :sequel, :autoincrement => false, :migration => true, :timestamps => false
+
+      config.log_warn_duration = nil
+      config.rails_fancy_pants_logging = true
+      config.loggers = []
+
+      rake_tasks do
+        load 'rails3_sequel/railties/database.rake'
+      end
+
+      initializer 'sequel.initialize_database' do |app|
+        Rails::Sequel::Database.configurations = app.config.database_configuration
+        Rails::Sequel::Database.connect
+      end
+
+      initializer 'sequel.logging' do |app|
+        ::Sequel::Model.db.log_warn_duration = 0.1
+
+        if app.config.rails_fancy_pants_logging then
+          ::Sequel::Model.db.loggers << Rails.logger
+          ::Sequel::Model.db.extend Rails::Sequel::Logging
+          ActionController::Base.send :include, Rails::Sequel::Railties::ControllerRuntime
+        end
+
+        # additional loggers
+        ::Sequel::Model.db.loggers.concat(app.config.loggers)
+      end
+
+      config.after_initialize do
+        # set some sensible Rails defaults
+        ::Sequel::Model.plugin :active_model
+        ::Sequel::Model.plugin :validation_helpers
+
+        ::Sequel::Model.raise_on_save_failure = false
+      end
+    end
+  end
+end

data/lib/rails3_sequel/railties/controller_runtime.rb

@@ -0,0 +1,36 @@
+module Rails
+  module Sequel
+    module Railties
+
+      module ControllerRuntime
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :db_runtime
+
+        def cleanup_view_runtime
+          db_rt_before_render = ::Sequel::Model.db.reset_runtime
+          runtime = super
+          db_rt_after_render = ::Sequel::Model.db.reset_runtime
+          self.db_runtime = db_rt_before_render + db_rt_after_render
+          runtime - db_rt_after_render
+        end
+
+        def append_info_to_payload (payload)
+          super
+          payload[:db_runtime] = db_runtime
+        end
+
+        module ClassMethods
+          def log_process_action (payload)
+            messages, db_runtime = super, payload[:db_runtime]
+            messages << ("DB: %.1fms" % db_runtime.to_f) if db_runtime
+            messages
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/rails3_sequel/railties/database.rake

@@ -0,0 +1,115 @@
+# dont spit out SELECT messages
+# maybe there's a better way to do this?
+class PickyLogger < Logger
+  def add (severity, message = nil, progname = nil, &block)
+    # using progname because that's where the levels put the message
+    return if progname =~ /SELECT/
+    super
+  end
+end
+
+namespace :db do
+  def migrations_path
+    File.join(RAILS_ROOT, 'db', 'migrate')
+  end
+
+  desc 'Create the database, load the schema, and initialize with the seed data'
+  task :setup => ['db:create', 'db:schema:load', 'db:seed']
+
+  desc 'Load the seed data from db/seeds.rb'
+  task :seed => :environment do
+    seed_file = File.join(Rails.root, 'db', 'seeds.rb')
+    load(seed_file) if File.exist?(seed_file)
+  end
+
+  namespace :create do
+    task :all do
+      puts 'Pending implementation'
+    end
+  end
+
+  task :create do
+    puts 'Pending implementation'
+  end
+
+  namespace :migrate do
+    task :sequel_migration => :environment do
+      Sequel.extension :migration
+      # outputs statements to screen also
+      Sequel::Model.db.loggers << PickyLogger.new(STDOUT)
+    end
+
+    desc 'Rollbacks the database one migration and re migrate up. If you want to rollback more than one step, define STEP=x.'
+    task :redo => [ 'db:migrate:down', 'db:migrate' ]
+
+    desc 'Migrate up. Alias to db:migrate.'
+    task :up => 'db:migrate'
+
+    desc 'Migrate down. Define either VERSION or STEP. VERSION takes precedence if both are defined. STEP=1 if neither are defined'
+    task :down, :needs => :sequel_migration do
+      if ENV['VERSION'] then
+        version = ENV['VERSION'].to_i
+      else
+        step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+        version = Sequel::Migrator.get_current_migration_version(Sequel::Model.db) - step
+      end
+
+      Sequel::Migrator.apply(Sequel::Model.db, migrations_path, version)
+    end
+  end
+
+  desc "Retrieves the current schema version number."
+  task :version, :needs => 'migrate:sequel_migration' do
+    puts "Current version: #{Sequel::Migrator.get_current_migration_version(Sequel::Model.db)}"
+  end
+  
+  desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x."
+  task :migrate, :needs => 'migrate:sequel_migration' do
+    if ENV['VERSION']
+      Sequel::Migrator.apply(Sequel::Model.db, migrations_path, ENV['VERSION'].to_i)
+    else
+      Sequel::Migrator.apply(Sequel::Model.db, migrations_path)
+    end
+  end
+
+  desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n. This is an alias to db:migrate:down.'
+  task :rollback => 'db:migrate:down'
+
+
+  namespace :schema do
+    desc "Create a db/schema.rb file that can be portably used against any DB supported by Sequel."
+    task :dump => :environment do
+      Sequel.extension :schema_dumper
+      File.open(ENV['SCHEMA'] || "#{Rails.root}/db/schema.rb", "w") do |file|
+        file.puts Sequel::Model.db.dump_schema_migration
+      end
+
+      # needs also away to store current schema version
+    end
+
+    desc "Load a schema.rb file into the database."
+    task :load => :environment do
+      file = ENV['SCHEMA'] || "#{Rails.root}/db/schema.rb"
+      if File.exists?(file) then
+        load(file)
+        # probably needs to also run "up: here
+      else
+        abort "#{file} doesn't exist."
+      end
+    end
+  end
+
+  namespace :test do
+    desc "Recreate the test database from the current schema.rb"
+    task :load => 'db:test:purge' do
+      Sequel.connect(Rails::Sequel::Database.configurations['test'])
+      Rake::Task['db:schema:load'].invoke
+    end
+
+    desc 'Empty the test database'
+    task :purge => :environment do
+      raise NotImplementedError
+    end
+  end
+
+end

data/lib/rails3_sequel/railties/log_subscriber.rb

@@ -0,0 +1,30 @@
+module Rails
+  module Sequel
+    module Railties
+      class LogSubscriber < Rails::LogSubscriber
+        def sql(event)
+          name = '%s (%.1fms)' % [event.payload[:name], event.payload[:duration]]
+          sql  = event.payload[:sql].squeeze(' ')
+
+          if odd?
+            name = color(name, :cyan, true)
+            sql  = color(sql, nil, true)
+          else
+            name = color(name, :magenta, true)
+          end
+
+          warn "  #{name}  #{sql}"
+        end
+
+        # by default, Rails.logger will be used
+        # if users want additional loggers, they can specify through the yml file
+
+        private
+
+        def odd?
+          @odd_or_even = !@odd_or_even
+        end
+      end
+    end
+  end
+end

data/lib/rails3_sequel.rb

@@ -0,0 +1 @@
+require 'rails3_sequel/railtie'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: rails3_sequel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rachot Moragraan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 11
+        - 0
+        version: 3.11.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id002
+description: Rails 3 integration with Sequel
+email: janechii@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rails/generators/sequel/observer/templates/observer.rb
+- lib/rails/generators/sequel/observer/observer_generator.rb
+- lib/rails/generators/sequel/model/model_generator.rb
+- lib/rails/generators/sequel/model/templates/migration.rb
+- lib/rails/generators/sequel/model/templates/model.rb
+- lib/rails/generators/sequel/active_model.rb
+- lib/rails/generators/sequel/migration/templates/migration.rb
+- lib/rails/generators/sequel/migration/migration_generator.rb
+- lib/rails/generators/sequel/generated_attribute.rb
+- lib/rails/generators/sequel.rb
+- lib/rails3_sequel/railtie.rb
+- lib/rails3_sequel/database.rb
+- lib/rails3_sequel/logging.rb
+- lib/rails3_sequel/railties/controller_runtime.rb
+- lib/rails3_sequel/railties/log_subscriber.rb
+- lib/rails3_sequel.rb
+- lib/rails3_sequel/railties/database.rake
+- README.md
+- VERSION
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/mooman/rails3_sequel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails 3 integration with Sequel
+test_files: []
+