hood 0.0.0 → 0.0.1

data/HISTORY.md

@@ -0,0 +1,6 @@
+## 0.0.1 (11-1-11)
+
+* First release
+* Basic support for required variables
+* DSL is complete
+* Barebones Railtie is finished

data/README.md

@@ -1,7 +1,7 @@
 # Hood
 
-*Hood is currently in alpha development. Our feature-set isn't fully developed,
-our specs are weak, and there are probably bugs.*
+**Hood is currently in alpha development. Our feature-set isn't fully developed,
+our specs are weak, and there are probably bugs.**
 
 Hood is to enviroment variables as bundler is to gems. To put it simply, we have
 the following goals:
@@ -17,7 +17,11 @@ Hood uses something called an "Envfile" to define environment variables. It uses
 a DSL (Domain Specific Language) similar to Bundler's to do so:
 
 ```ruby
-env "GOOGLE_MAPS_API_KEY", required: true
+env "GOOGLE_MAPS_API_KEY"
+
+env "REDIS_URI", :default => "localhost:6379"
+
+env "SALES_TAX", :description => "Current sales tax in Los Angeles (eg. 0.0875)"
 
 prefix "DB_" do
   env "PASSWORD"
@@ -31,5 +35,19 @@ end
 ## Options
 * :description - If the desired value isn't obvious, you can include a string
 * :optional - Pass true to avoid throwing a runtime error when the app starts and this var isn't present
-* :prefix - Prefixes the group (or env I guess) with the passed string. Useful when you have a group where all vars have the same prefix
 * :default - A pre-defined default value for this var
+
+## Compatibility
+
+Hood is tested against the following Rubies: MRI 1.8.7, MRI 1.9.2, MRI 1.9.3,
+Rubinius 2.0, and JRuby.
+
+![Build Status](https://secure.travis-ci.org/bloudermilk/hood.png?branch=master&.png)
+
+[Build History](http://travis-ci.org/#!/bloudermilk/hood)
+
+
+## License
+
+Hood is released under the MIT license. See the LICENSE file for more
+info.

data/lib/hood/dsl.rb

@@ -1,8 +1,13 @@
 module Hood
   class DSL
+    VALID_OPTION_KEYS = [:default, :description, :optional]
+
+    attr_reader :variables
+
     def self.evaluate(envfile)
       builder = new
-      #builder.instance_eval(
+      builder.instance_eval(Hood.read_file(envfile.to_s), envfile.to_s, 1)
+      builder
     end
 
     def initialize
@@ -11,10 +16,23 @@ module Hood
       @prefix     = ""
     end
 
+    def exists?(name)
+      !!@variables.index {|v| v.name == name }
+    end
+
     def env(name, opts={})
-      _normalize_options(name, opts)
+      name, opts = _normalize_options(name, opts)
 
       var = Variable.new(name, opts)
+
+      if exists? var.name
+        message = "You tried to define the variable '#{var.name}' twice."
+        raise DuplicateVariableError, message
+      end
+
+      @variables << var
+
+      var
     end
 
     def optional
@@ -24,7 +42,7 @@ module Hood
       @optional = old
     end
 
-    def prefix(prefix)
+    def prefix(prefix, &block)
       @prefix, old = @prefix + prefix, @prefix
       yield
     ensure
@@ -36,10 +54,10 @@ module Hood
     def _normalize_hash(opts)
       # Cannot modify a hash during an iteration in 1.9
       opts.keys.each do |k|
-        next if String === k
+        next if k.is_a? Symbol
         v = opts[k]
         opts.delete(k)
-        opts[k.to_s] = v
+        opts[k.to_sym] = v
       end
       opts
     end
@@ -47,17 +65,25 @@ module Hood
     def _normalize_options(name, opts)
       _normalize_hash(opts)
 
-      invalid_keys = opts.keys - %w(description prefix optional)
+      invalid_keys = opts.keys - VALID_OPTION_KEYS
       if invalid_keys.any?
         plural = invalid_keys.size > 1
-        message = "You passed #{invalid_keys.map{|k| ':'+k }.join(", ")} "
+        message = "You passed #{invalid_keys.map{|k| ":#{k}" }.join(", ")} "
         if plural
-          message << "as options for env '#{name}', but they are invalid."
+          message << "as options for variable '#{name}', but they are invalid."
         else
-          message << "as an option for env '#{name}', but it is invalid."
+          message << "as an option for variable '#{name}', but it is invalid."
         end
-        raise InvalidOption, message
+        raise InvalidOptionError, message
       end
+
+      # The :optional option should default to the builder's state
+      opts[:optional] = @optional if opts[:optional].nil?
+
+      # Prepend the prefix
+      name = @prefix + name
+
+      [name, opts]
     end
   end
 end

data/lib/hood/railtie.rb

@@ -0,0 +1,7 @@
+module Hood
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      Hood.setup!
+    end
+  end
+end

data/lib/hood/variable.rb

@@ -1,7 +1,29 @@
 module Hood
   class Variable
+    attr_reader :name, :description, :default
+
     def initialize(name, opts={})
-      @name = opts[:name]
+      @name         = name
+      @default      = opts[:default]
+      @description  = opts[:description]
+      @optional     = !!opts[:optional]
+    end
+
+    def optional?
+      @optional
+    end
+
+    def fulfill!
+      ENV[name] ||= @default
+
+      unless valid?
+        message = "Missing required environment variable '#{name}'"
+        raise UnfulfilledVariableError, message
+      end
+    end
+
+    def valid?
+      !!ENV[name] || optional?
     end
   end
 end

data/lib/hood/version.rb

@@ -1,3 +1,3 @@
 module Hood
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/lib/hood.rb

@@ -1,6 +1,32 @@
 module Hood
   autoload :DSL,      "hood/dsl"
-  autoload :Variable, "hood/dsl"
+  autoload :Variable, "hood/variable"
+  autoload :VERSION,  "hood/version"
 
+  class HoodError                 < StandardError ; end
+  class DslError                  < HoodError     ; end
+  class InvalidOptionError        < DslError      ; end
+  class DuplicateVariableError    < DslError      ; end
+  class UnfulfilledVariableError  < HoodError     ; end
 
+  class << self
+    def read_file(file)
+      File.open(file, "rb") { |f| f.read }
+    end
+
+    def setup!
+      load_envfile
+      fulfull_requirements
+    end
+
+    def load_envfile
+      @builder = DSL.evaluate("Envfile")
+    end
+
+    def fulfill_requirements
+      @builder.variables.each(&:fulfill!)
+    end
+  end
 end
+
+require "hood/railtie" if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hood
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-31 00:00:00.000000000Z
+date: 2011-11-01 00:00:00.000000000Z
 dependencies: []
-description: Description has not been written yet.
+description: Hood gives you a standard way to define environment variable requirements
+  for your app.
 email:
 - brendan@gophilosophie.com
 executables: []
@@ -19,9 +20,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hood/dsl.rb
+- lib/hood/railtie.rb
 - lib/hood/variable.rb
 - lib/hood/version.rb
 - lib/hood.rb
+- HISTORY.md
 - LICENSE
 - Rakefile
 - README.md
@@ -39,7 +42,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2469481964501867426
+      hash: -1841366577289620485
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -48,11 +51,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2469481964501867426
+      hash: -1841366577289620485
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Summary has not been written yet
+summary: Hood is the easiest way to manage your applications environment variables.
 test_files: []