grape-activerecord 2.0.0 → 2.1.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a4153d9aa6bac32066254f76353d8608d5637d
-  data.tar.gz: 2d83a5e15433ca0ad19d360caa99b6150bb2f50e
+  metadata.gz: 52fae3b0b15766403ba80d6a74c9bff1bac315b9
+  data.tar.gz: 0f6f09e48b8bf41bb6b68adc37e04879bb6b528a
 SHA512:
-  metadata.gz: 73c43881ff83cc9cdf96a171b3f1f3de3b156c739eac11f0405d1af12959b0cbdfe3f26e0d2a36a352285dc6f408a8ae3e2f19ddcc7d3c4892b6122e904e7c59
-  data.tar.gz: 5ba35e8d13f810a4ccf2aeec5184e67ab371ffc26b51b36d27873558241f2e6106adadcfd64f3253f21767dbecfd24021cd2de4f530df2bf1ab1aa781aa985bd
+  metadata.gz: 05b77a6c52a9cf15497d2f2e591475c0d54d1b03260d74d68d264970fa968cf00bfa4f58d2b23984a83c6d8031f134a7a985c8c6bc51c98746a9f3bd15713f00
+  data.tar.gz: 5c89319bc465ba39fab414d1cae69fcf30398057eb4b4a6717953cb4805d00d5838d18cf5fbc2856885c16837aa4ecb11c81e6442877dc6548eaa66affabbac5

data/README.md

@@ -1,6 +1,9 @@
 # grape-activerecord
 
-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.
+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. Supports:
+
+* ActiveRecord 4
+* ActiveRecord 5 (new, possibly buggy; please submit a PR if you find something!)
 
 ## How to use
 
@@ -16,6 +19,9 @@ After loading your gems, tell `Grape::ActiveRecord` about your database config u
     Grape::ActiveRecord.configure_from_url! ENV['DATABASE_URL'] # e.g. postgres://user:pass@host/db
     Grape::ActiveRecord.configure_from_hash!(adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000)
 
+**Important note**: `configure_from_file!` won't work as expected if you have already `DATABASE_URL` set as part of your environment variables.
+This is because in ActiveRecord when that env variable is set it will merge its properties into the current connection configuration.
+
 #### 3. Enable ActiveRecord connection management
 
 This ActiveRecord middleware cleans up your database connections after each request. Add it to your `config.ru` file:
@@ -27,7 +33,7 @@ This ActiveRecord middleware cleans up your database connections after each requ
 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"
+    load "tasks/grape-activerecord.rake"
 
     namespace :db do
       # Some db tasks require your app code to be loaded, or at least your gems

data/lib/grape/activerecord/activerecord.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 # Grape and ActiveRecord integration
 module Grape
   # Grape and ActiveRecord integration
@@ -11,6 +13,8 @@ module Grape
       attr_accessor :fixtures_path
       # Name of the seeds file in db_dir
       attr_accessor :seed_file
+      # Internal compatibility layer across different major versions of AR
+      attr_accessor :_normalizer
     end
 
     # Connect to database with a Hash. Example:

data/lib/grape/activerecord/compatibility_4.rb

@@ -0,0 +1,30 @@
+module Grape
+  module ActiveRecord
+    # Compatibility layer for ActiveRecord 4
+    class Compatibility4
+      attr_reader :major_version
+
+      # Compatibility layer for ActiveRecord 4
+      def initialize
+        @major_version = 4
+        ::ActiveRecord::Base.default_timezone = :utc
+        ::ActiveRecord::Base.logger = Logger.new(STDOUT)
+      end
+
+      # All db migration dir paths
+      def migrations_paths
+        ::ActiveRecord::Migrator.migrations_paths
+      end
+
+      # The dir in which to put new migrations
+      def migrations_path
+        ::ActiveRecord::Migrator.migrations_path
+      end
+
+      # Basename of migration classes
+      def migration_base_class_name
+        'ActiveRecord::Migration'
+      end
+    end
+  end
+end

data/lib/grape/activerecord/compatibility_5.rb

@@ -0,0 +1,30 @@
+module Grape
+  module ActiveRecord
+    # Compatibility layer for ActiveRecord 5
+    class Compatibility5
+      attr_reader :major_version
+
+      # Compatibility layer for ActiveRecord 5
+      def initialize
+        @major_version = 5
+        ::ActiveRecord::Base.default_timezone = :utc
+        ::ActiveRecord::Base.logger = Logger.new(STDOUT)
+      end
+
+      # All db migration dir paths
+      def migrations_paths
+        ::ActiveRecord::Migrator.migrations_paths
+      end
+
+      # The dir in which to put new migrations
+      def migrations_path
+        ::ActiveRecord::Migrator.migrations_paths[0]
+      end
+
+      # Basename of migration classes
+      def migration_base_class_name
+        'ActiveRecord::Migration[5.0]'
+      end
+    end
+  end
+end

data/lib/grape/activerecord/defaults.rb

@@ -1,7 +1,8 @@
-::ActiveRecord::Base.default_timezone = :utc
-::ActiveRecord::Base.logger = Logger.new(STDOUT)
-
 Grape::ActiveRecord.db_dir = 'db'
 Grape::ActiveRecord.migrations_paths = %w(db/migrate)
 Grape::ActiveRecord.fixtures_path = 'test/fixtures'
 Grape::ActiveRecord.seed_file = 'seeds.rb'
+Grape::ActiveRecord._normalizer = case ::ActiveRecord::VERSION::MAJOR
+                                  when 4 then Grape::ActiveRecord::Compatibility4.new
+                                  when 5 then Grape::ActiveRecord::Compatibility5.new
+                                  end

data/lib/grape/activerecord/rake.rb

@@ -1,4 +1,2 @@
-require 'grape/activerecord'
-load "active_record/railties/databases.rake"
-require "grape/activerecord/rake/activerecord_#{ActiveRecord::VERSION::MAJOR}"
-load "grape/activerecord/tasks.rake"
+$stderr.puts "WARNING: loading 'grape/activerecord/rake' in your Rakefile is deprecated; do 'load \"tasks/grape-activerecord.rake\"' instead"
+load "tasks/grape-activerecord.rake"

data/lib/grape/activerecord/version.rb

@@ -1,6 +1,6 @@
 module Grape
   module ActiveRecord
     # Gem version
-    VERSION = '2.0.0'
+    VERSION = '2.1.0-rc1'
   end
 end

data/lib/grape/activerecord.rb

@@ -1,6 +1,7 @@
-require 'erb'
 require 'active_record'
 require 'hashie-forbidden_attributes'
 require 'grape/activerecord/version'
 require 'grape/activerecord/activerecord'
+require 'grape/activerecord/compatibility_4'
+require 'grape/activerecord/compatibility_5'
 require 'grape/activerecord/defaults'

data/lib/tasks/grape-activerecord.rake

@@ -0,0 +1,91 @@
+require 'pathname'
+require 'fileutils'
+require 'active_support/core_ext/string/strip'
+require 'active_support/core_ext/string/inflections'
+require 'grape/activerecord'
+load 'active_record/railties/databases.rake'
+
+#
+# Configure and override the default activerecord db rake tasks
+#
+
+Rake::Task.define_task('db:_load_config') do
+  ::ActiveRecord::Base.logger = nil
+  ::ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+    config.root = Rake.application.original_dir
+    config.env = Grape::ActiveRecord.rack_env.to_s
+    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 "#{Grape::ActiveRecord.db_dir}/#{Grape::ActiveRecord.seed_file}"
+      end
+    end
+  end
+end
+
+Rake::Task['db:load_config'].clear
+Rake::Task.define_task('db:load_config') do
+  # Run the user's db:environment task first, so they have an opportunity to set a custom db config location
+  Rake::Task['db:environment'].invoke
+end
+
+Rake::Task.define_task('db:environment') do
+  # defined by user
+end
+
+# Load db config at the end of user-defined db:environment
+Rake::Task['db:environment'].enhance do
+  Rake::Task['db:_load_config'].invoke
+end
+
+Rake::Task['db:test:deprecated'].clear if Rake::Task.task_defined?('db:test:deprecated')
+
+#
+# Define grape-activerecord helper tasks
+#
+
+namespace :db do
+  namespace :test do
+    task :environment do
+      ENV['RACK_ENV'] = 'test'
+    end
+  end
+
+  desc "Create a migration (parameters: NAME, VERSION)"
+  task :create_migration do
+    unless ENV["NAME"]
+      puts "No NAME specified. Example usage: `rake db:create_migration NAME=create_widgets`"
+      exit 1
+    end
+
+    name = ENV["NAME"]
+    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    Grape::ActiveRecord._normalizer.migrations_paths.each do |directory|
+      next unless File.exists?(directory)
+      migration_files = Pathname(directory).children
+      if duplicate = migration_files.find { |path| path.basename.to_s.include?(name) }
+        puts "Another migration is already named \"#{name}\": #{duplicate}."
+        exit 1
+      end
+    end
+
+    filename = "#{version}_#{name}.rb"
+    dirname = Grape::ActiveRecord._normalizer.migrations_path
+    path = File.join(dirname, filename)
+
+    FileUtils.mkdir_p(dirname)
+    File.write path, <<-MIGRATION.strip_heredoc
+      class #{name.camelize} < #{Grape::ActiveRecord._normalizer.migration_base_class_name}
+        def change
+        end
+      end
+    MIGRATION
+
+    puts path
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-activerecord
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0.pre.rc1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -28,30 +28,36 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hashie-forbidden_attributes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.1'
 description: Extends Grape with simple ActiveRecord integration
 email: jordan.hollinger@gmail.com
 executables: []
@@ -62,11 +68,12 @@ files:
 - README.md
 - lib/grape/activerecord.rb
 - lib/grape/activerecord/activerecord.rb
+- lib/grape/activerecord/compatibility_4.rb
+- lib/grape/activerecord/compatibility_5.rb
 - lib/grape/activerecord/defaults.rb
 - lib/grape/activerecord/rake.rb
-- lib/grape/activerecord/rake/activerecord_4.rb
-- lib/grape/activerecord/tasks.rake
 - lib/grape/activerecord/version.rb
+- lib/tasks/grape-activerecord.rake
 homepage: https://github.com/jhollinger/grape-activerecord
 licenses:
 - MIT
@@ -79,12 +86,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1

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

@@ -1,35 +0,0 @@
-Rake::Task.define_task('db:_load_config') do
-  ActiveRecord::Base.logger = nil
-
-  ActiveRecord::Tasks::DatabaseTasks.tap do |config|
-    config.root = Rake.application.original_dir
-    config.env = Grape::ActiveRecord.rack_env.to_s
-    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}/#{Grape::ActiveRecord.seed_file}"
-      end
-    end
-  end
-end
-
-Rake::Task['db:load_config'].clear
-Rake::Task.define_task('db:load_config') do
-  # Run the user's db:environment task first, so they have an opportunity to set a custom db config location
-  Rake::Task['db:environment'].invoke
-end
-
-Rake::Task.define_task('db:environment') do
-  # defined by user
-end
-
-# Load db config at the end of user-defined db:environment
-Rake::Task['db:environment'].enhance do
-  Rake::Task['db:_load_config'].invoke
-end
-
-Rake::Task['db:test:deprecated'].clear if Rake::Task.task_defined?('db:test:deprecated')

data/lib/grape/activerecord/tasks.rake

@@ -1,46 +0,0 @@
-require 'pathname'
-require 'fileutils'
-require 'active_support/core_ext/string/strip'
-require 'active_support/core_ext/string/inflections'
-
-namespace :db do
-  namespace :test do
-    task :environment do
-      ENV['RACK_ENV'] = 'test'
-    end
-  end
-
-  desc "Create a migration (parameters: NAME, VERSION)"
-  task :create_migration do
-    unless ENV["NAME"]
-      puts "No NAME specified. Example usage: `rake db:create_migration NAME=create_widgets`"
-      exit 1
-    end
-
-    name = ENV["NAME"]
-    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S")
-
-    ActiveRecord::Migrator.migrations_paths.each do |directory|
-      next unless File.exists?(directory)
-      migration_files = Pathname(directory).children
-      if duplicate = migration_files.find { |path| path.basename.to_s.include?(name) }
-        puts "Another migration is already named \"#{name}\": #{duplicate}."
-        exit 1
-      end
-    end
-
-    filename = "#{version}_#{name}.rb"
-    dirname = ActiveRecord::Migrator.migrations_path
-    path = File.join(dirname, filename)
-
-    FileUtils.mkdir_p(dirname)
-    File.write path, <<-MIGRATION.strip_heredoc
-      class #{name.camelize} < ActiveRecord::Migration
-        def change
-        end
-      end
-    MIGRATION
-
-    puts path
-  end
-end