gonzo_array_extensions 0.1.0

data/Manifest

@@ -0,0 +1,10 @@
+Manifest
+README.rdoc
+Rakefile
+lib/gonzo_array_extensions.rb
+lib/gonzo_array_extensions/array.rb
+spec/custom_matchers.rb
+spec/gonzo_array_extensions/array_spec.rb
+spec/gonzo_array_extensions_spec.rb
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,73 @@
+= Gonzo Array Extensions
+
+Extends the Ruby core Array class, and augments some of its methods with additional functionality.
+
+== Install
+
+  gem install gonzo_array_extensions --source http://gemcutter.org
+  
+== Usage
+
+Gonzo Array Extensions augments the Array methods first, last and include? so you can pass an optional block to each so you can check for additional information.
+
+To use the library just include the gem in your code...
+  
+  include 'rubygems'
+  include 'gonzo_array_extensions'
+
+=== Array#first
+
+As well as supporting the original functionality of Array#first you can also pass an additional block and the first element(s) matching the block will be returned.
+
+  a = [ 1, 2, 3, 4, 5, 6 ]
+  a.first { |x| x > 3 }    #=> 4
+  a.first(1) { |x| x > 3 } #=> [4]
+  a.first(3) { |x| x > 3 } #=> [4, 5, 6]
+  a.first { |x| x > 6 }    #=> nil
+
+=== Array#last
+  
+As well as supporting the original functionality of Array#last you can also pass an additional block and the last element(s) matching the block will be returned.
+
+  a = [ 1, 2, 3, 4, 5, 6 ]
+  a.last { |x| x < 3 }    #=> 2
+  a.last(1) { |x| x < 3 } #=> [2]
+  a.last(3) { |x| x < 5 } #=> [2, 3, 4]  
+  a.first { |x| x > 6 }   #=> nil
+
+=== Array#include?
+
+As well as supporting the original functionality of Array#include? you can also pass an additional block and the method will return true if any element(s) match.
+
+  a = [ 1, 2, 3, 4, 5, 6 ]
+  a.include? { |x| x < 3 }    #=> true
+  a.include? { |x| x > 6 }    #=> false
+      
+== Thanks      
+      
+Thats it really!
+
+Love Rob.
+
+== License
+
+Copyright (c) 2010 Robert Oles
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+Echoe.new('gonzo_array_extensions', '0.1.0') do |p|
+  p.description    = "Extends standard library Array with some common gonzo needs"
+  p.url            = "http://github.com/robertoles/gonzo_array_extensions"
+  p.author         = "Robert Oles"
+  p.email          = "robertoles@me.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/gonzo_array_extensions.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gonzo_array_extensions}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robert Oles"]
+  s.date = %q{2010-02-21}
+  s.description = %q{Extends standard library Array with some common gonzo needs}
+  s.email = %q{robertoles@me.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/gonzo_array_extensions.rb", "lib/gonzo_array_extensions/array.rb", "tasks/rspec.rake"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/gonzo_array_extensions.rb", "lib/gonzo_array_extensions/array.rb", "spec/custom_matchers.rb", "spec/gonzo_array_extensions/array_spec.rb", "spec/gonzo_array_extensions_spec.rb", "spec/spec_helper.rb", "tasks/rspec.rake", "gonzo_array_extensions.gemspec"]
+  s.homepage = %q{http://github.com/robertoles/gonzo_array_extensions}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gonzo_array_extensions", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{gonzo_array_extensions}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Extends standard library Array with some common gonzo needs}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/gonzo_array_extensions/array.rb

@@ -0,0 +1,26 @@
+module Gonzo
+  module ArrayExtensions
+    def self.included(base)
+      base.instance_eval do
+        alias_method_chain :first, :block
+        alias_method_chain :last, :block
+        alias_method_chain :include?, :block
+      end
+    end
+    
+    def first_with_block(*args, &block)
+      return first_without_block(*args) unless block_given?
+      select(&block).first_without_block(*args)
+    end
+    
+    def last_with_block(*args, &block)
+      return last_without_block(*args) unless block_given?
+      select(&block).last_without_block(*args)
+    end
+    
+    def include_with_block?(*args, &block)
+      return include_without_block?(*args) unless block_given?
+      !select(&block).empty?
+    end
+  end
+end

data/lib/gonzo_array_extensions.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'activesupport'
+require 'gonzo_array_extensions/array'
+
+if defined? Array
+  Array.instance_eval do
+    include ActiveSupport::CoreExtensions::Module 
+    include Gonzo::ArrayExtensions
+  end
+end

data/spec/custom_matchers.rb

@@ -0,0 +1,24 @@
+module CustomMatchers
+  class IncludeModule
+    def initialize(expected_module)
+      @expected_module = expected_module
+    end
+
+    def matches?(clazz)
+      @clazz = clazz
+      @clazz.include?(@expected_module)
+    end
+
+    def failure_message_for_should
+      "expected #{@clazz.inspect} to include the module #{@expected_module.inspect}"
+    end
+
+    def failure_message_for_should_not
+      "expected #{@clazz.inspect} not to include the module #{@expected_module.inspect}"
+    end
+  end
+
+  def include_module(expected_module)
+    IncludeModule.new(expected_module)
+  end
+end

data/spec/gonzo_array_extensions/array_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require File.join(ROOT, 'lib', 'gonzo_array_extensions')
+
+describe Array do
+  describe "#first" do
+    describe "maintain its original functionality" do
+      it "should return nil if the array is empty" do
+        [].first.should be_nil
+      end
+      
+      it "should still return the first item" do
+        [1,2,3].first.should == 1
+      end
+      
+      it "should still return a single item in an array when n is one" do
+        [1,2,3].first(1).should == [1]
+      end
+      
+      it "should still return an array with the amount of items for n" do
+        [1,2,3,4,5].first(3).should == [1,2,3]
+      end
+    end
+    
+    describe "using a block" do
+      it "should return nil if no match is found" do
+        ["some", "word", "foobar"].first{ |x| x == "blah" }.should be_nil
+      end
+      
+      it "should return the first item which matches the block" do
+        ["some", "word", "foobar"].first{ |x| x == "foobar" }.should == "foobar"
+      end
+      
+      it "should return the a first item matching the block in an array when n is one" do
+        ["some", "word", "foobar"].first(1){ |x| x == "foobar"}.should == ["foobar"]
+      end
+      
+      it "should return an array with the first n elements matching the block" do
+        [1, "foobar", 2, "foo", "bar"].first(2){ |x| x.instance_of?(String) }.should == ["foobar", "foo"]
+      end
+    end
+  end
+  
+  describe "#last" do
+    describe "maintain its original functionality" do
+      it "should return nil if the array is empty" do
+        [].last.should be_nil
+      end
+      
+      it "should still return the last item" do
+        [1,2,3].last.should == 3
+      end
+      
+      it "should still return a single item in an array when n is one" do
+        [1,2,3].last(1).should == [3]
+      end
+      
+      it "should still return an array with the amount of items for n" do
+        [1,2,3,4,5].last(3).should == [3,4,5]
+      end
+    end
+    
+    describe "using a block" do
+      it "should return nil if no match is found" do
+        ["some", "word", "foobar"].last{ |x| x == "blah" }.should be_nil
+      end
+      
+      it "should return the first item which matches the block" do
+        ["some", "word", "foobar"].last{ |x| x == "some" }.should == "some"
+      end
+      
+      it "should return the a first item matching the block in an array when n is one" do
+        ["some", "word", "foobar"].last(1){ |x| x == "some"}.should == ["some"]
+      end
+      
+      it "should return an array with the first n elements matching the block" do
+        [1, "foobar", 2, "foo", "bar"].last(2){ |x| x.instance_of?(String) }.should == ["foo", "bar"]
+      end
+    end
+  end
+  
+  describe "#include?" do
+    describe "maintain the original functionality" do
+      it "should still return true if the item is included in the array" do
+        [1,2,3].should include(2)
+      end
+      
+      it "should still return false if the item is not included in the array" do
+        [1,2,3].should_not include(4)
+      end
+    end
+    
+    describe "using a block" do
+      it "should return true if a matching item if found in the array" do
+        ["some", "word", "foobar"].include?{ |x| x.length == 6 }.should be_true
+      end
+      
+      it "should return false if a macthing item is not found in the array" do
+        ["some", "word", "foobar"].include?{ |x| x.length == 2 }.should be_false
+      end
+    end
+  end
+end

data/spec/gonzo_array_extensions_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Loading gonzo array extensions' do
+  
+  before do
+    require File.join(ROOT, 'lib', 'gonzo_array_extensions')
+  end
+  
+  it "should include the Gonzo::ArayExtensions module in the core array class" do
+    Array.should include_module(Gonzo::ArrayExtensions)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+
+ROOT = File.join(File.dirname(__FILE__), '..')
+
+require File.join(ROOT, 'lib', 'gonzo_array_extensions', 'array.rb')
+
+require File.dirname(__FILE__) + "/custom_matchers"
+Spec::Runner.configure do |config|
+  config.include(CustomMatchers)
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["-c"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gonzo_array_extensions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Robert Oles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-21 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Extends standard library Array with some common gonzo needs
+email: robertoles@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/gonzo_array_extensions.rb
+- lib/gonzo_array_extensions/array.rb
+- tasks/rspec.rake
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/gonzo_array_extensions.rb
+- lib/gonzo_array_extensions/array.rb
+- spec/custom_matchers.rb
+- spec/gonzo_array_extensions/array_spec.rb
+- spec/gonzo_array_extensions_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- gonzo_array_extensions.gemspec
+has_rdoc: true
+homepage: http://github.com/robertoles/gonzo_array_extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Gonzo_array_extensions
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: gonzo_array_extensions
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Extends standard library Array with some common gonzo needs
+test_files: []
+