bkoski-each_with_context 0.5.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Koski
+
+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,50 @@
+= each_with_context
+
+Inspired by the Liquid templating language's nice {for loop goodies}[http://wiki.github.com/tobi/liquid/liquid-for-designers],
+each_with_context provides some contextual information about an element in an each loop.
+
+If you've ever found yourself writing an <tt>each_with_index</tt> and 
+checking <tt>i == 0</tt> to see if the element is the first, or wondering whether the
+next element is differs from the current, this gem is for you.
+
+== INSTALLATION
+
+To use, just install the gem:
+
+  sudo gem install bkoski-each_with_context --source http://gems.github.com
+  
+and
+
+  require 'each_with_context'
+  
+Now you can call <tt>each_with_context</tt> on anything that's already Enumerable[http://www.ruby-doc.org/core/classes/Enumerable.html].
+
+
+== USAGE
+
+each_with_context accepts a block with two params: the element, and an EnumerableContext describing
+the element.  For example:
+
+  [1,2,3].each_with_context do |num, context|
+    
+    # Here, you can call:
+    context.first? # true if num is first element
+    context.last? # true if num is last element
+   
+    context.edge  # returns :first if first?, :last if last?, nil otherwise
+                  # useful when determining CSS selectors
+                   
+    context.next # next element; nil if that doesn't exist
+    context.previous # previous element; nil if that doesn't exist
+   
+    context.next_differs_on?(:some-method)      # These methods return true if element.some_method != next/previous.some_method
+    context.previous_differs_on?(:some-method)   # If there is no next/previous, they return nil
+    
+    context.previous_is? {|element, previous_element| previous_element > element} # These methods yield element and next/previous, then return the result of the block
+    context.next_is? {|element, next_element| next_element * 2 == element}        # Useful for more advanced comparisons. Method returns nil if there is no next/previous.
+    
+  end
+
+== COPYRIGHT
+
+Copyright (c) 2009 Ben Koski. See LICENSE for details.

data/lib/each_with_context/enumerable.rb

@@ -0,0 +1,11 @@
+module Enumerable
+
+  # Calls block with two arguments: the current <tt>element</tt> an EnumerableContext,
+  # which provides details about the element's context. See class docs for details.
+  def each_with_context &block
+    each_with_index do |element, i|
+      yield(element, EnumerableContext.new(self,i))
+    end
+  end
+
+end

data/lib/each_with_context/enumerable_context.rb

@@ -0,0 +1,75 @@
+class EnumerableContext
+  
+  # Current index into the collection
+  attr_accessor :index
+  
+  # Create with a collection and the index into that collection
+  def initialize collection, index
+    @collection = collection
+    @index = index
+  end
+  
+  # Is current index the first?
+  def first?
+    index == 0
+  end
+  
+  # Is current index the last?
+  def last?
+    index == @collection.length - 1
+  end
+  
+  # Returns :first if first?; last if last?; nil otherwise
+  def edge
+    :first if first?
+    :last if last?
+    nil
+  end
+  
+  # Returns the next element in the collection; nil if it does not exist
+  def next
+    last? ? nil : @collection[index + 1]
+  end
+  
+  # Returns the previous element in the collection; nil if it does not exist
+  def previous
+    first? ? nil : @collection[index - 1]
+  end
+  
+  # Returns true if the next element does not have the same value for <tt>field</tt>
+  def next_differs_on? field
+    if last?
+      nil
+    else
+      element.send(field) != self.next.send(field) # need to self to differentiate from keyword
+    end
+  end
+
+  # Returns true if the previous element does not have the same value for <tt>field</tt>
+  def previous_differs_on? field
+    if first?
+      nil
+    else
+      element.send(field) != previous.send(field)
+    end
+  end
+  
+  # Yields a block with element, next_element as params; returns value returned by block
+  # Returns nil if there is no next element.
+  def next_is? &block
+    last? ? nil : yield(element, self.next)
+  end
+  
+  # Yields a block with element, previous_element as params; returns value returned by block
+  # Returns nil if there is no previous element.
+  def previous_is? &block
+    first? ? nil : yield(element, self.previous)
+  end
+  
+  private
+  # Returns the element at the current index
+  def element
+    @collection[index]
+  end
+  
+end

data/lib/each_with_context.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'each_with_context/enumerable')
+require File.join(File.dirname(__FILE__), 'each_with_context/enumerable_context')

data/test/test_each_with_context.rb

@@ -0,0 +1,225 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestEachWithContext < Test::Unit::TestCase
+
+  context "first?" do
+    setup do
+      @collection = [1,2,3,4]
+    end
+
+    should "return true on last element" do
+      @collection.each_with_context do |num,c|
+         assert c.first? if num == 1
+      end
+    end
+    
+    should "return false for all other elements" do
+      @collection.each_with_context do |num,c|
+         assert !c.first?, "first? should be false for #{num}" if num != 1
+      end
+    end
+  end
+
+  context "last?" do
+    setup do
+      @collection = [1,2,3,4]
+    end
+
+    should "return true on last element" do
+      @collection.each_with_context do |num,c|
+         assert c.last? if num == 4
+      end
+    end
+    
+    should "return false for all other elements" do
+      @collection.each_with_context do |num,c|
+         assert !c.last?, "last? should be false for #{num}" if num != 4
+      end
+    end
+  end
+
+  context "edge" do
+    setup do
+      @collection = [1,2,3]
+    end
+
+    should "return :first for first element" do
+      @collection.each_with_context do |num,c|
+        assert_equal :first, c.edge if c == 1
+      end
+    end
+    
+    should "return :last for last element" do
+      @collection.each_with_context do |num,c|
+        assert_equal :last, c.edge if c == 3
+      end 
+    end
+    
+    should "return nil for an element in the middle" do
+      @collection.each_with_context do |num,c|
+        assert_nil c.edge if c == 2
+      end
+    end
+  end
+  
+  context "index" do
+    should "return the zero-based index as index" do
+      [0,1,2,3].each_with_context do |num,c|
+        assert_equal num, c.index
+      end
+    end
+  end
+  
+  context "next" do
+    setup do
+      @collection = ['a','b','c','d']
+    end
+
+    should "return the next element" do
+      @collection.each_with_context do |element, c|
+        assert_equal(@collection[c.index + 1], c.next) unless c.last?
+      end
+    end
+    
+    should "return nil if there is no next element" do
+      @collection.each_with_context do |element, c|
+        assert_nil c.next if c.last?
+      end
+    end
+  end
+  
+  context "previous" do
+    setup do
+      @collection = ['a','b','c','d']
+    end
+
+    should "return the previous element" do
+      @collection.each_with_context do |element, c|
+        assert_equal(@collection[c.index - 1], c.previous) unless c.first?
+      end
+    end
+    
+    should "return nil if there is no previous element" do
+      @collection.each_with_context do |element, c|
+        assert_nil c.previous if c.first?
+      end
+    end
+  end
+  
+  context "next_differs_on?" do
+    setup do
+      @collection = [Date.today, Date.today + 1, Date.today + 2]
+    end
+
+    should "return true if next element doesn't have same value for specified method" do
+      [Date.today, Date.today + 1, Date.today + 2].each_with_context do |date,c|
+        assert c.next_differs_on?(:day) unless c.last?
+      end
+    end
+    
+    should "return false if next element doesn't have same value for specified method" do
+      [Date.today, Date.today, Date.today].each_with_context do |date,c|
+        assert !c.next_differs_on?(:day) unless c.last?
+      end
+    end
+    
+    should "return nil if there is no next element" do
+      [Date.today, Date.today, Date.today].each_with_context do |date,c|
+        assert_nil c.next_differs_on?(:day) if c.last?
+      end
+    end
+  end
+  
+  context "previous_differs_on?" do
+    setup do
+      @collection = [Date.today, Date.today + 1, Date.today + 2]
+    end
+
+    should "return true if next element doesn't have same value for specified method" do
+      [Date.today, Date.today + 1, Date.today + 2].each_with_context do |date,c|
+        assert c.previous_differs_on?(:day) unless c.first?
+      end
+    end
+    
+    should "return false if next element doesn't have same value for specified method" do
+      [Date.today, Date.today, Date.today].each_with_context do |date,c|
+        assert !c.previous_differs_on?(:day) unless c.first?
+      end
+    end
+    
+    should "return nil if there is no next element" do
+      [Date.today, Date.today, Date.today].each_with_context do |date,c|
+        assert_nil c.previous_differs_on?(:day) if c.first?
+      end
+    end
+  end
+  
+  context "next_is?" do
+    setup do
+      @collection = [1,2,3,4]
+    end
+
+    should "yield block with element as first parameter" do
+      @collection.each_with_context do |element, c|
+        unless c.last?
+          c.next_is? { |e,n| assert_equal(element, e) }
+        end
+      end
+    end
+    
+    should "yield block with next element as second parameter" do
+      @collection.each_with_context do |element, c|
+        unless c.last?
+          c.next_is? { |e,n| assert_equal(c.next, n) }
+        end
+      end
+    end
+    
+    should "return nil if there is no next element" do
+      @collection.each_with_context do |element, c|
+        assert_nil(c.next_is? { |e,n| 29 }) if c.last?
+      end
+    end
+    
+    should "return value returned by block" do
+      @collection.each_with_context do |element, c|
+        assert_equal(49, c.next_is? { |e,n| 49 }) unless c.last?
+      end
+    end
+  end
+  
+  context "previous_is?" do
+    setup do
+      @collection = [1,2,3,4]
+    end
+
+    should "yield block with element as first parameter" do
+      @collection.each_with_context do |element, c|
+        unless c.first?
+          c.previous_is? { |e,p| assert_equal(element, e) }
+        end
+      end
+    end
+    
+    should "yield block with previous element as second parameter" do
+      @collection.each_with_context do |element, c|
+        unless c.first?
+          c.previous_is? { |e,p| assert_equal(c.previous, p) }
+        end
+      end
+    end
+    
+    should "return nil if there is no previous element" do
+      @collection.each_with_context do |element, c|
+        assert_nil(c.previous_is? { |e,p| 'test-value' }) if c.first?
+      end
+    end
+    
+    should "return value returned by block" do
+      @collection.each_with_context do |element, c|
+        assert_equal('test-value', c.previous_is? { |e,p| 'test-value' }) unless c.first?
+      end
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'each_with_context'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: bkoski-each_with_context
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Ben Koski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: gems@benkoski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/each_with_context
+- lib/each_with_context.rb
+- lib/each_with_context/enumerable.rb
+- lib/each_with_context/enumerable_context.rb
+- test/test_each_with_context.rb
+- test/test_helper.rb
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/bkoski/each_with_context
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Get contextual information about an element in an each loop
+test_files: []
+