grape-activerecord 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 277fa119f61a75f2b6920ad1e4b885d23e687fc3
-  data.tar.gz: 30829e43950d647ceb2290983c6121948863b9fb
+  metadata.gz: 00c4596408538956fc799ddf52a5fb064845fd03
+  data.tar.gz: 9da3063fdfaaa9656086a3b2f6689db3cb1ce29d
 SHA512:
-  metadata.gz: 6377dc5c48e482106997bc2a75aa238dac39c09b3a2eebdd5ba85392518742d1eb8accdc5de240585b5daa223ae263f3c9f8f05eaa332d58ddbf1a879fb056a7
-  data.tar.gz: 03cada4ffaa98838717c078b1a18d5c30f61d6e66fc0ca5eb8e104413e54f9f466492e37ccc018c15b4be99760884a2810fb7479cc6ad93aaa83de457b9d4f8f
+  metadata.gz: 18c76a4f1c0a5a8610b1d4d0032aecdbcbb016da37c5487c657d754c7b8d71cf15359369a544f2f6f968900e1c4719a2c0161689a4ffa0e5101219cc6515defa
+  data.tar.gz: 2bc91adce6a8182c0687c0f739c1359d46f8edd1dba617ce12b885fd7a2943e20d2b3028a0cd508cb30c20f533028aecb3b88a00294591b7bdbba17cc04b2239

data/README.md

@@ -1,50 +1,41 @@
 # grape-activerecord
 
-A simple way to use ActiveRecord with your Grape apps.
+A simple way to use ActiveRecord with your Grape apps. The defaults are all very Railsy (`config/database.yml`, `db/seeds.rb`, `db/migrate`, etc.), but you can easily change them.
 
 ## How to use
 
-### 1. Add it to your Gemfile
+#### 1. Add it to your Gemfile
 
     gem "grape-activerecord"
 
-### 2. Configure your database connection
+#### 2. Configure your database connection
 
-grape-activerecord looks for your database configuration in:
+By default grape-activerecord looks for your database configuration in:
 
 * `config/database.yml` (see /examples for a sample file)
 * The `DATABASE_URL` environment variable (e.g. `postgres://user:pass@host/db`)
 
-But if your app has more particular needs, we've got you covered:
+#### 3. Enable ActiveRecord connection management
 
-    Grape::ActiveRecord.database_file = "elsewhere/db.yml"
-    Grape::ActiveRecord.database_url = "postgres://user:pass@host/db"
-    Grape::ActiveRecord.database = {adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000}
-
-### 3. Enable ActiveRecord connection management
-
-This ActiveRecord middleware cleans up your database connections after each request. Add it to your config.ru file:
+This ActiveRecord middleware cleans up your database connections after each request. Add it to your `config.ru` file:
 
     use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
-### 4. Import ActiveRecord tasks into your Rakefile
+#### 4. Import ActiveRecord tasks into your Rakefile
 
-This will give you most of the standard `db:` tasks you get in Rails. Run `bundle exec rake -T` to get a full list.
+This will give you most of the standard `db:` tasks you get in Rails. Add it to your `Rakefile`.
 
     require "bundler/setup"
     require "grape/activerecord/rake"
 
     namespace :db do
-      # Some db tasks require your app code to be loaded
+      # Some db tasks require your app code to be loaded, or at least your gems
       task :environment do
-        # If you set a custom db config in your app, you'll need to set it in your Rakefile too
-        # Grape::ActiveRecord.database_file = "elsewhere/db.yml"
-
         require_relative "app"
       end
     end
 
-Unlike in Rails, creating a new migration is also a rake task:
+Unlike in Rails, creating a new migration is also a rake task. Run `bundle exec rake -T` to get a full list.
 
     bundle exec rake db:create_migration NAME=create_widgets
 
@@ -52,6 +43,21 @@ Unlike in Rails, creating a new migration is also a rake task:
 
 Look under /examples for some example apps.
 
+## Advanced options
+
+You have a number of ways to tell ActiveRecord about your database. Use these options early in your app's boot process: somewhere between bundler and your app code. And make sure they make it into your `Rakefile` (maybe in `require_relative "app"` above.)
+
+    Grape::ActiveRecord.database_file = "elsewhere/db.yml"
+    Grape::ActiveRecord.database_url = "postgres://user:pass@host/db"
+    Grape::ActiveRecord.database = {adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000}
+
+You can configure custom locations for your db-related files like migrations, seeds, and fixtures. You should probably put these near the top of your `Rakefile`, before defining your tasks.
+
+    Grape::ActiveRecord.db_dir = 'db'
+    Grape::ActiveRecord.migrations_paths = ['db/migrate']
+    Grape::ActiveRecord.fixtures_path = 'test/fixtures'
+    Grape::ActiveRecord.seed_file = 'seeds.rb'
+
 ## License
 
 Licensed under the MIT License

data/lib/grape/activerecord/activerecord.rb

@@ -2,6 +2,17 @@
 module Grape
   # Grape and ActiveRecord integration
   module ActiveRecord
+    class << self
+      # Relative path to the "db" dir
+      attr_accessor :db_dir
+      # Relative path(s) to the migrations directory
+      attr_accessor :migrations_paths
+      # Relative path to the fixtures directory
+      attr_accessor :fixtures_path
+      # Name of the seeds file in db_dir
+      attr_accessor :seed_file
+    end
+
     # The current Rack environment
     RACK_ENV = (ENV['RACK_ENV'] || 'development').to_sym
 

data/lib/grape/activerecord/defaults.rb

@@ -6,3 +6,8 @@ if ENV['DATABASE_URL']
 elsif File.file? 'config/database.yml'
   Grape::ActiveRecord.database_file = 'config/database.yml'
 end
+
+Grape::ActiveRecord.db_dir = 'db'
+Grape::ActiveRecord.migrations_paths = %w(db/migrate)
+Grape::ActiveRecord.fixtures_path = 'test/fixtures'
+Grape::ActiveRecord.seed_file = 'seeds.rb'

data/lib/grape/activerecord/rake/activerecord_4.rb

@@ -5,14 +5,14 @@ Rake::Task.define_task('db:_load_config') do
   ActiveRecord::Tasks::DatabaseTasks.tap do |config|
     config.root = Rake.application.original_dir
     config.env = Grape::ActiveRecord::RACK_ENV.to_s
-    config.db_dir = 'db'
-    config.migrations_paths = ['db/migrate']
-    config.fixtures_path = 'test/fixtures'
+    config.db_dir = Grape::ActiveRecord.db_dir
+    config.migrations_paths = Array(Grape::ActiveRecord.migrations_paths)
+    config.fixtures_path = Grape::ActiveRecord.fixtures_path
     config.database_configuration = ActiveRecord::Base.configurations
     config.seed_loader = Object.new
     config.seed_loader.instance_eval do
       def load_seed
-        load "#{ActiveRecord::Tasks::DatabaseTasks.db_dir}/seeds.rb"
+        load "#{ActiveRecord::Tasks::DatabaseTasks.db_dir}/#{Grape::ActiveRecord.seed_file}"
       end
     end
   end

data/lib/grape/activerecord/rake.rb

@@ -1,3 +1,4 @@
+require 'grape/activerecord'
 load "active_record/railties/databases.rake"
 require "grape/activerecord/rake/activerecord_#{ActiveRecord::VERSION::MAJOR}"
 load "grape/activerecord/tasks.rake"

data/lib/grape/activerecord/version.rb

@@ -1,6 +1,6 @@
 module Grape
   module ActiveRecord
     # Gem version
-    VERSION = '1.0.3'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape