envvar-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44260b9c093047f0e080dc69d151e6b7c54adb62
+  data.tar.gz: 0f9ea3649146060be29932af44a55ebf47fceaac
+SHA512:
+  metadata.gz: 9847d4aa72d57927cc8d40f533c6240be2273e42374c56f2be667343c38cc5572a3bec77226b4afdf22e146bd5c3558ecf4f71267ad8e2109289125f1358d6b0
+  data.tar.gz: 7f2e905e6842272548daa1e6ef996cf026d4d3a88770430b1091c9fcf98bf075d43f617f794cca1dd4c0a56e1aa32be64772205aa63d4b39b0427afcf3c51a42

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Brendan Stennett
+
+MIT License
+
+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,69 @@
+# Envvar
+
+Manages defining optional (and default) values, environment specific values and required values.
+There is a focus on 12 Factor principle and definining most variables outside of the environment 
+in production but making it easy for developers to get started with development environment 
+specific variables and sensible defaults.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'envvar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install envvar
+
+## Usage
+
+Place the following lines as soon as possible in the application boot process:
+```ruby
+require 'envvar'
+Envvar.load(File.expand_path('../application.yml', __FILE__))
+```
+
+The application.yml file contains a few different sections:
+- required
+- defaults
+- development, test, etc.
+
+A sample of this file is show below:
+```yaml
+required:
+  - FOO
+  - BAR
+defaults:
+  BAM: thud
+development:
+  FOO: bat
+  BAR: qux
+```
+
+This gives a nice place to set application defaults and development/test variables in one place.  It would be best 
+practise to not include the production environment variables in this file and instead set them as ENV variables in the 
+outside environment.  Any variables listed in the `required` section that are not present in the ENV hash after the
+Envvar.load call with raise `Envvar::EnvironmentError`.  This allows for a fast-fail setup which is useful in more
+complex applications with quite a few necessary environment variables.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/envvar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/envvar-rails.rb

@@ -0,0 +1 @@
+require 'envvar/rails'

data/lib/envvar/rails-now.rb

@@ -0,0 +1,6 @@
+# Taken from the nicely put together gem "dotenv" that I have used in the past
+# but doesn't functions a bit different than what I am looking for here.
+# https://github.com/bkeepers/dotenv
+
+require 'envvar/rails'
+Envvar::Railtie.load

data/lib/envvar/rails.rb

@@ -0,0 +1,53 @@
+require 'envvar'
+
+# Taken from the nicely put together gem "dotenv" that I have used in the past
+# but doesn't functions a bit different than what I am looking for here.
+# https://github.com/bkeepers/dotenv
+
+# Fix for rspec rake tasks loading in development
+#
+# Dotenv loads environment variables when the Rails application is initialized.
+# When running `rake`, the Rails application is initialized in development.
+# Rails includes some hacks to set `RAILS_ENV=test` when running `rake test`,
+# but rspec does not include the same hacks.
+#
+# See https://github.com/bkeepers/dotenv/issues/219
+if defined?(Rake.application)
+  is_running_specs = Rake.application.top_level_tasks.grep(/^spec(:|$)/).any?
+  Rails.env = ENV['RAILS_ENV'] ||= 'test' if is_running_specs
+end
+
+module Envvar
+  # Dotenv Railtie for using Dotenv to load environment from a file into
+  # Rails applications
+  class Railtie < Rails::Railtie
+    # Public: Load dotenv
+    #
+    # This will get called during the `before_configuration` callback, but you
+    # can manually call `Dotenv::Railtie.load` if you needed it sooner.
+    def load
+      Envvar.load(config_file, Rails.env)
+    end
+
+    # Internal: `Rails.root` is nil in Rails 4.1 before the application is
+    # initialized, so this falls back to the `RAILS_ROOT` environment variable,
+    # or the current working directory.
+    def root
+      Rails.root || Pathname.new(ENV['RAILS_ROOT'] || Dir.pwd)
+    end
+
+    # Rails uses `#method_missing` to delegate all class methods to the
+    # instance, which means `Kernel#load` gets called here. We don't want that.
+    def self.load
+      instance.load
+    end
+
+    config.before_configuration { load }
+
+    private
+
+    def config_file
+      root.join('config/application.yml')
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: envvar-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brendan Stennett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: envvar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Rails integration for envvar
+email:
+- brendan@thinkdataworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/envvar-rails.rb
+- lib/envvar/rails-now.rb
+- lib/envvar/rails.rb
+homepage: http://github.com/HuffMoody/envvar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Rails integration for envvar
+test_files: []