midas-guilded 0.0.5 → 0.0.6

data/History.txt

@@ -1,4 +1,8 @@
+== 0.0.6 2009-02-11
+
+* Updated config file and Guilder to accept an :env variable.  This variable will allow Guilded to know what environment
+  it is running in so that it knows whether to cache assets, etc.
+
 == 0.0.1 2009-02-28
 
-* 1 major enhancement:
-  * Initial release
+* Initial release

data/README.rdoc

@@ -1,10 +1,10 @@
 = guilded-base
 
-* http://github.com/midas/guilded-base/tree/master
+http://github.com/midas/guilded-base/tree/master
 
 == DESCRIPTION
 
-Warning: This project just started and there are no releases available yet.
+Warning: This project just started and there are no stable releases available yet.
 
 Guilded is a framework for building web based components centered around current web standards and best practices. The current 
 framework is written in ruby, but could be ported to other languages.
@@ -26,13 +26,39 @@ allow the jQuery plugin to be used outside of the Guilded project, if desired.
 Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.
 
 Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged 
-in a Gem and have a dependency on the guilded-base gem.
+in a Gem and have a dependency on the guilded gem.
 
 The Guilded-Base gem contains the framework to build Guilded components.
 
 
 == FEATURES
 
+=== Centralized control of CSS and JavaScript assets needed to render a web page.
+* Automatic addition of jQuery 1.3.2 library.
+* Automatic addition of Yahoo's reset-min.css.
+* Redefinition of jQuery's $ method to $j and running jQuery in no conflict mode to allow other libraries to retain control 
+  of the $ method.
+* Definition of the g namespace to avoid JavaScript name collisions.
+* Definition of convenience method $jc().  Equivalent to jQuery( '.' + className ).
+* Definition of convenience method $jid().  Equivalent to jQuery( '#' + idName ). 
+* The assets required for each component are added by the author to a central data store.  When the view helper to create
+  the component is called, these assets are added to the asset store.  This results in a single method call with some options
+  to use a Guilded component.
+* For CSS assets, Guilded simply loops through the collection of CSS assets creating an HTML link tag for each asset, or one 
+  HTML link tag for the cached version of these asset(s), when running in production mode.
+* For JavaScript assets, Guilded loops through the collection of JavaScript assets creating an HTML script tag for each, or a
+  single script tag for the cached version of these asset(s), when running in production mode.
+
+=== Caching of CSS and JavaScript assets needed to render a web page.
+* The CSS assets are cached to form one file.  In addition, the JavaScript assets are cached to form one file.  These files are 
+  named by sorting and concatenating into a single string the names of each individual respective asset.  This string is then hashed 
+  to generate a reproducable unique string.  This file naming technique allows Guilded to find cached asset files that 
+  match a combination of Guilded components, not an action, URI, etc.  Thus, one file for a certain combination of Guilded 
+  components is generated and then reused on any page where the combination appears.
+
+=== Automatic choosing of packed, compressed or minified JavaScript files when in production mode.
+* In production mode, Guilded automatically looks for a .pack, .compressed or .min version of the JavaScript assets.  If one of 
+  these is found, it includes it, otherwise, it includes the version specified by the author in the view helper.  This is usually an unpacked version of the file.
 
 == PROBLEMS
 
@@ -40,30 +66,29 @@ The Guilded-Base gem contains the framework to build Guilded components.
 
 == REQUIREMENTS
 
-jQuery
+* jQuery 1.3.2 (included in Guilded)
 
 
 == INSTALL
 
-gem sources -a http://gems.github.com
-
-sudo gem install midas-guilded
+  gem sources -a http://gems.github.com
+  sudo gem install midas-guilded
 
 
 == INSTALL FOR RAILS
 
 Add to environment file:
 
-	config.gem "guilded", :version => '0.0.3'
+  config.gem "guilded", :version => '0.0.5'
 
 Run:
 
-	sudo rake:gems:install
+  sudo rake:gems:install
 	
 Generate:
 
-	script/generate guilded_config
-	script/generate guilded_assets
+  script/generate guilded_config
+  script/generate guilded_assets
 
 
 Edit the settings file at config/initializers/load_guilded_settings.rb.  Change any of these settings to reflect how

data/Rakefile

@@ -4,7 +4,7 @@ require File.dirname(__FILE__) + '/lib/guilded'
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.new('guilded', Guilded::VERSION) do |p|
-  p.developer('midas', 'jaosn@lookforwardenterprises.com')
+  p.developer('C. Jason Harrelson (midas)', 'jason@lookforwardenterprises.com')
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
   p.rubyforge_name       = p.name # TODO this is default value

data/guilded.gemspec

@@ -1,13 +1,14 @@
 # -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{guilded}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["midas"]
-  s.date = %q{2009-03-03}
-  s.description = %q{Warning: This project just started and there are no releases available yet.  Guilded is a framework for building web based components centered around current web standards and best practices. The current  framework is written in ruby, but could be ported to other languages.  Guilded intends to provide a toolset for creating and consuming reusable web components.  Currently, this problem domain is filled with JavaScript frameworks.  These frameworks are wonderful and work very well.   However, they do not degrade and are not accessible.  Guilded seeks to provide the same level of "componentization" and ease of use without sacrificing degradability  and accessibility.  Guilded will achieve these goals by applying each technology at our disposal to do what it was intended.    XHTML will be employed for content.  CSS used for layout and styling.  Behavior will be added to a component with JavaScript  through progressive enhancement.  The user will have the best experience with a Guilded component when CSS and JavaScript are  enabled in their browser, but will still be able to use the component when CSS and JavaScript are disabled.   Guilded will use jQuery as it's base JavaScript framework.  jQuery was chosen because it lends itself to progressive enhancement due to the way it was authored.  In addition, the tight integration of jQuery's selectors with CSS selectors is also highly  desirable.  When authoring a Guilded component, it is encouraged to write the behavior code as a jQuery plugin.  This will  allow the jQuery plugin to be used outside of the Guilded project, if desired.  Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.  Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged  in a Gem and have a dependency on the guilded-base gem.  The Guilded-Base gem contains the framework to build Guilded components.}
-  s.email = ["jaosn@lookforwardenterprises.com"]
+  s.authors = ["C. Jason Harrelson (midas)"]
+  s.date = %q{2009-03-11}
+  s.description = %q{Warning: This project just started and there are no stable releases available yet.  Guilded is a framework for building web based components centered around current web standards and best practices. The current  framework is written in ruby, but could be ported to other languages.  Guilded intends to provide a toolset for creating and consuming reusable web components.  Currently, this problem domain is filled with JavaScript frameworks.  These frameworks are wonderful and work very well.   However, they do not degrade and are not accessible.  Guilded seeks to provide the same level of "componentization" and ease of use without sacrificing degradability  and accessibility.  Guilded will achieve these goals by applying each technology at our disposal to do what it was intended.    XHTML will be employed for content.  CSS used for layout and styling.  Behavior will be added to a component with JavaScript  through progressive enhancement.  The user will have the best experience with a Guilded component when CSS and JavaScript are  enabled in their browser, but will still be able to use the component when CSS and JavaScript are disabled.   Guilded will use jQuery as it's base JavaScript framework.  jQuery was chosen because it lends itself to progressive enhancement due to the way it was authored.  In addition, the tight integration of jQuery's selectors with CSS selectors is also highly  desirable.  When authoring a Guilded component, it is encouraged to write the behavior code as a jQuery plugin.  This will  allow the jQuery plugin to be used outside of the Guilded project, if desired.  Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.  Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged  in a Gem and have a dependency on the guilded gem.  The Guilded-Base gem contains the framework to build Guilded components.}
+  s.email = ["jason@lookforwardenterprises.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
   s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "guilded.gemspec", "lib/guilded.rb", "lib/guilded/component_def.rb", "lib/guilded/exceptions.rb", "lib/guilded/guilder.rb", "lib/guilded/rails.rb", "lib/guilded/rails/view_helpers.rb", "rails_generators/guilded_assets/guilded_assets_generator.rb", "rails_generators/guilded_assets/templates/guilded.js", "rails_generators/guilded_assets/templates/guilded.min.js", "rails_generators/guilded_assets/templates/jquery-1.2.6.js", "rails_generators/guilded_assets/templates/jquery-1.2.6.min.js", "rails_generators/guilded_assets/templates/jquery-1.3.2.js", "rails_generators/guilded_assets/templates/jquery-1.3.2.min.js", "rails_generators/guilded_assets/templates/reset-min.css", "rails_generators/guilded_config/guilded_config_generator.rb", "rails_generators/guilded_config/templates/load_guilded_settings.rb", "script/console", "script/destroy", "script/generate", "spec/guilded/component_def_spec.rb", "spec/guilded/guilder_spec.rb", "spec/guilded_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rails.rake", "tasks/rspec.rake"]
   s.has_rdoc = true
@@ -17,7 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{guilded}
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Warning: This project just started and there are no releases available yet}
+  s.summary = %q{Warning: This project just started and there are no stable releases available yet}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -35,7 +36,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<hoe>, [">= 1.8.0"])
   end
 end
-
-
-
-

data/lib/guilded.rb

@@ -6,8 +6,69 @@ require 'guilded/guilder'
 require 'guilded/exceptions'
 require 'guilded/rails/view_helpers'
 
+# Guilded is a framework for creating reusable UI components for web applications.  Guilded provides the facilities to 
+# easily add components and all of their required assets to a page.
+# 
+# A Guilded component is a set of XHTML, CSS and JavaScript that combine to create a rich UI.  The Guilded component should be
+# authored using progressive enhancement to enable users without CSS or JavaScript enabled to utilize the essential functionality
+# of the component.  The easiest way to accomplish this requirement is to write your behavior code as a jQuery plugin.  Doing
+# so will naturally guide your behavior code to be applied through progrssive enhancement and also allow your behavior code 
+# to be used without Guilded.
+#
+# To create a Guilded component at least four things must occur: writing a view helper, writing a JavaScript initialization
+# function, writing a default stylesheet and writing either a rake task or generator to place these assets into a project's 
+# public directory.  It is also probable that a jQuery plugin with the behavior code will need to be authored.  If this is the 
+# case, then the JavaScript initialization function will most likely just call the jQuery plugin on the DOM element(s) that should 
+# have the behavior applied.
+#
+# The view helper should output the HTML necessary for the component.  It must also add the component to a collection so that
+# Guilded can collect its assets and add them to the page.  This is accomplished through a call to the Guilder.add() method.
+# The Guilder is a singleton, so you must access it like: Guilded::Guilder.instance.add( ... ).  The Guilder.add() method adds
+# element to a collection with it's options.  Guilded automatically looks for CSS assets that obey the naming convention 
+# {component_name}/default.css.  Guilded also automatically looks for a JavaScript asset named: guilded.{component_name}.js.  
+# This asset should at least include the initComponentName( options ).  The Guilded.add() method can also add additional CSS and 
+# JavaScript assets necessary for a component.  An example of an additional JavaScript asset is the jQuery plugin authored to 
+# contain the behavior of a component.  The view helper must be called with an :id option as it is used to differentiate different
+# instances of the same component on a single page from each other.  It will also be used as the DOM element's id.  A Guilded view 
+# helper should have a g_ appended to the beginning of it to help differentiate from normal view helepr sin a project.
+# 
+# The JavaScript initialization function should be named init{ComponentName}( options ).  The options hash from the view helper
+# will automatically be passed to this function.  The function should handle a before and after init callback to enable the user
+# to set up anything necessary for the component and perform additional tasks.  This function must also perform any other code 
+# necessary to set up the behavior for a compnent.  An example fo this would be adding behavior to events or simply calling
+# a jQuery plugin on element(s) of the component.  Remember that any JavaScript relating to Guilded should be placed in the 'g'
+# namespace that Guilded creates on every page.  An example init function for a g_load_alerter would be:
+#
+#   g.initLoadAlerter = function( options )
+#   {
+#     if( g.beforeInitLoadAlerter )
+#       g.beforeInitLoadAlerter( options );
+#
+#     // Initialization code here...
+#
+#     if( g.afterInitLoadAlerter )
+#       g.afterInitLoadAlerter( options );
+#   };
+#
+# For a user to implement these callback functions, they should create a JavaScript file with the functions and call it on
+# any page they need it on utilizing Guilded's JavaScript include helper g_javascript_include_tag.  This helper will add the
+# JavaScript files after the jQuery and Guilded framework files, but within the component files in the order they were added.  
+# This will make the 'g' namespace available for use.  Obviously this file must be included prior to calling the component's helper,
+# or the callback functions will not be defined for use. 
+#
+# The default stylesheet for a Guilded component should be the minimum amount of CSS for the component to function.  When no :skin
+# option is passed to the view helper when a component is added, Guilded will look for the default stylesheet.  The assets
+# used within the stylesheet (images) should be placed in a folder named default that is in the same directory as the default.css
+# file.  All asssets used in the stylesheet should use an absolute reference from the public directory: /stylesheets/guilded/{component_name}/default/{asset_name}.
+#
+# In order to create another skin for a component, simply create a {skin_name}.css file and a {skin_name} directory with the style 
+# assets in it.  Be sure to reference the style assets with absolute paths from teh public directory so that the skin will work in 
+# all cases.  Then call the component's view helper and use the :skin option:
+#
+#   <%= g_load_alerter :skin => 'blueish', :id => 'load_alerter' %>
+#
 module Guilded
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end
 
 ActionView::Base.send( :include, Guilded::Rails::ViewHelpers ) if defined?( ActionView )

data/lib/guilded/guilder.rb

@@ -2,16 +2,26 @@ require 'digest'
 require 'singleton'
 
 module Guilded
+  
+  # Guilder is the worker for the entire Guilded framework.  It collects all of the necessary components for a page
+  # through its add() method.  When the g_apply_behavior() method is called at the end of a page, the Guilder writes
+  # HTML to include all of the necessary asset files (caching them in production).  It also writes s JavaScript initialization
+  # function and fires the initialization function on page load.  
+  #
+  # This initialization function calls the initialization function for each Guilded component that was added to the current 
+  # page.  For example, if a Guilded component named 'g_load_alerter' was added to a page, the Guilder would include this line 
+  # in the initialization function it writes: g.initLoadAlerter( /* passing options hash here */ );  The g before the function
+  # is a JavaScript namespace that Guilded automatically creates to facilitate avoiding name collisions with other JavaScript 
+  # libraries and code.
+  #
+  # Th options hash that is passed to the init functions for each Guilded component is simply the options hash from the 
+  # component's view helper.  The Guilder calls .to_json() on the options hash.  Thus, if there are pairs in the options hash
+  # that need not go to the JavaScript init method they should be removed within the view helper. 
+  #
   class Guilder
     include Singleton
     
-    # The folder name for guilded JavaScript files.  Must include trailing '/'.
-    #GUILDED_JS_FOLDER = ""
-    # The folder name for guilded css files.  Must include trailing '/'.
-    #GUILDED_CSS_FOLDER = "guilded/"
     GUILDED_NS = "guilded."
-    # JS_PATH = GUILDED_CONFIG[:js_path] if defined?( GUILDED_CONFIG )
-    # CSS_PATH = GUILDED_CONFIG[:css_path] if defined?( GUILDED_CONFIG )
       
     attr_reader :initialized_at
     
@@ -22,8 +32,6 @@ module Guilded
         raise Guilded::Exceptions::MissingConfiguration
       end
       @initialized_at = Time.now
-      @env = options[:env].to_sym if options[:env]
-      @env ||= :production
       @g_elements = Hash.new
       @combined_js_srcs = Array.new
       @combined_css_srcs = Array.new
@@ -41,27 +49,37 @@ module Guilded
       @g_elements[ options[:id] ] = Guilded::ComponentDef.new( element, options, libs, styles )
     end
   
-    def count
+    def count #:nodoc:
       @g_elements.size
     end
     
+    # The number of Guilded components to be renderred.
+    #
     def component_count
       count
     end
     
+    # The current number of CSS assets necessary for the Guilded component set. 
+    #
     def style_count
       @combined_css_srcs.size
     end
     
+    # The current number of JavaScript assets necessary for the Guilded component set. 
+    #
     def script_count
       @combined_js_srcs.size
     end
     
+    # The collection of JavaScript assets for the current Guilded component set.
+    #
     def combined_js_srcs
       generate_asset_lists unless @assets_combined
       @combined_js_srcs
     end
     
+    # The collection of CSS assets for the current Guilded component set.
+    #
     def combined_css_srcs
       generate_asset_lists unless @assets_combined
       @combined_css_srcs
@@ -80,7 +98,7 @@ module Guilded
     # Generates the markup required to include all the assets necessary for the Guilded compoents in 
     # @g_elements collection.  Use this if you are not interested in caching asset files.
     #
-    def apply
+    def apply #:nodoc:
       to_init = ""
       generate_asset_lists unless @assets_combined
       @combined_css_srcs.each { |css| to_init << "<link href=\"/stylesheets/#{css}\" media=\"screen\" rel=\"stylesheet\" type=\"text/css\" />" }
@@ -92,7 +110,7 @@ module Guilded
     # Writes an initialization method that calls each Guilded components initialization method.  This 
     # method will exceute on document load finish.
     #
-    def generate_javascript_init
+    def generate_javascript_init #:nodoc:
       code = "<script type=\"text/javascript\">"
       code << "var initGuildedElements = function(){"
       @g_elements.each_value do |guilded_def| 
@@ -101,15 +119,21 @@ module Guilded
       code << "};jQuery('document').ready( initGuildedElements );</script>"
     end
     
+    # Generates a name to use when caching the current set of Guilded component JavaScript assets.  Sorts and concatenates
+    # the name of each JavaScript asset in @combined_js_srcs.  Then hashes this string to generate a reproducible, unique 
+    # and shorter string.
     def js_cache_name
       generate_js_cache_name( @combined_js_srcs )
     end
     
+    # Generates a name to use when caching the current set of Guilded component CSS assets.  Sorts and concatenates
+    # the name of each JavaScript asset in @combined_js_srcs.  Then hashes this string to generate a reproducible, unique 
+    # and shorter string.
     def css_cache_name
       generate_css_cache_name( @combined_css_srcs )
     end
     
-    def generate_js_cache_name( sources )      
+    def generate_js_cache_name( sources ) #:nodoc: 
       generate_asset_lists unless @assets_combined
       #return"#{controller.class.to_s.underscore}_#{controller.action_name}" if development?
       sorted_srcs = sources.sort
@@ -118,7 +142,7 @@ module Guilded
       "#{Digest::MD5.hexdigest( joined )}"
     end
     
-    def generate_css_cache_name( sources )
+    def generate_css_cache_name( sources ) #:nodoc:
       generate_asset_lists unless @assets_combined
       #return "#{controller.class.to_s.underscore}_#{controller.action_name}" if development?
       sorted_srcs = sources.sort
@@ -129,7 +153,7 @@ module Guilded
     
   protected
     
-    def configure_guilded
+    def configure_guilded #:nodoc: 
       @js_path = GUILDED_CONFIG[:js_path]
       @js_folder = GUILDED_CONFIG[:js_folder]
       @jquery_js = GUILDED_CONFIG[:jquery_js]
@@ -137,6 +161,8 @@ module Guilded
       @css_path = GUILDED_CONFIG[:css_path]
       @css_folder = GUILDED_CONFIG[:css_folder]
       @reset_css = GUILDED_CONFIG[:reset_css]
+      @env = GUILDED_CONFIG[:environment]
+      @env ||= :production
       @js_path.freeze
       @css_path.freeze
       @js_folder.freeze
@@ -144,12 +170,13 @@ module Guilded
       @guilded_js.freeze
       @css_folder.freeze
       @reset_css.freeze
+      @env.freeze
     end
     
     # Adds the Guilded reset CSS file and the guilded.js and jQuery files to the respective sources
     # collections.
     #
-    def init_sources
+    def init_sources #:nodoc: 
       @combined_css_srcs << "#{@reset_css}" unless @reset_css.nil? || @reset_css.empty?
       @combined_js_srcs << "#{@jquery_js}" << "#{@js_folder}#{@guilded_js}"
     end
@@ -157,7 +184,7 @@ module Guilded
     # Combines all JavaScript and CSS files into lists to include based on what Guilded components are on 
     # the current page.
     #
-    def generate_asset_lists
+    def generate_asset_lists #:nodoc: 
       @assets_combined = true
       @g_elements.each_value do |defi|
         #TODO get stylesheet (skin) stuff using rails caching
@@ -179,7 +206,7 @@ module Guilded
     # libs An array of JavaScript libraries that this component depends on.  More than likely 
     #   a jQuery plugin, etc.
     #
-    def combine_js_sources( component, libs=[] )  #:doc:
+    def combine_js_sources( component, libs=[] )  #:nodoc:
       resolve_js_libs( libs )
       
       comp_src = add_guilded_js_path( component )
@@ -192,7 +219,7 @@ module Guilded
     # parts fo the name to try and get the debug version of the library.  If it cannot 
     # find the debug version of the file, it will just remain  what was initially provded.
     #
-    def resolve_js_libs( libs )
+    def resolve_js_libs( libs ) #:nodoc: 
       if development?
         # Try to use an unpacked or unminimized version
         libs.each do |lib|
@@ -214,7 +241,7 @@ module Guilded
     # Helper method that takes an array of js sources and adds the correct guilded
     # path to them.  Returns an array with the new path resolved sources.
     #
-    def map_guilded_js_paths( *sources )
+    def map_guilded_js_paths( *sources ) #:nodoc: 
       sources.map { |source| add_guilded_js_path( source ) }
     end
     
@@ -222,12 +249,14 @@ module Guilded
     # it looks for a .pack.js, .min.jsm .compressed.js and chooses one of these over the 
     # development version.
     #
-    def add_guilded_js_path( source )
+    def add_guilded_js_path( source ) #:nodoc: 
       part = "#{@js_folder}#{GUILDED_NS}#{source.to_s}"
       ext = 'js'
       
       return "#{part}.#{ext}" if development?
  
+      #TODO: switch this to take min, pack or compressed out if in development mode for efficiency in production
+ 
       possibles = {
         "#{@js_path}#{part}.pack.#{ext}" => "#{part}.pack.#{ext}",
         "#{@js_path}#{part}.min.#{ext}" => "#{part}.min.#{ext}",
@@ -242,7 +271,7 @@ module Guilded
       "" # Should never reach here
     end
     
-    def combine_css_sources( component, skin, styles=[] )  #:doc:
+    def combine_css_sources( component, skin, styles=[] ) #:nodoc: 
       # Get all of this components defined external styles
       styles.each do |style|
         @combined_css_srcs.push( style ) unless @combined_css_srcs.include?( style )
@@ -257,15 +286,23 @@ module Guilded
       @combined_css_srcs.push( skin_user_src ) unless @combined_css_srcs.include?( skin_user_src ) || skin_user_src.empty?
     end
     
-    def add_guilded_css_path( source, skin )
+    def add_guilded_css_path( source, skin ) #:nodoc: 
       skin = 'default' if skin.nil? || skin.empty?
       part = "#{@css_folder}#{source.to_s}/#{skin}.css"
       path = "#{@css_path}#{part}"
       File.exists?( path ) ? part : ''
     end
     
-    def development?
-      @env == :development
+    def development? #:nodoc: 
+      @env.to_sym == :development
+    end
+    
+    def production? #:nodoc: 
+      @env.to_sym == :production
+    end
+    
+    def test? #:nodoc: 
+      @env.to_sym == :test
     end
     
   end

data/rails_generators/guilded_config/templates/load_guilded_settings.rb

@@ -1,8 +1,12 @@
+# While Guilded is framework agnostic, this config file is Rails specific.  You can create your own config file based
+# on this one in order to work in different environments.
+#
 GUILDED_CONFIG = {
   :js_path => "#{RAILS_ROOT}/public/javascripts/",
   :js_folder => "", # from the js_path
-  :jquery_js => "jquery/jquery-1.2.6.min.js", # from the js_path
+  :jquery_js => "jquery/jquery-1.3.2.min.js", # from the js_path
   :css_path => "#{RAILS_ROOT}/public/stylesheets/",
   :css_folder => "guilded/", # from the css_path
-  :reset_css => "reset-min.css" # from the css_path
+  :reset_css => "reset-min.css", # from the css_path
+  :environment => Rails.env
 }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: midas-guilded
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
-- midas
+- C. Jason Harrelson (midas)
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-03 00:00:00 -08:00
+date: 2009-03-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,9 +32,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: "Warning: This project just started and there are no releases available yet.  Guilded is a framework for building web based components centered around current web standards and best practices. The current  framework is written in ruby, but could be ported to other languages.  Guilded intends to provide a toolset for creating and consuming reusable web components.  Currently, this problem domain is filled with JavaScript frameworks.  These frameworks are wonderful and work very well.   However, they do not degrade and are not accessible.  Guilded seeks to provide the same level of \"componentization\" and ease of use without sacrificing degradability  and accessibility.  Guilded will achieve these goals by applying each technology at our disposal to do what it was intended.    XHTML will be employed for content.  CSS used for layout and styling.  Behavior will be added to a component with JavaScript  through progressive enhancement.  The user will have the best experience with a Guilded component when CSS and JavaScript are  enabled in their browser, but will still be able to use the component when CSS and JavaScript are disabled.   Guilded will use jQuery as it's base JavaScript framework.  jQuery was chosen because it lends itself to progressive enhancement due to the way it was authored.  In addition, the tight integration of jQuery's selectors with CSS selectors is also highly  desirable.  When authoring a Guilded component, it is encouraged to write the behavior code as a jQuery plugin.  This will  allow the jQuery plugin to be used outside of the Guilded project, if desired.  Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.  Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged  in a Gem and have a dependency on the guilded-base gem.  The Guilded-Base gem contains the framework to build Guilded components."
+description: "Warning: This project just started and there are no stable releases available yet.  Guilded is a framework for building web based components centered around current web standards and best practices. The current  framework is written in ruby, but could be ported to other languages.  Guilded intends to provide a toolset for creating and consuming reusable web components.  Currently, this problem domain is filled with JavaScript frameworks.  These frameworks are wonderful and work very well.   However, they do not degrade and are not accessible.  Guilded seeks to provide the same level of \"componentization\" and ease of use without sacrificing degradability  and accessibility.  Guilded will achieve these goals by applying each technology at our disposal to do what it was intended.    XHTML will be employed for content.  CSS used for layout and styling.  Behavior will be added to a component with JavaScript  through progressive enhancement.  The user will have the best experience with a Guilded component when CSS and JavaScript are  enabled in their browser, but will still be able to use the component when CSS and JavaScript are disabled.   Guilded will use jQuery as it's base JavaScript framework.  jQuery was chosen because it lends itself to progressive enhancement due to the way it was authored.  In addition, the tight integration of jQuery's selectors with CSS selectors is also highly  desirable.  When authoring a Guilded component, it is encouraged to write the behavior code as a jQuery plugin.  This will  allow the jQuery plugin to be used outside of the Guilded project, if desired.  Guilded also seeks to provide a standardized CSS framework for creating layouts that are reusable and predictable.  Guilded will utilize the currently existing RubyGems system to package its components.  A new Guilded component will be packaged  in a Gem and have a dependency on the guilded gem.  The Guilded-Base gem contains the framework to build Guilded components."
 email: 
-- jaosn@lookforwardenterprises.com
+- jason@lookforwardenterprises.com
 executables: []
 
 extensions: []
@@ -103,6 +103,6 @@ rubyforge_project: guilded
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: "Warning: This project just started and there are no releases available yet"
+summary: "Warning: This project just started and there are no stable releases available yet"
 test_files: []