otr-activerecord 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58dbba472854748f534103046ed89afd5f6920f8
+  data.tar.gz: eace235fb0201c8c3ba63a59cad9b4230fe3e707
+SHA512:
+  metadata.gz: 2302a10494dfa0f20481b80318249aac5db711d7998390b15d48682ddf77d92173804f44ca0bae35e3ad576b886ae80f2bd65fa449c00272e954dabb5586a72f
+  data.tar.gz: 42f5730e6b715517336ea15a337138293c1beadab4ea710be0f6005b5b29234f3e9ac2e17bdaba5e4efaeccbf2b18c6aada9a2882d5fdb49e593adcb355546d1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Jordan Hollinger
+
+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,66 @@
+# otr-activerecord
+
+An easy way to use ActiveRecord "off the rails." Works with Grape, Sinatra, plain old Rack, or even in a boring little script!. The defaults are all very Railsy (`config/database.yml`, `db/seeds.rb`, `db/migrate`, etc.), but you can easily change them. (Formerly known as `grape-activerecord`.) Supports:
+
+* ActiveRecord 4
+* ActiveRecord 5 (new, possibly buggy; PRs and Issues welcome!)
+
+## How to use
+
+#### 1. Add it to your Gemfile
+
+    gem "otr-activerecord"
+
+#### 2. Configure your database connection
+
+After loading your gems, tell `OTR::ActiveRecord` about your database config using one of the following examples:
+
+    OTR::ActiveRecord.configure_from_file! "config/database.yml"
+    OTR::ActiveRecord.configure_from_url! ENV['DATABASE_URL'] # e.g. postgres://user:pass@host/db
+    OTR::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 in Rack apps
+
+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
+
+This will give you most of the standard `db:` tasks you get in Rails. Add it to your `Rakefile`.
+
+    require "bundler/setup"
+    load "tasks/otr-activerecord.rake"
+
+    namespace :db do
+      # Some db tasks require your app code to be loaded; they'll expect to find it here
+      task :environment do
+        require_relative "app"
+      end
+    end
+
+Unlike in Rails, creating a new migration is also a rake task. Run `bundle exec rake -T` to get a full list of tasks.
+
+    bundle exec rake db:create_migration[create_widgets]
+
+## Examples
+
+Look under [/examples](https://github.com/jhollinger/otr-activerecord/tree/master/examples) for some example apps.
+
+## Advanced options
+
+The defaults for db-related files like migrations, seeds, and fixtures are the same as Rails. If you want to override them, use the following options in your `Rakefile`:
+
+    OTR::ActiveRecord.db_dir = 'db'
+    OTR::ActiveRecord.migrations_paths = ['db/migrate']
+    OTR::ActiveRecord.fixtures_path = 'test/fixtures'
+    OTR::ActiveRecord.seed_file = 'seeds.rb'
+
+## License
+
+Licensed under the MIT License
+
+Copyright 2016 Jordan Hollinger

data/lib/otr-activerecord/activerecord.rb

@@ -0,0 +1,44 @@
+require 'erb'
+
+# "Off the Rails" ActiveRecord configuration/integration for Grape, Sinatra, Rack, and any other kind of app
+module OTR
+  # ActiveRecord configuration module
+  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
+      # Internal compatibility layer across different major versions of AR
+      attr_accessor :_normalizer
+    end
+
+    # Connect to database with a Hash. Example:
+    # {adapter: 'postgresql', host: 'localhost', database: 'db', username: 'user', password: 'pass', encoding: 'utf8', pool: 10, timeout: 5000}
+    def self.configure_from_hash!(spec)
+      ::ActiveRecord::Base.configurations = {rack_env => spec}.stringify_keys
+      ::ActiveRecord::Base.establish_connection(rack_env)
+    end
+
+    # Connect to database with a DB URL. Example: "postgres://user:pass@localhost/db"
+    def self.configure_from_url!(url)
+      configure_from_hash! ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::ConnectionUrlResolver.new(url).to_hash
+    end
+
+    # Connect to database with a yml file. Example: "config/database.yml"
+    def self.configure_from_file!(path)
+      raise "#{path} does not exist!" unless File.file? path
+      ::ActiveRecord::Base.configurations = YAML.load(ERB.new(File.read(path)).result) || {}
+      ::ActiveRecord::Base.establish_connection(rack_env)
+    end
+
+    # The current Rack environment
+    def self.rack_env
+      (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['OTR_ENV'] || 'development').to_sym
+    end
+  end
+end

data/lib/otr-activerecord/compatibility_4.rb

@@ -0,0 +1,30 @@
+module OTR
+  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
+        OTR::ActiveRecord.migrations_paths
+      end
+
+      # The dir in which to put new migrations
+      def migrations_path
+        OTR::ActiveRecord.migrations_paths[0]
+      end
+
+      # Basename of migration classes
+      def migration_base_class_name
+        'ActiveRecord::Migration'
+      end
+    end
+  end
+end

data/lib/otr-activerecord/compatibility_5.rb

@@ -0,0 +1,30 @@
+module OTR
+  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
+        OTR::ActiveRecord.migrations_paths
+      end
+
+      # The dir in which to put new migrations
+      def migrations_path
+        OTR::ActiveRecord.migrations_paths[0]
+      end
+
+      # Basename of migration classes
+      def migration_base_class_name
+        'ActiveRecord::Migration[5.0]'
+      end
+    end
+  end
+end

data/lib/otr-activerecord/defaults.rb

@@ -0,0 +1,8 @@
+OTR::ActiveRecord.db_dir = 'db'
+OTR::ActiveRecord.migrations_paths = %w(db/migrate)
+OTR::ActiveRecord.fixtures_path = 'test/fixtures'
+OTR::ActiveRecord.seed_file = 'seeds.rb'
+OTR::ActiveRecord._normalizer = case ::ActiveRecord::VERSION::MAJOR
+                                when 4 then OTR::ActiveRecord::Compatibility4.new
+                                when 5 then OTR::ActiveRecord::Compatibility5.new
+                                end

data/lib/otr-activerecord/version.rb

@@ -0,0 +1,6 @@
+module OTR
+  module ActiveRecord
+    # Gem version
+    VERSION = '1.0.0'
+  end
+end

data/lib/otr-activerecord.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+require 'hashie-forbidden_attributes'
+require 'otr-activerecord/version'
+require 'otr-activerecord/activerecord'
+require 'otr-activerecord/compatibility_4'
+require 'otr-activerecord/compatibility_5'
+require 'otr-activerecord/defaults'

data/lib/tasks/otr-activerecord.rake

@@ -0,0 +1,84 @@
+require 'pathname'
+require 'fileutils'
+require 'active_support/core_ext/string/strip'
+require 'active_support/core_ext/string/inflections'
+require 'otr-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 = OTR::ActiveRecord.rack_env.to_s
+    config.db_dir = OTR::ActiveRecord.db_dir
+    config.migrations_paths = Array(OTR::ActiveRecord.migrations_paths)
+    config.fixtures_path = OTR::ActiveRecord.fixtures_path
+    config.database_configuration = ::ActiveRecord::Base.configurations
+    config.seed_loader = Object.new
+    config.seed_loader.instance_eval do
+      def load_seed
+        load "#{OTR::ActiveRecord.db_dir}/#{OTR::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 otr-activerecord helper tasks
+#
+
+namespace :db do
+  namespace :test do
+    task :environment do
+      ENV['RACK_ENV'] = 'test'
+    end
+  end
+
+  desc "Create a migration"
+  task :create_migration, [:name] do |_, args|
+    name, version = args[:name], Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    OTR::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) }
+        abort "Another migration is already named \"#{name}\": #{duplicate}."
+      end
+    end
+
+    filename = "#{version}_#{name}.rb"
+    dirname = OTR::ActiveRecord._normalizer.migrations_path
+    path = File.join(dirname, filename)
+
+    FileUtils.mkdir_p(dirname)
+    File.write path, <<-MIGRATION.strip_heredoc
+      class #{name.camelize} < #{OTR::ActiveRecord._normalizer.migration_base_class_name}
+        def change
+        end
+      end
+    MIGRATION
+
+    puts path
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: otr-activerecord
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: 'Off The Rails ActiveRecord: Use ActiveRecord with Grape, Sinatra, Rack,
+  or anything else! Formerly known as ''grape-activerecord''.'
+email: jordan.hollinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/otr-activerecord.rb
+- lib/otr-activerecord/activerecord.rb
+- lib/otr-activerecord/compatibility_4.rb
+- lib/otr-activerecord/compatibility_5.rb
+- lib/otr-activerecord/defaults.rb
+- lib/otr-activerecord/version.rb
+- lib/tasks/otr-activerecord.rake
+homepage: https://github.com/jhollinger/otr-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: 'Off The Rails: Use ActiveRecord with Grape, Sinatra, Rack, or anything else!'
+test_files: []
+has_rdoc: