izzy 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b1d3b907301db63a45af7c7a18a9aebd0158c12
-  data.tar.gz: ceff0672f2abc1784bd6516e274bec640ebf6748
+  metadata.gz: f887dc8ba689628a9a7fa1998d390283069082f3
+  data.tar.gz: afc2eb39a69dc0e1e7f426dd6103ab19947381fc
 SHA512:
-  metadata.gz: 586b68549ebc90aeee1448e544e35825130c01320361612361abb925e41d434a75bed7d31173b2b7bd14d910c9ca5d54e83448c52be13581b7433860a7e46fd9
-  data.tar.gz: 216cfa83cfce99dbf5c41d032ce90c2e10b8b39159e6b9a2946a9edf2a3c58422fabb3ab64a564b133db80515562090fc8e3b41bfdd258444d02d60e4c9409c2
+  metadata.gz: 451277cec47478a5b83a416d075eab35ce3a483e5d0567fcdc44915b53562ac25655d4f39e1e3966936dc85ea3634b89c5604ff752eebf455e01ffc9d76176bd
+  data.tar.gz: fe4923ee0732d862bed2f8b06bc10b267c7def3ae6de02dbafe03f33c6f9904dfddd1ed7ad7138547121ce49d01eee41046437df569e8e6dfbe24506a6f654a8

data/CHANGELOG.md

@@ -44,4 +44,13 @@ Added a module to be mixed into Array, allowing for encapsulation of function ev
 Methods added:
 * all_are
 * any_are
-* none_are
+* none_are
+
+## v 3.2.0 - Merge QEnumerable
+
+Merged the QEnumerable gem into Izzy because of similarities. Removed respond_to? on checks (not including arrays) in order to skim down the time.
+
+Methods added:
+* select_where
+* reject_where
+* find_where

data/README.md

@@ -6,58 +6,31 @@
 
 ## Izzy Module
 
-To demo Izzy, let's take our class, Person:
+To demo Izzy, let's make a Person:
 
-```ruby
-class Person
-  include Izzy # Make sure to include Izzy!
-  attr_reader :name, :age, :sex
-
-  def initialize(name, age, sex)
-    @name = name
-    @age  = age
-    @sex  = sex
-  end
-
-  def older_than_18?; @age > 18 end
-
-  def younger_than_18?; @age < 18 end
-
-  def male?; @sex == 'm'; end
-
-  def female?; @sex == 'f' end
-
-  def me?; @name == 'brandon' && @sex == 'm' end
-
-  def geek?; @name == 'brandon' end
-end
-```
-
-So we make our person:
 ```ruby
 brandon = Person.new('brandon', 23, 'm')
 ```
 
-...and do some comparisons!
-```ruby
-brandon.all_of?  :older_than_18?, :male?, :me?, :geek? # => true
-brandon.none_of? :younger_than_18?, :female?           # => true
-brandon.any_of?  :male?, :female?, :geek?              # => true
-```
+### Matchers
 
-Maybe boolean comparisons aren't your cup of tea. Izzy has you covered my friend:
+Let's do some matching against it:
 ```ruby
 brandon.matches_all?  name: /^br/, age: (20..30) # => true
 brandon.matches_any?  name: /br$/, age: (20..30) # => true
 brandon.matches_none? name: /br&/, age: (30..40) # => true
 ```
-Izzy compares on === much like a case statement, allowing you to regex and range away! You can even do type checks while you're at it.
 
+#### Type Checking
+
+Perhaps you want to type check:
 ```ruby
 brandon.matches_all? name: String, age: Integer
 ```
 
-Why stop there? Need a bit more power? We have Lambdas for that!
+#### Lambdas
+
+Need a bit more power? We have Lambdas for that!
 
 ```ruby
 longer_than_3 = -> n { n.length > 3 }
@@ -66,6 +39,8 @@ is_odd = -> a { a.odd? }
 brandon.matches_all? name: longer_than_3, age: is_odd # => true
 ```
 
+### Multi Matchers
+
 ....or let's push it further for some interesting results:
 
 ```ruby
@@ -81,11 +56,18 @@ brandon.matches_all?(
 
 ```
 
-Simple to the point, no more mess of && or || checks for the same object. All you have to do is include Izzy in your object and you're ready to go!
+#### Boolean Matchers
+
+...and do some comparisons on boolean methods!
+```ruby
+brandon.all_of?  :older_than_18?, :male?, :me?, :geek? # => true
+brandon.none_of? :younger_than_18?, :female?           # => true
+brandon.any_of?  :male?, :female?, :geek?              # => true
+```
 
 ## Izzy Array Module
 
-But wait! There's more! IzzyArray allows you a few more tricks on top of that!
+IzzyArray allows you a few more tricks on top of that!
 ```ruby
 class Array; include IzzyArray end
 
@@ -96,6 +78,61 @@ class Array; include IzzyArray end
 
 Combine with rails :present?, :empty?, and various other methods and you have some interesting results! This one will get some more power with experimentation.
 
+## Izzy Enumerable
+
+Let's get ourselves a collection to use:
+```ruby
+class Object; include Izzy end
+
+brandon = Person.new('brandon', 23, 'm')
+john    = Person.new('john',    42, 'm')
+jill    = Person.new('jill',    31, 'f')
+alice   = Person.new('alice',   50, 'f')
+zeke    = Person.new('zeke',    18, 'm')
+
+people = [brandon, john, jill, alice, zeke]
+```
+
+### Select Where
+
+Select all objects where params match:
+```ruby
+people.select_where name: /^j/
+# => [john, jill]
+
+people.select_where(
+  age: [
+    (20..35),
+    -> a { a.odd? }
+  ]
+)
+# => [brandon]
+```
+
+### Reject Where
+
+Reject all objects where params match:
+```ruby
+people.reject_where name: /^j/
+# => [brandon, alice, zeke]
+
+people.reject_where(
+  age: [
+    (20..35),
+    -> a { a.odd? }
+  ]
+)
+# => [john, jill, alice, zeke]
+```
+
+### Find Where
+
+Finds the first object where params match:
+```ruby
+people.find_where name: /^j/, gender: 'm'
+# => john
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default  => :spec
+task :default => :spec

data/lib/izzy.rb

@@ -1,6 +1,9 @@
 require 'izzy/version'
 
 module Izzy
+
+  # Boolean Predicate
+
   def all_of?(*methods)
     methods.all? &method_check
   end
@@ -13,6 +16,8 @@ module Izzy
     methods.none? &method_check
   end
 
+  # Matchers
+
   def matches_all?(matchers = {})
     matchers.all? &matcher_check(:all?)
   end
@@ -25,32 +30,46 @@ module Izzy
     matchers.none? &matcher_check(:any?)
   end
 
+  # Enumerable Matchers
+
+  def select_where(matchers = {})
+    self.select { |s| s.matches_all? matchers }
+  end
+
+  def reject_where(matchers = {})
+    self.reject { |s| s.matches_all? matchers }
+  end
+
+  def find_where(matchers = {})
+    self.find { |s| s.matches_all? matchers }
+  end
+
   private
 
   def method_check
-    -> m { self.respond_to?(m) && self.send(m) }
+    -> m { self.send(m) }
   end
 
   def matcher_check(type = :all?)
     -> matcher { 
       m, val = *matcher
       values = val.is_a?(Array) ? val : Array[val]
-      values.send(type) { |v| self.respond_to?(m) && v === self.send(m) }
+      values.send(type) { |v| v === self.send(m) }
     }
   end
 end
 
 module IzzyArray
   def all_are(m)
-    self.all?(&object_block(m))
+    self.all? &object_block(m)
   end
 
   def any_are(m)
-    self.any?(&object_block(m))
+    self.any? &object_block(m)
   end
 
   def none_are(m)
-    self.none?(&object_block(m))
+    self.none? &object_block(m)
   end
 
   private

data/lib/izzy/version.rb

@@ -1,3 +1,3 @@
 module Izzy
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/spec/izzy_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+class Object; include Izzy end
+
 class Person
   include Izzy
 
@@ -11,131 +13,168 @@ class Person
     @sex  = sex
   end
 
-  def older_than_18?
-    @age > 18
-  end
-
-  def younger_than_18?
-    @age < 18
-  end
-
-  def male?
-    @sex.eql? 'm'
-  end
-
-  def female?
-    @sex.eql? 'f'
-  end
-
-  def me?
-    @name.eql?('brandon') && @sex.eql?('m')
-  end
-
-  def geek?
-    @name.eql? 'brandon'
-  end
+  def older_than_18?;   @age > 18                               end
+  def younger_than_18?; @age < 18                               end
+  def male?;            @sex.eql? 'm'                           end
+  def female?;          @sex.eql? 'f'                           end
+  def me?;              @name.eql?('brandon') && @sex.eql?('m') end
+  def geek?;            @name.eql? 'brandon'                    end
 end
 
-describe 'Person' do
-  before(:all) { @person = Person.new('brandon', 23, 'm') }
+brandon = Person.new('brandon', 23, 'm')
+john    = Person.new('john',    42, 'm')
+jill    = Person.new('jill',    31, 'f')
+alice   = Person.new('alice',   50, 'f')
+zeke    = Person.new('zeke',    18, 'm')
 
-  describe '#all_of?' do
-    it 'returns true if Person matches all of the conditions' do
-      expect(@person.all_of? :older_than_18?, :male?, :geek?).to be_true
-    end
+people = [brandon, john, jill, alice, zeke]
 
-    it 'returns false if Person does not match all of the conditions' do
-      expect(@person.all_of? :younger_than_18, :male?).to be_false
+describe 'Person' do
+  context 'Boolean Predicates' do
+    describe '#all_of?' do
+      it 'returns true if Person matches all of the conditions' do
+        expect(brandon.all_of? :older_than_18?, :male?, :geek?).to be_true
+      end
+
+      it 'returns false if Person does not match all of the conditions' do
+        expect(brandon.all_of? :younger_than_18?, :male?).to be_false
+      end
     end
-  end
 
-  describe '#any_of?' do
-    it 'returns true if Person matches any of the conditions' do
-      expect(@person.any_of? :older_than_18?, :female?, :geek?).to be_true
-    end
+    describe '#any_of?' do
+      it 'returns true if Person matches any of the conditions' do
+        expect(brandon.any_of? :older_than_18?, :female?, :geek?).to be_true
+      end
 
-    it 'returns false if Person matches none of the conditions' do
-      expect(@person.any_of? :younger_than_18, :female?).to be_false
+      it 'returns false if Person matches none of the conditions' do
+        expect(brandon.any_of? :younger_than_18?, :female?).to be_false
+      end
     end
-  end
 
-  describe '#none_of?' do
-    it 'returns true if Person matches none of the conditions' do
-      expect(@person.none_of? :younger_than_18, :female?).to be_true
-    end
+    describe '#none_of?' do
+      it 'returns true if Person matches none of the conditions' do
+        expect(brandon.none_of? :younger_than_18?, :female?).to be_true
+      end
 
-    it 'returns false if Person matches any of the conditions' do
-      expect(@person.none_of? :older_than_18?, :female?, :geek?).to be_false
+      it 'returns false if Person matches any of the conditions' do
+        expect(brandon.none_of? :older_than_18?, :female?, :geek?).to be_false
+      end
     end
   end
 
-  describe '#matches_all?' do
-    it 'returns true if Person matches all of the conditions' do
-      expect(
-        @person.matches_all?(name: /br/, age: (20..30))
-      ).to be_true
+  context 'Matchers' do
+    describe '#matches_all?' do
+      it 'returns true if Person matches all of the conditions' do
+        expect(
+          brandon.matches_all?(name: /br/, age: (20..30))
+        ).to be_true
+      end
+
+      it 'returns true for multiple conditionals' do
+        expect(
+          brandon.matches_all?(
+            name: [/br/, /an/],
+            age: [(20..30), -> a { a < 30 }]
+          )
+        ).to be_true
+      end
+
+      it 'returns false if Person does not match all conditions' do
+        expect(
+          brandon.matches_all?(name: /br/, age: (25..30))
+        ).to be_false
+      end
     end
 
-    it 'returns true for multiple conditionals' do
-      expect(
-        @person.matches_all?(
-          name: [/br/, /an/],
-          age: [(20..30), -> a { a < 30 }]
-        )
-      ).to be_true
+    describe '#matches_any?' do
+      it 'returns true if Person matches all of the conditions' do
+        expect(
+          brandon.matches_any?(name: /br/, age: (25..30))
+        ).to be_true
+      end
+
+      it 'returns true for multiple conditionals' do
+        expect(
+          brandon.matches_any?(
+            name: [/br/, /an/],
+            age: [(30..40), -> a { a > 30 }]
+          )
+        ).to be_true
+      end
+
+
+      it 'returns false if Person does not match any conditions' do
+        expect(
+          brandon.matches_any?(name: /br$/, age: (25..30))
+        ).to be_false
+      end
     end
 
-    it 'returns false if Person does not match all conditions' do
-      expect(
-        @person.matches_all?(name: /br/, age: (25..30))
-      ).to be_false
+    describe '#matches_none?' do
+      it 'returns true if Person matches none of the conditions' do
+        expect(
+          brandon.matches_none?(name: /br$/, age: (25..30))
+        ).to be_true
+      end
+
+      it 'returns true for multiple conditionals' do
+        expect(
+          brandon.matches_none?(
+            name: [/br$/, /foo/],
+            age: [(30..40), -> a { a > 30 }]
+          )
+        ).to be_true
+      end
+
+      it 'returns false if Person matches any of the conditions' do
+        expect(
+          brandon.matches_none?(name: /br/, age: (25..30))
+        ).to be_false
+      end
     end
   end
 
-  describe '#matches_any?' do
-    it 'returns true if Person matches all of the conditions' do
-      expect(
-        @person.matches_any?(name: /br/, age: (25..30))
-      ).to be_true
-    end
+  context 'Enumerable Matchers' do
+    describe '#select_where' do 
+      it 'returns people whose names start with j' do
+        expect(people.select_where(name: /^j/)).to eq([john, jill])
+      end
+
+      it 'returns people whose ages are above 30' do
+        expect(people.select_where(age: -> a { a > 30 })).to eq([john, jill, alice])
+      end
 
-    it 'returns true for multiple conditionals' do
-      expect(
-        @person.matches_any?(
-          name: [/br/, /an/],
-          age: [(30..40), -> a { a > 30 }]
-        )
-      ).to be_true
+      it 'returns people who are male' do
+        expect(people.select_where(sex: 'm')).to eq([brandon, john, zeke])
+      end
     end
 
+    describe '#reject_where' do
+      it 'returns people whose names do not start with j' do
+        expect(people.reject_where(name: /^j/)).not_to eq([john, jill])
+      end
 
-    it 'returns false if Person does not match any conditions' do
-      expect(
-        @person.matches_any?(name: /br$/, age: (25..30))
-      ).to be_false
-    end
-  end
+      it 'returns people whose ages are not above 30' do
+        expect(people.reject_where(age: -> a { a > 30 })).not_to eq([john, jill, alice])
+      end
 
-  describe '#matches_none?' do
-    it 'returns true if Person matches none of the conditions' do
-      expect(
-        @person.matches_none?(name: /br$/, age: (25..30))
-      ).to be_true
+      it 'returns people who are not male' do
+        expect(people.reject_where(sex: 'm')).not_to eq([brandon, john, zeke])
+      end
     end
 
-    it 'returns true for multiple conditionals' do
-      expect(
-        @person.matches_none?(
-          name: [/br$/, /foo/],
-          age: [(30..40), -> a { a > 30 }]
-        )
-      ).to be_true
-    end
+    describe '#find_where' do
+      it 'returns the first person whose name starts with j' do
+        expect(people.find_where(name: /^j/)).to eq(john)
+      end
+
+      it 'returns the first person whose age is above 30' do
+        expect(people.find_where(age: -> a { a > 30 })).to eq(john)
+      end
 
-    it 'returns false if Person matches any of the conditions' do
-      expect(
-        @person.matches_none?(name: /br/, age: (25..30))
-      ).to be_false
+      it 'returns the first person who is male' do
+        expect(people.find_where(sex: 'm')).to eq(brandon)
+      end
     end
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: izzy
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -59,10 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -84,12 +84,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []