inquisitive 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80d236d855c6c33b3ec287fcd2c3a302388608f3
-  data.tar.gz: bd301adffafcbc757db422e5e0adeb780a06b5e4
+  metadata.gz: e22f450e21c1139aff9b5587f6da20f9964ed3f5
+  data.tar.gz: 26d9737845ee0028316664d7715ec0b2457619b1
 SHA512:
-  metadata.gz: e19cf79e18d77f23a58ee9c6dfc6d87af7262e4fd828f271e9cfe3694c67b38d11ea6c10764a14b6483ce037accac1491348a9a25ef6351c5d7332b6f0cd1d6a
-  data.tar.gz: 5e287d046ac747a2f27391bb6c38046b33c3123c93e953546948a06d16500cacde4629fcb77b66c39cfee4941eebb8e1d8df6ba7e4ca41ae6313d7c5989cadd3
+  metadata.gz: 213264cbb822921b64d7393fcdeee3c135dbee7e4ae4ed93d9150b01354fe6f0803d4028cc2ad64147ccf47239de5c2ec49121a60338911beec8dc4d697dc561
+  data.tar.gz: eea7a7c74d2a3288e6902b1012bccefbaec395e7847007d1dd87fa1cfaa109bdea7d9bcf00ea41af33f36115c504e28059bf6be4ceac90f2b7750aaa0c877e65

data/README.md

@@ -301,10 +301,94 @@ MyApp.env
 #=> "development"
 MyApp.env.development?
 #=> true
+
 MyApp.env.production?
 #=> false
 ```
 
+#### Presence
+
+Environment inquirers can have explicit presence checks, circumventing a common pitfall when reasoning about environment variables. Borrowing from the example above:
+
+```ruby
+ENV['STUB__AUTHENTICATION'] = 'false'
+class MyApp
+  extend Inquisitive::Environment
+  inquires_about 'STUB'
+end
+
+MyApp.stub.authentication
+#=> "false"
+MyApp.stub.authentication?
+#=> true
+MyApp.stub.authentication.true?
+#=> false
+```
+
+It's common to use the presence of environment variables as runtime booleans. This is frequently done by setting the environment variable to the string `"true"` when you want it to be true, and not at all otherwise. As demonstrated, this pattern can lead to ambiguity when the string is other values.
+
+By default such variables will be parsed as an `Inquisitive::String`, so predicate methods will return true whatever their contents, as long as they exist. You can bind the predicate method tighter to an explicit value if you prefer:
+
+```ruby
+ENV['STUB_AUTHENTICATION'] = 'false'
+ENV['STUB_REGISTRATION'] = 'true'
+class MyApp
+  extend Inquisitive::Environment
+  inquires_about 'STUB_AUTHENTICATION', present_if: 'true'
+  inquires_about 'STUB_REGISTRATION', present_if: 'true'
+end
+
+MyApp.stub_authentication
+#=> "false"
+MyApp.stub_authentication?
+#=> false
+
+MyApp.stub_registration
+#=> "true"
+MyApp.stub_registration?
+#=> true
+```
+
+This only works on top-level inquirers, so there's no way to get our nested `MyApp.stubbed.authentication?` to behave as expected. Prefer `MyApp.stubbed.authentication.true?` instead.
+
+The `present_if` check uses `===` under the covers for maximum expressiveness, so you can also use it to match against regexs, classes, and other constructs.
+
+##### Truthy Booleans
+
+`Inquisitive::Environment.truthy` contains a regex useful for reading booleans from environment variables.
+
+```ruby
+ENV['NO'] = 'no'
+ENV['YES'] = 'yes'
+ENV['TRUTHY'] = 'TrUe'
+ENV['FALSEY'] = 'FaLsE'
+ENV['BOOLEAN'] = '1'
+ENV['BOOLENOPE'] = '0'
+class MyCli
+  extend Inquisitive::Environment
+  inquires_about 'NO', present_if: truthy
+  inquires_about 'YES', present_if: truthy
+  inquires_about 'TRUTHY', present_if: truthy
+  inquires_about 'FALSEY', present_if: truthy
+  inquires_about 'BOOLEAN', present_if: truthy
+  inquires_about 'BOOLENOPE', present_if: truthy
+end
+
+MyApp.no?
+#=> false
+MyApp.yes?
+#=> true
+
+MyApp.truthy?
+#=> true
+MyApp.falsey?
+#=> false
+
+MyApp.boolean?
+#=> true
+MyApp.boolenope?
+```
+
 #### Inquiry mode
 
 Environment inquirers have three configurable modes, defaulting to `:static`.

data/inquisitive.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "inquisitive"
-  spec.version       = "3.0.0"
+  spec.version       = "3.1.0"
   spec.authors       = ["Chris Keele"]
   spec.email         = ["dev@chriskeele.com"]
   spec.summary       = "Predicate methods for those curious about their datastructures."

data/lib/inquisitive/environment.rb

@@ -2,6 +2,10 @@ module Inquisitive
   module Environment
     include Inquisitive
 
+    def truthy
+      /true|yes|1/i
+    end
+
     def inquires_about(env_var, opts={})
 
       env_accessor = opts.fetch(:with, env_var.downcase[/(.*?)(?=(?:_$|$))/])
@@ -31,6 +35,19 @@ module Inquisitive
 
       end
 
+      present_if = opts.fetch(:present_if, nil)
+
+      @__env_presence__ ||= HashWithIndifferentAccess.new
+      @__env_presence__["#{env_accessor}?"] = present_if if present_if
+
+      define_singleton_method :"#{env_accessor}?" do
+        if @__env_presence__.has_key? __method__
+          @__env_presence__[__method__] === send(predication(__method__))
+        else
+          Inquisitive.present? send(predication(__method__))
+        end
+      end
+
     end
 
   private

data/test/inquisitive/environment_test.rb

@@ -2,6 +2,11 @@ require 'test_helper'
 
 class InquisitiveEnvironmentTest < EnvironmentTest
 
+  def test_missing_variable_predicates
+    App.inquires_about 'DOES_NOT_EXIST', with: :exists
+    refute App.exists?
+  end
+
   def test_autonaming_of_inquirers
     App.inquires_about 'NAME_NOT_SPECIFIED'
     assert App.respond_to? :name_not_specified
@@ -16,4 +21,30 @@ class InquisitiveEnvironmentTest < EnvironmentTest
     assert App.defaults_to.static?
   end
 
+  def test_custom_string_presence
+    ENV['AUTHORIZABLE'] = 'false'
+    App.inquires_about 'AUTHORIZABLE', present_if: 'true'
+    refute App.authorizable?
+  end
+
+  def test_custom_regex_presence
+    ENV['AUTHORIZABLE'] = 'not at all'
+    App.inquires_about 'AUTHORIZABLE', present_if: /yes/
+    refute App.authorizable?
+  end
+
+  def test_custom_class_presence
+    ENV['AUTHORIZABLE'] = 'not at all'
+    App.inquires_about 'AUTHORIZABLE', present_if: Array
+    refute App.authorizable?
+  end
+
+  %w[true True TrUe TRUE yes Yes YeS YES 1].each do |truthy_var|
+    define_method :"test_truthy_var_#{truthy_var}" do
+      ENV['TRUTHY'] = truthy_var
+      App.inquires_about 'TRUTHY', present_if: App.truthy
+      assert App.truthy?
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inquisitive
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Chris Keele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler