active_enumerable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016716ccb116b9441ef93f1d0698201c9b41ac50
-  data.tar.gz: a164e13d533c2aa282b9d7663ee65f1a28b8ea17
+  metadata.gz: f474e8fd2a0f244864a65b57e314e9a10b0a4ebf
+  data.tar.gz: 86960a5df4654c9d4301f37d9238614e1ac894d0
 SHA512:
-  metadata.gz: 7ab10d01e6738b89b9f375b1a1df9156f5cf8c2a3f96b026e698f244c232fd73a9188adc3523d678c721bb995b5902620e0b04dc4647c6fb90148e26f3112cb1
-  data.tar.gz: cb3a52fd97b0aae04319d7749e8df84b23fa9b30747cbc54c861f90b9c0d009ee6ba695e6dfb6a4db185fe541999e524ce5d72b86c799afc94a7ebdf4aac4c47
+  metadata.gz: 0184271b0c54d92a5d495a54a25fcbb78d9f9f68d0c51ad515f08477982ff64cedaf9fd0811c82e00976093156a5af2ef332f25c9d310550b51f87f549002a7c
+  data.tar.gz: 98a7c9613270176e506222bbfc447e3f5bbd3e45a2311d763884c956e03e584e8fef1dad54cf4e0e5ded48331836ff6ab993b2a429af59fc467a3f2419582203

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
+  - 2.1.7
   - 2.2.3
+  - 2.3.0
 before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.2.0 - 2015-02-15
+### Features
+- English like querying DSL
+
+### Enhancement 
+- `#where` can match when arrays are equal.
+- `#where` can match when strings with regex.
+
 ## 0.1.0 - 2015-12-31
 This version is only to secure the rubygem name.

data/README.md

@@ -1,5 +1,8 @@
 # ActiveEnumerable
 
+[![Build Status](https://travis-ci.org/zeisler/active_enumerable.svg?branch=master)](https://travis-ci.org/zeisler/active_enumerable)
+[![Gem Version](https://badge.fury.io/rb/active_enumerable.svg)](https://badge.fury.io/rb/active_enumerable)
+
 Include ActiveRecord like query methods to Ruby enumerable collections.
 
 ## Installation
@@ -20,6 +23,8 @@ Or install it yourself as:
 
 ## Usage
 
+### ActiveRecord Like Querying
+
 ```ruby
 require "active_enumerable"
 
@@ -46,6 +51,33 @@ Customers.item_class = Customer
 
 customers.create({paid: true, credit: 1500}).to_a.last
   #=> <#Customer paid: true, credit: 1500>
+ 
+```
+
+### English Like DSL
+
+```ruby
+class People
+  include ActiveEnumerable
+  
+  scope :unpaid, -> { where(paid: false).or(credit: 0) }
+end
+
+people = People.new([{ name: "Reuben" }, { name: "Naomi" }])
+people.where { has(:name).of("Reuben") } }
+    #=> <#People [{ name: "Reuben" }]]
+    
+    
+people = People.new( [
+        { name: "Reuben", parents: [{ name: "Mom", age: 29 }, { name: "Dad", age: 33 }] },
+        { name: "Naomi", parents: [{ name: "Mom", age: 29 }, { name: "Dad", age: 41 }] }
+      ] )
+      
+people.where { has(:parents).of(age: 29, name: "Mom").or(age: 33, name: "Dad") } 
+    #=>  <#People [{ name: "Reuben", parents: [...] }, { name: "Naomi", parents: [...] }]
+    
+people.where { has(:parents).of(age: 29, name: "Mom").and(age: 33, name: "Dad")
+    #=>  <#People [{ name: "Reuben", parents: [...] }>
 ```
 
 ## Development

data/active_enumerable.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.1'
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/active_enumerable.rb

@@ -1,12 +1,15 @@
 require "active_enumerable/version"
 require "active_enumerable/base"
+require "active_enumerable/record_not_found"
 require "active_enumerable/comparable"
 require "active_enumerable/enumerable"
 require "active_enumerable/finder"
 require "active_enumerable/method_caller"
+require "active_enumerable/scope_method"
 require "active_enumerable/scopes"
 require "active_enumerable/where"
 require "active_enumerable/queries"
+require "active_enumerable/english_dsl"
 
 module ActiveEnumerable
   include Base
@@ -14,6 +17,7 @@ module ActiveEnumerable
   include Comparable
   include Queries
   include Scopes
+  include EnglishDsl
 
   module ClassMethods
     include Scopes::ClassMethods

data/lib/active_enumerable/base.rb

@@ -1,10 +1,16 @@
 module ActiveEnumerable
   module Base
     def initialize(collection=[])
-      @to_a = collection.to_ary
+      if collection.is_a? ::Enumerator::Lazy
+        @collection = collection
+      else
+        @collection = collection.to_a
+      end
     end
 
-    attr_reader :to_a
+    def to_a
+      @collection.to_a
+    end
 
     # @private
     def __new_relation__(collection)
@@ -20,11 +26,15 @@ module ActiveEnumerable
     end
 
     def add(item)
-      to_a << item
+      @collection << item
     end
 
     def all
-      self
+      self.tap { to_a }
+    end
+
+    def name
+      self.class.name
     end
 
     module ClassMethods

data/lib/active_enumerable/english_dsl.rb

@@ -0,0 +1,81 @@
+module ActiveEnumerable
+  module EnglishDsl
+    include ScopeMethod
+    include Where
+
+    # @param [Hash]
+    # @yield takes block to evaluate English Dsl
+    #   <ActiveEnumerable>#where{ has(:name).of("Dustin") }
+    # @return [ActiveEnumerable]
+    def where(*args, &block)
+      if block_given?
+        scope(&block).send(:_english_eval__)
+      else
+        super
+      end
+    end
+
+    # @param [String, Symbol] attr is either a method name a Hash key.
+    #   has(:name)
+    def has(attr)
+      all_conditions << [attr]
+      self
+    end
+
+    # @param [Hash, Object] matches is list of sub conditions or associations to query.
+    #   Or this can by any value to compare the result from attr.
+    def of(matches)
+      if all_conditions.empty? || !(all_conditions.last.count == 1)
+        raise ".has(attr) must be call before calling #of."
+      else
+        all_conditions.last << matches
+        self
+      end
+    end
+
+    # After calling #of(matches) providing additional matches to #or(matches) build a either or query.
+    # @param [Hash, Object] matches is list of sub conditions or associations to query.
+    #   Or this can by any value to compare the result from attr.
+    def or(matches)
+      raise ".has(attr).of(matches) must be call before calling #or(matches)." if all_conditions.empty? || !(all_conditions.last.count == 2)
+      evaluation_results << english_where
+      all_conditions.last[1] = matches
+      evaluation_results << english_where
+      self
+    end
+
+    # @param [Hash, Object, NilClass] matches is list of sub conditions or associations to query.
+    #   Or this can by any value to compare the result from attr.
+    #   Or passing nothing and provide a different has(attr)
+    #     has(attr).of(matches).and.has(other_attr)
+    def and(matches=nil)
+      if matches
+        all_conditions.last[1].merge!(matches)
+        evaluation_results << english_where
+      end
+      self
+    end
+
+    private
+
+    def all_conditions
+      @all_conditions ||= []
+    end
+
+    def _english_eval__
+      if evaluation_results.empty?
+        english_where
+      else
+        __new_relation__ evaluation_results.flat_map(&:to_a).uniq
+      end
+    end
+
+    def english_where
+      where all_conditions.each_with_object({}) { |e, h| h[e[0]] = e[1] }
+    end
+
+    def evaluation_results
+      @evaluation_results ||= []
+    end
+  end
+end

data/lib/active_enumerable/enumerable.rb

@@ -3,7 +3,7 @@ module ActiveEnumerable
     include ::Enumerable
 
     def each(*args, &block)
-      @to_a.send(:each, *args, &block)
+      @collection.send(:each, *args, &block)
     end
   end
 end

data/lib/active_enumerable/finder.rb

@@ -1,16 +1,49 @@
 module ActiveEnumerable
-  # @private
+
   class Finder
     def initialize(record)
       @method_caller = MethodCaller.new(record)
     end
 
+    # Regex conditions
+    #   Finder.new({ name: "Timmy" }).is_of({ name: /Tim/ })
+    #     #=> true
+    #
+    # Hash conditions
+    #   record = { name: "Timmy", parents: [{ name: "Dad", age: 33 }, { name: "Mom", age: 29 }] } }
+    #
+    #   Matching array of partial hashes identities
+    #     Finder.new(record).is_of(parents: [{ name: "Dad" }, { name: "Mom" }]))
+    #       #=> true
+    #
+    #   Matching partial hashes identities to an array of hashes
+    #     Finder.new(record).is_of(parents: { name: "Dad", age: 33 })
+    #       #=> true
+    #
+    # Array conditions
+    #   record = { name: "Timmy" }
+    #
+    #   Finder.new(record).is_of(name: %w(Timmy Fred))
+    #     #=> true
+    #   Finder.new(record).is_of(name: ["Sammy", /Tim/])
+    #     #=> true
+    #
+    # Value conditions
+    #   record = { name: "Timmy", age: 10 }
+    #
+    #   Finder.new(record).is_of(name: "Timmy")
+    #     #=> true
+    #   Finder.new(record).is_of(age: 10)
+    #     #=> true
+    #
+    # @param [Hash] conditions
+    # @return [true, false]
     def is_of(conditions={})
       conditions.all? do |col, match|
         if match.is_a? Hash
           hash_match(col, match)
-        elsif match.is_a? ::Enumerable
-          any_match(col, match)
+        elsif match.is_a? Array
+          array_match(col, match)
         else
           compare(col, match)
         end
@@ -28,12 +61,24 @@ module ActiveEnumerable
       end
     end
 
-    def any_match(col, match)
-      match.any? { |m| compare(col, m) }
+    def array_match(col, match)
+      if @method_caller.call(col).is_a? Array
+        if !(r = compare(col, match)) && match.map(&:class).uniq == [Hash]
+          match.all? { |m| hash_match(col, m) }
+        else
+          r
+        end
+      else
+        match.any? { |m| compare(col, m) }
+      end
     end
 
     def compare(col, match)
-      @method_caller.call(col) == match
+      @method_caller.call(col).public_send(compare_by(match), match)
+    end
+
+    def compare_by(match)
+      (match.is_a? Regexp) ? :=~ : :==
     end
   end
 end

data/lib/active_enumerable/method_caller.rb

@@ -14,8 +14,10 @@ module ActiveEnumerable
       else
         object.public_send(method)
       end
-    rescue NoMethodError, KeyError => e
+    rescue NoMethodError => e
       raise e if raise_no_method
+    rescue KeyError => e
+      raise e, "#{e.message} for #{object}" if raise_no_method
     end
   end
 end

data/lib/active_enumerable/queries.rb

@@ -1,6 +1,5 @@
 module ActiveEnumerable
   module Queries
-    include ActiveEnumerable::Where
 
     # Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
     # If no record can be found for all of the listed ids, then RecordNotFound will be raised. If the primary key
@@ -12,13 +11,17 @@ module ActiveEnumerable
     #   <#ActiveEnumerable>.find([1])        # returns an array for the object with ID = 1
     #
     # <tt>ActiveEnumerable::RecordNotFound</tt> will be raised if one or more ids are not found.
-    def find(ids)
-      raise RecordNotFound.new("Couldn't find #{self.name} without an ID") if ids.nil?
-      results = [*ids].map do |id|
-        find_by!(id: id.to_i)
+    # @return [ActiveEnumerable, Object]
+    # @param [*Fixnum, Array<Fixnum>] args
+    def find(*args)
+      raise RecordNotFound.new("Couldn't find #{self.name} without an ID") if args.compact.empty?
+      if args.count > 1 || args.first.is_a?(Array)
+        __new_relation__(args.flatten.lazy.map do |id|
+          find_by!(id: id.to_i)
+        end)
+      else
+        find_by!(id: args.first.to_i)
       end
-      return __new_relation__(results) if ids.class == Array
-      results.first
     end
 
     # Updates all records with details given if they match a set of conditions supplied, limits and order can
@@ -74,6 +77,8 @@ module ActiveEnumerable
     # If no record is found, returns <tt>nil</tt>.
     #
     #   <#ActiveEnumerable>.find_by name: 'Spartacus', rating: 4
+    #
+    # # @see ActiveEnumerable::Finder#is_of for all usages of conditions.
     def find_by(conditions = {})
       to_a.detect do |record|
         Finder.new(record).is_of(conditions)

data/lib/active_enumerable/scope_method.rb

@@ -0,0 +1,12 @@
+module ActiveEnumerable
+  module ScopeMethod
+    def scope(&block)
+      result = instance_exec(&block)
+      if result.is_a? Array
+        __new_relation__(result)
+      else
+        result
+      end
+    end
+  end
+end

data/lib/active_enumerable/scopes.rb

@@ -1,5 +1,6 @@
 module ActiveEnumerable
   module Scopes
+    include ScopeMethod
     def method_missing(meth, *args, &block)
       if create_scope_method(meth)
         send(meth, *args, &block)
@@ -24,15 +25,6 @@ module ActiveEnumerable
       end
     end
 
-    def scope(&block)
-      result = instance_exec(&block)
-      if result.is_a? Array
-        __new_relation__(result)
-      else
-        result
-      end
-    end
-
     private :create_scope_method
 
     module ClassMethods

data/lib/active_enumerable/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnumerable
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/active_enumerable/where.rb

@@ -55,6 +55,7 @@ module ActiveEnumerable
     #
     #   <#ActiveEnumerable>.where(id: 1).or(author_id: 3)
     #
+    # @see ActiveEnumerable::Finder#is_of for all usages of conditions.
     def where(conditions=nil)
       return WhereNotChain.new(all, method(:__new_relation__)) if conditions.nil?
       enable_or create_where_relation(conditions, to_a.select do |record|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_enumerable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,11 +74,13 @@ files:
 - lib/active_enumerable.rb
 - lib/active_enumerable/base.rb
 - lib/active_enumerable/comparable.rb
+- lib/active_enumerable/english_dsl.rb
 - lib/active_enumerable/enumerable.rb
 - lib/active_enumerable/finder.rb
 - lib/active_enumerable/method_caller.rb
 - lib/active_enumerable/queries.rb
 - lib/active_enumerable/record_not_found.rb
+- lib/active_enumerable/scope_method.rb
 - lib/active_enumerable/scopes.rb
 - lib/active_enumerable/version.rb
 - lib/active_enumerable/where.rb
@@ -94,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="