sequel-rails 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f72c17bd6336f3beaf4c924f50df1c3c5f465e26
-  data.tar.gz: 68c754a39afbf03af0beada56cd545c38167d59f
+  metadata.gz: 1f76a96adfae8ea0e88a9309033960f3257abc59
+  data.tar.gz: ee00b69625771c517e4b0c9d595420fac941b62b
 SHA512:
-  metadata.gz: ba99ffdebabe0e37b4d17c4de59a00bc0fba5475505d7ddd5998570fb45652f1e2f93c4597b356a798c94e1b3a174d50ac6cf7181ae506ae6d56a699b49a1449
-  data.tar.gz: 46740f777f70160dd7d8ffa6158557280c0677dabe0b2eae00dc7631b33b3780da148d759c9f554b0b2d9bfa90fbe56f5f07d2796f6c74a4e946f6f1bef84346
+  metadata.gz: 1d988bf8488b10141f59786d78902694cb3f3bc44eaeffcdb09afc885f343b731b7d1faf36f070daa38d0628900e21687726c5f4b477aaf023a21d1ae9b85ec9
+  data.tar.gz: 96fc1e85b462e0d74ba7389f33c7aafe1ed94bd0d9fbbf4eeeb997ce6bb26ec22b25c94c6e99f6f50d19bd36dd77d8ac2bfeb28b680e943ece1ff8d76fdd4b7c

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gemspec
 
 gem "fakefs", :require => "fakefs/safe"
+gem "pry"
 
 # MRI/Rubinius Adapter Dependencies
 platform :ruby do

data/History.md

@@ -1,3 +1,17 @@
+0.7.0 (2013-10-11)
+==================
+
+* Add more information in the README, related to features of SequelRails [#54](https://github.com/TalentBox/sequel-rails/issues/54)
+* Refactor storage shell command construction/execution/escaping [#55](https://github.com/TalentBox/sequel-rails/issues/55)
+* Handle more options from database.yml for PostgreSQL when creating/dropping/loading/dumping database [#55](https://github.com/TalentBox/sequel-rails/issues/55)
+* Allow dumping the schema even if there aren't any migrations to run. (Kevin Menard) [#53](https://github.com/TalentBox/sequel-rails/pull/53)
+* Fix Postgres rake tasks under JRuby (Kevin Menard, Chris Heisterkamp) [#52](https://github.com/TalentBox/sequel-rails/pull/52) [#38](https://github.com/TalentBox/sequel-rails/pull/38)
+* Fix SQL schema dumps using timestamp migration (Joshua Hansen) [#50](https://github.com/TalentBox/sequel-rails/pull/50)
+* Apply all migrations in the schema.rb file when loading it (Robert Payne) [#49](https://github.com/TalentBox/sequel-rails/pull/49)
+* Make dump_schema_information compatible with integer based migration (Robert Payne) [#48](https://github.com/TalentBox/sequel-rails/pull/48) [#47](https://github.com/TalentBox/sequel-rails/issues/47)
+* Add an `after_connect` hook (Jan Berdajs) [#46](https://github.com/TalentBox/sequel-rails/pull/46)
+* Update license dates and add license to gemspec [#45](https://github.com/TalentBox/sequel-rails/issues/45)
+
 0.6.1 (2013-09-16)
 ==================
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 The sequel-rails team
+Copyright (c) 2009-2013 The sequel-rails team
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,18 +4,27 @@ sequel-rails
 [![Build Status](https://travis-ci.org/TalentBox/sequel-rails.png?branch=master)](https://travis-ci.org/TalentBox/sequel-rails)
 [![Code Climate](https://codeclimate.com/github/TalentBox/sequel-rails.png)](https://codeclimate.com/github/TalentBox/sequel-rails)
 
-This gem provides the railtie that allows [sequel](http://github.com/jeremyevans/sequel) to hook into [rails3](http://github.com/rails/rails) and thus behave like a rails framework component. Just like activerecord does in rails, [sequel-rails](http://github.com/talentbox/sequel-rails) uses the railtie API to hook into rails. The two are actually hooked into rails almost identically.
+This gem provides the railtie that allows
+[sequel](http://github.com/jeremyevans/sequel) to hook into
+[Rails (3.x and 4.x)](http://github.com/rails/rails) and thus behave like a
+rails framework component. Just like activerecord does in rails,
+[sequel-rails](http://github.com/talentbox/sequel-rails) uses the railtie API to
+hook into rails. The two are actually hooked into rails almost identically.
 
-The code for this gem was initially taken from the excellent [dm-rails](http://github.com/datamapper/dm-rails) project.
+The code for this gem was initially taken from the excellent
+[dm-rails](http://github.com/datamapper/dm-rails) project.
 
-This was originally a fork of [brasten](https://github.com/brasten)'s [sequel-rails](https://github.com/brasten/sequel-rails) that has been updated to support newer versions of rails.
+This was originally a fork of [brasten](https://github.com/brasten)'s
+[sequel-rails](https://github.com/brasten/sequel-rails) that has been updated to
+support newer versions of rails.
 
-Since January 2013, we've became the official maintainers of the gem after [brasten](https://github.com/brasten) proposed us.
+Since January 2013, we've became the official maintainers of the gem after
+[brasten](https://github.com/brasten) proposed us.
 
 Using sequel-rails
 ==================
 
-Using sequel with rails3 requires a couple minor changes.
+Using sequel with Rails (3.x or 4.x) requires a couple minor changes.
 
 First, add the following to your Gemfile (after the `Rails` lines):
 
@@ -30,7 +39,9 @@ gem "sequel-rails"
 
 ... be sure to run "bundle install" if needed!
 
-Secondly, you'll need to require the different Rails components separately in your `config/application.rb` file, and not require `ActiveRecord`.  The top of your `config/application.rb` will probably look something like:
+Secondly, you'll need to require the different Rails components separately in
+your `config/application.rb` file, and not require `ActiveRecord`.
+The top of your `config/application.rb` will probably look something like:
 
 ```ruby
 # require 'rails/all'
@@ -44,7 +55,8 @@ require "sprockets/railtie"
 
 Starting with sequel-rails 0.4.0.pre3 we don't change default Sequel behaviour
 nor include any plugin by default, if you want to get back the previous
-behaviour, you can create a new initializer (eg: `config/initializers/sequel.rb`) with content:
+behaviour, you can create a new initializer (eg: `config/initializers/sequel.rb`)
+with content:
 
 ```ruby
 require "sequel_rails/railties/legacy_model_config"
@@ -52,8 +64,62 @@ require "sequel_rails/railties/legacy_model_config"
 
 After those changes, you should be good to go!
 
+Features provided by `sequel-rails`
+===================================
+
+1. Connection management:
+
+   `sequel-rails` will initiate the `Sequel` connection mechanism based on your
+   configuration in `database.yml`.
+
+2. Generators:
+
+   You can use them just like `ActiveRecord`'s ones:
+
+   Migration:
+
+   ```ruby
+   rails generate migration create_admin_users
+   # Or
+   rails generate migration CreateAdminUsers
+   ```
+
+   Model:
+
+   ```ruby
+   rails generate model User email:string
+   ```
+
+   Observer:
+
+   ```ruby
+   rails generate observer User
+   ```
+
+3. Rake tasks similar to `ActiveRecord`, see
+   [Available sequel specific rake tasks](#available-sequel-specific-rake-tasks)
+
+4. Add some `Sequel` and `sequel-rails` specific exceptions to `ActionDispatch`'s `rescue_responses`
+
+   `Sequel::Plugins::RailsExtensions::ModelNotFound` is mapped to `:not_found`
+
+   `Sequel::NoMatchingRow` is mapped to `:not_found`
+
+   `Sequel::ValidationFailed` is mapped to `:unprocessable_entity`
+
+   `Sequel::NoExistingObject` is mapped to `:unprocessable_entity`
+
+5. Add a `i18n_scope` method to `Sequel::Model` which respond with `"sequel"`.
+   This is used by `ActiveModel`.
+
+6. Adding `Sequel` to `ActiveSupport::LogSubscriber`. This is what allows you to
+   see SQL queries in the log and also allows us to implement the next item.
+
+7. Add a hook in `ActionController::Base` so that the sum of SQL queries time
+   for the current action is reported as `DB` for the controller's line in logs.
+
 Configuration
-====================================
+=============
 You can configure some options with the usual rails mechanism, in
 `config/application.rb` and/or in `config/environments/*.rb`.
 
@@ -74,6 +140,78 @@ You can configure some options with the usual rails mechanism, in
     config.sequel.load_database_tasks = false
 ```
 
+The connection settings are read from the file `config/database.yml` and is
+expected to be similar to `ActiveRecord`'s format.
+
+Here's some examples:
+
+1. For PostgreSQL:
+
+    ```yaml
+    development:
+      adapter: postgresql
+      database: a_database_name
+      user: user_name # Also accept 'username' as key, if both are present 'username' is used
+      password: password
+      host: 10.0.0.2 # Optional
+      port: 5432 # Optional
+      owner: owner_name # Optional
+      encoding: utf8 # Optional, also accept 'charset' as key, if both are present 'encoding' is used (defaults to 'utf8')
+      maintenance_db: template2 # Optional
+      locale: en_US.UTF-8 # Optional, equivalent to setting 'collation' and 'ctype' to the same value
+      collation: en_US.UTF-8 # Optional
+      ctype: en_US.UTF-8 # Optional
+      template: template1 # Optional
+      tablespace: non_default_tablespace_name # Optional
+    ```
+
+2. For MySQL:
+
+    ```yaml
+    development:
+      adapter: mysql # Also accept mysql2
+      database: a_database_name
+      user: user_name # Also accept 'username' as key, if both are present 'username' is used
+      password: password
+      host: 10.0.0.2 # Optional
+      port: 5432 # Optional
+      charset: latin1 # Optional (defaults to 'utf8')
+      collation: latin1_general_ci # Optional (defaults to 'utf8_unicode_ci')
+    ```
+
+2. For SQLite:
+
+    ```yaml
+    development:
+      adapter: sqlite # Also accept sqlite3
+      database: db/mydatabase.sqlite # Path to db relative to Rails root
+    ```
+
+  For in memory testing:
+
+    ```yaml
+    development:
+      adapter: sqlite # Also accept sqlite3
+      database: ":memory:"
+    ```
+
+Enabling plugins
+================
+
+If you want to enable plugins for all your models, you should use the
+after_connect configuration option in `config/application.rb` (0.6.2+):
+
+```ruby
+    config.sequel.after_connect = proc do
+      Sequel::Model.plugin :timestamps, update_on_create: true
+    end
+```
+
+This will ensure that these plugins are loaded before any Sequel models are
+loaded. Loading plugins into `Sequel::Model` after subclasses are already
+created is not supported by Sequel. You can also load extensions in
+`after_connect` or perform any custom actions that you need.
+
 Available sequel specific rake tasks
 ====================================
 
@@ -153,6 +291,10 @@ Improvements has been made by those awesome contributors:
 * Saulius Grigaliunas (sauliusg)
 * Jacques Crocker (railsjedi)
 * Eric Strathmeyer (strathmeyer)
+* Jan Berdajs (mrbrdo)
+* Robert Payne (robertjpayne)
+* Kevin Menard (nirvdrum)
+* Chris Heisterkamp (cheister)
 
 Credits
 =======

data/lib/sequel_rails/configuration.rb

@@ -5,12 +5,7 @@ module SequelRails
   mattr_accessor :configuration
 
   def self.setup(environment)
-    config = configuration.environment_for(environment.to_s)
-    if config['url']
-      ::Sequel.connect config['url'], config
-    else
-      ::Sequel.connect config
-    end
+    configuration.connect environment
   end
 
   class Configuration < ActiveSupport::OrderedOptions
@@ -32,6 +27,7 @@ module SequelRails
       self.migration_dir = nil
       self.schema_dump = default_schema_dump
       self.load_database_tasks = true
+      self.after_connect = nil
     end
 
     def environment_for(name)
@@ -46,6 +42,17 @@ module SequelRails
       end
     end
 
+    def connect(environment)
+      normalized_config = environment_for environment
+      db = if normalized_config['url']
+        ::Sequel.connect normalized_config['url'], normalized_config
+      else
+        ::Sequel.connect normalized_config
+      end
+      after_connect.call if after_connect.respond_to?(:call)
+      db
+    end
+
   private
 
     def default_schema_dump

data/lib/sequel_rails/migrations.rb

@@ -6,34 +6,46 @@ module SequelRails
       def migrate(version=nil)
         opts = {}
         opts[:target] = version.to_i if version
-        ::Sequel::Migrator.run(::Sequel::Model.db, Rails.root.join("db/migrate"), opts)
+        ::Sequel::Migrator.run(::Sequel::Model.db, migrations_dir, opts)
       end
       alias_method :migrate_up!, :migrate
       alias_method :migrate_down!, :migrate
 
       def pending_migrations?
-        return false unless File.exists?(Rails.root.join("db/migrate"))
-        !::Sequel::Migrator.is_current?(::Sequel::Model.db, Rails.root.join("db/migrate"))
+        return false unless available_migrations?
+        !::Sequel::Migrator.is_current?(::Sequel::Model.db, migrations_dir)
       end
 
       def dump_schema_information(opts={})
         sql = opts.fetch :sql
         db = ::Sequel::Model.db
-        migrator = ::Sequel::TimestampMigrator.new db, "db/migrate"
+        res = ""
 
-        inserts = migrator.applied_migrations.map do |migration_name|
-          insert = migrator.ds.insert_sql(migrator.column => migration_name)
-          sql ? insert : "    self << #{insert.inspect}"
-        end
+        if available_migrations?
+          migrator_class = ::Sequel::Migrator.send(:migrator_class, migrations_dir)
+          migrator = migrator_class.new db, migrations_dir
 
-        res = ""
-        if inserts.any?
-          res << "Sequel.migration do\n  change do\n" unless sql
-          res << inserts.join("\n")
-          res << "\n  end\nend\n" unless sql
+          inserts = migrator.ds.map do |hash|
+            insert = migrator.ds.insert_sql(hash)
+            sql ? "#{insert};" : "    self << #{insert.inspect}"
+          end
+
+          if inserts.any?
+            res << "Sequel.migration do\n  change do\n" unless sql
+            res << inserts.join("\n")
+            res << "\n  end\nend\n" unless sql
+          end
         end
         res
       end
+
+      def migrations_dir
+        Rails.root.join("db/migrate")
+      end
+
+      def available_migrations?
+        File.exists?(migrations_dir) && Dir[File.join(migrations_dir, '*')].any?
+      end
     end
   end
 end

data/lib/sequel_rails/railties/database.rake

@@ -33,7 +33,7 @@ namespace :db do
       if File.exists?(file)
         require 'sequel/extensions/migration'
         load(file)
-        ::Sequel::Migration.descendants.first.apply(db_for_current_env, :up)
+        ::Sequel::Migration.descendants.each{|m| m.apply(db_for_current_env, :up)}
       else
         abort %{#{file} doesn't exist yet. Run "rake db:migrate" to create it then try again. If you do not intend to use a database, you should instead alter #{Rails.root}/config/boot.rb to limit the frameworks that will be loaded}
       end

data/lib/sequel_rails/shellwords.rb

@@ -0,0 +1,33 @@
+module SequelRails
+  begin
+    require "shellwords"
+    Shellwords = ::Shellwords
+  rescue LoadError
+    # Taken from shellwords.rb (Ruby 2.0.0p247)
+    class Shellwords
+      def self.shellescape(str)
+        str = str.to_s
+
+        # An empty argument will be skipped, so return empty quotes.
+        return "''" if str.empty?
+
+        str = str.dup
+
+        # Treat multibyte characters as is.  It is caller's responsibility
+        # to encode the string in the right encoding for the shell
+        # environment.
+        str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
+
+        # A LF cannot be escaped with a backslash because a backslash + LF
+        # combo is regarded as line continuation and simply ignored.
+        str.gsub!(/\n/, "'\n'")
+
+        return str
+      end
+
+      def self.shelljoin(array)
+        array.map { |arg| shellescape(arg) }.join(' ')
+      end
+    end
+  end
+end

data/lib/sequel_rails/storage.rb

@@ -1,3 +1,4 @@
+require "sequel_rails/shellwords"
 require "sequel_rails/storage/abstract"
 require "sequel_rails/storage/sqlite"
 require "sequel_rails/storage/mysql"

data/lib/sequel_rails/storage/abstract.rb

@@ -39,31 +39,59 @@ module SequelRails
       end
 
       def database
-        @database ||= config['database'] || config['path']
+        @database ||= config["database"] || config["path"]
       end
 
       def username
-        @username ||= config['username'] || config['user'] || ''
+        @username ||= config["username"] || config["user"] || ""
       end
 
       def password
-        @password ||= config['password'] || ''
+        @password ||= config["password"] || ""
       end
 
       def host
-        @host ||= config['host'] || ''
+        @host ||= config["host"] || ""
       end
 
       def port
-        @port ||= config['port'] || ''
+        @port ||= config["port"] || ""
       end
 
       def owner
-        @owner ||= config['owner'] || ''
+        @owner ||= config["owner"] || ""
       end
 
       def charset
-        @charset ||= config['charset'] || ENV['CHARSET'] || 'utf8'
+        @charset ||= config["charset"] || ENV["CHARSET"] || "utf8"
+      end
+
+      def collation
+        @collation ||= config["collation"] || ENV["COLLATION"]
+      end
+
+      private
+
+      def add_option(commands, name, value)
+        if value.present?
+          separator = name[0,2]=="--" ? "=" : " "
+          commands << "#{name}#{separator}#{value}"
+        end
+      end
+
+      def add_flag(commands, flag)
+        commands << flag
+      end
+
+      def exec(escaped_command)
+        `#{escaped_command}`
+
+        # Evaluate command status as a boolean like `system` does.
+        $?.exitstatus == 0
+      end
+
+      def safe_exec(args)
+        exec SequelRails::Shellwords.join(Array(args))
       end
 
     end