spaghetti 0.2.6

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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spaghetti.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Omar Abdel-Wahab
+
+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,41 @@
+# Spaghetti
+
+Endless page for Rails > 3.1 using jQuery Sausage.
+Spaghetti supports both [Kaminari](https://github.com/amatsuda/kaminari) and [will_paginate](https://github.com/mislav/will_paginate).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spaghetti'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spaghetti
+
+## Usage
+
+Make sure you add spaghetti JavaScript to your `application.js`:
+    
+    //= require spaghetti
+
+Then add spaghetti markup to your view (example: posts/index.html):
+    
+    <%= spaghetti 'posts', posts_path %>
+    
+You need to have your `posts_controller` responding with the following `index.js.erb` file:
+    
+    <%= spaghetti 'posts', @posts %>
+
+
+## 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

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/helpers/spaghetti_helpers.rb

@@ -0,0 +1,20 @@
+module SpaghettiHelpers
+  def spaghetti name, path_or_items
+    output = ''.html_safe
+    puts path_or_items.class.name
+    if path_or_items.class.name == 'String'
+      output << "<div class=\"#{ name } spaghetti\" data-spaghetti-enabled=\"1\" data-spaghetti-url=\"#{ path_or_items }\" data-spaghetti-next-page=\"1\"><div class=\"items\"></div><div class=\"throbber\">#{ image_tag 'throbber.gif' }</div></div>".html_safe
+    else
+      if path_or_items.any?
+        output << "$('.#{ name } .items').append('#{ j render path_or_items }');".html_safe
+        output << "$('.#{ name }').data('spaghetti-next-page', #{ params[:page].to_i + 1 });".html_safe
+        output << "$('.#{ name }').data('spaghetti-enabled', '1');".html_safe
+      else
+        output << "$('.#{ name }').data('spaghetti-enabled', '0');".html_safe
+        output << "$('.#{ name }').append($('<div class=\"spaghetti-disabled\"></div>'));".html_safe
+      end
+      output << "$('.#{ name }').removeClass('spaghetti-loading');".html_safe
+    end
+    output
+  end  
+end

data/lib/spaghetti.rb

@@ -0,0 +1,2 @@
+require "spaghetti/version"
+require "spaghetti/engine"

data/lib/spaghetti/engine.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../../app/helpers/spaghetti_helpers'
+
+module Spaghetti
+  class Engine < ::Rails::Engine
+    initializer "spaghetti.setup_helpers" do |app|
+      app.config.to_prepare do
+        ActionController::Base.send :helper, SpaghettiHelpers
+      end
+    end
+  end
+end

data/lib/spaghetti/version.rb

@@ -0,0 +1,3 @@
+module Spaghetti
+  VERSION = "0.2.6"
+end

data/spaghetti.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spaghetti/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spaghetti"
+  gem.version       = Spaghetti::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors       = ["Omar Abdel-Wahab"]
+  gem.email         = ["owahab@gmail.com"]
+  gem.description   = %q{Spaghetti - Rails Endless Page}
+  gem.summary       = %q{Spaghetti - Rails Endless Page}
+  gem.homepage      = "http://github.com/owahab/spaghetti"
+  gem.add_dependency 'jquery-rails', '>= 2.1'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/vendor/assets/javascripts/spaghetti.js

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery-ui
+//= require spaghetti/jquery.sausage
+//= require spaghetti/init

data/vendor/assets/javascripts/spaghetti/init.js

@@ -0,0 +1,23 @@
+$(function() {
+  function nearBottomOfPage() {
+    return $(window).scrollTop() > $(document).height() - $(window).height() - 200;
+  }
+
+  $(window).scroll(function(){
+    if ($('.spaghetti').data('spaghetti-enabled') == 1) {
+      if(nearBottomOfPage()) {
+        $('.spaghetti').data('spaghetti-enabled', 0);
+        $('.spaghetti').addClass('spaghetti-loading');
+        $.ajax({
+          url: $('.spaghetti').data('spaghetti-url') + '?page=' + $('.spaghetti').data('spaghetti-next-page'),
+          type: 'get',
+          dataType: 'script',
+          success: function() {
+            $(window).sausage('draw');
+          }
+        });
+      }
+    }
+  });
+  $(window).sausage();
+}); 

data/vendor/assets/javascripts/spaghetti/jquery.sausage.js

@@ -0,0 +1,428 @@
+//     jquery.sausage.js 1.0.0
+//     (c) 2011 Christopher Cliff
+//     Freely distributed under the MIT license.
+//     For all details and documentation:
+//     http://christophercliff.github.com/sausage
+
+(function($, undefined){
+    
+    $.widget('cc.sausage', {
+        
+        // # Options
+        //
+        //
+        
+        options: {
+            
+            // ### page `string`
+            //
+            // Sets the string to be used to select page elements.
+            // 
+            // Example:
+            // 
+            //      $(window)
+            //          .sausage({
+            //              page: '.my-page-selector'
+            //          })
+            //          ;
+            //
+            page: '.page',
+            
+            // ### content `function`
+            // 
+            // Sets the content of the sausage elements. Use `i` and `$page` to render content dynamically.
+            // 
+            // Example:
+            // 
+            //      $(window)
+            //          .sausage({
+            //              content: function (i, $page) {
+            //                  return '<div>' + $page.data('name') + '</div>';
+            //          }
+            //      })
+            //      ;
+            //
+            content: function (i, $page) {
+                return '<span class="sausage-span">' + (i + 1) + '</span>';
+            }
+            
+        },
+        
+        // # Private Methods
+        //
+        //
+        
+        // ## `._create()`
+        //
+        //
+        _create: function () {
+            
+            var self = this,
+                $el = self.element;
+            
+            // Use $el for the outer element.
+            self.$outer = $el;
+            // Use `body` for the inner element if the outer element is `window`. Otherwise, use the first child of `$el`.
+            self.$inner = $.isWindow(self.element.get(0)) ? $('body') : $el.children(':first-child');
+            self.$sausages = $('<div class="sausage-set"/>');
+            self.sausages = self.$sausages.get(0);
+            self.offsets = [];
+            
+            self.$sausages
+                .appendTo(self.$inner)
+                ;
+            
+            // Trigger the `create` event.
+            self._trigger('create');
+            
+            return;
+        },
+        
+        // ## `._init()`
+        //
+        //
+        _init: function () {
+            
+            var self = this;
+            
+            // Stop and destroy if scroll bar is not present.
+            if (self.$outer.height() >= self.$inner.height())
+            {
+                self.destroy();
+                
+                return;
+            }
+            
+            self.draw();
+            self._update();
+            self._events();
+            self._delegates();
+            
+            // Add a CSS class for styling purposes.
+            self.$sausages
+                .addClass('sausage-set-init')
+                ;
+            
+            self.blocked = false;
+            
+            // Trigger the `init` event.
+            self._trigger('init');
+            
+            return;
+        },
+        
+        // ## `._events()`
+        //
+        //
+        _events: function () {
+            
+            var self = this;
+            
+            self.hasScrolled = false;
+            
+            self.$outer
+                .bind('resize.sausage', function(){
+                    
+                    self.draw();
+                    
+                })
+                .bind('scroll.sausage', function(e){
+                    
+                    self.hasScrolled = true;
+                    
+                })
+                ;
+            
+            // [Prevent crazy amounts of scroll events from being fired](http://ejohn.org/blog/learning-from-twitter/) by setting an interval and listening.
+            setInterval(function(){
+                
+                if (!self.hasScrolled)
+                {
+                    return;
+                }
+                
+                self.hasScrolled = false;
+                self._update();
+                
+            }, 250);
+            
+            return;
+        },
+        
+        // ## `._getCurrent()`
+        //
+        //
+        _getCurrent: function () {
+            
+            var self = this,
+                st = self.$outer.scrollTop() + self._getHandleHeight(self.$outer, self.$inner)/4,
+                h_win = self.$outer.height(),
+                h_doc = self.$inner.height(),
+                i = 0;
+            
+            for (l = self.offsets.length; i < l; i++)
+            {
+                if (!self.offsets[i + 1])
+                {
+                    return i;
+                }
+                else if (st <= self.offsets[i])
+                {
+                    return i;
+                }
+                else if (st > self.offsets[i] && st <= self.offsets[i + 1])
+                {
+                    return i;
+                }
+            }
+            
+            return i;
+        },
+        
+        // ## `._delegates()`
+        //
+        //
+        _delegates: function () {
+            
+            var self = this;
+            
+            self.$sausages
+                .delegate('.sausage', 'hover', function(){
+                    
+                    if (self.blocked)
+                    {
+                        return;
+                    }
+                    
+                    $(this)
+                        .toggleClass('sausage-hover')
+                        ;
+                    
+                })
+                .delegate('.sausage', 'click', function(e){
+                    e.preventDefault();
+                    
+                    if (self.blocked)
+                    {
+                        return;
+                    }
+                    
+                    var $sausage = $(this),
+                        val = $sausage.index(),
+                        o = self.$inner.find(self.options.page).eq(val).offset().top;
+                    
+                    self._scrollTo(o);
+                    
+                    // Trigger the `onClick` event.
+                    // 
+                    // Example:
+                    // 
+                    //      $(window)
+                    //          .sausage({
+                    //              onClick: function (e, o) {
+                    //                  alert('You clicked the sausage at index: ' + o.i);
+                    //          }
+                    //      })
+                    //      ;
+                    //
+                    self._trigger('onClick', e, {
+                        $sausage: $sausage,
+                        i: val
+                    });
+                    
+                    if ($sausage.hasClass('current'))
+                    {
+                        return;
+                    }
+                    
+                    // Trigger the `onUpdate` event.
+                    self._trigger('onUpdate', e, {
+                        $sausage: $sausage,
+                        i: val
+                    });
+                })
+                ;
+            
+            return;
+        },
+        
+        _scrollTo: function (o) {
+            
+            var self = this,
+                $outer = self.$outer,
+                rate = 2/1, // px/ms
+                distance = self.offsets[self.current] - o,
+                duration = Math.abs(distance/rate);
+                // Travel at 2 px per 1 ms but never longer than 1 s.
+                duration = (duration < 1000) ? duration : 1000;
+            
+            if (self.$outer.get(0) === window)
+            {
+                $outer = $('body, html, document');
+            }
+            
+            $outer
+                .stop(true)
+                .animate({
+                    scrollTop: o
+                }, duration)
+                ;
+            
+            return;
+        },
+        
+        _handleClick: function () {
+            
+            var self = this
+            
+            
+            
+            return;
+        },
+        
+        // ## `._update()`
+        //
+        //
+        _update: function () {
+            
+            var self = this;
+                i = self._getCurrent(),
+                c = 'sausage-current';
+            
+            if (i === self.current || self.blocked)
+            {
+                return;
+            }
+            
+            self.current = i;
+            
+            self.$sausages.children().eq(i)
+                .addClass(c)
+            .siblings()
+                .removeClass(c)
+                ;
+            
+            // Trigger the `update` event.
+            self._trigger('update');
+            
+            return;
+        },
+        
+        // ### `._getHandleHeight()`
+        // 
+        // 
+        _getHandleHeight: function ($outer, $inner) {
+            
+            var h_outer = $outer.height(),
+                h_inner = $inner.height();
+            
+            return h_outer/h_inner*h_outer;
+        },
+        
+        // # Public Methods
+        //
+        //
+        
+        // ### draw `.sausage("draw")`
+        // 
+        // Creates the sausage UI elements.
+        draw: function () {
+            
+            var self = this,
+                h_win = self.$outer.height(),
+                h_doc = self.$inner.height(),
+                $items = self.$inner.find(self.options.page),
+                $page,
+                s = [],
+                offset_p,
+                offset_s;
+            
+            self.offsets = [];
+            self.count = $items.length;
+            
+            // Detach from DOM while making changes.
+            self.$sausages
+                .detach()
+                .empty()
+                ;
+            
+            // Calculate the element heights and push to an array.
+            for (var i = 0; i < self.count; i++)
+            {
+                $page = $items.eq(i);
+                offset_p = $page.offset();
+                offset_s = offset_p.top/h_doc*h_win;
+                
+                s.push('<div class="sausage' + ((i === self.current) ? ' sausage-current' : '') + '" style="height:' + ($page.outerHeight()/h_doc*h_win) + 'px;top:' + offset_s + 'px;">' + self.options.content(i, $page) + '</div>');
+                
+                // Create `self.offsets` for calculating current sausage.
+                self.offsets.push(offset_p.top);
+            }
+            
+            // Use Array.join() for speed.
+            self.sausages.innerHTML = s.join('');
+            
+            // And reattach.
+            self.$sausages
+                .appendTo(self.$inner)
+                ;
+            
+            return;
+        },
+        
+        // ### block `.sausage("block")`
+        // 
+        // Blocks the UI to prevent users from interacting with the sausage UI. Useful when loading data and updating the DOM.
+        block: function () {
+            
+            var self = this,
+                c = 'sausage-set-blocked';
+            
+            self.blocked = true;
+            
+            // Add a CSS class for styling purposes.
+            self.$sausages
+                .addClass(c)
+                ;
+            
+            return;
+        },
+        
+        // ### unblock `.sausage("unblock")`
+        // 
+        // Unblocks the UI once loading and DOM manipulation are complete.
+        unblock: function () {
+            
+            var self = this,
+                c = 'sausage-set-blocked';
+            
+            self.$sausages
+                .removeClass(c)
+                ;
+            
+            self.blocked = false;
+            
+            return;
+        },
+        
+        // ### destroy `.sausage("destroy")`
+        // 
+        // Removes the sausage instance from the DOM.
+        destroy: function () {
+            
+            var self = this;
+            
+            self.$outer
+                .unbind('.sausage')
+                ;
+            
+            self.$sausages
+                .remove()
+                ;
+            
+            return;
+        }
+        
+    });
+    
+})(jQuery);

data/vendor/assets/stylesheets/spaghetti.css

@@ -0,0 +1,12 @@
+.throbber {
+  display: none;
+  text-align: center;
+}
+
+.spaghetti-loading > .throbber {
+  display: block;
+}
+
+.spaghetti-disabled {
+  padding: 20px;
+}

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: spaghetti
+version: !ruby/object:Gem::Version
+  version: 0.2.6
+  prerelease: 
+platform: ruby
+authors:
+- Omar Abdel-Wahab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Spaghetti - Rails Endless Page
+email:
+- owahab@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/spaghetti_helpers.rb
+- lib/spaghetti.rb
+- lib/spaghetti/engine.rb
+- lib/spaghetti/version.rb
+- spaghetti.gemspec
+- vendor/assets/images/throbber.gif
+- vendor/assets/javascripts/spaghetti.js
+- vendor/assets/javascripts/spaghetti/init.js
+- vendor/assets/javascripts/spaghetti/jquery.sausage.js
+- vendor/assets/stylesheets/spaghetti.css
+homepage: http://github.com/owahab/spaghetti
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2528948971779599297
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2528948971779599297
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Spaghetti - Rails Endless Page
+test_files: []