best_in_place_rails_4 0.0.1

data/lib/assets/javascripts/best_in_place.purr.js

@@ -0,0 +1,10 @@
+//= require jquery.purr
+
+jQuery(document).on('best_in_place:error', function(event, request, error) {
+    // Display all error messages from server side validation
+    jQuery.each(jQuery.parseJSON(request.responseText), function(index, value) {
+      if( typeof(value) == "object") {value = index + " " + value.toString(); }
+      var container = jQuery("<span class='flash-error'></span>").html(value);
+      container.purr();
+    });
+});

data/lib/assets/javascripts/jquery.purr.js

@@ -0,0 +1,161 @@
+/**
+ * jquery.purr.js
+ * Copyright (c) 2008 Net Perspective (net-perspective.com)
+ * Licensed under the MIT License (http://www.opensource.org/licenses/mit-license.php)
+ *
+ * @author R.A. Ray
+ * @projectDescription  jQuery plugin for dynamically displaying unobtrusive messages in the browser. Mimics the behavior of the MacOS program "Growl."
+ * @version 0.1.0
+ *
+ * @requires jquery.js (tested with 1.2.6)
+ *
+ * @param fadeInSpeed           int - Duration of fade in animation in miliseconds
+ *                          default: 500
+ *  @param fadeOutSpeed         int - Duration of fade out animationin miliseconds
+                            default: 500
+ *  @param removeTimer          int - Timeout, in miliseconds, before notice is removed once it is the top non-sticky notice in the list
+                            default: 4000
+ *  @param isSticky             bool - Whether the notice should fade out on its own or wait to be manually closed
+                            default: false
+ *  @param usingTransparentPNG  bool - Whether or not the notice is using transparent .png images in its styling
+                            default: false
+ */
+
+(function(jQuery) {
+
+  jQuery.purr = function(notice, options)
+  {
+    // Convert notice to a jQuery object
+    notice = jQuery(notice);
+
+    // Add a class to denote the notice as not sticky
+    notice.addClass('purr');
+
+    // Get the container element from the page
+    var cont = document.getElementById('purr-container');
+
+    // If the container doesn't yet exist, we need to create it
+    if (!cont)
+    {
+      cont = '<div id="purr-container"></div>';
+    }
+
+    // Convert cont to a jQuery object
+    cont = jQuery(cont);
+
+    // Add the container to the page
+    jQuery('body').append(cont);
+
+    notify();
+
+    function notify ()
+    {
+      // Set up the close button
+      var close = document.createElement('a');
+      jQuery(close).attr({
+          className: 'close',
+          href: '#close'
+          }).appendTo(notice).click(function() {
+              removeNotice();
+              return false;
+          });
+
+      // If ESC is pressed remove notice
+      jQuery(document).keyup(function(e) {
+        if (e.keyCode == 27) {
+          removeNotice();
+        }
+      });
+
+      // Add the notice to the page and keep it hidden initially
+      notice.appendTo(cont).hide();
+
+      if (jQuery.browser.msie && options.usingTransparentPNG)
+      {
+        // IE7 and earlier can't handle the combination of opacity and transparent pngs, so if we're using transparent pngs in our
+        // notice style, we'll just skip the fading in.
+        notice.show();
+      }
+      else
+      {
+        //Fade in the notice we just added
+        notice.fadeIn(options.fadeInSpeed);
+      }
+
+      // Set up the removal interval for the added notice if that notice is not a sticky
+      if (!options.isSticky)
+      {
+        var topSpotInt = setInterval(function() {
+          // Check to see if our notice is the first non-sticky notice in the list
+          if (notice.prevAll('.purr').length == 0)
+          {
+            // Stop checking once the condition is met
+            clearInterval(topSpotInt);
+
+            // Call the close action after the timeout set in options
+            setTimeout(function() {
+                removeNotice();
+              }, options.removeTimer);
+          }
+        }, 200);
+      }
+    }
+
+    function removeNotice()
+    {
+      // IE7 and earlier can't handle the combination of opacity and transparent pngs, so if we're using transparent pngs in our
+      // notice style, we'll just skip the fading out.
+      if (jQuery.browser.msie && options.usingTransparentPNG)
+      {
+        notice.css({ opacity: 0 }).animate({ height: '0px'},
+            {
+              duration: options.fadeOutSpeed,
+              complete: function ()
+              {
+                notice.remove();
+              }
+            }
+          );
+      }
+      else
+      {
+        // Fade the object out before reducing its height to produce the sliding effect
+        notice.animate({ opacity: '0' },
+          {
+            duration: options.fadeOutSpeed,
+            complete: function ()
+              {
+                notice.animate({ height: '0px' },
+                  {
+                    duration: options.fadeOutSpeed,
+                    complete: function()
+                      {
+                        notice.remove();
+                      }
+                  }
+                );
+              }
+          }
+        );
+      }
+    };
+  };
+
+  jQuery.fn.purr = function(options)
+  {
+    options = options || {};
+    options.fadeInSpeed = options.fadeInSpeed || 500;
+    options.fadeOutSpeed = options.fadeOutSpeed || 500;
+    options.removeTimer = options.removeTimer || 4000;
+    options.isSticky = options.isSticky || false;
+    options.usingTransparentPNG = options.usingTransparentPNG || false;
+
+    this.each(function()
+      {
+        new jQuery.purr( this, options );
+      }
+    );
+
+    return this;
+  };
+})( jQuery );

data/lib/best_in_place_rails_4.rb

@@ -0,0 +1,11 @@
+require "best_in_place_rails_4/check_version"
+require "best_in_place_rails_4/utils"
+require "best_in_place_rails_4/helper"
+require "best_in_place_rails_4/engine"
+require "best_in_place_rails_4/railtie"
+require "best_in_place_rails_4/controller_extensions"
+require "best_in_place_rails_4/display_methods"
+require "action_view"
+
+module BestInPlaceRails4
+end

data/lib/best_in_place_rails_4/check_version.rb

@@ -0,0 +1,8 @@
+module BestInPlaceRails4
+  module CheckVersion
+    if Rails::VERSION::STRING < "4.0"
+      raise "This version of Best in Place is intended to be used for Rails >= 4.0."
+      return
+    end
+  end
+end

data/lib/best_in_place_rails_4/controller_extensions.rb

@@ -0,0 +1,28 @@
+module BestInPlaceRails4
+  module ControllerExtensions
+    def respond_with_bip(obj)
+      obj.changed? ? respond_bip_error(obj) : respond_bip_ok(obj)
+    end
+
+  private
+    def respond_bip_ok(obj)
+      if obj.respond_to?(:id)
+        klass = "#{obj.class}_#{obj.id}"
+      else
+        klass = obj.class.to_s
+      end
+      param_key = BestInPlaceRails4::Utils.object_to_key(obj)
+      updating_attr = params[param_key].keys.first
+
+      if renderer = BestInPlaceRails4::DisplayMethods.lookup(klass, updating_attr)
+        render :json => renderer.render_json(obj)
+      else
+        head :ok
+      end
+    end
+
+    def respond_bip_error(obj)
+      render :json => obj.errors.full_messages, :status => :unprocessable_entity
+    end
+  end
+end

data/lib/best_in_place_rails_4/display_methods.rb

@@ -0,0 +1,44 @@
+module BestInPlaceRails4
+  module DisplayMethods
+    extend self
+
+    class Renderer < Struct.new(:opts)
+      def render_json(object)
+        case opts[:type]
+        when :model
+          {:display_as => object.send(opts[:method])}.to_json
+        when :helper
+          value = if opts[:helper_options]
+                    BestInPlaceRails4::ViewHelpers.send(opts[:method], object.send(opts[:attr]), opts[:helper_options])
+                  else
+                    BestInPlaceRails4::ViewHelpers.send(opts[:method], object.send(opts[:attr]))
+                  end
+          {:display_as => value}.to_json
+        when :proc
+          {:display_as => opts[:proc].call(object.send(opts[:attr]))}.to_json
+        else
+          {}.to_json
+        end
+      end
+    end
+
+    @@table = Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
+
+    def lookup(klass, attr)
+      foo = @@table[klass.to_s][attr.to_s]
+      foo == {} ? nil : foo
+    end
+
+    def add_model_method(klass, attr, display_as)
+      @@table[klass.to_s][attr.to_s] = Renderer.new :method => display_as.to_sym, :type => :model
+    end
+
+    def add_helper_method(klass, attr, helper_method, helper_options = nil)
+      @@table[klass.to_s][attr.to_s] = Renderer.new :method => helper_method.to_sym, :type => :helper, :attr => attr, :helper_options => helper_options
+    end
+    
+    def add_helper_proc(klass, attr, helper_proc)
+      @@table[klass.to_s][attr.to_s] = Renderer.new :type => :proc, :attr => attr, :proc => helper_proc
+    end
+  end
+end

data/lib/best_in_place_rails_4/engine.rb

@@ -0,0 +1,8 @@
+module BestInPlaceRails4
+  class Engine < Rails::Engine
+    initializer "setup for rails" do
+      ActionView::Base.send(:include, BestInPlaceRails4::BestInPlaceHelpers)
+      ActionController::Base.send(:include, BestInPlaceRails4::ControllerExtensions)
+    end
+  end
+end

data/lib/best_in_place_rails_4/helper.rb

@@ -0,0 +1,128 @@
+module BestInPlaceRails4
+  module BestInPlaceHelpers
+
+    def best_in_place(object, field, opts = {})
+      if opts[:display_as] && opts[:display_with]
+        raise ArgumentError, "Can't use both 'display_as' and 'display_with' options at the same time"
+      end
+
+      if opts[:display_with] && !opts[:display_with].is_a?(Proc) && !ViewHelpers.respond_to?(opts[:display_with])
+        raise ArgumentError, "Can't find helper #{opts[:display_with]}"
+      end
+
+      real_object = real_object_for object
+      opts[:type] ||= :input
+      opts[:collection] ||= []
+      field = field.to_s
+
+      display_value = build_value_for(real_object, field, opts)
+
+      collection = nil
+      value = nil
+      if opts[:type] == :select && !opts[:collection].blank?
+        value = real_object.send(field)
+        display_value = Hash[opts[:collection]].stringify_keys[value.to_s]
+        collection = opts[:collection].to_json
+      end
+      if opts[:type] == :checkbox
+        value = !!real_object.send(field)
+        if opts[:collection].blank? || opts[:collection].size != 2
+          opts[:collection] = ["No", "Yes"]
+        end
+        display_value = value ? opts[:collection][1] : opts[:collection][0]
+        collection = opts[:collection].to_json
+      end
+      classes = ["best_in_place"]
+      unless opts[:classes].nil?
+        # the next three lines enable this opt to handle both a stings and a arrays
+        classes << opts[:classes]
+        classes.flatten!
+      end
+
+      out = "<span class='#{classes.join(" ")}'"
+      out << " id='#{BestInPlace::Utils.build_best_in_place_id(real_object, field)}'"
+      out << " data-url='#{opts[:path].blank? ? url_for(object) : url_for(opts[:path])}'"
+      out << " data-object='#{opts[:object_name] || BestInPlace::Utils.object_to_key(real_object)}'"
+      out << " data-collection='#{attribute_escape(collection)}'" unless collection.blank?
+      out << " data-attribute='#{field}'"
+      out << " data-activator='#{opts[:activator]}'" unless opts[:activator].blank?
+      out << " data-ok-button='#{opts[:ok_button]}'" unless opts[:ok_button].blank?
+      out << " data-cancel-button='#{opts[:cancel_button]}'" unless opts[:cancel_button].blank?
+      out << " data-nil='#{attribute_escape(opts[:nil])}'" unless opts[:nil].blank?
+      out << " data-use-confirm='#{opts[:use_confirm]}'" unless opts[:use_confirm].nil?
+      out << " data-type='#{opts[:type]}'"
+      out << " data-inner-class='#{opts[:inner_class]}'" if opts[:inner_class]
+      out << " data-html-attrs='#{opts[:html_attrs].to_json}'" unless opts[:html_attrs].blank?
+      out << " data-original-content='#{attribute_escape(real_object.send(field))}'" if opts[:display_as] || opts[:display_with]
+      out << " data-value='#{attribute_escape(value)}'" if value
+
+      if opts[:data] && opts[:data].is_a?(Hash)
+        opts[:data].each do |k, v|
+          if !v.is_a?(String) && !v.is_a?(Symbol)
+            v = v.to_json
+          end
+          out << %( data-#{k.to_s.dasherize}="#{v}")
+        end
+      end
+      if !opts[:sanitize].nil? && !opts[:sanitize]
+        out << " data-sanitize='false'>"
+        out << display_value.to_s
+      else
+        out << ">#{h(display_value.to_s)}"
+      end
+      out << "</span>"
+      raw out
+    end
+
+    def best_in_place_if(condition, object, field, opts={})
+      if condition
+        best_in_place(object, field, opts)
+      else
+        build_value_for real_object_for(object), field, opts
+      end
+    end
+
+  private
+    def build_value_for(object, field, opts)
+      return "" if object.send(field).blank?
+
+      if (object.respond_to?(:id))
+        klass = "#{object.class}_#{object.id}"
+      else
+        klass = object.class.to_s
+      end
+      if opts[:display_as]
+        BestInPlace::DisplayMethods.add_model_method(klass, field, opts[:display_as])
+        object.send(opts[:display_as]).to_s
+
+      elsif opts[:display_with].try(:is_a?, Proc)
+        BestInPlace::DisplayMethods.add_helper_proc(klass, field, opts[:display_with])
+        opts[:display_with].call(object.send(field))
+      elsif opts[:display_with]
+        BestInPlace::DisplayMethods.add_helper_method(klass, field, opts[:display_with], opts[:helper_options])
+        if opts[:helper_options]
+          BestInPlace::ViewHelpers.send(opts[:display_with], object.send(field), opts[:helper_options])
+        else
+          BestInPlace::ViewHelpers.send(opts[:display_with], object.send(field))
+        end
+
+      else
+        object.send(field).to_s.presence || ""
+      end
+    end
+
+    def attribute_escape(data)
+      return unless data
+
+      data.to_s.
+        gsub("&", "&amp;").
+        gsub("'", "&apos;").
+        gsub(/\r?\n/, "&#10;")
+    end
+
+    def real_object_for(object)
+      (object.is_a?(Array) && object.last.class.respond_to?(:model_name)) ? object.last : object
+    end
+  end
+end
+

data/lib/best_in_place_rails_4/railtie.rb

@@ -0,0 +1,7 @@
+module BestInPlaceRails4
+  class Railtie < Rails::Railtie
+    initializer "set view helpers" do
+      BestInPlaceRails4::ViewHelpers = ActionView::Base.new
+    end
+  end
+end

data/lib/best_in_place_rails_4/utils.rb

@@ -0,0 +1,21 @@
+module BestInPlaceRails4
+  module Utils
+    extend self
+
+    def build_best_in_place_id(object, field)
+      if object.is_a?(Symbol) || object.is_a?(String)
+        return "best_in_place_#{object}_#{field}"
+      end
+
+      id = "best_in_place_#{object_to_key(object)}"
+      id << "_#{object.id}" if object.class.ancestors.include?(ActiveModel::Serializers::JSON)
+      id << "_#{field}"
+      id
+    end
+
+    def object_to_key(object)
+      return object.class.to_s.underscore unless object.class.respond_to?(:model_name)
+      ActiveModel::Naming.param_key(object.class)
+    end
+  end
+end

data/lib/best_in_place_rails_4/version.rb

@@ -0,0 +1,3 @@
+module BestInPlaceRails4
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: best_in_place_rails_4
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Berry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: BestInPlace is a jQuery script and a Rails 3 helper that provide the
+  method best_in_place to display any object field easily editable for the user by
+  just clicking on it. It supports input data, text data, boolean data and custom
+  dropdown data. It works with RESTful controllers.
+email:
+- cavneb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- best_in_place_rails_4.gemspec
+- lib/assets/javascripts/best_in_place.js
+- lib/assets/javascripts/best_in_place.purr.js
+- lib/assets/javascripts/jquery.purr.js
+- lib/best_in_place_rails_4.rb
+- lib/best_in_place_rails_4/check_version.rb
+- lib/best_in_place_rails_4/controller_extensions.rb
+- lib/best_in_place_rails_4/display_methods.rb
+- lib/best_in_place_rails_4/engine.rb
+- lib/best_in_place_rails_4/helper.rb
+- lib/best_in_place_rails_4/railtie.rb
+- lib/best_in_place_rails_4/utils.rb
+- lib/best_in_place_rails_4/version.rb
+homepage: http://github.com/cavneb/best_in_place
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: It makes any field in place editable by clicking on it, it works for inputs,
+  textareas, select dropdowns and checkboxes
+test_files: []