configurable_engine 0.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'jeweler'
+gem 'rspec'
+gem 'cucumber'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber
+  jeweler
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Campbell
+
+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,90 @@
+# Configurable #
+
+A Rails 3 configuration plugin. An update to [Behavior](http://github.com/paulca/behavior).
+
+## How it works ##
+
+Configurable lets you define app-wide configuration variables and values in `config/configurable.yml`. These can then be accessed throughout your app.
+
+If you or your app users need to change these variables, Configurable stores new values in the database.
+
+## Installation ##
+
+Configurable is available as a Ruby gem. Simply add it to your Rails 3 app's `Gemfile`:
+
+    gem 'configurable'
+
+Then run the `configurable_engine:install` generator:
+
+    rails generate configurable:install
+
+## 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:
+    name: Site Title
+    default: My Site
+  
+Now, within your app, you can access `Configurable[:site\_title]` (or `Configurable.site_title` if you prefer).
+
+If you want to update the config, create a Configurable record in the database:
+
+    Configurable.create!(:name => 'site_title', :value => 'My New Site')
+    
+## Web Interface ##
+
+Using Rails 3's Engines feature, Configurable comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/configurable`.
+
+If you want to add a layout, or protect the configurable controller, create `app/controllers/admin/application_controller.rb` which would look something like this:
+
+    class Admin::ApplicationController < ApplicationController
+      before_filter :protect_my_code
+      layout 'admin'
+    end
+
+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"
+
+    Value:
+      name: A number            # sets the edit label
+      default: 10               # sets the default value
+      type: integer             # coerces the value to an integer
+
+    Price:
+      name: A price             # sets the edit label
+      default: "10.00"          # sets the default value
+      type: decimal             # coerces the value to a decimal
+
+## Running the Tests ##
+
+The tests for this rails engine are in the `dummy` directory, which is a dummy Rails app with Configurable loaded in the Gemfile.
+
+Within the `dummy` folder, run:
+
+    rake db:schema:load
+    rake db:test:prepare
+    bundle exec rspec spec
+    bundle exec cucumber features
+
+== Copyright
+
+Copyright (c) 2011 Paul Campbell. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "configurable_engine"
+  gem.homepage = "http://github.com/paulca/configurable_engine"
+  gem.license = "MIT"
+  gem.summary = %Q{Database-backed configuration for Rails 3, with defaults from config file.}
+  gem.description = %Q{Configurable allows you to set up config variables in a config file, specifying default values for all environments. These variables can then be set on a per-app basis using a user facing configuration screen. }
+  gem.email = "paul@rslw.com"
+  gem.authors = ["Paul Campbell"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'rails', '~>3.0.0'
+  gem.files = FileList["[A-Za-z]*", "app/**/*", "config/*"]
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configurable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/admin/application_controller.rb

@@ -0,0 +1,2 @@
+class Admin::ApplicationController < ::ApplicationController
+end

data/app/controllers/admin/configurables_controller.rb

@@ -0,0 +1,15 @@
+class Admin::ConfigurablesController < Admin::ApplicationController
+  
+  def show
+    
+  end
+  
+  def update
+    Configurable.keys.each do |key|
+      Configurable.find_or_create_by_name(key).
+                   update_attribute(:value,params[key])
+    end
+    redirect_to admin_configurable_path
+  end
+  
+end

data/app/models/configurable.rb

@@ -0,0 +1,38 @@
+class Configurable < ActiveRecord::Base
+  
+  def self.defaults
+    HashWithIndifferentAccess.new(
+      YAML.load_file(
+        Rails.root.join('config', 'configurable.yml')
+      )
+    )
+  end
+  
+  def self.keys
+    self.defaults.collect { |k,v| k.to_s }
+  end
+  
+  def self.[](key)
+    value = find_by_name(key).try(:value) || self.defaults[key][:default]
+    case self.defaults[key][:type]
+    when 'boolean'
+      value == true or value == 1 or value == "1" or value == "t"
+    when 'decimal'
+      BigDecimal.new(value.to_s)
+    when 'integer'
+      value.to_i
+    else
+      value
+    end
+  end
+  
+  def self.method_missing(name, *args)
+    name_stripped = name.to_s.gsub('?', '')
+    if self.keys.include?(name_stripped)
+      self[name_stripped]
+    else
+      super
+    end
+  end
+  
+end

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

@@ -0,0 +1,16 @@
+<h2>Config</h2>
+
+<%= form_tag(admin_configurable_path, :method => :put) do -%>
+  <%- Configurable.defaults.each do |key, options| -%>
+    <%= label_tag key, options[:name] %>
+    <%- if options[:type] == 'password' -%>
+      <%= text_area_tag key, Configurable.send(key) %>
+    <%- elsif options[:type] == 'text' -%>
+      <%= password_field_tag key, Configurable.send(key) %>
+    <%- else -%>
+      <%= text_field_tag key, Configurable.send(key) %>
+    <%- end -%>
+  <%- end -%>
+  
+  <%= submit_tag 'Save' %>
+<%- end -%>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    resource :configurable
+  end
+end

data/configurable_engine.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configurable_engine}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Campbell"]
+  s.date = %q{2011-01-10}
+  s.description = %q{Configurable allows you to set up config variables in a config file, specifying default values for all environments. These variables can then be set on a per-app basis using a user facing configuration screen. }
+  s.email = %q{paul@rslw.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/admin/application_controller.rb",
+    "app/controllers/admin/configurables_controller.rb",
+    "app/models/configurable.rb",
+    "app/views/admin/configurables/show.html.erb",
+    "config/routes.rb",
+    "configurable_engine.gemspec"
+  ]
+  s.homepage = %q{http://github.com/paulca/configurable_engine}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Database-backed configuration for Rails 3, with defaults from config file.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
+  end
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: configurable_engine
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: "Configurable allows you to set up config variables in a config file, specifying default values for all environments. These variables can then be set on a per-app basis using a user facing configuration screen. "
+email: paul@rslw.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- app/controllers/admin/application_controller.rb
+- app/controllers/admin/configurables_controller.rb
+- app/models/configurable.rb
+- app/views/admin/configurables/show.html.erb
+- config/routes.rb
+- configurable_engine.gemspec
+has_rdoc: true
+homepage: http://github.com/paulca/configurable_engine
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -271690143338276698
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Database-backed configuration for Rails 3, with defaults from config file.
+test_files: []
+