activemodel-datastore 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 43c4bfc5e295411cd88d6bdff0897e564dea9e23
-  data.tar.gz: 4ed3b3a28213026e2c99cb0f616372c82958d78f
+SHA256:
+  metadata.gz: c8befe5fdd25af32f0024fe2b4c2ce59c15bd153af554bf2941e7cabc2724e84
+  data.tar.gz: d189bd5a085a3fb18de7afff018f7a9db64ed6122aeb38ab120f272cc49ec6c7
 SHA512:
-  metadata.gz: ebe8bb990217d55648209e66be3114176d83e85c81fdecf3f4b1396346f1b063cb823e8aed2e7599e9568e1bd0c92bb4e5ae0dd7c2801a8114eeaf6513e41fb1
-  data.tar.gz: 6b623ad9ccc3094e96b19969df904e844c4659f9b7dbbabebfd97ae6c8e98311c437c9b3ee4cbdaa2b6733ff2ceb085b0d242baf0be8e5a67802dea83d5043dd
+  metadata.gz: ca3683674b1066054f609751dc89f55b500c50b3aae1a84c1b49026bdfb169e0002a62a3cfa101f1c97e78231297ecba4ccf0bc940c192d421a1fb185d39372f
+  data.tar.gz: f9b0e617008082832350f11dffa172b6861a2ff586a1ef4c0a638c2187a5f9a3e98088c596b40fc098ecf3d7df4a0dddf142b59876d6b3a1a6fbb34eb5705b10

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 0.5.0 / 2020-08-17
+* adding support Google::Cloud::Datastore 2.0.0 (rewritten low-level client, with improved performance and stability).
+
+### 0.4.0 / 2019-08-23
+* adding support for Rails 6
+
+### 0.3.0 / 2018-04-17
+* adding Travis CI configuration (rud)
+* no longer override connection related environment variables if already defined(shao1555)
+* adding support for passing query an array of select properties
+
+### 0.2.5 / 2017-11-06
+* adding support for setting indexed false on individual entity properties
+* updating example Cloud Datastore Rails app to 5.1.4
+* retry on exceptions are now specific to Google::Cloud::Error
+
+### 0.2.4 / 2017-10-31
+* non-Rails projects now source client authentication settings automatically (rjmooney)
+* documentation improvements
+
 ### 0.2.3 / 2017-05-24
 * adding CarrierWave file upload support
 * updating example Cloud Datastore Rails app to 5.1

data/README.md

@@ -13,6 +13,7 @@ automatically scales to handle your applications' load. Cloud Datastore is a sch
 suited for unstructured or semi-structured application data.
 
 [![Gem Version](https://badge.fury.io/rb/activemodel-datastore.svg)](https://badge.fury.io/rb/activemodel-datastore)
+[![Build Status](https://travis-ci.org/Agrimatics/activemodel-datastore.svg?branch=master)](https://travis-ci.org/Agrimatics/activemodel-datastore)
  
 ## Table of contents
  
@@ -126,8 +127,8 @@ end
 ```
 
 Callbacks work as you would expect. We have also added the ability to set default values through 
-[`default_property_value`](http://www.rubydoc.info/gems/activemodel-datastore/ActiveModel%2FDatastore:default_property_value) 
-and type cast the format of values through [`format_property_value`](http://www.rubydoc.info/gems/activemodel-datastore/ActiveModel%2FDatastore:format_property_value):
+[`default_property_value`](http://www.rubydoc.info/gems/activemodel-datastore/ActiveModel/Datastore/PropertyValues#default_property_value-instance_method) 
+and type cast the format of values through [`format_property_value`](http://www.rubydoc.info/gems/activemodel-datastore/ActiveModel/Datastore/PropertyValues#format_property_value-instance_method):
 
 ```ruby
 class User
@@ -254,6 +255,7 @@ users, cursor = User.all(limit: 7)
 # @option options [String] :order Sort the results by property name.
 # @option options [String] :desc_order Sort the results by descending property name.
 # @option options [Array] :select Retrieve only select properties from the matched entities.
+# @option options [Array] :distinct_on Group results by a list of properties.
 # @option options [Array] :where Adds a property filter of arrays in the format[name, operator, value].
 ```
 

data/lib/active_model/datastore.rb

@@ -114,6 +114,7 @@ module ActiveModel::Datastore
   include ActiveModel::Dirty
   include ActiveModel::Validations
   include ActiveModel::Validations::Callbacks
+  include ActiveModel::Datastore::ExcludedIndexes
   include ActiveModel::Datastore::NestedAttr
   include ActiveModel::Datastore::PropertyValues
   include ActiveModel::Datastore::TrackChanges
@@ -153,12 +154,14 @@ module ActiveModel::Datastore
     entity = CloudDatastore.dataset.entity self.class.name, id
     if parent.present?
       raise ArgumentError, 'Must be a Key' unless parent.is_a? Google::Cloud::Datastore::Key
+
       entity.key.parent = parent
     elsif parent?
       entity.key.parent = self.class.parent_key(parent_key_id)
     end
     entity_properties.each do |attr|
       entity[attr] = instance_variable_get("@#{attr}")
+      entity.exclude_from_indexes!(attr, true) if no_index_attributes.include? attr
     end
     entity
   end
@@ -168,7 +171,7 @@ module ActiveModel::Datastore
   end
 
   ##
-  # For compatibility with libraries that require the bang method version (example, factory_girl).
+  # For compatibility with libraries that require the bang method version (example, factory_bot).
   #
   def save!
     save_entity || raise(EntityNotSavedError, 'Failed to save the entity')
@@ -177,6 +180,7 @@ module ActiveModel::Datastore
   def update(params)
     assign_attributes(params)
     return unless valid?
+
     run_callbacks :update do
       entity = build_entity
       self.class.retry_on_exception? { CloudDatastore.dataset.save entity }
@@ -195,6 +199,7 @@ module ActiveModel::Datastore
 
   def save_entity(parent = nil)
     return unless valid?
+
     run_callbacks :save do
       entity = build_entity(parent)
       success = self.class.retry_on_exception? { CloudDatastore.dataset.save entity }
@@ -271,6 +276,7 @@ module ActiveModel::Datastore
     # @option options [String] :order Sort the results by property name.
     # @option options [String] :desc_order Sort the results by descending property name.
     # @option options [Array] :select Retrieve only select properties from the matched entities.
+    # @option options [Array] :distinct_on Group results by a list of properties.
     # @option options [Array] :where Adds a property filter of arrays in the format
     #   [name, operator, value].
     #
@@ -350,6 +356,7 @@ module ActiveModel::Datastore
     #
     def from_entities(entities)
       raise ArgumentError, 'Entities param must be an Enumerator' unless entities.is_a? Enumerator
+
       entities.map { |entity| from_entity(entity) }
     end
 
@@ -361,6 +368,7 @@ module ActiveModel::Datastore
     #
     def from_entity(entity)
       return if entity.nil?
+
       model_entity = build_model(entity)
       model_entity.entity_property_values = entity.properties.to_h
       entity.properties.to_h.each do |name, value|
@@ -370,12 +378,6 @@ module ActiveModel::Datastore
       model_entity
     end
 
-    def exclude_from_index(entity, boolean)
-      entity.properties.to_h.keys.each do |value|
-        entity.exclude_from_indexes! value, boolean
-      end
-    end
-
     ##
     # Constructs a Google::Cloud::Datastore::Query.
     #
@@ -387,6 +389,7 @@ module ActiveModel::Datastore
     # @option options [String] :order Sort the results by property name.
     # @option options [String] :desc_order Sort the results by descending property name.
     # @option options [Array] :select Retrieve only select properties from the matched entities.
+    # @option options [Array] :distinct_on Group results by a list of properties.
     # @option options [Array] :where Adds a property filter of arrays in the format
     #   [name, operator, value].
     #
@@ -402,8 +405,9 @@ module ActiveModel::Datastore
       sleep_time = 0.25
       begin
         yield
-      rescue => e
+      rescue Google::Cloud::Error => e
         return false if retries >= max_retry_count
+
         puts "\e[33mRescued exception #{e.message.inspect}, retrying in #{sleep_time}\e[0m"
         # 0.25, 0.5, 1, 2, and 4 second between retries.
         sleep sleep_time
@@ -418,8 +422,9 @@ module ActiveModel::Datastore
       sleep_time = 0.25
       begin
         yield
-      rescue => e
+      rescue Google::Cloud::Error => e
         raise e if retries >= max_retry_count
+
         puts "\e[33mRescued exception #{e.message.inspect}, retrying in #{sleep_time}\e[0m"
         # 0.25, 0.5, 1, 2, and 4 second between retries.
         sleep sleep_time
@@ -443,7 +448,8 @@ module ActiveModel::Datastore
       query.cursor(options[:cursor]) if options[:cursor]
       query.limit(options[:limit]) if options[:limit]
       query_sort(query, options)
-      query.select(options[:select]) if options[:select]
+      query.select(*options[:select]) if options[:select]
+      query.distinct_on(*options[:distinct_on]) if options[:distinct_on]
       query_property_filter(query, options)
     end
 

data/lib/active_model/datastore/connection.rb

@@ -14,23 +14,20 @@
 module CloudDatastore
   if defined?(Rails) == 'constant'
     if Rails.env.development?
-      ENV['DATASTORE_EMULATOR_HOST'] = 'localhost:8180'
-      ENV['GCLOUD_PROJECT'] = 'local-datastore'
+      ENV['DATASTORE_EMULATOR_HOST'] ||= 'localhost:8180'
+      ENV['GCLOUD_PROJECT'] ||= 'local-datastore'
     elsif Rails.env.test?
-      ENV['DATASTORE_EMULATOR_HOST'] = 'localhost:8181'
-      ENV['GCLOUD_PROJECT'] = 'test-datastore'
+      ENV['DATASTORE_EMULATOR_HOST'] ||= 'localhost:8181'
+      ENV['GCLOUD_PROJECT'] ||= 'test-datastore'
     elsif ENV['SERVICE_ACCOUNT_PRIVATE_KEY'].present? &&
           ENV['SERVICE_ACCOUNT_CLIENT_EMAIL'].present?
-      ENV['GCLOUD_KEYFILE_JSON'] = '{"private_key": "' + ENV['SERVICE_ACCOUNT_PRIVATE_KEY'] + '",
+      ENV['GCLOUD_KEYFILE_JSON'] ||= '{"private_key": "' + ENV['SERVICE_ACCOUNT_PRIVATE_KEY'] + '",
       "client_email": "' + ENV['SERVICE_ACCOUNT_CLIENT_EMAIL'] + '"}'
     end
-  else
-    ENV['DATASTORE_EMULATOR_HOST'] = 'localhost:8181'
-    ENV['GCLOUD_PROJECT'] = 'test-datastore'
   end
 
   def self.dataset
-    @dataset ||= Google::Cloud.datastore(ENV['GCLOUD_PROJECT'])
+    @dataset ||= Google::Cloud.datastore
   end
 
   def self.reset_dataset

data/lib/active_model/datastore/excluded_indexes.rb

@@ -0,0 +1,38 @@
+module ActiveModel::Datastore
+  module ExcludedIndexes
+    extend ActiveSupport::Concern
+
+    def no_index_attributes
+      []
+    end
+
+    ##
+    # Sets all entity properties to be included/excluded from the Datastore indexes.
+    #
+    def exclude_from_index(entity, boolean)
+      entity.properties.to_h.each_key do |value|
+        entity.exclude_from_indexes! value, boolean
+      end
+    end
+
+    module ClassMethods
+      ##
+      # Sets attributes to be excluded from the Datastore indexes.
+      #
+      # Overrides no_index_attributes to return an Array of the attributes configured
+      # to be indexed.
+      #
+      # For example, an indexed string property can not exceed 1500 bytes. String properties
+      # that are not indexed can be up to 1,048,487 bytes. All properties indexed by default.
+      #
+      def no_indexes(*attributes)
+        attributes = attributes.collect(&:to_s)
+        define_method('no_index_attributes') { attributes }
+      end
+
+      def clear_index_exclusions!
+        define_method('no_index_attributes') { [] }
+      end
+    end
+  end
+end

data/lib/active_model/datastore/nested_attr.rb

@@ -105,9 +105,7 @@ module ActiveModel::Datastore
 
     def nested_model_class_names
       entity_kinds = []
-      if nested_attributes?
-        nested_models.each { |x| entity_kinds << x.class.name }
-      end
+      nested_models.each { |x| entity_kinds << x.class.name } if nested_attributes?
       entity_kinds.uniq
     end
 
@@ -159,7 +157,7 @@ module ActiveModel::Datastore
       association_name = association_name.to_sym
       send("#{association_name}=", []) if send(association_name).nil?
 
-      attributes.each do |_i, params|
+      attributes.each_value do |params|
         if params['id'].blank?
           unless reject_new_record?(params, options)
             new = association_name.to_c.new(params.except(*UNASSIGNABLE_KEYS))
@@ -182,6 +180,7 @@ module ActiveModel::Datastore
       unless attributes.is_a?(Hash)
         raise ArgumentError, "Hash expected, got #{attributes.class.name} (#{attributes.inspect})"
       end
+
       attributes
     end
 
@@ -216,6 +215,7 @@ module ActiveModel::Datastore
     #
     def call_reject_if(attributes, options)
       return false if destroy_flag?(attributes)
+
       attributes = attributes.with_indifferent_access
       blank_proc = proc { |attrs| attrs.all? { |_key, value| value.blank? } }
       options[:reject_if] = blank_proc if options[:reject_if] == :all_blank
@@ -247,6 +247,7 @@ module ActiveModel::Datastore
     class AssociatedValidator < ActiveModel::EachValidator
       def validate_each(record, attribute, value)
         return unless Array(value).reject(&:valid?).any?
+
         record.errors.add(attribute, :invalid, options.merge(value: value))
       end
     end

data/lib/active_model/datastore/property_values.rb

@@ -38,6 +38,7 @@ module ActiveModel::Datastore
     #
     def format_property_value(attr, type)
       return unless send(attr.to_sym).present?
+
       case type.to_sym
       when :integer
         send("#{attr.to_sym}=", send(attr.to_sym).to_i)

data/lib/active_model/datastore/track_changes.rb

@@ -70,12 +70,12 @@ module ActiveModel::Datastore
       unless tracked_attributes.present?
         raise TrackChangesError, 'Object has not been configured for change tracking.'
       end
+
       changed = marked_for_destruction? ? true : false
       tracked_attributes.each do |attr|
         break if changed
-        if send("#{attr}_changed?")
-          changed = send(attr) == send("#{attr}_was") ? false : true
-        end
+
+        changed = send(attr) != send("#{attr}_was") if send("#{attr}_changed?")
       end
       self.exclude_from_save = !changed
       changed
@@ -83,6 +83,7 @@ module ActiveModel::Datastore
 
     def remove_unmodified_children
       return unless tracked_attributes.present? && nested_attributes?
+
       nested_attributes.each do |attr|
         with_changes = Array(send(attr.to_sym)).select(&:values_changed?)
         send("#{attr}=", with_changes)

data/lib/active_model/datastore/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   module Datastore
-    VERSION = '0.2.3'
+    VERSION = '0.5.0'
   end
 end

data/lib/activemodel/datastore.rb

@@ -7,6 +7,7 @@ require 'active_model'
 
 require 'active_model/datastore/connection'
 require 'active_model/datastore/errors'
+require 'active_model/datastore/excluded_indexes'
 require 'active_model/datastore/nested_attr'
 require 'active_model/datastore/property_values'
 require 'active_model/datastore/track_changes'

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-datastore
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Bryce McLean
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: google-cloud-datastore
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,50 +70,50 @@ dependencies:
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -128,26 +128,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.14
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.14
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -168,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
 description: Makes the google-cloud-datastore gem compliant with active_model conventions
   and compatible with your Rails 5+ applications.
 email:
@@ -191,6 +171,7 @@ files:
 - lib/active_model/datastore/carrier_wave_uploader.rb
 - lib/active_model/datastore/connection.rb
 - lib/active_model/datastore/errors.rb
+- lib/active_model/datastore/excluded_indexes.rb
 - lib/active_model/datastore/nested_attr.rb
 - lib/active_model/datastore/property_values.rb
 - lib/active_model/datastore/track_changes.rb
@@ -199,8 +180,12 @@ files:
 homepage: https://github.com/Agrimatics/activemodel-datastore
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/Agrimatics/activemodel-datastore
+  changelog_uri: https://github.com/Agrimatics/activemodel-datastore/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/Agrimatics/activemodel-datastore/
+  bug_tracker_uri: https://github.com/Agrimatics/activemodel-datastore/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,9 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Cloud Datastore integration with Active Model
 test_files: []