behavior 0.1.0

data/README.textile

@@ -0,0 +1,97 @@
+h1. Behavior
+
+Behavior is a Ruby on Rails plugin for storing application configuration variables in the database. You can use it to store things like a Site's Title, description and keywords, or for user definable things like a currency exchange rate, or minimum and maximum values.
+
+The benefits of storing configuration in the database are:
+
+- End users can easily edit the values
+- Configuration is decoupled from the codebase
+
+This is particularly useful for open source projects, where application settings shouldn't be stored in source code.
+
+It's designed to be as simple to use and get up and running, and to be flexible in that it's both end user and developer friendly.
+
+Although all config variables are ultimately stored in the database, you can set sensible defaults in a configuration file in the source code.
+
+h2. Installation
+
+Behavior is easy to install.
+
+As a plugin:
+
+<pre><code>./script/plugin install git://github.com/paulca/behavior.git</code></pre>
+
+Or as a gem. Add this to your environment.rb:
+
+<pre><code>config.gem 'behavior'</code></pre>
+
+Generate the migration and sample behavior.yml:
+
+<pre><code>./script/generate behavior</code></pre>
+
+And run the migration:
+
+<pre><code>rake db:migrate</code></pre>
+
+h2. Basic Usage
+
+There are two parts to how behavior works. First of all there is a config file, config/behavior.yml. This file controls the variables that are allowed to be set in the app.
+
+For example, if you wanted to have access to a config variable "site_title", put this in behavior.yml:
+
+<pre><code>site_title:
+  default: My Site</code></pre>
+  
+Now, within your app, you can access <pre><code>config[:site_title]</code></pre>.
+
+If you want to update the config, call <pre><code>config.update(:site_title => "My New Title")</code></pre>
+
+h2. Web Interface
+
+behavior comes with a web interface that is available to your app straight away at <pre><code>http://localhost:3000/admin/config</code></pre>.
+
+By default, this comes with no styling, but you can create a layout in <pre><code>app/layouts/admin.html.erb</code></pre>, or set a layout by setting <pre><code>Behavior::Setting.layout</code></pre>
+
+For example, to use your standard application layout, create a <pre><code>config/initializers/behavior.rb</code></pre> like this:
+
+<pre><code>Behavior::Settings.layout = 'application'</code></pre>
+
+You can also add before_filters to protect the controller from outsiders:
+
+<pre><code>Behavior::Settings.before_filters << 'require_admin_user'</code></pre>
+
+If you want to control how the fields in the admin interface appear, you can add additional params in your behavior.yml file:
+
+<pre><code>site_title:
+  name: Name of Your Site   # sets the edit label
+  default: My Site          # sets the default value
+  type: string              # uses input type="text"
+  
+site_description:
+  name: Describe Your Site  # sets the edit label
+  default: My Site          # sets the default value
+  type: text                # uses textarea
+  
+secret:
+  name: A Secret Passphrase # sets the edit label
+  default: passpass         # sets the default value
+  type: password            # uses input type="password"
+</code></pre>
+
+h2. Running the tests
+
+You can run the tests by checking out the code into vendor/plugins of a Rails app and running:
+
+<pre><code>rake</code></pre>
+
+It also comes with a set of cucumber features:
+
+<pre><code>cucumber</code></pre>
+
+h2. About me
+
+I'm Paul Campbell. I'm an avid Ruby on Rails web developer. Follow my ramblings at "http://www.pabcas.com":http://www.pabcas.com
+
+Follow me on Twitter "http://twitter.com/paulca":http://twitter.com/paulca
+
+Copyright (c) 2009 Paul Campbell, released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'app/**/*',
+  'generators/**/*',
+  'config/*',
+  'lib/**/*',
+  'rails/**/*',
+  'spec/**/*',
+  'features/**/*'
+]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "behavior"
+    s.version = "0.1.0"
+    s.author = "Paul Campbell"
+    s.email = "paul@rslw.com"
+    s.homepage = "http://www.github.com/paulca/behavior"
+    s.platform = Gem::Platform::RUBY
+    s.summary = "A Rails plugin for storing application configuration in the database."
+    s.files = PKG_FILES.to_a
+    s.require_path = "lib"
+    s.has_rdoc = false
+    s.extra_rdoc_files = ["README.textile"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new

data/app/controllers/admin/configs_controller.rb

@@ -0,0 +1,20 @@
+class Admin::ConfigsController < ApplicationController
+  
+  layout Behavior::Settings.layout
+  Behavior::Settings.before_filters.each do |filter|
+    before_filter filter
+  end
+  
+  helper :behavior
+  
+  def show
+    @configs = config.all
+  end
+  
+  def update
+    config.update(params[:conf])
+    flash[:notice] = "Config Changes Saved"
+    redirect_to admin_config_path
+  end
+  
+end

data/app/helpers/behavior_helper.rb

@@ -0,0 +1,8 @@
+module BehaviorHelper
+  
+  def behavior_tag(conf)
+    return text_area_tag("conf[#{conf}]", config[conf], :id => conf) if config.meta[conf][:type] == 'text'
+    return password_field_tag("conf[#{conf}]", config[conf], :id => conf) if config.meta[conf][:type] == 'password'
+    text_field_tag("conf[#{conf}]", config[conf], :id => conf)
+  end
+end

data/app/models/behavior_config.rb

@@ -0,0 +1,3 @@
+class BehaviorConfig < ActiveRecord::Base
+  
+end

data/app/views/admin/configs/show.html.erb

@@ -0,0 +1,20 @@
+<h2>Edit Configuration</h2>
+
+<%- if !flash[:notice].blank? -%>
+  <div class="notice">
+    <%= flash[:notice] %>
+  </div>
+<%- end -%>
+
+<%- form_tag admin_config_path, :method => :put do -%>
+
+  <fieldset>
+    <%- @configs.each do |conf| -%>
+      <%= label_tag(conf, (config.meta[conf][:name]))  %>
+      <%= behavior_tag(conf) %> <br />
+    <%- end -%>
+  </fieldset>
+  
+  <%= submit_tag "Save" %>
+  
+<%- end -%>

data/app/views/layouts/admin.html.erb

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <title>Site Admin</title>
+  </head>
+  
+  <body>
+    <h1>Site Admin</h1>
+    <%= yield %>
+  </body>
+</html>

data/behavior.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{behavior}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Campbell"]
+  s.date = %q{2009-12-11}
+  s.email = %q{paul@rslw.com}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    "README.textile",
+     "Rakefile",
+     "app/controllers/admin/configs_controller.rb",
+     "app/helpers/behavior_helper.rb",
+     "app/models/behavior_config.rb",
+     "app/views/admin/configs/show.html.erb",
+     "app/views/layouts/admin.html.erb",
+     "behavior.gemspec",
+     "config/behavior.yml",
+     "config/routes.rb",
+     "features/admin_configs.feature",
+     "features/step_definitions/web_steps.rb",
+     "features/support/behavior_env.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "generators/behavior/USAGE",
+     "generators/behavior/behavior_generator.rb",
+     "generators/behavior/templates/20091210164854_create_behavior_configs.rb",
+     "generators/behavior/templates/behavior.yml",
+     "generators/definition.txt",
+     "lib/behavior.rb",
+     "rails/init.rb",
+     "spec/behavior_generator_spec.rb",
+     "spec/behavior_spec.rb",
+     "spec/blueprints.rb",
+     "spec/database.yml",
+     "spec/debug.log",
+     "spec/helpers/behavior_helper_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://www.github.com/paulca/behavior}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Rails plugin for storing application configuration in the database.}
+  s.test_files = [
+    "spec/behavior_generator_spec.rb",
+     "spec/behavior_spec.rb",
+     "spec/blueprints.rb",
+     "spec/helpers/behavior_helper_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/config/behavior.yml

@@ -0,0 +1,18 @@
+email_address:
+  name: Email Address
+  type: string
+  default: example@example.com
+
+email_name:
+  default: Site Administrator
+  type: string
+  
+password:
+  default: password
+  type: password
+  name: Password
+  
+description:
+  default: My Awesome Site
+  type: text
+  name: Description

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin do |admin|
+    admin.resource :config
+  end
+end

data/features/admin_configs.feature

@@ -0,0 +1,15 @@
+Feature: Editing Configuration
+  In order to set configuration variables in my app
+  As a user
+  I want to be able to see what configuration is available, and edit it
+  
+  Scenario: Editing configuration
+    Given I am on the configuration page
+    Then I should see "Site Admin"
+      And I should see "Email Address"
+      And I should see "Email name"
+    
+    When I fill in "Email Address" with "paul@rslw.com"
+      And I press "Save"
+    Then the "Email Address" field should contain "paul@rslw.com"
+    Then I should see "Config Changes Saved"

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,248 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one.
+
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+module WithinHelpers
+  def with_scope(locator)
+    within(locator || 'html') { yield }
+  end
+end
+World(WithinHelpers)
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^\"]*)"(?: within "([^\"]*)")?$/ do |button, selector|
+  with_scope(selector) do
+    click_button(button)
+  end
+end
+
+When /^(?:|I )follow "([^\"]*)"(?: within "([^\"]*)")?$/ do |link, selector|
+  with_scope(selector) do
+    click_link(link)
+  end
+end
+
+When /^(?:|I )fill in "([^\"]*)" with "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, value, selector|
+  with_scope(selector) do
+    fill_in(field, :with => value)
+  end
+end
+
+When /^(?:|I )fill in "([^\"]*)" for "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+  with_scope(selector) do
+    fill_in(field, :with => value)
+  end
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following(?: within "([^\"]*)"|)?:$/ do |fields, selector|
+  with_scope(selector) do
+    fields.rows_hash.each do |name, value|
+      When %{I fill in "#{name}" with "#{value}"}
+    end
+  end
+end
+
+When /^(?:|I )select "([^\"]*)" from "([^\"]*)"(?: within "([^\"]*)")?$/ do |value, field, selector|
+  with_scope(selector) do
+    select(value, :from => field)
+  end
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time
+When /^(?:|I )select "([^\"]*)" as the date and time(?: within "([^\"]*)")?$/ do |time, selector|
+  with_scope(selector) do
+    select_datetime(time)
+  end
+end
+
+# Use this step when using multiple datetime_select helpers on a page or
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date and time(?: within "([^\"]*)")?$/ do |datetime, datetime_label, selector|
+  with_scope(selector) do
+    select_datetime(datetime, :from => datetime_label)
+  end
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it.
+When /^(?:|I )select "([^\"]*)" as the time(?: within "([^\"]*)")?$/ do |time, selector|
+  with_scope(selector) do
+    select_time(time)
+  end
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" time(?: within "([^\"]*)")?$/ do |time, time_label, selector|
+  with_scope(selector) do
+    select_time(time, :from => time_label)
+  end
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^(?:|I )select "([^\"]*)" as the date(?: within "([^\"]*)")?$/ do |date, selector|
+  with_scope(selector) do
+    select_date(date)
+  end
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date(?: within "([^\"]*)")?$/ do |date, date_label, selector|
+  with_scope(selector) do
+    select_date(date, :from => date_label)
+  end
+end
+
+When /^(?:|I )check "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    check(field)
+  end
+end
+
+When /^(?:|I )uncheck "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    uncheck(field)
+  end
+end
+
+When /^(?:|I )choose "([^\"]*)"(?: within "([^\"]*)")?$/ do |field, selector|
+  with_scope(selector) do
+    choose(field)
+  end
+end
+
+When /^(?:|I )attach the file at "([^\"]*)" to "([^\"]*)"(?: within "([^\"]*)")?$/ do |path, field, selector|
+  with_scope(selector) do
+    attach_file(field, path)
+  end
+end
+
+Then /^(?:|I )should see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      has_content?(text).should be_true
+    else
+      assert has_content?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      has_xpath?('//*', :text => regexp).should be_true
+    else
+      assert has_xpath('//*', :text => regexp)
+    end
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)"(?: within "([^\"]*)")?$/ do |text, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      has_content?(text).should be_false
+    else
+      assert_not has_content?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/(?: within "([^\"]*)")?$/ do |regexp, selector|
+  regexp = Regexp.new(regexp)
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      has_xpath?('//*', :text => regexp).should be_false
+    else
+      assert_not has_xpath?('//*', :text => regexp)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should contain "([^\"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      field_labeled(field).value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_labeled(field).value)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field(?: within "([^\"]*)")? should not contain "([^\"]*)"$/ do |field, selector, value|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      find_field(field).value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, find_field(field).value)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should be checked$/ do |label, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      field_labeled(label)['checked'].should == 'checked'
+    else
+      assert field_labeled(label)['checked'] == 'checked'
+    end
+  end
+end
+
+Then /^the "([^\"]*)" checkbox(?: within "([^\"]*)")? should not be checked$/ do |label, selector|
+  with_scope(selector) do
+    if defined?(Spec::Rails::Matchers)
+      field_labeled(label)['checked'].should_not == 'checked'
+    else
+      assert field_labeled(label)['checked'] != 'checked'
+    end
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  if defined?(Spec::Rails::Matchers)
+    URI.parse(current_url).path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), URI.parse(current_url).path
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/features/support/behavior_env.rb

@@ -0,0 +1,3 @@
+require 'spec/spec_helper'
+Behavior::Settings.config_file = 'config/behavior.yml'
+load_schema

data/features/support/env.rb

@@ -0,0 +1,53 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one.
+
+ENV["RAILS_ENV"] ||= "cucumber"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+require 'cucumber/rails/rspec'
+require 'cucumber/rails/world'
+require 'cucumber/rails/active_record'
+require 'cucumber/web/tableish'
+
+require 'capybara/rails'
+require 'capybara/cucumber'
+require 'capybara/session'
+require 'cucumber/rails/capybara_javascript_emulation' # Lets you click links with onclick javascript handlers without using @culerity or @javascript
+# Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In
+# order to ease the transition to Capybara we set the default here. If you'd
+# prefer to use XPath just remove this line and adjust any selectors in your
+# steps to use the XPath syntax.
+Capybara.default_selector = :css
+
+# If you set this to false, any error raised from within your app will bubble 
+# up to your step definition and out to cucumber unless you catch it somewhere
+# on the way. You can make Rails rescue errors and render error pages on a
+# per-scenario basis by tagging a scenario or feature with the @allow-rescue tag.
+#
+# If you set this to true, Rails will rescue all errors and render error
+# pages, more or less in the same way your application would behave in the
+# default production environment. It's not recommended to do this for all
+# of your scenarios, as this makes it hard to discover errors in your application.
+ActionController::Base.allow_rescue = false
+
+# If you set this to true, each scenario will run in a database transaction.
+# You can still turn off transactions on a per-scenario basis, simply tagging 
+# a feature or scenario with the @no-txn tag. If you are using Capybara,
+# tagging with @culerity or @javascript will also turn transactions off.
+#
+# If you set this to false, transactions will be off for all scenarios,
+# regardless of whether you use @no-txn or not.
+#
+# Beware that turning transactions off will leave data in your database 
+# after each scenario, which can lead to hard-to-debug failures in 
+# subsequent scenarios. If you do this, we recommend you create a Before
+# block that will explicitly put your database in a known state.
+Cucumber::Rails::World.use_transactional_fixtures = true
+
+# How to clean your database when transactions are turned off. See
+# http://github.com/bmabey/database_cleaner for more info.
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation

data/features/support/paths.rb

@@ -0,0 +1,27 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in webrat_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+    
+    when /the configuration page/
+      admin_config_path
+    
+    # Add more mappings here.
+    # Here is a more fancy example:
+    #
+    #   when /^(.*)'s profile page$/i
+    #     user_profile_path(User.find_by_login($1))
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/generators/behavior/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Creates a migration to create a table to store application configuration called "behavior_configs"
+    
+    Also creates an empty config/behavior.yml to get you started
+    
+Examples:
+    `./script/generate cucumber`

data/generators/behavior/behavior_generator.rb

@@ -0,0 +1,9 @@
+class BehaviorGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'db/migrate'
+      m.file "20091210164854_create_behavior_configs.rb", "db/migrate/20091210164854_create_behavior_configs.rb"
+      m.file "behavior.yml", "config/behavior.yml"
+    end
+  end
+end