amberbit-config 1.0.2 → 1.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright 2011 Wojciech Piekutowski, Hubert Łępicki, Piotr Tynecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -0,0 +1,89 @@
+AmberBit Config
+===============
+
+Provides simple global configuration for ruby applications using YAML files.
+
+Installation:
+=============
+
+With bundler:
+---------------
+
+    1. Edit Gemfile, located in your application and add the following line:
+        gem 'amberbit-config'
+    2. Run bundle:
+        bundle install
+    3. Use rake to generate configuration files:
+        rake amberbit:config:setup
+    4. Make sure that ./config/app_config.yml stays in .gitignore
+
+As a rails engine:
+------------------
+
+It will work without any other actions as a rails engine. It takes environment name from:
+
+    ENV['RAILS_ENV'] or ENV['RACK_ENV'] or ENV['APP_CONFIG_ENV']
+
+AppConfig should be initialized before environment configuration. If you need to use it within ./config/application.rb then
+add after Bundler.require
+
+    require 'amberbit-config'
+    AmberbitConfig.initialize_within File.dirname(__FILE__)
+
+Any ruby application
+--------------------
+For any other app require and initialize AppConfig as above, just make sure that there's an ENV variable. You can also
+specify files to load, i.e.:
+
+    require 'amberbit-config'
+    ENV['RACK_ENV'] = 'development'
+    AmberbitConfig.initialize 'config/app_config_default.yml', 'config/app_config.yml'
+
+Tested with Ruby on Rails, Sinatra, and plain old ruby.
+
+Usage:
+======
+
+Place your application configuration default values into ./config/app_config_default.yml:
+
+    default:
+      application:
+        name: SuperApp
+        url: http://localhost:3000/
+
+    test:
+      # overwrite application.url key only in test env
+      application:
+        url: http://testhost:3000/
+
+And overwrite values you wish on per-installation basis in ./config/app_config.yml:
+
+    default:
+      application:
+        name: SuperApp specially for you
+
+    production:
+      application:
+        url: http://yoursuperhiperdomain.com
+
+In your application Ruby code you can access the values in 2 following ways:
+
+  AppConfig["application"]["name"] #=> SuperApp specially for you
+
+or
+
+  AppConfig.application.name #=> SuperApp specially for you
+
+Keys are deep-merged, for example:
+  production env:
+
+  AppConfig.application.name #=> SuperApp specially for you
+  AppConfig.application.url #=> http://yoursuperhiperdomain.com
+
+  development env:
+
+  AppConfig.application.name #=> SuperApp specially for you
+  AppConfig.application.url #=> http://localhost:3000/
+
+
+Copyright (c) 2008/2011 Wojciech Piekutowski, Hubert Łępicki, Piotr Tynecki released under the MIT license

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/lib/amberbit-config.rb

@@ -1,3 +1,27 @@
-require 'yaml'
-require File.join(File.dirname(__FILE__), 'hash_struct')
-require File.join(File.dirname(__FILE__), 'amber_bit_app_config')
+require 'amberbit-config/version'
+require 'amberbit-config/errors'
+require 'amberbit-config/config'
+require 'amberbit-config/hash_struct'
+require 'amberbit-config/engine' if defined?(::Rails::Engine)
+
+module AmberbitConfig
+  # Initialize AppConfig variable with default file path and custom file path if it wasn't set yet.
+  def self.initialize(default_file, config_file)
+    return unless File.exist?(default_file)
+    return if defined?(AppConfig)
+
+    config = Config.new default_file, config_file
+    Object.const_set 'AppConfig', HashStruct.create(config.data)
+  end
+
+  # Run initialze with default file names within root_path
+  def self.initialize_within(root_path)
+    initialize path_from(root_path, 'app_config_default.yml'), path_from(root_path, 'app_config.yml')
+  end
+
+  # Gets path from root_path and file name, i.e.
+  # <tt>path_from File.dirname(__FILE__), 'app_config.yml'</tt>
+  def self.path_from(root_path, file)
+    File.expand_path File.join(File.dirname(root_path), 'config', file)
+  end
+end

data/lib/amberbit-config/config.rb

@@ -0,0 +1,60 @@
+require 'erb'
+require 'yaml'
+
+module AmberbitConfig
+  # Class responsible for loading, parsing and merging configuration from yaml files.
+  class Config
+    attr_reader :default, :custom, :data
+
+    def initialize(defaults_file, customs_file)
+      @default = parse_yaml defaults_file
+      @custom  = parse_yaml customs_file
+
+      @data = deep_merge default, custom
+    end
+
+    private
+
+    # Parse configuration file with ERB so you can set keys like:
+    # <tt>redis_url: <%= ENV['REDIS_URL'] %></tt>
+    # then loads a hash and merges defaults with current environment
+    def parse_yaml(file)
+      file_content = File.exist?(file) ? ERB.new(File.read(file)).result : '---'
+
+      config = YAML.load(file_content) || {}
+      env    = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['APP_CONFIG_ENV']
+
+      config_from config['default'], config[env]
+    end
+
+    def config_from(default_config, env_config)
+      if present?(default_config) && present?(env_config)
+        deep_merge default_config, env_config
+      else
+        env_config || default_config || {}
+      end
+    end
+
+    def deep_merge(origin, from)
+      origin ||= {}
+      from   ||= {}
+      deep_merge!(origin.dup, from)
+    end
+
+    def deep_merge!(origin, from)
+      from.each do |key, value|
+        origin[key] = value.is_a?(Hash) ? deep_merge(origin[key], value) : value
+      end
+
+      origin
+    end
+
+    def present?(object)
+      !blank?(object)
+    end
+
+    def blank?(object)
+      object.respond_to?(:empty?) ? object.empty? : !object
+    end
+  end
+end

data/lib/amberbit-config/engine.rb

@@ -0,0 +1,12 @@
+require 'amberbit-config'
+
+module AmberbitConfig
+  class Engine < ::Rails::Engine
+    engine_name :amberbit_config
+
+    # Try to initialize AppConfig as soon as possible
+    initializer 'amberbit_config.initialize_config', before: :load_environment_config do |app|
+      AmberbitConfig.initialize_within app.root.join('config')
+    end
+  end if defined?(::Rails)
+end

data/lib/amberbit-config/errors.rb

@@ -0,0 +1,4 @@
+module AmberbitConfig
+  class HashArgumentError < ::ArgumentError; end
+  class ConfigNotSetError < ::NoMethodError; end
+end

data/lib/amberbit-config/hash_struct.rb

@@ -0,0 +1,59 @@
+require 'ostruct'
+
+module AmberbitConfig
+  # Main class that holds whole configuration, acts as open struct, with few tune ups
+  class HashStruct < ::OpenStruct
+    # Initialize with check for conflicts within hash keys
+    def initialize(hash = nil)
+      check_hash_for_conflicts hash if hash
+      super
+    end
+
+    # Adds access to existing keys through hash operator
+    def [](key)
+      self.send key unless key == nil
+    end
+
+    # Generates a nested Hash object which is a copy of existing configuration
+    def to_hash
+      _copy = {}
+      @table.each { |key, value| _copy[key] = value.is_a?(HashStruct) ? value.to_hash : value }
+      _copy
+    end
+
+    # Raise an error if method/configuration isn't set yet. It should prevent typos, because normally it will just
+    # return a nil. With this check you can spot those earlier.
+    def method_missing(method, *args, &block)
+      if method =~ /=\z/ || self.respond_to?(method)
+        super
+      else
+        raise ConfigNotSetError, "Configuration option: '#{method}' was not set"
+      end
+    end
+
+    # Creates a deeply nested HashStruct from hash.
+    def self.create(object)
+      case object
+      when Array
+        object.map { |item| create(item) }
+      when Hash
+        mapped = {}
+        object.each { |key, value| mapped[key] = create(value) }
+        HashStruct.new mapped
+      else
+        object
+      end
+    end
+
+    private
+
+    # Checks if provided option is a hash and if the keys are not in confict with OpenStruct public methods.
+    def check_hash_for_conflicts(hash)
+      raise HashArgumentError, 'It must be a hash' unless hash.is_a?(Hash)
+
+      unless (conflicts = self.public_methods & hash.keys.map(&:to_sym)).empty?
+        raise HashArgumentError, "Rename keys in order to avoid conflicts with internal calls: #{conflicts.join(', ')}"
+      end
+    end
+  end
+end

data/lib/amberbit-config/version.rb

@@ -0,0 +1,3 @@
+module AmberbitConfig
+  VERSION = '1.1.0'
+end

data/lib/tasks/amberbit-config.rake

@@ -0,0 +1,37 @@
+if defined?(Rails)
+  namespace :amberbit do
+    namespace :config do
+
+      desc 'Creates config/app_config_default.yml and config/app_config.yml files'
+      task :setup => :environment do
+        if File.directory? Rails.root.join('config')
+          puts 'Directory config already exists, skipping.'
+        elsif !File.exists?(Rails.root.join('config'))
+          Dir.mkdir Rails.root.join('config')
+          puts 'Directory config was created.'
+        else
+          puts 'AmberBit Config requires config to be a directory and it appears to be a regular file!'
+          puts 'Cannot continue, stopping!'
+          exit(-1)
+        end
+
+        %w(app_config_default app_config).each do |fn|
+          if File.exists? Rails.root.join('config', "#{fn}.yml")
+            puts "File config/#{fn}.yml already exists, skipping."
+          else
+            File.open Rails.root.join('config', "#{fn}.yml"), 'w+:utf-8' do |file|
+              file.write "---\ndefault:\n\ndevelopment:\n\ntest:\n\nstaging:\n\nproduction:"
+            end
+
+            puts "File config/#{fn}.yml was created."
+          end
+        end
+
+        if (gitignore = Rails.root.join('.gitignore')) && File.exists?(gitignore)
+          File.open(gitignore, 'a') { |f| f << "\nconfig/app_config.yml" }
+          puts 'Added entry in .gitignore'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,150 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: amberbit-config
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Wojciech Piekutowski
 - Hubert Lepicki
+- Piotr Tynecki
+- Leszek Zalewski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-22 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: Reads YAML files with configuration. Allows you to specify default configuration file you can store in repository and overwrite it with custom configuration file for each application instance and environment.
+date: 2013-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: Reads YAML files with configuration. Allows you to specify default configuration
+  file you can store in repository and overwrite it with custom configuration file
+  for each application instance and environment.
 email: hubert.lepicki@amberbit.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
-- .gitignore
+extra_rdoc_files: []
+files:
+- lib/amberbit-config/version.rb
+- lib/amberbit-config/hash_struct.rb
+- lib/amberbit-config/engine.rb
+- lib/amberbit-config/errors.rb
+- lib/amberbit-config/config.rb
+- lib/amberbit-config.rb
+- lib/tasks/amberbit-config.rake
 - MIT-LICENSE
-- README
-- Rakefile
+- README.rdoc
 - VERSION
-- amberbit-config.gemspec
-- init.rb
-- install.rb
-- lib/amber_bit_app_config.rb
-- lib/amberbit-config.rb
-- lib/hash_struct.rb
-- rails/init.rb
-- spec/library_spec.rb
-- spec/plugin_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/testapp/README
-- spec/testapp/Rakefile
-- spec/testapp/app/controllers/application_controller.rb
-- spec/testapp/app/helpers/application_helper.rb
-- spec/testapp/config/application/config.yml
-- spec/testapp/config/application/default.yml
-- spec/testapp/config/boot.rb
-- spec/testapp/config/environment.rb
-- spec/testapp/config/environments/development.rb
-- spec/testapp/config/environments/production.rb
-- spec/testapp/config/environments/test.rb
-- spec/testapp/config/initializers/backtrace_silencers.rb
-- spec/testapp/config/initializers/inflections.rb
-- spec/testapp/config/initializers/mime_types.rb
-- spec/testapp/config/initializers/new_rails_defaults.rb
-- spec/testapp/config/initializers/session_store.rb
-- spec/testapp/config/locales/en.yml
-- spec/testapp/config/routes.rb
-- spec/testapp/db/test.sqlite3
-- spec/testapp/doc/README_FOR_APP
-- spec/testapp/log/development.log
-- spec/testapp/log/production.log
-- spec/testapp/log/server.log
-- spec/testapp/log/test.log
-- spec/testapp/public/404.html
-- spec/testapp/public/422.html
-- spec/testapp/public/500.html
-- spec/testapp/public/favicon.ico
-- spec/testapp/public/images/rails.png
-- spec/testapp/public/index.html
-- spec/testapp/public/javascripts/application.js
-- spec/testapp/public/javascripts/controls.js
-- spec/testapp/public/javascripts/dragdrop.js
-- spec/testapp/public/javascripts/effects.js
-- spec/testapp/public/javascripts/prototype.js
-- spec/testapp/public/robots.txt
-- spec/testapp/script/about
-- spec/testapp/script/console
-- spec/testapp/script/dbconsole
-- spec/testapp/script/destroy
-- spec/testapp/script/generate
-- spec/testapp/script/performance/benchmarker
-- spec/testapp/script/performance/profiler
-- spec/testapp/script/plugin
-- spec/testapp/script/runner
-- spec/testapp/script/server
-- spec/testapp/test/performance/browsing_test.rb
-- spec/testapp/test/test_helper.rb
-- tasks/amberbit_app_config_tasks.rake
-- uninstall.rb
-has_rdoc: true
 homepage: http://github.com/amberbit/amberbit-config
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+rdoc_options: []
+require_paths:
+- - .
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2357817230340208494
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2357817230340208494
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Yet Another AppConfig for Rails but not only
-test_files: 
-- spec/testapp/config/boot.rb
-- spec/testapp/config/environment.rb
-- spec/testapp/config/environments/development.rb
-- spec/testapp/config/environments/production.rb
-- spec/testapp/config/environments/test.rb
-- spec/testapp/config/initializers/backtrace_silencers.rb
-- spec/testapp/config/initializers/mime_types.rb
-- spec/testapp/config/initializers/new_rails_defaults.rb
-- spec/testapp/config/initializers/session_store.rb
-- spec/testapp/config/initializers/inflections.rb
-- spec/testapp/config/routes.rb
-- spec/testapp/test/test_helper.rb
-- spec/testapp/test/performance/browsing_test.rb
-- spec/testapp/app/controllers/application_controller.rb
-- spec/testapp/app/helpers/application_helper.rb
-- spec/library_spec.rb
-- spec/plugin_spec.rb
-- spec/spec_helper.rb
+summary: Yet Another AppConfig for Rails but not only.
+test_files: []