better_settings 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 838170a01ea177f40b02a01a7e7308c6b1cf6528
-  data.tar.gz: 94ddb23c277b6ae2ba9c9eb12cfab77635163d87
+SHA256:
+  metadata.gz: 34fa70db51a53b69111e00f5a879b0b88a77bf1b8bf8f407d2e6c892396867fb
+  data.tar.gz: bb872caccae378615c55100c464f4eb2ddf15cd732dc7a230cb703ccb743d6c6
 SHA512:
-  metadata.gz: 0241b28bfe8bdc7d143c21dbf7526b88142bae2e958c4a9c85a8369ff14c390383a3db14abff98122fc7e2593384d2b0ca3b52fc6a3471700476f9eba173c161
-  data.tar.gz: 254487a597d7e78ca6569d2df82634c48551dfa2715a49533d29bfcd11ade1472df41eebf5cc5d7661fa3a1ba5dfd6610759e21663dc3b8da2ffa03e3aa68f41
+  metadata.gz: cd721daa3d8b187d4ddf15b7757e8376c92c09289dea815d3b47234d7da0fceec3acb3a55f15df1d616de3c4b637d386388499e0882e4f07c59ab1d2aff31b42
+  data.tar.gz: e3a8e901ae7f28b40a6c60b16266e7e4da2a32262ea88f3b9238826d0d01b8a29a058e3db713a53dd343be14853503a8d9b2c898a8aa2fe3d8bdca09484b027e

data/README.md

@@ -1,9 +1,38 @@
-BetterSettings [![Gem Version](https://img.shields.io/gem/v/better_settings.svg?colorB=e9573f)](https://rubygems.org/gems/better_settings) [![Build Status](https://travis-ci.org/ElMassimo/better_settings.svg)](https://travis-ci.org/ElMassimo/better_settings) [![Coverage Status](https://coveralls.io/repos/github/ElMassimo/better_settings/badge.svg?branch=master)](https://coveralls.io/github/ElMassimo/better_settings?branch=master) [![Inline docs](http://inch-ci.org/github/ElMassimo/better_settings.svg)](http://inch-ci.org/github/ElMassimo/better_settings) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/better_settings/blob/master/LICENSE.txt)
-=======================================
-
-A robust settings library that can read YML files and provide an immutable object allowing to access settings through method calls. Can be used in __any Ruby app__, __not just Rails__.
-
-### Installation
+<h1 align="center">
+Better Settings
+<p align="center">
+  <a href="https://github.com/ElMassimo/better_settings/actions">
+    <img alt="Build Status" src="https://github.com/ElMassimo/better_settings/workflows/build/badge.svg"/>
+  </a>
+  <a href="https://codeclimate.com/github/ElMassimo/better_settings">
+    <img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/better_settings/badges/gpa.svg"/>
+  </a>
+  <a href="https://codeclimate.com/github/ElMassimo/better_settings">
+    <img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/better_settings/badges/coverage.svg"/>
+  </a>
+  <a href="https://rubygems.org/gems/better_settings">
+    <img alt="Gem Version" src="https://img.shields.io/gem/v/better_settings.svg?colorB=e9573f"/>
+  </a>
+  <a href="https://github.com/ElMassimo/better_settings/blob/master/LICENSE.txt">
+    <img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/>
+  </a>
+</p>
+</h1>
+
+A robust settings library for Ruby. Access your settings by calling methods on a safe immutable object.
+
+## Features ⚡️
+
+- 🚀 __Light and Performant:__ settings are eagerly loaded, no `method_missing` tricks, no dependencies.
+- 💬 __Useful Error Messages:__ when trying to access a setting that does not exist.
+- 💎 __Immutability:__ once created settings can't be modified.
+- 🗂 __Multiple Files:__ useful to create multiple environment-specific source files.
+- ❕ __No Optional Setings:__ since it encourages unsafe access patterns.
+
+You can read more about it in [the blog announcement](https://maximomussini.com/posts/better-settings/).
+
+
+## Installation 💿
 
 Add this line to your application's Gemfile:
 
@@ -19,12 +48,11 @@ Or install it yourself as:
 
     $ gem install better_settings
 
-### Usage
+## Usage 🚀
 
-#### 1. Define a class
+### 1. Define a class
 
-Instead of defining a Settings constant for you, that task is left to you. Simply create a class in your application
-that looks like:
+Create a class in your application that extends `BetterSettings`:
 
 ```ruby
 # app/models/settings.rb
@@ -33,12 +61,16 @@ class Settings < BetterSettings
 end
 ```
 
-#### 2. Create your settings
+We use `Rails.root` in this example to obtain an absolute path to a plain YML file,
+but when using other Ruby frameworks you can use `File.expand_path` with `__dir__` instead.
+
+Also, we specified a `namespace` with the current environment. You can provide
+any value that corresponds to a key in the YAML file that you want to use.
+This allows to target different environments with the same file.
 
-Notice above we specified an absolute path to our settings file called `application.yml`. This is just a typical YAML file.
-Also notice above that we specified a namespace for our environment. A namespace is just an optional string that corresponds to a key in the YAML file.
+### 2. Create your settings
 
-Using a namespace allows us to change our configuration depending on our environment:
+Now, create a YAML file that contains all the possible namespaces:
 
 ```yaml
 # config/application.yml
@@ -59,43 +91,56 @@ production:
   <<: *defaults
 ```
 
-#### 3. Access your settings
+The `defaults` group in this example won't be used directly, we are using YAML's
+syntax to reuse those values when we use `<<: *defaults`, allowing us to share
+these values across environments.
 
-  >> Rails.env
-  => "development"
+### 3. Access your settings
 
-  >> Settings.mailer
-  => "#<Settings ... >"
+You can use these settings anywhere, for example in a model:
 
-  >> Settings.mailer.root
-  => "www.example.com
+```ruby
+class Post < ActiveRecord::Base
+  self.per_page = Settings.pagination.posts_per_page
+end
+```
 
-  >> Settings.port
-  => 3000
+or in the console:
 
-  >> Settings.dynamic
-  => "Did you know you can use ERB inside the YML file? Env is development."
+```
+>> Rails.env
+=> "development"
 
-You can use these settings anywhere, for example in a model:
+>> Settings.mailer
+=> "#<Settings ... >"
 
-  class Post < ActiveRecord::Base
-    self.per_page = Settings.pagination.posts_per_page
-  end
+>> Settings.mailer.root
+=> "www.example.com
 
-### Advanced Setup ⚙
-Name it `Settings`, name it `Config`, name it whatever you want. Add as many or as few as you like, read from as many files as necessary (nested keys will be merged).
+>> Settings.port
+=> 3000
 
-We usually read a few optional files for the `development` and `test` environment, which allows each developer to override some settings in their own local environment (we git ignore `development.yml` and `test.yml`).
+>> Settings.dynamic
+=> "Did you know you can use ERB inside the YML file? Env is development."
+```
+
+## Advanced Setup ⚙
+
+You can create as many setting classes as you need, and name them in different ways, and read from as many files as necessary (nested keys will be merged).
+
+The way I like to use it, is by reading a few optional files for the _development_ and _test_ environments, which allows each developer to override some settings in their own local environment (and git ignoring `development.yml` and `test.yml`).
 
 ```ruby
 # app/models/settings.rb
 class Settings < BetterSettings
-  source Rails.root.join('config', 'application.yml'), namespace: Rails.env
-  source Rails.root.join('config', 'development.yml'), namespace: Rails.env, optional: true if Rails.env.development?
-  source Rails.root.join('config', 'test.yml'), namespace: Rails.env, optional: true if Rails.env.test?
+  source Rails.root.join('config/application.yml'), namespace: Rails.env
+  source Rails.root.join('config/development.yml'), namespace: Rails.env, optional: true if Rails.env.development?
+  source Rails.root.join('config/test.yml'), namespace: Rails.env, optional: true if Rails.env.test?
 end
 ```
-Our `application.yml` looks like this:
+
+Then `application.yml` looks like this:
+
 ```yaml
 # application.yml
 defaults: &defaults
@@ -123,15 +168,12 @@ production:
   <<: *server_defaults
   host: 'example.com'
 ```
+
 A developer might want to override some settings by defining a `development.yml` such as:
+
 ```yaml
 development:
   auto_logout: true
 ````
-The main advantage is that those changes won't be tracked by source control :smiley:
 
-## Opinionated Design
-After using [settingslogic](https://github.com/settingslogic/settingslogic) for a long time, we learned some lessons, which are distilled in the following decisions:
-- __Immutability:__ Once created settings can't be modified.
-- __No Optional Setings:__ Any optional setting can be modeled in a safer way, this library doesn't allow them.
-- __Not Tied to a Source File:__ Useful to create multiple environment-specific files.
+The main advantage is that those changes won't be tracked in source control :smiley:

data/lib/better_settings.rb

@@ -17,6 +17,7 @@ class BetterSettings
   ]
 
   attr_reader :settings
+
   def_delegators :settings, :to_h, :to_hash
 
   # Public: Initializes a new settings object from a Hash or compatible object.
@@ -34,7 +35,6 @@ class BetterSettings
   end
 
   # Internal: Display explicit errors for typos and missing settings.
-  # rubocop:disable Style/MethodMissing
   def method_missing(name, *)
     raise MissingSetting, "Missing setting '#{ name }' in #{ @parent }"
   end
@@ -53,13 +53,14 @@ private
   # Internal: Defines a getter for the specified setting.
   def create_accessor(key, value)
     raise InvalidSettingKey if !key.is_a?(String) || key !~ VALID_SETTING_NAME || RESERVED_METHODS.include?(key)
+
     instance_variable_set("@#{ key }", auto_wrap(key, value))
     singleton_class.send(:attr_reader, key)
   end
 
   # Internal: Recursively merges two hashes (in case ActiveSupport is not available).
   def deep_merge(this_hash, other_hash)
-    this_hash.merge(other_hash) do |key, this_val, other_val|
+    this_hash.merge(other_hash) do |_key, this_val, other_val|
       if this_val.is_a?(Hash) && other_val.is_a?(Hash)
         deep_merge(this_val, other_val)
       else
@@ -69,6 +70,7 @@ private
   end
 
   class MissingSetting < StandardError; end
+
   class InvalidSettingKey < StandardError; end
 
   class << self
@@ -98,12 +100,14 @@ private
     # Internal: Methods called at the class level are delegated to this instance.
     def root_settings
       raise ArgumentError, '`source` must be specified for the settings' unless defined?(@root_settings)
+
       @root_settings
     end
 
     # Internal: Parses a yml file that can optionally use ERB templating.
     def yaml_to_hash(file_name)
-      return {} if (content = open(file_name).read).empty?
+      return {} if (content = File.open(file_name).read).empty?
+
       YAML.load(ERB.new(content).result).to_hash
     end
   end

data/lib/better_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class BetterSettings
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/better_settings/better_settings_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'support/settings'
 
@@ -6,47 +8,47 @@ describe BetterSettings do
     Settings.new(value, parent: 'new_settings')
   end
 
-  it 'should access settings' do
+  it 'accesses settings' do
     expect(Settings.setting2).to eq 5
   end
 
-  it 'should access nested settings' do
+  it 'accesses nested settings' do
     expect(Settings.setting1.setting1_child).to eq 'saweet'
   end
 
-  it 'should access settings in nested arrays' do
+  it 'accesses settings in nested arrays' do
     expect(Settings.array.first.name).to eq 'first'
   end
 
-  it 'should access deep nested settings' do
+  it 'accesses deep nested settings' do
     expect(Settings.setting1.deep.another).to eq 'my value'
   end
 
-  it 'should access extra deep nested settings' do
+  it 'accesses extra deep nested settings' do
     expect(Settings.setting1.deep.child.value).to eq 2
   end
 
-  it 'should enable erb' do
+  it 'enables erb' do
     expect(Settings.setting3).to eq 25
   end
 
-  it 'should namespace settings' do
+  it 'namespaces settings' do
     expect(DevSettings.language.haskell.paradigm).to eq 'functional'
     expect(DevSettings.language.smalltalk.paradigm).to eq 'object-oriented'
     expect(DevSettings.environment).to eq 'development'
   end
 
-  it 'should distinguish nested keys' do
+  it 'distinguishes nested keys' do
     expect(Settings.language.haskell.paradigm).to eq 'functional'
     expect(Settings.language.smalltalk.paradigm).to eq 'object oriented'
   end
 
-  it 'should not override global methods' do
+  it 'does not override global methods' do
     expect(Settings.global).to eq 'GLOBAL'
     expect(Settings.custom).to eq 'CUSTOM'
   end
 
-  it 'should raise a helpful error message' do
+  it 'raises a helpful error message' do
     expect {
       Settings.missing
     }.to raise_error(BetterSettings::MissingSetting, /Missing setting 'missing' in/)
@@ -55,56 +57,56 @@ describe BetterSettings do
     }.to raise_error(BetterSettings::MissingSetting, /Missing setting 'missing' in 'language' section/)
   end
 
-  it 'should raise an error on a nil source argument' do
+  it 'raises an error on a nil source argument' do
     expect { NoSource.foo.bar }.to raise_error(ArgumentError, '`source` must be specified for the settings')
   end
 
-  it 'should support instance usage as well' do
+  it 'supports instance usage as well' do
     expect(new_settings(Settings.setting1).setting1_child).to eq 'saweet'
   end
 
-  it 'should handle invalid name settings' do
+  it 'handles invalid name settings' do
     expect {
       new_settings('some-dash-setting#' => 'dashtastic')
     }.to raise_error(BetterSettings::InvalidSettingKey)
   end
 
-  it 'should handle settings with nil value' do
+  it 'handles settings with nil value' do
     expect(Settings.nil).to eq nil
   end
 
-  it 'should handle settings with false value' do
+  it 'handles settings with false value' do
     expect(Settings.false).to eq false
   end
 
   # If .name is called on BetterSettings itself, handle appropriately
   # by delegating to Hash
-  it 'should have the parent class always respond with Module.name' do
-    expect(BetterSettings.name).to eq 'BetterSettings'
+  it 'has the parent class always respond with Module.name' do
+    expect(described_class.name).to eq 'BetterSettings'
   end
 
   # If .name is not a property, delegate to superclass
-  it 'should respond with Module.name' do
+  it 'responds with Module.name' do
     expect(DevSettings.name).to eq 'DevSettings'
   end
 
   # If .name is a property, respond with that instead of delegating to superclass
-  it 'should allow a name setting to be overriden' do
+  it 'allows a name setting to be overriden' do
     expect(Settings.name).to eq 'test'
   end
 
   describe 'to_h' do
-    it 'should handle empty file' do
+    it 'handles empty file' do
       expect(NoSettings.to_h).to be_empty
     end
 
-    it 'should be similar to the internal representation' do
+    it 'is similar to the internal representation' do
       expect(settings = Settings.send(:root_settings)).to be_is_a(Settings)
       expect(hash = settings.send(:settings)).to be_is_a(Hash)
       expect(Settings.to_h).to eq hash
     end
 
-    it 'should not mutate the original when getting a copy' do
+    it 'does not mutate the original when getting a copy' do
       result = Settings.language.to_h.merge('haskell' => 'awesome')
       expect(result.class).to eq Hash
       expect(result).to eq(
@@ -117,7 +119,7 @@ describe BetterSettings do
   end
 
   describe '#to_hash' do
-    it 'should return a new instance of a Hash object' do
+    it 'returns a new instance of a Hash object' do
       expect(Settings.to_hash).to be_kind_of(Hash)
       expect(Settings.to_hash.class.name).to eq 'Hash'
       expect(Settings.to_hash.object_id).not_to eq Settings.object_id

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-require 'coveralls'
 SimpleCov.start { add_filter '/spec/' }
-Coveralls.wear!
 
 require 'better_settings'
 require 'rspec/given'
-require 'pry-byebug'
+require 'pry-byebug' if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')

data/spec/support/settings.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class Settings < BetterSettings
   source "#{ File.dirname(__FILE__) }/settings.yml"
-  source "#{File.dirname(__FILE__)}/settings_empty.yml"
+  source "#{ File.dirname(__FILE__) }/settings_empty.yml"
 
   def self.custom
     'CUSTOM'
@@ -17,8 +19,8 @@ class DevSettings < BetterSettings
 end
 
 class NoSettings < BetterSettings
-  source "#{File.dirname(__FILE__)}/settings_empty.yml", optional: true
-  source "#{File.dirname(__FILE__)}/settings_none.yml", optional: true
+  source "#{ File.dirname(__FILE__) }/settings_empty.yml", optional: true
+  source "#{ File.dirname(__FILE__) }/settings_none.yml", optional: true
 end
 
 class NoSource < BetterSettings

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: better_settings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Máximo Mussini
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-given
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: Settings solution for Rails applications that can read YAML files (ERB-enabled)
-  and allows to access using method calls.
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Settings solution for Ruby or Rails applications that can read ERB-enabled
+  YAML files. Safe, performant, with friendly error messages, and no dependencies.
 email:
 - maximomussini@gmail.com
 executables: []
@@ -85,26 +113,25 @@ homepage: https://github.com/ElMassimo/better_settings
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: 'Settings for Rails applications: simple, immutable, better.'
+summary: 'Settings for Ruby applications: fast, immutable, better.'
 test_files:
 - spec/better_settings/better_settings_spec.rb
 - spec/spec_helper.rb