bcms_settings 0.0.2 → 0.0.3

data/README

@@ -1,243 +1,166 @@
-== 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
+# Cms::Settings for BrowserCMS projects
 
-The result will be a message in your log file along the lines of:
+Cms::Settings provides an interface for storing and retrieving
+arbitrary key value pairs and can be used as a persistent
+global configuration store.
 
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+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.
 
-More information on how to use the logger is at http://www.ruby-doc.org/core/
+For all installed bcms modules loaded as gems as defined by the BrowserCMS'
+module instalation process, this module can create a namespaced key value
+store automatically.
 
-Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+## Installation
 
-* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
-* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+The Settings module installs like most other BrowserCMS modules
+(http://guides.browsercms.org/installing_modules.html)
+except that it does not define any new routes and requires one
+additional step.
 
-These two online (and free) books will bring you up to speed on the Ruby language
-and also on programming in general.
+    gem install bcms_settings
 
+## Set up your application to use the module
 
-== Debugger
+### 1. Edit config/environment.rb
 
-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:
+    config.gem "browsercms"
+    config.gem "bcms_settings"
 
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.find(:all)
-      debugger
-    end
-  end
+### 2. Run the following commands
+
+    script/generate browser_cms
+    rake db:migrate
+
+### 3. Add the following line to the browsercms.rb initializer
+
+    Cms::Settings.synchronize
+
+## Usage
+
+### Cms::Settings.syncronize
+
+Calling this method in an initializer will keep your installed modules
+(as declared on environment.rb) in sync with the Settings module.
+
+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 => {}>
+
+if you uninstall bcms_xyz (by removing it from environment.rb)
+the corresponding settings oject will be destroyed for you.
+
+To know which bcms_modules the Settings module knows about:
 
-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:
+    Cms::Settings.modules => ['bcms_s3', 'bcms_seo_sitemap']
 
-  >> @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"
+### Storing, retrieving and deleting values
 
-...and even better is that you can examine how your runtime objects actually work:
+To store values in these objects just call arbitrary methods (which will become
+keys) and assign values. It is possile to store scalar values, arrays and
+hashes. Values ar persisted automatically.
 
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
+    Cms::Settings.bcms_s3.account_id = "ACCOUNT_ID"
+    Cms::Settings.bcms_s3.buckets = %w[bucket1 bucket2]
 
-Finally, when you're ready to resume execution, you enter "cont"
+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"]}>
 
-== Console
+To retrieve values:
 
-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>.
+    Cms::Settings.bcms_s3.account_id
+    => "ACCOUNT_ID"
 
-To reload your controllers and models after launching the console run <tt>reload!</tt>
+    Cms::Settings.bcms_s3.buckets.first
+    => "bucket1"
 
-== dbconsole
+To update keys, just assign new values:
 
-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.
+    Cms::Settings.bcms_s3.account_id = "NEW_ID"
+    Cms::Settings.bcms_s3.account_id
+    => "NEW_ID"
 
-== Description of Contents
+To delete values, call the delete method on the settings object:
 
-app
-  Holds all the code that's specific to this particular application.
+    Cms::Settings.bcms_s3.delete("buckets")
+    Cms::Settings.bcms_s3
+    => #<Cms::Settings: bcms_s3 => {"account_id"=>"NEW_ID"}
 
-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.
+Keys can have almost any name, except for these:
+["inspect", "__send__", "delete", "instance_eval", "__metaclass__", "method_missing"]
 
-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.
+### Registering and deleting modules
 
-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.
+It is also possible to register and delete modules manually in addition to or
+as an alternative to caling Settings.synchronize.
 
-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.
+To register modules:
 
-config
-  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+    Cms::Settings.register("bcms_my_module")
 
-db
-  Contains the database schema in schema.rb.  db/migrate contains all
-  the sequence of Migrations for your schema.
+then you can store, retrieve and delete arbitrary values:
 
-doc
-  This directory is where your application documentation will be stored when generated
-  using <tt>rake doc:app</tt>
+    config = Cms::Settings.bcms_my_module
+    config.client = "Widgets INC"
+    config.url = "http://example.com"
+    config.sections = %w[A B C]
 
-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.
+    config.url
+    => "http://example.com
 
-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.
+    config.delete("url")
 
-script
-  Helper scripts for automation and generation.
+    config.url
+    => nil
+
+In reality, 'registering a module' only creates an object where
+to store values, so you can request sorage to the Settings module for
+whatever porpose you like, povinding that:
+
+  1. The name you are trying to register is a valid BrowserCMS module
+  name and a valid Ruby method identifier, so this is valid:
+
+      Cms::Settings.register("bcms_my_config")
+
+  but this is not:
+
+      Cms::Settings.register("My Config")
+
+  2. The name you are trying to register has not been registered
+  previously. Names passed to the register method must be unique.
+
+
+To delete modules:
+
+    Cms::Settings.delete("bcms_my_config") #all values will be lost
+
+    Cms::Settings.bcms_by_config #Raises an exception
+    => ModuleNotRegistered
+
+
+## Module development
+
+If you are developing a BrowserCMS module and want to use the Settings
+API you'll need to include something like this in an initializer while
+on development:
+
+    unless Cms::Settings.modules.include?('bcms_my_module')
+      Cms::Settings.register('bcms_my_module')
+    end
 
-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/lib/bcms_settings/cms/settings.rb

@@ -1,58 +1,4 @@
 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
 
@@ -115,16 +61,48 @@ module Cms
     # 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
+    # Cms::Settings.bcms_foo will be prsisted in the the database 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:
+    # Modules can only be registered once:
     # Cms::Settings.modules =>  ["bcms_s3", "bcms_seo_sitemap"]
     # Cms::Settings.register("bcms_s3") => ModuleConfigurationExists
+    #
+    # ******************
+    # **IMPORTANT NOTE**
+    # ******************
+    # When developing modules that use the Settings API, it is necessary to
+    # register them manually since they can't declare themselves as
+    # dependencies. This can be done in an initializer, however, since
+    # modules can only be registered once, every time the modules' project
+    # boots, an exception will be raised.
+    #
+    # One possible workaround is to check if the module is registered already:
+    #
+    # unless Cms::Settings.modules.include?('bcms_seo_sitemap')
+    #   Cms::Settings.register('bcms_seo_sitemap')
+    # end
+    #
+    # A marginally better approach would be something like:
+    #
+    # unless Cms::Settings.registered?('bcms_seo_sitemap')
+    #   Cms::Settings.register('bcms_seo_sitemap')
+    # end
+    #
+    # Another possibility is to have the register method fail silently if the
+    # module already exists or just log a warning.
+    #
+    # I do like the exceptions approach because it makes it evident that
+    # somehow, somewhere, for some reason, someone registered that module
+    # previously and may be using the configuration object for something.
+    #
+    # This is particularly important because in reality, 'registered modules'
+    # need not to even be modules at all. Someone may just register
+    # 'bcms_my_configuration' for whatever purpose even from the console.
 
     def register(module_name)
       register_modules [module_name], false
@@ -186,7 +164,7 @@ module Cms
 
     def installed_modules
       Rails.configuration.gems.map do |g|
-        g.name if g.name =~ /^bcms_/
+        g.name if g.name =~ /^bcms_/ && g.name != 'bcms_settings'
       end.compact.uniq
     end
 
@@ -198,16 +176,18 @@ module Cms
     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."
+      if CmsModule.table_exists?
+        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
     end

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

@@ -88,14 +88,53 @@ class SettingsTest < ActiveSupport::TestCase
     end
   end
 
-  test "raises NoMethodError for undefined methods that do not conform with BCMS module naming convention " do
+  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
+  #TODO: The following tests for CmsModuleProxy should probably be split to a different file.
+
+  test "should store values for arbitrary keys" do
+    register_modules 'bcms_s3'
+    Cms::Settings.bcms_s3.account_id = "ACCOUNT_ID"
+    assert_equal "ACCOUNT_ID", Cms::Settings.bcms_s3.account_id
+  end
+
+  test "sohould store arrays" do
+    register_modules 'bcms_blog'
+    config = Cms::Settings.bcms_blog
+    config.options = %w[A B C]
+    assert_equal "C", config.options.last
+  end
+
+  test "should update values" do
+    register_modules 'bcms_blog'
+    config = Cms::Settings.bcms_blog
+    config.authors = ['Sue', 'Mike']
+    assert_equal 'Sue', config.authors[0]
+    config.authors[0] = 'Zoe'
+    assert_equal 'Zoe', config.authors[0]
+  end
 
+  test "should destroy key value pairs" do
+    register_modules 'bcms_wibble'
+    config = Cms::Settings.bcms_wibble
+    config.depth = 3
+    assert_equal 3, config.depth
+    config.delete("depth")
+    assert !config.depth
+  end
+
+  test "should raise NoMethodError for methods with arity > 1" do
+    register_modules 'bcms_wibble'
+    assert_raise(NoMethodError) do
+      Cms::Settings.bcms.wibble.something('a', 'b')
+    end
+  end
+
+  private
   def register_modules(*names)
     names.each {|n| CmsModule.create(:name => n, :settings => {})}
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcms_settings
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - BrowserMedia