env_bang 0.2.8.1 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec44b0eec6674b6a0cdf6f16989121a5bda0d79b
-  data.tar.gz: 58a68baf89c28c817f8b543cb5ec485aa83bef6f
+  metadata.gz: dfe99ce78ee95e20f85bd9467d2131b39550dd78
+  data.tar.gz: a24392f5e44fbcc89903e5c73d365eefd74d86d1
 SHA512:
-  metadata.gz: a92587c42bda2d877ecb4fe61b7358579ec7869c01afd064c722dc87e46f278b6a4ad94cec923180d0a98e2ef13ba7383eb583a26738a54e8744d4bea8e20764
-  data.tar.gz: 7fd541f39092230c9a3e84775b0be6aac4a4c9fd345efb4ff5659535732fa7450c2f67bc6db707a640c1c32b5cfb0f02fdb6c54d9930a3cb8645e3d2dd698f2e
+  metadata.gz: 9081e3b9ee0253b58ba4f1eb6561e1afc4d988c468b0b4a68a98b86442afde16c97a847b32b028cbc03a987763fb8f5f390f045b8c44231604603d172115df92
+  data.tar.gz: 180d9a2a0d823caec0f48dbb4f15e99329b82d69d058b6b703d6a865ddb01ae8a44bd14ed6969ab216b2cfc70e4a544076abd4624b0983905177ba30205f0765

data/README.md

@@ -56,9 +56,6 @@ ENV!.config do
 end
 ```
 
-A single variable can also be configured with `ENV!.use MY_VAR`, but the `ENV!.config` block
-will typically be a cleaner place for all the variables for your app.
-
 Once a variable is specified with the `use` method, access it with
 
 ```ruby
@@ -126,7 +123,7 @@ end
 #### Default type conversion behavior
 
 If you don’t specify a `:class` option for a variable, ENV! defaults to a special
-type conversion called `:StringUnlessFalsey`. This coversion returns a string, unless
+type conversion called `:StringUnlessFalsey`. This conversion returns a string, unless
 the value is a "falsey" string ('false', 'no', 'off', '0', 'disable', or 'disabled').
 To turn off this magic for one variable, pass in `class: String`. To disable it globally,
 set
@@ -168,6 +165,39 @@ ENV!['NUMBER_SET']
 #=> #<Set: {1, 3, 5, 7, 9}>
 ```
 
+## Implementation Notes
+
+1. ENV! is simply a method that returns ENV_BANG. In certain contexts
+   (like defining a class), the exclamation mark notation is not allowed,
+   so we use an alias to get this shorthand.
+
+2. Any method that can be run within an `ENV!.config` block can also be run
+   as a method directly on `ENV!`. For instance, instead of
+
+   ```ruby
+   ENV!.config do
+      add_class Set do
+        ...
+      end
+
+      use :NUMBER_SET, class: Set
+   end
+   ```
+
+   It would also work to run
+
+   ```ruby
+   ENV!.add_class Set do
+      ...
+   end
+
+   ENV!.use :NUMBER_SET, class: Set
+   ```
+   
+   While the `config` block is designed to provide a cleaner configuration
+   file, calling the methods directly can occasionally be handy, such as when
+   trying things out in an IRB/Pry session.
+
 ## Contributing
 
 1. Fork it

data/lib/env_bang.rb

@@ -1,4 +1,5 @@
 require "env_bang/version"
+require "env_bang/classes"
 require "env_bang/formatter"
 
 class ENV_BANG
@@ -7,11 +8,6 @@ class ENV_BANG
       instance_eval(&block)
     end
 
-    def clear_config
-      @vars = {}
-      default_class nil
-    end
-
     def use(var, *args)
       var = var.to_s
       description = args.first.is_a?(String) && args.shift
@@ -63,43 +59,6 @@ class ENV_BANG
       end
     end
   end
-
-  module Classes
-    class << self
-      attr_writer :default_class
-
-      def default_class
-        @default_class ||= :StringUnlessFalsey
-      end
-
-      def cast(value, options = {})
-        public_send(:"#{options.fetch(:class, default_class)}", value, options)
-      end
-
-      def boolean(value, options)
-        !(value =~ /^(|0|disabled?|false|no|off)$/i)
-      end
-
-      def Array(value, options)
-        options.delete(:class)
-        options[:class] = options[:of] if options[:of]
-        value.split(',').map { |value| cast(value.strip, options) }
-      end
-
-      def Symbol(value, options)
-        value.to_sym
-      end
-
-      def StringUnlessFalsey(value, options)
-        boolean(value, options) && value
-      end
-
-      # Delegate methods like Integer(), Float(), String(), etc. to the Kernel module
-      def method_missing(klass, value, options, &block)
-        Kernel.send(klass, value)
-      end
-    end
-  end
 end
 
 def ENV!

data/lib/env_bang/classes.rb

@@ -0,0 +1,38 @@
+class ENV_BANG
+  module Classes
+    class << self
+      attr_writer :default_class
+
+      def default_class
+        @default_class ||= :StringUnlessFalsey
+      end
+
+      def cast(value, options = {})
+        public_send(:"#{options.fetch(:class, default_class)}", value, options)
+      end
+
+      def boolean(value, options)
+        !(value =~ /^(|0|disabled?|false|no|off)$/i)
+      end
+
+      def Array(value, options)
+        options.delete(:class)
+        options[:class] = options[:of] if options[:of]
+        value.split(',').map { |value| cast(value.strip, options) }
+      end
+
+      def Symbol(value, options)
+        value.to_sym
+      end
+
+      def StringUnlessFalsey(value, options)
+        boolean(value, options) && value
+      end
+
+      # Delegate methods like Integer(), Float(), String(), etc. to the Kernel module
+      def method_missing(klass, value, options, &block)
+        Kernel.send(klass, value)
+      end
+    end
+  end
+end

data/lib/env_bang/version.rb

@@ -1,3 +1,3 @@
 class ENV_BANG
-  VERSION = "0.2.8.1"
+  VERSION = "0.2.9"
 end

data/test/env_bang_test.rb

@@ -2,7 +2,8 @@ require_relative 'test_helper'
 
 describe ENV_BANG do
   before do
-    ENV!.clear_config
+    ENV_BANG.instance_eval { @vars = nil }
+    ENV_BANG::Classes.default_class = nil
   end
 
   it "Raises exception if unconfigured ENV var requested" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_bang
 version: !ruby/object:Gem::Version
-  version: 0.2.8.1
+  version: 0.2.9
 platform: ruby
 authors:
 - Jonathan Camenisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,6 +56,7 @@ files:
 - env_bang.gemspec
 - lib/env_bang-rails.rb
 - lib/env_bang.rb
+- lib/env_bang/classes.rb
 - lib/env_bang/formatter.rb
 - lib/env_bang/version.rb
 - test/env_bang_test.rb