midas-guilded 0.2.3 → 0.2.4

data/History.txt

@@ -1,3 +1,10 @@
+= 0.2.4 2009-05-29
+
+* Added add_data method to the Guilder object allowing named data structures to be passed to the JavaScript 
+  executing environment.
+* Added a jQuery event to the body DOM element called guildedInitialized.  To execute JavaScript code after all 
+  Guilded components are intialized, simply bind to this event.
+
 = 0.2.0 2009-04-06
 
 * Added human attribute hint support for InactiveRecord

data/README.rdoc

@@ -1,4 +1,4 @@
-= guilded-base
+= guilded
 
 http://github.com/midas/guilded/tree/master
 
@@ -8,8 +8,8 @@ Guilded is a framework for building web based components centered around 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 
+filled with JavaScript frameworks.  These frameworks are wonderful and work very well.   However, they do not degrade gracefully 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 
@@ -24,9 +24,9 @@ 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.
+in a Gem and have a dependency on the Guilded gem.
 
-The Guilded-Base gem contains the framework to build Guilded components.
+The Guilded gem contains the framework to build Guilded components.
 
 
 == FEATURES
@@ -36,16 +36,23 @@ The Guilded-Base gem contains the framework to build Guilded components.
 * 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 the g namespace to avoid JavaScript name collisions.  Simply define your custom functions within the g object.
+* Definition of convenience method $j().  Equivalent to jQuery() or $().  Guilded runs jQuery in no conflict mode, giving the $
+  back to any other JavaScript frameworks in use.  You must use $j() or jQuery() in lieu of $().
 * 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.
+  to use a Guilded component.  No need to include JavaScript source files or CSS files.  Guilded automatically does this for 
+  you.
 * 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.
+* Pass named data structures from the server to the client side environment for use with the Guilder.add_data() method.  Once Guilded
+  is initialized, the data structure will be instantiated for you with the name specified within the g object.
+* Execute custom JavaScript code after all Guilded components are initialized (ensuring everything you wish to use is instantiated) 
+  using the 'guildedInitialized' custom jQuery event defined on the body DOM element.
 
 === 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 
@@ -56,7 +63,22 @@ The Guilded-Base gem contains the framework to build Guilded components.
 
 === 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.
+  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.
+
+
+== GUILDED COMPONENT PROJECTS
+
+* http://github.com/midas/g_already_grid/tree/master
+* http://github.com/midas/g_auto_completer/tree/master
+* http://github.com/midas/g_flash_growler/tree/master
+* http://github.com/midas/g_flot/tree/master
+* http://github.com/midas/g_form_submit_protector/tree/master
+* http://github.com/midas/g_named_scope_filters/tree/master
+* http://github.com/midas/g_nested_select/tree/master
+* http://github.com/midas/g_sectioned_shower/tree/master
+* http://github.com/midas/g_toggle_block/tree/master
+
 
 == PROBLEMS
 
@@ -97,7 +119,7 @@ Next you must make a call to the view helper to apply the CSS  It should be plac
 
   <%= g_apply_style %>
 
-There is also a view helper to apply the JavaScript.  You can place this at the bottom of your layouts (so you
+There is also a view helper to apply the JavaScript.  You can place this at the bottom of your layout(s) (so you
 do not have to include it in every template):
 
   <%= g_apply_behavior %>
@@ -115,6 +137,7 @@ filter in your application controller:
     Guilded::Guilder.instance.reset!
   end
 
+Then install one or more Guilded components and you are on your way!
 
 == LICENSE
 

data/guilded.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{guilded}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["C. Jason Harrelson (midas)"]
-  s.date = %q{2009-04-17}
-  s.description = %q{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.date = %q{2009-05-29}
+  s.description = %q{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 gracefully 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 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/active_record/human_attribute_hint.rb", "lib/guilded/rails/active_record/human_attribute_override.rb", "lib/guilded/rails/helpers.rb", "lib/guilded/rails/inactive_record/human_attribute_hint.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/jquery-url.js", "rails_generators/guilded_assets/templates/jquery-url.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/rails/helpers_spec.rb", "spec/guilded_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rails.rake", "tasks/rspec.rake"]

data/lib/guilded.rb

@@ -72,7 +72,7 @@ require 'guilded/rails/inactive_record/human_attribute_hint'
 #   <%= g_load_alerter :skin => 'blueish', :id => 'load_alerter' %>
 #
 module Guilded
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end
 
 ActionView::Base.send( :include, Guilded::Rails::ViewHelpers ) if defined?( ActionView )

data/lib/guilded/guilder.rb

@@ -34,6 +34,7 @@ module Guilded
       end
       @initialized_at = Time.now
       @g_elements = Hash.new
+      @g_data_elements = Hash.new
       @combined_js_srcs = Array.new
       @combined_css_srcs = Array.new
       @assets_combined = false
@@ -49,6 +50,17 @@ module Guilded
       raise Guilded::Exceptions::DuplicateElementId.new( options[:id] ) if @g_elements.has_key?( options[:id] )
       @g_elements[ options[:id].to_sym ] = Guilded::ComponentDef.new( element, options, libs, styles )
     end
+    
+    # Adds a data structure to be passed to the Guilded JavaScript environment for use on the client 
+    # side.  The data is passed using the ruby to_json method on the data structure provided.
+    #
+    # === Parameters
+    # * +name+ - The desired name of the variable on the client side.
+    # * +data+ - The data to pass to the Guilded JavaScript environment. 
+    #
+    def add_data( name, data )
+      @g_data_elements.merge!( name.to_sym => data )
+    end
   
     def count #:nodoc:
       @g_elements.size
@@ -130,15 +142,19 @@ module Guilded
     def generate_javascript_init #:nodoc:
       code = "<script type=\"text/javascript\">"
       code << "var initGuildedElements = function(){"
+      @g_data_elements.each do |name, data|
+        code << "g.#{name} = #{data.to_json};" 
+      end
       @g_elements.each_value do |guilded_def| 
-        code << "g.#{guilded_def.kind.to_s.camelize( :lower )}Init( #{guilded_def.options.to_json} );" unless guilded_def.exclude_js?
+        code << "g.#{guilded_def.kind.to_s.camelize( :lower )}Init(#{guilded_def.options.to_json});" unless guilded_def.exclude_js?
       end
-      code << "};jQuery('document').ready( initGuildedElements );</script>"
+      code << "jQuery('body').trigger('guildedInitialized');};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
@@ -146,6 +162,7 @@ module Guilded
     # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: midas-guilded
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - C. Jason Harrelson (midas)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-05-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: 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.
+description: 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 gracefully 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 gem contains the framework to build Guilded components.
 email: 
 - jason@lookforwardenterprises.com
 executables: []