wq / wq.app Goto Github PK

Also add a debug mode in wq/app.js that triggers debug in wq/pages.js and wq/store.js

Add support for asynchronously resolved context objects. Ideally they would only be called if they appear in the template.

• item.saved -> item.synced
• item.listQuery -> item.modelConf
• See also #20

Need a general solution for ensuring FormData is not lost when round-tripped to localStorage (see comment in wq/app.js).

Solution should ideally work both in the browser and in cordova, but will need a way to save files and/or file references in offline storage. May need to leverage another storage mechanism and/or another library - see #20 and @jeremiahsa's localstore library.

When I edit an annotation, upon saving, it returns to the annotation-detail page. I would like to have a configuration option that will let me choose where to redirect. Perhaps it could be a parameter for app.router.customize_page?

Points display their value when hovered over; extend this to lines using http://bl.ocks.org/mbostock/3902569 as an example.

It seems that sometimes if a list hasn't been prefetched then the callback doesn't fire due to getPageInfo not returning anything.

wq/router.js ensures that jQuery Mobile is not initialized until all routes have been set up. This is useful for ensuring pageshow events work as expected, but makes apps a bit more fragile if anything breaks while configuring routes. The main time this becomes an issue is when using class='ui-page' to avoid a FOUC: the CSS will load and hide the div, but then jQM will never be able to un-hide it.

It might be good to have a fallback function that executes after 500-1000 ms to ensure that jQM is initialized even if the rest of the code fails. The alternative would be to recommend not using class='ui-page' and just rely on ensuring simple HTML is able to function.

Marking as "enhancement" as this isn't strictly a bug in the library (it usually only shows up when there is a bug in application code).

data-json -> data-wq-json, etc.

There are a few places where promises would provide significant benefit over the current callback management routines, in particular in store.js and app.js. Perhaps the q library would be useful.

Move the attachmentTypes configuration from being JavaScript hardcoded in wq/app.js to JSON embedded in the the wq configuration object.

For example,

var attachmentTypes = {
    relationship: {
        'predicate': 'related',
        'type': 'relationshiptype',
        'getTypeFilter': function(page, context) {
            /* jshint unused: false */
            return {'from_type': page};
        },
        'getChoiceList': function(type, context) {
            /* jshint unused: false */
            return type.to_type;
        },
        'getChoiceListFilter': function(type, context) {
            /* jshint unused: false */
            return {};
        },
        'getDefaults': function(type, context) {
            /* jshint unused: false */
            return {
                'type_label': type.name,
                'to_type': type.to_type
            };
        }
    }
};

might become:

{
    "pages": {
        "relationship": {
            "name": "relationship",
            "url": "relationships",
            "list": true,
            "parents": {
                "relationshiptype": [
                    "type"
                ]
            },
            "children": [],

            "attachment": {
                "predicate": "related",
                "type": "relationshiptype",
                "typeFilter": {
                    "from_type": "{{page}}"
                },
                "choiceListPage": "{{type.to_type}}",
                "choiceListFilter": {},
                "getDefaults": {
                    "type_label": "{{type.name}}",
                    "to_type": "{{type.to_type}}",
                }
          }
    }
}

The new localForage-powered wq/store.js, and by extension wq/app.js, will fail if offline storage is disabled or unavailable. This is similar to #37, but the mechanism for handling it will be a bit different. One option would be to find/create a localForage "driver" that stores everything in memory. Another potential workaround would be to do something like this:

localForage.getItem('test').then(function() {
    // Successful, initialize wq/app.js
    app.init(config).then(function() {
        app.jqmInit();
        app.prefetchAll();
    });
}, app.jqmInit); // Failed; initialize "vanilla" jQuery Mobile

This assumes a wq.db-style backend, i.e. that the HTML templates and URL structure were created to render on the server with progressive enhancement in mind.

This is related to #40, except that the error is predictable (easily triggered by disabling cookies on iOS).

Add support for custom REST API actions, e.g. defined via an DRF @action decorator. Then you could define a form like this and have it work via a JSON AJAX call in wq/app.js:

<form action="/listurl/itemid/customaction" method="post">

E.g. if cookies are disabled in iOS.

For example, wq/app.js should be able to hide the spinner if there is an issue loading data.

Specifically, stop vendoring custom versions of external libraries in js/lib, and instead reference the actual repos (or maintained forks if necessary). Could probably use volojs (or bower) for dependency resolution.

The choice fields for drop-downs when they are declared on the model do not display the selected item.

Need an easy way to start a new project (including a shell app.build.json) from the command line.

The main issue is the notifications about inline SVG values that print out the entire value.

When there is more than one foreign key pointing to the same table (or when the foreign key has a different name than the referenced model), the automatically-generated parent dropdowns are ineffective.

For example, overwriting ds.save requires a hack:

define(['wq/store'], function(ds) {

var _dsSave = ds.save;
ds.save = function(data, id, callback) {
    // custom code ...
    _dsSave(data, id, callback);
}

});

With prototypes, this could become:

define(['wq/store'], function(ds) {

ds.save = function(data, id, callback) {
    // custom code ...
    ds.prototype.save(data, id, callback);
}

});

See #20.

When using wq/online on Android devices, the online.js module is sometimes offline, even when online. This results in items going into the outbox.

It seems that navigator.onLine does not always work reliably. I recommend we make an AJAX request to determine if the status is online as a fail safe.

Due to a bug in Android 4.3 and earlier, wq/outbox.js isn't able to upload offline-stored files via AJAX on those versions. Android 4.4 and newer versions are unaffected.

Workarounds include:

• For web apps, ensure the user is using Chrome instead of the stock browser when contributing data.
• For native apps, build the app with the Crosswalk WebView. The Crosswalk webview is available in the latest version of Phonegap Build as a plugin - see Species Tracker's config.xml for an example. Google's multiple APK support could be leveraged so that the Crosswalk-enabled APK would only need to be available for Android 4.3 and earlier.

A better solution would be to fix this within wq/store.js to avoid the need for these workarounds. We'd detect the bug and then upload the file as a base64-encoded string if needed. The REST API (e.g. wq.db) would need to be modified to support file uploads in this format.

Real-world use cases so far have almost always had at most 0 or 1 pages of data stored locally, with subsequent pages rendered on the server. Even if there is a use case for JSON pagination, it's not clear what benefit there is to having each page stored separately on the client - if anything they should be stored in the same place.

Ensure that the automatically generated application cache does not include references to the fallback icon images from jQuery Mobile. They're included now since they're listed in the CSS (though the rule that lists them would normally not be active).

As the first major wq.app module(77f8903#diff-16), wq/store.js is unique in that it is the only major module with no external dependencies (other than shims and jQuery.ajax, the latter which should/could be factored out). It's time to evaluate whether there are any popular third-party localStorage-persisted Model libraries that have arisen in the last 2 years or so that fulfill similar needs and would be worth incorporating.

Specifically, the following actions need to be taken:

• Fully document wq/store.js' existing functionality and API
• Evaluate third party alternatives, and whether any have the same or comparable functionality
• If a replacement is found, determine whether to keep wq/store.js as a compatibility wrapper, or switch to using the new library directly
• If no similar libraries can be found, document why wq/store.js is unique
• In either case, consider splitting out ds.getList() into a separate module (probably wq/model.js)

Replace (or augment) wq command-line utilities with an existing (probably javascript-based) tool like volo. Related to #1.

• Assume config.debug will be set with the Django setting (see wq/wq.db#41) or via wq.yml for non-Django projects.
• Ensure config.debug is applied to initialize e.g. wq/pages.js
• Don't uglify build when DEBUG=True

Update to Python 3.

It's time to integrate a testing framework.

wq/pages.js might more accurately be called wq/router.js, and should probably absorb the current module with that name. Probably do this after #3.

Like #38, but for wq/map.js. This would allow changing at least basemaps and GeoJSON layers via only map config.

This might prove difficult for things like map.config.maps[page].onshow and layerConf.oneach, which are best implemented as JS functions. I guess there's always eval()...

Since pages.register() is really meant to replace jQM's AJAX loading mechanism, it could probably connect to pagebeforeload instead of pagebeforechange.

See discussion in azicchetti/jquerymobile-router#76.

The line charts should be broken into separate segments when there is a significant* gap in the data (e.g. several months in an otherwise daily dataset).

*The definition of significant would need to be computed automatically and customizable.

It would be nice if wq/chart.js could include built-in functionality for displaying units, in particular on the y-axis.

This is due to the use of symlinks.

Preferably all init() functions would take a single config object.

When I try to build, I get this error:

Now opening... ../htdocs-build/build.txt
Traceback (most recent call last):
  File "/Users/josh/.virtualenvs/wq1/bin/wq", line 9, in <module>
    load_entry_point('wq.core==0.8.0', 'console_scripts', 'wq')()
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 700, in __call__
    return self.main(*args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 680, in main
    rv = self.invoke(ctx)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/wq/core/decorators.py", line 19, in invoke
    return super(ConfigGroup, self).invoke(ctx)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 1027, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 873, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 508, in invoke
    return callback(*args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/decorators.py", line 63, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 508, in invoke
    return callback(*args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/decorators.py", line 16, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/wq/app/build/builder.py", line 56, in build
    ctx.invoke(appcache, version=version)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 508, in invoke
    return callback(*args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/decorators.py", line 63, in new_func
    return ctx.invoke(f, obj, *args[1:], **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/click/core.py", line 508, in invoke
    return callback(*args, **kwargs)
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/wq/app/build/appcache.py", line 48, in appcache
    s_js, b_js = _parse_js_buildfile(outdir + '/build.txt')
  File "/Users/josh/.virtualenvs/wq1/lib/python2.7/site-packages/wq/app/build/appcache.py", line 80, in _parse_js_buildfile
    text = open(filename).read()
IOError: [Errno 2] No such file or directory: '../htdocs-build/build.txt'

It's obviously looking for build.txt. Where is this build.txt file? What creates build.txt in the first place?

Integrate leaflet.draw into wq/map.js to support maps in edit views.

As discussed in etianen/django-require#28, it would be nice to have a generic Python lib for executing r.js (or JavaScript in general). This lib could check the system for node, rhino or perhaps anything else that can execute JavaScript code.

Having a separate library in PyPI would also provide a nice succinct way to say "this lib requires the ability to execute JavaScript".

I am currently trying to get wq.app and wq.db up-and-running on Mac OSX Mavericks. I am trying at the moment to run deploy.sh. When deploy, in turn, runs manage.py, I get this error:

env: python3: No such file or directory

This makes perfect sense, as I am not using python 3, but rather 2.7.5. So, I am wondering, should I upgrade to Python3, or can I simply change this directive #!/usr/bin/env python3 to an identifier that references Pyhon 2.7.5?

Or... would I be better served running ubuntu 14.04 LTS like is used in all the documentation? (I'd rather not use a totally different os for development and have to use a whole new set of tools, but if I have to, I will). What do you think?

I have installed the sample application wq.app. I am currently trying to build it. When I go to the app folder, then type wq optimize, I get this:

####################
Optimizing with r.js
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/highlight.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/jquery.mobile.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/jquery.mobile.icons.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/jquery.mobile.structure.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/leaflet.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/leaflet.draw.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/lib/leaflet.markercluster.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/themes.css
Optimizing (standard.keepLines.keepWhitespace) CSS file: /Users/user/Development/python/wqprojectdir/htdocs-build/css/wqproject.css
lib/leaflet.css
  URL not a relative URL, skipping: #default#VML

Tracing dependencies for: wqproject
Error: ENOENT, no such file or directory '/Users/user/Development/python/wqprojectdir/htdocs-build/js/data/config.js'
In module tree:
    wqproject
      wqproject/main
        wqproject/config

Error: Error: ENOENT, no such file or directory '/Users/user/Development/python/wqprojectdir/htdocs-build/js/data/config.js'
In module tree:
    wqproject
      wqproject/main
        wqproject/config

    at Error (native)

I went through the other build steps that come before optimize, and they all worked out fine. What am I missing?

This pattern is quite common at the start of almost every wq/app.js-powered application:

for(var key in app.config.pages) {
    if (app.config.pages[key].list) {
        var url = app.config.pages[key].url;
        ds.prefetch({'url': url});
    }
}

Perhaps it should be the default?

The best solution would be to compute it automatically based on the location of the CSS file (rather than the JS location which is what Leaflet tries to do).

Either way, should probably change wq/map.js so that it works even if L.Icon.Default.imagePath is changed after the module loads (e.g. by the user's own map module).

Center+zoom assumes a specific screen size, which is not the wq way. Better to have users describe the extent of the area they want to show and let Leaflet pick the appropriate zoom level.

When attempting to search for an id and afterwards searching for a different key on the datastore, a 404 error is thrown.

Need to support this workflow:

• Offline, not logged in
• Create item
• Go online
• Authenticate
• Sync outbox

This will also help for cases when users need to re-authenticate for whatever reason.

May need to have a notion of "ownership" of items so you can't get at someone else's outbox?