jsort 0.0.1 → 0.0.2

data/README.md

@@ -13,33 +13,49 @@ Usage
 
 **Controller**
 
-```
-  def sort
-     params[:ordered_items].each_with_index do |id,idx|
-       m = MyModel.find(id)
-       m.position = idx
-       m.save
-     end
-  end
-```
+
+    def sort
+       params[:ordered_items].each_with_index do |id,idx|
+         m = MyModel.find(id)
+         m.position = idx
+         m.save
+       end
+       render :nothing => true
+    end
+
 
 **View** (HAML; obviously, will work with html.erb too)
 
-```
-  - jsort(@my_items,'ordered_items', sort_my_controller_path) do |item|
-    = item.name
-    = link_to "[Edit]", edit_my_item_path(item)
-```
+
+    - jsort(@my_items,'ordered_items', sort_my_controller_path) do |item|
+      = item.name
+      = link_to "[Edit]", edit_my_item_path(item)
+
+_Parameters_
+
+  `jsort ITEMS, NAME, PATH, [OPTIONS]`
+  
+  * *ITEMS* - a collection of items to sort. If an item provides a method/field positon, the items will be sorted
+  * *NAME* - The div-id of the list. This will be the key of `params[:NAME]` passed to the controller.
+  * *PATH* - path or url to the controller/action where the script will post to.
+  * *OPTIONS* - Opional you may provide the following options:
+  
+  `:text => 'MOVE` - Will use this text as a drag-n-drop-handle instead of the image
+  `:image => 'yourimage.jpg'` - use your own image (place it in assets/images path of your application
+  `:handle_only => true` - Only the handle (image or text) can be used to drag&move. Default is 'false' which allows you to pick up by clicking anywhere on the line.
+  
+
 
 This will display an ordered list which is sortable by drag and drop.
-The block passed to jsort will be used to format each line. If no block is
-given item.to_s will be used to display the items.
+The block passed to jsort will be used to format each line/item. If no block is
+given `item.to_s` will be used to display the items.
 
 
 Installation
 ------------
 
  * Rails 3.1:
+   * Add `gem "jsort", "~> 0.0.1"` to your Gemfile
    * Add this line to your application.js-template: `//= require jsort_sortable`
  * Rails < 3.1:
    * A generator will be provided soon. At the moment you have to copy the jsort_sortable.js to your javascript-directory and you have to include it in your layout manually.

data/VERSION

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

data/jsort.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jsort}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andi Altendorfer"]
+  s.date = %q{2011-08-12}
+  s.description = %q{Write a controller-method to do the sort and call jsort-helper in your view.}
+  s.email = %q{andi@iboard.cc}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "jsort.gemspec",
+    "lib/generators/jsort/install/install_generator.rb",
+    "lib/jsort.rb",
+    "lib/jsort/rails.rb",
+    "lib/jsort/rails/engine.rb",
+    "test/helper.rb",
+    "test/test_jsort.rb",
+    "vendor/assets/images/sortable_vertical.png",
+    "vendor/assets/javascripts/jsort_sortable.js"
+  ]
+  s.homepage = %q{http://github.com/iboard/jsort}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{sort lists with drag & drop without coding a single line of Javascript by yourself}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jquery-rails>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<jquery-rails>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jquery-rails>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/jsort.rb

@@ -3,15 +3,31 @@ require "jsort/rails"
 module ActionView
   module Helpers
     module FormHelper
+      
+      
+      
+      # Renders an ordered list of items and register the javascript-call for drag-n-sort
+      # 
+      # @param [Enumerate] items - The collection of items to sort
+      # @param [String] name - The name of the div-tag and key of the params for the controller
+      # @param [String] path - The path or url to post against (The sort-method in your controller)
+      # @param [Hash] options - Options used to format the lines of items
+      #
+      # Options:
+      #   * `:text => 'click here to sort'` - Will use this text as a drag-n-drop-handle instead of the image
+      #   * `:image => 'yourimage.jpg'` - use your own image (place it in assets/images path of your application
+      #   * `:handle_only => true` - Only the handle (image or text) can be used to drag&move. Default is 'false' which allows you to pick up by clicking anywhere on the line.
+      #   * `:div_type => ['table','tr','td'] or ['ol',nil,'li'], ....
       def jsort(items,name,path,options={},&block)
         
         defaults = {
           :handle_only => false,
           :image => 'sortable_vertical.png',
-          :text => nil
+          :text => nil,
+          :div_type => ['ol',nil,'li']
         }
         defaults.merge!(options)
-        concat("<ol id='#{name.pluralize}' path='#{path}'>".html_safe)
+        concat("<#{defaults[:div_type][0]} id='#{name.pluralize}' path='#{path}'>".html_safe)
         
         begin
           sorted_items = items.sort {|a,b| a.position <=> b.position}
@@ -20,7 +36,8 @@ module ActionView
         end
         
         for item in sorted_items
-          concat("<li class='#{name}_sort_entry' id='#{name}_#{item.to_param}'>".html_safe)
+          concat("<#{defaults[:div_type][1]}>") unless defaults[:div_type][1].nil?
+          concat("<#{defaults[:div_type][2]} class='#{name}_sort_entry' id='#{name}_#{item.to_param}'>".html_safe)
           concat("<span class='handle'>".html_safe)
           if options[:text]
             concat(options[:text] + " ")
@@ -40,9 +57,10 @@ module ActionView
           unless defaults[:handle_only] && options[:handle_only] == true
             concat("</span>".html_safe)
           end
-          concat("</li>".html_safe)
+          concat("</#{defaults[:div_type][2]}>".html_safe)
+          concat("</#{defaults[:div_type][1]}>") unless defaults[:div_type][1].nil?
         end
-        concat("</ol>".html_safe)
+        concat("</#{defaults[:div_type][0]}>".html_safe)
         concat(javascript_tag( "registerSortableList($('##{name.pluralize}'));"))
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsort
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000 +02:00
+date: 2011-08-12 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &70183613714720 !ruby/object:Gem::Requirement
+  requirement: &70313271128080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70183613714720
+  version_requirements: *70313271128080
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70183613714220 !ruby/object:Gem::Requirement
+  requirement: &70313271127540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183613714220
+  version_requirements: *70313271127540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70183613713720 !ruby/object:Gem::Requirement
+  requirement: &70313271126720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70183613713720
+  version_requirements: *70313271126720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70183613713220 !ruby/object:Gem::Requirement
+  requirement: &70313271119120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70183613713220
+  version_requirements: *70313271119120
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70183613712720 !ruby/object:Gem::Requirement
+  requirement: &70313271113660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70183613712720
+  version_requirements: *70313271113660
 description: Write a controller-method to do the sort and call jsort-helper in your
   view.
 email: andi@iboard.cc
@@ -83,6 +83,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- jsort.gemspec
 - lib/generators/jsort/install/install_generator.rb
 - lib/jsort.rb
 - lib/jsort/rails.rb
@@ -107,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4219561250019622986
+      hash: 3460106958135409389
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: