inquisitive 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0386fe6dcde04e8963c090b8b2e937003cd0f23a
-  data.tar.gz: fd157641b836c285be3f496e644d25eedd2dc8ca
+  metadata.gz: 82f138341b19063e39338834d96ff3cd4bb479e1
+  data.tar.gz: d518c1b744f8ac23092a992b39cf38cc49ffb97b
 SHA512:
-  metadata.gz: 7bdaac4757a5166432c9a0af4b31d78d33d07498a7ce6ee2b2d5b9daedb0a58c581a6f7e6edcf5fd906c955030f13fe34dc81d05fd3ecef953e3dc7961a0cef0
-  data.tar.gz: 429c3aed3a0de7a9c99ef3ebce6d381baab13c9b577d7678954000a40e6b3b264e0ffdf4142c818a312d68a11cd2a3292695d247c7ab4ebb260c77983011c201
+  metadata.gz: 829304a8b3326698f81ce23868356a969578344ac7b93d39ed59687269a0574c095ce9cee48e11fc8c2216e99bff06339ab8da0d5ef76cc73827ce682f070e82
+  data.tar.gz: cd501e9fbb4651689562457adc90b1f94bd0e076caf70c150550e1019788aaa2eef8e56d7ab1b8d81dd786c772fcd9cdb237c76eba62c7a458c0c48c032b0dba

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+Changes to Inquisitive
+======================
+
+> **Please consult this file when upgrading Inquisitive for important information on bugfixes, new features, and backwards incompatible changes.**
+
+Starting with **[2.0.0](#2.0.0)**, Inquisitive follows [symantic versioning](symver.org) to help inform you of the implications of upgrades.
+
+Releases
+--------
+
+[2.0.0]: https://github.com/christhekeele/inquisitive/tree/2.0.0
+[1.2.0]: https://github.com/christhekeele/inquisitive/tree/f314eaf84f7c3d9a2d56ae684d031dd81d2f7b85
+
+- [2.0.0](#2.0.0)
+- [1.2.0](#1.2.0)
+
+2.0.0 - [2014.06.19][2.0.0]
+---------------------------
+
+### Breaking
+
+- `Inquisitive::Environment`: **hash detection**
+
+  Previously `inquires_about` needed a special syntax to detect when you want to parse a group of environment variables as a hash. This was accomplished by leaving a trailing `_` in the declaration, such as:
+  
+  ```ruby
+  ENV['PREFIX_KEY1'] = "value1"
+  ENV['PREFIX_KEY2'] = "value2"
+  module Mine
+    extend Inquisitive::Environment
+    inquires_about 'PREFIX_'
+  end
+  Mine.prefix
+  #=> { 'key1' => 'value1', 'key2' => 'value2' }
+  ```
+  
+  Now it auto-detects hash groupings by looking for a double-`_` in the key itself:
+  
+  ```ruby
+  ENV['PREFIX__KEY1'] = "value1"
+  ENV['PREFIX__KEY2'] = "value2"
+  module Mine
+    extend Inquisitive::Environment
+    inquires_about 'PREFIX'
+  end
+  Mine.prefix
+  #=> { 'key1' => 'value1', 'key2' => 'value2' }
+  ```
+
+  Nested hashes (through multiple `__`'s) are not yet supported.
+
+- `Inquisitive::Environment`:  **default modes**
+
+  Previously the default mode was `:dynamic`. This was mostly to prevent unexpected behaviour for newcomers.
+  
+  Now `:static` is the default. This is because `Inquisitive::Environment` is meant to be loaded immediately after a boot script that prepares your environment variables, and queried often later. `:static` optimizes to this usecase.
+  
+  To reproduce the old behaviour, you must explicitly pass `mode: :dynamic` each to `inquires_about` invocation. Alternatively, `mode: :lazy` might be a viable way to get the benefits of `:static` without refactoring your boot process.
+  
+### Non-breaking
+
+- `Inquisitive::Environment`: **cached mode now lazy mode**
+
+  The `:cached` environment mode is now known as `:lazy`. This is backwards compatible because all logic handling modes explicitly checks for `:static` or `:dynamic`, so any other named mode has the same behaviour as `:lazy`.
+
+1.2.0 - [2013.11.21][1.2.0]
+---------------------------
+
+Everything to date.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in inquisitive.gemspec
 gemspec
+
+gem 'pry'

data/README.md

@@ -1,15 +1,29 @@
 Inquisitive
 ===========
 
-Predicate methods for those curious about their datastructures.
+> **Predicate methods for those curious about their datastructures.**
 
-Inquisitive allows you to interrogate objects about their contents with friendly, readable method chains. It's the logical conclusion of ActiveSupport's `StringInquirer`.
+Inquisitive provides String, Array, and Hash subclasses with dynamic predicate methods that allow you to interrogate the most common Ruby datastructures in a readable, friendly fashion. It's the inevitable evolution of ActiveSupport's `StringInquirer`.
 
-This library is extracted from several projects where I found myself building on the `Rails.env.production?` pattern: wrapping information from the `ENV` variable into more descriptive and flexible methods accessible from my main namespace. `Inquisitive::Environment` contains helper methods to further this end.
+It also allows you to auto-instanciate and read inquisitive datastructures straight from your `ENV` hash through the `Inquisitive::Environment` module.
 
-For all intents and purposes Inquisitive has no dependencies, doesn't pollute the global constant namespace with anything but `Inquisitive`, and doesn't touch any core classes. It uses ActiveSupport's `HashWithIndifferentAccess`, but will bootstrap itself with a minimal version extracted from ActiveSupport 4.0 if it cannot be found.
+Inquisitive will try to use ActiveSupport's `HashWithIndifferentAccess`, but if that cannot be found it will bootstrap itself with a minimal, well-tested version extracted from ActiveSupport 4.0.
 
-It also leans on `method_missing`, `dup`, and wrapper objects, so if your application is too inquisitive you might find it grinding to a halt. It's recommended to only use it to switch on a few core runtime environment variables. Don't serialize ActiveRecord attributes into it, is what I'm saying here.
+Installation
+------------
+
+To add to your project:
+
+```bash
+$ echo "gem 'inquisitive'" >> Gemfile
+$ bundle install
+```
+
+Otherwise:
+
+```bash
+gem install inquisitive
+```
 
 Usage
 -----
@@ -95,7 +109,7 @@ config.no.api?
 
 ### Inquisitive Environment
 
-`Inquisitive::Environment` can be used in your modules and classes to more easily interrogate the `ENV` variable:
+`Inquisitive::Environment` can be used in your modules and classes to more easily interrogate `ENV` variables with inquisitive objects:
 
 #### Strings
 
@@ -134,12 +148,12 @@ MyGame.supported_databases.sql_server?
 #### Hashes
 
 ```ruby
-ENV['STUB_AUTHENTICATION'] = 'true'
-ENV['STUB_IN'] = "development"
-ENV['STUB_SERVICES'] = "database,api"
+ENV['STUB__AUTHENTICATION'] = 'true'
+ENV['STUB__IN'] = "development"
+ENV['STUB__SERVICES'] = "database,api"
 class MyGame
   extend Inquisitive::Environment
-  inquires_about 'STUB_'
+  inquires_about 'STUB'
 end
 
 MyGame.stub.authentication?
@@ -180,10 +194,10 @@ MyGame.env.production?
 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'
+ENV['STUB__AUTHENTICATION'] = 'false'
 class MyGame
   extend Inquisitive::Environment
-  inquires_about 'STUB_'
+  inquires_about 'STUB'
 end
 
 MyGame.stub.authentication
@@ -220,16 +234,16 @@ MyGame.stub_registration?
 
 This only works on top-level inquirers, so there's no way to get our nested `MyGame.stubbed.authentication?` to behave as expected (currently).
 
-The `present_if` check uses `===` under the covers for maximum expressiveness, so you can also use it to match against regexs and other constructs.
+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.
 
 #### Inquiry mode
 
-Environment inquirers have three configurable modes, defaulting to `:dynamic`:
+Environment inquirers have three configurable modes, defaulting to `:static`.
 
 ```ruby
 class MyGame
   extend Inquisitive::Environment
-  inquires_about 'STUB_', mode: %i[dynamic cached static].sample
+  inquires_about 'STUB', mode: %i[dynamic lazy static].sample
 end
 ```
 
@@ -239,7 +253,7 @@ end
 
     Use if you're manipulating the environment in between invocations, so `Inquisitive` can pick up on new values, detect changes between string or array notation, and discover new keys for hash notation.
 
-- **Cached**
+- **Lazy**
 
     Environment inquiries check `ENV` on their first invocation, and re-use the response in future invocations.
 

data/Rakefile

@@ -6,3 +6,7 @@ Rake::TestTask.new do |t|
   t.test_files = Dir['test/**/*_test.rb']
 end
 task default: :test
+
+task :console do
+  `pry -I lib -r inquisitive.rb`
+end

data/inquisitive.gemspec

@@ -4,11 +4,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "inquisitive"
-  spec.version       = "1.2.0"
+  spec.version       = "2.0.0"
   spec.authors       = ["Chris Keele"]
   spec.email         = ["dev@chriskeele.com"]
-  spec.description   = "Predicate methods for those curious about their datastructures."
   spec.summary       = "Predicate methods for those curious about their datastructures."
+  spec.description   = <<-DESC
+    Predicate methods for those curious about their datastructures.
+    
+    Provides String, Array, and Hash subclasses with dynamic predicate methods that
+    allow you to interrogate the contents of the most common Ruby datastructures
+    in a readable, friendly fashion.
+    
+    Also allows you to auto-instanciate and read inquisitive datastructures straight
+    from your `ENV` hash.
+  DESC
   spec.homepage      = "https://github.com/rawsugar/inquisitive"
   spec.license       = "MIT"
 

data/lib/inquisitive/environment.rb

@@ -8,7 +8,7 @@ module Inquisitive
       @__env_accessors__ ||= HashWithIndifferentAccess.new
       @__env_accessors__[env_accessor] = env_var
 
-      mode = Inquisitive[ opts.fetch(:mode, :dynamic).to_s ]
+      mode = Inquisitive[ opts.fetch(:mode, :static).to_s ]
 
       if mode.dynamic?
 
@@ -45,23 +45,25 @@ module Inquisitive
       end
     end
 
+  private
+
     module Parser
       class << self
 
         def [](var_name)
           if ENV.has_key? var_name
+            
             env_var = ENV[var_name]
-
             if env_var.include? ','
               env_var.split(',').map(&:strip)
             else
               env_var
             end
 
-          elsif hash_var? var_name
+          elsif env_vars = can_find_env_keys_from(var_name)
 
-            Parser.env_keys_from(var_name).reduce({}) do |hash, key|
-              hash[Parser.key_for(key, var_name)] = Inquisitive[Parser[key]]
+            env_vars.reduce({}) do |hash, key|
+              hash[key_for(key, var_name)] = Inquisitive[Parser[key]]
               hash
             end
 
@@ -69,19 +71,20 @@ module Inquisitive
             ""
           end
         end
-
-        def hash_var?(var_name)
-          var_name[-1] == '_'
+        
+        def can_find_env_keys_from(var_name)
+          found = env_keys_from(var_name)
+          found.empty? ? nil : found
         end
 
         def env_keys_from(var_name)
           ENV.keys.select do |key|
-            key =~ /^#{var_name}/
+            key =~ /^#{var_name}__/
           end
         end
 
         def key_for(env_key, var_name)
-          env_key.gsub("#{var_name}", '').downcase
+          env_key.gsub("#{var_name}__", '').downcase
         end
 
       end

data/lib/inquisitive/hash_with_indifferent_access.rb

@@ -40,14 +40,6 @@ module Inquisitive
       end
     end
 
-    def steal_default_from(hash)
-      if hash.default_proc
-        self.default_proc = hash.default_proc
-      else
-        self.default = hash.default
-      end
-    end
-
     alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
     alias_method :regular_update, :update unless method_defined?(:regular_update)
 
@@ -84,6 +76,11 @@ module Inquisitive
     def fetch(key, *extras)
       super(convert_key(key), *extras)
     end
+    
+    # not sure why just this one Enumerable method fails tests without override
+    def reject(*args, &block)
+      self.class[super]
+    end
 
     def values_at(*indices)
       indices.collect {|key| self[convert_key(key)]}
@@ -155,6 +152,14 @@ module Inquisitive
 
   protected
 
+    def steal_default_from(hash)
+      if hash.default_proc
+        self.default_proc = hash.default_proc
+      else
+        self.default = hash.default
+      end
+    end
+
     def convert_key(key)
       key.kind_of?(Symbol) ? key.to_s : key
     end

data/test/inquisitive/combinatorial_environment_test.rb

@@ -4,18 +4,18 @@ class InquisitiveCombinatorialEnvironmentTest < EnvironmentTest
     super
     ENV['STRING'] = @raw_string
     ENV['ARRAY'] = @raw_array.join(',')
-    ENV['HASH_AUTHENTICATION'] = @raw_hash[:authentication].to_s
-    ENV['HASH_IN'] = @raw_hash[:in]
-    ENV['HASH_DATABASES'] = @raw_hash[:databases].join(',')
+    ENV['HASH__AUTHENTICATION'] = @raw_hash[:authentication].to_s
+    ENV['HASH__IN'] = @raw_hash[:in]
+    ENV['HASH__DATABASES'] = @raw_hash[:databases].join(',')
   end
   def teardown
     super
     ENV.delete 'STRING'
     ENV.delete 'ARRAY'
-    ENV.delete 'HASH_AUTHENTICATION'
-    ENV.delete 'HASH_IN'
-    ENV.delete 'HASH_DATABASES'
-    ENV.delete 'HASH_SOMETHING_NEW'
+    ENV.delete 'HASH__AUTHENTICATION'
+    ENV.delete 'HASH__IN'
+    ENV.delete 'HASH__DATABASES'
+    ENV.delete 'HASH__SOMETHING_NEW'
   end
 
   def change_string_variable
@@ -25,12 +25,12 @@ class InquisitiveCombinatorialEnvironmentTest < EnvironmentTest
     ENV['ARRAY'] = [ ENV['ARRAY'], 'something_new' ].join ','
   end
   def change_hash_variable
-    ENV['HASH_SOMETHING_NEW'] = 'true'
+    ENV['HASH__SOMETHING_NEW'] = 'true'
   end
 
 end
 
-%w[dynamic cached static].each do |mode|
+%w[dynamic lazy static].each do |mode|
   %w[string array hash].each do |type|
 
     Inquisitive.const_set(
@@ -45,7 +45,7 @@ end
           super
           @mode = Inquisitive[self.class.mode]
           @type = Inquisitive[self.class.type]
-          App.inquires_about @type.upcase + (@type == "hash" ? "_" : ""), mode: @mode
+          App.inquires_about @type.upcase, mode: @mode
         end
 
         def string

data/test/inquisitive/environment_test.rb

@@ -4,32 +4,25 @@ class InquisitiveEnvironmentTest < EnvironmentTest
 
   def test_missing_variable_responses
     App.inquires_about 'DOES_NOT_EXIST', with: :exists
-    assert_equal App.exists, ""
+    assert_equal "", App.exists
   end
   def test_missing_variable_predicates
     App.inquires_about 'DOES_NOT_EXIST', with: :exists
     refute App.exists?
   end
 
-  def test_missing_hash_variable_responses
-    App.inquires_about 'DOES_NOT_EXIST_', with: :exists
-    assert_equal App.exists, {}
-  end
-  def test_missing_hash_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
   end
 
-  def test_default_mode_of_dynamic
-    App.inquires_about 'DEFAULTS_TO', with: :defaults_to
-    App.defaults_to # Call once to ensure no caching
+  def test_default_mode_of_static
+    ENV['DEFAULTS_TO'] = 'static'
+    App.inquires_about 'DEFAULTS_TO'
+    ENV['DEFAULTS_TO'] = 'lazy'
+    assert App.defaults_to.static?
     ENV['DEFAULTS_TO'] = 'dynamic'
-    assert App.defaults_to.dynamic?
+    assert App.defaults_to.static?
   end
 
   def test_custom_string_presence

data/test/shared/combinatorial_environment_tests.rb

@@ -15,7 +15,7 @@ module CombinatorialEnvironmentTests
   end
 
   def test_changing_variable_after_definition
-    App.inquires_about @type.upcase + (@type == "hash" ? "_" : ""), mode: @mode, with: :precache
+    App.inquires_about @type.upcase, mode: @mode, with: :precache
     test = @mode.static? ? :assert_equal : :refute_equal
     precache = App.precache
     send :"change_#{@type}_variable"

metadata

@@ -1,79 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: inquisitive
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Keele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.7'
-description: Predicate methods for those curious about their datastructures.
+description: "    Predicate methods for those curious about their datastructures.\n
+  \   \n    Provides String, Array, and Hash subclasses with dynamic predicate methods
+  that\n    allow you to interrogate the contents of the most common Ruby datastructures\n
+  \   in a readable, friendly fashion.\n    \n    Also allows you to auto-instanciate
+  and read inquisitive datastructures straight\n    from your `ENV` hash.\n"
 email:
 - dev@chriskeele.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -107,17 +112,17 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Predicate methods for those curious about their datastructures.
@@ -134,3 +139,4 @@ test_files:
 - test/shared/hash_tests.rb
 - test/shared/string_tests.rb
 - test/test_helper.rb
+has_rdoc: