sting 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddebedec4cecec6db3c92d487c60b6a4b841a5aeb93ad668ef101a12ece92334
-  data.tar.gz: 401bc1ff2e7c00631bca054a957fc28475094c85ec6b368f207ebe1185100855
+  metadata.gz: 1b4cb2c0a668bf879e98ac401f7419678288949857b8ed055daf23a41cc6b7e7
+  data.tar.gz: e3c52cd17082f8cd7ce774aaa404ec1bc87091f09d3d5b5223d8e8fb70377b4c
 SHA512:
-  metadata.gz: 6076bc7d1301e66d30074d06ac3601aabd9461ba71e68362af647e081714305c402cea41b1d88276ec5d6d6e0cd466dfdbd8067ee41e7f5e6bd8a6f7d7ad1e33
-  data.tar.gz: ff0ff3133cae18cedbf06106a66ded80dacabc3ad184f35fe11893d2e5ae994a32093d149c5cc9ec2437fd6e13d1ab7f76ed559f94c17a894d06feed53510dbb
+  metadata.gz: 00dd281cbc65ec4365686ae4137c011397a18f1e12bef0bea99ae46d63a119d9f30063f3601de1ddc294cfe921808df515ad1d58454eba14e027413dc56dd044
+  data.tar.gz: ae1d6134e99010e99d9a06a836b28db0429c23236fcbb1ca614cfa1a06582825af0e728bfba7d28c265a9408b79984392e81f9ddaa12e89bb97f43c1d33cbbf9

data/README.md

@@ -15,9 +15,38 @@ Sting is a minimal, lightweight, multi-YAML settings library.
 Installation
 --------------------------------------------------
 
-    $ gem install sting
+```shell
+$ gem install sting
+```
+
+
+Why was this made?
+--------------------------------------------------
+
+Sting was made to replace the Rails Config gem, which has an unreasonable 
+amount of dependencies (i.e. the dry-validation gem, its children and 
+grandchildren...).
+
+
+Features
+--------------------------------------------------
+
+- [Aggressively minimalistic][1], no dependencies, no monkey-patching, no magic.
+- Settings are accessible through a globally available class.
+- Load and merge one or more YAML files or hashes.
+- Settings objects are standard ruby hashes, arrays and basic types.
+- Ability to update settings at runtime.
+- ERB code in the YAML files will be evaluated.
 
 
+Nonfeatures
+--------------------------------------------------
+
+- No dot notation access to nested values - Use `Settings.server['host']` 
+  instead of `Settings.server.host` - to avoid having to monkey-patch hashes.
+- No special generators for Rails. 
+  [Usage with rails is still trivial](#using-with-rails).
+
 
 Usage
 --------------------------------------------------
@@ -25,21 +54,72 @@ Usage
 ```ruby
 require 'sting'
 
-# If you want to use a different name than Sting
+# If you want to use a different name than Sting (optional)
 Settings = Sting
 
-# Load some YAML files
+# Load some YAML files. If the provided filename does end with '.yml' or 
+# '.yaml', we will add '.yml' to it.
 Settings << 'one'
-Settings << 'two'
+Settings << 'two.yml'
+
+# Merge with another options hash
+Settings << { port: 3000, host: 'localhost' }
 
 # Access values
-p Settings.hello
-p Settings['hello']
-p Settings[:hello]
+p Settings.host
+p Settings['host']
+p Settings[:host]
+
+# Access nested values
+p Settings.server['host']
 
 # Access all values
-p Settings.all
+p Settings.settings
 
 # Check if a key is defined
 p Settings.has_key? :hello
+
+# Access value, but raise an exception if it does not exist
+p Settings.host!
+
+# Access boolean values, or check if a key exists
+p Settings.host?
+
+# Update a value (in memory only, not in file)
+Settings.port = 3000
+
+# Reset (erase) all values
+Settings.reset!
 ```
+
+
+Using with Rails
+--------------------------------------------------
+
+You can use this however you wish in Rails. This is the recommended 
+implementation:
+
+Add sting to your Gemfile:
+
+```ruby
+gem 'sting'
+```
+
+Create an initializer:
+
+```ruby
+# config/initializers/settings.rb
+Settings = Sting
+Settings << "#{Rails.root}/config/settings"
+Settings << "#{Rails.root}/config/settings/#{Rails.env}"
+```
+
+Create four config files:
+
+- config/**settings**.yml
+- config/settings/**development**.yml
+- config/settings/**production**.yml
+- config/settings/**test**.yml
+
+
+[1]: https://github.com/DannyBen/sting/blob/master/lib/sting.rb

data/lib/sting.rb

@@ -3,10 +3,14 @@ require 'erb'
 
 class Sting
   class << self
-    def <<(path)
-      path = "#{path}.yml" unless path =~ /\.ya?ml$/
-      content = File.read path
-      content = YAML.load(ERB.new(content).result)
+    def <<(source)
+      if source.is_a? Hash
+        content = source.collect{ |k,v| [k.to_s, v] }.to_h
+      else
+        source = "#{source}.yml" unless source =~ /\.ya?ml$/
+        content = File.read source
+        content = YAML.load(ERB.new(content).result)
+      end
       settings.merge! content if content
     end
 

data/lib/sting/version.rb

@@ -1,3 +1,3 @@
 class Sting
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug