host_config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdaf7af07bea5b22be646a2d7c91f6d15cbc199d
+  data.tar.gz: d59f7eeeedc89cf2ec1e685750e971b792d67eb6
+SHA512:
+  metadata.gz: b93f9736232f1805ccac535125f0ce5daac02928cfef931975d0e25fe6281c776bc1bd0feb32ffaf872b0fda155ca281771a6a182955bf7ebddf1a8bec81b73a
+  data.tar.gz: e5d05a7cf4c397e9b12191eb1dfbfdd2fdb4cd28499dadde7d574e1892eb42204736076df3dd7ec157fa8585026e78805dea2d7a505d15661e499a1ad0dff040

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Ryan Funduk
+
+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,72 @@
+# HostConfig
+
+Simple per-host configuration for Rails 4.
+
+
+## Setup/Usage
+
+First add it to your `Gemfile`:
+
+    gem 'host_config'
+
+Then make an initializer (or add it to one you already have, like so):
+
+    AppConfig = HostConfig.init!
+
+That's really it. This will attempt to load `config/hosts/HOSTNAME.yml`
+and assign an OpenStruct to `AppConfig` which you can then use all over
+your app. You can also override the hostname:
+
+    override_hostname = Rails.env.production? ? 'aws' :
+                        Rails.env.staging? ? 'staging' :
+                        nil
+    AppConfig = HostConfig.init! hostname: override_hostname
+
+...or something similar, so that you can share config for production environments.
+This is a good alternative to environment variables. You can handle your configuration
+just like you already handle `database.yml` (eg, by not committing production config
+to the git repo, but adding it to each host out of band).
+
+You can also add more values to it for things that aren't host-specific:
+
+    AppConfig.analytics_id = 'UA-XXXXXXXX-Y'
+    AppConfig.sanitize = Sanitize::Config::RELAXED
+    AppConfig.sanitize[:attributes]['a'] = %w{ target href name }
+    AppConfig.sanitize[:add_attributes] = {
+      'a' => { 'target' => '_blank' }
+    }
+
+...can be quite convenient.
+
+
+## Configuration
+
+Configuration is in YAML files.
+
+    ---
+      force_ssl: true
+      protocol: https
+      application_host: myapp.com
+
+      twitter:
+        consumer: ABC
+        secret: XYZ
+
+      vegetables:
+        - broccoli
+        - carrots
+        - corn
+
+As simple as that. You can also setup common stuff in files prefixed with `_`. Eg,
+`_defaults.yml`, and load either before or after the stuff in the primary config:
+
+    ---
+      load_before:
+        - defaults
+      other_stuff: 'here'
+
+This will look for `_defaults.yml` and deep-merge in the rest. You can also use
+`load_after`, which will of course override values in the primary config... why would
+you ever need this? I don't know :)
+
+See the `test/dummy` app and the tests for the details if it isn't clear.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HostConfig'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/host_config.rb

@@ -0,0 +1,68 @@
+require 'ostruct'
+require 'socket'
+
+module HostConfig
+  VERSION = "0.0.1"
+
+  class MissingConfigFile < StandardError; end
+
+  class << self
+    def init!( opts={} )
+      @logger = opts[:logger] || Rails.logger
+      @hostname = opts[:hostname] || Socket.gethostname.split('.').shift
+      @config = {}
+      @config[:hostname] = opts[:hostname]
+      @logger.debug "Loading host config #{@hostname}"
+      process( load_config( @hostname ) )
+    end
+
+    private
+
+    def load_config( file )
+      begin
+        path = "#{Rails.root}/config/hosts/#{file}.yml"
+        data = File.read(path)
+        YAML.load( data )
+      rescue Errno::ENOENT
+        raise MissingConfigFile.new( "Missing config file '#{path}', could not setup HostConfig!" )
+      end
+    end
+
+    def process( config )
+      load_before = config.delete('load_before')
+      load_after = config.delete('load_after')
+
+      if load_before.is_a? Array
+        load_before.each do |file|
+          @logger.debug "   including... _#{file}"
+          c = load_config( "_#{file}" )
+          process( c )
+        end
+      end
+
+      @config.deep_merge! config
+
+      if load_after.is_a? Array
+        load_after.each do |file|
+          c = load_config( "_#{file}" )
+          process( c )
+        end
+      end
+
+      to_openstruct(@config)
+    end
+
+    def to_openstruct( obj )
+      case obj
+      when Array
+        obj.map { |el| to_openstruct(el) }
+      when Hash
+        ::OpenStruct.new( obj.each_with_object({}) do |(k,v), h|
+                            h[k] = to_openstruct(v)
+                          end )
+      else
+        obj
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: host_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Funduk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: ''
+email:
+- ryan.funduk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/host_config.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/rfunduk/host_config
+licenses: []
+metadata: {}
+post_install_message: 
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Simple per-host configuration for Rails 4.
+test_files: []