rails_config_model_generator 1.1.0

data/History.txt

@@ -0,0 +1,14 @@
+== 1.1.0 / 2007-07-16
+
+* Specify model name and migration fields via generator
+* Updated tests
+* fixed syntax error in the conroller template
+* Rewrote the generator
+* Refactored configuration creation on load
+* updated tests
+
+== 1.0.0 / 2007-07-16
+
+* Initial release - generating configuration model
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rails_config_model.rb
+rails_config_model_generator.rb
+templates/configuration.rb
+templates/configuration_controller.rb
+templates/edit.rhtml
+templates/fixtures.yml
+templates/functional_test.rb
+templates/migration.rb
+templates/unit_test.rb
+

data/README.txt

@@ -0,0 +1,91 @@
+== rails_config_model
+
+    by Brian Hogan
+    http://rconfig.rubyforge.org/
+    http://www.napcs.com/products/rails/rails_config_model_generator
+
+== DESCRIPTION:
+Creates a configuration controller and model that can be used to quickly create configuration table for your system so you can store system-wide variables that you'd like the user to be able to set.
+
+This gem contains a generator to create a simple configuration model, migration, and interface for your application, complete with working tests.
+
+== FEATURES
+  
+* Generates the controller, model, and the associated files.  
+* You can specify the model name and set the fields for the migrations via the generator.
+
+== SYNOPSIS:
+
+=== Setup and overview
+Generate a new configuration system for your application by executing the generator from the root of your application.
+ 
+   ruby script\generate rails_config_model Configuration
+   
+You can also specify the model fields much like the scaffold_resource generator
+
+  ruby script/generate rails_config_model Configuration contact_email:string site_name:string welcome_message:text max_number_of_events:integer
+   
+Once installed, you modify the generated migration to include the fields you want to configure. There are a few defaults there to give you an idea.
+ 
+The generator will create a controller mounted at /configuration so you can edit your configurations.  Modify this as needed to provide for security.
+ 
+=== The Edit form
+The application's edit form uses the *form* helper method to auto-generate the fields. This may not be optimal and you may wish to actually write your own view instead. See app/views/configuration/edit.rhtml for more details.
+ 
+=== Usage
+Configuration is simply a model for this table. It is designed to handle a single row of a table, and so additional rows cannot be created. 
+If you have a table that looks like this:
+    
+    id
+    contact_email
+    site_name
+    welcome_message
+    max_number_of_events
+
+You simply grab the row from the table
+ 
+     @configuration = Configuration.load
+     
+and then grab the values out.
+ 
+     email = @configuration.contact_email
+
+Or save new values
+
+  @configuration = Configuration.load
+  @configuration.welcome_message = "This is the default message."
+  @configuraiton.save
+ 
+
+== REQUIREMENTS:
+
+* Rails, a database, and a reason to use this.
+
+== INSTALL:
+
+Download and sudo gem install rails_config_model
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Brian P. Hogan
+
+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/Rakefile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/rails_config_model.rb'
+
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject do |x|
+      Array(x).first == 'hoe'
+    end
+  end
+end
+
+Hoe.new('rails_config_model_generator', RailsConfigModel::VERSION) do |p|
+  p.rubyforge_name = 'rconfig'
+  p.name = "rails_config_model_generator"
+  p.author = ["Brian Hogan"]
+  #p.remote_rdoc_dir = ''
+  # p.summary = 'FIX'
+  p.description = p.paragraphs_of('README.txt', 2..10).join("\n\n")
+  p.url = "http://rconfig.rubyforge.org/"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ""
+end
+
+# vim: syntax=Ruby

data/lib/rails_config_model.rb

@@ -0,0 +1,3 @@
+class RailsConfigModel
+  VERSION = '1.1.0'
+end

data/rails_config_model_generator.rb

@@ -0,0 +1,103 @@
+# This generator borrows heavily from the scaffold_resource generator in Rails 1.2.3
+class RailsConfigModelGenerator < Rails::Generator::NamedBase
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_singular_name
+  alias_method  :controller_table_name, :controller_plural_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @controller_name =  @name
+
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
+
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+  
+  
+
+
+  def manifest
+    recorded_session = record do |m|
+
+       	      m.class_collisions(controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+       	      m.class_collisions(class_path, "#{class_name}")
+
+
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      
+      m.template('configuration.rb', File.join('app/models', class_path, "#{file_name}.rb"))
+
+      m.template(
+        'configuration_controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+
+      m.template("edit.rhtml",         File.join("app/views", controller_class_path, controller_file_name,  "edit.rhtml"))
+      m.template('functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      m.template('unit_test.rb',       File.join('test/unit',       class_path, "#{file_name}_test.rb"))
+      m.template('fixtures.yml',       File.join('test/fixtures', "#{table_name}.yml"))
+
+      unless options[:skip_migration]
+        m.migration_template(
+          'migration.rb', 'db/migrate', 
+          :assigns => {
+            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+            :attributes     => attributes
+          }, 
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+        )
+      end
+
+
+
+    end
+    
+    action = nil
+    action = $0.split("/")[2]
+    
+
+    case action
+      when "generate" 
+        puts
+        puts ("-" * 70)
+        puts "Your app's configuration is all ready to go! There's just a couple things you might want to do:"
+        puts 
+        puts "  1. Modify db/migrate/create_#{file_path.gsub(/\//, '_').pluralize} and add any additional columns."
+        puts "  2. Open up #{File.join('app/models', class_path, "#{file_name}.rb")} and add any custom validations." 
+        puts "  3. Migrate your database (rake db:migrate) and then run your unit tests to make sure this generator didn't break anything!"
+        puts "  4. Modify #{File.join("app/views", controller_class_path, controller_file_name,  "edit.rhtml")} and customize it for your application."
+        puts
+        puts ("-" * 70)
+        puts
+      when "destroy" 
+        puts
+        puts ("-" * 70)
+          puts
+        puts "Thanks for using the rails_config_model generator. If you added any additional files that depend on this, be sure to remove them!"
+        puts
+        puts ("-" * 70)
+        puts
+      else
+        puts
+    end
+    recorded_session
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Run this to create the files you need for a configuration system.  Usage:  rails_config_model ModelName [field:type, field:type]"
+    end
+end

data/templates/configuration.rb

@@ -0,0 +1,34 @@
+# The <%=class_name %> model acts as the interface to the <%=table_name %> table. 
+# The <%=table_name %> table should consist of only one row with one column for each configuration field in your system. 
+#
+# Callbacks prevent rows from being added to or removed from the table.
+#
+class <%=class_name %> < ActiveRecord::Base
+  
+    before_create :check_for_existing
+    before_destroy :check_for_existing
+
+   # class methods
+   
+   # Returns the system configuration record. You should use this instead of doing an explicit #find on this object, as this
+   # method will retrieve only the first row from the table.
+   #
+   # If no configuration record exists, one will be created with blank fields.
+   def self.load
+     
+
+      <%=singular_name %> = <%=class_name %>.find :first
+       if <%=singular_name %>.nil?
+         <%=singular_name %> = <%=class_name %>.create() 
+       end
+      <%=singular_name %>
+   end
+    
+
+   protected
+   
+   # Prevents the destruction or creation of more than one record.
+   def check_for_existing
+        return false if <%=class_name %>.find(:all).size >= 1 
+    end
+end

data/templates/configuration_controller.rb

@@ -0,0 +1,44 @@
+# This configuration controller was generated by the rails_configu_model generator
+# 
+# This controller provides an interface to quickly edit the values in the <%=table_name %> table.
+# See <%=class_name %> for more details on the system configuration.
+#
+
+class <%=controller_class_name %>Controller < ApplicationController
+
+  before_filter :find_<%=singular_name %>
+  
+  
+  # Simply redirect to the edit action
+  def index
+    edit
+    render :action=> "edit"
+  end
+  
+
+  # Shows the page to edit the <%=singular_name %> variables.
+  def edit
+  end
+  
+  
+  # Saves the posted data to the <%=table_name %> table via the standard
+  # Rails mass-assignment update approach.
+  def update
+
+    if @<%=singular_name %>.update_attributes(params[:<%=singular_name %>])
+      flash[:notice] = 'Your system configuration was successfully updated.'
+      redirect_to :action => 'edit'
+    else
+      render :action=>"edit"
+    end
+  end
+
+  
+  protected
+  
+  # Before filter to load the configuration data.
+  def find_<%=singular_name %>
+     @<%=singular_name %> =  <%=class_name %>.load
+  end
+  
+end

data/templates/edit.rhtml

@@ -0,0 +1,5 @@
+<h2>System configuration</h2>
+<hr />
+<%%= error_messages_for "<%= singular_name %>" %>
+<%%= form("<%= singular_name %>", :action => "update") %>
+

data/templates/fixtures.yml

@@ -0,0 +1,6 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>

data/templates/functional_test.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%=controller_file_name %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%=controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%=controller_class_name %>ControllerTest < Test::Unit::TestCase
+
+  fixtures :<%=table_name %>
+
+  def setup
+    @controller = <%=controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_index
+    get "index"
+    assert_response :success
+    assert_template "edit"
+    
+  end
+  
+  
+  def test_edit
+    get "edit"
+    assert_response :success
+    assert_template "edit"
+  end
+  
+  def test_update
+    post "update", {:id=>1}
+    assert_response :redirect
+  end
+  
+  def test_create_new_<%=singular_name %>_when_none_exists
+    <%=class_name %>.delete_all
+    get "edit"
+    assert_response :success
+    assert_template "edit"
+  end
+  
+end

data/templates/migration.rb

@@ -0,0 +1,13 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.column :<%= attribute.name %>, :<%= attribute.type %>
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/templates/unit_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%=class_name %>Test < Test::Unit::TestCase
+
+ fixtures :<%=table_name %>
+
+ # The assumption here is that the  record was created already.
+ # Once there is a record, it should not allow the creation of an existing one.
+  def test_should_not_create
+   c = <%=class_name %>.create({})
+   assert !c.save
+  end
+  
+  # Should not be able to remove the last configuration in the system.
+  def test_should_not_delete
+   c = <%=class_name %>.find :first
+   assert !c.destroy
+  end
+  
+  def test_load_method_should_only_find_one
+    assert_kind_of(<%=class_name %>, <%=class_name %>.load)
+  end
+  
+  def test_should_create_new_record_on_load_if_none_found
+    <%=class_name %>.delete_all
+    assert_not_nil <%=class_name %>.load
+  end
+  
+  
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: rails_config_model_generator
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+date: 2007-10-25 00:00:00 -05:00
+summary: The author was too lazy to write a summary
+require_paths: 
+- lib
+email: ryand-ruby@zenspider.com
+homepage: http://rconfig.rubyforge.org/
+rubyforge_project: rconfig
+description: "== DESCRIPTION: Creates a configuration controller and model that can be used to quickly create configuration table for your system so you can store system-wide variables that you'd like the user to be able to set.  This gem contains a generator to create a simple configuration model, migration, and interface for your application, complete with working tests.  == FEATURES  * Generates the controller, model, and the associated files.   * You can specify the model name and set the fields for the migrations via the generator.  == SYNOPSIS:  === Setup and overview Generate a new configuration system for your application by executing the generator from the root of your application.  ruby script\\generate rails_config_model Configuration  You can also specify the model fields much like the scaffold_resource generator  ruby script/generate rails_config_model Configuration contact_email:string site_name:string welcome_message:text max_number_of_events:integer  Once installed, you modify the generated migration to include the fields you want to configure. There are a few defaults there to give you an idea.  The generator will create a controller mounted at /configuration so you can edit your configurations.  Modify this as needed to provide for security.  === The Edit form The application's edit form uses the *form* helper method to auto-generate the fields. This may not be optimal and you may wish to actually write your own view instead. See app/views/configuration/edit.rhtml for more details.  === Usage Configuration is simply a model for this table. It is designed to handle a single row of a table, and so additional rows cannot be created.  If you have a table that looks like this:  id contact_email site_name welcome_message max_number_of_events  You simply grab the row from the table  @configuration = Configuration.load  and then grab the values out.  email = @configuration.contact_email  Or save new values  @configuration = Configuration.load @configuration.welcome_message = \"This is the default message.\" @configuraiton.save"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Brian Hogan
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rails_config_model.rb
+- rails_config_model_generator.rb
+- templates/configuration.rb
+- templates/configuration_controller.rb
+- templates/edit.rhtml
+- templates/fixtures.yml
+- templates/functional_test.rb
+- templates/migration.rb
+- templates/unit_test.rb
+test_files: 
+- test/test_rails_config_model.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+