active_enumerable 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f474e8fd2a0f244864a65b57e314e9a10b0a4ebf
-  data.tar.gz: 86960a5df4654c9d4301f37d9238614e1ac894d0
+  metadata.gz: db5edb0e4e9f6d7f8fd5a300614a183963166077
+  data.tar.gz: e1b94fd1c797689656ba6191fdb9de1fe8ba6bfb
 SHA512:
-  metadata.gz: 0184271b0c54d92a5d495a54a25fcbb78d9f9f68d0c51ad515f08477982ff64cedaf9fd0811c82e00976093156a5af2ef332f25c9d310550b51f87f549002a7c
-  data.tar.gz: 98a7c9613270176e506222bbfc447e3f5bbd3e45a2311d763884c956e03e584e8fef1dad54cf4e0e5ded48331836ff6ab993b2a429af59fc467a3f2419582203
+  metadata.gz: 6c7f661c81d3ad8bc7a1c8cef010cd9dffb22bb668f7244b089352e9415216372b8fa522bb5afc1032e25779b7873bb7835217c02d972566fb9e05c2702f54a0
+  data.tar.gz: 93a46896255357f33867972e7a6335285908ec7dd76383028db39caf80ef88741d7955388aa8d44cd68a60012ea7b5bb53bee0eda0401290ea723913851a2c72

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - 2.1.7
-  - 2.2.3
-  - 2.3.0
+  - 2.2.9
+  - 2.3.3
+  - 2.4.3
 before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+## 1.0.0 - 2018-01-26
+- Remove mutation methods and ensure 100% test coverage
 
 ## 0.2.0 - 2015-02-15
 ### Features

data/README.md

@@ -3,7 +3,8 @@
 [![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.
+Provides ActiveRecord like query methods for use in Ruby Enumerable collections.
+Use Hashes or custom Ruby Objects to represent records. 
 
 ## Installation
 
@@ -30,33 +31,39 @@ require "active_enumerable"
 
 class Customers
   include ActiveEnumerable
-  
+
   scope :unpaid, -> { where(paid: false).or(credit: 0) }
 end
 
 customers = Customers.new([{paid: true, credit: 1000}, {paid: false, credit: 2000}, {paid: false, credit: 0}])
 
 customers.unpaid
-  # => <#Customers [{:paid=>false, :credit=>2000}, {:paid=>false, :credit=>0}]]>
-  
-customers.scope { select { |y| y > 1000 } }
-  #=> <#Customers [{paid: true, credit: 1000}, {paid: false, credit: 2000}]>
-  
+# => <#Customers [{:paid=>false, :credit=>2000}, {:paid=>false, :credit=>0}]]>
+
+customers.scope { select { |y| y[:credit] >= 1000 } }
+#=> <#Customers [{paid: true, credit: 1000}, {paid: false, credit: 2000}]>
+
 customers.sum(:credit)
-  #=> 3000
-  
-customers.create({paid: true, credit: 1500}) # defaults to Hash creations
+#=> 3000
 
-Customers.item_class = Customer
+customers << { paid: true, credit: 1500 } # accepts Hashes
 
-customers.create({paid: true, credit: 1500}).to_a.last
-  #=> <#Customer paid: true, credit: 1500>
- 
+class Customer
+  attr_reader :paid, :credit
+  def initialize(paid:, credit:)
+    @paid  = paid
+    @credit = credit
+  end
+end
+
+customers << Customer.new(paid: true, credit: 1500) # Or Objects
 ```
 
 ### English Like DSL
 
 ```ruby
+require "active_enumerable"
+
 class People
   include ActiveEnumerable
   
@@ -64,7 +71,7 @@ class People
 end
 
 people = People.new([{ name: "Reuben" }, { name: "Naomi" }])
-people.where { has(:name).of("Reuben") } }
+people.where { has(:name).of("Reuben") }
     #=> <#People [{ name: "Reuben" }]]
     
     
@@ -75,9 +82,6 @@ people = People.new( [
       
 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
@@ -88,6 +92,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
+This is a community project and commit access will be granted to those who show interest by having a history of acceptable pull-requests.
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/zeisler/active_enumerable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 

data/active_enumerable.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Dustin Zeisler"]
   spec.email         = ["dustin@zeisler.net"]
 
-  spec.summary       = %q{Gives ActiveRecord like querying methods to ruby enumerable objects.}
-  spec.description   = %q{Gives ActiveRecord like querying methods to ruby enumerable objects.}
+  spec.summary       = %q{Provides ActiveRecord like query methods for use in Ruby Enumerable collections.}
+  spec.description   = %q{Provides ActiveRecord like query methods for use in Ruby Enumerable collections. Use Hashes or custom Ruby Objects to represent records.}
   spec.homepage      = "https://github.com/zeisler/active_enumerable"
   spec.license       = "MIT"
 
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.15.1"
 end

data/lib/active_enumerable.rb

@@ -2,7 +2,6 @@ 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"
@@ -19,11 +18,7 @@ module ActiveEnumerable
   include Scopes
   include EnglishDsl
 
-  module ClassMethods
-    include Scopes::ClassMethods
-  end
-
   def self.included(base)
-    base.extend(ClassMethods)
+    base.extend(Scopes::ClassMethods)
   end
 end

data/lib/active_enumerable/base.rb

@@ -1,6 +1,16 @@
 module ActiveEnumerable
   module Base
+    include ::Enumerable
+
+    def each(*args, &block)
+      @collection.send(:each, *args, &block)
+    end
+
     def initialize(collection=[])
+      active_enumerable_setup(collection)
+    end
+
+    def active_enumerable_setup(collection=[])
       if collection.is_a? ::Enumerator::Lazy
         @collection = collection
       else
@@ -12,23 +22,12 @@ module ActiveEnumerable
       @collection.to_a
     end
 
-    # @private
-    def __new_relation__(collection)
-      self.class.new(collection)
-    end
-
-    def create(attributes)
-      add(if (klass = self.class.item_class)
-            klass.new(attributes)
-          else
-            attributes
-          end)
-    end
-
-    def add(item)
+    def <<(item)
       @collection << item
     end
 
+    alias_method :add, :<<
+
     def all
       self.tap { to_a }
     end
@@ -37,18 +36,9 @@ module ActiveEnumerable
       self.class.name
     end
 
-    module ClassMethods
-      def item_class
-        @item_class
-      end
-
-      def item_class=(klass)
-        @item_class = klass
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
+    # @private
+    def __new_relation__(collection)
+      self.class.new(collection)
     end
   end
 end

data/lib/active_enumerable/english_dsl.rb

@@ -3,6 +3,8 @@ module ActiveEnumerable
     include ScopeMethod
     include Where
 
+    UnmetCondition = Class.new(StandardError)
+
     # @param [Hash]
     # @yield takes block to evaluate English Dsl
     #   <ActiveEnumerable>#where{ has(:name).of("Dustin") }
@@ -26,7 +28,7 @@ module ActiveEnumerable
     #   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."
+        raise UnmetCondition, ".has(attr) must be call before calling #of."
       else
         all_conditions.last << matches
         self
@@ -37,7 +39,7 @@ module ActiveEnumerable
     # @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)
+      raise UnmetCondition, ".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

data/lib/active_enumerable/extract_options.rb

@@ -0,0 +1,29 @@
+class Hash
+  # By default, only instances of Hash itself are extractable.
+  # Subclasses of Hash may implement this method and return
+  # true to declare themselves as extractable. If a Hash
+  # is extractable, Array#extract_options! pops it from
+  # the Array when it is the last element of the Array.
+  def extractable_options?
+    instance_of?(Hash)
+  end
+end unless Hash.respond_to?(:extractable_options?)
+
+class Array
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)        # => {}
+  #   options(1, 2, a: :b) # => {:a=>:b}
+  def extract_options!
+    if last.is_a?(Hash) && last.extractable_options?
+      pop
+    else
+      {}
+    end
+  end
+end unless Array.respond_to?(:extract_options!)

data/lib/active_enumerable/order.rb

@@ -0,0 +1,48 @@
+require "active_enumerable/extract_options"
+
+module ActiveEnumerable
+  # @private
+  module Order
+    class << self
+      def call(args, all)
+        options = args.extract_options!
+        if options.empty? && args.count == 1
+          all.sort_by { |item| MethodCaller.new(item).call(args.first) }
+        else
+          order_mixed_args(all, args, options)
+        end
+      end
+
+      private
+
+      def order_mixed_args(all, args, options)
+        normalized_opt = args.each_with_object({}) { |a, h| h[a] = :asc }.merge(options) # Add non specified direction keys
+        all.sort { |a, b| build_order(a, normalized_opt) <=> build_order(b, normalized_opt) }
+      end
+
+      def build_order(a, options)
+        options.map { |k, v| send(v, MethodCaller.new(a).call(k)) }
+      end
+
+      def desc(r)
+        DESC.new(r)
+      end
+
+      def asc(r)
+        r
+      end
+    end
+
+    class DESC
+      attr_reader :r
+
+      def initialize(r)
+        @r = r
+      end
+
+      def <=>(other)
+        -(r <=> other.r) # Flip negative/positive result
+      end
+    end
+  end
+end

data/lib/active_enumerable/queries.rb

@@ -1,7 +1,10 @@
+require "active_enumerable/order"
+require "bigdecimal"
+
 module ActiveEnumerable
   module Queries
-
-    # 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]).
+    # Find by id - Depends on either having an Object#id or Hash{id: Integer}
+    # 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
     # is an integer, find by id coerces its arguments using +to_i+.
     #
@@ -14,7 +17,7 @@ module ActiveEnumerable
     # @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?
+      raise RecordNotFound.new("Couldn't find #{self.respond_to?(:name) ? self.name : self.class.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)
@@ -24,52 +27,6 @@ module ActiveEnumerable
       end
     end
 
-    # Updates all records with details given if they match a set of conditions supplied, limits and order can
-    # also be supplied.
-    #
-    # ==== Parameters
-    #
-    # * +updates+ - A string, array, or hash.
-    #
-    # ==== Examples
-    #
-    #   # Update all customers with the given attributes
-    #   <#ActiveEnumerable>.update_all wants_email: true
-    #
-    #   # Update all books with 'Rails' in their title
-    #   <#ActiveEnumerable>.where(title: 'Rails').update_all(author: 'David')
-    #
-    #   # Update all books that match conditions, but limit it to 5 ordered by date
-    #   <#ActiveEnumerable>.where(title: 'Rails').order(:created_at).limit(5).update_all(author: 'David')
-    def update_all(attributes)
-      all.each { |i| i.update(attributes) }
-    end
-
-    # Updates an object (or multiple objects) and saves it.
-    #
-    # ==== Parameters
-    #
-    # * +id+ - This should be the id or an array of ids to be updated.
-    # * +attributes+ - This should be a hash of attributes or an array of hashes.
-    #
-    # ==== Examples
-    #
-    #   # Updates one record
-    #   <#ActiveEnumerable>.update(15, user_name: 'Samuel', group: 'expert')
-    #
-    #   # Updates multiple records
-    #   people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
-    #   <#ActiveEnumerable>.update(people.keys, people.values)
-    def update(id, attributes)
-      if id.is_a?(Array)
-        id.map.with_index { |one_id, idx| update(one_id, attributes[idx]) }
-      else
-        object = find(id)
-        object.update(attributes)
-        object
-      end
-    end
-
     # Finds the first record matching the specified conditions. There
     # is no implied ordering so if order matters, you should specify it
     # yourself.
@@ -95,39 +52,6 @@ module ActiveEnumerable
       result
     end
 
-    # Finds the first record with the given attributes, or creates a record
-    # with the attributes if one is not found:
-    #
-    #   # Find the first user named "Penélope" or create a new one.
-    #   <#ActiveEnumerable>.find_or_create_by(first_name: 'Penélope')
-    #   # => #<User id: 1, first_name: "Penélope", last_name: nil>
-    #
-    #   # Find the first user named "Penélope" or create a new one.
-    #   # We already have one so the existing record will be returned.
-    #   <#ActiveEnumerable>.find_or_create_by(first_name: 'Penélope')
-    #   # => #<User id: 1, first_name: "Penélope", last_name: nil>
-    #
-    # This method accepts a block, which is passed down to +create+. The last example
-    # above can be alternatively written this way:
-    #
-    #   # Find the first user named "Scarlett" or create a new one with a
-    #   # different last name.
-    #   <#ActiveEnumerable>.find_or_create_by(first_name: 'Scarlett') do |user|
-    #     user.last_name = 'Johansson'
-    #   end
-    #   # => #<User id: 2, first_name: "Scarlett", last_name: "Johansson">
-    #
-    def find_or_create_by(attributes, &block)
-      find_by(attributes) || create(attributes, &block)
-    end
-
-    alias_method :find_or_create_by!, :find_or_create_by
-
-    # Like <tt>find_or_create_by</tt>, but calls <tt>new</tt> instead of <tt>create</tt>.
-    def find_or_initialize_by(attributes, &block)
-      find_by(attributes) || new(attributes, &block)
-    end
-
     # Count the records.
     #
     #   <#ActiveEnumerable>.count
@@ -136,17 +60,15 @@ module ActiveEnumerable
     #   <#ActiveEnumerable>.count(:age)
     #   # => returns the total count of all people whose age is not nil
     def count(name = nil)
-      return all.size if name.nil?
-      where.not(name => nil).size
+      return to_a.size if name.nil?
+      to_a.reject { |record| Finder.new(record).is_of(name: nil) }.size
     end
 
     # Specifies a limit for the number of records to retrieve.
     #
     #   <#ActiveEnumerable>.limit(10)
     def limit(num)
-      relation = __new_relation__(all.take(num))
-      relation.send(:set_from_limit)
-      relation
+      __new_relation__(all.take(num))
     end
 
     # Calculates the sum of values on a given attribute. The value is returned
@@ -167,11 +89,12 @@ module ActiveEnumerable
     def average(key)
       values = values_by_key(key)
       total  = values.inject { |sum, n| sum + n }
+      return unless total
       BigDecimal.new(total) / BigDecimal.new(values.count)
     end
 
-    # Calculates the minimum value on a given attribute. The value is returned
-    # with the same data type of the attribute, or +nil+ if there's no row.
+    # Calculates the minimum value on a given attribute. Returns +nil+ if there's
+    # no row.
     #
     #   <#ActiveEnumerable>.minimum(:age) # => 7
     def minimum(key)
@@ -191,10 +114,15 @@ module ActiveEnumerable
     #   <#ActiveEnumerable>.order('name')
     #
     #   <#ActiveEnumerable>.order(:name)
-    def order(key)
-      __new_relation__(all.sort_by { |item| MethodCaller.new(item).call(key) })
+    #
+    #   <#ActiveEnumerable>.order(email: :desc)
+    #
+    #   <#ActiveEnumerable>.order(:name, email: :desc)
+    def order(*args)
+      __new_relation__(Order.call(args, all))
     end
 
+
     # Reverse the existing order clause on the relation.
     #
     #   <#ActiveEnumerable>.order('name').reverse_order
@@ -233,7 +161,7 @@ module ActiveEnumerable
     private
 
     def values_by_key(key)
-      all.map { |obj| obj.send(key) }
+      all.map { |obj| MethodCaller.new(obj).call(key)  }
     end
   end
 end

data/lib/active_enumerable/scopes.rb

@@ -9,12 +9,8 @@ module ActiveEnumerable
       end
     end
 
-    def respond_to_missing?(meth, include_private = false)
-      if create_scope_method(meth)
-        true
-      else
-        super
-      end
+    def respond_to_missing?(meth, _include_private = false)
+      create_scope_method(meth)
     end
 
     def create_scope_method(meth)

data/lib/active_enumerable/version.rb

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

data/lib/active_enumerable/where.rb

@@ -1,3 +1,5 @@
+require "active_enumerable/finder"
+
 module ActiveEnumerable
   module Where
     class WhereNotChain

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_enumerable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Gives ActiveRecord like querying methods to ruby enumerable objects.
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: Provides ActiveRecord like query methods for use in Ruby Enumerable collections.
+  Use Hashes or custom Ruby Objects to represent records.
 email:
 - dustin@zeisler.net
 executables: []
@@ -75,9 +90,10 @@ files:
 - lib/active_enumerable/base.rb
 - lib/active_enumerable/comparable.rb
 - lib/active_enumerable/english_dsl.rb
-- lib/active_enumerable/enumerable.rb
+- lib/active_enumerable/extract_options.rb
 - lib/active_enumerable/finder.rb
 - lib/active_enumerable/method_caller.rb
+- lib/active_enumerable/order.rb
 - lib/active_enumerable/queries.rb
 - lib/active_enumerable/record_not_found.rb
 - lib/active_enumerable/scope_method.rb
@@ -104,8 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Gives ActiveRecord like querying methods to ruby enumerable objects.
+summary: Provides ActiveRecord like query methods for use in Ruby Enumerable collections.
 test_files: []

data/lib/active_enumerable/enumerable.rb

@@ -1,9 +0,0 @@
-module ActiveEnumerable
-  module Enumerable
-    include ::Enumerable
-
-    def each(*args, &block)
-      @collection.send(:each, *args, &block)
-    end
-  end
-end