Updating for ajax style json editing of nodes, simple as possible

Author: adamhjk

chef-server/lib/controllers/nodes.rb

@@ -35,8 +35,11 @@ def show
     rescue Net::HTTPServerException => e
       raise NotFound, "Cannot load node #{params[:id]}"
     end
-
-    display @node
+    if params[:ajax] == "true"
+      render JSON.pretty_generate(@node)
+    else
+      display @node
+    end
   end
 
   def create
@@ -51,11 +54,20 @@ def create
   end
 
   def update
-    @node = params.has_key?("inflated_object") ? params["inflated_object"] : nil
+    if params[:ajax]
+      @node = JSON.parse(params[:value])
+    else      
+      @node = params.has_key?("inflated_object") ? params["inflated_object"] : nil
+    end
+    
     if @node
       @status = 202
       @node.save
-      display @node
+      if params[:ajax]
+        render partial("nodes/node", :node => @node)
+      else
+        display @node
+      end
     else
       raise NotFound, "You must provide a Node to update"
     end

chef-server/lib/public/javascript/chef.js

@@ -16,15 +16,16 @@
 // limitations under the License.
 //
 
-// $(document).ready(function() {
-//   $(".edit_area").editable(location.href + ".json", { 
-//       type      : 'textarea',
-//       cancel    : 'Cancel',
-//       submit    : 'Save',
-//       indicator : "<img src='/images/indicator.gif'>",
-//       target    : location.href + ".json",
-//       loadtype  : "GET",
-//       loadurl   : location.href + ".json?pretty=true",
-//       tooltip   : 'Click to edit...'
-//   });
-// });
+$(document).ready(function() {
+  $(".edit_area").editable(location.href + ".json", { 
+      type      : 'textarea',
+      cancel    : 'Cancel',
+      submit    : 'Save',
+      indicator : "<img src='/images/indicator.gif'>",
+      target    : location.href + ".json?ajax=true",
+      loadtype  : "GET",
+      loadurl   : location.href + ".json?ajax=true",
+      tooltip   : 'Click to edit...',
+      method : "PUT"
+  });
+});

chef-server/lib/views/nodes/_node.html.haml

@@ -1,7 +1,7 @@
 .node
   %h1 
     = "Node #{h node.name}" 
-  %div.edit_area#node{:to_update => node.name}
+  .edit_area#node{:to_update => node.name}
     %h2 Recipes
     %ol
       = recipe_list(node)

chef/Rakefile

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 require 'rubygems'
 require 'rake/gempackagetask'
+require 'rake/rdoctask'
 require './tasks/rspec.rb'
 
 GEM = "chef"
@@ -40,6 +41,10 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+end
+
 task :install => [:package] do
   sh %{sudo gem install pkg/#{GEM}-#{VERSION} --no-rdoc --no-ri}
 end

chef/lib/chef/compile.rb

@@ -33,6 +33,9 @@ def initialize()
     # Chef::Node.find_file(name)
     #
     # The first step in compiling the catalog. Results available via the node accessor.
+    #
+    # === Returns
+    # <Chef::Node>:: The loaded Chef Node
     def load_node(name)
       Chef::Log.debug("Loading Chef Node #{name} from CouchDB")
       @node = Chef::Node.load(name)
@@ -42,6 +45,9 @@ def load_node(name)
     end
 
     # Load all the attributes, from every cookbook
+    #
+    # === Returns
+    # true:: Always returns true
     def load_attributes()
       @cookbook_loader.each do |cookbook|
         cookbook.load_attributes(@node)
@@ -53,16 +59,22 @@ def load_attributes()
     # the recipes.
     #
     # Results available via the definitions accessor.
+    #
+    # === Returns
+    # true:: Always returns true
     def load_definitions()
       @cookbook_loader.each do |cookbook|
         hash = cookbook.load_definitions
         @definitions.merge!(hash)
       end
+      true
     end
 
     # Load all the libraries, from every cookbook, so they are available when we process
     # the recipes.
     #
+    # === Returns
+    # true:: Always returns true
     def load_libraries()
       @cookbook_loader.each do |cookbook|
         cookbook.load_libraries
@@ -74,6 +86,9 @@ def load_libraries()
     # 
     # The results are available via the collection accessor (which returns a Chef::ResourceCollection 
     # object)
+    #
+    # === Returns
+    # true:: Always returns true
     def load_recipes
       @node.recipes.each do |recipe|
         Chef::Log.debug("Loading Recipe #{recipe}")
@@ -86,6 +101,7 @@ def load_recipes
          cookbook.load_recipe("default", @node, @collection, @definitions, @cookbook_loader)
         end
       end
+      true
     end
 
   end

chef/lib/chef/config.rb

@@ -62,10 +62,24 @@ class Config
     class << self
       include Chef::Mixin::FromFile
 
+      # Pass Chef::Config.configure() a block, and it will yield @configuration.
+      #
+      # === Parameters
+      # <block>:: A block that takes @configure as it's argument
       def configure(&block)
         yield @configuration
       end
 
+      # Get the value of a configuration option
+      #
+      # === Parameters
+      # config_option<Symbol>:: The configuration option to return
+      #
+      # === Returns
+      # value:: The value of the configuration option
+      #
+      # === Raises
+      # <ArgumentError>:: If the configuration option does not exist
       def [](config_option)
         if @configuration.has_key?(config_option.to_sym)
           @configuration[config_option.to_sym]
@@ -74,14 +88,43 @@ def [](config_option)
         end
       end
 
+      # Set the value of a configuration option
+      #
+      # === Parameters
+      # config_option<Symbol>:: The configuration option to set (within the [])
+      # value:: The value for the configuration option
+      #
+      # === Returns
+      # value:: The new value of the configuration option
       def []=(config_option, value)
         @configuration[config_option.to_sym] = value
       end
 
+      # Check if Chef::Config has a configuration option.
+      #
+      # === Parameters
+      # key<Symbol>:: The configuration option to check for
+      #
+      # === Returns
+      # <True>:: If the configuration option exists
+      # <False>:: If the configuration option does not exist
       def has_key?(key)
         @configuration.has_key?(key.to_sym)
       end
-    
+      
+      # Allows for simple lookups and setting of configuration options via method calls
+      # on Chef::Config.  If there any arguments to the method, they are used to set
+      # the value of the configuration option.  Otherwise, it's a simple get operation.
+      #
+      # === Parameters
+      # method_symbol<Symbol>:: The method called.  Must match a configuration option.
+      # *args:: Any arguments passed to the method
+      #
+      # === Returns
+      # value:: The value of the configuration option.
+      #
+      # === Raises
+      # <ArgumentError>:: If the method_symbol does not match a configuration option.
       def method_missing(method_symbol, *args)
         if @configuration.has_key?(method_symbol)
           if args.length == 1