on_the_spot 0.0.0.beta2 → 0.0.1

data/README.markdown

@@ -13,13 +13,26 @@ Run the installation task:
 
     rails g on_the_spot:install
 
-Inside your `routes.rb` you provide the catch-all
+Inside your `routes.rb` you either provide the catch-all
 
-      match ':controller(/:action(/:id(.:format)))'
+    match ':controller(/:action(/:id(.:format)))'
 
-This is not ideal: i am looking for a better solution.
+or you type something like
 
-But that is all you need to do to start using it!
+    resources :posts do
+      collection do
+        get :update_attribute_on_the_spot
+      end
+    end
+
+While this last is the best solution, 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!
+
+Inside your `application.html.haml` you will need to add below the default javascripts:
+
+    = javascript_include_tag :on_the_spot
+
+That is all you need to do to start using it!
 
 
 ## Usage
@@ -41,11 +54,24 @@ And inside your view you will have to specify the fields you want to be "editabl
 
 It should be as simple as that :)
 
+## Detailed options
+
+The `on_the_spot_edit` also accepts options:
+
+* `type`    : `textarea` or `select` (none means default edit, select is currently not yet supported)
+* `ok_text` : the text for the ok-button
+* `cancel_text` : the text for the cancel-button
+* `tooltip` : the tooltip-text
+
+For the texts: if a text is not specified, the default is taken from the `on_the_spot.en.yml` (or your current language).
+
+## Example project
+
+Ther is a example rails3-project called on_the_spot_tester here: http://github.com/nathanvda/on_the_spot_tester
+
 ## 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
+- make sure user can choose to use a select instead of just text or textarea
 - add tests!
 
 ## Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.0.0.beta2
+0.0.1

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

@@ -12,6 +12,7 @@ module OnTheSpot
       def copy_glue_javascript
         # !!!!! TO DO: check this -> how do a copy?
         copy_file "on_the_spot.js", "public/javascripts/on_the_spot.js"
+        copy_file "on_the_spot.en.yml", "config/locales/on_the_spot.en.yml"
       end
 
     end

data/lib/generators/on_the_spot/install/templates/on_the_spot.en.yml

@@ -0,0 +1,5 @@
+en:
+  on_the_spot:
+    ok: Ok
+    cancel: Cancel
+    tooltip: Click to edit ...

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

@@ -16,13 +16,19 @@ $(document).ready(function() {
             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 ...';
+            tooltip_text = el.attr('data-tooltip') || 'Click to edit ...',
+            edit_type    = el.attr('data-edittype');
 
-        el.editable(data_url, {
+        var options = {
             tooltip: tooltip_text,
             cancel: cancel_text,
             submit: ok_text
-        })
+        };
+        if (edit_type != null) {
+            options.type = edit_type;
+        }
+
+        el.editable(data_url, options)
     })
 
 });

data/lib/on_the_spot/on_the_spot_helpers.rb

@@ -1,6 +1,14 @@
 module OnTheSpot
   module Helpers
 
+    EDIT_TYPE_TEXTAREA='textarea'
+    EDIT_TYPE_SELECT='select'
+
+    # Possible options:
+    #   ok_text     : the ok-button text
+    #   cancel_text : the cancel-button text
+    #   tooltip     : the tooltip to show
+    #   type        : {'textarea' || 'select' }
     def on_the_spot_edit(object, field, options={})
       #!!! to do: translate options to data-fields
       # Possible fields:
@@ -8,11 +16,23 @@ module OnTheSpot
       #  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')
+                            )
+
       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
+      html_options = { :id => "#{object.class.name.underscore}__#{field}__#{object.id}",
+                       :class => 'on_the_spot_editing',
+                       :'data-url' => update_url}
+
+      html_options[:'data-edittype'] = options[:type] unless options[:type].nil?
+      html_options[:'data-ok']       = options[:ok_text] unless options[:ok_text].nil?
+      html_options[:'data-cancel']   = options[:cancel_text] unless options[:cancel_text].nil?
+      html_options[:'data-tooltip']  = options[:tooltip] unless options[:tooltip].nil?
+
+      content_tag("span", html_options) do
         object.send(field.to_sym).to_s
       end
     end

data/on_the_spot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{on_the_spot}
-  s.version = "0.0.0.beta2"
+  s.version = "0.0.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Van der Auwera"]
-  s.date = %q{2010-09-05}
+  s.date = %q{2010-09-11}
   s.description = %q{Unobtrusive in place editing, using jEditable; only works in Rails 3}
   s.email = %q{nathan@dixis.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "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.en.yml",
      "lib/generators/on_the_spot/install/templates/on_the_spot.js",
      "lib/on_the_spot.rb",
      "lib/on_the_spot/controller_extension.rb",

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: on_the_spot
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 0
-  - beta2
-  version: 0.0.0.beta2
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Nathan Van der Auwera
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-05 00:00:00 +02:00
+date: 2010-09-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +52,7 @@ files:
 - 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.en.yml
 - lib/generators/on_the_spot/install/templates/on_the_spot.js
 - lib/on_the_spot.rb
 - lib/on_the_spot/controller_extension.rb
@@ -81,13 +81,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: