slender_data 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1deea5d8aa969cdc2e213cb39e50b526a00615c0
-  data.tar.gz: 5b89a6bd314958eef91ddf872db9d10763f609d9
+  metadata.gz: d219af00b0955ed12a4724a45274fbbdcfad22d2
+  data.tar.gz: 1e55017fea414a68625b7076f61bba42f46991ac
 SHA512:
-  metadata.gz: b3df0aa35a568a60aa088320e254183d632357f5ecee53b0f47a2ba900113a3fb546e6220f3b50890388f8e67e87c71c5e71db3a2f55563dd3c1c7e4ab14ccf1
-  data.tar.gz: 916850fc041b71ae70fc6c9d97308a7713f78d4ac41f6d4a7ac324f120db9f604f5c5fe6bb20f1c25da2b023822759b42bb745eacd6e5f4e2f665608324fe38c
+  metadata.gz: 003380a4bc570c13031e817ca35673904b6270dc1d1d4445e8e066258055cc43c0e3835866c557cd792232821f3cb64276c5f041bde7079c78774307a99ee103
+  data.tar.gz: 91d95a4d10aae259c87f1f7461808dc9c03e5fc99816f6be1a01d2a40b134f209df11715b63a9f04e5a77a2aada10553277657a9e3775c1369a8bcf9806255ef

data/app/assets/javascripts/slender_data/persistence_manager.coffee

@@ -8,6 +8,13 @@
 # In addition to the standard RESTful routes, the data API is expected to support these methods for performance reasons:
 # * DELETE /entries: Delete a whole batch of entries at once. The ids of the entries to delete are given as a JSON hash in the body of the request.
 # *
+#
+# Terminology:
+# * "load" methods are high level public API. They try to satisfy the requests from the local cache, and load the data from the server on demand.
+# * "get" methods access only the local cache, and return their results synchronously.
+# * "fetch" methods encapsulate accessing remote resources.
+# * "create" creates a given entry on the server
+# * "add" adds the given entry to the clientside cache.
 class slender_data.PersistenceManager
 
   constructor: (params) ->
@@ -31,6 +38,15 @@ class slender_data.PersistenceManager
     @loader = new slender_data.AjaxLoader { cache: no }
 
 
+  # Adds the given entry to the clientside caches.
+  # Returns the entry to be used by the client.
+  add: (entry) ->
+    @server_data.add entry
+    client_entry = slender_data.clone_hash entry
+    @client_data.add client_entry
+    client_entry
+
+
   # Adds the given data objects to the server cache.
   add_all: (data) ->
     @server_data.add_all data
@@ -69,6 +85,9 @@ class slender_data.PersistenceManager
         error_callback(xhr.responseText) if error_callback
 
 
+  # TODO: create_many
+
+
   # Deletes the given object from the server.
   delete: (obj, success_callback, error_callback) ->
     @client_data.remove obj
@@ -106,8 +125,31 @@ class slender_data.PersistenceManager
     "#{@base_url}.json"
 
 
-  # Returns the cached data object, or undefined.
-  get_cached: (key) ->
+  # Fetches the entry with the given key from the server.
+  # Adds it to the clientside cache.
+  fetch: (key, success_callback) ->
+    @loader.get "#{@base_url}/#{key}.json", (server_entry) =>
+      client_entry = @add server_entry
+      success_callback client_entry
+
+
+  # Loads all objects from the server.
+  # Provides the given params as parameters to the GET request.
+  fetch_all: (params, success_callback, error_callback) ->
+    jQuery.ajax
+      url: @collection_url()
+      cache: no
+      data: params
+      success: (data) =>
+        @server_data.add_all data
+        success_callback(data) if success_callback
+      error: (xhr) ->
+        error_callback(xhr.responseText) if error_callback
+
+
+  # Returns the cached object with the given key, if one exists in the cache.
+  # Returns ndefined if no object with this key exists in the cache.
+  get_cached_entry: (key) ->
 
     # Try to use client_data cache.
     client_obj = @client_data.get key
@@ -121,51 +163,39 @@ class slender_data.PersistenceManager
       return client_obj
 
     # Object not found in client or server cache.
-    return undefined
+    undefined
+
+
+  # Returns all entries that are in the cache,
+  # and the ids of all entries that are not cached.
+  get_cached_entries: (ids) ->
+    entries = []
+    missing_ids = []
+    for id in ids
+      if (entry = @get_cached_entry(id))
+        entries.push entry
+      else
+        missing_ids.push id
+    [entries, missing_ids]
 
 
   # Returns the entry with the given key.
   load: (key, success_callback) ->
 
     # Try to load from cache.
-    return success_callback(entry) if entry = @get_cached key
+    return success_callback(entry) if entry = @get_cached_entry key
 
-    # No data on client at all --> load data from server.
-    @loader.get "#{@base_url}/#{key}", (server_entry) =>
-      @server_data.add server_entry
-      client_entry = slender_data.clone_hash server_entry
-      @client_data.add client_entry
-      success_callback client_entry
-
-
-  # Loads all objects from the server.
-  # Provides the given params as parameters to the GET request.
-  load_all: (params, success_callback, error_callback) ->
-    jQuery.ajax
-      url: @collection_url()
-      cache: no
-      data: params
-      success: (data) =>
-        @server_data.add_all data
-        success_callback() if success_callback
-      error: (xhr) ->
-        error_callback(xhr.responseText) if error_callback
+    # No data on client --> load from server.
+    @fetch key, success_callback
 
 
   # Loads all entries with the given ids.
   load_many: (ids, success_callback) ->
-    missing_ids = []
-    entries = []
-    $.each ids, (pos, id) =>
-      entry = @get_cached id
-      if entry
-        entries.push entry
-      else
-        missing_ids.push id
-
+    [cached_entries, missing_ids] = @get_cached_entries(ids)
     if missing_ids.length == 0
-      return success_callback(entries)
+      return success_callback(cached_entries)
 
+    # TODO: implement loading the missing entries from the server.
     alert "uncached entries found: #{missing_ids}"
 
 
@@ -179,6 +209,8 @@ class slender_data.PersistenceManager
       @create obj, success_callback, error_callback
 
 
+  # TODO: save_many
+
   # Updates the given object.
   #
   # The given object must exist on the server already,

data/lib/slender_data/version.rb

@@ -1,3 +1,3 @@
 module SlenderData
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: slender_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A JS micro-framework for lightweight AJAX data management against RESTful