sting 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddebedec4cecec6db3c92d487c60b6a4b841a5aeb93ad668ef101a12ece92334
-  data.tar.gz: 401bc1ff2e7c00631bca054a957fc28475094c85ec6b368f207ebe1185100855
+  metadata.gz: 91a794768cc4e13515dd2cc4867a7f29a4a346c415625b8498378977023cfeea
+  data.tar.gz: 7cd20416e9154d42e1d5e53b2fe5aa8a872bd586cf2ade1b51c7ac3f9c3d3899
 SHA512:
-  metadata.gz: 6076bc7d1301e66d30074d06ac3601aabd9461ba71e68362af647e081714305c402cea41b1d88276ec5d6d6e0cd466dfdbd8067ee41e7f5e6bd8a6f7d7ad1e33
-  data.tar.gz: ff0ff3133cae18cedbf06106a66ded80dacabc3ad184f35fe11893d2e5ae994a32093d149c5cc9ec2437fd6e13d1ab7f76ed559f94c17a894d06feed53510dbb
+  metadata.gz: 3a9b1e2ec851db2d9bcbcbd75b0cb009a5d6160ee6627d91ad7dcaee9f2df73f1de48f1ef2067894a3d735e746e8a2058662040475da5ce8df476f4dfdbecf43
+  data.tar.gz: 1179d98777ef5f5ef6a8d9657698be963bd47b20ab8f7ab6a4d992c25aa77d4e21d487b5980a51bb5a9bc872506b6dfb63b0d6d873508b76d0bfa77ae8f0521d

data/README.md

@@ -2,9 +2,8 @@ Sting - Minimal Settings Library
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/sting.svg)](https://badge.fury.io/rb/sting)
-[![Build Status](https://travis-ci.com/DannyBen/sting.svg?branch=master)](https://travis-ci.com/DannyBen/sting)
+[![Build Status](https://github.com/DannyBen/sting/workflows/Test/badge.svg)](https://github.com/DannyBen/sting/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c8afe395a8f2cf290fec/maintainability)](https://codeclimate.com/github/DannyBen/sting/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/c8afe395a8f2cf290fec/test_coverage)](https://codeclimate.com/github/DannyBen/sting/test_coverage)
 
 ---
 
@@ -15,31 +14,150 @@ Sting is a minimal, lightweight, multi-YAML settings library.
 Installation
 --------------------------------------------------
 
-    $ gem install sting
+```shell
+$ gem install sting
+```
+
+
+Features
+--------------------------------------------------
 
+- [Aggressively minimalistic][1].
+- Settings are accessible through a globally available class.
+- Can be used either as a singleton class or as an instance.
+- 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.
+- [Ability to extend](#extending-yaml-files) (import) other YAML files.
+- 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`.
+- No special generators for Rails. 
+  [Usage with rails is still trivial](#using-with-rails).
 
 
 Usage
 --------------------------------------------------
 
+### Using as a singleton class
+
 ```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 not end with '.yml' or 
+# '.yaml', we will add '.yml' to it.
+Settings << 'one'
+Settings << 'two.yml'
+
+# Adding additional files can also be done with `#push`. These two are the 
+# same.
 Settings << 'one'
-Settings << 'two'
+Settings.push 'one'
+
+# 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
+# Access nested values safely (get nil if any of the keys does not exist)
+p Settings[:server, :host]
+p Settings[:server, :production, :host]
+
+# Get the hash of all values
+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 as an instance
+
+All the above operations are also available to instances of `Sting`.
+
+```ruby
+require 'sting'
+
+# Create an instance.
+config = Sting.new
+
+# Or, create an instance, and provide the first source file to it.
+config = Sting.new 'settings'
+
+# Load additional YAML files. 
+config << 'local_settings'
 ```
+
+
+### Extending YAML files
+
+Sting uses [ExtendedYAML], which means you can use the `extends` key to load
+one ormore YAML files into your loaded configuration files:
+
+```yaml
+# Extend a single file (extension is optional)
+extends: some-other-file.yml
+
+# Extend multiple files
+extends:
+- some-file
+- another-file
+```
+
+
+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/sting_operations.rb
+[2]: https://github.com/DannyBen/extended_yaml

data/lib/sting.rb

@@ -1,61 +1,11 @@
 require 'yaml'
 require 'erb'
+require 'sting/sting_operations'
 
 class Sting
-  class << self
-    def <<(path)
-      path = "#{path}.yml" unless path =~ /\.ya?ml$/
-      content = File.read path
-      content = YAML.load(ERB.new(content).result)
-      settings.merge! content if content
-    end
-
-    def [](key)
-      settings[key.to_s]
-    end
-
-    def method_missing(name, *args, &blk)
-      name = name.to_s
-      return settings[name] if has_key? name
-
-      suffix = nil
-
-      if name.end_with? *['=', '!', '?']
-        suffix = name[-1]
-        name = name[0..-2]
-      end
-
-      case suffix
-      when "="
-        settings[name] = args.first
-
-      when "?"
-        !!settings[name]
+  include StingOperations
 
-      when "!"
-        if has_key? name
-          return settings[name]
-        else
-          raise ArgumentError, "Key '#{name}' does not exist"
-        end
-
-      else
-        nil
-
-      end
-
-    end
-
-    def settings
-      @settings ||= {}
-    end
-
-    def reset!
-      @settings = nil
-    end
-
-    def has_key?(key)
-      settings.has_key? key.to_s
-    end
+  class << self
+    include StingOperations
   end
 end

data/lib/sting/sting_operations.rb

@@ -0,0 +1,77 @@
+require 'extended_yaml'
+
+class Sting
+  module StingOperations
+    def initialize(source = nil)
+      self << source if source
+    end
+
+    def <<(source)
+      if source.is_a? Hash
+        content = source.collect{ |k,v| [k.to_s, v] }.to_h
+
+      elsif source.include? '*'
+        Dir["#{source}"].each { |file| push file }
+
+      elsif File.directory? source
+        Dir["#{source}/*.yml"].each { |file| push file }
+
+      else
+        source = "#{source}.yml" unless source =~ /\.ya?ml$/
+        content = ExtendedYAML.load source
+      end
+
+      settings.merge! content if content
+    end
+    alias_method :push, :<<
+
+    def [](*keys)
+      settings.dig(*keys.map(&:to_s))
+    end
+
+    def method_missing(name, *args, &blk)
+      name = name.to_s
+      return settings[name] if has_key? name
+
+      suffix = nil
+
+      if name.end_with?('=', '!', '?')
+        suffix = name[-1]
+        name = name[0..-2]
+      end
+
+      case suffix
+      when "="
+        settings[name] = args.first
+
+      when "?"
+        !!settings[name]
+
+      when "!"
+        if has_key? name
+          return settings[name]
+        else
+          raise ArgumentError, "Key '#{name}' does not exist"
+        end
+
+      else
+        nil
+
+      end
+
+    end
+
+    def settings
+      @settings ||= {}
+    end
+    alias to_h settings
+
+    def reset!
+      @settings = nil
+    end
+
+    def has_key?(key)
+      settings.has_key? key.to_s
+    end
+  end
+end

data/lib/sting/version.rb

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

metadata

@@ -1,99 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: extended_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rspec_fixtures
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.2'
 description: Minimal, lightweight, multi-YAML settings
 email: db@dannyben.com
 executables: []
@@ -102,6 +32,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/sting.rb
+- lib/sting/sting_operations.rb
 - lib/sting/version.rb
 homepage: https://github.com/dannyben/sting
 licenses:
@@ -122,8 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Minimal, lightweight, multi-YAML settings