rubymood-jintastic 1.0.0

data/README.md

@@ -0,0 +1,95 @@
+#Jintastic
+
+Jintastic is a **j**Query based **in**-place editor generated by [Form**tastic**](http://github.com/justinfrench/formtastic/tree/master).
+
+## Features
+
+* easy usage
+* you can reuse your partials and controller actions
+* you can edit more than one attribute at once
+* you can use nested resources
+
+## Install
+
+**Gem**
+
+    sudo gem install rubymood-jintastic
+
+Add Jintastic as a dependency in your environment.rb file:
+
+    config.gem 'rubymood-jintastic', :lib => 'jintastic' 
+
+**Plugin**
+
+    script/plugin install git://github.com/rubymood/jintastic.git
+    
+## Usage
+
+Having downloaded jQuery(>=1.3.2) include javascript files in your template: 
+    
+    <%= javascripts_include_tag 'jquery', 'jintastic' %>
+
+**Example**
+
+Let's say you have a bookmark resource and you have this haml files:
+
+    # bookmarks/index.html.haml
+    %ul
+      = render @bookmarks
+
+    # bookmarks/_bookmark.html.haml
+    %li
+      = bookmark.name
+
+    # bookmarks/edit.html.haml
+    -# with formtastic
+    - semantic_form_for @bookmark do |f| 
+      -f.inputs
+        = render :partial=>'form', :locals=>{:f=>f}
+        = f.commit_button 
+    -# or with default form_for helper
+    - form_for @bookmark do |f|
+      = render :partial=>'form'
+      = f.submit_tag 'Save'
+    
+    # bookmarks/_form.html.haml
+    -# with formtastic
+    = f.input :name
+    = f.input :url
+    -# or with default form_for helper
+    = error_messages_for :bookmark
+    = f.text_field :name
+    = f.text_field :url
+
+This is simple. If you organize your views in this way you just follows the rails conventions. Now if you want to in-place editing a bookmark inside your index page just simply do one of the below:
+
+    # bookmarks/_bookmark.html.haml
+    %li{:id=>dom_id(bookmark)} # we are referencing the id later in a js file (see below)
+      -# this shows name attribute, and if you click on it, you can edit it
+      = in_place_editor_for bookmark, :name
+      -# this shows name attribute, and if you click on it, it will show your bookmark form partial
+      = in_place_editor_for bookmark, :name=>:form
+      -# this shows name attribute, and if you click on it, it will show your custom form partial
+      = in_place_editor_for bookmark, :name=>'bookmarks/custom_form'
+      -# this shows name attribute, and if you click on it, you can edit both the name and url attributes
+      = in_place_editor_for bookmark, :name=>[:name, :bookmark]
+      -# so you can edit something else (this shows name attribute, but when you click on it, you will edit the url attribute)
+      = in_place_editor_for bookmark, :name=>:url
+      -# and finally, you can add nested resource
+      = in_place_editor_for [:admin, bookmark], :name
+
+Inside your bookmark controller you have to make nothing new. The only thing you have to do is some javascript magic:
+
+    # bookmarks/update.js.erb
+    $('#<%= dom_id @bookmark %>').replaceWith('<%= escape_javascript render @bookmark %>')
+
+## And finally, what happens at validation error?
+
+With formtastic input helper the validation errors will be displayed automatic. If you use rails default input helpers you could display the errors in your form partial (see above in the example).
+
+## TODO
+
+* some options to customize in place editor form
+* make some tests
+
+Copyright (c) 2009 Nandor Komzak, released under the MIT license

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jintastic"
+    gem.summary = %Q{jQuery based in-place editor generated by Formtastic}
+    gem.email = "nandor.komzak@gmail.com"
+    gem.homepage = "http://github.com/rubymood/jintastic"
+    gem.authors = ["Nandor Komzak"]
+    gem.description = gem.summary
+    gem.files.include FileList["{assets}/**/*"]
+    gem.add_dependency("justinfrench-formtastic")
+    gem.has_rdoc = false
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jintastic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 0
+:major: 1

data/assets/app/views/jintastic/_in_place_editor.html.erb

@@ -0,0 +1,16 @@
+<div class="in_place_editor_wrapper">
+  <%= content_tag container_tag, instance[attribute], content_tag_options %>
+  <% semantic_form_for path_spec_or_object, form_tag_options do |f| %>
+    <% f.inputs do %>
+      <% if input_attributes %>
+        <% input_attributes.each do |attr| %>
+          <%= f.input attr %>
+        <% end %>
+      <% else %>
+        <%= render :partial=>form_partial, :locals=>{:f=>f} %>
+      <% end %>
+    <% end %>
+    <%= submit_tag 'Save', :class=>'in_place_save' %>
+    <input type='button' value='Cancel' class='in_place_cancel' />
+  <% end %>
+</div>

data/assets/public/javascripts/jintastic.js

@@ -0,0 +1,36 @@
+(function($){
+  $(function(){
+		$.inPlaceEditor = {
+      toggle: function() {
+        $([this.attribute, this.form]).toggle()
+
+        if (this.form.is(':visible'))
+          $.inPlaceEditor.form.find('fieldset li:nth-child(1)')
+      }
+    }
+
+    $('.in_place_attribute').live('click', function() {
+      $.inPlaceEditor.attribute = $(this)
+      $.inPlaceEditor.form = $.inPlaceEditor.attribute.next()
+      $.inPlaceEditor.toggle() 
+    })
+
+    $('.in_place_save').live('click', function() {
+      $.inPlaceEditor.form = $(this).parent('form')
+      $.inPlaceEditor.attribute = $.inPlaceEditor.form.prev()
+      $.ajax({
+        url: $.inPlaceEditor.form[0].action,
+        type: "POST",
+        dataType: "script",
+        data: $.inPlaceEditor.form.serializeArray()
+      })
+      return false
+    })
+
+    $('.in_place_cancel').live('click', function() {
+      $.inPlaceEditor.form = $(this).parent('form')
+      $.inPlaceEditor.attribute = $.inPlaceEditor.form.prev()
+      $.inPlaceEditor.toggle()
+    })
+  })
+})(jQuery)

data/lib/jintastic.rb

@@ -0,0 +1,62 @@
+require 'formtastic'
+
+class ActionView::Base 
+  def in_place_editor_for(path_spec_or_object, attributes)
+    instance = case path_spec_or_object
+      when ActiveRecord::Base: path_spec_or_object
+      when Array: path_spec_or_object.last
+    end
+    
+    if attributes.class==Symbol  
+      #simple one attribute in place editor
+      #in_place_editor_for @user, :name
+      attribute = attributes.to_sym
+      input_attributes = Array(attribute)
+
+    elsif attributes.values.first==:form
+      #render default form partial
+      #in_place_editor_for @user, :name=>:form 
+      attribute = attributes.keys.first
+
+    elsif attributes.values.first.class==String
+      #render custom form partial
+      #in_place_editor_for @user, :name=>'users/custom_form'
+      attribute = attributes.keys.first
+      form_partial = attributes[attribute]
+
+    else
+      #attribute is an array
+      #in_place_editor_for @user, :name=>[:name,:address]
+      attribute = attributes.keys.first
+      input_attributes = attributes.values
+    end
+
+    container_tag =  instance.column_for_attribute(attribute).type == :text ? :pre : :span
+
+    form_tag_options = {:id=>dom_id(path_spec_or_object, attribute)}
+    content_tag_options = {:class=>'in_place_attribute'}
+
+    form_partial ||= "#{instance.class.to_s.downcase.pluralize}/form" unless input_attributes
+
+    if instance.valid?
+      form_tag_options.merge!({:html=>{:style=>"display: none"}}) 
+    else
+      content_tag_options.merge!({:style=>"display: none"})
+    end
+
+    render :partial => 'jintastic/in_place_editor', 
+           :locals => {:container_tag=>container_tag,
+                     :input_attributes=>input_attributes,
+                     :attribute=>attribute,
+                     :path_spec_or_object=>path_spec_or_object,
+                     :instance=>instance,
+                     :content_tag_options=>content_tag_options,
+                     :form_tag_options=>form_tag_options,
+                     :form_partial=>form_partial}
+  end   
+end
+
+# hack for assets because gems hasn't got rake tasks 
+#
+# copy assets at every server start because after update maybe they have to update too
+FileUtils.cp_r File.join(File.dirname(__FILE__), *%w{.. assets .}), Rails.root 

data/test/jintastic_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class JintasticTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jintastic'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: rubymood-jintastic
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Nandor Komzak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: justinfrench-formtastic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: jQuery based in-place editor generated by Formtastic
+email: nandor.komzak@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION.yml
+- assets/app/views/jintastic/_in_place_editor.html.erb
+- assets/public/javascripts/jintastic.js
+- lib/jintastic.rb
+- test/jintastic_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/rubymood/jintastic
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: jQuery based in-place editor generated by Formtastic
+test_files: 
+- test/test_helper.rb
+- test/jintastic_test.rb