on_the_spot 0.0.0.beta2

data/.document

@@ -0,0 +1,5 @@
+README.markdown
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "rake"
+gem "jeweler"
+gem "rspec",   ">= 2.0.0.beta.20"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 nathanvda
+
+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/README.markdown

@@ -0,0 +1,63 @@
+# on_the_spot
+
+On-the-spot is a Rails3 compliant unobtrusive javascript in-place-editing plugin, using jEditable.
+(currently a work in progress, extracted it from a rails3 application)
+
+## Installation
+
+Inside your `Gemfile` add the following:
+
+    gem "on_the_spot"
+
+Run the installation task:
+
+    rails g on_the_spot:install
+
+Inside your `routes.rb` you provide the catch-all
+
+      match ':controller(/:action(/:id(.:format)))'
+
+This is not ideal: i am looking for a better solution.
+
+But that is all you need to do to start using it!
+
+
+## Usage
+Inside your controller you write:
+
+
+    class YourController < ApplicationController
+
+      can_edit_on_the_spot
+
+      ... leave the rest of your controller alone ...
+
+    end
+
+And inside your view you will have to specify the fields you want to be "editable" :
+
+    Username: <%= on_the_spot_edit @user, :name %>
+
+
+It should be as simple as that :)
+
+## To do
+
+- make sure you can overrule ok/cancel texts
+- make sure user can choose to use a textarea instead of just text
+- find a clean solution for the routes
+- add tests!
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 nathanvda. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "on_the_spot"
+    gem.summary = %Q{unobtrusive in place editing}
+    gem.description = %Q{Unobtrusive in place editing, using jEditable; only works in Rails 3}
+    gem.email = "nathan@dixis.com"
+    gem.homepage = "http://github.com/nathanvda/on_the_spot"
+    gem.authors = ["Nathan Van der Auwera"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta20"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "on_the_spot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0.beta2

data/lib/generators/on_the_spot/install/install_generator.rb

@@ -0,0 +1,19 @@
+module OnTheSpot
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc "This generator installs jEditable and some glue javascript"
+
+      def download_jeditable
+        # Downloading latest jQuery
+        get "http://www.appelsiini.net/download/jquery.jeditable.mini.js", "public/javascripts/jquery.jeditable.mini.js"
+      end
+
+      def copy_glue_javascript
+        # !!!!! TO DO: check this -> how do a copy?
+        copy_file "on_the_spot.js", "public/javascripts/on_the_spot.js"
+      end
+
+    end
+  end
+end

data/lib/generators/on_the_spot/install/templates/jquery.jeditable.mini.js

@@ -0,0 +1,38 @@
+
+(function($){$.fn.editable=function(target,options){if('disable'==target){$(this).data('disabled.editable',true);return;}
+if('enable'==target){$(this).data('disabled.editable',false);return;}
+if('destroy'==target){$(this).unbind($(this).data('event.editable')).removeData('disabled.editable').removeData('event.editable');return;}
+var settings=$.extend({},$.fn.editable.defaults,{target:target},options);var plugin=$.editable.types[settings.type].plugin||function(){};var submit=$.editable.types[settings.type].submit||function(){};var buttons=$.editable.types[settings.type].buttons||$.editable.types['defaults'].buttons;var content=$.editable.types[settings.type].content||$.editable.types['defaults'].content;var element=$.editable.types[settings.type].element||$.editable.types['defaults'].element;var reset=$.editable.types[settings.type].reset||$.editable.types['defaults'].reset;var callback=settings.callback||function(){};var onedit=settings.onedit||function(){};var onsubmit=settings.onsubmit||function(){};var onreset=settings.onreset||function(){};var onerror=settings.onerror||reset;if(settings.tooltip){$(this).attr('title',settings.tooltip);}
+settings.autowidth='auto'==settings.width;settings.autoheight='auto'==settings.height;return this.each(function(){var self=this;var savedwidth=$(self).width();var savedheight=$(self).height();$(this).data('event.editable',settings.event);if(!$.trim($(this).html())){$(this).html(settings.placeholder);}
+$(this).bind(settings.event,function(e){if(true===$(this).data('disabled.editable')){return;}
+if(self.editing){return;}
+if(false===onedit.apply(this,[settings,self])){return;}
+e.preventDefault();e.stopPropagation();if(settings.tooltip){$(self).removeAttr('title');}
+if(0==$(self).width()){settings.width=savedwidth;settings.height=savedheight;}else{if(settings.width!='none'){settings.width=settings.autowidth?$(self).width():settings.width;}
+if(settings.height!='none'){settings.height=settings.autoheight?$(self).height():settings.height;}}
+if($(this).html().toLowerCase().replace(/(;|")/g,'')==settings.placeholder.toLowerCase().replace(/(;|")/g,'')){$(this).html('');}
+self.editing=true;self.revert=$(self).html();$(self).html('');var form=$('<form />');if(settings.cssclass){if('inherit'==settings.cssclass){form.attr('class',$(self).attr('class'));}else{form.attr('class',settings.cssclass);}}
+if(settings.style){if('inherit'==settings.style){form.attr('style',$(self).attr('style'));form.css('display',$(self).css('display'));}else{form.attr('style',settings.style);}}
+var input=element.apply(form,[settings,self]);var input_content;if(settings.loadurl){var t=setTimeout(function(){input.disabled=true;content.apply(form,[settings.loadtext,settings,self]);},100);var loaddata={};loaddata[settings.id]=self.id;if($.isFunction(settings.loaddata)){$.extend(loaddata,settings.loaddata.apply(self,[self.revert,settings]));}else{$.extend(loaddata,settings.loaddata);}
+$.ajax({type:settings.loadtype,url:settings.loadurl,data:loaddata,async:false,success:function(result){window.clearTimeout(t);input_content=result;input.disabled=false;}});}else if(settings.data){input_content=settings.data;if($.isFunction(settings.data)){input_content=settings.data.apply(self,[self.revert,settings]);}}else{input_content=self.revert;}
+content.apply(form,[input_content,settings,self]);input.attr('name',settings.name);buttons.apply(form,[settings,self]);$(self).append(form);plugin.apply(form,[settings,self]);$(':input:visible:enabled:first',form).focus();if(settings.select){input.select();}
+input.keydown(function(e){if(e.keyCode==27){e.preventDefault();reset.apply(form,[settings,self]);}});var t;if('cancel'==settings.onblur){input.blur(function(e){t=setTimeout(function(){reset.apply(form,[settings,self]);},500);});}else if('submit'==settings.onblur){input.blur(function(e){t=setTimeout(function(){form.submit();},200);});}else if($.isFunction(settings.onblur)){input.blur(function(e){settings.onblur.apply(self,[input.val(),settings]);});}else{input.blur(function(e){});}
+form.submit(function(e){if(t){clearTimeout(t);}
+e.preventDefault();if(false!==onsubmit.apply(form,[settings,self])){if(false!==submit.apply(form,[settings,self])){if($.isFunction(settings.target)){var str=settings.target.apply(self,[input.val(),settings]);$(self).html(str);self.editing=false;callback.apply(self,[self.innerHTML,settings]);if(!$.trim($(self).html())){$(self).html(settings.placeholder);}}else{var submitdata={};submitdata[settings.name]=input.val();submitdata[settings.id]=self.id;if($.isFunction(settings.submitdata)){$.extend(submitdata,settings.submitdata.apply(self,[self.revert,settings]));}else{$.extend(submitdata,settings.submitdata);}
+if('PUT'==settings.method){submitdata['_method']='put';}
+$(self).html(settings.indicator);var ajaxoptions={type:'POST',data:submitdata,dataType:'html',url:settings.target,success:function(result,status){if(ajaxoptions.dataType=='html'){$(self).html(result);}
+self.editing=false;callback.apply(self,[result,settings]);if(!$.trim($(self).html())){$(self).html(settings.placeholder);}},error:function(xhr,status,error){onerror.apply(form,[settings,self,xhr]);}};$.extend(ajaxoptions,settings.ajaxoptions);$.ajax(ajaxoptions);}}}
+$(self).attr('title',settings.tooltip);return false;});});this.reset=function(form){if(this.editing){if(false!==onreset.apply(form,[settings,self])){$(self).html(self.revert);self.editing=false;if(!$.trim($(self).html())){$(self).html(settings.placeholder);}
+if(settings.tooltip){$(self).attr('title',settings.tooltip);}}}};});};$.editable={types:{defaults:{element:function(settings,original){var input=$('<input type="hidden"></input>');$(this).append(input);return(input);},content:function(string,settings,original){$(':input:first',this).val(string);},reset:function(settings,original){original.reset(this);},buttons:function(settings,original){var form=this;if(settings.submit){if(settings.submit.match(/>$/)){var submit=$(settings.submit).click(function(){if(submit.attr("type")!="submit"){form.submit();}});}else{var submit=$('<button type="submit" />');submit.html(settings.submit);}
+$(this).append(submit);}
+if(settings.cancel){if(settings.cancel.match(/>$/)){var cancel=$(settings.cancel);}else{var cancel=$('<button type="cancel" />');cancel.html(settings.cancel);}
+$(this).append(cancel);$(cancel).click(function(event){if($.isFunction($.editable.types[settings.type].reset)){var reset=$.editable.types[settings.type].reset;}else{var reset=$.editable.types['defaults'].reset;}
+reset.apply(form,[settings,original]);return false;});}}},text:{element:function(settings,original){var input=$('<input />');if(settings.width!='none'){input.width(settings.width);}
+if(settings.height!='none'){input.height(settings.height);}
+input.attr('autocomplete','off');$(this).append(input);return(input);}},textarea:{element:function(settings,original){var textarea=$('<textarea />');if(settings.rows){textarea.attr('rows',settings.rows);}else if(settings.height!="none"){textarea.height(settings.height);}
+if(settings.cols){textarea.attr('cols',settings.cols);}else if(settings.width!="none"){textarea.width(settings.width);}
+$(this).append(textarea);return(textarea);}},select:{element:function(settings,original){var select=$('<select />');$(this).append(select);return(select);},content:function(data,settings,original){if(String==data.constructor){eval('var json = '+data);}else{var json=data;}
+for(var key in json){if(!json.hasOwnProperty(key)){continue;}
+if('selected'==key){continue;}
+var option=$('<option />').val(key).append(json[key]);$('select',this).append(option);}
+$('select',this).children().each(function(){if($(this).val()==json['selected']||$(this).text()==$.trim(original.revert)){$(this).attr('selected','selected');}});}}},addInputType:function(name,input){$.editable.types[name]=input;}};$.fn.editable.defaults={name:'value',id:'id',type:'text',width:'auto',height:'auto',event:'click.editable',onblur:'cancel',loadtype:'GET',loadtext:'Loading...',placeholder:'Click to edit',loaddata:{},submitdata:{},ajaxoptions:{}};})(jQuery);

data/lib/generators/on_the_spot/install/templates/on_the_spot.js

@@ -0,0 +1,28 @@
+$(document).ready(function() {
+
+    $(".on_the_spot_editing").mouseover(function() {
+        $(this).css('background-color', '#EEF2A0');
+    });
+    $(".on_the_spot_editing").mouseout(function() {
+        $(this).css('background-color', 'inherit');
+    });
+/*    $('.on_the_spot_editing').editable(this.attr('data-url'), {
+        tooltip: 'Click to edit...',
+        cancel : 'Cancel',
+        submit : 'OK'
+    });*/
+    $('.on_the_spot_editing').each(function(n){
+        var el           = $(this),
+            data_url     = el.attr('data-url'),
+            ok_text      = el.attr('data-ok') || 'OK',
+            cancel_text  = el.attr('data-cancel') || 'Cancel',
+            tooltip_text = el.attr('data-tooltip') || 'Click to edit ...';
+
+        el.editable(data_url, {
+            tooltip: tooltip_text,
+            cancel: cancel_text,
+            submit: ok_text
+        })
+    })
+
+});

data/lib/on_the_spot.rb

@@ -0,0 +1,19 @@
+require 'on_the_spot/controller_extension'
+require 'on_the_spot/on_the_spot_helpers'
+
+module OnTheSpot
+  class Railtie < ::Rails::Railtie
+
+    config.before_initialize do
+      config.action_view.javascript_expansions[:on_the_spot] = %w(jquery.jeditable.mini.js on_the_spot)
+    end
+
+    # configure our plugin on boot. other extension points such
+    # as configuration, rake tasks, etc, are also available
+    initializer "on_the_spot.initialize" do |app|
+      ActionController::Base.send :include, OnTheSpot::ControllerExtension
+      ActionView::Base.send :include, OnTheSpot::Helpers
+    end
+
+  end
+end

data/lib/on_the_spot/controller_extension.rb

@@ -0,0 +1,22 @@
+module OnTheSpot
+  module ControllerExtension
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # if this method is called inside a controller, the edit-on-the-spot
+    # controller action is added that will allow to edit fields in place
+    module ClassMethods
+      def can_edit_on_the_spot
+        define_method :update_attribute_on_the_spot do
+          klass, field, id = params[:id].split('__')
+          object = klass.camelize.constantize.find(id)
+          object.update_attribute(field, params[:value])
+          render :text => CGI::escapeHTML(object.send(field).to_s)
+        end
+      end
+    end
+    
+  end
+end

data/lib/on_the_spot/on_the_spot_helpers.rb

@@ -0,0 +1,21 @@
+module OnTheSpot
+  module Helpers
+
+    def on_the_spot_edit(object, field, options={})
+      #!!! to do: translate options to data-fields
+      # Possible fields:
+      #  url?
+      #  type: textarea or not
+      #  button-translations ok-Text, cancel-Text
+      #
+      update_url = url_for(:action => 'update_attribute_on_the_spot')
+
+      content_tag("span", :id => "#{object.class.name.underscore}__#{field}__#{object.id}",
+                  :class => 'on_the_spot_editing',
+                  :'data-url' => update_url) do
+        object.send(field.to_sym).to_s
+      end
+    end
+
+  end
+end

data/on_the_spot.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{on_the_spot}
+  s.version = "0.0.0.beta2"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Van der Auwera"]
+  s.date = %q{2010-09-05}
+  s.description = %q{Unobtrusive in place editing, using jEditable; only works in Rails 3}
+  s.email = %q{nathan@dixis.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/on_the_spot/install/install_generator.rb",
+     "lib/generators/on_the_spot/install/templates/jquery.jeditable.mini.js",
+     "lib/generators/on_the_spot/install/templates/on_the_spot.js",
+     "lib/on_the_spot.rb",
+     "lib/on_the_spot/controller_extension.rb",
+     "lib/on_the_spot/on_the_spot_helpers.rb",
+     "on_the_spot.gemspec",
+     "spec/on_the_spot_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/nathanvda/on_the_spot}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{unobtrusive in place editing}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/on_the_spot_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta20"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta20"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta20"])
+  end
+end
+

data/spec/on_the_spot_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "OnTheSpot" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'on_the_spot'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: on_the_spot
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 0
+  - beta2
+  version: 0.0.0.beta2
+platform: ruby
+authors: 
+- Nathan Van der Auwera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta20
+        version: 2.0.0.beta20
+  type: :development
+  version_requirements: *id001
+description: Unobtrusive in place editing, using jEditable; only works in Rails 3
+email: nathan@dixis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/generators/on_the_spot/install/install_generator.rb
+- lib/generators/on_the_spot/install/templates/jquery.jeditable.mini.js
+- lib/generators/on_the_spot/install/templates/on_the_spot.js
+- lib/on_the_spot.rb
+- lib/on_the_spot/controller_extension.rb
+- lib/on_the_spot/on_the_spot_helpers.rb
+- on_the_spot.gemspec
+- spec/on_the_spot_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nathanvda/on_the_spot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: unobtrusive in place editing
+test_files: 
+- spec/spec_helper.rb
+- spec/on_the_spot_spec.rb