jeditable-rails 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Aidan Feldman
+
+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.rdoc

@@ -0,0 +1,40 @@
+= jeditable-rails
+
+A gem to add in-place-editable fields to your Rails project.  It is a wrapper for the Jeditable[http://www.appelsiini.net/projects/jeditable] jQuery plugin, so most options for <tt>.jeditable()</tt> can be passed through the <tt>options</tt> parameter of the helpers.
+
+== Requirements
+
+* jQuery[http://www.jquery.com] 1.2.6+ - see jquery-rails[http://github.com/indirect/jquery-rails] for easy integration with your Rails project
+* Jeditable[http://www.appelsiini.net/projects/jeditable]
+
+== Usage
+
+Assuming a Rails 3 project, in your Gemfile, add:
+
+  gem 'jeditable-rails'
+
+Suppose you have a <tt>User</tt> model with a <tt>#zip_code</tt> attribute.
+
+  # app/views/users/show.html.erb
+  <h1>View/Edit your profile</h1>
+  ...
+  <b>Zip Code:</b>
+  <%= editable_field @user, :zip_code %>
+
+The helpers can be used in any view you like.  The field appears as normal text to the user, but when clicked, turns into a form field that will then be submitted back to the server.  By default, jeditable-rails requires an <tt>update</tt> action when a PUT is done to <tt>url_for(object)</tt>, which is <em>generated by default for Rails scaffolds</em>.
+
+== Contributing to jeditable-rails
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Aidan Feldman. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "jeditable-rails"
+  gem.homepage = "http://github.com/afeld/jeditable-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{An edit-in-place gem for Rails 3}
+  gem.description = %Q{An edit-in-place gem that uses the JEditable jQuery plugin to post updates to the server via AJAX.}
+  gem.email = "aidan.feldman@gmail.com"
+  gem.authors = ["Aidan Feldman"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jeditable-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/jeditable-rails.gemspec

@@ -0,0 +1,65 @@
+# 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{jeditable-rails}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aidan Feldman"]
+  s.date = %q{2011-02-02}
+  s.description = %q{An edit-in-place gem that uses the JEditable jQuery plugin to post updates to the server via AJAX.}
+  s.email = %q{aidan.feldman@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "jeditable-rails.gemspec",
+    "lib/jeditable-rails.rb",
+    "lib/jeditable-rails/base.rb",
+    "lib/jeditable-rails/helpers/jeditable_helper.rb",
+    "test/helper.rb",
+    "test/test_jeditable-rails.rb"
+  ]
+  s.homepage = %q{http://github.com/afeld/jeditable-rails}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{An edit-in-place gem for Rails 3}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_jeditable-rails.rb"
+  ]
+
+  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_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/jeditable-rails.rb

@@ -0,0 +1 @@
+require 'jeditable-rails/base'

data/lib/jeditable-rails/base.rb

@@ -0,0 +1,7 @@
+require 'jeditable-rails/helpers/jeditable_helper'
+
+module ActionView
+  class Base
+    include JeditableHelper
+  end
+end

data/lib/jeditable-rails/helpers/jeditable_helper.rb

@@ -0,0 +1,48 @@
+module JeditableHelper
+  # If the <tt>condition</tt> evaluates to <tt>true</tt>, an editable field
+  # will be created.  Otherwise, the value of the property of the object is
+  # returned.  See #editable_field for options.
+  def editable_field_if(condition, object, property, options={})
+    value = object.send property    
+    if condition
+      name = "#{object.class.to_s.underscore}[#{property}]"
+      update_url = options.delete(:update_url) || url_for(object)
+      args = {:method => 'PUT', :name => name}.merge(options)
+      %{
+        <span class="editable" data-name="#{name}">#{value}</span>
+        <script type="text/javascript">
+          $(function(){          
+            var args = {data: function(value, settings) {
+              // Unescape HTML
+              var retval = value
+                .replace(/&amp;/gi, '&')
+                .replace(/&gt;/gi, '>')
+                .replace(/&lt;/gi, '<')
+                .replace(/&quot;/gi, "\\\"");
+              return retval;
+            }};
+            $.extend(args, #{args.to_json});
+            $(".editable[data-name='#{name}']").editable("#{update_url}", args);
+          });
+        </script>
+      }.html_safe
+    else
+      value
+    end
+  end
+  
+  # Creates an editable span for the given property of the given object.
+  # When clicked, the 
+  # 
+  # === Options
+  # 
+  # [:method]
+  #   Specify the HTTP method to use: <tt>'PUT'</tt> or <tt>'POST'</tt>.
+  # [:name]
+  #   The <tt>name</tt> attribute to be used when the form is posted.
+  # [:update_url]
+  #   The URL to submit the form to.  Defaults to <tt>url_for(object)</tt>.
+  def editable_field(object, property, options={})
+    editable_field_if(true, object, property, options={})
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jeditable-rails'
+
+class Test::Unit::TestCase
+end

data/test/test_jeditable-rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestJeditableRails < 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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: jeditable-rails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aidan Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: An edit-in-place gem that uses the JEditable jQuery plugin to post updates to the server via AJAX.
+email: aidan.feldman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- jeditable-rails.gemspec
+- lib/jeditable-rails.rb
+- lib/jeditable-rails/base.rb
+- lib/jeditable-rails/helpers/jeditable_helper.rb
+- test/helper.rb
+- test/test_jeditable-rails.rb
+has_rdoc: true
+homepage: http://github.com/afeld/jeditable-rails
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: An edit-in-place gem for Rails 3
+test_files: 
+- test/helper.rb
+- test/test_jeditable-rails.rb