active_hash 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84505bccf077a25c58e6e57c7fe5ed5e626a0990bf7018711936d4d40374d8a
-  data.tar.gz: c4da9c5f5c3af7b5eb55747a91ee292052cef9cb7cfb134337a91d901534dceb
+  metadata.gz: 495ecea300cebeef38e96068866a539533b308e1799937aa9efdb8786e66eaf3
+  data.tar.gz: a149a1dc1d69ef1f416393384c7a2d8b7adbae874ca26d3f23b4c219d0df5514
 SHA512:
-  metadata.gz: b03cc2c6bf1826e6e95a4277434127bed837808bcfdf1f82bbd8ad888b05f9d11e248eff8577cd0e9d51c6d2ace1d1e7688be1ddf3e09dcb38bc161b622c81a8
-  data.tar.gz: fe93b20edaa8152c0448ce071c9d782edb3ded08b716708309678aba1a33b513c9bb9505693a9751a7497e3cd08f44fb18ec3f314c1d040a2b08262479eb1748
+  metadata.gz: 3206ab8403d58c5578fc5b4238a3834ea3fee6fe462618651d7e5377138855df959dec91df632c2882d00bd41b107ab9c46821f6724201cfc9547e0621d6d5bb
+  data.tar.gz: ce189a601b0800ead8e4e0586b72c008272fca5c55bd7da8bac536f28804fd9cb832550bd20a186095070b4fcb5401cdbe691408087ad5b32d1a23406e189fcf

data/CHANGELOG

@@ -1,3 +1,6 @@
+2019-09-28 (v3.0.0)
+  - Make #where chainable [#178](https://github.com/zilkey/active_hash/pull/178)
+
 2019-09-28 (v2.3.0)
   - Add ::scope method (inspired by ActiveRecord) [#173](https://github.com/zilkey/active_hash/pull/173)
   - Let `.find(nil)` raise ActiveHash::RecordNotFound (inspired by ActiveRecord) [#174](https://github.com/zilkey/active_hash/pull/174)

data/README.md

@@ -15,6 +15,14 @@ ActiveHash also ships with:
   * ActiveFile: a base class that you can use to create file data sources
   * ActiveYaml: a base class that will turn YAML into a hash and load the data into an ActiveHash object
 
+## !!! Important notice !!!
+We have changed returned value to chainable by v3.0.0. It's not just an `Array` instance anymore.
+If it breaks your application, please report us on [issues](https://github.com/zilkey/active_hash/issues), and use v2.x.x as following..
+
+```ruby
+gem 'active_hash', '~> 2.3.0'
+```
+
 ## Installation
 
 Bundler:

data/active_hash.gemspec

@@ -45,5 +45,6 @@ Gem::Specification.new do |s|
   ].flatten
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.add_runtime_dependency('activesupport', '>= 5.0.0')
+  s.add_development_dependency "pry"
   s.required_ruby_version = '>= 2.4.0'
 end

data/lib/active_hash.rb

@@ -12,6 +12,7 @@ rescue LoadError
 end
 
 require 'active_hash/base'
+require 'active_hash/relation'
 require 'active_file/multiple_files'
 require 'active_file/hash_and_array_files'
 require 'active_file/base'

data/lib/active_hash/base.rb

@@ -23,7 +23,7 @@ module ActiveHash
       end
 
       def not(options)
-        return @records if options.blank?
+        return @scope if options.blank?
 
         # use index if searching by id
         if options.key?(:id) || options.key?("id")
@@ -32,9 +32,11 @@ module ActiveHash
         end
         return candidates if options.blank?
 
-        (candidates || @records || []).reject do |record|
+        filtered_records = (candidates || @records || []).reject do |record|
           match_options?(record, options)
         end
+        
+        ActiveHash::Relation.new(@scope.klass, filtered_records, {})
       end
 
       def match_options?(record, options)
@@ -182,76 +184,11 @@ module ActiveHash
         record
       end
 
-      def all(options={})
-        if options.has_key?(:conditions)
-          where(options[:conditions])
-        else
-          @records ||= []
-        end
-      end
-
-      def where(options = :chain)
-        if options == :chain
-          return WhereChain.new(self)
-        elsif options.blank?
-          return @records
-        end
-
-        # use index if searching by id
-        if options.key?(:id) || options.key?("id")
-          ids = (options.delete(:id) || options.delete("id"))
-          ids = range_to_array(ids) if ids.is_a?(Range)
-          candidates = Array.wrap(ids).map { |id| find_by_id(id) }.compact
-        end
-        return candidates if options.blank?
-
-        (candidates || @records || []).select do |record|
-          match_options?(record, options)
-        end
-      end
-
-      def find_by(options)
-        where(options).first
+      def all(options = {})
+        ActiveHash::Relation.new(self, @records || [], options[:conditions] || {})
       end
 
-      def find_by!(options)
-        find_by(options) || (raise RecordNotFound.new("Couldn't find #{name}"))
-      end
-
-      def match_options?(record, options)
-        options.all? do |col, match|
-          if match.kind_of?(Array)
-            match.any? { |v| normalize(v) == normalize(record[col]) }
-          else
-            normalize(record[col]) == normalize(match)
-          end
-        end
-      end
-
-      private :match_options?
-
-      def normalize(v)
-        v.respond_to?(:to_sym) ? v.to_sym : v
-      end
-
-      private :normalize
-
-      def range_to_array(range)
-        return range.to_a unless range.end.nil?
-
-        e = data.last[:id]
-        (range.begin..e).to_a
-      end
-
-      private :range_to_array
-
-      def count
-        all.length
-      end
-
-      def pluck(*column_names)
-        column_names.map { |column_name| all.map(&column_name.to_sym) }.inject(&:zip)
-      end
+      delegate :where, :find, :find_by, :find_by!, :find_by_id, :count, :pluck, :first, :last, to: :all
 
       def transaction
         yield
@@ -269,30 +206,6 @@ module ActiveHash
         @records = []
       end
 
-      def find(id, * args)
-        case id
-          when :all
-            all
-          when :first
-            all(*args).first
-          when Array
-            id.map { |i| find(i) }
-          when nil
-            raise RecordNotFound.new("Couldn't find #{name} without an ID")
-          else
-            find_by_id(id) || begin
-              raise RecordNotFound.new("Couldn't find #{name} with ID=#{id}")
-            end
-        end
-      end
-
-      def find_by_id(id)
-        index = record_index[id.to_s]
-        index and @records[index]
-      end
-
-      delegate :first, :last, :to => :all
-
       def fields(*args)
         options = args.extract_options!
         args.each do |field|

data/lib/active_hash/relation.rb

@@ -0,0 +1,128 @@
+module ActiveHash
+  class Relation
+    include Enumerable
+    
+    delegate :each, to: :records # Make Enumerable work
+    delegate :equal?, :==, :===, :eql?, to: :records
+    delegate :empty?, :length, :first, :second, :third, :last, to: :records
+        
+    def initialize(klass, all_records, query_hash = nil)
+      self.klass = klass
+      self.all_records = all_records
+      self.query_hash = query_hash
+      self.records_dirty = false
+      self
+    end
+    
+    def where(query_hash = :chain)
+      return ActiveHash::Base::WhereChain.new(self) if query_hash == :chain
+      
+      self.records_dirty = true unless query_hash.nil? || query_hash.keys.empty?
+      self.query_hash.merge!(query_hash || {})
+      self
+    end
+    
+    def all(options = {})
+      if options.has_key?(:conditions)
+        where(options[:conditions])
+      else
+        where({})
+      end
+    end
+    
+    def find_by(options)
+      where(options).first
+    end
+
+    def find_by!(options)
+      find_by(options) || (raise RecordNotFound.new("Couldn't find #{klass.name}"))
+    end
+    
+    def find(id, *args)
+      case id
+        when :all
+          all
+        when :first
+          all(*args).first
+        when Array
+          id.map { |i| find(i) }
+        when nil
+          raise RecordNotFound.new("Couldn't find #{klass.name} without an ID")
+        else
+          find_by_id(id) || begin
+            raise RecordNotFound.new("Couldn't find #{klass.name} with ID=#{id}")
+          end
+      end
+    end
+    
+    def find_by_id(id)
+      index = klass.send(:record_index)[id.to_s] # TODO: Make index in Base publicly readable instead of using send?
+      index and records[index]
+    end
+    
+    def count
+      length
+    end
+    
+    def pluck(*column_names)
+      column_names.map { |column_name| all.map(&column_name.to_sym) }.inject(&:zip)
+    end
+    
+    def reload
+      @records = filter_all_records_by_query_hash
+    end
+    
+    attr_reader :query_hash, :klass, :all_records, :records_dirty
+    
+    private
+    
+    attr_writer :query_hash, :klass, :all_records, :records_dirty
+    
+    def records
+      if @records.nil? || records_dirty
+        reload
+      else
+        @records
+      end
+    end
+    
+    def filter_all_records_by_query_hash
+      self.records_dirty = false
+      return all_records if query_hash.blank?
+      
+      # use index if searching by id
+      if query_hash.key?(:id) || query_hash.key?("id")
+        ids = (query_hash.delete(:id) || query_hash.delete("id"))
+        ids = range_to_array(ids) if ids.is_a?(Range)
+        candidates = Array.wrap(ids).map { |id| klass.find_by_id(id) }.compact
+      end
+      
+      return candidates if query_hash.blank?
+
+      (candidates || all_records || []).select do |record|
+        match_options?(record, query_hash)
+      end
+    end
+    
+    def match_options?(record, options)
+      options.all? do |col, match|
+        if match.kind_of?(Array)
+          match.any? { |v| normalize(v) == normalize(record[col]) }
+        else
+          normalize(record[col]) == normalize(match)
+        end
+      end
+    end
+
+    def normalize(v)
+      v.respond_to?(:to_sym) ? v.to_sym : v
+    end
+    
+    def range_to_array(range)
+      return range.to_a unless range.end.nil?
+
+      e = records.last[:id]
+      (range.begin..e).to_a
+    end
+  end
+end

data/lib/active_hash/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_hash
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeff Dean
@@ -45,6 +45,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Includes the ability to specify data using hashes, yml files or JSON
   files
 email: jeff@zilkey.com
@@ -61,6 +75,7 @@ files:
 - lib/active_file/multiple_files.rb
 - lib/active_hash.rb
 - lib/active_hash/base.rb
+- lib/active_hash/relation.rb
 - lib/active_hash/version.rb
 - lib/active_json/base.rb
 - lib/active_yaml/aliases.rb