jintastic 1.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Nandor Komzak
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,97 @@
+#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**
+
+It’s hosted on Gemcutter, so you’ll need to set that up first, if you haven’t already: gem sources -a http://gemcutter.org/ 
+
+    sudo gem install jintastic 
+
+Add Jintastic as a dependency in your environment.rb file:
+
+    config.gem '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,59 @@
+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("formtastic")
+    gem.has_rdoc = false
+  end
+  Jeweler::GemcutterTasks.new
+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,5 @@
+--- 
+:build: 
+:major: 1
+:minor: 0
+:patch: 2

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

@@ -0,0 +1,16 @@
+<div class="in_place_editor_wrapper">
+  <%= content_tag container_tag, h(html_text), 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 %>
+    <%= f.commit_button :button_html => {:class => 'in_place_save', :style=>"float:left"} %>
+    <input type='button' value='<%= I18n.t('formtastic.actions.cancel', :default=>'Cancel') %>' class='in_place_cancel' />
+  <% end %>
+</div>

data/assets/public/javascripts/jintastic.js

@@ -0,0 +1,35 @@
+(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() {
+      form = $(this).parents('form') // return size always must be eql 1
+      $.ajax({
+        url: form.attr('action'),
+        type: "POST",
+        dataType: "script",
+        data: form.serializeArray()
+      })
+      return false
+    })
+
+    $('.in_place_cancel').live('click', function() {
+      $.inPlaceEditor.form = $(this).parent('form')
+      $.inPlaceEditor.attribute = $.inPlaceEditor.form.prev()
+      $.inPlaceEditor.toggle()
+    })
+  })
+})(jQuery)

data/config/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  formtastic:
+    actions:
+      cancel: Cancel

data/init.rb

@@ -0,0 +1,3 @@
+require File.join File.dirname(__FILE__), *%w{vendor plugins formtastic rails init}
+require 'jintastic'
+I18n.load_path.unshift File.join File.dirname(__FILE__), 'config', 'locale', 'en.yml'

data/jintastic.gemspec

@@ -0,0 +1,111 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jintastic}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nandor Komzak"]
+  s.date = %q{2010-02-13}
+  s.description = %q{jQuery based in-place editor generated by Formtastic}
+  s.email = %q{nandor.komzak@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION.yml",
+     "assets/app/views/jintastic/_in_place_editor.html.erb",
+     "assets/public/javascripts/jintastic.js",
+     "config/locale/en.yml",
+     "init.rb",
+     "jintastic.gemspec",
+     "lib/jintastic.rb",
+     "test/jintastic_test.rb",
+     "test/test_helper.rb",
+     "vendor/plugins/formtastic/.gitignore",
+     "vendor/plugins/formtastic/MIT-LICENSE",
+     "vendor/plugins/formtastic/README.textile",
+     "vendor/plugins/formtastic/RELEASE_PROCESS",
+     "vendor/plugins/formtastic/Rakefile",
+     "vendor/plugins/formtastic/VERSION.yml",
+     "vendor/plugins/formtastic/formtastic.gemspec",
+     "vendor/plugins/formtastic/generators/form/USAGE",
+     "vendor/plugins/formtastic/generators/form/form_generator.rb",
+     "vendor/plugins/formtastic/generators/form/templates/view__form.html.erb",
+     "vendor/plugins/formtastic/generators/form/templates/view__form.html.haml",
+     "vendor/plugins/formtastic/generators/formtastic/formtastic_generator.rb",
+     "vendor/plugins/formtastic/generators/formtastic/templates/formtastic.css",
+     "vendor/plugins/formtastic/generators/formtastic/templates/formtastic_changes.css",
+     "vendor/plugins/formtastic/generators/formtastic/templates/formtastic_config.rb",
+     "vendor/plugins/formtastic/generators/formtastic_stylesheets/formtastic_stylesheets_generator.rb",
+     "vendor/plugins/formtastic/install.rb",
+     "vendor/plugins/formtastic/lib/formtastic.rb",
+     "vendor/plugins/formtastic/lib/formtastic/i18n.rb",
+     "vendor/plugins/formtastic/lib/locale/en.yml",
+     "vendor/plugins/formtastic/rails/init.rb",
+     "vendor/plugins/formtastic/spec/buttons_spec.rb",
+     "vendor/plugins/formtastic/spec/commit_button_spec.rb",
+     "vendor/plugins/formtastic/spec/custom_builder_spec.rb",
+     "vendor/plugins/formtastic/spec/custom_macros.rb",
+     "vendor/plugins/formtastic/spec/defaults_spec.rb",
+     "vendor/plugins/formtastic/spec/error_proc_spec.rb",
+     "vendor/plugins/formtastic/spec/errors_spec.rb",
+     "vendor/plugins/formtastic/spec/form_helper_spec.rb",
+     "vendor/plugins/formtastic/spec/i18n_spec.rb",
+     "vendor/plugins/formtastic/spec/include_blank_spec.rb",
+     "vendor/plugins/formtastic/spec/input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/boolean_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/check_boxes_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/country_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/date_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/datetime_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/file_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/hidden_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/numeric_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/password_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/radio_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/select_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/string_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/text_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/time_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs/time_zone_input_spec.rb",
+     "vendor/plugins/formtastic/spec/inputs_spec.rb",
+     "vendor/plugins/formtastic/spec/label_spec.rb",
+     "vendor/plugins/formtastic/spec/semantic_errors_spec.rb",
+     "vendor/plugins/formtastic/spec/semantic_fields_for_spec.rb",
+     "vendor/plugins/formtastic/spec/spec.opts",
+     "vendor/plugins/formtastic/spec/spec_helper.rb",
+     "vendor/plugins/formtastic/uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/rubymood/jintastic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{jQuery based in-place editor generated by Formtastic}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/jintastic_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<formtastic>, [">= 0"])
+    else
+      s.add_dependency(%q<formtastic>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<formtastic>, [">= 0"])
+  end
+end
+

data/lib/jintastic.rb

@@ -0,0 +1,61 @@
+require 'formtastic'
+
+class ActionView::Base
+  def in_place_editor_for(path_spec_or_object, attributes, html_text = nil)
+    instance = path_spec_or_object.kind_of?(Array) ? path_spec_or_object.last : path_spec_or_object
+
+    if attributes.class==Symbol
+      #simple one attribute in place editor
+      #in_place_editor_for @user, :name
+      attribute = attributes
+      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[attribute]
+    end
+
+    container_tag =  instance.respond_to?(:column_for_attribute) ?
+      instance.column_for_attribute(attribute).type == :text ? :pre : :span : :span
+
+    form_tag_options = {}
+    content_tag_options = {:class=>'in_place_attribute'}
+
+    form_partial ||= "#{instance.class.to_s.downcase.pluralize}/form" unless input_attributes
+
+    html_text ||= instance[attribute]
+
+    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,
+                       :path_spec_or_object=>path_spec_or_object,
+                       :html_text=>html_text,
+                       :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