slender_data 0.5.0 → 0.6.0

data/app/assets/javascripts/slender_data/queries/single_query.coffee

@@ -0,0 +1,81 @@
+#= require slender_data/queries/base_query
+
+
+# Represents a query for a single entry.
+class slender_data.SingleQuery extends slender_data.BaseQuery
+
+  constructor: (query, params) ->
+    super query, params
+
+    # Cache for the currently known entry id of this query.
+    # If undefined, this value will be calculated later on demand.
+    #
+    # Don't use this field directly. Use id() to access it.
+    @_id_value = undefined
+
+    # Cache for the currently known entry of this query.
+    # If undefined, this value will be calculated later on demand.
+    #
+    # Don't use this field directly. Use entry() to access it.
+    @_entry_value = undefined
+
+    # Cache for the currently known entry version for this query.
+    # If undefined, this value will be calculated later on demand.
+    #
+    # Don't use this field directly. Use version() to access it.
+    @_version_value = undefined
+
+    @_store_query query
+
+    # Allows to access the entry through its domain name,
+    # i.e. @user()
+    @[@entry_name] = @entry
+
+    # Allows to access the entry id through its domain name,
+    # i.e. username()
+    @[@id_name] = @id
+
+    # Allows to access the version through its domain name,
+    # i.e. timestamp()
+    @[@version_name] = @version
+
+
+  # Returns the data entry of this query.
+  # This method will be accessed through an alias named after the model name.
+  entry: ->
+    if @_entry_value
+      @_entry_value
+    else
+      throw new Error "Cannot provide the entry because it was not given to this query."
+
+
+  # Returns the id for this query.
+  id: ->
+    unless @_id_value
+      if @_entry_value
+        @_id_value = @_entry_value[@id_name]
+    @_id_value
+
+
+  # Stores the given data.
+  _store_query: (query) ->
+    switch @selector_name()
+      when 'entry'
+        @_entry_value = query.entry
+      when @entry_name
+        @_entry_value = query[@entry_name]
+      when 'id'
+        @_id_value = query.id
+      when @id_name
+        @_id_value = query[@id_name]
+      else
+        throw new Error("Unknown selector name: #{@selector_name()}")
+
+
+  # Returns the desired entry version described by this query.
+  version: ->
+    unless @_version_value
+      if @_entry_value
+        @_version_value = @_entry_value[@version_name] ? @_entry_value.version
+    @_version_value
+

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

@@ -0,0 +1,87 @@
+#= require slender_data/cache
+#= require slender_data/parameterizable
+
+# Provides fast and convenient retrieval of cached objects
+# using Queries.
+#
+# This class understands Queries and their specific configurations,
+# and behaves accordingnly.
+class slender_data.QueryCache extends slender_data.Parameterizable
+
+  constructor: (params) ->
+    super params
+
+    # Storage for the entries.
+    @cache = new slender_data.Cache
+
+
+  # Adds the given entry to this cache.
+  add: (entry) ->
+    if @partial_entries
+      return if @is_full_entry(@get entry: entry)
+    @cache.add entry[@id_name], entry
+    return
+
+  # Adds a clone of the entry described by the given query.
+  add_clone: (entry) ->
+    clone = slender_data.clone_hash entry
+    if @partial_entries
+      return if @is_full_entry(@get entry: entry)
+    @cache.add entry[@id_name], clone
+
+
+  # Adds clones of the given entries to this cache.
+  add_clones: (entries) ->
+    @add_clone(entry) for entry in entries
+
+
+  # Adds all the given entries to this cache.
+  add_many: (entries) ->
+    @add(entry) for entry in entries
+    return
+
+
+  # Adds clones of all entries described by the given multi-query.
+  add_many_as_clones: (entries) ->
+    @add_clone(entry) for entry in entries
+
+
+  # Returns the entry corresponding to the given query.
+  get: (query) ->
+    query = @_querify_single query
+    if (result = @cache.get query.id())
+      if @partial_entries
+        result = undefined if query.full and not @is_full_entry(result)
+      if @versioning
+        result = undefined if query.version() > new slender_data.SingleQuery(entry: result, @params).version()
+    result
+
+  # Returns all entries corresponding to the given multi-query.
+  get_many: (multi_query) ->
+    multi_query = @_querify_multi multi_query
+    found = []
+    missing = []
+    for query in multi_query.transpose()
+      if (entry = @get query)
+        found.push entry
+      else
+        missing.push query.selector_value()
+    found: found, missing: multi_query.replicate(missing)
+
+
+  # Returns the number of stored entries.
+  length: ->
+    @cache.length()
+
+
+  # Removes the entry described by the given query.
+  remove: (query) ->
+    query = @_querify_single query
+    @cache.remove query.id()
+
+
+  # Removes all entries described by the given multi-query.
+  remove_many: (multi_query) ->
+    multi_query = @_querify_multi multi_query
+    @cache.remove_many multi_query.ids()
+

data/lib/slender_data/version.rb

@@ -1,3 +1,3 @@
 module SlenderData
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "slender_data"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,31 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  config.assets.precompile = %w( slender_data.js )
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = false
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  config.assets.precompile = %w( slender_data.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end