on_the_spot 0.0.17 → 0.0.18

data/History.md

@@ -1,5 +1,10 @@
 # Change History / Release Notes
 
+## Version 0.0.18 (11/12/2011)
+
+* added support for a `:display_method` which will make working with formatted editable content much easier
+* added the option to specify a function to verify the access
+
 ## Version 0.0.17 (1/11/2011)
 
 * added support for `onblur` action: when focus is lost, allow to autosave.

data/README.markdown

@@ -4,6 +4,17 @@
 
 On-the-spot is a Rails3 compliant unobtrusive javascript in-place-editing plugin, using jEditable, and depends on jQuery.
 
+## Features
+
+* built on proven jQuery plugin `jEditable`
+* works on index-pages, nested objects, ...
+* can generate simple edit-boxes, textareas, dropdown lists, checkboxes
+* will check your server-side validations and show the error
+* you can check the access-rights before doing any update (to check against tampering)
+* you can use custom display methods, e.g when using markdown
+* watch the demo-project [here]() ([source](https://github.com/nathanvda/on_the_spot_tester))
+
+
 ## Installation
 
 Inside your `Gemfile` add the following:
@@ -26,6 +37,14 @@ Or, inside your `application.html.haml` you could still include the needed javas
 
     = javascript_include_tag :on_the_spot
 
+To use the default styling, add the following to application.css so it compiles to the asset_pipeline
+
+	//= require on_the_spot
+
+Or, inside your `application.html.haml` you could still include the needed css, using
+
+	= stylesheet_link_tag :on_the_spot
+
 
 ### Rails 3.0.x
 
@@ -37,6 +56,15 @@ or using erb, you write
 
     <%= javascript_include_tag :on_the_spot %>
 
+To use the default styling, inside your `application.html.haml` you will need to add below the default CSS:
+
+    = stylesheet_link_tag :on_the_spot
+
+or using erb, you write
+
+    <%= stylesheet_link_tag :on_the_spot %>
+
+
 ### Routes (for all Rails 3 versions)
 
 Inside your `routes.rb` you need to provide the following route :
@@ -44,12 +72,14 @@ Inside your `routes.rb` you need to provide the following route :
     resources :posts do
       collection do
         put :update_attribute_on_the_spot
+        get :get_attribute_on_the_spot
       end
     end
 
 You need to do this for each controller that uses the on-the-spot editing.
-For the moment i do not know of any better solution, but i am always open for suggestions!
 
+You only need to specify the route for `get_attribute_on_the_spot` if you make use of the `:display_method` option,
+and do not want to supply your own load-function.
 
 That is all you need to do to start using it!
 
@@ -89,10 +119,21 @@ The `on_the_spot_edit` also accepts options:
 * `:url`: URL to post to if you don't want to use the standard routes
 * `:selected`: Text selected by default on edit (boolean, default is false)
 * `:callback`: The name of a javascript function that is called after form has been submitted
+* `:display_method`: the name of a method that is used to get the value to display of a field. When you use this, we will automatically
+   attempt to look up the raw value of the field to edit.  This differs from the `:display_text` option, as this will also be called after update.
+   This supersedes the `:display_text` option.
 
 
 For the texts: if a text is not specified, the default is taken from the `on_the_spot.en.yml` (or your current language).
 
+## Styling
+
+Each element that is editable will have the `on_the_spot_editing` class.
+
+When an element is moused over, it will get the `on_the_spot_over` class.
+
+You can use these classes to style the elements.
+
 ## Example Usages
 
 ### Edit field
@@ -119,6 +160,31 @@ For the texts: if a text is not specified, the default is taken from the `on_the
     <%= on_the_spot_edit @user, :name, :callback => 'testCallback' %>
 
 
+## Using together with `cancan`
+
+When using `on_the_spot` together with `cancan`, you will have to explicitly exclude the on_the_spot method,
+like so:
+
+    before_filter :load_and_authorize_resource, :except => [:update_attribute_on_the_spot]
+    
+The `load_and_authorize_resource` will try to find the object, based on the id in the parameters, but `on_the_spot` uses a different
+encoding to store the object, field and id in one attribute. So if you exclude that, there will not be a problem.
+
+
+## Using together with an authorization system (e.g. Cancan)
+
+If you want to test access-rights, you can do so by specifying a method which will be called
+
+In your controller write:
+
+    can_edit_on_the_spot :check_access
+
+    def check_access(object, field)
+      # verify that the current user has access to edit/see the field of given object
+    end
+
+
+
 ## Example project
 
 There is an example rails3-project called [on_the_spot_tester](http://github.com/nathanvda/on_the_spot_tester)

data/VERSION

@@ -1 +1 @@
-0.0.17
+0.0.18

data/app/assets/css/on_the_spot.css

@@ -0,0 +1 @@
+.on_the_spot_over { background: #EEF2A0; }

data/app/assets/javascripts/on_the_spot_code.js

@@ -1,10 +1,10 @@
 $(document).ready(function() {
 
     $(".on_the_spot_editing").mouseover(function() {
-        $(this).css('background-color', '#EEF2A0');
+		$(this).addClass('on_the_spot_over');
     });
     $(".on_the_spot_editing").mouseout(function() {
-        $(this).css('background-color', 'inherit');
+		$(this).removeClass('on_the_spot_over');
     });
     $('.on_the_spot_editing').each(initializeOnTheSpot);
 
@@ -24,6 +24,7 @@ function initializeOnTheSpot(n){
         load_url      = el.attr('data-loadurl'),
         selected      = el.attr('data-selected'),
         onblur_action = el.attr('data-onblur') || 'cancel',
+        method_name   = el.attr('data-display-method') || '',
         callback      = el.attr('data-callback');
 
 
@@ -42,6 +43,7 @@ function initializeOnTheSpot(n){
         onblur: onblur_action,
         submitdata: {
           authenticity_token: auth_token,
+          display_method: method_name,
           _method: 'put'
         },
         callback: callback ? new Function("value", "settings", "return "+callback+"(this, value, settings);") : null
@@ -63,5 +65,5 @@ function initializeOnTheSpot(n){
         options.cols = columns;
     }
 
-    el.editable(data_url, options)
+    el.editable(data_url, options);
 }

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

@@ -13,7 +13,7 @@ module OnTheSpot
         if ::Rails.version[0..2].to_f >= 3.1
           #puts "The javascripts do not need to be installed since Rails 3.1"
         else
-          copy_file "../../../../../app/assets/javascripts/on_the_spot.js", "public/javascripts/on_the_spot.js"
+          copy_file "../../../../../app/assets/javascripts/on_the_spot_code.js", "public/javascripts/on_the_spot.js"
           copy_file "../../../../../app/assets/javascripts/jquery.jeditable.mini.js", "public/javascripts/jquery.jeditable.mini.js"
           copy_file "../../../../../app/assets/javascripts/jquery.jeditable.checkbox.js", "public/javascripts/jquery.jeditable.checkbox.js"
         end

data/lib/on_the_spot/controller_extension.rb

@@ -8,20 +8,48 @@ module OnTheSpot
     # 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
+      def can_edit_on_the_spot(check_acces_method=nil)
         define_method :update_attribute_on_the_spot do
           klass, field, id = params[:id].split('__')
           select_data = params[:select_array]
+          display_method = params[:display_method]
+
           object = klass.camelize.constantize.find(id)
-          if object.update_attributes(field => params[:value])
-            if select_data.nil?
-              render :text => CGI::escapeHTML(object.send(field).to_s)
+
+          is_allowed = check_acces_method.present? ? self.send(check_acces_method, object, field) : true
+
+          if is_allowed
+            if object.update_attributes(field => params[:value])
+              if select_data.nil?
+                field_or_method = if display_method.present?
+                                    object.send(display_method)
+                                  else
+                                    CGI::escapeHTML(object.send(field).to_s)
+                                  end
+                render :text => field_or_method
+              else
+                parsed_data = JSON.parse(select_data.gsub("'", '"'))
+                render :text => parsed_data[object.send(field).to_s]
+              end
             else
-              parsed_data = JSON.parse(select_data.gsub("'", '"'))
-              render :text => parsed_data[object.send(field).to_s]
+              render :text => object.errors.full_messages.join("\n"), :status => 422
             end
           else
-            render :text => object.errors.full_messages.join("\n"), :status => 422
+            render :text => "Acces is not allowed", :status => 422
+          end
+        end
+
+        define_method :get_attribute_on_the_spot do
+          klass, field, id = params[:id].split('__')
+
+          object = klass.camelize.constantize.find(id)
+
+          is_allowed = check_acces_method.present? ? self.send(check_acces_method, object, field) : true
+
+          if is_allowed
+            render :text => object.send(field)
+          else
+            render :text => "Acces is not allowed", :status => 422
           end
         end
       end

data/lib/on_the_spot/on_the_spot_helpers.rb

@@ -20,14 +20,6 @@ module OnTheSpot
     #   selected     : (optional) boolean, text selected on edit
     #   callback     : (optional) a javascript function that is called after form has been submitted
     def on_the_spot_edit(object, field, options={})
-      #!!! to do: translate options to data-fields
-      # Possible fields:
-      #  type: textarea or not
-      #  button-translations ok-Text, cancel-Text
-      #
-
-
-
       options.reverse_merge!(:ok_text     => t('on_the_spot.ok'),
                              :cancel_text => t('on_the_spot.cancel'),
                              :tooltip     => t('on_the_spot.tooltip'),
@@ -52,21 +44,27 @@ module OnTheSpot
         raise OnTheSpotMissingParameters.new("Using type select needs either data or loadurl to function!") if select_data.nil?
         html_options[:'data-select']  = convert_array_to_json(select_data, field_value)
       elsif editable_type == :textarea
-        html_options[:'data-rows']      = options[:rows]
-        html_options[:'data-columns']   = options[:columns]
+        html_options[:'data-rows']         = options[:rows]
+        html_options[:'data-columns']      = options[:columns]
+      end
+      html_options[:'data-ok']             = options[:ok_text]
+      html_options[:'data-cancel']         = options[:cancel_text]
+      html_options[:'data-tooltip']        = options[:tooltip]
+      html_options[:'data-auth']           = form_authenticity_token if defined? form_authenticity_token
+      html_options[:'data-selected']       = options[:selected]
+      html_options[:'data-callback']       = options[:callback]
+      html_options[:'data-onblur']         = options[:onblur] if options[:onblur] && ['cancel','submit', 'ignore'].include?(options[:onblur])
+      html_options[:'data-loadurl']        = options[:loadurl] unless options[:loadurl].nil?
+      html_options[:'data-display-method'] = options[:display_method] unless options[:display_method].nil?
+      if html_options[:'data-display-method'].present? && html_options[:'data-loadurl'].nil?
+        html_options[:'data-loadurl'] = url_for(:action => 'get_attribute_on_the_spot')
       end
-      html_options[:'data-ok']          = options[:ok_text]
-      html_options[:'data-cancel']      = options[:cancel_text]
-      html_options[:'data-tooltip']     = options[:tooltip]
-      html_options[:'data-auth']        = form_authenticity_token if defined? form_authenticity_token
-      html_options[:'data-selected']    = options[:selected]
-      html_options[:'data-callback']    = options[:callback]
-      html_options[:'data-onblur']      = options[:onblur] if options[:onblur] && ['cancel','submit', 'ignore'].include?(options[:onblur])
-      html_options[:'data-loadurl']     = options[:loadurl] unless options[:loadurl].nil?
         
       content_tag("span", html_options) do
         if options[:display_text]
           options[:display_text]
+        elsif options[:display_method]
+          object.send(options[:display_method].to_sym).to_s
         elsif editable_type == :select && options[:loadurl].nil?
           lookup_display_value(select_data, field_value)
         else

data/on_the_spot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{on_the_spot}
-  s.version = "0.0.17"
+  s.version = "0.0.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = %q{2011-11-06}
+  s.date = %q{2011-12-12}
   s.description = %q{Unobtrusive in place editing, using jEditable; only works in Rails 3}
   s.email = %q{nathan@dixis.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "README.markdown",
     "Rakefile",
     "VERSION",
+    "app/assets/css/on_the_spot.css",
     "app/assets/javascripts/jquery.jeditable.checkbox.js",
     "app/assets/javascripts/jquery.jeditable.mini.js",
     "app/assets/javascripts/on_the_spot.js",

data/spec/on_the_spot_spec.rb

@@ -67,6 +67,23 @@ describe "OnTheSpot" do
           @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-ok=\"ok\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">jediknight</span>"
         end
 
+        it "makes the correct html for an edit-field and use the display-method as string" do
+          @dummy.should_receive(:changed_content).and_return("test-changed")
+          @tester.should_receive(:url_for).with({:action => 'get_attribute_on_the_spot'}).and_return('/bla-again')
+
+          @result = @tester.on_the_spot_edit @dummy, :content, :display_method => 'changed_content'
+          @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-display-method=\"changed_content\" data-loadurl=\"/bla-again\" data-ok=\"ok\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">test-changed</span>"
+        end
+
+        it "makes the correct html for an edit-field and use the display-method (as symbol)" do
+          @dummy.should_receive(:changed_content).and_return("test-changed")
+          @tester.should_receive(:url_for).with({:action => 'get_attribute_on_the_spot'}).and_return('/bla-again')
+
+          @result = @tester.on_the_spot_edit @dummy, :content, :display_method => :changed_content
+          @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-display-method=\"changed_content\" data-loadurl=\"/bla-again\" data-ok=\"ok\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">test-changed</span>"
+        end
+
+
         it "makes the correct html for a text-area" do
           @result = @tester.on_the_spot_edit @dummy, :content, :type => :textarea
           @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-columns=\"40\" data-edittype=\"textarea\" data-ok=\"ok\" data-rows=\"5\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">test</span>"
@@ -109,7 +126,7 @@ describe "OnTheSpot" do
             @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-edittype=\"select\" data-loadurl=\"/load/data\" data-ok=\"ok\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">test</span>"
           end
 
-          it "usea the display-text preferrably" do
+          it "use the display-text preferrably" do
             @result = @tester.on_the_spot_edit @dummy, :content, :type => :select, :loadurl => '/load/data', :display_text => 'ninja'
             @result.should == "<span class=\"on_the_spot_editing\" data-cancel=\"cancel\" data-edittype=\"select\" data-loadurl=\"/load/data\" data-ok=\"ok\" data-tooltip=\"tooltip\" data-url=\"/bla\" id=\"r_spec/mocks/mock__content__123\">ninja</span>"
           end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: on_the_spot
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 0
-  - 17
-  version: 0.0.17
+  - 18
+  version: 0.0.18
 platform: ruby
 authors: 
 - Nathan Van der Auwera
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-06 00:00:00 +01:00
+date: 2011-12-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,6 +88,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- app/assets/css/on_the_spot.css
 - app/assets/javascripts/jquery.jeditable.checkbox.js
 - app/assets/javascripts/jquery.jeditable.mini.js
 - app/assets/javascripts/on_the_spot.js