configuration_manager 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bruz Marzolf
+
+MIT License
+
+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,41 @@
+Configuration Manager
+=====================
+
+Rails development configuration management and theme switching. This is specific
+to how application configuration and theme handling are done at CX, and hasn't
+been made more generally useful yet.
+
+Install
+-------
+
+Add to your Gemfile:
+
+     gem "configuration_manager"
+
+In your ApplicationController:
+
+    include ConfigurationManager
+
+    if Rails.env.development? || Rails.env.test?
+      before_filter :reload_config
+      before_filter :check_configuration_freshness
+    end
+
+If there are configurations that should be ignored, add them in config/initializers/configuration_manager.rb:
+
+    ConfigurationManager.configure do |config|
+      config.ignored_configs = [:key_to_ignore, :another_one]
+    end
+
+Add default theme configurations as config/application.{theme name}.dev.yml. All of these will require updates whenever new developement configurations are added.
+
+Usage
+-----
+
+Update to the latest config for the current theme:
+
+    rake config:update
+
+Switch themes:
+
+    rake config:switch THEME={theme name}

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/configuration_manager.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configuration_manager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "configuration_manager"
+  spec.version       = ConfigurationManager::VERSION
+  spec.authors       = ["Bruz Marzolf"]
+  spec.email         = ["bruz@cx.com"]
+  spec.description   = %q{Manage development configurations for themed apps}
+  spec.summary       = %q{Themed app configuration management}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/configuration_manager/configuration.rb

@@ -0,0 +1,13 @@
+module ConfigurationManager
+  class Configuration < Struct.new(:ignored_configs)
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+  end
+end

data/lib/configuration_manager/railtie.rb

@@ -0,0 +1,7 @@
+module ConfigurationManager
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../../tasks/config.rake',  __FILE__)
+    end
+  end
+end

data/lib/configuration_manager/version.rb

@@ -0,0 +1,3 @@
+module ConfigurationManager
+  VERSION = "0.1.0"
+end

data/lib/configuration_manager.rb

@@ -0,0 +1,53 @@
+require "configuration_manager/configuration"
+require "configuration_manager/railtie"
+require "configuration_manager/version"
+
+module ConfigurationManager
+
+  def reload_config
+    AppConfig.reload!
+  rescue Errno::ENOENT
+    raise "Missing the application.yml configuration file. Try loading with " +
+      "`cp config/application.cx.dev.yml config/application.yml`"
+  end
+
+  def check_configuration_freshness
+    current = "application.yml"
+    reference = "application.#{AppConfig.theme}.dev.yml"
+
+    current_path = "#{Rails.root}/config/#{current}"
+    reference_path = "#{Rails.root}/config/#{reference}"
+
+    different = configs_different? current_path, reference_path
+
+    if different && !AppConfig['allow_custom_configuration']
+      raise "Current configuration #{current} does not match #{reference}. " +
+        "Either run `rake config:update` or set allow_custom_configuration to true" +
+        " in your application.yml."
+    end
+  end
+
+  private
+
+  def configs_different?(path_one, path_two)
+    one = YAML.load_file(path_one)
+    two = YAML.load_file(path_two)
+
+    relevant_configs_one = relevant_configs(one)
+    relevant_configs_two = relevant_configs(two)
+
+    relevant_configs_one != relevant_configs_two
+  end
+
+  def relevant_configs(data)
+    ignored_configs = ConfigurationManager.configuration.ignored_configs
+
+    ignored_configs.each do |config|
+      ["development", "test"].each do |env|
+        data[env].delete config.to_s if data[env]
+      end
+    end
+
+    data
+  end
+end

data/lib/tasks/config.rake

@@ -0,0 +1,27 @@
+namespace :config do
+  desc "Switch configurations to another theme, specieid by THEME"
+  task :switch do
+    theme = ENV['THEME']
+
+    puts "= Switching to the #{theme} configuration"
+    copy_theme(theme)
+
+    puts "= Clearing temp files"
+    Rake::Task["tmp:clear"].invoke
+  end
+
+  desc "Update the current configuration"
+  task :update do
+    theme = AppConfig.theme
+
+    puts "= Updating config, using the #{theme} configuration"
+    copy_theme(theme)
+  end
+
+  def copy_theme(theme)
+    source = "#{Rails.root}/config/application.#{theme}.dev.yml"
+    dest = "#{Rails.root}/config/application.yml"
+
+    system "cp #{source} #{dest}"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: configuration_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bruz Marzolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage development configurations for themed apps
+email:
+- bruz@cx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- configuration_manager.gemspec
+- lib/configuration_manager.rb
+- lib/configuration_manager/configuration.rb
+- lib/configuration_manager/railtie.rb
+- lib/configuration_manager/version.rb
+- lib/tasks/config.rake
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 912823216979744525
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 912823216979744525
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Themed app configuration management
+test_files: []