tepee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9e0ccf99d106a61407b6f7d076165f60e30f24d
+  data.tar.gz: 217bc76c1c6558b4092f44480f25b90f15159ddc
+SHA512:
+  metadata.gz: fca3087eb54625901d20528e79de769e243753bf4e14ad1d0b5cc80ecbf6c3f4bae4d7f5aeaf82cc1218a36795f4f7d1db33931ad16d3babd9dea9ae87643c43
+  data.tar.gz: 0f1d3eb8de91be2b0668d996f9bba6a4b9cb9aecae692b21004a14ce3955608feedf0b1b04bd70236d2fe2b21badae261efab3f2a8d02a347829aa7318ad06c4

data/.travis.yml

@@ -0,0 +1,6 @@
+before_install:
+    - gem install bundler
+language: ruby
+rvm:
+    - 2.3.0
+script: bundle exec rspec spec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+RUBY VERSION
+   ruby 2.3.0p0
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Appaloosa.io
+
+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.md

@@ -0,0 +1,123 @@
+# Tepee: A configuration helper for the braves
+
+[![Build Status](https://travis-ci.org/appaloosa-store/tepee.svg)](https://travis-ci.org/appaloosa-store/tepee)
+
+## Purpose
+
+This gem aims to make your rails app (or lib, script, ...) by making your environment variables more maintainable by nesting them, allowing you to use your own naming conventions for them.
+
+## Usage
+
+### Setup
+
+Your conf class must inherit from Tepee.
+
+```ruby
+class MyApp::Configuration < Tepee
+  # ...
+end
+```
+
+### Setting a value
+
+```ruby
+class MyApp::Configuration < Tepee
+  add(:my_value, 42)
+  ## Defines the configuration value 'my_value', with 42 as default value.
+  ## If the MY_VALUE environment variable is set, it overrides 42.
+
+  add(:my_value, 13, env_var: 'FOOBAR')
+  ## Defines the configuration value 'my_value', with 13 as default value.
+  ## If the FOOBAR environment variable is set, it overrides 13.
+  ## You can use this for mapping purposes!
+end
+```
+
+### Fetching a value
+
+`MyApp::Configuration.my_value`
+
+### Using sub sections
+
+#### Adding a section
+
+```ruby
+class MyApp::Configuration < Tepee
+  section(:billing) do
+    add :domain,        'my_domain'
+    add :api_key,       'qwerty12345'
+    add :public_key,    'my-public-key'
+    add :webhook_token, '12345azerty'
+  end
+end
+```
+
+Those values could be accessed through: `MyApp::Configuration.billing.domain`.
+That value is either:
+ The content of the environment variable `BILLING_DOMAIN` if it exists, or `'my_domain'` if it does not.
+
+#### Nesting sections
+
+```ruby
+class MyApp::Configuration < Tepee
+  section(:foo) do
+    # Can be overrided by the FOO_VALUE environment variable.
+    # Accessible via MyApp::Configuration.foo.value
+    add :value, "I'm a foo value"
+     section(:bar) do
+      # Can be overrided by the FOO_BAR_VALUE environment variable.
+      # Accessible via Appaloosa::Configuration.foo.bar.value
+      add :value, "I'm a bar value"
+    end
+  end
+end
+```
+
+Now, you are able to retrieve the values of your configuration tokens like follow:
+* `MyApp::Configuration.foo.value      # => "I'm a foo value"`
+* `MyApp::Configuration.foo.bar.value  # => "I'm a bar value"`
+* `MyApp::Configuration.bar.value      # => Undefined method bar for <Configuration #...`
+
+### Overriding values with environment variables
+
+Assuming that your configuration is:
+
+```ruby
+class MyApp::Configuration
+  ...
+  add :top_domain_name, (Rails.env.test? ? 'example.com' : 'lvh.me')
+  section :mobile do
+    add :api_key, 'dvorak98765', env_var: 'GC2M_API_KEY'
+    section :notification do
+      add :user, 'bob@alice.com'
+    end
+  end
+end
+```
+
+If you want to configure (for the heroku application 'my-app') any of those configuration values, please proceed as following:
+
+```ruby
+# MyApp::Configuration.top_domain_name:
+heroku config:set TOP_DOMAIN_NAME='www.alice.bob' -a my-app
+
+# MyApp::Configuration.mobile.api_key:
+heroku config:set MOBILE_API_KEY='bepo13579' -a my-app
+
+# MyApp::Configuration.mobile.notification.user:
+heroku config:set MOBILE_NOTIFICATION_USER='alice@bob.com' -a my-app
+```
+
+But do not use the `env_var` keyword which allows to override the used environment variable name.
+
+## Contributing
+
+1. Fork it ( https://github.com/appaloosa-store/tepee/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Licence
+
+See the included LICENSE file for details.

data/lib/tepee/version.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+class Tepee
+  # This module holds the Tepee version information.
+  module Version
+    STRING = '0.0.1'.freeze
+
+    module_function
+
+    def version(*_args)
+      STRING
+    end
+  end
+end

data/lib/tepee.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'tepee/version'
+
+# Tepee configuration helper for the braves
+class Tepee
+  class << self
+    attr_accessor :env_var_prefix
+
+    protected
+
+    def add(name, default, env_var: "#{env_var_prefix}#{name}")
+      value = ENV[String(env_var).upcase] || default
+      const_set(String(name).upcase, value)
+      define_singleton_method(name) { value }
+      self
+    end
+
+    SEP = '_'.freeze
+    MISSING_BLOCK = 'Missing block'.freeze
+
+    def section(name, &block)
+      raise MISSING_BLOCK unless block_given?
+      new_env_var_prefix = "#{String(name)}#{SEP}"
+      unless env_var_prefix.nil?
+        new_env_var_prefix = "#{env_var_prefix}#{new_env_var_prefix}"
+      end
+      klass = Class.new(self)
+      klass.env_var_prefix = new_env_var_prefix.upcase
+      klass.instance_exec(&block)
+      const_set(String(name).upcase, klass)
+      define_singleton_method(name) { klass }
+    end
+    self
+  end
+end

data/tepee.gemspec

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'tepee/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tepee'
+  s.version = Tepee::Version::STRING
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.3'
+  s.authors = ['Alexandre Ignjatovic', 'Robin Sfez', 'Benoit Tigeot', 'Christophe Valentin']
+  s.description = <<-EOF
+    A ruby configuration helper for the braves.
+
+    Organize your configuration into sections.
+
+    Easily override your configuration value by updating your enviroment variables (heroku friendly).
+
+    Self contained, and with a very light memory footprint.
+  EOF
+
+  s.email = 'alexandre.ignjatovic@gmail.com'
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ %r{^(?:
+    spec/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.rubocop_todo.yml
+    |.*\.eps
+    )$}x
+  end
+  s.test_files = []
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.extra_rdoc_files = ['LICENSE', 'README.md']
+  s.homepage = 'http://github.com/appaloosa-store/tepee'
+  s.licenses = ['MIT']
+  s.require_paths = ['lib']
+  s.rubygems_version = '1.8.23'
+
+  s.summary = 'A ruby configuration helper for the braves'
+
+  s.add_development_dependency('rspec', '~> 3.4')
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: tepee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandre Ignjatovic
+- Robin Sfez
+- Benoit Tigeot
+- Christophe Valentin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: |2
+      A ruby configuration helper for the braves.
+
+      Organize your configuration into sections.
+
+      Easily override your configuration value by updating your enviroment variables (heroku friendly).
+
+      Self contained, and with a very light memory footprint.
+email: alexandre.ignjatovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".travis.yml"
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/tepee.rb
+- lib/tepee/version.rb
+- tepee.gemspec
+homepage: http://github.com/appaloosa-store/tepee
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.5
+signing_key: 
+specification_version: 4
+summary: A ruby configuration helper for the braves
+test_files: []