info_hub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 391b44bfb0ff261310da84f2b0026f1be9e790cc
+  data.tar.gz: 21d5fec5a67c24320f465405bcb1139fbb77589e
+SHA512:
+  metadata.gz: e3ebb2e5c6efaad9cdab111cdae1504c995aa3aeb156293e6007f82e63fdc5cdfc6a6b2f41175887afc7dd9f04df3cefd115670f68674bf531b887df01892143
+  data.tar.gz: 4ae5f6e4f2db0497a82de5a144904f57afbe76280172d4b65f6d93ba72aab91c9b59e9973602adb24404378e31726de513668325ba98d5d1046939a2f99e9c21

data/README.md

@@ -0,0 +1,54 @@
+[gem]: https://rubygems.org/gems/info_hub
+[travis]: https://travis-ci.org/OnApp/info_hub
+
+# InfoHub
+
+[![Gem Version](https://badge.fury.io/rb/info_hub.svg)][gem]
+[![Build Status](https://travis-ci.org/OnApp/info_hub.svg?branch=master)][travis]
+
+This gem delivers a simple DSL to read data from YAML files which might be useful for storing some basic knowledge around the application.
+
+### Installation
+Add to your `Gemfile`:
+
+```ruby
+# Gemfile
+gem 'info_hub'
+```
+and run `bundle install`
+
+Create a new file which includes all syste-wide constants:
+```ruby
+# config/info_hub.yml
+percentage:
+    min: 1
+    max: 100
+```
+
+Then add add path to that file to `InfoHub` paths (in `config/initializers/info_hub.rb`)
+```ruby
+# config/initializers/info_hub.rb
+InfoHub.info_hub_file_paths << File.expand_path('../info_hub.yml', __dir__)
+
+InfoHub.finalize!
+```
+Before `finalize!` execution, you may add as many `.yml` files as you need. All of them will be deeply merged in the order they were added.
+
+### Usage
+Now anywhere in you code you can:
+```ruby
+InfoHub[:percentage] # => { min: 1, max: 100 }
+# or the equivalent
+InfoHub.fetch(:percentage) # => { min: 1, max: 100 }
+```
+You may also get some internal values:
+```ruby
+# Similar to `dig` in ruby 2.3
+InfoHub.get(:percentage, :min) # => 1
+InfoHub.get(:percentage, :max) # => 100
+```
+### Licence
+See `LICENSE` file.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/OnApp/info_hub.

data/lib/info_hub/version.rb

@@ -0,0 +1,3 @@
+module InfoHub
+  VERSION = '0.0.1'.freeze
+end

data/lib/info_hub.rb

@@ -0,0 +1,55 @@
+require 'active_support/all'
+require 'yaml'
+
+module InfoHub
+  extend self
+
+  attr_accessor :info_hub_file_paths
+
+  KeyNotFoundError = Class.new(StandardError)
+  SettingsNotFinalizedError = Class.new(StandardError)
+  SettingsAlreadyFinalizedError = Class.new(StandardError)
+
+  def info_hub_file_paths
+    @info_hub_file_paths ||= []
+  end
+
+  def fetch(key)
+    settings.fetch(key) { raise_error(key) }
+  end
+  alias_method :[], :fetch
+
+  def use(key)
+    yield fetch(key)
+  end
+
+  def get(*keys)
+    keys.inject(settings) { |settings, key| settings.fetch(key) { raise_error(key) } }
+  end
+
+  def finalize!
+    raise SettingsAlreadyFinalizedError, 'InfoHub configuration is already finalized.' if finalized?
+
+    info_hub_file_paths.freeze
+  end
+
+  def finalized?
+    info_hub_file_paths.frozen?
+  end
+
+  private
+
+  def settings
+    @settings ||= begin
+      raise SettingsNotFinalizedError, 'Settings not finalized' unless finalized?
+
+      info_hub_file_paths.inject({}) do |settings, path|
+        settings.deep_merge!(YAML.load_file(path).deep_symbolize_keys)
+      end
+    end
+  end
+
+  def raise_error(key)
+    raise KeyNotFoundError, "`#{key}` key not found"
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: info_hub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- OnApp devs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      This gem delivers a simple DSL to read data from YAML files.
+      That might be useful for storing some basic knowledge around the application.
+email:
+- onapp@onapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/info_hub.rb
+- lib/info_hub/version.rb
+homepage: https://github.com/OnApp/info_hub
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Handy library to read from YAML files
+test_files: []