on_the_spot 0.0.1 → 0.0.2

data/.rspec

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

data/Gemfile

@@ -2,4 +2,9 @@ source "http://rubygems.org"
 
 gem "rake"
 gem "jeweler"
-gem "rspec",   ">= 2.0.0.beta.20"
+gem "json_pure"
+
+group :test do
+  gem "rspec",   ">= 2.0.0.rc"
+  gem "actionpack", ">=3.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 3.0.0)
+  jeweler
+  rake
+  rspec (>= 2.0.0.rc)

data/README.markdown

@@ -1,7 +1,7 @@
 # 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)
+This is still in progress, but should already be usable for simple text-fields and text-areas.
 
 ## Installation
 
@@ -13,11 +13,7 @@ Run the installation task:
 
     rails g on_the_spot:install
 
-Inside your `routes.rb` you either provide the catch-all
-
-    match ':controller(/:action(/:id(.:format)))'
-
-or you type something like
+Inside your `routes.rb` you need to provide the following route:
 
     resources :posts do
       collection do
@@ -25,13 +21,17 @@ or you type something like
       end
     end
 
-While this last is the best solution, you need to do this for each controller that uses the on-the-spot editing.
+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
 
+or using erb, you write
+
+    <%= javascript_include_tag :on_the_spot %>
+
 That is all you need to do to start using it!
 
 
@@ -58,21 +58,36 @@ It should be as simple as that :)
 
 The `on_the_spot_edit` also accepts options:
 
-* `type`    : `textarea` or `select` (none means default edit, select is currently not yet supported)
+* `type`    : `textarea` or `select` (none means default edit)
 * `ok_text` : the text for the ok-button
 * `cancel_text` : the text for the cancel-button
 * `tooltip` : the tooltip-text
+* `rows`: for textarea, the number of rows, defaults to 5
+* `columns`: for textarea, the number of columns, defaults to 40
+* `data`: for select, the lookup-data, should be in an array of id-value pairs. E.g. `[[1, 'ok'], [2, 'not ok'], [3, 'not decided']].
+
 
 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
+## Example Usages
+
+### Edit field
 
-Ther is a example rails3-project called on_the_spot_tester here: http://github.com/nathanvda/on_the_spot_tester
+    <%= on_the_spot_edit @user, :name %>
+
+### Textarea
+
+    <%= on_the_spot_edit @user, :description, :type => :textarea, :rows => 10, :columns => 55 %>
+
+### Select-box
+
+    <%= on_the_spot_edit @user, :rating, :type => :select, :data => [[1, 'good'], [2, 'mediocre'], [3, 'bad']] %>
+
+
+## Example project
 
-## To do
+There is an example rails3-project called [on_the_spot_tester](http://github.com/nathanvda/on_the_spot_tester)
 
-- make sure user can choose to use a select instead of just text or textarea
-- add tests!
 
 ## Note on Patches/Pull Requests
  

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rake'
+require "rspec/core/rake_task"
 
 begin
   require 'jeweler'
@@ -18,6 +19,14 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+RSpec::Core::RakeTask.new(:spec)
+
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new("test_cov") do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--rails --include views -Ispec --exclude gems\/,spec\/,features\/,seeds\/}
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -27,3 +36,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

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

@@ -6,18 +6,17 @@ $(document).ready(function() {
     $(".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 ...',
-            edit_type    = el.attr('data-edittype');
+            edit_type    = el.attr('data-edittype'),
+            select_data  = el.attr('data-select'),
+            rows         = el.attr('data-rows'),
+            columns      = el.attr('data-columns'),
+            load_url     = el.attr('data-loadurl');
 
         var options = {
             tooltip: tooltip_text,
@@ -27,6 +26,19 @@ $(document).ready(function() {
         if (edit_type != null) {
             options.type = edit_type;
         }
+        if (edit_type == 'select') {
+            if (select_data != null) {
+                options.data = select_data;
+                options.submitdata = { 'select_array': select_data }
+            }
+            if (load_url != null) {
+                options.loadurl = load_url;
+            }
+        }
+        else if (edit_type == 'textarea') {
+            options.rows = rows;
+            options.columns = columns;
+        }
 
         el.editable(data_url, options)
     })

data/lib/on_the_spot/controller_extension.rb

@@ -11,9 +11,15 @@ module OnTheSpot
       def can_edit_on_the_spot
         define_method :update_attribute_on_the_spot do
           klass, field, id = params[:id].split('__')
+          select_data = params[:select_array]
           object = klass.camelize.constantize.find(id)
           object.update_attribute(field, params[:value])
-          render :text => CGI::escapeHTML(object.send(field).to_s)
+          if select_data.nil?
+            render :text => CGI::escapeHTML(object.send(field).to_s)
+          else
+            parsed_data = JSON.parse(select_data.gsub("'", '"'))
+            render :text => parsed_data[object.send(field).to_s]
+          end
         end
       end
     end

data/lib/on_the_spot/on_the_spot_helpers.rb

@@ -4,11 +4,17 @@ module OnTheSpot
     EDIT_TYPE_TEXTAREA='textarea'
     EDIT_TYPE_SELECT='select'
 
+    class OnTheSpotMissingParameters < StandardError; end
+
     # Possible options:
     #   ok_text     : the ok-button text
     #   cancel_text : the cancel-button text
     #   tooltip     : the tooltip to show
     #   type        : {'textarea' || 'select' }
+    #   rows        : nr of rows for textarea
+    #   columns     : nr of columns for textarea
+    #   loadurl     : (for select) an url that will return the json for the select
+    #   data        : (for select) an array of options in the form [id, value]
     def on_the_spot_edit(object, field, options={})
       #!!! to do: translate options to data-fields
       # Possible fields:
@@ -16,26 +22,65 @@ 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')
+                             :tooltip     => t('on_the_spot.tooltip'),
+                             :rows        => 5,
+                             :columns     => 40
                             )
 
       update_url = url_for(:action => 'update_attribute_on_the_spot')
 
+      field_value =  object.send(field.to_sym).to_s
+
       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?
+      editable_type = options[:type].nil? ? nil : options[:type].to_sym
+      html_options[:'data-edittype']    = editable_type.to_s unless editable_type.nil?
+      if editable_type == :select
+        # we need either a data or loadurl
+        unless options[:loadurl].nil?
+          html_options[:'data-loadurl'] = options[:loadurl]
+        else
+          # we should find a hash
+          select_data = options[:data]
+          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)
+        end
+      elsif editable_type == :textarea
+        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]
 
       content_tag("span", html_options) do
-        object.send(field.to_sym).to_s
+        if editable_type == :select
+          lookup_display_value(select_data, field_value)
+        else
+          field_value
+        end
       end
     end
 
+    def lookup_display_value(id_value_array, id_str)
+      found_pair = id_value_array.select{ |idv| idv[0].to_s == id_str.to_s }
+      found_pair.size == 0 ? '' : found_pair[0][1]
+    end
+
+    def convert_array_to_json(id_value_array, selected_id)
+      conv_arr = id_value_array.map{|idv| "'#{idv[0]}':'#{idv[1]}'" }
+      result = "{ #{conv_arr.join', '}"
+      result += ", 'selected':'#{ selected_id.to_s}'" unless selected_id.nil?
+      result += "}"
+      result
+    end
+
   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.1"
+  s.version = "0.0.2"
 
   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-11}
+  s.date = %q{2010-10-06}
   s.description = %q{Unobtrusive in place editing, using jEditable; only works in Rails 3}
   s.email = %q{nathan@dixis.com}
   s.extra_rdoc_files = [
@@ -19,11 +19,14 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     ".rspec",
      "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.markdown",
      "Rakefile",
      "VERSION",
+     "autotest/discover.rb",
      "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",

data/spec/on_the_spot_spec.rb

@@ -1,7 +1,56 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'on_the_spot/on_the_spot_helpers'
+
+require 'action_controller'
 
 describe "OnTheSpot" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  describe "Helpers" do
+    before(:each) do
+
+      class TestClass < ActionView::Base
+        include OnTheSpot::Helpers
+      end
+
+      @tester = TestClass.new
+      @test_array_nr  = [[1,"abc"], [2, "def"], [3, "ghi"]]
+      @test_array_str = [["key", "value"], ["key2", "value2"]]
+    end
+
+    context "lookup values from array" do
+      it "should find value abc for key 1" do
+        @tester.lookup_display_value(@test_array_nr, 1).should == 'abc'
+      end
+
+      it "should find value <value2> for key key2" do
+        @tester.lookup_display_value(@test_array_str, 'key2').should == 'value2'
+      end
+
+      it "should return an empty string if key does not exist" do
+        @tester.lookup_display_value(@test_array_str, 'key1').should == ''
+      end
+
+    end
+
+    context "convert array to json" do
+      it "should convert correctly" do
+        @tester.convert_array_to_json(@test_array_nr, 1).should == "{ '1':'abc', '2':'def', '3':'ghi', 'selected':'1'}"
+      end
+    end
+
+    context "creating a simple edit-field" do
+      before(:each) do
+        @dummy = mock()
+        @dummy.stub!(:content).and_return('test')
+        @dummy.stub!(:id).and_return('123')
+        @tester.should_receive(:t).with('on_the_spot.ok').and_return("ok")
+        @tester.should_receive(:t).with('on_the_spot.cancel').and_return("cancel")
+        @tester.should_receive(:t).with('on_the_spot.tooltip').and_return("tooltip")
+        @tester.should_receive(:url_for).and_return('/bla')
+        @result = @tester.on_the_spot_edit @dummy, :content
+      end
+      it "should make the correct html" 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\">test</span>"
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,26 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'on_the_spot'
-require 'spec'
-require 'spec/autorun'
+require 'rspec/core'
+#require 'autotest/rspec2'
 
-Spec::Runner.configure do |config|
-  
+
+
+RSpec.configure do |c|
+  c.color_enabled = true
+#  c.filter_run :focused => true
+#  c.run_all_when_everything_filtered = true
+#  c.filter_run_excluding :ruby => lambda {|version|
+#    case version.to_s
+#    when "!jruby"
+#      RUBY_ENGINE != "jruby"
+#    when /^> (.*)/
+#      !(RUBY_VERSION.to_s > $1)
+#    else
+#      !(RUBY_VERSION.to_s =~ /^#{version.to_s}/)
+#    end
+#  }
+#  c.around do |example|
+#    sandboxed { example.run }
+#  end
 end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nathan Van der Auwera
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-11 00:00:00 +02:00
+date: 2010-10-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,11 +45,14 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .rspec
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.markdown
 - Rakefile
 - VERSION
+- autotest/discover.rb
 - 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