in_enumerable 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+## NETBEANS
+nbproject

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brian Morearty
+
+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,74 @@
+= in_enumerable
+
+A simple but nice language extension.
+
+in_enumerable extends the Object type with the tasty 'in?' method, which returns true if an object is included
+in a list or other enumerable value.  So you can do this:
+
+  1.in? [1,2]          # => true
+  3.in? [1,2]          # => false
+
+instead of the slightly more awkward:
+
+  [1,2].include?(1)    # => true
+  [1,2].include?(3)    # => false
+
+Despite its name, in_enumerable doesn't require an enumerable type.  
+It uses duck typing to work with any type that has an 'include?' method, such as:
+
+  # Array (see examples above)
+
+  # Hash
+  h = { "a" => 100, "b" => 200 }
+  "a".in?(h)           # => true
+  "z".in?(h)           # => false
+
+  # String
+  "lo".in?("hello")    # => true
+  "ol".in?("hello")    # => false
+  ?h.in?("hello")      # => true
+
+  # Range
+  25.in?(1..50)        # => true
+  75.in?(1..50)        # => false
+
+  # Set
+  require 'set'
+  s = Set.new([1,2])
+  1.in?(s)             # => true
+  3.in?(s)             # => false
+
+  # Even Module
+  module A
+  end
+  class B
+    include A
+  end
+  class C < B
+  end
+  A.in?(B)             # => true
+  A.in?(C)             # => true
+  A.in?(A)             # => false
+
+== Installation
+
+  gem install in_enumerable
+
+== Usage
+
+  require 'rubygems'
+  require 'in_enumerable'
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Brian Morearty. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "in_enumerable"
+    gem.summary = %Q{extends the Object type with the tasty 'in?' method}
+    gem.description = %Q{extends the Object type with the tasty 'in?' method, which returns true if an object is included
+in a list or other enumerable value.  So you can do this:
+  1.in? [1,2]          # => true
+  3.in? [1,2]          # => false
+}
+    gem.email = "brian at morearty.org"
+    gem.homepage = "http://github.com/BMorearty/in_enumerable"
+    gem.authors = ["Brian Morearty"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "in_enumerable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/in_enumerable.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{in_enumerable}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Morearty"]
+  s.date = %q{2009-12-24}
+  s.description = %q{extends the Object type with the tasty 'in?' method, which returns true if an object is included
+in a list or other enumerable value.  So you can do this:
+  1.in? [1,2]          # => true
+  3.in? [1,2]          # => false
+}
+  s.email = %q{brian at morearty.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "in_enumerable.gemspec",
+     "lib/in_enumerable.rb",
+     "test/helper.rb",
+     "test/test_in_enumerable.rb"
+  ]
+  s.homepage = %q{http://github.com/BMorearty/in_enumerable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{extends the Object type with the tasty 'in?' method}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_in_enumerable.rb"
+  ]
+
+  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
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/in_enumerable.rb

@@ -0,0 +1,18 @@
+# Extends the Object type with the tasty 'in?' method, which tells you if an object is included
+# in an Array or other enumerable value
+module InEnumerable
+  # Returns true if enumerable includes self.  Like this:
+  #
+  #   1.in? [1,2]          # => true
+  #   3.in? [1,2]          # => false
+  #
+  # == Parameters
+  # [enumerable]    Any value that implements an include? method.  E.g., Array, Hash, String, Range.
+  def in?(enumerable)
+    enumerable.include? self
+  end
+end
+
+class Object
+  include InEnumerable
+end

data/test/helper.rb

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

data/test/test_in_enumerable.rb

@@ -0,0 +1,57 @@
+require 'helper'
+require 'set'
+
+class TestInEnumerable < Test::Unit::TestCase
+  context "An Array [1,2]" do
+    should "include 1 but not 3" do
+      assert 1.in?([1,2])       # => true
+      assert !3.in?([1,2])      # => false
+    end
+  end
+
+  context "A Hash with keys 'a' and 'b'" do
+    should "include 'a' but not 'z'" do
+      h = { "a" => 100, "b" => 200 }
+      assert "a".in?(h)         # => true
+      assert !"z".in?(h)        # => false
+    end
+  end
+
+  context "A String 'hello'" do
+    should "include 'lo' and ?h but not 'ol'" do
+      assert "lo".in?("hello")    # => true
+      assert !"ol".in?("hello")   # => false
+      assert ?h.in?("hello")      # => true
+    end
+  end
+
+  context "A Range (1..50)" do
+    should "include 25 but not 75" do
+      assert 25.in?(1..50)        # => true
+      assert !75.in?(1..50)       # => false
+    end
+  end
+
+  context "A Set {1,2}" do
+    should "include 1 but not 3" do
+      s = Set.new([1,2])
+      assert 1.in?(s)             # => true
+      assert !3.in?(s)            # => false
+    end
+  end
+
+  context "Module A included in B which has subclass C" do
+    should "be in B and C but not in itself" do
+      module A
+      end
+      class B
+        include A
+      end
+      class C < B
+      end
+      assert A.in?(B)             # => true
+      assert A.in?(C)             # => true
+      assert !A.in?(A)            # => false
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: in_enumerable
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brian Morearty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  extends the Object type with the tasty 'in?' method, which returns true if an object is included
+  in a list or other enumerable value.  So you can do this:
+    1.in? [1,2]          # => true
+    3.in? [1,2]          # => false
+
+email: brian at morearty.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- in_enumerable.gemspec
+- lib/in_enumerable.rb
+- test/helper.rb
+- test/test_in_enumerable.rb
+has_rdoc: true
+homepage: http://github.com/BMorearty/in_enumerable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: extends the Object type with the tasty 'in?' method
+test_files: 
+- test/helper.rb
+- test/test_in_enumerable.rb