configvars_rails 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/configvars_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configvars_rails}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2010-08-08}
+  s.date = %q{2010-08-09}
   s.description = %q{This gem provides a model and simple controller for
       storing global application configuration in a database. This allows the
       configuration to change without source code modifications.}
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "configvars_rails.gemspec",
      "lib/configvars_rails.rb",
      "lib/configvars_rails/controller.rb",
+     "lib/configvars_rails/descriptor.rb",
      "lib/configvars_rails/engine.rb",
      "lib/configvars_rails/generators/all_generator.rb",
      "lib/configvars_rails/generators/templates/001_create_config_vars.rb",
@@ -38,14 +39,16 @@ Gem::Specification.new do |s|
      "lib/configvars_rails/generators/templates/config_vars/edit.html.erb",
      "lib/configvars_rails/generators/templates/config_vars/index.html.erb",
      "lib/configvars_rails/generators/templates/config_vars/new.html.erb",
-     "lib/configvars_rails/generators/templates/config_vars/show.html.erb",
      "lib/configvars_rails/generators/templates/config_vars_controller.rb",
      "lib/configvars_rails/generators/templates/config_vars_controller_test.rb",
+     "lib/configvars_rails/generators/templates/config_vars_initializer.rb",
      "lib/configvars_rails/model.rb",
      "test/config_var_test.rb",
      "test/config_vars_controller_api_test.rb",
+     "test/descriptor_test.rb",
      "test/helpers/application_controller.rb",
      "test/helpers/db_setup.rb",
+     "test/helpers/initializers.rb",
      "test/helpers/routes.rb",
      "test/helpers/view_helpers.rb",
      "test/test_helper.rb"
@@ -58,7 +61,9 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/test_helper.rb",
      "test/config_vars_controller_api_test.rb",
+     "test/descriptor_test.rb",
      "test/helpers/application_controller.rb",
+     "test/helpers/initializers.rb",
      "test/helpers/routes.rb",
      "test/helpers/db_setup.rb",
      "test/helpers/view_helpers.rb",

data/lib/configvars_rails.rb

@@ -3,6 +3,7 @@ module ConfigvarsRails
 end
 
 require 'configvars_rails/controller.rb'
+require 'configvars_rails/descriptor.rb'
 require 'configvars_rails/model.rb'
 
 if defined?(Rails)

data/lib/configvars_rails/controller.rb

@@ -30,27 +30,27 @@ module ControllerInstanceMethods
   # GET /config_vars
   # GET /config_vars.xml
   def index
-    @config_vars = ConfigVar.all
-
-    respond_to do |format|
-      format.html # index.html.erb
+    @config_vars = ConfigVar.order(:name).all
+    
+    defined_names = ConfigvarsRails.variable_names
+    default_names = defined_names - @config_vars.map { |var| var.name.to_sym }
+    @default_vars = {}
+    default_names.map(&:to_s).sort.each do |name|
+      @default_vars[name] = ConfigvarsRails.variable_descriptor(name)
     end
-  end
-
-  # GET /config_vars/1
-  # GET /config_vars/1.xml
-  def show
-    @config_var = ConfigVar.find(params[:id])
 
     respond_to do |format|
-      format.html # show.html.erb
+      format.html # index.html.erb
     end
   end
 
   # GET /config_vars/new
   # GET /config_vars/new.xml
   def new
-    @config_var = ConfigVar.new
+    @config_var = ConfigVar.new :name => params[:name]
+    if params[:name] and descriptor = ConfigvarsRails.variable_descriptor(params[:name])
+      @config_var.value = descriptor.default_value
+    end
 
     respond_to do |format|
       format.html # new.html.erb
@@ -69,7 +69,7 @@ module ControllerInstanceMethods
 
     respond_to do |format|
       if @config_var.save!
-        format.html { redirect_to(@config_var, :notice => 'Configuration variable was successfully created.') }
+        format.html { redirect_to(config_vars_url, :notice => 'Configuration variable was successfully created.') }
       else
         format.html { render :action => :new }
       end
@@ -83,7 +83,7 @@ module ControllerInstanceMethods
 
     respond_to do |format|
       if @config_var.update_attributes(params[:config_var])
-        format.html { redirect_to(@config_var, :notice => 'Config flag was successfully updated.') }
+        format.html { redirect_to(config_vars_url, :notice => 'Configuration variable was successfully updated.') }
       else
         format.html { render :action => :edit }
       end

data/lib/configvars_rails/descriptor.rb

@@ -0,0 +1,62 @@
+# :nodoc: namespace
+module ConfigvarsRails
+  @vars = {}
+  
+  # Configuration variable descriptor.
+  class Descriptor
+    # Creates a new variable descriptor.
+    #
+    # Args:
+    #   type:: the type of values the variable can take
+    #   default_value:: a Proc or default value for the configuration variable
+    def initialize(value_type, default_value)
+      @value_type = value_type.to_sym
+      @default = default_value.dup
+    end
+
+    # The default value to be used if the variable doesn't have an explicit
+    # value.
+    def default_value
+      if @default.kind_of? Proc
+        @default.call
+      else
+        @default.dup
+      end
+    end
+    
+    # The type of values that the variable takes.
+    attr_reader :value_type
+  end
+  
+  # Registers a new configuration variable.
+  def self.add_variable(name, descriptor)
+    @vars[name.to_sym] = descriptor
+  end
+  
+  # The descriptor for a configuration variable.
+  def self.variable_descriptor(name)
+    @vars[name.to_sym]
+  end
+  
+  # The names for all the configuration variables.
+  def self.variable_names
+    @vars.keys
+  end
+end  # namespace ConfigvarsRails
+
+
+# 
+module ConfigVars
+  # Declares a configuration variable with string values.
+  #
+  # Args:
+  #   name:: the variable's name
+  #   default_value:: a string 
+  #
+  # Optionally, takes a block that will be called when the variable's default
+  # value is requested.
+  def self.string(name, default_value = nil, &block)
+    descriptor = ConfigvarsRails::Descriptor.new :string, default_value || block
+    ConfigvarsRails.add_variable name, descriptor
+  end
+end  # namespace ConfigVars

data/lib/configvars_rails/generators/all_generator.rb

@@ -21,13 +21,16 @@ class AllGenerator < Rails::Generators::Base
     copy_file File.join('config_vars_controller_test.rb'),
               File.join('test', 'functional', 'config_vars_controller_test.rb')
     [
-      '_form.html.erb', 'edit.html.erb', 'index.html.erb', 'new.html.erb',
-      'show.html.erb'
+      '_form.html.erb', 'edit.html.erb', 'index.html.erb', 'new.html.erb'
     ].each do |view_name|
       copy_file File.join('config_vars', view_name),
                 File.join('app', 'views', 'config_vars', view_name)
     end
     route 'resources :config_vars'
+    
+    copy_file 'config_vars_initializer.rb',
+              File.join('config', 'initializers', 'config_vars.rb')    
+    
   end
 end  # class ConfigvarsRails::ConfigVarsGenerator
 

data/lib/configvars_rails/generators/templates/config_vars/edit.html.erb

@@ -2,5 +2,4 @@
 
 <%= render 'form' %>
 
-<%= link_to 'Show', @config_var %> |
 <%= link_to 'Back', config_vars_path %>

data/lib/configvars_rails/generators/templates/config_vars/index.html.erb

@@ -1,9 +1,11 @@
-<h1>Listing Configuration Variables</h1>
+<h1>Set Configuration Variables</h1>
 
-<table>
+<table class="configuration_variables">
   <tr>
     <th>Name</th>
+    <th>Type</th>
     <th>Value</th>
+    <th>Default Value</th>
     <th></th>
     <th></th>
     <th></th>
@@ -12,14 +14,39 @@
 <% @config_vars.each do |config_var| %>
   <tr>
     <td><%= config_var.name %></td>
+    <td>
+      <%= config_var.descriptor ? config_var.descriptor.value_type :
+              'undefined' %>
+    </td>
     <td><%= config_var.value %></td>
-    <td><%= link_to 'Show', config_var %></td>
+    <td>
+      <%= config_var.descriptor ? config_var.descriptor.default_value :
+              'undefined' %>
+    </td>
     <td><%= link_to 'Edit', edit_config_var_path(config_var) %></td>
-    <td><%= link_to 'Destroy', config_var, :confirm => 'Are you sure?', :method => :delete %></td>
+    <td><%= link_to 'Reset to default', config_var, :method => :delete %></td>
   </tr>
 <% end %>
 </table>
 
-<br />
+<h1>Available Configuration Variables</h1>
 
-<%= link_to 'New Configuration Variable', new_config_var_path %>
+<table class="configuration_variables">
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Default Value</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @default_vars.each do |name, descriptor| %>
+  <tr>
+    <td><%= name %></td>
+    <td><%= descriptor.value_type %></td>
+    <td><%= descriptor.default_value %></td>
+    <td><%= link_to 'Edit', new_config_var_path(:name => name) %></td>
+  </tr>
+<% end %>
+</table>

data/lib/configvars_rails/generators/templates/config_vars/new.html.erb

@@ -1,4 +1,4 @@
-<h1>New Configuration Variable</h1>
+<h1>Editing Configuration Variable</h1>
 
 <%= render 'form' %>
 

data/lib/configvars_rails/generators/templates/config_vars_controller_test.rb

@@ -5,9 +5,8 @@ class ConfigVarsControllerTest < ActionController::TestCase
     @config_var = config_vars(:app_uri)
   end
   
-  test "cannot access config var without authentication" do
-    get :show, :id => @config_var.to_param
-
+  test "cannot access config vars without authentication" do
+    get :index
     assert_response :unauthorized    
   end
 end

data/lib/configvars_rails/generators/templates/config_vars_initializer.rb

@@ -0,0 +1,4 @@
+# Definitions for configuration variables used in this application.
+
+ConfigVars.string 'simple_var', 'simple_val'
+ConfigVars.string('block_var') { Time.now }

data/lib/configvars_rails/model.rb

@@ -35,10 +35,13 @@ end  # module ConfigvarsRails::Model::ModelClassMethods
 module ModelMetaclassMethods
   # Access configuration flags by ConfigVar['flag_name'].
   def [](name)
-    unless flag = where(:name => name).first
-      raise IndexError, "Configuration variable #{name} not found"
-    end
-    flag.value
+    var = where(:name => name).first
+    return var.value if var
+    
+    descriptor = ConfigvarsRails.variable_descriptor name
+    return descriptor.default_value if descriptor
+    
+    raise IndexError, "Configuration variable #{name} not found"
   end
   
   # Set configuration flags by ConfigVar['flag_name'] = 'flag_value'.
@@ -54,6 +57,10 @@ end  # module ConfigvarsRails::Model::ModelMetaclassMethods
 
 # Included in models that call config_vars_model.
 module ModelInstanceMethods
+  # The descriptor for this variable, or nil if no descriptor was defined.
+  def descriptor
+    ConfigvarsRails.variable_descriptor name
+  end
 end  # module ConfigvarsRails::Model::ModelInstanceMethods
 
 ActiveRecord::Base.send :include, ModelMixin

data/test/config_var_test.rb

@@ -17,6 +17,10 @@ class ConfigVarTest < ActiveSupport::TestCase
   test "convenience get" do
     @var.save!
     assert_equal 'var_value', ConfigVar['var']
+    
+    assert_raise IndexError do
+      assert_equal 'failure', ConfigVar['undefined']
+    end
   end
   
   test "convenience set" do

data/test/config_vars_controller_api_test.rb

@@ -11,19 +11,36 @@ class ConfigVarsControllerApiTest < ActionController::TestCase
 
   setup do
     @config_var = config_vars(:app_uri)
-    request.env['HTTP_AUTHORIZATION'] = encode_credentials('config', 'vars')
+    request.env['HTTP_AUTHORIZATION'] = encode_credentials('config', 'vars')    
   end
 
   test "should get index" do
     get :index
     assert_response :success
-    assert_not_nil assigns(:config_vars)
+    
+    assert assigns(:config_vars).include?(config_vars(:app_uri)),
+           "@config_vars doesn't have a database fixture"
+    assert assigns(:default_vars).has_key?('simple_var'),
+           "@default_vars doesn't have a simple_var"
   end
 
   test "should get new" do
     get :new
     assert_response :success
   end
+  
+  test "new with preset name" do
+    get :new, :name => 'undefined'
+    assert_response :success
+    assert_equal 'undefined', assigns(:config_var).name
+  end
+
+  test "new with preset name and default value" do
+    get :new, :name => 'simple_var'
+    assert_response :success
+    assert_equal 'simple_var', assigns(:config_var).name
+    assert_equal 'simple_val', assigns(:config_var).value
+  end
 
   test "should create config_var" do
     attributes = @config_var.attributes.merge 'name' => 'other_uri'
@@ -31,12 +48,7 @@ class ConfigVarsControllerApiTest < ActionController::TestCase
       post :create, :config_var => attributes
     end
 
-    assert_redirected_to config_var_path(assigns(:config_var))
-  end
-
-  test "should show config_var" do
-    get :show, :id => @config_var.to_param
-    assert_response :success
+    assert_redirected_to config_vars_url
   end
 
   test "should get edit" do
@@ -47,7 +59,7 @@ class ConfigVarsControllerApiTest < ActionController::TestCase
   test "should update config_var" do
     put :update, :id => @config_var.to_param,
                  :config_var => @config_var.attributes
-    assert_redirected_to config_var_path(assigns(:config_var))
+    assert_redirected_to config_vars_url
   end
 
   test "should destroy config_var" do
@@ -55,7 +67,7 @@ class ConfigVarsControllerApiTest < ActionController::TestCase
       delete :destroy, :id => @config_var.to_param
     end
 
-    assert_redirected_to config_vars_path
+    assert_redirected_to config_vars_url
   end
   
   # Verbatim, from ActiveController's own unit tests.

data/test/descriptor_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class DescriptorTest < ActiveSupport::TestCase
+  setup do    
+    @simple_desc = ConfigvarsRails.variable_descriptor 'simple_var'
+    @block_desc = ConfigvarsRails.variable_descriptor 'block_var'
+  end
+  
+  test 'default_value' do
+    assert_equal 'simple_val', @simple_desc.default_value
+    assert_in_delta Time.now, @block_desc.default_value, 0.1,
+                    'first block call'
+  end
+  
+  test 'value_type' do
+    assert_equal :string, @simple_desc.value_type
+  end
+  
+  test 'default_value fallback in ConfigVar[]' do
+    assert_equal 'simple_val', ConfigVar['simple_var']
+  end
+end

data/test/helpers/initializers.rb

@@ -0,0 +1 @@
+require 'configvars_rails/generators/templates/config_vars_initializer.rb'

data/test/test_helper.rb

@@ -13,4 +13,5 @@ require 'helpers/view_helpers.rb'
 # NOTE: application_controller has to follow view_helpers
 require 'helpers/application_controller.rb'
 require 'helpers/db_setup.rb'
+require 'helpers/initializers.rb'
 require 'helpers/routes.rb'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configvars_rails
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Victor Costan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-08 00:00:00 -04:00
+date: 2010-08-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - configvars_rails.gemspec
 - lib/configvars_rails.rb
 - lib/configvars_rails/controller.rb
+- lib/configvars_rails/descriptor.rb
 - lib/configvars_rails/engine.rb
 - lib/configvars_rails/generators/all_generator.rb
 - lib/configvars_rails/generators/templates/001_create_config_vars.rb
@@ -83,14 +84,16 @@ files:
 - lib/configvars_rails/generators/templates/config_vars/edit.html.erb
 - lib/configvars_rails/generators/templates/config_vars/index.html.erb
 - lib/configvars_rails/generators/templates/config_vars/new.html.erb
-- lib/configvars_rails/generators/templates/config_vars/show.html.erb
 - lib/configvars_rails/generators/templates/config_vars_controller.rb
 - lib/configvars_rails/generators/templates/config_vars_controller_test.rb
+- lib/configvars_rails/generators/templates/config_vars_initializer.rb
 - lib/configvars_rails/model.rb
 - test/config_var_test.rb
 - test/config_vars_controller_api_test.rb
+- test/descriptor_test.rb
 - test/helpers/application_controller.rb
 - test/helpers/db_setup.rb
+- test/helpers/initializers.rb
 - test/helpers/routes.rb
 - test/helpers/view_helpers.rb
 - test/test_helper.rb
@@ -131,7 +134,9 @@ summary: Global configuration variables for Rails 3 applications.
 test_files: 
 - test/test_helper.rb
 - test/config_vars_controller_api_test.rb
+- test/descriptor_test.rb
 - test/helpers/application_controller.rb
+- test/helpers/initializers.rb
 - test/helpers/routes.rb
 - test/helpers/db_setup.rb
 - test/helpers/view_helpers.rb

data/lib/configvars_rails/generators/templates/config_vars/show.html.erb

@@ -1,15 +0,0 @@
-<p id="notice"><%= notice %></p>
-
-<p>
-  <b>Name:</b>
-  <%= @config_var.name %>
-</p>
-
-<p>
-  <b>Value:</b>
-  <%= @config_var.value %>
-</p>
-
-
-<%= link_to 'Edit', edit_config_var_path(@config_var) %> |
-<%= link_to 'Back', config_vars_path %>