active_hash 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495ecea300cebeef38e96068866a539533b308e1799937aa9efdb8786e66eaf3
-  data.tar.gz: a149a1dc1d69ef1f416393384c7a2d8b7adbae874ca26d3f23b4c219d0df5514
+  metadata.gz: b300c0554a72d04ab10205af37b7f3e89dbbedca23b9c5185cc4ad0aac4e761b
+  data.tar.gz: 3aca6e2f970fa2362a127cafd0b88eb5df716daace9281355b5f5966981f9d1d
 SHA512:
-  metadata.gz: 3206ab8403d58c5578fc5b4238a3834ea3fee6fe462618651d7e5377138855df959dec91df632c2882d00bd41b107ab9c46821f6724201cfc9547e0621d6d5bb
-  data.tar.gz: ce189a601b0800ead8e4e0586b72c008272fca5c55bd7da8bac536f28804fd9cb832550bd20a186095070b4fcb5401cdbe691408087ad5b32d1a23406e189fcf
+  metadata.gz: 02ab457c893ee5388d9668221b84725a1b83b1f2057a17cba98962973b3c2ab902cc9b17ad62b4fb1d4367d9fb40c13fe9d9b70caa76bdb76bf59f287f3b4b5f
+  data.tar.gz: d7176902700dbb797afac5ea08978b774df1428cfaab593e8895a70897cf9d9eaa39f468cc0829e0dc6aa8a687d209106e4ce6c0dd0b0df505aa3a54971f0fb8

data/CHANGELOG

@@ -1,3 +1,9 @@
+2020-01-15 (v3.1.0)
+  - Add ActiveHash::Base.order method inspired by ActiveRecord [#177](https://github.com/zilkey/active_hash/pull/177)
+  - Add #to_ary to ActiveHash::Relation [#182](https://github.com/zilkey/active_hash/pull/182)
+  - Allow #find to behave like Enumerable#find if id is nil and a block is given [#183](https://github.com/zilkey/active_hash/pull/183)
+  - Delegate :sample to `records` [#189](https://github.com/zilkey/active_hash/pull/189)
+
 2019-09-28 (v3.0.0)
   - Make #where chainable [#178](https://github.com/zilkey/active_hash/pull/178)
 

data/README.md

@@ -131,7 +131,7 @@ NOTE: auto-defined fields will _not_ override fields you've defined, either on t
 If some of your hash values contain nil, and you want to provide a default, you can specify defaults with the :field method:
 ```ruby
 class Country < ActiveHash::Base
-  field   :is_axis_of_evil, :default => false
+  field :is_axis_of_evil, :default => false
 end
 ```
 ## Defining Data
@@ -164,11 +164,13 @@ Country.find 1                 # => returns the first country object with that i
 Country.find [1,2]             # => returns all Country objects with ids in the array
 Country.find :all              # => same as .all
 Country.find :all, args        # => the second argument is totally ignored, but allows it to play nicely with AR
+Country.find { |country| country.name.start_with?('U') } # => returns the first country for which the block evaluates to true
 Country.find_by_id 1           # => find the first object that matches the id
 Country.find_by(name: 'US')    # => returns the first country object with specified argument
 Country.find_by!(name: 'US')   # => same as find_by, but raise exception when not found
 Country.where(name: 'US')      # => returns all records with name: 'US'
 Country.where.not(name: 'US')  # => returns all records without name: 'US'
+Country.order(name: :desc)     # => returns all records ordered by name attribute in DESC order
 ```
 It also gives you a few dynamic finder methods.  For example, if you defined :name as a field, you'd get:
 ```ruby
@@ -206,16 +208,24 @@ Country#name=       # => sets the name
 ```
 ## Saving in-memory records
 
-The ActiveHash::Base.all method functions like an in-memory data store.  You can save your records to the the .all array by using standard ActiveRecord create and save methods:
+The ActiveHash::Base.all method functions like an in-memory data store. You can save your records as ActiveHash::Relation object by using standard ActiveRecord create and save methods:
 ```ruby
-Country.all             # => []
+Country.all
+=> #<ActiveHash::Relation:0x00007f861e043bb0 @klass=Country, @all_records=[], @query_hash={}, @records_dirty=false>
 Country.create
-Country.all             # [ <Country :id => 1> ]
+=> #<Country:0x00007f861b7abce8 @attributes={:id=>1}>
+Country.all
+=> #<ActiveHash::Relation:0x00007f861b7b3628 @klass=Country, @all_records=[#<Country:0x00007f861b7abce8 @attributes={:id=>1}>], @query_hash={}, @records_dirty=false>
 country = Country.new
-country.new_record?     # => true
+=> #<Country:0x00007f861e059938 @attributes={}>
+country.new_record?
+=> true
 country.save
-country.new_record?     # => false
-Country.all             # [ <Country :id => 1>, <Country :id => 2>  ]
+=> true
+country.new_record?
+# => false
+Country.all
+=> #<ActiveHash::Relation:0x00007f861e0ca610 @klass=Country, @all_records=[#<Country:0x00007f861b7abce8 @attributes={:id=>1}>, #<Country:0x00007f861e059938 @attributes={:id=>2}>], @query_hash={}, @records_dirty=false>
 ```
 Notice that when adding records to the collection, it will auto-increment the id for you by default.  If you use string ids, it will not auto-increment the id.  Available methods are:
 ```

data/lib/active_hash/base.rb

@@ -188,7 +188,7 @@ module ActiveHash
         ActiveHash::Relation.new(self, @records || [], options[:conditions] || {})
       end
 
-      delegate :where, :find, :find_by, :find_by!, :find_by_id, :count, :pluck, :first, :last, to: :all
+      delegate :where, :find, :find_by, :find_by!, :find_by_id, :count, :pluck, :first, :last, :order, to: :all
 
       def transaction
         yield

data/lib/active_hash/relation.rb

@@ -3,8 +3,9 @@ module ActiveHash
     include Enumerable
     
     delegate :each, to: :records # Make Enumerable work
-    delegate :equal?, :==, :===, :eql?, to: :records
+    delegate :equal?, :==, :===, :eql?, :sort!, to: :records
     delegate :empty?, :length, :first, :second, :third, :last, to: :records
+    delegate :sample, to: :records
         
     def initialize(klass, all_records, query_hash = nil)
       self.klass = klass
@@ -38,7 +39,7 @@ module ActiveHash
       find_by(options) || (raise RecordNotFound.new("Couldn't find #{klass.name}"))
     end
     
-    def find(id, *args)
+    def find(id = nil, *args, &block)
       case id
         when :all
           all
@@ -47,7 +48,8 @@ module ActiveHash
         when Array
           id.map { |i| find(i) }
         when nil
-          raise RecordNotFound.new("Couldn't find #{klass.name} without an ID")
+          raise RecordNotFound.new("Couldn't find #{klass.name} without an ID") unless block_given?
+          records.find(&block) # delegate to Enumerable#find if a block is given
         else
           find_by_id(id) || begin
             raise RecordNotFound.new("Couldn't find #{klass.name} with ID=#{id}")
@@ -71,7 +73,25 @@ module ActiveHash
     def reload
       @records = filter_all_records_by_query_hash
     end
+
+    def order(*options)
+      check_if_method_has_arguments!(:order, options)
+      relation = where({})
+      return relation if options.blank?
+
+      processed_args = preprocess_order_args(options)
+      candidates = relation.dup
+
+      order_by_args!(candidates, processed_args)
+
+      candidates
+    end
     
+    def to_ary
+      records.dup
+    end
+    
+
     attr_reader :query_hash, :klass, :all_records, :records_dirty
     
     private
@@ -124,5 +144,40 @@ module ActiveHash
       e = records.last[:id]
       (range.begin..e).to_a
     end
+
+    def check_if_method_has_arguments!(method_name, args)
+      return unless args.blank?
+
+      raise ArgumentError,
+            "The method .#{method_name}() must contain arguments."
+    end
+
+    def preprocess_order_args(order_args)
+      order_args.reject!(&:blank?)
+      return order_args.reverse! unless order_args.first.is_a?(String)
+
+      ary = order_args.first.split(', ')
+      ary.map! { |e| e.split(/\W+/) }.reverse!
+    end
+
+    def order_by_args!(candidates, args)
+      args.each do |arg|
+        field, dir = if arg.is_a?(Hash)
+                       arg.to_a.flatten.map(&:to_sym)
+                     elsif arg.is_a?(Array)
+                       arg.map(&:to_sym)
+                     else
+                       arg.to_sym
+                     end
+
+        candidates.sort! do |a, b|
+          if dir.present? && dir.to_sym.upcase.equal?(:DESC)
+            b[field] <=> a[field]
+          else
+            a[field] <=> b[field]
+          end
+        end
+      end
+    end
   end
 end

data/lib/active_hash/version.rb

@@ -1,5 +1,5 @@
 module ActiveHash
   module Gem
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_hash
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jeff Dean
@@ -29,7 +29,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport