modularity-rails 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b308dae8fa805bb5a5bc2d60f35074c03ff17aaf
-  data.tar.gz: 2d5ddb447553352e40c2a2ab7e239571855489b7
+  metadata.gz: 65f2ce39342e4c93961f900aabf4c03b62feec63
+  data.tar.gz: 23b288aaa60b08f814f664ede4605487cb69fe51
 SHA512:
-  metadata.gz: 00ff8f9aa9807dd0beb7c8769971bc986615670956026ec9855a446db39ad7daf820279230f63842aad0ef57731350025060a47965fe55d892dd3a37788715fe
-  data.tar.gz: c5fed634fdf0ae9badcc14cca776ece4b9268c3a192f08fe7f27d26f6bef7afc727d7d7cc6e3a956f387ff75e8aa674078f2c90c82724e4e9db0492248321b6d
+  metadata.gz: 7c6c1e2a371e3003c401780f624d3792890ccd92521a8de5741380496596c60dfd248f0ca07148b4ee68caa4d1cd00b8aea03822cdb74a72f1bebe77fc1541db
+  data.tar.gz: 42576e03b20368447a62be4e6df4f475e79b7336ac346f642d59f39efde7bad459b4ba49323272a98462b2190932d34e14231b59b7f84bbe12aeac3aec249a99

data/README.md

@@ -148,10 +148,10 @@ and must be explicitly required in your Rails files using the `require` commands
 
 ## Mixins
 
-###clickable
+### Clickable
 Including this mixins adds a 'clickable' aspect to your module, i.e. turns it into a button. Clicking anywhere inside the container makes it fire the 'clicked' event.
 
-###closable
+### Closable
 Including this mixin makes a module closable. The mixin searches for an embedded DOM element with the class 'CloseButton'. When it is clicked, the following things happen:
 
 * The _closable_closing_ hook of the closable class is called.
@@ -162,20 +162,6 @@ Including this mixin makes a module closable. The mixin searches for an embedded
 * The _closable_closed_ hook of the closable class is called.
 
 
-## Tools
-
-### Loader
-A generic cached loader for parallel and repeated GET requests.
-Prevents duplicate requests, caches the responses.
-
-The first request triggers the ajax request. Subsequent requests while the resquest is running are accumulated without causing new requests.
-Once the response arrives, all currently requesting clients are answered. Subsequent requests are answered immediately using the cached data.
-
-```coffeescript
-Module.loader.get '/test.json', (data) ->
-  # Use data here.
-```
-
 # Development
 
 ## Contributing

data/lib/modularity-rails/version.rb

@@ -1,3 +1,3 @@
 module ModularityRails
-  VERSION = '0.28.0'
+  VERSION = '0.29.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modularity-rails
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,10 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/assets/javascripts/modularity/data/ajax_loader.coffee
-- app/assets/javascripts/modularity/data/cache.coffee
-- app/assets/javascripts/modularity/data/indexed_cache.coffee
-- app/assets/javascripts/modularity/data/persistence_manager.coffee
 - app/assets/javascripts/modularity/mixins/clickable.coffee
 - app/assets/javascripts/modularity/mixins/closable.coffee
 - app/assets/javascripts/modularity/modularity.coffee
@@ -152,7 +148,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 lightweight, object- and component-oriented CoffeeScript framework for

data/app/assets/javascripts/modularity/data/ajax_loader.coffee

@@ -1,77 +0,0 @@
-#= require modularity/data/cache
-
-
-# A generic ajax loader for parallel GET requests.
-# Prevents duplicate requests, caches the responses
-# to answer subsequent requests immediately
-# without additional server requests.
-#
-# Warning: Caches the responses, so once a request is cached,
-#          any new content on the same URL will not be visible!
-class modularity.AjaxLoader
-
-  constructor: (params = {}) ->
-
-    # Caches the callbacks.
-    @cb_cache = new modularity.Cache()
-
-    # Whether to perform caching of data.
-    # Default: no.
-    @caching = !!params.caching
-
-    # Caches the data loaded.
-    @data_cache = new modularity.Cache()
-
-    # The number of currently running loading operations.
-    @loader_count = 0
-
-
-  # The different events that this class can fire.
-  @events =
-    AJAX_LOADING: 'AJAX_LOADING'
-    AJAX_LOADED: 'AJAX_LOADED'
-
-
-  # Loads the data from the given URL asynchronously.
-  get: (url, callback) ->
-
-    # Return immediately if we have cached data.
-    if @caching
-      cached_data = @data_cache.get url
-      return callback(cached_data) if cached_data?
-
-    # Here, we have no cached data. Check
-
-    # If a GET call to this URL is already in progress -->
-    # add the given callback to the list of waiting callbacks.
-    request_in_progress = @cb_cache.get url
-    return request_in_progress.push(callback) if request_in_progress?
-
-    # Here, no request is currently in progress --> start a new one.
-
-    # Add callback to callback list.
-    @cb_cache.add url, [callback]
-
-    # Fire 'loading' event if this is the start of a loading operation.
-    @loader_count++
-    if @loader_count == 1
-      modularity.fire_global_event modularity.AjaxLoader.events.AJAX_LOADING
-
-    # Perform the request.
-    jQuery.get url, (data) =>
-
-      # Add result to cache.
-      if @caching
-        @data_cache.add url, data
-
-      # Call callbacks.
-      cb(data) for cb in @cb_cache.get url
-
-      # Remove request from callback list.
-      @cb_cache.remove url
-
-      # Fire 'loaded' event.
-      @loader_count--
-      if @loader_count == 0
-        modularity.fire_global_event modularity.AjaxLoader.events.AJAX_LOADED
-

data/app/assets/javascripts/modularity/data/cache.coffee

@@ -1,65 +0,0 @@
-#= require modularity/tools/object_tools
-
-# A generic cache.
-# Stores key-value pairs.
-class modularity.Cache
-
-  constructor: ->
-
-    # Container for the cached objects.
-    @cache = {}
-
-
-  # Adds the given entry to the cache.
-  # Overwrites existing entries.
-  add: (key, value) ->
-    @cache[key] = value
-
-
-  # Returns the entry with the given key from the cache, or NULL if no entry exists.
-  get: (key) ->
-    @cache[key]
-
-
-  # Looks up several entries at once.
-  # Returns a hash of found entries, and a list of missing entries.
-  get_many: (keys) ->
-    result = { found: {}, missing: [] }
-    for key in keys
-      do (key) =>
-        value = @cache[key]
-        if value
-          result.found[key] = value
-        else
-          result.missing.push key
-    result
-  getMany: Cache::get_many
-
-
-  # Returns the number of cached objects.
-  length: () ->
-    modularity.object_length @cache
-
-
-  # Removes the entry with the given key.
-  remove: (key) =>
-    delete @cache[key]
-
-
-  # Removes all entries with the given keys.
-  remove_many: (keys) ->
-    @remove(key) for key in keys
-
-
-  # Replaces the cache with the given data.
-  # When 'key' is given, treats 'data' as an array of objects, and indexes each element by the given key.
-  # When 'key' is not given, treats 'data' as an already indexed hash object.
-  replace_all: (data, key) ->
-    if key
-      # Key given --> index the data array.
-      @add(entry[key], entry) for entry in data
-    else
-      # Key not given --> use data as the new cache.
-      @cache = data
-  replaceAll: Cache::replace_all
-

data/app/assets/javascripts/modularity/data/indexed_cache.coffee

@@ -1,32 +0,0 @@
-#= require modularity/data/cache
-
-# Provides fast and convenient retrieval of hash objects
-# by indexing them on a given key column.
-class modularity.IndexedCache
-
-  constructor: (@key = 'id') ->
-    @cache = new modularity.Cache
-
-
-  add: (entry) ->
-    @cache.add entry[@key], entry
-
-
-  add_all: (entries) ->
-    @add(entry) for entry in entries
-
-
-  remove: (entry_id) ->
-    @cache.remove entry_id
-
-
-  remove_many: (entry_ids) ->
-    @cache.remove_many entry_ids
-
-
-  get: (key) ->
-    @cache.get key
-
-
-  length: => @cache.length()
-

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

@@ -1,238 +0,0 @@
-#= require modularity/data/ajax_loader
-#= require modularity/data/indexed_cache
-#= require modularity/tools/object_tools
-
-# Provides persistence services for data models.
-#
-# This class operates against a standard RESTful data API, whole path is given in params.url.
-# 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.
-# *
-class modularity.PersistenceManager
-
-  constructor: (params) ->
-
-    # Copy of the data as it is on the server.
-    @server_data = new modularity.IndexedCache
-
-    # Copy of the data as it is on the client.
-    @client_data = new modularity.IndexedCache
-
-    # The base url on the server. Expected to be a fully RESTful API.
-    @base_url = params.url
-
-    # Name of the 'id' column for models.
-    @key = params.key or 'id'
-
-    # Name of the model class (e.g. "user").
-    @model_name = params.model_name
-
-    # For handling parallel requests to the server.
-    @loader = new modularity.AjaxLoader { cache: no }
-
-
-  # Adds the given data objects to the server cache.
-  add_all: (data) ->
-    @server_data.add_all data
-
-
-  # Returns an array containing only the changed objects.
-  # Each object contains only the changed columns + key column.
-  changed_objects_columns: (objects) ->
-    modularity.tap [], (result) =>
-      for object in objects
-        diff = modularity.object_diff @server_data.get(object[@key]), object
-        continue if modularity.object_length(diff) == 0
-        diff[@key] = object[@key]
-        result.push(diff)
-
-
-  # Returns the URL to access the collection of objects.
-  collection_url: ->
-    "#{@base_url}.json"
-
-
-  # Creates the given object on the server.
-  create: (obj, success_callback, error_callback) ->
-    data = {}
-    data[@model_name] = obj
-
-    jQuery.ajax
-      url: @collection_url()
-      type: 'POST'
-      data: data
-      success: (server_response) =>
-        server_obj = server_response[@model_name]
-        @server_data.add server_obj
-        success_callback server_obj
-      error: (xhr) =>
-        error_callback(xhr.responseText) if error_callback
-
-
-  # Deletes the given object from the server.
-  delete: (obj, success_callback, error_callback) ->
-    @client_data.remove obj
-    @server_data.remove obj
-    jQuery.ajax
-      url: @entry_url(obj)
-      type: 'DELETE'
-      success: ->
-        success_callback() if success_callback?
-      error: (xhr) ->
-        error_callback(xhr.responseText) if error_callback
-
-
-  # Deletes the given objects from the server.
-  delete_many: (object_ids, success_callback, error_callback) ->
-    @client_data.remove_many object_ids
-    @server_data.remove_many object_ids
-    jQuery.ajax
-      url: @base_url
-      type: 'DELETE'
-      data: {ids: object_ids}
-      success: ->
-        success_callback() if success_callback?
-      error: (xhr) ->
-        error_callback(xhr.responseText) if error_callback
-
-
-  # Returns the url to access a single entry.
-  entry_url: (entry) ->
-    "#{@base_url}/#{entry[@key]}.json"
-
-
-  # Returns the url to access the collection of entries.
-  entries_url: ->
-    "#{@base_url}.json"
-
-
-  # Returns the cached data object, or undefined.
-  get_cached: (key) ->
-
-    # Try to use client_data cache.
-    client_obj = @client_data.get key
-    return client_obj if client_obj
-
-    # No data in client cache --> try to use server cache.
-    server_obj = @server_data.get key
-    if server_obj
-      client_obj = modularity.clone_hash server_obj
-      @client_data.add client_obj
-      return client_obj
-
-    # Object not found in client or server cache.
-    return undefined
-
-
-  # 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
-
-    # No data on client at all --> load data from server.
-    @loader.get "#{@base_url}/#{key}", (server_entry) =>
-      @server_data.add server_entry
-      client_entry = modularity.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
-
-
-  # 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
-
-    if missing_ids.length == 0
-      return success_callback(entries)
-
-    alert "uncached entries found: #{missing_ids}"
-
-
-  # Saves the given object.
-  # Does the right thing (create or update) dependent on
-  # whether the object already has a key parameter.
-  save: (obj, success_callback, error_callback) ->
-    if obj[@key]?
-      @update obj, success_callback, error_callback
-    else
-      @create obj, success_callback, error_callback
-
-
-  # Updates the given object.
-  #
-  # The given object must exist on the server already,
-  # and have a proper value in the key attribute.
-  update: (obj, success_callback, error_callback) ->
-
-    # Handle updating several objects.
-    return @update_many(obj, success_callback, error_callback) if $.type(obj) == 'array'
-
-    # Create a new hash, containing only the changed attributes between obj and it's replica in @server_data.
-    diff_obj = modularity.object_diff @server_data.get(obj[@key]), obj
-    if modularity.object_length(diff_obj) == 0
-      success_callback obj if success_callback
-      return
-
-    # Send to server
-    data = {}
-    data[@model_name] = diff_obj
-    jQuery.ajax
-      url: @entry_url(obj)
-      type: 'PUT'
-      data: data
-      success: (server_response) =>
-        server_obj = server_response[@model_name]
-        @server_data.add server_obj
-        client_obj = modularity.clone_hash server_obj
-        @client_data.add client_obj
-        success_callback client_obj if success_callback
-      error: (xhr) ->
-        error_callback(xhr.responseText) if error_callback
-
-
-  # Bulk-updates the given objects.
-  # All the existing objects must exist on the server already,
-  # and have a value in the key attribute.
-  update_many: (objects, success_callback, error_callback) ->
-
-    # Find all objects that have been changed on the client.
-    diff_objects = @changed_objects_columns objects
-
-    # Send to server
-    data = {}
-    data["#{@model_name}s"] = diff_objects
-    jQuery.ajax
-      url: @entries_url()
-      type: 'PUT'
-      data: data
-      success: (server_response) =>
-        server_objects = server_response["#{@model_name}s"]
-        client_objects = (for server_object in server_objects
-          @server_data.add server_object
-          client_object = modularity.clone_hash server_object
-          @client_data.add client_object
-          client_object)
-        success_callback(client_objects) if success_callback
-      error: (xhr) ->
-        error_callback(xhr.responseText) if error_callback