config_module 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d4f6c816e394924d4d3e833ef2d3c8be39cc6048a1167dca507761c6f965db
-  data.tar.gz: b782426dd752d18ed5ca2a8a6ec2f8c98998156d6fd2b5807cea0f7eebf629fd
+  metadata.gz: 701a829eca82ba1d43a19d1bd2b75193f023251871313acc51482ca29fa4f66e
+  data.tar.gz: 05f819d5bf5b604edae092a8a42ea52b3f384cf6c2c53c1922cf04a2769f4c14
 SHA512:
-  metadata.gz: b12be1b132e0e47a3a80f1bde3ae177e1f8ad7f73edd9228ad3c2830e706189571104ae0768b0c5fa53b986f444894dde2b9a6e34a8b1a93b1ddf0ddcd68f32f
-  data.tar.gz: 53678ce655a23c423bad46535a774075a8ecb5483ef9237677d3e0484a5a500884391a11beab622c0d2e1915205cd7530379581d1e5428ed61c23bd14e0bf437
+  metadata.gz: 01ed4412fab19c1b3c7809f5e8d89fb7885c3ce3fcf51907bde289fc088986db1731471b37f409badd50aafec97af9f27aabdbcbafcc09777755cf2dea6737e8
+  data.tar.gz: 656d3401a0dd788025efeae0c09d200dfaededfdffe3872ab2da6f40255c7999a9047455877ec1a017e5499fc742e4e66c0ea653354ae8e6bce65b7e6d50955c

data/.codeclimate.yml

@@ -8,6 +8,8 @@ engines:
   rubocop:
     enabled: true
     channel: rubocop-0-50
+    config:
+      file: .rubocop.yml
   reek:
     enabled: true
 ratings:

data/.editorconfig

@@ -0,0 +1,12 @@
+
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.3.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+# [The official Code of Conduct can be found in the Project Standards repository.](https://github.com/acook/project_standards/blob/master/community/coc.markdown)

data/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# How to Contribute
+
+Hi, and thanks for your interest in this project! We look forward to your contributions!
+
+# Getting Started
+
+To contribute to this project you'll need...
+
+- Git
+- A GitHub/Gitlab account
+- A compiler/interpreter for the language you're using
+- The latest project repo
+- Sent me an email just to say hi and that you agree to the Contributor's Agreement (at the bottom)
+
+# If You Want to Assist
+
+- Check out the Trello Board and GitHub/Gitlab Issues to see what there is to do
+- Pick out a task from the Ready list on Trello or a Bug tag from Issues
+- Fork the repo and start getting familiar with the codebase
+- Make your changes (see Git Commit Messages and Code Standards sections later in this document)
+- Run the examples to make sure you didn't break anything
+- Open a Pull Request
+- Also, feel free to email me through GitHub (people do it all the time) or post an issue if you need help
+
+# If You Have An Idea
+
+- As above, check the Trello Board and GitHub Issues
+- See if there's an existing or similar idea
+- If so, feel free to start working on a solution (see above section), or wait for someone else to pick it up
+- If not, submit it as a GitHub issue
+
+# To Report a Bug
+
+Please use GitHub/Gitlab Issues and provide as much as possible of the following...
+
+- The version or git SHA1 of the project that you're using
+- An example to reproduce the problem
+- A clear description of what you expected to happen
+- Detailed information about what happened instead
+- Include the full text of any error messages
+- Your OS and its release info (eg Debian Jesse or Windows 8.1)
+
+# Git Commit Messages
+
+- Stick to GitHub's suggested commit message length
+- Keep commits small, don't squash commits, but do clean up WIPs
+- Write informative summary of why your made your changes
+- Try to keep each commit in a working state whenever possible
+- Use git add -p to chunk up your changes into logical units if you make several unrelated changes
+
+# Code Standards
+
+Please use idiomatic formatting for the language, there are plugins for many editors which do this automatically. Each project may specify additional formatting guidelines. 
+
+- Use [EditorConfig](https://editorconfig.org/)
+- Correct errors or new warnings that the CI and status checks report
+
+# Contributor Agreement
+
+You must agree to this contributor agreement when contributing.
+
+You grant me (Anthony M. Cook) a non-exclusive unlimited license to use your contributions. As well as granting a non-exclusive unlimited license to any patents you hold that you utilize in your contribution. You promise to not include patents or code that you don't have the permissions to grant these rights. You continue to own your copyright and patents for your contributions, you're just letting me use them.
+
+You also grant permission for me (Anthony M. Cook) to change the license(s) of this project, since we never know what the futer may hold! Even if released under a new license, the existing code will remain under the existing license. This allows persons and organizations to contribute to the development of this project financially without being bound by the terms of the standard agreement. This is called a dual-licensing model and you can find out more about how it benefits open source projects [on the OSS Watch page](http://oss-watch.ac.uk/resources/duallicence2). 
+
+Thanks so much for your contributions! 
+
+# Official Version of this Document
+The contents of the official version supercede the above, in case they get out of sync!
+https://github.com/acook/project_standards/edit/master/Contributing/CONTRIBUTING.markdown

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Anthony M. Cook
+
+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.markdown

@@ -5,12 +5,11 @@ Load important configuration files into their own modules!
 
 Reference documentation for the [Latest Released](http://rubydoc.info/gems/config_module/file/README.markdown) and [Edge Version](https://github.com/acook/config_module#readme) is available.
 
-[![Gem Version](https://img.shields.io/gem/v/config_module.svg)](https://rubygems.org/gems/config_module)
-[![Gem Downloads](https://img.shields.io/gem/dt/config_module.svg?maxAge=2592000)](https://rubygems.org/gems/config_module)
-[![Build Status](https://travis-ci.org/acook/config_module.svg?branch=master)](https://travis-ci.org/acook/config_module)
+[![Gem Version](https://img.shields.io/gem/v/config_module.svg?style=for-the-badge)](https://rubygems.org/gems/config_module)
+[![Gem Downloads](https://img.shields.io/gem/dt/config_module.svg?style=for-the-badge)](https://rubygems.org/gems/config_module)
+[![Build Status](https://img.shields.io/travis/acook/config_module.svg?style=for-the-badge)](https://travis-ci.org/acook/config_module)
+[![Maintainability](https://api.codeclimate.com/v1/badges/14d47ea9d0e90d40154d/maintainability)](https://codeclimate.com/github/acook/config_module/maintainability)
 [![CircleCI](https://circleci.com/gh/acook/config_module.svg?style=svg)](https://circleci.com/gh/acook/config_module)
-[![Code Climate](https://codeclimate.com/github/acook/config_module/badges/gpa.svg)](https://codeclimate.com/github/acook/config_module)
-[![Test Coverage](https://codeclimate.com/github/acook/config_module/badges/coverage.svg)](https://codeclimate.com/github/acook/config_module/coverage)
 
 Installation
 ------------
@@ -102,13 +101,7 @@ end
 
 ### Check for Presence of Configuration Keys with `has_key?`
 
-There are times you want to provde defaults for values, and in typical Ruby fashion you would probably do this:
-
-```ruby
-MyConfig.some_option || 'my default value'
-```
-
-Occassionally though, that won't be good enough because the value could intentionally be `false` or even `nil`. In those situations, you might want to check to see if the key exists (especially useful along with namespaces). Much like a Hash, you can use the `has_key?` method and do something like:
+You might want to check to see if the key exists (especially useful along with namespaces) before calling the method. Much like a Hash, you can use the `has_key?` method and do something like:
 
 ```ruby
 if MyConfig.has_key? :some_option then
@@ -133,13 +126,15 @@ You can access config options like a hash too, if you want:
   MyConfig.nonexistant_key   #=> raises ConfigModule::ConfigOption::NotFoundError
   ```
 
-  It'll also avoid any naming conflicts that might arise between methods defined on ConfigModule or ConfigOption and your key names. You can use it in concert with the above `config` method instead of `self` to enhance readability:
+  It'll also avoid any naming conflicts that might arise between methods names and key names. You can use it in concert with the above `config` method instead of `self` to enhance readability:
 
   ```ruby
   def bar
-    config[:namespace]
+    config[:my_key]
   end
   ```
+  
+  Lastly, it also doesn't wrap the returned value in a `ConfigOption`, it will return the underlying value such as a `Hash` directly.
 
 
 ### Enumerable
@@ -211,7 +206,6 @@ Caveats
 Who made this anyway?
 ---------------------
 
-I'm glad you asked!
-
-    Anthony M. Cook 2016
+    © 2016-2019 Anthony M. Cook
+    Contributors: Brian Hawley
 

data/config_module.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |gem|
   gem.version = ConfigModule::VERSION
   gem.authors = ["Anthony M. Cook"]
   gem.email = ["github@anthonymcook.com"]
-  gem.description =
-    "Wrap a configuration file in a module for easy use throughout your application. Inspired by Rails."
+  gem.description = <<-DESC.chomp.gsub(/^ */, "")
+    ConfigModule loads a YAML file into a module to make it easy to access and maintain your configurations.
+    It provides helpers for namespaces (like environments), hash-like square-bracket access, helpful custom exceptions, and optimized repeat access.
+  DESC
   gem.summary = "Load important configuration files into their own modules!"
   gem.homepage = "http://github.com/acook/config_module"
   gem.licenses = %w[MIT LGPL-3.0]

data/lib/config_module/config_helper.rb

@@ -13,14 +13,12 @@ module ConfigModule
     def method_missing_handler name, source, *args, &block
       ConfigOption.wrap config.send(name, *args, &block)
     rescue NoMethodError => error
-      if error.name == name
-        raise(
-          ConfigOption::NotFoundError.new(name, self, error),
-          error.message, source
-        )
-      else
-        raise
-      end
+      raise unless error.name == name
+
+      raise(
+        ConfigOption::NotFoundError.new(name, self, error),
+        error.message, source
+      )
     end
 
     def respond_to_missing_handler name, include_all
@@ -32,8 +30,10 @@ module ConfigModule
     end
 
     def load_config
-      @raw_config = YAML.load_file config_file
+      raise ConfigModule::ConfigFileNotSpecified, config_file unless config_file
+      raise ConfigModule::ConfigFileNotFound, config_file unless File.exist? config_file
 
+      yaml_load
       load_namespaces_from raw_config
     end
 
@@ -58,5 +58,18 @@ module ConfigModule
     def namespaces
       @namespaces ||= []
     end
+
+  private
+
+    def yaml_load
+      @raw_config =
+        if YAML::VERSION >= "3.0.2"
+          YAML.load_file config_file, fallback: {}
+        elsif YAML::VERSION >= "2.1.0"
+          YAML.load_file config_file, {}
+        else
+          YAML.load_file(config_file) || {} # ambiguous with false or nil value
+        end
+    end
   end
 end

data/lib/config_module/config_option.rb

@@ -14,6 +14,7 @@ module ConfigModule
 
     def each_pair
       return to_enum(__method__) { @table.size } unless block_given?
+
       @table.each_pair { |pair| yield pair }
       self
     end
@@ -21,12 +22,14 @@ module ConfigModule
 
     def each_key
       return to_enum(__method__) { @table.size } unless block_given?
+
       @table.each_key { |key| yield key }
       self
     end
 
     def each_value
       return to_enum(__method__) { @table.size } unless block_given?
+
       @table.each_value { |value| yield value }
       self
     end

data/lib/config_module/exceptions.rb

@@ -1,20 +1,17 @@
 # frozen_string_literal: true
 
 module ConfigModule
+  # for when a config setting error occurs
   class ConfigError < NoMethodError
     def initialize name, object, details = nil
       @name, @object, @details = name, object, details
-      @custom_message = "invalid #{identifier} `#{name}' for #{object_info}"
     end
     attr_reader :name, :object, :details
 
-    def custom_message
-      @custom_message + "\n#{super_message}"
+    def message
+      "invalid #{identifier} `#{name}' for #{object_info}"
     end
 
-    alias_method :super_message, :message
-    alias_method :message, :custom_message
-
     def object_info
       if object.is_a?(Class)
         object.name
@@ -27,4 +24,30 @@ module ConfigModule
   class InvalidNamespaceError < ConfigError
     def identifier; :namespace; end
   end
+
+  # for when config_file path isn't found
+  class ConfigFileNotFound < EOFError
+    def initialize config_file
+      @config_file = config_file
+    end
+    attr_reader :config_file
+
+    def message
+      "config_file `#{config_file}` not found."\
+      "Make sure it exists in the location specified."
+    end
+  end
+
+  # for when config_file was not set
+  class ConfigFileNotSpecified < TypeError
+    def initialize config_file
+      @config_file = config_file
+    end
+    attr_reader :config_file
+
+    def message
+      "config_file location is #{config_file.inspect}."\
+      "Set your config's location with the `config_file` method."
+    end
+  end
 end

data/lib/config_module/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConfigModule
-  VERSION = "1.2.3".freeze
+  VERSION = "1.2.4".freeze
 end

data/uspec/config_helper_spec.rb

@@ -12,3 +12,22 @@ spec "method_missing_handler traces back to the caller" do
     error.backtrace.to_s.include?("spec/config_helper_spec.rb:8:in") || error.backtrace
   end
 end
+
+spec "is helpful when the config_file is not set" do
+  begin
+    configless_helper = ConfigModule::ConfigHelper.new
+    configless_helper.load_config
+  rescue ConfigModule::ConfigFileNotSpecified => error
+    error.message.include?("config_file") || error
+  end
+end
+
+spec "is helpful when the config_file is missing" do
+  begin
+    missing_helper = ConfigModule::ConfigHelper.new
+    missing_helper.config_file = "god"
+    missing_helper.load_config
+  rescue ConfigModule::ConfigFileNotFound => error
+    error.message.include?("config_file") || error
+  end
+end

data/uspec/config_module_spec.rb

@@ -103,3 +103,13 @@ spec "incorrect namespaces raise informative errors" do
     true
   end
 end
+
+module EmptyExample
+  extend ConfigModule
+  config_file "./config/empty.yml"
+end
+
+spec "empty config file becomes empty config" do
+  EmptyExample.config.class == ConfigModule::ConfigOption &&
+    EmptyExample.config.each.to_a == []
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_module
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uspec
@@ -24,8 +24,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-description: Wrap a configuration file in a module for easy use throughout your application.
-  Inspired by Rails.
+description: |-
+  ConfigModule loads a YAML file into a module to make it easy to access and maintain your configurations.
+  It provides helpers for namespaces (like environments), hash-like square-bracket access, helpful custom exceptions, and optimized repeat access.
 email:
 - github@anthonymcook.com
 executables: []
@@ -34,13 +35,17 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".codeclimate.yml"
+- ".editorconfig"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.markdown
 - Rakefile
 - config_module.gemspec
@@ -49,6 +54,7 @@ files:
 - lib/config_module/config_option.rb
 - lib/config_module/exceptions.rb
 - lib/config_module/version.rb
+- uspec/config/empty.yml
 - uspec/config/example.yml
 - uspec/config/false_nil.yml
 - uspec/config_helper_spec.rb