jipe 1.0.0 → 2.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,8 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-end
+# Specify your gem's dependencies in jipe.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nat Budin
+
+MIT License
+
+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,29 @@
+# Jipe
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jipe'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jipe
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,47 +1 @@
-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 = "jipe"
-  gem.homepage = "http://github.com/nbudin/jipe"
-  gem.license = "MIT"
-  gem.summary = %Q{RESTful In-place editors for Rails using Jester}
-  gem.email = "natbudin@gmail.com"
-  gem.authors = ["Nat Budin"]
-  # 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'
-require 'rake/rdoctask'
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the jipe plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the jipe plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Jipe'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/gem_tasks"

data/jipe.gemspec

@@ -1,62 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jipe/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{jipe}
-  s.version = "1.0.0"
+Gem::Specification.new do |spec|
+  spec.name          = "jipe"
+  spec.version       = Jipe::VERSION
+  spec.authors       = ["Nat Budin"]
+  spec.email         = ["natbudin@gmail.com"]
+  spec.description   = %q{An in-place editor for Jester}
+  spec.summary       = %q{A clone of Prototype's in-place edit controls for Thoughtbot's jester.js.  You might not wanna use this now that jQuery exists, but, in case you do, here it is.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nat Budin"]
-  s.date = %q{2011-03-15}
-  s.email = %q{natbudin@gmail.com}
-  s.extra_rdoc_files = [
-    "README"
-  ]
-  s.files = [
-    "Gemfile",
-    "README",
-    "Rakefile",
-    "app/controllers/jipe_controller.rb",
-    "app/views/jipe/jester.js.erb",
-    "app/views/jipe/jipe.js.erb",
-    "assets/images/edit-field.png",
-    "assets/javascripts/jester.js",
-    "assets/javascripts/jipe.js",
-    "generators/jipe/USAGE",
-    "generators/jipe/jipe_generator.rb",
-    "generators/jipe/templates/edit-field.png",
-    "init.rb",
-    "install.rb",
-    "lib/jipe.rb",
-    "rails/init.rb",
-    "tasks/jipe_tasks.rake",
-    "test/jipe_test.rb",
-    "uninstall.rb"
-  ]
-  s.homepage = %q{http://github.com/nbudin/jipe}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
-  s.summary = %q{RESTful In-place editors for Rails using Jester}
-  s.test_files = [
-    "test/jipe_test.rb"
-  ]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  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<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-    else
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    end
-  else
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-  end
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", ">= 3.0.0"
 end
-

data/lib/jipe.rb

@@ -1,138 +1,146 @@
-# Jipe
+require 'jipe/version'
 
 module Jipe
-  def jipe_id_for(record, field, options = {})
-    options = {
-      :class => record.class.to_s,
-      :id => nil }.update(options || {})
-    rclass = options[:class]
-    if options[:id]
-      return options[:id]
-    else
-      return "#{rclass.downcase}_#{record.id}_#{field}"
+  class Engine < Rails::Engine
+    initializer 'jipe.extend_helpers' do
+      ActionView::Base.send :include, Jipe::Helpers
     end
   end
-
-  def jipe_editor_for(record, field, options = {})
-    options = { :external_control => true,
-      :class => record.class.to_s,
-      :rows => 1 }.update(options || {})
-    rclass = options[:class]
-    outstr = <<-ENDDOC
-      <script type="text/javascript">
-          new Jipe.InPlaceEditor("#{jipe_id_for(record, field, options)}",
-          #{rclass}, #{record.id}, #{field.to_json}, {
-    ENDDOC
-    if options[:external_control]
-      outstr << "externalControl: 'edit_#{jipe_id_for(record, field, options)}', "
-      options.delete(:external_control)
-    end
-    if options[:on_complete]
-      outstr << "onComplete: #{options[:on_complete]}, "
-      options.delete(:on_complete)
-    end
-    if protect_against_forgery?
-      outstr << "authenticityToken: '#{form_authenticity_token}', "
+  
+  module Helpers
+    def jipe_id_for(record, field, options = {})
+      options = {
+        :class => record.class.to_s,
+        :id => nil }.update(options || {})
+      rclass = options[:class]
+      if options[:id]
+        return options[:id]
+      else
+        return "#{rclass.downcase}_#{record.id}_#{field}"
+      end
     end
-    outstr << "rows: #{options[:rows]},"
-    options.delete(:rows)
-    options.delete(:id)
+
+    def jipe_editor_for(record, field, options = {})
+      options = { :external_control => true,
+        :class => record.class.to_s,
+        :rows => 1 }.update(options || {})
+      rclass = options[:class]
+      outstr = <<-ENDDOC
+        <script type="text/javascript">
+            new Jipe.InPlaceEditor("#{jipe_id_for(record, field, options)}",
+            #{rclass}, #{record.id}, #{field.to_json}, {
+      ENDDOC
+      if options[:external_control]
+        outstr << "externalControl: 'edit_#{jipe_id_for(record, field, options)}', "
+        options.delete(:external_control)
+      end
+      if options[:on_complete]
+        outstr << "onComplete: #{options[:on_complete]}, "
+        options.delete(:on_complete)
+      end
+      if protect_against_forgery?
+        outstr << "authenticityToken: '#{form_authenticity_token}', "
+      end
+      outstr << "rows: #{options[:rows]},"
+      options.delete(:rows)
+      options.delete(:id)
     
-    # everything else is ajax options
-    outstr << "ajaxOptions: {"
-    options.each_pair do |k, v|
-      outstr << "'#{escape_javascript k.to_s}': '#{escape_javascript v.to_s}',"
-    end
-    unless options[:attributes]
-      outstr << "'attributes[]': '#{escape_javascript field.to_s}'"
-    end
+      # everything else is ajax options
+      outstr << "ajaxOptions: {"
+      options.each_pair do |k, v|
+        outstr << "'#{escape_javascript k.to_s}': '#{escape_javascript v.to_s}',"
+      end
+      unless options[:attributes]
+        outstr << "'attributes[]': '#{escape_javascript field.to_s}'"
+      end
     
-    outstr << "}});\n</script>"
-    return outstr
-  end
+      outstr << "}});\n</script>"
+      return outstr.html_safe
+    end
 
-  def jipe_editor(record, field, options = {})
-    options = { :external_control => true,
-      :class => record.class.to_s,
-      :rows => 1,
-      :editing => true,
-      :on_complete => nil }.update(options || {})
-    rclass = options[:class]
-    outstr = <<-ENDDOC
-      <span id="#{jipe_id_for(record, field, options)}">
-        #{record.send(field).to_s}
-      </span>
-    ENDDOC
-    if options[:editing]
-      outstr += <<-ENDDOC
-        #{ options[:external_control] ? image_tag("jipe/edit-field.png",
-          { :id => "edit_#{jipe_id_for(record, field, options)}" }) : "" }
-        #{ jipe_editor_for(record, field, options)}
+    def jipe_editor(record, field, options = {})
+      options = { :external_control => true,
+        :class => record.class.to_s,
+        :rows => 1,
+        :editing => true,
+        :on_complete => nil }.update(options || {})
+      rclass = options[:class]
+      outstr = <<-ENDDOC
+        <span id="#{jipe_id_for(record, field, options)}">
+          #{record.send(field).to_s}
+        </span>
       ENDDOC
+      if options[:editing]
+        outstr += <<-ENDDOC
+          #{ options[:external_control] ? image_tag("jipe/edit-field.png",
+            { :id => "edit_#{jipe_id_for(record, field, options)}" }) : "" }
+          #{ jipe_editor_for(record, field, options)}
+        ENDDOC
+      end
+      return outstr.html_safe
     end
-    return outstr
-  end
 
-  def jipe_select_field(record, field, choices, options = {}, html_options = {})
-    options = {
-      :class => record.class.to_s,
-      :on_complete => nil,
-    }.update(options || {})
+    def jipe_select_field(record, field, choices, options = {}, html_options = {})
+      options = {
+        :class => record.class.to_s,
+        :on_complete => nil,
+      }.update(options || {})
   
-    rclass = options.delete(:class)
-    value = record.send(field)
-    id = jipe_id_for(record, field, options)
+      rclass = options.delete(:class)
+      value = record.send(field)
+      id = jipe_id_for(record, field, options)
 
-    js_options = {}
-    js_options['onComplete'] = options.delete(:on_complete) if options[:on_complete]
-    if protect_against_forgery?
-      js_options["authenticityToken"] = form_authenticity_token
-    end
-    options.each do |k, v|
-      if v.nil?
-        options.delete(k)
-      elsif v.kind_of? String
-        options[k] = "'#{escape_javascript(v)}'"
+      js_options = {}
+      js_options['onComplete'] = options.delete(:on_complete) if options[:on_complete]
+      if protect_against_forgery?
+        js_options["authenticityToken"] = form_authenticity_token
       end
-    end
-    js_options['ajaxOptions'] = options_for_javascript(options)
+      options.each do |k, v|
+        if v.nil?
+          options.delete(k)
+        elsif v.kind_of? String
+          options[k] = "'#{escape_javascript(v)}'"
+        end
+      end
+      js_options['ajaxOptions'] = options_for_javascript(options)
 
-    outstr = <<-ENDDOC
-    #{select_tag id, options_for_select(choices, value), html_options}
-    <script type="text/javascript">
-      new Jipe.SelectField('#{id}', #{rclass}, #{record.id}, #{field.to_json},
-        #{options_for_javascript js_options});
-    </script>
-    ENDDOC
-    return outstr
-  end
-  
-  def jipe_image_toggle(record, field, true_image, false_image, options = {})
-    options = {
-      :class => record.class.to_s,
-      :on_complete => nil,
-    }.update(options || {})
-    rclass = options[:class]
-    value = record.send(field)
-    idprefix = jipe_id_for(record, field, options)
-    
-    js_options = {}
-    js_options['onComplete'] = options[:on_complete] if options[:on_complete]
-    if protect_against_forgery?
-      js_options["authenticityToken"] = form_authenticity_token
-    end
-    
-    outstr = <<-ENDDOC
-      #{image_tag true_image, :id => "#{idprefix}_true", 
-          :style => (value ? "" : "display: none") }
-      #{image_tag false_image, :id => "#{idprefix}_false", 
-          :style => (value ? "display: none" : "") }
+      outstr = <<-ENDDOC
+      #{select_tag id, options_for_select(choices, value), html_options}
       <script type="text/javascript">
-        new Jipe.ImageToggle("#{idprefix}_true", "#{idprefix}_false",
-          #{rclass}, #{record.id}, #{field.to_json},
+        new Jipe.SelectField('#{id}', #{rclass}, #{record.id}, #{field.to_json},
           #{options_for_javascript js_options});
       </script>
-    ENDDOC
-    return outstr
+      ENDDOC
+      return outstr.html_safe
+    end
+  
+    def jipe_image_toggle(record, field, true_image, false_image, options = {})
+      options = {
+        :class => record.class.to_s,
+        :on_complete => nil,
+      }.update(options || {})
+      rclass = options[:class]
+      value = record.send(field)
+      idprefix = jipe_id_for(record, field, options)
+    
+      js_options = {}
+      js_options['onComplete'] = options[:on_complete] if options[:on_complete]
+      if protect_against_forgery?
+        js_options["authenticityToken"] = form_authenticity_token
+      end
+    
+      outstr = <<-ENDDOC
+        #{image_tag true_image, :id => "#{idprefix}_true", 
+            :style => (value ? "" : "display: none") }
+        #{image_tag false_image, :id => "#{idprefix}_false", 
+            :style => (value ? "display: none" : "") }
+        <script type="text/javascript">
+          new Jipe.ImageToggle("#{idprefix}_true", "#{idprefix}_false",
+            #{rclass}, #{record.id}, #{field.to_json},
+            #{options_for_javascript js_options});
+        </script>
+      ENDDOC
+      return outstr.html_safe
+    end
   end
 end