activemodel-datastore 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798ea7d0389b4ebe382843a0392d3c1d2a9d2d9b
-  data.tar.gz: ad21cf50902c04a3277eab704e5a0b9c81bb8db5
+  metadata.gz: 43c4bfc5e295411cd88d6bdff0897e564dea9e23
+  data.tar.gz: 4ed3b3a28213026e2c99cb0f616372c82958d78f
 SHA512:
-  metadata.gz: d2323ec3937aca9cf5bd817f7788d0990fe4ba965ff0b03c5421cd0c662e5308a6caaab4daf5965d5c8b719d7117dc34fd9ab6bf27b8d1cb61d007fe02adfa52
-  data.tar.gz: 2d3660d111a2fbbb3081861b4657a016d0decd16ba966a1e55212f20653f2914a2cb9a671f298a5e9acd469138cfe063f8c7362c08a103452adaf95ae1d61752
+  metadata.gz: ebe8bb990217d55648209e66be3114176d83e85c81fdecf3f4b1396346f1b063cb823e8aed2e7599e9568e1bd0c92bb4e5ae0dd7c2801a8114eeaf6513e41fb1
+  data.tar.gz: 6b623ad9ccc3094e96b19969df904e844c4659f9b7dbbabebfd97ae6c8e98311c437c9b3ee4cbdaa2b6733ff2ceb085b0d242baf0be8e5a67802dea83d5043dd

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.3 / 2017-05-24
+* adding CarrierWave file upload support
+* updating example Cloud Datastore Rails app to 5.1
+* adding image upload example to example Rails app
+
 ### 0.2.2 / 2017-04-27
 
 * now store a hash of entity properties during entity to model conversion

data/README.md

@@ -24,6 +24,7 @@ suited for unstructured or semi-structured application data.
 - [Datastore Indexes](#indexes)
 - [Datastore Emulator](#emulator)
 - [Example Rails App](#rails)
+- [CarrierWave File Uploads](#carrierwave)
 - [Track Changes](#track_changes)
 - [Nested Forms](#nested)
 - [Datastore Gotchas](#gotchas)
@@ -471,6 +472,47 @@ There is an example Rails 5 app in the test directory [here](https://github.com/
  ```
  
  Navigate to http://localhost:3000.
+ 
+## <a name="carrierwave"></a>CarrierWave File Uploads
+
+Active Model Datastore has built in support for [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) 
+which is a simple and extremely flexible way to upload files from Rails applications. You can use 
+different stores, including filesystem and cloud storage such as Google Cloud Storage or AWS.
+
+Simply require `active_model/datastore/carrier_wave_uploader` and extend your model with the 
+CarrierWaveUploader (after including ActiveModel::Datastore). Follow the CarrierWave 
+[instructions](https://github.com/carrierwaveuploader/carrierwave#getting-started) for generating 
+an uploader.
+
+In this example it will be something like:
+
+`rails generate uploader ProfileImage`
+
+Define an attribute on the model for your file(s). You can then mount the uploaders using 
+`mount_uploader` (single file) or `mount_uploaders` (array of files). Don't forget to add the new
+attribute to `entity_properties` and whitelist the attribute in the controller if using strong 
+parameters.
+
+```ruby
+require 'active_model/datastore/carrier_wave_uploader'
+
+class User
+  include ActiveModel::Datastore
+  extend CarrierWaveUploader
+
+  attr_accessor :email, :enabled, :name, :profile_image, :role
+  
+  mount_uploader :profile_image, ProfileImageUploader
+
+  def entity_properties
+    %w[email enabled name profile_image role]
+  end
+end
+```
+
+You will want to add something like this to your Rails form:
+
+`<%= form.file_field :profile_image %>`
 
 ## <a name="track_changes"></a>Track Changes
 

data/lib/active_model/datastore/carrier_wave_uploader.rb

@@ -0,0 +1,117 @@
+module CarrierWaveUploader
+  include CarrierWave::Mount
+
+  private
+
+  def mount_base(column, uploader = nil, options = {}, &block)
+    super
+
+    # include CarrierWave::Validations::ActiveModel
+    #
+    # validates_integrity_of column if uploader_option(column.to_sym, :validate_integrity)
+    # validates_processing_of column if uploader_option(column.to_sym, :validate_processing)
+    # validates_download_of column if uploader_option(column.to_sym, :validate_download)
+
+    after_save :"store_#{column}!"
+    after_update :"store_#{column}!"
+    after_destroy :"remove_#{column}!"
+
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      ##
+      # Override for setting the file urls on the entity.
+      #
+      def build_entity(parent = nil)
+        entity = super(parent)
+        self.class.uploaders.keys.each do |col|
+          entity[col.to_s] = send("get_" + col.to_s + "_identifiers")
+        end
+        entity
+      end
+
+      ##
+      # Override to append file names for mount_uploaders.
+      # Works with multiple files stored as an Array.
+      #
+      def update(params)
+        existing_files = {}
+        self.class.uploaders.keys.each do |attr_name|
+           existing_files[attr_name] = uploader_file_names(attr_name) if send(attr_name).is_a? Array
+        end
+        assign_attributes(params)
+        return unless valid?
+        run_callbacks :update do
+          entity = build_entity
+          self.class.uploaders.keys.each do |attr_name|
+            entity[attr_name] = append_files(entity[attr_name], existing_files[attr_name])
+          end
+          self.class.retry_on_exception? { CloudDatastore.dataset.save entity }
+        end
+      end
+
+      ##
+      # For new entities, set the identifiers (file names).
+      # For deleted entities, set the identifier (which will be nil).
+      # For updated entities, set the identifiers if they have changed. The
+      # identifier will be nil if files were not uploaded during the update.
+      #
+      def get_#{column}_identifiers
+        identifier = write_#{column}_identifier
+        if persisted? && !remove_#{column}? && identifier.nil?
+          if defined?(#{column}_identifier) && #{column}_identifier.present?
+           #{column}_identifier if defined?(#{column}_identifier) && #{column}_identifier.present?
+          elsif defined?(#{column}_identifiers) && #{column}_identifiers.present?
+            #{column}_identifiers
+          end
+        else
+          identifier
+        end
+      end
+
+      ##
+      # Called by CarrierWave::Mount.mount_uploaders -> write_#{column}_identifier.
+      #
+      def write_uploader(column, identifier)
+        identifier
+      end
+
+      ##
+      # This gets called whenever the uploaders instance variable is nil.
+      # It returns the uploader identifiers (file names) for the desired column.
+      #
+      def read_uploader(column)
+        if entity_property_values.present? && entity_property_values.key?(column.to_s)
+          entity_property_values[column.to_s]
+        end
+      end
+
+      ##
+      # Reset cached mounter on record reload.
+      #
+      def reload!
+        @_mounters = nil
+        super
+      end
+
+      ##
+      # Reset cached mounter on record dup.
+      #
+      def initialize_dup(other)
+        @_mounters = nil
+        super
+      end
+
+      # private
+
+      def uploader_file_names(attr_name)
+        send(attr_name).map { |x| x.file.filename }
+      end
+
+      def append_files(files, new_files)
+        if files.is_a?(Array) && !new_files.nil?
+          files = files.push(*new_files).flatten.compact.uniq
+        end
+        files
+      end
+    RUBY
+  end
+end

data/lib/active_model/datastore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-datastore
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bryce McLean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -154,14 +154,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.0
+        version: '0.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.0
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Makes the google-cloud-datastore gem compliant with active_model conventions
   and compatible with your Rails 5+ applications.
 email:
@@ -174,6 +188,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/active_model/datastore.rb
+- lib/active_model/datastore/carrier_wave_uploader.rb
 - lib/active_model/datastore/connection.rb
 - lib/active_model/datastore/errors.rb
 - lib/active_model/datastore/nested_attr.rb
@@ -201,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Cloud Datastore integration with Active Model