configvars_rails 0.4.5 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.5.0

data/configvars_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configvars_rails}
-  s.version = "0.4.5"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Victor Costan}]
-  s.date = %q{2011-06-30}
+  s.date = %q{2011-07-06}
   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|
     "app/helpers/config_vars_helper.rb",
     "configvars_rails.gemspec",
     "lib/configvars_rails.rb",
+    "lib/configvars_rails/auth.rb",
     "lib/configvars_rails/controller.rb",
     "lib/configvars_rails/descriptor.rb",
     "lib/configvars_rails/engine.rb",

data/lib/configvars_rails/auth.rb

@@ -0,0 +1,27 @@
+require 'action_controller'
+
+# :nodoc: add config_vars_auth ro ActiveController class methods
+class ActionController::Base
+  # HTTP Basic for controller actions, using config_vars credentials.
+  def self.config_vars_auth(*args)
+    include ConfigvarsRails::AuthInstanceMethods
+    before_filter :config_vars_http_basic_check, *args
+  end
+end
+
+# :nodoc: namespace
+module ConfigvarsRails
+
+# Included in controllers that call config_vars_controller.
+module AuthInstanceMethods
+  def config_vars_http_basic_check
+    authenticate_or_request_with_http_basic(
+        ConfigVar['config_vars.http_realm']) do |user, password|
+      user == ConfigVar['config_vars.http_user'] &&
+          password == ConfigVar['config_vars.http_password']
+    end
+  end
+  private :config_vars_http_basic_check
+end  # module ConfigvarsRails::AuthInstanceMethods
+
+end  # namespace ConfigvarsRails

data/lib/configvars_rails/controller.rb

@@ -1,121 +1,89 @@
-require 'action_controller'
+require 'active_support'
 
 # :nodoc: namespace
 module ConfigvarsRails
 
-# :nodoc: namespace
-module Session
-
-# Mixed into ActiveController::Base
-module ControllerMixin
-  def self.included(base)
-    base.send :extend, ControllerClassMethods
-  end
-end
-
-# Methods here become ActiveController::Base class methods.
-module ControllerClassMethods  
+# Included by the config vars management controller.
+#
+# Some parts of the codebase expect the controller to be named 
+# ConfigVarsController.
+module Controller
+  extend ActiveSupport::Concern
   
-  # Turns the current controller into the config vars management controller.
-  #
-  # Right now, this should be called from ConfigVarsController. The controller
-  # name is hardwired in other parts of the implementation.
-  def config_vars_controller
-    include ControllerInstanceMethods
+  included do
     layout 'config_vars'
   end
-  
-  # HTTP Basic for controller actions, using config_vars credentials.
-  def config_vars_auth(*args)
-    include AuthInstanceMethods
-    before_filter :config_vars_http_basic_check, *args
-  end
-end
-
-# Included in controllers that call config_vars_controller.
-module ControllerInstanceMethods
-  # GET /config_vars
-  def index
-    @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 { |name|
-      [name.to_s, ConfigvarsRails.variable_descriptor(name)]
-    }.sort
 
-    respond_to do |format|
-      format.html # index.html.erb
-    end
-  end
-    
-  # GET /config_vars/http_user
-  def show
-    edit
-    render :text => @config_var.value
-  end
-
-  # GET /config_vars/http_user/edit
-  def edit
-    @config_var = ConfigVar.where(:name => params[:name]).first
-    unless @config_var
-      @config_var = ConfigVar.new :name => params[:name]
-      if descriptor = ConfigvarsRails.variable_descriptor(params[:name])
-        @config_var.value = descriptor.default_value
+  # Included in controllers that include ConfivarsRails::Controller.
+  module InstanceMethods
+    # GET /config_vars
+    def index
+      @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 { |name|
+        [name.to_s, ConfigvarsRails.variable_descriptor(name)]
+      }.sort
+  
+      respond_to do |format|
+        format.html # index.html.erb
       end
-    end      
-  end
-
-  # PUT /config_vars/http_user
-  def update
-    @config_var = ConfigVar.where(:name => params[:name]).first
-    unless @config_var
-      @config_var = ConfigVar.new params[:config_var]
-      @config_var.name = params[:name]
     end
-
-    respond_to do |format|
-      success = if @config_var.new_record?
-        @config_var.save
-      else
-        @config_var.update_attributes(params[:config_var])
+      
+    # GET /config_vars/http_user
+    def show
+      edit
+      render :text => @config_var.value
+    end
+  
+    # GET /config_vars/http_user/edit
+    def edit
+      @config_var = ConfigVar.where(:name => params[:name]).first
+      unless @config_var
+        @config_var = ConfigVar.new :name => params[:name]
+        if descriptor = ConfigvarsRails.variable_descriptor(params[:name])
+          @config_var.value = descriptor.default_value
+        end
+      end      
+    end
+  
+    # PUT /config_vars/http_user
+    def update
+      @config_var = ConfigVar.where(:name => params[:name]).first
+      unless @config_var
+        @config_var = ConfigVar.new params[:config_var]
+        @config_var.name = params[:name]
       end
-      if success
-        format.html do
-          redirect_to config_vars_url,
-              :notice => 'Configuration variable was successfully updated.'
+  
+      respond_to do |format|
+        success = if @config_var.new_record?
+          @config_var.save
+        else
+          @config_var.update_attributes(params[:config_var])
+        end
+        if success
+          format.html do
+            redirect_to config_vars_url,
+                :notice => 'Configuration variable was successfully updated.'
+          end
+        else
+          format.html { render :action => :edit }
         end
-      else
-        format.html { render :action => :edit }
       end
     end
-  end
-
-  # DELETE /config_vars/http_user
-  def destroy
-    @config_var = ConfigVar.where(:name => params[:name]).first
-    @config_var.destroy
-
-    respond_to do |format|
-      format.html { redirect_to(config_vars_url) }
-    end
-  end
-end  # module ConfigvarsRails::Session::ControllerInstanceMethods
-
-# Included in controllers that call config_vars_controller.
-module AuthInstanceMethods
-  def config_vars_http_basic_check
-    authenticate_or_request_with_http_basic(
-        ConfigVar['config_vars.http_realm']) do |user, password|
-      user == ConfigVar['config_vars.http_user'] &&
-          password == ConfigVar['config_vars.http_password']
+  
+    # DELETE /config_vars/http_user
+    def destroy
+      @config_var = ConfigVar.where(:name => params[:name]).first
+      @config_var.destroy
+  
+      respond_to do |format|
+        format.html { redirect_to(config_vars_url) }
+      end
     end
-  end
-  private :config_vars_http_basic_check
-end  # module ConfigvarsRails::Session::AclInstanceMethods
-
-ActionController::Base.send :include, ControllerMixin
+  end  # module ConfigvarsRails::Controller::InstanceMethods
 
-end  # namespace ConfigvarsRails::Session
+end  # module ConfigvarsRails::Controller
 
 end  # namespace ConfigvarsRails

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

@@ -1,6 +1,6 @@
 # Configuration flags that are global to the installation.
 class ConfigVar < ActiveRecord::Base
-  config_vars_model
+  include ConfigvarsRails::Model
 
   # Add your extensions to the ConfigVar class here.
 end

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

@@ -1,6 +1,6 @@
 # Viewing and changing configuration variables.
 class ConfigVarsController < ApplicationController
-  config_vars_controller
+  include ConfigvarsRails::Controller
 
   config_vars_auth
 end

data/lib/configvars_rails/model.rb

@@ -1,74 +1,57 @@
-require 'active_record'
+require 'active_support'
 
 # :nodoc: namespace
 module ConfigvarsRails
 
 # :nodoc: namespace
 module Model
+  extend ActiveSupport::Concern
 
-
-# Mixed into ActiveRecord::Base
-module ModelMixin
-  def self.included(base)
-    base.send :extend, ModelClassMethods
-  end
-end
-
-
-# Methods here become ActiveRecord::Base class methods.
-module ModelClassMethods
-  # Extends the model to make it hold configuration variables.
-  def config_vars_model
+  included do
     # The name of the configuration variable.
     validates :name, :uniqueness => true, :length => 1..64, :presence => true
   
     # The value of the configuration variable.
     validates :value, :length => 0..1024, :exclusion => { :in => [nil] }
-
-    extend ModelMetaclassMethods
-    include ModelInstanceMethods
   end
-end  # module ConfigvarsRails::Model::ModelClassMethods
 
 
-# Included in the metaclass of models that call config_vars_model.
-module ModelMetaclassMethods
-  # Access configuration flags by ConfigVar['flag_name'].
-  def [](name)
-    var = where(:name => name).first
-    return var.value if var
+  # Class methods for models that include ConfigVarsRails::Model.
+  module ClassMethods
+    # Access configuration flags by ConfigVar['flag_name'].
+    def [](name)
+      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
     
-    descriptor = ConfigvarsRails.variable_descriptor name
-    return descriptor.default_value if descriptor
+    # Set configuration flags by ConfigVar['flag_name'] = 'flag_value'.
+    def []=(name, value)
+      flag = where(:name => name).first
+      flag ||= new :name => name
+      flag.value = value
+      flag.save!
+      value
+    end
+  end  # module ConfigvarsRails::Model::ClassMethods
+
+
+  # Included in models that include ConfigVarsRails::Model.
+  module InstanceMethods
+    # The descriptor for this variable, or nil if no descriptor was defined.
+    def descriptor
+      ConfigvarsRails.variable_descriptor name
+    end
     
-    raise IndexError, "Configuration variable #{name} not found"
-  end
-  
-  # Set configuration flags by ConfigVar['flag_name'] = 'flag_value'.
-  def []=(name, value)
-    flag = where(:name => name).first
-    flag ||= new :name => name
-    flag.value = value
-    flag.save!
-    value
-  end
-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
-  
-  # Use name instead of ID on all URLs.
-  def to_param
-    name
-  end
-end  # module ConfigvarsRails::Model::ModelInstanceMethods
-
-ActiveRecord::Base.send :include, ModelMixin
+    # Use name instead of ID on all URLs.
+    def to_param
+      name
+    end
+  end  # module ConfigvarsRails::Model::InstanceMethods
 
 end  # namespace ConfigvarsRails::Model
 

data/lib/configvars_rails.rb

@@ -2,6 +2,7 @@
 module ConfigvarsRails
 end
 
+require 'configvars_rails/auth.rb'
 require 'configvars_rails/controller.rb'
 require 'configvars_rails/descriptor.rb'
 require 'configvars_rails/model.rb'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configvars_rails
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
   - 5
-  version: 0.4.5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Victor Costan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 Z
+date: 2011-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -120,6 +120,7 @@ files:
 - app/helpers/config_vars_helper.rb
 - configvars_rails.gemspec
 - lib/configvars_rails.rb
+- lib/configvars_rails/auth.rb
 - lib/configvars_rails/controller.rb
 - lib/configvars_rails/descriptor.rb
 - lib/configvars_rails/engine.rb