envied 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44b4eb082007cd5398a1071cdc35c4120355a4fc
+  data.tar.gz: 023f24e04c08eac42a0d276456be612b4eea865c
+SHA512:
+  metadata.gz: e9aa2e24f9dbdec5eda80fe0785c33fdb2e2a737feebf44cdd5f9f9b770664e56931964d68444caa633d9f9e554ba01071e6588929ad812fd83424646e494943
+  data.tar.gz: afbac06eaf2229c84befdb43abd1c6e097b363b291ad2bb72e81088edff38451b9a76a43cd9fdfee51599d9925b81bdfe8d057e21172b513d9e061d192214692

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in envied.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gert Goet
+
+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,67 @@
+# ENVied or ENV on EPO
+
+TL;DR `ENVied` will improve your life drama-ti-cally.
+
+Say you're nicely configuring your app via ENV-variables, 'ey?  
+Then maybe, just like me, you had the itch to check whether all variables your app needs, are present.  
+Or you sometimes wish that ENV-variables should not only contain strings, but integers and booleans.
+
+Wooha! You really should try `ENVied`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'envied'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+# in config/application.rb
+# somewhere after 'Bundler.require(*Rails.groups)':
+ENVied.configure do |env|
+  env.variable :rails_env
+  env.variable :force_ssl, :Boolean
+  env.variable :port, :Integer
+end
+
+ENVied.require! # raises when configured variables are not present in ENV
+
+# existing app config starts here
+module Blog
+  class Application < Rails::Application
+    config.force_ssl = ENVied.force_ssl
+    ...
+  end
+end
+```
+
+## Testing
+
+```bash
+bundle install --binstubs
+
+bin/rspec
+# or
+bin/rake
+```
+
+## Developing
+
+```bash
+bin/pry --gem
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/envied/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run the specs"
+task default: :spec

data/envied.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envied'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envied"
+  spec.version       = ENVied::VERSION
+  spec.authors       = ["Gert Goet"]
+  spec.email         = ["gert@thinkcreate.nl"]
+  spec.summary       = %q{ENV on epo}
+  spec.description   = %q{no, really}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", '~> 1.0.1'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '3.0.0.beta2'
+end

data/lib/envied.rb

@@ -0,0 +1,84 @@
+class ENVied
+  VERSION = "0.0.1"
+  module Configurable
+    require 'virtus'
+
+    class EnvMissing < StandardError;end
+    class EnvWrongType < StandardError;end
+
+    def self.included(base)
+      base.class_eval do
+        include Virtus.model
+      end
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Creates an instance of Configuration.
+      #
+      # Will raise EnvMissing for variables Configuration defined
+      # but are missing from env.
+      #
+      # Will raise EnvWrongType for variables that can't be coerced to the
+      # type defined in Configuration.
+      #
+      # @param env [Hash] the env
+      def parse_env(env)
+        atts = attribute_set.map(&:name).each_with_object({}) do |name, result|
+          @current_att = name
+          unless result[name] = env[name.to_s] || env[name.to_s.upcase]
+            raise EnvMissing, "Please provide ENV['#{name.to_s.upcase}']"
+          end
+        end
+        new(atts)
+      rescue Virtus::CoercionError => e
+        configured_type = attribute_set[@current_att].options[:primitive]
+        raise EnvWrongType,
+          "ENV['#{@current_att.to_s.upcase}'] should be of type %s" % configured_type
+      end
+
+      def variable(name, type = String, options = {})
+        attribute name, type, { strict: true }.merge(options)
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure(&block)
+    @configuration = Class.new { include Configurable }.tap(&block)
+    # or define this thing as ENVied::Configuration? prolly not threadsafe
+  ensure
+    @instance = nil
+  end
+
+  def self.instance
+    @instance ||= @configuration.parse_env(ENV.to_hash)
+  end
+  class << self
+    alias_method :require!, :instance
+  end
+
+  def self.[](key)
+    instance.attributes[key]
+    #instance[key] # will raise and complain that <class <>> doesn't response; better?
+  end
+
+  def self.method_missing(method, *args, &block)
+    respond_to_missing?(method) ? instance.public_send(method, *args, &block) : super
+  end
+
+  def self.respond_to_missing?(method, include_private = false)
+    instance.attributes.key?(method) || super
+  end
+end
+
+#ENVied.configure do |env|
+#  env.variable :port, :Integer
+#  env.variable :force_ssl, :Boolean
+#  env.variable :require, :Boolean
+#end
+#
+#ENVied.require

data/lib/envied/version.rb

@@ -0,0 +1,3 @@
+#class ENVied
+#  VERSION = "0.0.1"
+#end

data/spec/envied_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ENVied do
+  subject { described_class }
+
+  it { should respond_to :require! }
+  it { should respond_to :configure }
+
+  context 'configured' do
+
+    def unconfigured
+      configured_with
+      self
+    end
+
+    def configured_with(hash = {})
+      described_class.configure do |env|
+        hash.each do |name, type|
+          env.variable(name, type)
+        end
+      end
+      self
+    end
+
+    def and_ENV(env = {})
+      stub_const("ENV", env)
+      described_class
+    end
+
+    def and_no_ENV
+      and_ENV
+    end
+
+    it 'responds to configured variables' do
+      configured_with(a: :Integer).and_ENV({'A' => '1'})
+      is_expected.to respond_to :a
+    end
+
+    it 'responds not to unconfigured variables' do
+      unconfigured.and_ENV({'A' => '1'})
+      is_expected.to_not respond_to :a
+    end
+
+    context 'ENV contains not all configured variables' do
+      before { configured_with(a: :Integer).and_no_ENV }
+
+      it 'raises EnvMissing on calling required!' do
+        expect {
+          ENVied.require!
+        }.to raise_error(ENVied::Configurable::EnvMissing)
+      end
+
+      it 'raises EnvMissing when interacted with and configured variable not present in ENV' do
+        expect {
+          ENVied.any_missing_method
+        }.to raise_error(ENVied::Configurable::EnvMissing)
+      end
+    end
+
+    context 'ENV containing variable of different type' do
+      before { configured_with(a: :Integer).and_ENV('A' => 'NaN') }
+
+      specify do
+        expect {
+          ENVied.a
+        }.to raise_error(ENVied::Configurable::EnvWrongType)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'envied'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: envied
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gert Goet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+description: no, really
+email:
+- gert@thinkcreate.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- envied.gemspec
+- lib/envied.rb
+- lib/envied/version.rb
+- spec/envied_spec.rb
+- spec/spec_helper.rb
+- underconstruction.gif
+homepage: ''
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: ENV on epo
+test_files:
+- spec/envied_spec.rb
+- spec/spec_helper.rb