best_in_place_mongoid 1.0.2

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($) {
+
+  $.purr = function(notice, options)
+  {
+    // Convert notice to a jQuery object
+    notice = $(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 = $(cont);
+
+    // Add the container to the page
+    $('body').append(cont);
+
+    notify();
+
+    function notify ()
+    {
+      // Set up the close button
+      var close = document.createElement('a');
+      $(close).attr({
+          className: 'close',
+          href: '#close'
+          }).appendTo(notice).click(function() {
+              removeNotice();
+              return false;
+          });
+
+      // If ESC is pressed remove notice
+      $(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();
+                      }
+                  }
+                );
+              }
+          }
+        );
+      }
+    };
+  };
+
+  $.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 $.purr( this, options );
+      }
+    );
+
+    return this;
+  };
+})( jQuery );

data/lib/best_in_place_mongoid.rb

@@ -0,0 +1,7 @@
+require "best_in_place_mongoid/utils"
+require "best_in_place_mongoid/helper"
+require "best_in_place_mongoid/engine"
+
+module BestInPlaceMongoid
+  autoload :TestHelpers, "best_in_place_mongoid/test_helpers"
+end

data/lib/best_in_place_mongoid/engine.rb

@@ -0,0 +1,7 @@
+module BestInPlaceMongoid
+  class Engine < Rails::Engine
+    initializer "setup for rails" do
+      ActionView::Base.send(:include, BestInPlaceMongoid::BestInPlaceMongoidHelpers)
+    end
+  end
+end

data/lib/best_in_place_mongoid/helper.rb

@@ -0,0 +1,53 @@
+module BestInPlaceMongoid
+  module BestInPlaceMongoidHelpers
+
+    def best_in_place(object, field, opts = {})
+      opts[:type] ||= :input
+      opts[:collection] ||= []
+      field = field.to_s
+      value = object.send(field).blank? ? "" : object.send(field)
+      collection = nil
+      if opts[:type] == :select && !opts[:collection].blank?
+        v = object.send(field)
+        value = Hash[opts[:collection]][!!(v =~ /^[0-9]+$/) ? v.to_i : v]
+        collection = opts[:collection].to_json
+      end
+      if opts[:type] == :checkbox
+        fieldValue = !!object.send(field)
+        if opts[:collection].blank? || opts[:collection].size != 2
+          opts[:collection] = ["No", "Yes"]
+        end
+        value = fieldValue ? opts[:collection][1] : opts[:collection][0]
+        collection = opts[:collection].to_json
+      end
+      out = "<span class='best_in_place'"
+      out << " id='#{BestInPlaceMongoid::Utils.build_best_in_place_id(object, field)}'"
+      out << " data-url='#{opts[:path].blank? ? url_for(object).to_s : url_for(opts[:path])}'"
+      out << " data-object='#{object.class.to_s.gsub("::", "_").underscore}'"
+      out << " data-collection='#{collection}'" unless collection.blank?
+      out << " data-attribute='#{field}'"
+      out << " data-activator='#{opts[:activator]}'" unless opts[:activator].blank?
+      out << " data-nil='#{opts[:nil].to_s}'" unless opts[:nil].blank?
+      out << " data-type='#{opts[:type].to_s}'"
+      out << " data-inner-class='#{opts[:inner_class].to_s}'" if opts[:inner_class]
+      out << " data-html-attrs='#{opts[:html_attrs].to_json}'" unless opts[:html_attrs].blank?
+      if !opts[:sanitize].nil? && !opts[:sanitize]
+        out << " data-sanitize='false'>"
+        out << sanitize(value.to_s, :tags => %w(b i u s a strong em p h1 h2 h3 h4 h5 ul li ol hr pre span img br), :attributes => %w(id class href))
+      else
+        out << ">#{sanitize(value.to_s, :tags => nil, :attributes => nil)}"
+      end
+      out << "</span>"
+      raw out
+    end
+
+    def best_in_place_if(condition, object, field, opts={})
+      if condition
+        best_in_place(object, field, opts)
+      else
+        object.send field
+      end
+    end
+  end
+end
+

data/lib/best_in_place_mongoid/test_helpers.rb

@@ -0,0 +1,39 @@
+module BestInPlaceMongoid
+  module TestHelpers
+
+    def bip_area(model, attr, new_value)
+      id = BestInPlaceMongoid::Utils.build_best_in_place_id model, attr
+      page.execute_script <<-JS
+        $("##{id}").click();
+        $("##{id} form textarea").val('#{new_value}');
+        $("##{id} form textarea").blur();
+      JS
+    end
+
+    def bip_text(model, attr, new_value)
+      id = BestInPlaceMongoid::Utils.build_best_in_place_id model, attr
+      page.execute_script <<-JS
+        $("##{id}").click();
+        $("##{id} input[name='#{attr}']").val('#{new_value}');
+        $("##{id} form").submit();
+      JS
+    end
+
+    def bip_bool(model, attr)
+      id = BestInPlaceMongoid::Utils.build_best_in_place_id model, attr
+      page.execute_script("$('##{id}').click();")
+    end
+
+    def bip_select(model, attr, name)
+      id = BestInPlaceMongoid::Utils.build_best_in_place_id model, attr
+      page.execute_script <<-JS
+        (function() {
+          $("##{id}").click();
+          var opt_value = $("##{id} select option:contains('#{name}')").attr('value');
+          $("##{id} select option[value='" + opt_value + "']").attr('selected', true);
+          $("##{id} select").change();
+        })();
+      JS
+    end
+  end
+end

data/lib/best_in_place_mongoid/utils.rb

@@ -0,0 +1,15 @@
+module BestInPlaceMongoid
+  class Utils
+
+    def self.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.class.to_s.demodulize.underscore}"
+      id << "_#{object.id}" if object.class.ancestors.include?(Mongoid::Document)
+      id << "_#{field}"
+      id
+    end
+  end
+end

data/lib/best_in_place_mongoid/version.rb

@@ -0,0 +1,3 @@
+module BestInPlaceMongoid
+  VERSION = "1.0.2"
+end

data/spec/helpers/best_in_place_mongoid_spec.rb

@@ -0,0 +1,239 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe BestInPlaceMongoid::BestInPlaceMongoidHelpers do
+  describe "#best_in_place" do
+    before do
+      @user = User.new :name => "Lucia",
+        :last_name => "Napoli",
+        :email => "lucianapoli@gmail.com",
+        :address => "Via Roma 99",
+        :zip => "25123",
+        :country => "2",
+        :receive_email => false,
+        :description => "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus a lectus et lacus ultrices auctor. Morbi aliquet convallis tincidunt. Praesent enim libero, iaculis at commodo nec, fermentum a dolor. Quisque eget eros id felis lacinia faucibus feugiat et ante. Aenean justo nisi, aliquam vel egestas vel, porta in ligula. Etiam molestie, lacus eget tincidunt accumsan, elit justo rhoncus urna, nec pretium neque mi et lorem. Aliquam posuere, dolor quis pulvinar luctus, felis dolor tincidunt leo, eget pretium orci purus ac nibh. Ut enim sem, suscipit ac elementum vitae, sodales vel sem."
+    end
+
+    it "should generate a proper span" do
+      nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+      span = nk.css("span")
+      span.should_not be_empty
+    end
+
+    describe "general properties" do
+      before do
+        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+        @span = nk.css("span")
+      end
+
+      context "when it's an Mongoid document" do
+        it "should have a proper id" do
+          @span.attribute("id").value.should == "best_in_place_user_#{@user.id}_name"
+        end
+      end
+
+      context "when it's not an AR model" do
+        it "shold generate an html id without any id" do
+          nk = Nokogiri::HTML.parse(helper.best_in_place [1,2,3], :first, :path => @user)
+          span = nk.css("span")
+          span.attribute("id").value.should == "best_in_place_array_first"
+        end
+      end
+
+      it "should have the best_in_place class" do
+        @span.attribute("class").value.should == "best_in_place"
+      end
+
+      it "should have the correct data-attribute" do
+        @span.attribute("data-attribute").value.should == "name"
+      end
+
+      it "should have the correct data-object" do
+        @span.attribute("data-object").value.should == "user"
+      end
+
+      it "should have no activator by default" do
+        @span.attribute("data-activator").should be_nil
+      end
+
+      it "should have no inner_class by default" do
+        @span.attribute("data-inner-class").should be_nil
+      end
+
+      describe "url generation" do
+        it "should have the correct default url" do
+          @user.save!
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+          span = nk.css("span")
+          span.attribute("data-url").value.should == "/users/#{@user.id}"
+        end
+
+        it "should use the custom url specified in string format" do
+          out = helper.best_in_place @user, :name, :path => "/custom/path"
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.attribute("data-url").value.should == "/custom/path"
+        end
+
+        it "should use the path given in a named_path format" do
+          out = helper.best_in_place @user, :name, :path => helper.users_path
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.attribute("data-url").value.should == "/users"
+        end
+
+        it "should use the given path in a hash format" do
+          out = helper.best_in_place @user, :name, :path => {:controller => :users, :action => :edit, :id => 23}
+          nk = Nokogiri::HTML.parse(out)
+          span = nk.css("span")
+          span.attribute("data-url").value.should == "/users/23/edit"
+        end
+      end
+
+      describe "nil option" do
+        it "should have no nil data by default" do
+          @span.attribute("data-nil").should be_nil
+        end
+
+        it "should show '' if the object responds with nil for the passed attribute" do
+          @user.stub!(:name).and_return(nil)
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+          span = nk.css("span")
+          span.text.should == ""
+        end
+
+        it "should show '' if the object responds with an empty string for the passed attribute" do
+          @user.stub!(:name).and_return("")
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+          span = nk.css("span")
+          span.text.should == ""
+        end
+      end
+
+      it "should have the given inner_class" do
+        out = helper.best_in_place @user, :name, :inner_class => "awesome"
+        nk = Nokogiri::HTML.parse(out)
+        span = nk.css("span")
+        span.attribute("data-inner-class").value.should == "awesome"
+      end
+
+      it "should have the given activator" do
+        out = helper.best_in_place @user, :name, :activator => "awesome"
+        nk = Nokogiri::HTML.parse(out)
+        span = nk.css("span")
+        span.attribute("data-activator").value.should == "awesome"
+      end
+    end
+
+
+    context "with a text field attribute" do
+      before do
+        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :name)
+        @span = nk.css("span")
+      end
+
+      it "should render the name as text" do
+        @span.text.should == "Lucia"
+      end
+
+      it "should have an input data-type" do
+        @span.attribute("data-type").value.should == "input"
+      end
+
+      it "should have no data-collection" do
+        @span.attribute("data-collection").should be_nil
+      end
+    end
+
+    context "with a boolean attribute" do
+      before do
+        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :receive_email, :type => :checkbox)
+        @span = nk.css("span")
+      end
+
+      it "should have a checkbox data-type" do
+        @span.attribute("data-type").value.should == "checkbox"
+      end
+
+      it "should have the default data-collection" do
+        data = ["No", "Yes"]
+        @span.attribute("data-collection").value.should == data.to_json
+      end
+
+      it "should render the current option as No" do
+        @span.text.should == "No"
+      end
+
+      describe "custom collection" do
+        before do
+          nk = Nokogiri::HTML.parse(helper.best_in_place @user, :receive_email, :type => :checkbox, :collection => ["Nain", "Da"])
+          @span = nk.css("span")
+        end
+
+        it "should show the message with the custom values" do
+          @span.text.should == "Nain"
+        end
+
+        it "should render the proper data-collection" do
+          @span.attribute("data-collection").value.should == ["Nain", "Da"].to_json
+        end
+      end
+
+    end
+
+    context "with a select attribute" do
+      before do
+        @countries = COUNTRIES.to_a
+        nk = Nokogiri::HTML.parse(helper.best_in_place @user, :country, :type => :select, :collection => @countries)
+        @span = nk.css("span")
+      end
+
+      it "should have a select data-type" do
+        @span.attribute("data-type").value.should == "select"
+      end
+
+      it "should have a proper data collection" do
+        @span.attribute("data-collection").value.should == @countries.to_json
+      end
+
+      it "should show the current country" do
+        @span.text.should == "Italy"
+      end
+    end
+  end
+
+  describe "#best_in_place_if" do
+    context "when the parameters are valid" do
+      before(:each) do
+        @output = "Some Value"
+        @field = :somefield
+        @object = mock("object", @field => @output)
+        @options = mock("options")
+      end
+      context "when the condition is true" do
+        before {@condition = true}
+        context "when the options parameter is left off" do
+          it "should call best_in_place with the rest of the parameters and empty options" do
+            helper.should_receive(:best_in_place).with(@object, @field, {})
+            helper.best_in_place_if @condition, @object, @field
+          end
+        end
+        context "when the options parameter is included" do
+          it "should call best_in_place with the rest of the parameters" do
+            helper.should_receive(:best_in_place).with(@object, @field, @options)
+            helper.best_in_place_if @condition, @object, @field, @options
+          end
+        end
+      end
+      context "when the condition is false" do
+        before {@condition = false}
+        it "should return the value of the field when the options value is left off" do
+          helper.best_in_place_if(@condition, @object, @field).should eq @output
+        end
+        it "should return the value of the field when the options value is included" do
+          helper.best_in_place_if(@condition, @object, @field, @options).should eq @output
+        end
+      end
+    end
+  end
+end