app-yml-rails 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.0 (Apr 30, 2012)
+
+**Features:**
+
+  - Provides project-wide settings via `config/app.yml`
+  - Supports `App.settings.nested_settings` syntax
+  - Supports all/production/staging/development/test environments (specific environment settings over settings from the 'all' environment)
+  - Auto-refreshes `app.yml` changes without requiring an application restart

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Graham Swan
+
+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,64 @@
+# app-yml-rails
+
+This gem provides a Rails application with project-wide settings via an **app.yml** file.
+
+## Features
+
+- Provides project-wide settings via **config/app.yml**.
+- Supports `App.settings.nested_settings` syntax.
+- Supports **all/production/staging/development/test** environments (specific environment settings over settings from the 'all' environment).
+- Auto-refreshes **app.yml** changes without requiring an application restart.
+
+## Installation
+
+Add the following line to your project's **Gemfile**:
+
+    gem 'app-yml-rails'
+
+Install the config and initializer files:
+
+    $ rails generate app_yml:install
+
+## Usage
+
+1. Edit your project settings in **config/app.yml**.
+2. Access settings anywhere in your application via `App.settings.nested_setting` syntax.
+
+## Examples
+
+If your **config/app.yml** file appears as follows:
+
+    all:
+      emails:
+        admin: admin@example.com
+        team:
+          ceo: ceo@example.com
+      max_search_results: 20
+      app_name: My Amazing Application
+
+    development:
+      emails:
+        team:
+          ceo: ceo@localhost
+      app_name: My Amazing Application (development)
+
+    production:
+      app_name: My Amazing Application (production)
+
+Settings in the **development** environment:
+
+    App.emails.admin       => 'admin@example.com'
+    App.emails.team.ceo    => 'ceo@localhost'
+    App.max_search_results => 20
+    App.app_name           => 'My Amazing Application (development)'
+
+Settings in the **production** environment:
+
+    App.emails.admin       => 'admin@example.com'
+    App.emails.team.ceo    => 'ceo@example.com'
+    App.max_search_results => 20
+    App.app_name           => 'My Amazing Application (production)'
+
+## License
+
+[MIT License](https://github.com/thinkswan/app-yml-rails/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/app_yml.rb

@@ -0,0 +1,6 @@
+require 'app_yml/core_ext'
+require 'app_yml/application_controller_ext'
+
+# Public: Initializes the 'AppYml' module. All functionality is contained 'lib/app_yml'.
+module AppYml
+end

data/lib/app_yml/application_controller_ext.rb

@@ -0,0 +1,20 @@
+# Public: Injects a filter into the project's ApplicationController to refresh the 'app.yml' settings for every request.
+require 'action_controller'
+
+ActionController::Base.class_eval do
+  private
+
+  # Private: Refreshes all settings from 'app.yml' for every request (no app restarts required).
+  #
+  # Provides a global 'App' constant holding project-wide settings.
+  def _reload_app_yml
+    App::build_settings_hash
+  end
+end
+
+ActionController::Base.instance_eval do
+  helper_method :_reload_app_yml
+  
+  # Refresh 'app.yml' settings if the 'app.rb' initializer has been installed
+  before_filter :_reload_app_yml, :if => Proc.new { defined? App }
+end

data/lib/app_yml/core_ext.rb

@@ -0,0 +1,45 @@
+# Public: Extends Ruby's Hash class to provide a method for performing a deep update on a hash.
+class Hash
+  # Public: Performs an in-place deep update on the calling hash with the provided 'new_hash'. Allows us to override 'app.yml'
+  # settings from the 'all' environment with the current environment (test/development/staging/production) with unlimited nesting.
+  #
+  # new_hash - The hash to copy over the calling hash.
+  #
+  # Examples
+  #
+  #   { :email => 'email@example.com', :name => 'Graham Swan' }.deep_update!({ :email => 'new_email@example.com' })
+  #   => { :email => 'new_email@example.com', :name => 'Graham Swan' }
+  #
+  # Returns the calling hash with the updated values.
+  def deep_update! new_hash={}
+    new_hash.each_pair do |key, val|
+      if val.class.eql? Hash
+        self[key].deep_update! val
+      else
+        self[key] = val
+      end
+    end
+    
+    self
+  end
+end
+
+# Public: Extends Rails' HashWithIndifferentAccess class to provide a method for accessing a hash's values with dot syntax.
+module ActiveSupport
+  class HashWithIndifferentAccess < Hash
+    # Public: Causes '{}.arg' to call '{}[:arg]'.
+    #
+    # Note: None of the HashWithIndifferentAccess methods will work here. (http://as.rubyonrails.org/classes/HashWithIndifferentAccess.html)
+    #   The aforementioned methods will invoke their expected functionality.
+    #
+    # Examples
+    #
+    #   (HashWithIndifferentAccess.new({ :country => 'Canada' })).country
+    #   => 'Canada'
+    #
+    # Returns the calling hash with the updated values.
+    def method_missing(method, *args)
+      self[method]
+    end
+  end
+end

data/lib/app_yml/version.rb

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

data/lib/generators/app_yml/install/install_generator.rb

@@ -0,0 +1,25 @@
+# Public: A generator used to install the app.yml config file and the app.rb initializer.
+#   Copies lib/generators/app_yml/install/templates/app.yml to config/app.yml
+#   Copies lib/generators/app_yml/install/templates/app.rb to config/initializers/app.rb
+#
+# Usage: rails generate app_yml:install
+module AppYml
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+  
+      desc "Creates an app.yml config file in 'config/app.yml' and an app.rb initializer (providing access to the App constant) in 'config/initializers/app.rb'."
+
+      def create_config_file
+        template 'app.yml', File.join('config', 'app.yml')
+      end
+
+      def create_initializer_file
+        template 'app.rb', File.join('config', 'initializers', 'app.rb')
+      end
+     
+    end
+  end
+end
+
+

data/lib/generators/app_yml/install/templates/app.rb

@@ -0,0 +1,39 @@
+# Public: An initializer that provides global access to the App constant (which holds all settings from config/app.yml).
+#
+# Thanks to Adrian Danieli (http://sickpea.com/2009/6/rails-app-configuration-in-10-lines) for this idea.
+module App
+  # Causes App.arg to call App[arg].
+  #
+  # Eg: App.country would call App[:country]
+  def self.method_missing(method, *args)
+    self[method, *args]
+  end
+  
+  # Causes App[arg] to return @@settings[arg].
+  #
+  # Eg: If @@settings = { :country => 'Canada' }, then App[:country] will return @@settings[:country] == 'Canada'
+  def self.[](*args)
+    args.inject(@@settings) { |hash, arg| hash[arg] }
+  end
+  
+  # Parses 'config/app.yml' and converts it into a HashWithIndifferentAccess (which provides us with dot syntax).
+  # 
+  # See 'config/app.yml' for examples.
+  def self.build_settings_hash
+    # Create a hash out of config/app.yml
+    yaml = YAML.load(ERB.new(File.read(Rails.root.join('config', 'app.yml'))).result)
+
+    # Fetch settings from the all: section
+    @@settings = yaml['all']
+
+    # Merge in settings from the current environment's section, giving the environment's settings precedence
+    @@settings.deep_update! yaml[Rails.env] || {}
+
+    # Allow this hash's data to be accessed with both strings and symbols
+    @@settings = HashWithIndifferentAccess.new @@settings
+  end
+  
+  # Initialize the settings hash
+  @@settings = {}
+  self.build_settings_hash
+end

data/lib/generators/app_yml/install/templates/app.yml

@@ -0,0 +1,42 @@
+# This is the app's global key-value store. Retrieve settings from anywhere in the app with App.setting.nested_setting syntax.
+#
+# Note: Settings from the current environment (test/development/staging/production) will override settings
+#   with the same name from the 'all' section.
+#
+# Example: The following config will result in this resultant hash: App.emails = { :admin => 'admin@localhost', :support => 'support@example.com' }
+#
+# all:
+#   emails:
+#     admin: admin@example.com
+#     support: support@example.com
+# development:
+#   emails:
+#     admin: admin@localhost
+#
+# In this example, 'App.emails.admin' will return 'admin@localhost'.
+
+all:
+  emails:
+    admin: admin@example.com
+    support: support@example.com
+    billing: billing@example.com
+    team:
+      ceo: ceo@example.com
+      cto: cto@example.com
+  max_search_results: 20
+  app_name: My Amazing Application
+
+test:
+
+development:
+  emails:
+    admin: admin@localhost
+    team:
+      ceo: ceo@localhost
+  app_name: My Amazing Application (development)
+
+staging:
+  app_name: My Amazing Application (staging)
+
+production:
+  app_name: My Amazing Application (production)

data/test/app_yml_test.rb

@@ -0,0 +1,5 @@
+require 'test_helper'
+
+class AppYmlTest < ActiveSupport::TestCase
+  # TODO Write a functional test to ensure app.yml settings are reloaded on every request
+end

data/test/core_ext_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+ 
+class CoreExtTest < Test::Unit::TestCase
+  @@all_hash = {
+    :emails => {
+      :admin => 'admin@example.com',
+      :support => 'support@example.com',
+      :billing => 'billing@example.com',
+      :team => {
+        :ceo => 'ceo@example.com',
+        :cto => 'cto@example.com'
+      }
+    },
+    :max_search_results => 20,
+    :app_name => 'My Amazing Application'
+  }
+  @@dev_hash = {
+    :emails => {
+      :admin => 'admin@localhost',
+      :team => {
+        :ceo => 'ceo@localhost'
+      }
+    },
+    :app_name => 'My Amazing Application (development)'
+  }
+  
+  def test_hash_dot_syntax
+    hash_with_indifferent_access = HashWithIndifferentAccess.new @@all_hash
+    
+    assert_equal 'ceo@example.com', hash_with_indifferent_access.emails.team.ceo
+    assert_equal 20, hash_with_indifferent_access.max_search_results
+  end
+  
+  def test_hash_deep_update
+    all_hash_copy = Marshal.load Marshal.dump @@all_hash # Make a deep copy of @@all_hash (so that it maintains its state for subsequent tests)
+    all_hash_copy.deep_update! @@dev_hash
+    app_hash = HashWithIndifferentAccess.new all_hash_copy
+    
+    assert_equal 'admin@localhost', app_hash.emails.admin
+    assert_equal 'ceo@localhost', app_hash.emails.team.ceo
+    assert_equal 'My Amazing Application (development)', app_hash.app_name
+    
+    assert_equal 'support@example.com', app_hash.emails.support
+    assert_equal 'cto@example.com', app_hash.emails.team.cto
+    assert_equal 20, app_hash.max_search_results
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.