bcms_settings 0.0.1

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,243 @@
+== 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, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== 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/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) 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 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(: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 you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that 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 enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+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.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/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>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+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.
+  Most models will descend from ActiveRecord::Base.
+
+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.
+
+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 script/generate 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. Contains subdirectories for images, stylesheets,
+  and javascripts. 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 script/generate scripts, 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.

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/cms_module.rb

@@ -0,0 +1,19 @@
+
+# CmsModule objects represent bcms modules registered with the Cms:Settings module.
+# These objects are not ment to be accessed directly, but through Cms:Settings'
+# public interface.
+
+class CmsModule < ActiveRecord::Base
+
+  NAME_REGEX = /^bcms_[a-z0-9_]+/
+
+  validates_uniqueness_of :name
+  validates_presence_of :name
+  validates_format_of :name, :with => NAME_REGEX
+
+  serialize :settings
+
+  named_scope :managed, :conditions => {:cms_managed => true},
+                        :select => 'name'
+end
+

data/db/migrate/20101129011429_create_cms_modules.rb

@@ -0,0 +1,14 @@
+class CreateCmsModules < ActiveRecord::Migration
+  def self.up
+    create_table :cms_modules do |t|
+      t.string :name, :limit => 50
+      t.text :settings
+      t.boolean :cms_managed, :default => true
+    end
+  end
+
+  def self.down
+    drop_table :cms_modules
+  end
+end
+

data/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

data/lib/bcms_settings.rb

@@ -0,0 +1,2 @@
+require 'bcms_settings/routes'
+require 'bcms_settings/cms/settings'

data/lib/bcms_settings/cms/settings.rb

@@ -0,0 +1,265 @@
+module Cms
+  #  Cms::Settings provides an interface for storing and retrieving
+  #  arbitrary key value pairs and can be used as a persistent
+  #  global configuration store.
+  #
+  #  Cms::Settings stores key value pairs in attributes of ActiveRecord
+  #  objects. These objects, however, are not designed to be used
+  #  directly. Rather, this module provides an interface for easy
+  #  access to the storage objects.
+  #
+  #  For all installed bcms modules loaded as gems as defined by the BrowserCMS'
+  #  module instalation process, this module creates a namespaced key value
+  #  store automatically.
+  #
+  #  To know which bcms_modules the Settings module knows about:
+  #  Cms::Settings.modules => [] #an empty array for new projects.
+  #
+  #  If a BrowserCMS project declares the following gem dependencies
+  #  in environment.rb:
+  #
+  #  gem.bcms_s3
+  #  gem.bcms_seo_sitemap
+  #
+  #  Client code can access the following objects automatically:
+  #
+  #  Cms::Settings.bcms_s3 => #<Cms::Settings: bcms_s3 => {}>
+  #  Cms::Settings.bcms_seo_sitemap => #<Cms::Settings: bcms_seo_sitemap => {}>
+  #
+  #  To store key, value pairs just call an "=" method with an arbitrary name
+  #  and value:
+  #
+  #  Cms::Settings.bcms_s3.account_id = "ACCOUNT_ID"
+  #  Cms::Settings.bcms_s3.buckets = %w[bucket1 bucket2]
+  #
+  #  After adding these two values, the object looks like this:
+  #
+  #  Cms::Settings.bcms_s3 => <Cms::Settings: bcms_s3 => {"account_id"=>"ACCOUNT_ID", "buckets"=>["bucket1", "bucket2"]}>
+  #
+  #  To retrieve values:
+  #
+  #  Cms::Settings.bcms_s3.account_id => "ACCOUNT_ID"
+  #  Cms::Settings.bcms_s3.buckets.first = "bucket1"
+  #
+  #  To update keys, just assign new values:
+  #
+  #  Cms::Settings.bcms_s3.account_id = "NEW_ID"
+  #  Cms::Settings.bcms_s3.account_id => "NEW_ID"
+  #
+  #  To delete values, call the delete method on the settings object:
+  #
+  #  Cms::Settings.bcms_s3.delete("buckets")
+  #  Cms::Settings.bcms_s3 => #<Cms::Settings: bcms_s3 => {"account_id"=>"NEW_ID"}
+  #
+  #  Keys can have almost any name, except:
+  #  ["inspect", "__send__", "delete", "instance_eval", "__metaclass__", "method_missing", "__id__"]
+
+  module Settings
+
+    # Raised when an attempt is made to access configuration for a module
+    # that has not been previously registered or is not installed.
+    class ModuleNotRegistered < StandardError; end
+
+    # Raised when an attempt is made to register a moudle that has already
+    # been registered.
+    class ModuleConfigurationExists < StandardError; end
+
+    # Raised when a module name is not a valid BrowserCMS module name.
+    # All module names must be lowercase, start with the bcms_ prefix and
+    # must not contain whitespace or special characters. (Must be valid
+    # Ruby method identifiers).
+    #
+    # Although the CmsModule model class validates module names, the Settings
+    # module checks all names before passing them to the CmsModule and raises
+    # this exception right away.
+    class InvalidModuleName < StandardError; end
+
+    extend self
+
+    # cms managed modules are those that are declared as dependencies on
+    # environment.rb. The synchronize method keeps these installed modules
+    # in sync with the database automatically, creating a record for declared
+    # dependencies and deleting records for bcms_modules that are no longer
+    # installed.
+    #
+    # Cms::Settings.synchronize can be called as part of BrowserCMS'
+    # initialization process.
+    #
+    # If this method is never called, there won't be any cms managed 'automatic'
+    # modules, in which case all modules must register themselves calling
+    # Cms::Settings.register("bcms_xyz")
+    #`
+    # Conversely, if this method is called, all installed bcms modules will
+    # get a configuration object whether they need it or not.
+
+    def synchronize
+      register_modules(installed_modules - registered_modules)
+      remove_modules(managed_modules - installed_modules)
+    end
+
+    # Retruns an array of module names the Cms::Settings module knows
+    # about.
+    #
+    # [in environment.rb]
+    # gem.bcms_s3
+    # gem.bcms_news
+    #
+    # Cms::Settings.modules => ["bcms_s3", "bcms_news"]
+    # Cms::Settings.register("bcms_blog")
+    # Cms::Settings.modules => ["bcms_s3", "bcms_news", "bcms_blog"]
+
+    def modules
+      registered_modules
+    end
+
+    # Manually registered modules are ignored by the synchronize method.
+    #
+    # Cms::Settings.register("bcms_foo")
+    # Cms::Settings.bcms_foo will be prsisted in the thatabase until
+    # manually deleted.
+    #
+    # Manually registered module names must conform to BCMS's module naming
+    # conventions, so this call will raise an InvalidModuleName exception:
+    # Cms::Settings.register("foo") => InvalidModuleName
+    #
+    # Module names must also be unique:
+    # Cms::Settings.modules =>  ["bcms_s3", "bcms_seo_sitemap"]
+    # Cms::Settings.register("bcms_s3") => ModuleConfigurationExists
+
+    def register(module_name)
+      register_modules [module_name], false
+    end
+
+    # Destroys the CmsModule object.
+    # Trying to delete a module that has not been registered raises an
+    # exception:
+    #
+    # Cms::Settings.modules =>  ["bcms_s3", "bcms_seo_sitemap"]
+    # Cms::Settings.delete("bcms_news") => ModuleNotRegistered
+    #
+    # At the moment it is possible to delete cms managed modules
+    # although they will be automatically registered again if
+    # Cms::Settings.synchronize is called.
+
+    def delete(module_name)
+      remove_modules [module_name.to_s]
+    end
+
+    # This method_missing implementation enables client code to call
+    # arbitrary methods on the Settings module. Undefined methods
+    # whose name does not conform to BCMS's module naming convention
+    # are handled elsewhere (presumably rasing a NoMethodError exception)
+    #
+    # If a module with name equal to the called method has been registered
+    # previously, a module method with the same name is defined (so it does not
+    # go through method missing again) and a proxy object is returned.
+    #
+    # If the module has not been registered previously, a ModuleNotRegistered
+    # exception is raised.
+    #
+    # Given:
+    # Cms::Settings.modules => ["bcms_s3", "bcms_seo_sitemap"]
+    #
+    # Cms::Settings.bcms_s3 =>  #<Cms::Settings: bcms_s3 => {"account_id"=>"NEW_ID"}
+    # Cms::Settings.bcms_news => ModuleNotRegistered
+    # Cms::Settings.foo => NoMethodError
+
+    def method_missing(method_id, *args)
+      method_name = method_id.to_s
+      unless method_name =~ CmsModule::NAME_REGEX
+        super(method_id, *args)
+      end
+      define_method(method_name) do
+        CmsModuleProxy.new(find_module(method_name))
+      end
+      send(method_name)
+    end
+
+    private
+    def registered_modules
+      CmsModule.all(:select => 'name').map { |m| m.name }
+    end
+
+    def managed_modules
+      CmsModule.managed.map {|m| m.name}
+    end
+
+    def installed_modules
+      Rails.configuration.gems.map do |g|
+        g.name if g.name =~ /^bcms_/
+      end.compact.uniq
+    end
+
+    def remove_modules(module_names)
+      module_names.each do |name|
+        verify_module_name(name)
+        find_module(name).destroy
+      end
+    end
+
+    def register_modules(module_names, managed = true)
+      module_names.each do |name|
+        verify_module_name(name)
+        begin
+          CmsModule.create!(:name => name.to_s,
+                            :settings => {},
+                            :cms_managed => managed)
+
+        rescue ActiveRecord::RecordInvalid
+          raise ModuleConfigurationExists,
+            "The module #{name} is already registered."
+        end
+      end
+    end
+
+    def verify_module_name(module_name)
+      unless module_name.to_s =~ CmsModule::NAME_REGEX
+        raise InvalidModuleName,
+          "#{module_name} is not a valid BrowserCMS module name. " +
+          "No modules were registered or deleted."
+      end
+    end
+
+    def find_module(module_name)
+      CmsModule.find_by_name!(module_name)
+    rescue ActiveRecord::RecordNotFound
+      raise ModuleNotRegistered,
+        "The module '#{module_name}' is not registered. " +
+        "Call Cms::Settings.register(#{module_name})."
+    end
+
+    # Calls to Cms::Settings.bcms_yxz, where bcms_yxz is a previously
+    # registered cms module, do not return ActiveRecord objects. Instead,
+    # the CmsModule object is wrapped in an instance of the CmsModuleProxy
+    # class, which provides acces to the underlying serialized hash through
+    # arbitrary method names.
+    class CmsModuleProxy < BlankSlate
+      def initialize(cms_module)
+        @cms_module = cms_module
+      end
+
+      def delete(key)
+        @cms_module.settings.delete(key)
+        @cms_module.save
+      end
+
+      def inspect
+        "#<Cms::Settings: #{@cms_module.name} => #{@cms_module.settings.inspect}>"
+      end
+
+      def method_missing(method_id, *args)
+        num_args = args.length
+        method_name = method_id.to_s
+        if method_name.chomp!("=")
+          @cms_module.settings[method_name] = args.first
+          @cms_module.save
+        elsif num_args == 0
+          @cms_module.settings[method_name]
+        else
+          super(method_id, *args)
+        end
+      end
+    end
+  end
+end
+

data/lib/bcms_settings/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_settings
+    namespace(:cms) do |cms|
+      #cms.content_blocks :settings
+    end  
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+
+Cms::Settings.synchronize if CmsModule.table_exists?

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/cms_module_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class CmsModuleTest < ActiveSupport::TestCase
+
+  def valid_attributes
+    {
+      :name => 'bcms_blog',
+      :settings => {}
+    }
+  end
+
+  def setup
+    @blog_module = CmsModule.new(valid_attributes)
+  end
+
+  test "should be valid with valid attributes" do
+    assert @blog_module.valid?
+  end
+
+  test "should not be valid without a cms_name" do
+    @blog_module.name = ""
+    assert !@blog_module.valid?
+  end
+
+  test "should not be valid if cms_name is not a valid BCMS module name" do
+    @blog_module.name = "bcms s3"
+    assert !@blog_module.valid?
+    @blog_module.name = "BCMS_S3"
+    assert !@blog_module.valid?
+    @blog_module.name = "s3"
+    assert !@blog_module.valid?
+    @blog_module.name = "bcms-s3"
+    assert !@blog_module.valid?
+    @blog_module.name = "bcms_s3"
+    assert @blog_module.valid?
+  end
+
+  test "should not be valid if cms_name is not unique" do
+    @blog_module.save
+    assert !CmsModule.new(valid_attributes).valid?
+  end
+
+end
+

data/test/unit/lib/cms/settings_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+require 'mocha'
+
+class SettingsTest < ActiveSupport::TestCase
+
+  def setup
+    @modules = %w[bcms_blog bcms_s3 bcms_seo_sitemap]
+  end
+
+  test "modules returns an array of registered module names"do
+    register_modules *@modules
+    assert_equal @modules, Cms::Settings.modules
+  end
+
+  test "synchronize registers modules from loadaed gems" do
+    Cms::Settings.expects(:installed_modules).returns(@modules).twice
+    Cms::Settings.synchronize
+    assert_equal @modules, Cms::Settings.modules
+  end
+
+  test "synchronize deletes modules not loaded as gems" do
+    register_modules *@modules
+    installed_modules = %w[bcms_blog bcms_s3]
+    Cms::Settings.expects(:installed_modules).returns(installed_modules).twice
+    Cms::Settings.synchronize
+    assert_equal installed_modules, Cms::Settings.modules
+  end
+
+  test "register registers a module and flags it as non managed" do
+    Cms::Settings.register('bcms_blog')
+    assert_equal ['bcms_blog'], Cms::Settings.modules
+    assert !CmsModule.first.cms_managed?
+  end
+
+  test "register raises InvalidModuleName if name does not conform to BCMS's module naming convention" do
+    assert_raise(Cms::Settings::InvalidModuleName) do
+      Cms::Settings.register("invalid name")
+    end
+  end
+
+  test "register raises ModuleConfigurationExists if the module is already registered" do
+    register_modules *@modules
+    assert_raise(Cms::Settings::ModuleConfigurationExists) do
+      Cms::Settings.register('bcms_blog')
+    end
+  end
+
+  test "synchronize does not delete modules flagged as not managed" do
+    Cms::Settings.register('bcms_blog')
+    Cms::Settings.synchronize
+    assert_equal ['bcms_blog'], Cms::Settings.modules
+  end
+
+  test "delete destroys the module" do
+    Cms::Settings.register('bcms_blog')
+    assert_equal ['bcms_blog'], Cms::Settings.modules
+    Cms::Settings.delete('bcms_blog')
+    assert_equal [], Cms::Settings.modules
+  end
+
+  test "trying to delete a module that has not been registered raises ModuleNotRegistered" do
+    assert_raise(Cms::Settings::ModuleNotRegistered) do
+      Cms::Settings.delete('bcms_blog')
+    end
+  end
+
+  test "defines methods for accessing user registered modules" do
+    Cms::Settings.register('bcms_blog')
+    assert !Cms::Settings.respond_to?(:bcms_blog)
+    Cms::Settings.bcms_blog
+    assert Cms::Settings.respond_to?(:bcms_blog)
+  end
+
+  test "defines methods for cms managed modules" do
+    Cms::Settings.expects(:installed_modules).returns(@modules).twice
+    Cms::Settings.synchronize
+    assert !Cms::Settings.respond_to?(:bcms_s3)
+    Cms::Settings.bcms_s3
+    assert Cms::Settings.respond_to?(:bcms_s3)
+    assert !Cms::Settings.respond_to?(:bcms_seo_sitemap)
+    Cms::Settings.bcms_seo_sitemap
+    assert Cms::Settings.respond_to?(:bcms_seo_sitemap)
+  end
+
+  test "raises ModuleNotRegistered if a method with name of not installed module is called" do
+    assert_raise(Cms::Settings::ModuleNotRegistered) do
+      Cms::Settings.bcms_not_registered
+    end
+  end
+
+  test "raises NoMethodError for undefined methods that do not conform with BCMS module naming convention " do
+    assert_raise(NoMethodError) do
+      Cms::Settings.wibble
+    end
+  end
+
+  private
+
+  def register_modules(*names)
+    names.each {|n| CmsModule.create(:name => n, :settings => {})}
+  end
+
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_settings
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: browsercms
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 1
+        - 2
+        version: 3.1.2
+  type: :runtime
+  version_requirements: *id001
+description: This module provides a global persisted key value store that can be used to keep configuration key value pairs
+email: github@browsermedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- app/controllers/application_controller.rb
+- app/helpers/application_helper.rb
+- app/models/cms_module.rb
+- db/migrate/20101129011429_create_cms_modules.rb
+- doc/README_FOR_APP
+- lib/bcms_settings.rb
+- lib/bcms_settings/cms/settings.rb
+- lib/bcms_settings/routes.rb
+- rails/init.rb
+- LICENSE.txt
+- README
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/cms_module_test.rb
+- test/unit/lib/cms/settings_test.rb
+has_rdoc: true
+homepage: http://browsercms.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: browsercms
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Global settings storage for BrowserCMS
+test_files: 
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/cms_module_test.rb
+- test/unit/lib/cms/settings_test.rb