dotenv_rails_db_tasks_fix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d126642ad8ea8ec2a15861353fa3b48efd0133e22df45b63f4f25d2e9499a0ca
+  data.tar.gz: b59c95dcecb6f997799d32d04f259a70fba3673d053fe898854c2dab1a135b25
+SHA512:
+  metadata.gz: 6a34646ddce10d1d8c7e47ecd19d35e75695dad9becf03aee0315dbdda70a79cfd92a297dd12808f05f81beac98e34e94f5604f1bdc0935c5caa4062392e2fdd
+  data.tar.gz: f46d7d44344ac35610780e488d937907ee11a9607c44c03d85e84be368645ce11328a0923f5ea130a9300bac11b7d4ad4ba497f79c8e512c4c7826bc0d392049

data/.env.development

@@ -0,0 +1 @@
+DB_DATABASE=development

data/.env.test

@@ -0,0 +1 @@
+DB_DATABASE=test

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock
+/spec/example_project/db/*.sqlite3
+/.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dotenv_rails_db_tasks_fix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Csaba Apagyi
+
+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,126 @@
+# DotenvRailsDbTasksFix
+
+#### Fix for the issue when ActiveRecord `rake db:*` tasks are magically executed in both developement and test environments, but environment variables loaded via `dotenv` are not picking up the change.
+
+*You are viewing the README of version [v0.1.0](https://github.com/thisismydesign/dotenv_rails_db_tasks_fix/releases/tag/v0.1.0).*
+
+| Branch | Status |
+| ------ | ------ |
+| Development | [![Build Status](https://travis-ci.org/thisismydesign/dotenv_rails_db_tasks_fix.svg?branch=master)](https://travis-ci.org/thisismydesign/dotenv_rails_db_tasks_fix)   [![Coverage Status](https://coveralls.io/repos/github/thisismydesign/dotenv_rails_db_tasks_fix/badge.svg?branch=master)](https://coveralls.io/github/thisismydesign/dotenv_rails_db_tasks_fix?branch=master) |
+
+If you're using environment variables in your `database.yml` and load them via `Dotenv` chances are you also ran into this annoying issue in your development environment:
+
+`database.yml`
+```
+development:
+  database:     <%= ENV['DB_NAME'] %>
+  # ...
+test:
+  database:     <%= ENV['DB_NAME'] %>
+  # ...
+```
+
+`.env.development`
+```
+DB_NAME=development
+# ...
+```
+
+`.env.test`
+```
+DB_NAME=test
+# ...
+```
+
+```
+$ rails db:setup
+=>
+Created database 'app_development'
+Database 'app_development' already exists
+```
+
+```
+$ rails db:setup
+=>
+Database 'app_development' already exists
+Database 'app_development' already exists
+rails aborted!
+ActiveRecord::EnvironmentMismatchError: You are attempting to modify a database that was last run in `test` environment.
+You are running in `development` environment. If you are sure you want to continue, first set the environment using:
+
+        bin/rails db:environment:set RAILS_ENV=development
+```
+
+Using this gem you can do:
+
+`Rakefile`
+```
+# ...
+require "dotenv_rails_db_tasks_fix"
+DotenvRailsDbTasksFix.activate
+```
+
+```
+$ rails db:setup
+=>
+Created database 'app_development'
+Created database 'app_test'
+```
+
+## Explanation
+
+ActiveRecord has this feature that it executes DB tasks in `test` env as well if the current env is `development`. ([see](https://github.com/rails/rails/blob/v5.1.5/activerecord/lib/active_record/tasks/database_tasks.rb#L300):
+`environments << "test" if environment == "development"`). This happens in the middle of execution so there's no way for `dotenv` to nicely intervene and even if they did there are things already loaded at this point (e.g. env vars are interpolated to configs). Dotenv's recommendation is to use different env var names (e.g. `TEST_DB_NAME`, `DEVELOPMENT_DB_NAME`) but that would be counter-intuitive. Instead here we monkey patch `ActiveRecord::Tasks::DatabaseTasks` to explicitly reload env vars and the DB config when it switches to test env.
+
+*It's invasive and ugly but it only affects the development environment (so it's low-risk) and restores the expected behaviour of this widely used feature therefore sparing the annoyance and possible effort of investigation.*
+
+See [this issue](https://github.com/thisismydesign/dotenv_rails_db_tasks_fix) and [this article](http://www.zhuwu.me/blog/posts/rake-db-tasks-always-runs-twice-in-development-environment).
+
+## Caveats
+
+- Database config is expected to reside in Rails default `#{DatabaseTasks.root}/config/database.yml` (if you're using Rails `DatabaseTasks.root == Rails.root`)
+- Requires ActiveRecord >= 5.1.5, ~> 5.1.6 (because there're slight differences in the private API, althoguh following this solution it would be easy to extend support for other versions)
+- There's some weirdness with `Rails.env` vs `DatabaseTasks.env`. From trial-and-error it seems changing `DatabaseTasks.env` to reflect the current execution env will result in issues (with e.g. `db:setup` and `db:reset`), while changing `Rails.env` is actually required for `db:setup` to work correctly. [This fix](https://github.com/thisismydesign/dotenv_rails_db_tasks_fix/blob/be83ad6f97e4c1eb4bcfb5a2860eb3b53d7ff063/lib/dotenv_rails_db_tasks_fix.rb#L24-L28) seems to work for the use cases I tried but it's good to keep this in mind in case any similar issue presents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotenv_rails_db_tasks_fix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotenv_rails_db_tasks_fix
+
+## Feedback
+
+Any feedback is much appreciated.
+
+I can only tailor this project to fit use-cases I know about - which are usually my own ones. If you find that this might be the right direction to solve your problem too but you find that it's suboptimal or lacks features don't hesitate to contact me.
+
+Let me know if you make use of this project so that I can prioritize further efforts.
+
+## Conventions
+
+This gem is developed using the following conventions:
+- [Bundler's guide for developing a gem](http://bundler.io/v1.14/guides/creating_gem.html)
+- [Better Specs](http://www.betterspecs.org/)
+- [Semantic versioning](http://semver.org/)
+- [RubyGems' guide on gem naming](http://guides.rubygems.org/name-your-gem/)
+- [RFC memo about key words used to Indicate Requirement Levels](https://tools.ietf.org/html/rfc2119)
+- [Bundler improvements](https://github.com/thisismydesign/bundler-improvements)
+- [Minimal dependencies](http://www.mikeperham.com/2016/02/09/kill-your-dependencies/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thisismydesign/dotenv_rails_db_tasks_fix.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative "lib/dotenv_rails_db_tasks_fix"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require "erb"
+require 'yaml'
+require 'dotenv'
+require 'active_record'
+
+RSPEC_ROOT = Pathname.new(File.dirname(__FILE__)).join("spec")
+environment = ENV["RAILS_ENV"] || "development"
+db_config = Pathname.new(RSPEC_ROOT).join("example_project", "config", "database.yml")
+
+Dotenv.overload(".env", ".env.#{environment}", ".env.local", ".env.#{environment}.local")
+
+class Seeder; def load_seed; end; end
+
+include ActiveRecord::Tasks
+DatabaseTasks.database_configuration = YAML::load(ERB.new(File.read(db_config)).result)
+DatabaseTasks.root = Pathname.new(RSPEC_ROOT).join("example_project")
+DatabaseTasks.db_dir = Pathname.new(DatabaseTasks.root).join("db")
+DatabaseTasks.migrations_paths = [File.join(DatabaseTasks.root, 'db/migrate')]
+DatabaseTasks.env = environment
+DatabaseTasks.seed_loader = Seeder.new
+
+task :environment do
+  ActiveRecord::Base.configurations = DatabaseTasks.database_configuration
+  ActiveRecord::Base.establish_connection DatabaseTasks.env.to_sym
+end
+
+load 'active_record/railties/databases.rake'
+
+DotenvRailsDbTasksFix.activate

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv_rails_db_tasks_fix"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dotenv_rails_db_tasks_fix.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dotenv_rails_db_tasks_fix/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotenv_rails_db_tasks_fix"
+  spec.version       = DotenvRailsDbTasksFix::VERSION
+  spec.authors       = ["thisismydesign"]
+  spec.email         = ["git.thisismydesign@gmail.com"]
+
+  spec.summary       = ""
+  spec.homepage      = "https://github.com/thisismydesign/dotenv_rails_db_tasks_fix"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dotenv"
+  spec.add_dependency "activerecord", ">= 5.1.5", "~> 5.1.6"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+end

data/lib/dotenv_rails_db_tasks_fix.rb

@@ -0,0 +1,37 @@
+require "dotenv_rails_db_tasks_fix/version"
+require "dotenv"
+require "active_record"
+
+module DotenvRailsDbTasksFix
+  def self.activate
+    ActiveRecord::Tasks::DatabaseTasks.instance_eval do
+      return unless env.eql?("development")
+
+      private
+
+      def each_current_configuration(environment)
+        environments = [environment]
+        environments << "test" if environment == "development"
+
+        environments.each do |environment|
+          # On load order see: https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use
+          if environment.eql?("test")
+            Dotenv.overload(".env", ".env.#{environment}", ".env.#{environment}.local")
+          else
+            Dotenv.overload(".env", ".env.#{environment}", ".env.local", ".env.#{environment}.local")
+          end
+
+          # This is a fix for consecutive `db:setup` calls
+          # Without this they would run into `ActiveRecord::EnvironmentMismatchError`
+          # Otherwise it could be circumvented by using the `DISABLE_DATABASE_ENVIRONMENT_CHECK` env var or executing `db:drop` previously
+          # Check for `Rails` is there because it's not a dependency
+          Rails.env = environment if defined?(Rails)
+
+          db_config = Pathname.new(self.root).join("config", "database.yml")
+          config = YAML::load(ERB.new(File.read(db_config)).result)
+          yield config[environment], environment if config[environment]["database"]
+        end
+      end
+    end
+  end
+end

data/lib/dotenv_rails_db_tasks_fix/version.rb

@@ -0,0 +1,3 @@
+module DotenvRailsDbTasksFix
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: dotenv_rails_db_tasks_fix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thisismydesign
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.5
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- git.thisismydesign@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.development"
+- ".env.test"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dotenv_rails_db_tasks_fix.gemspec
+- lib/dotenv_rails_db_tasks_fix.rb
+- lib/dotenv_rails_db_tasks_fix/version.rb
+homepage: https://github.com/thisismydesign/dotenv_rails_db_tasks_fix
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []