sm_app_config 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dca19cd9859e9a5e67c278060c8dc663b1bf6b3b
+  data.tar.gz: 3f9fedd786e4ddb981619ea3dfe1e23d73f8bd89
+SHA512:
+  metadata.gz: fcee7f4e9079a81f7c534eaf0395f5ee77dfec3a47c0e6ce1450cd844a85cf8339bdca68abfbff3e379bf55274efc83a9b25db353ff97557e455c0ac809e87fb
+  data.tar.gz: fe5266fd5d9fcef88297db06ebc7808f12f657bd1809a0cc78015429dcb8647ac30da1f0526c3ca44fc54caa5a575271f327abc60c3aa9c7524cf994e2bfaa70

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sm_app_config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jack Whitis
+
+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,73 @@
+# SmAppConfig
+
+SmAppConfig (Southern Made App Config) is a framework agnostic library for storing and retrieving configuration settings using a YAML file or ENV variables. SmAppConfig will look first for an ENV variable with the specified name, then fall back to the YAML file if one is not found. Configuration files are excluded from source control by default. See below for usage instructions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sm_app_config'
+```
+
+And then run:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sm_app_config
+
+Run the generator to create configuration files:
+
+    $ app_config install
+
+Or with --no-rails if your app does not use Rails:
+
+    $ app_congfig install --no-rails
+
+This will do the following:
+
+- Create a configuration file at `config/app_config.yml`
+- Create an example configuration file at `config/app_config.example.yml`
+- Add `config/app_config.yml` to your `.gitignore` file
+
+## Usage
+
+To add configuration settings, simply add key/value pairs to `app_config.yml`, which is located in `config/` by default. If you are using Rails, you should place them under each applicable environment namespace. You should also add the keys with placeholder values to `app_config.example.yml`. This file should be checked into source control so that other developers know what keys need to be present in `app_config.yml`.
+
+You also have the option to store your configuration settings in ENV variables. This would be the desired approach if you were deploying to Heroku. Regardless of how your settings are stored, they can be accessed in this way:
+
+```ruby
+AppConfig['my-setting']
+```
+
+If an ENV variable named MY-SETTING is not found, SmAppConfig will look in `app_config.yml` for a key named my-setting. If you are using Rails, it will look for the key under the appropriate environment namespace. An error will be raised if the setting is not found or if `app_config.yml` does not exist.
+
+If you change `app_config.yml`, be sure to run:
+
+```ruby
+AppConfig.reload!
+```
+
+You can customize the name and location of your configuration file:
+
+```ruby
+SmAppConfig.configure(path: "custom/app_config.yml")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sm_app_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sm_app_config"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/app_config.yml

@@ -0,0 +1,4 @@
+sample_basic_setting: my-setting
+very_false: false
+test:
+  rails_setting: true

data/exe/app_config

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require_relative "../lib/generators/sm_app_config/install_generator"
+
+SmAppConfig::InstallGenerator.start

data/lib/generators/sm_app_config/install_generator.rb

@@ -0,0 +1,42 @@
+module SmAppConfig
+  class InstallGenerator < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path("../../templates", __FILE__)
+    end
+
+    desc "install", "Copies configuration files to config/"
+    method_options rails: true, desc: "Add Rails environments to configuration files"
+    def install
+      copy_app_config
+      copy_app_config_example
+      add_app_config_to_gitignore
+    end
+
+    desc "copy_app_config", "Copies app_config.yml to config/"
+    def copy_app_config
+      copy_file config_template, "config/app_config.yml"
+      say "Copied app_config.yml to config/"
+    end
+
+    desc "copy_app_config_example", "Copies app_config.example.yml to config/"
+    def copy_app_config_example
+      copy_file config_template, "config/app_config.example.yml"
+      say "Copied app_config.example.yml to config/"
+    end
+
+    desc "add_app_config_to_gitignore", "Adds app_config.yml to .gitignore"
+    def add_app_config_to_gitignore
+      append_to_file ".gitignore", "\n/config/app_config.yml"
+      say "Added /config/app_config.yml to .gitignore"
+    end
+
+    private
+
+    def config_template
+      @template ||= options[:rails] ? "rails_app_config.yml" : "app_config.yml"
+    end
+
+  end
+end

data/lib/generators/templates/app_config.yml

@@ -0,0 +1 @@
+foo: bar

data/lib/generators/templates/rails_app_config.yml

@@ -0,0 +1,6 @@
+development:
+  foo: "bar"
+production:
+  foo: "bar"
+test:
+  foo: "bar"

data/lib/sm_app_config/app_config.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+class AppConfig
+
+  def self.[] key
+    result = ENV[key.upcase]
+    return YAML.load(result) unless result.nil?
+
+    result = config[key]
+    return result unless result.nil?
+
+    raise ArgumentError.new("No ENV['#{key.upcase}'] or AppConfig['#{key}'] setting found")
+  end
+
+  def self.reload!
+    @config = nil
+  end
+
+  private
+
+  def self.config
+    @config ||= begin
+      raw_config = File.read(config_file)
+      loaded = YAML.load(raw_config)
+
+      if defined?(Rails)
+        loaded[Rails.env] or raise "No configuration found for environment #{Rails.env}"
+      else
+        loaded
+      end
+    rescue SystemCallError
+      raise "No configuration file found at #{config_file}"
+    end
+  end
+
+  def self.config_file
+    SmAppConfig::CONFIG.fetch(:path)
+  end
+
+end

data/lib/sm_app_config/configuration.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+
+module SmAppConfig
+  class Configuration
+    extend Forwardable
+    def_delegators :@hash, :to_hash, :[], :[]=, :==, :fetch, :delete
+
+    DEFAULTS = {
+      path: "config/app_config.yml"
+    }
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @hash = DEFAULTS.dup
+    end
+
+    def merge! configuration_hash
+      @hash.merge!(configuration_hash)
+    end
+
+  end
+end

data/lib/sm_app_config/version.rb

@@ -0,0 +1,3 @@
+module SmAppConfig
+  VERSION = "0.2.2"
+end

data/lib/sm_app_config.rb

@@ -0,0 +1,18 @@
+require "sm_app_config/version"
+require "sm_app_config/configuration"
+require "sm_app_config/app_config"
+
+module SmAppConfig
+  extend self
+
+  CONFIG = Configuration.new
+
+  def configure configuration_options = {}
+    CONFIG.merge!(configuration_options)
+  end
+
+  def clear!
+    CONFIG.clear
+  end
+
+end

data/sm_app_config.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sm_app_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sm_app_config"
+  spec.version       = SmAppConfig::VERSION
+  spec.authors       = ["Jack Whitis", "Matt Mueller"]
+  spec.email         = ["jack@southernmade.co"]
+
+  spec.summary       = %q{Application configuration for multiple environments.}
+  spec.description   = %q{Library for managing application configuration using a YAML file or ENV variables.}
+  spec.homepage      = "https://github.com/SouthernMade/sm_app_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.post_install_message = "Run `app_config install` to complete installation."
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "thor"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: sm_app_config
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Jack Whitis
+- Matt Mueller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for managing application configuration using a YAML file or ENV
+  variables.
+email:
+- jack@southernmade.co
+executables:
+- app_config
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/app_config.yml
+- exe/app_config
+- lib/generators/sm_app_config/install_generator.rb
+- lib/generators/templates/app_config.yml
+- lib/generators/templates/rails_app_config.yml
+- lib/sm_app_config.rb
+- lib/sm_app_config/app_config.rb
+- lib/sm_app_config/configuration.rb
+- lib/sm_app_config/version.rb
+- sm_app_config.gemspec
+homepage: https://github.com/SouthernMade/sm_app_config
+licenses:
+- MIT
+metadata: {}
+post_install_message: Run `app_config install` to complete installation.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Application configuration for multiple environments.
+test_files: []