behavior 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,102 @@
+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 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.
+
+Installation
+============
+
+Behavior is easy to install.
+
+As a plugin:
+
+    ./script/plugin install git://github.com/paulca/behavior.git
+
+Or as a gem. Add this to your environment.rb:
+
+    config.gem 'behavior'
+
+Then generate the migration and sample behavior.yml:
+
+    ./script/generate behavior
+
+And run the migration:
+
+    rake db:migrate
+
+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:
+
+    site_title:
+      default:
+  
+Now, within your app controllers and views, you can access `config[:site_title]`. In your models, you can access `Behavior.config[:site_title]`.
+
+If you want to update the config, call `config.update(:site_title => "My New Title")`
+
+Web Interface
+=============
+
+Using Rails' Engines feature, behavior comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/config`.
+
+By default, this comes with no styling, but you can create a layout in `app/layouts/admin.html.erb`, or set a layout by setting `Behavior::Setting.layout`
+
+For example, to use your standard application layout, create a `config/initializers/behavior.rb` like this:
+
+    Behavior::Settings.layout = 'application'
+
+You can also add before_filters to protect the controller from outsiders:
+
+    Behavior::Settings.before_filters << 'require_admin_user'
+
+If you want to control how the fields in the admin interface appear, you can add additional params in your behavior.yml file:
+
+    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"
+
+Running the tests
+=================
+
+You can run the tests by checking out the code into vendor/plugins of a Rails app and running:
+
+    rake
+
+It also comes with a set of cucumber features:
+
+    cucumber
+
+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

@@ -25,7 +25,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "behavior"
-    s.version = "0.1.0"
+    s.version = "0.1.1"
     s.author = "Paul Campbell"
     s.email = "paul@rslw.com"
     s.homepage = "http://www.github.com/paulca/behavior"

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

@@ -1,11 +1,5 @@
 <h2>Edit Configuration</h2>
 
-<%- if !flash[:notice].blank? -%>
-  <div class="notice">
-    <%= flash[:notice] %>
-  </div>
-<%- end -%>
-
 <%- form_tag admin_config_path, :method => :put do -%>
 
   <fieldset>

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

@@ -6,6 +6,12 @@
   
   <body>
     <h1>Site Admin</h1>
+    <%- if !flash[:notice].blank? -%>
+      <div class="notice">
+        <%= flash[:notice] %>
+      </div>
+    <%- end -%>
+    
     <%= yield %>
   </body>
 </html>

data/behavior.gemspec

@@ -5,17 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{behavior}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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",
+    "README.md",
      "Rakefile",
      "app/controllers/admin/configs_controller.rb",
      "app/helpers/behavior_helper.rb",

data/spec/debug.log

@@ -1729,3 +1729,95 @@
   BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_name') LIMIT 1
   BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'password') LIMIT 1
   BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'description') LIMIT 1
+  SQL (0.2ms)   select sqlite_version(*)
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (2.7ms)   DROP TABLE "behavior_configs"
+  SQL (1.7ms)   CREATE TABLE "behavior_configs" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "key" varchar(255), "value" varchar(255)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  SQL (0.1ms)   select sqlite_version(*)
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (1.5ms)   DROP TABLE "behavior_configs"
+  SQL (1.4ms)   CREATE TABLE "behavior_configs" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "key" varchar(255), "value" varchar(255)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_name') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'description') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'password') LIMIT 1
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_name') LIMIT 1
+  BehaviorConfig Create (2.7ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES(NULL, 'email_name')
+  BehaviorConfig Update (0.1ms)   UPDATE "behavior_configs" SET "value" = 'Site Administrator' WHERE "id" = 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Create (0.1ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES(NULL, 'email_address')
+  BehaviorConfig Update (0.1ms)   UPDATE "behavior_configs" SET "value" = 'paul@rslw.com' WHERE "id" = 2
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'description') LIMIT 1
+  BehaviorConfig Create (0.1ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES(NULL, 'description')
+  BehaviorConfig Update (0.2ms)   UPDATE "behavior_configs" SET "value" = 'My Awesome Site' WHERE "id" = 3
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'password') LIMIT 1
+  BehaviorConfig Create (0.2ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES(NULL, 'password')
+  BehaviorConfig Update (0.2ms)   UPDATE "behavior_configs" SET "value" = 'password' WHERE "id" = 4
+  BehaviorConfig Load (0.3ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_name') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'description') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'password') LIMIT 1
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.0ms)   DELETE FROM "behavior_configs";
+  SQL (0.2ms)   select sqlite_version(*)
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (1.6ms)   DROP TABLE "behavior_configs"
+  SQL (1.5ms)   CREATE TABLE "behavior_configs" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "key" varchar(255), "value" varchar(255)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  SQL (0.2ms)   select sqlite_version(*)
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (1.2ms)   DROP TABLE "behavior_configs"
+  SQL (1.4ms)   CREATE TABLE "behavior_configs" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "key" varchar(255), "value" varchar(255)) 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   SELECT version FROM "schema_migrations"
+  BehaviorConfig Create (0.4ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.3ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Update (0.1ms)   UPDATE "behavior_configs" SET "value" = 'joe@putplace.com' WHERE "id" = 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Create (0.3ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Create (0.3ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Create (0.4ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Create (0.3ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_address') LIMIT 1
+  BehaviorConfig Create (0.3ms)   INSERT INTO "behavior_configs" ("value", "key") VALUES('paul@rslw.com', 'email_address')
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."id" = 1) 
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'email_name') LIMIT 1
+  BehaviorConfig Load (0.1ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'password') LIMIT 1
+  BehaviorConfig Load (0.2ms)   SELECT * FROM "behavior_configs" WHERE ("behavior_configs"."key" = 'description') LIMIT 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: behavior
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Paul Campbell
@@ -19,10 +19,10 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.textile
+extra_rdoc_files: []
+
 files: 
-- README.textile
+- README.md
 - Rakefile
 - app/controllers/admin/configs_controller.rb
 - app/helpers/behavior_helper.rb

data/README.textile

@@ -1,97 +0,0 @@
-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