array_floe 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ronen Barzel
+
+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,76 @@
+= array_floe
+
+This small extension to ruby's Array class simplifies the reasonably-common
+need to specially handle "floe"--i.e., <b>f</b>irst, <b>l</b>ast, <b>o</b>dd, <b>e</b>ven--when
+iterating through the elements of an array.  It's particularly handy for
+generating CSS classes.
+
+The gem provides two additional iterators, Array#each_with_floe and
+Array#each_with_index_floe, that provide a "floe" object for each element
+in the array:
+
+    ary.each_with_floe do |element, floe|
+        if floe.first?
+            puts "#{element} is the first element"
+        end
+        if floe.last?
+            puts "#{element} is the last element"
+        end
+        if floe.odd?
+            puts "#{element} is an odd-numbered element"
+        end
+        if floe.even?
+            puts "#{element} is an even-numbered element"
+        end
+    end
+
+    ary.each_with_index_floe do |element, i, floe|
+        assert_equal(i == 0,        floe.first?)
+        assert_equal(i == ary.last, floe.last?)
+        assert_equal(i % 2 == 1,    float.odd?)
+        assert_equal(i % 2 == 1,    float.even?)
+    end
+
+If no block is given, an enumerator is returned instead.
+
+The "floe" object's <code>to_s</code> method returns a space-separated list
+of "first", "last", "odd", and "even" as appropriate:
+
+    [:a, :b, :c, :d].each_with_floe.collect{|element, floe| floe.to_s} #=> [ "first even", "odd", "even", "last odd" ]
+
+<code>floe.to_s</code> is particularly useful when generating HTML.  For
+example, this haml[http://haml-lang.com/] snippet:
+
+    %table
+    - [:a, :b, :c, :d].each_with_floe do |row, floe|
+      %tr{:class => floe}
+        %td= row
+
+would yield this HTML snippet:
+
+    <table>
+        <tr class="first even">
+            <td>a</td>
+        </tr>
+        <tr class="odd">
+            <td>b</td>
+        </tr>
+        <tr class="even">
+            <td>c</td>
+        </tr>
+        <tr class="last odd">
+            <td>d</td>
+        </tr>
+    </table>
+
+== Installing
+
+<code>% sudo gem install array_floe<code>
+
+or, if you're using bundler[http://gembundler.com/]:
+
+    gem "array_floe"
+
+== Copyright
+
+Released under the MIT License.  See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,56 @@
+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 = "array_floe"
+  gem.homepage = "http://github.com/ronen/array_floe"
+  gem.license = "MIT"
+  gem.summary = %Q{Provides iterators Array#each_with_floe and Array#each_with_index_floe}
+  gem.description = %Q{
+This small extension to ruby's Array class provides two additional
+iterators, Array#each_with_floe and Array#each_with_index_floe, that
+simplify the reasonably-common need to specially handle "floe"--i.e.,
+first, last, odd, even--when iterating through the elements of an array.
+It's particularly handy for generating CSS classes.
+  }
+  gem.email = "ronen@barzel.org"
+  gem.authors = ["ronen barzel"]
+  # 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 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "array_floe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/array_floe.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{array_floe}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ronen barzel"]
+  s.date = %q{2011-04-09}
+  s.description = %q{
+This small extension to ruby's Array class provides two additional
+iterators, Array#each_with_floe and Array#each_with_index_floe, that
+simplify the reasonably-common need to specially handle "floe"--i.e.,
+first, last, odd, even--when iterating through the elements of an array.
+It's particularly handy for generating CSS classes.
+  }
+  s.email = %q{ronen@barzel.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "array_floe.gemspec",
+    "lib/array_floe.rb",
+    "spec/array_floe_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ronen/array_floe}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Provides iterators Array#each_with_floe and Array#each_with_index_floe}
+  s.test_files = [
+    "spec/array_floe_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  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<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/array_floe.rb

@@ -0,0 +1,88 @@
+class Array
+
+  # The class for the "floe" object that constructed by
+  # Array#each_with_floe and Array#each_with_index_floe
+  class FirstLastOddEven
+    def initialize(i, size) # :nodoc:
+      @first = i == 0
+      @last = i == size -1
+      @odd = i.odd?
+    end
+    
+    # Returns true for the first element
+    def first? 
+      @first
+    end
+    
+    # Returns true for the last element
+    def last?
+      @last
+    end
+
+    # Returns true for odd-numbered elements
+    def odd?
+      @odd
+    end
+
+    # Returns true for even-numbered elements
+    def even?
+      !@odd
+    end
+
+    # Returns a space-separated list of "first", "last", "odd", and "even"
+    # as appropriate for the current element.
+    def to_s
+      @str ||= [@first && "first", @last && "last", @odd ? "odd" : "even"].select{|x| x}.join(' ')
+    end
+  end
+
+  # For each element in the array, calls the block with two arguments: the
+  # element and a "floe" object.
+  #
+  #    ary.each_with_floe do |element, floe|
+  #      if floe.first?
+  #          puts "#{element} is the first element"
+  #      end
+  #      if floe.last?
+  #          puts "#{element} is the last element"
+  #      end
+  #      if floe.odd?
+  #          puts "#{element} is an odd-numbered element"
+  #      end
+  #      if floe.even?
+  #          puts "#{element} is an even-numbered element"
+  #      end
+  #  end
+  #
+  # If no block is given, an enumerator is returned instead.
+  def each_with_floe() # :yields: element, floe
+    if block_given?
+      each_with_index do |element, i|
+        yield(element, FirstLastOddEven.new(i, size))
+      end
+    else
+      Enumerable::Enumerator.new(self, :each_with_floe)
+    end
+  end
+  
+  # For each element in the array, calls the block with three arguments: the
+  # element, its index, and a "floe" object.
+  #
+  #   ary.each_with_index_floe do |element, i, floe|
+  #       assert_equal(i == 0,        floe.first?)
+  #       assert_equal(i == ary.last, floe.last?)
+  #       assert_equal(i % 2 == 1,    float.odd?)
+  #       assert_equal(i % 2 == 1,    float.even?)
+  #   end
+  #
+  # If no block is given, an enumerator is returned instead.
+  def each_with_index_floe() # :yields: element, i, floe
+    if block_given?
+      each_with_index do |element, i|
+        yield(element, i, FirstLastOddEven.new(i, size))
+      end
+    else
+      Enumerable::Enumerator.new(self, :each_with_index_floe)
+    end
+  end
+end

data/spec/array_floe_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ArrayFloe" do
+
+  let (:a1) { Array(0...1) }
+  let (:a5) { Array(0...5) }
+
+  ["each_with_floe", "each_with_index_floe"].each do |method|
+
+    context method do
+
+      it "has correct arity" do
+        a5.send(method) do |*args|
+          args.size == (method == "each_with_index_floe" ? 3 : 2)
+        end
+      end
+
+      it "correctly reports first" do
+        a5.send(method) do |*args|
+          item = args.first
+          floe = args.last
+          floe.first?.should == (item == 0)
+        end
+      end
+
+      it "correctly reports last" do
+        a5.send(method) do |*args|
+          item = args.first
+          floe = args.last
+          floe.last?.should == (item == 4)
+        end
+      end
+
+      it "correctly reports odd" do
+        a5.send(method) do |*args|
+          item = args.first
+          floe = args.last
+          floe.odd?.should == (item % 2  == 1)
+        end
+      end
+
+      it "correctly reports even" do
+        a5.send(method) do |*args|
+          item = args.first
+          floe = args.last
+          floe.even?.should == (item % 2  == 0)
+        end
+      end
+
+      it "returns an enumerator" do
+        a5.send(method).should be_an_instance_of Enumerable::Enumerator
+        a5.send(method).find{|args| args.last.last? }.first.should == 4
+      end
+
+      it "iterates on the array entries" do
+        a5.send(method).collect(&:first).should == a5
+      end
+
+      if method == "each_with_index_floe"
+        it "passes the index" do
+          a5.send(method).collect{|args| args[1]}.should == a5
+        end
+      end
+
+      it "constructs floe strings" do
+        a5.send(method).collect{ |args| args.last.to_s }.should == [
+          "first even",
+          "odd",
+          "even",
+          "odd",
+          "last even"
+        ]
+      end
+
+      it "constructs first and last floe string when size == 1" do
+        a1.send(method).collect{|args| args.last.to_s}.should == [ "first last even" ]
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'array_floe'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: array_floe
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+description: "\n\
+  This small extension to ruby's Array class provides two additional\n\
+  iterators, Array#each_with_floe and Array#each_with_index_floe, that\n\
+  simplify the reasonably-common need to specially handle \"floe\"--i.e.,\n\
+  first, last, odd, even--when iterating through the elements of an array.\n\
+  It's particularly handy for generating CSS classes.\n  "
+email: ronen@barzel.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- array_floe.gemspec
+- lib/array_floe.rb
+- spec/array_floe_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ronen/array_floe
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Provides iterators Array#each_with_floe and Array#each_with_index_floe
+test_files: 
+- spec/array_floe_spec.rb
+- spec/spec_helper.rb