in_place_editing 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/README

@@ -0,0 +1,14 @@
+InPlaceEditing
+==============
+
+Example:
+
+  # Controller
+  class BlogController < ApplicationController
+    in_place_edit_for :post, :title
+  end
+
+  # View
+  <%= in_place_editor_field :post, 'title' %>
+
+Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license  

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test in_place_editing plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for in_place_editing plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'InPlaceEditing'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/in_place_editing.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "in_place_editing"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Heinemeier Hansson", "Jeremy Kemper", "Jose Fernandez", "Pawel Stradomski"]
+  s.email       = ["mark@amerine.net"]
+  s.homepage    = "https://github.com/amerine/in_place_editing"
+  s.summary     = %q{In Place Editing Rails Plugin}
+  s.description = %q{In Place Editing Rails Plugin}
+
+  s.rubyforge_project = "in_place_editing"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1,2 @@
+ActionController::Base.send :include, InPlaceEditing
+ActionController::Base.helper InPlaceMacrosHelper

data/lib/in_place_editing.rb

@@ -0,0 +1,28 @@
+module InPlaceEditing
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Example:
+  #
+  #   # Controller
+  #   class BlogController < ApplicationController
+  #     in_place_edit_for :post, :title
+  #   end
+  #
+  #   # View
+  #   <%= in_place_editor_field :post, 'title' %>
+  #
+  module ClassMethods
+    def in_place_edit_for(object, attribute, options = {})
+      define_method("set_#{object}_#{attribute}") do
+        unless [:post, :put].include?(request.method) then
+          return render(:text => 'Method not allowed', :status => 405)
+        end
+        @item = object.to_s.camelize.constantize.find(params[:id])
+        @item.update_attribute(attribute, params[:value])
+        render :text => CGI::escapeHTML(@item.send(attribute).to_s)
+      end
+    end
+  end
+end

data/lib/in_place_macros_helper.rb

@@ -0,0 +1,80 @@
+module InPlaceMacrosHelper
+  # Makes an HTML element specified by the DOM ID +field_id+ become an in-place
+  # editor of a property.
+  #
+  # A form is automatically created and displayed when the user clicks the element,
+  # something like this:
+  #   <form id="myElement-in-place-edit-form" target="specified url">
+  #     <input name="value" text="The content of myElement"/>
+  #     <input type="submit" value="ok"/>
+  #     <a onclick="javascript to cancel the editing">cancel</a>
+  #   </form>
+  # 
+  # The form is serialized and sent to the server using an AJAX call, the action on
+  # the server should process the value and return the updated value in the body of
+  # the reponse. The element will automatically be updated with the changed value
+  # (as returned from the server).
+  # 
+  # Required +options+ are:
+  # <tt>:url</tt>::       Specifies the url where the updated value should
+  #                       be sent after the user presses "ok".
+  # 
+  # Addtional +options+ are:
+  # <tt>:rows</tt>::              Number of rows (more than 1 will use a TEXTAREA)
+  # <tt>:cols</tt>::              Number of characters the text input should span (works for both INPUT and TEXTAREA)
+  # <tt>:size</tt>::              Synonym for :cols when using a single line text input.
+  # <tt>:cancel_text</tt>::       The text on the cancel link. (default: "cancel")
+  # <tt>:save_text</tt>::         The text on the save link. (default: "ok")
+  # <tt>:loading_text</tt>::      The text to display while the data is being loaded from the server (default: "Loading...")
+  # <tt>:saving_text</tt>::       The text to display when submitting to the server (default: "Saving...")
+  # <tt>:external_control</tt>::  The id of an external control used to enter edit mode.
+  # <tt>:load_text_url</tt>::     URL where initial value of editor (content) is retrieved.
+  # <tt>:options</tt>::           Pass through options to the AJAX call (see prototype's Ajax.Updater)
+  # <tt>:with</tt>::              JavaScript snippet that should return what is to be sent
+  #                               in the AJAX call, +form+ is an implicit parameter
+  # <tt>:script</tt>::            Instructs the in-place editor to evaluate the remote JavaScript response (default: false)
+  # <tt>:click_to_edit_text</tt>::The text shown during mouseover the editable text (default: "Click to edit")
+  def in_place_editor(field_id, options = {})
+    function =  "new Ajax.InPlaceEditor("
+    function << "'#{field_id}', "
+    function << "'#{url_for(options[:url])}'"
+
+    js_options = {}
+
+    if protect_against_forgery?
+      options[:with] ||= "Form.serialize(form)"
+      options[:with] += " + '&authenticity_token=' + encodeURIComponent('#{form_authenticity_token}')"
+    end
+
+    js_options['cancelText'] = %('#{options[:cancel_text]}') if options[:cancel_text]
+    js_options['okText'] = %('#{options[:save_text]}') if options[:save_text]
+    js_options['loadingText'] = %('#{options[:loading_text]}') if options[:loading_text]
+    js_options['savingText'] = %('#{options[:saving_text]}') if options[:saving_text]
+    js_options['rows'] = options[:rows] if options[:rows]
+    js_options['cols'] = options[:cols] if options[:cols]
+    js_options['size'] = options[:size] if options[:size]
+    js_options['externalControl'] = "'#{options[:external_control]}'" if options[:external_control]
+    js_options['loadTextURL'] = "'#{url_for(options[:load_text_url])}'" if options[:load_text_url]        
+    js_options['ajaxOptions'] = options[:options] if options[:options]
+    js_options['htmlResponse'] = !options[:script] if options[:script]
+    js_options['callback']   = "function(form) { return #{options[:with]} }" if options[:with]
+    js_options['clickToEditText'] = %('#{options[:click_to_edit_text]}') if options[:click_to_edit_text]
+    js_options['textBetweenControls'] = %('#{options[:text_between_controls]}') if options[:text_between_controls]
+    function << (', ' + options_for_javascript(js_options)) unless js_options.empty?
+    
+    function << ')'
+
+    javascript_tag(function)
+  end
+  
+  # Renders the value of the specified object and method with in-place editing capabilities.
+  def in_place_editor_field(object, method, tag_options = {}, in_place_editor_options = {})
+    instance_tag = ::ActionView::Helpers::InstanceTag.new(object, method, self)
+    tag_options = {:tag => "span",
+                   :id => "#{object}_#{method}_#{instance_tag.object.id}_in_place_editor",
+                   :class => "in_place_editor_field"}.merge!(tag_options)
+    in_place_editor_options[:url] = in_place_editor_options[:url] || url_for({ :action => "set_#{object}_#{method}", :id => instance_tag.object.id })
+    tag = content_tag(tag_options.delete(:tag), h(instance_tag.value(instance_tag.object)),tag_options)
+    return tag + in_place_editor(tag_options[:id], in_place_editor_options)
+  end
+end

data/test/in_place_editing_test.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + "/test_helper")
+
+class InPlaceEditingTest < Test::Unit::TestCase
+  include InPlaceEditing
+  include InPlaceMacrosHelper
+  
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::CaptureHelper
+  
+  def setup
+    @controller = Class.new do
+      def url_for(options)
+        url =  "http://www.example.com/"
+        url << options[:action].to_s if options and options[:action]
+        url
+      end
+    end
+    @controller = @controller.new
+    @protect_against_forgery = false
+  end
+
+  def protect_against_forgery?
+    @protect_against_forgery
+  end
+
+  def test_in_place_editor_external_control
+      assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {externalControl:'blah'})\n//]]>\n</script>),
+        in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :external_control => 'blah'})
+  end
+  
+  def test_in_place_editor_size
+      assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {size:4})\n//]]>\n</script>),
+        in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :size => 4})
+  end
+  
+  def test_in_place_editor_cols_no_rows
+      assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {cols:4})\n//]]>\n</script>),
+        in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :cols => 4})
+  end
+  
+  def test_in_place_editor_cols_with_rows
+      assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {cols:40, rows:5})\n//]]>\n</script>),
+        in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :rows => 5, :cols => 40})
+  end
+
+  def test_inplace_editor_loading_text
+      assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {loadingText:'Why are we waiting?'})\n//]]>\n</script>),
+        in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :loading_text => 'Why are we waiting?'})
+  end
+  
+  def test_in_place_editor_url
+    assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value')",
+    in_place_editor( 'id-goes-here', :url => { :action => "action_to_set_value" })    
+  end
+  
+  def test_in_place_editor_load_text_url
+    assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {loadTextURL:'http://www.example.com/action_to_get_value'})",
+    in_place_editor( 'id-goes-here', 
+      :url => { :action => "action_to_set_value" }, 
+      :load_text_url => { :action => "action_to_get_value" })
+  end
+  
+  def test_in_place_editor_html_response
+    assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {htmlResponse:false})",
+    in_place_editor( 'id-goes-here', 
+      :url => { :action => "action_to_set_value" }, 
+      :script => true )
+  end
+  
+  def form_authenticity_token
+    "authenticity token"
+  end
+
+  def test_in_place_editor_with_forgery_protection
+    @protect_against_forgery = true
+    assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {callback:function(form) { return Form.serialize(form) + '&authenticity_token=' + encodeURIComponent('authenticity token') }})",
+    in_place_editor( 'id-goes-here', :url => { :action => "action_to_set_value" })
+  end
+
+  def test_in_place_editor_text_between_controls
+    assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {textBetweenControls:'or'})",
+    in_place_editor( 'id-goes-here',
+      :url => { :action => "action_to_set_value" },
+      :text_between_controls => "or" )
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'rubygems'
+require 'action_controller'
+require 'action_controller/assertions'
+require 'in_place_editing'
+require 'in_place_macros_helper'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: in_place_editing
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Heinemeier Hansson
+- Jeremy Kemper
+- Jose Fernandez
+- Pawel Stradomski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: In Place Editing Rails Plugin
+email: 
+- mark@amerine.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README
+- Rakefile
+- in_place_editing.gemspec
+- init.rb
+- lib/in_place_editing.rb
+- lib/in_place_macros_helper.rb
+- test/in_place_editing_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/amerine/in_place_editing
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: in_place_editing
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: In Place Editing Rails Plugin
+test_files: 
+- test/in_place_editing_test.rb
+- test/test_helper.rb