synced 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aa93a0045e49e35ef45f18f16afcd94d9e0bd24
-  data.tar.gz: 699a8ae50503c3bb5467dacc47084ce59f849c92
+  metadata.gz: c751562a0b6773e1685c936cf9461f6e1672b993
+  data.tar.gz: b1620c76e516e4e6334c0b968196e9d731550f1a
 SHA512:
-  metadata.gz: 539bad5fcea8a7499960b79168d83196658a3479e953486fa70240c75e89079bf4bb3a1f12802d8edaee653fc66799cc6547db2f6a1f830fc404c4ddd1baa103
-  data.tar.gz: 4d1c9bb509766abbb41a245522b150442338f25ef23901650378a239709cb1c384fd14ed090238ff085ca6eaf2c341918c53f2476ba05e009d933608c74b7f2b
+  metadata.gz: 7bc982cf7b18f570fd5e0879306a94e322ccff6aa049325621538630db503edc71e59352428d56ed28db4289b7814a146bd80ee1488f453ead1056d09b8969e7
+  data.tar.gz: 1c4855bd6caaeeebc113e877724c2556c29775612bc911e199e09813b6fa71618bfde5322cc27cca46cbfbd6751a7f7d252a46ae33c1e189e50d43da3ed7c740

data/README.md

@@ -128,7 +128,7 @@ will be assigned value of `size` attribute of the remote object.
 
 ### Local attributes with mapping blocks
 
-If you want to convert an attributes value during synchronization you can
+If you want to convert attribute's value during synchronization you can
 pass a block as value in the mapping hash. Block will receive remote object
 as the only argument.
 
@@ -358,6 +358,34 @@ This can be overwritten in synchronize method.
 Photo.synchronize(fields: [:name, :size])
 ```
 
+## Delegate attributes
+
+You can delegate attributes from your synced model to `synced_data` Hash for easier access to
+synchronized data.
+
+```ruby
+class Photo < ActiveRecord::Base
+  synced delegate_attributes: [:name]
+end
+```
+
+Now you can fetch photo name using:
+
+```ruby
+@photo.name #=> "Sunny morning"
+```
+
+If you want to access synced attribute with different name, you can pass a Hash:
+
+```ruby
+class Photo < ActiveRecord::Base
+  synced delegate_attributes: {title: :name}
+end
+
+keys are delegated attributes' names and values are keys on synced data Hash. This is a simpler
+version of `delegate :name, to: :synced_data` which works with Hash reserved attributes names, like
+`:zip`, `:map`.
+
 ## Synced configuration options
 
 Option name          | Default value    | Description                                                                       | synced | synchronize |
@@ -372,6 +400,7 @@ Option name          | Default value    | Description
 `:include`           | `[]`             | [An array of associations to be fetched](#including-associations-in-synced_data)  | YES    | YES         |
 `:fields`            | `[]`             | [An array of fields to be fetched](#selecting-fields-to-be-synchronized)          | YES    | YES         |
 `:remote`            | `nil`            | [Remote objects to be synchronized with local ones](#synchronization-of-given-remote-objects) | NO | YES |
+`:delegate_attributes`| `[]`            | [Define delegators to synced data Hash attributes](#delegate-attributes) | YES | NO |
 
 ## Documentation
 

data/lib/synced/attributes_as_hash.rb

@@ -0,0 +1,11 @@
+module Synced
+  module AttributesAsHash
+    # On a Hash returns the same Hash
+    # On an Array returns a Hash with identical corresponding keys and values
+    # Used for mapping local - remote attributes
+    def synced_attributes_as_hash(attributes)
+      return attributes if attributes.is_a?(Hash)
+      Hash[Array(attributes).map { |name| [name, name] }]
+    end
+  end
+end

data/lib/synced/delegate_attributes.rb

@@ -0,0 +1,16 @@
+require 'synced/attributes_as_hash'
+
+module Synced
+  module DelegateAttributes
+    extend ActiveSupport::Concern
+    included do
+      synced_attributes_as_hash(synced_delegate_attributes).each do |key, value|
+        define_method(key) { send(synced_data_key)[value] }
+      end
+    end
+
+    module ClassMethods
+      include Synced::AttributesAsHash
+    end
+  end
+end

data/lib/synced/model.rb

@@ -32,15 +32,18 @@ module Synced
     # @option options [Time|Proc] initial_sync_since: A point in time from which
     #   objects will be synchronized on first synchronization.
     #   Works only for partial (updated_since param) synchronizations.
+    # @option options [Array|Hash] delegate_attributes: Given attributes will be defined
+    #   on synchronized object and delegated to synced_data Hash
     def synced(options = {})
       options.symbolize_keys!
       options.assert_valid_keys(:associations, :data_key, :fields,
         :globalized_attributes, :id_key, :include, :initial_sync_since,
-        :local_attributes, :mapper, :only_updated, :remove, :synced_all_at_key)
+        :local_attributes, :mapper, :only_updated, :remove, :synced_all_at_key,
+        :delegate_attributes)
       class_attribute :synced_id_key, :synced_all_at_key, :synced_data_key,
         :synced_local_attributes, :synced_associations, :synced_only_updated,
         :synced_mapper, :synced_remove, :synced_include, :synced_fields,
-        :synced_globalized_attributes, :synced_initial_sync_since
+        :synced_globalized_attributes, :synced_initial_sync_since, :synced_delegate_attributes
       self.synced_id_key                = options.fetch(:id_key, :synced_id)
       self.synced_all_at_key            = options.fetch(:synced_all_at_key,
         synced_column_presence(:synced_all_at))
@@ -58,6 +61,8 @@ module Synced
         [])
       self.synced_initial_sync_since    = options.fetch(:initial_sync_since,
         nil)
+      self.synced_delegate_attributes   = options.fetch(:delegate_attributes, [])
+      include Synced::DelegateAttributes
       include Synced::HasSyncedData
     end
 
@@ -128,3 +133,4 @@ module Synced
     end
   end
 end
+

data/lib/synced/synchronizer.rb

@@ -1,7 +1,10 @@
+require 'synced/delegate_attributes'
+require 'synced/attributes_as_hash'
 # Synchronizer class which performs actual synchronization between
 # local database and given array of remote objects
 module Synced
   class Synchronizer
+    include AttributesAsHash
     attr_reader :id_key
 
     # Initializes a new Synchronizer
@@ -51,7 +54,7 @@ module Synced
       @remove                = options[:remove]
       @only_updated          = options[:only_updated]
       @include               = options[:include]
-      @local_attributes      = attributes_as_hash(options[:local_attributes])
+      @local_attributes      = synced_attributes_as_hash(options[:local_attributes])
       @api                   = options[:api]
       @mapper                = options[:mapper].respond_to?(:call) ?
                                options[:mapper].call : options[:mapper]
@@ -60,7 +63,7 @@ module Synced
       @associations          = Array(options[:associations])
       @perform_request       = options[:remote].nil?
       @remote_objects        = Array(options[:remote]) unless @perform_request
-      @globalized_attributes = attributes_as_hash(options[:globalized_attributes])
+      @globalized_attributes = synced_attributes_as_hash(options[:globalized_attributes])
       @initial_sync_since    = options[:initial_sync_since]
     end
 
@@ -240,11 +243,6 @@ module Synced
       Synced.instrumenter.instrument(*args, &block)
     end
 
-    def attributes_as_hash(attributes)
-      return attributes if attributes.is_a?(Hash)
-      Hash[Array(attributes).map { |name| [name, name] }]
-    end
-
     class MissingAPIClient < StandardError
       def initialize(scope, model_class)
         @scope = scope

data/lib/synced/version.rb

@@ -1,3 +1,3 @@
 module Synced
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synced
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Sebastien Grosjean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,8 @@ files:
 - README.md
 - Rakefile
 - lib/synced.rb
+- lib/synced/attributes_as_hash.rb
+- lib/synced/delegate_attributes.rb
 - lib/synced/has_synced_data.rb
 - lib/synced/model.rb
 - lib/synced/rails.rb