rsjudge17 / backplanejs Goto Github PK

The Drupal module requires administrators to add a string value to identify 
each library. This should 
be changed so that the identifier is generated automatically.

The compressed CSS files are unusable in all browsers.

A temporary workaround has been placed into the build process that simply 
overwrites the compressed file with the uncompressed one.

In other words, backplane-min.css is not actually compressed.

Most of the rules for adding components to the library are defined in 
'generate-css.css'. This file is 
very difficult to maintain because it contains rules for both HTML and XTML 
mode.

Instead, we should specify the rules programmatically, as part of the call to 
the decorator object, 
and the decorator itself can add the rules to the stylesheets.

The first step of xforms-refresh event handling is to reevaluate all UI 
bindings:

http://www.w3.org/TR/xforms11/#evt-refresh

This is handled by the Model.rewire() method which in turn calls the 
Control.rewire() method for each control. Currently the control is being forced 
to rewire, regardless of whether any dependent data has changed.

The Model.rewire() needs to check whether a dependent value has changed, 
and only call the Control.rewire() method if there is anything to do.

There are a range of Selenium tests in the Ubiquity XForms library that we 
should make available via 
Google App Engine.

The pe-value part of xf:range currently uses YUI-specific functions. These need 
to be replaced with 
a shim as part of the 'any library' work.

The first thing that the setState() function does is to remove the 'on' and 
'off' 
classes for the state that it is dealing with.

This is as a precursor to setting the correct state, but is wasteful in the 
situation where the class is already present (when enabling) or already absent 
(when disabling).

It would be better to only remove the 'off' class when enabling, and remove 
the 'on' class when disabling, and further, to check whether the class is 
present.

When using xf:submission with @replace='instance', if the response XML has
a Content-Type header set to application/soap+xml (the product of a SOAP
request), the library generates an xforms-submit-error with an error type
of 'resource-error'.

It's expected that any XML with a Content-Type of application/*+xml would
be treated as XML and not generate xforms-submit-errors.

Example form to follow.

The method submission.contentTypeIsXML() aims to establish whether data 
received from a submission is XML.

The method checks for 'text/xml' and 'application/xml', but fails to take into 
account whether there is a charset, as defined here:

http://www.w3.org/International/O-HTTP-charset

The Ant tasks to create a Drupal module and upload it to the download area, are 
currently in the 
main build.xml.

It would be useful to create a 'local' build.xml that resides in the Drupal 
directory, so as to make the 
Drupal module self-contained, and also make the master build.xml easier to 
manage.

The Drupal module correctly adds the script element for a library, but doesn't 
add a reference to the 
CSS. This should be added.

The Ant tasks to combine JS and CSS files is used by running:

  ant compile

This makes use of Sprocketize, a Ruby on Rails gem, and whilst it works on 
Mac OS, it doesn't run on Windows.

Toggling between cases is slow, particularly on Internet Explorer.

The Drupal module was written to cope with the numerous Ubiquity libraries, but 
since these have 
all been merged into backplanejs, this module can be simpler.

The first change is therefore to only use one library, and the second is to use 
version numbers for 
the library to load, rather than a full URL.

The RDFa loader file is currently in the build directory, whilst the source is 
in the RDFa directory.

To assist YUI Doc processing, the loader file needs to be moved alongside the 
source.

What steps will reproduce the problem?

1. Open the following URL in Firefox
http://67.202.30.116/basic-authentication.html
2. Click 'Submit' trigger to trigger submission
3. Submission fails to get beyond xforms-submit

What is the expected output? What do you see instead?

I expect two separate modal xf:messages, one each for xforms-submit and
xforms-submit-done followed by the display of a list of financial product
names.

Please use labels and text to provide additional information.

The submission tries to retrieve the following file that is protected by
HTTP Basic authentication
http://xforms.localhost/protected/inst-product-list-complex.html.

The form xf:submission includes an xf:header element child element that
supplies the 'Authorization' header details and username/password details
as a base64 encoded string.

The form does what's expected when it's loaded with Internet Explorer
(tested with IE 7).

Firefox version tested with was 3.5.5.

An important long-term goal for both backplanejs and Ubiquity XForms is to be 
able to use any 
Ajax library as the foundation.

The library currently works with YUI, but Dojo, jQuery and Prototype are also 
important targets.

To achieve this, all YUI modules will need to be loaded via platform-specific 
loader files, so that 
these files can easily be switched out.

Also, all current YUI-related functions will need to be moved to a common 
object, to make it easy 
to replace them.

The modules that load other files, such as core.js, xforms.js, and so on, also 
load YUI files.

Move all of these references to a common file (called platform-yui.js) to make 
it easy to replace it 
with the equivalent, for a different Ajax library.

After the Drupal module is installed on a Drupal site it should be possible to 
add the backplanejs 
library to any node. Whilst the library selection is displaying correctly, any 
change to the value is not 
saved.

Using Safari 4, select and select1 controls, in their various guises, all 
suffer from differing levels of appearance problems. Also, possibly as a 
side-effect of these display issues, in many cases they do not work as 
expected, e.g. selecting items has no effect.

In Safari 4, XForms documents that contain non-relevant controls styled to 
be display:none or visibility:hidden, have the appearance of not working 
until some other seemingly unconnected event causes the browser to repaint 
the window. For instance, invoking an XForms message or opening the Web 
Inspector both have the effect of hiding the irrelevant controls, all of a 
sudden.

The same issue can be observed in forms that contain switch/case 
constructs.

I believe this may be a browser issue that we need to work around, because 
I've verified that we are correctly setting the appropriate CSS classes on 
the items in question at the correct juncture.

YUI Doc needs to be callable from Ant.

YUI Doc is the YUI tool for creating documentation from comments in source 
code. It's very similar 
to JSDoc, but I've read good things about YUI Doc, so I'm going to go with that.

The YUI Compressor is used to minify the concatenated script and CSS files, 
during the compile phase. It doesn't work on Windows.

There are a number of places in the library where we make direct use of the YUI 
library.

These references need to be moved to a single object, so that switching to 
other libraries is easier.

Alex Sansom wrote:

  I'd expect to be able to use the format-number() function in XPath statements for things
  like displaying something like an invoice total.

  Sample form attached.

An empty safe CURIE looks like this:

  @about="[]"

When used in a document the CURIE should be ignored because it's unknown, and 
therefore the 
currently in-scope subject used instead.

See http://backplanejs.appspot.com/rdfa?
url=http://www.w3.org/2006/07/SWD/RDFa/testsuite/xhtml1-testcases/0121.xhtml 
and note 
that the last subject is the XHTML namespace, rather than 'http://example.org'.

As the build.xml file has grown, and the number of build targets has increased 
(we now build 
Drupal modules as well as roll-up files), then the target names have become a 
little disorganised.

There seem to be a number of best practices for naming and organising targets, 
so we should 
follow them.

On how to structure build files, The Elements of Ant Style is useful 
(http://wiki.apache.org/ant/TheElementsOfAntStyle). Nothing in our build files 
goes against this 
guidance at the moment, but it's good to have the reference.

On how to name and organise targets, it might be wise to follow those used in 
the Maven 
(http://maven.apache.org/) project.

The Selenium test framework is currently part of the Ubiquity XForms library, 
and should be moved 
into 'third-party'.

The build tasks are currently hard-coded to use YUI. This should become a 
setting in 
ant.properties.

It's well known that adding and removing classes from HTML elements is 
time-consuming.

We currently use the YUI addClass() and removeClass() functions to set and 
remove classes, but we should also use the hasClass() function to check 
whether we actually need to make the change.

When using @replace="instance" on xf:submission, any retrieved data should 
overwrite the identified instance, and then cause the display to update.

This is not happening in IE and Chrome.

In IE8, if documents are set to use standards mode, the XForms loader doesn't 
work. The same documents can be seen to load correctly in quirks mode.

Some of the recently added tasks, such as starting and stopping a local 
Google App Engine server, would be useful when developing applications that 
use backplanejs. This issue is about making some changes that will allow the 
tasks to be 'called' from elsewhere. (Mainly it's about making sure that all of 
the paths are set explicitly, but there are a few other minor changes that are 
needed.)

The XForms processor currently uses Google's Ajaxslt XML parser, in order to 
provide cross-browser support.

However, this parser is extremely slow in Internet Explorer, so should be 
replaced with native XML support.

Although the Drupal module loads the script files automatically, administrators 
still need to add the 
XForms and XML Events namespaces to their site (usually via an update to their 
templates).

Instead, the Drupal module should automatically add the namespaces to any page 
that includes a 
library.

Reported by Alex Sansom:

When submitting an XML instance using IE (7.0.6002.18005) node elemets 
that are empty do not get included in the submitted data.

E.g., if you send:

<data xmlns=""> <currency-amount currency="GBP" 
amount=""></currency-amount> </data>

Verifying via Fiddler, only:

<data xmlns=""> <currency-amount currency="GBP"></currency-
amount> </data>

gets sent to the resource you've submitted to.

Maybe it's helpful to note that if using the serialize() function with 
xf:output to display the contents of an instance, empty attributes in 
instance data are not shown then either.

Although Sprocketize is a useful piece of code, its use of Rails adds an extra 
dependency.

Instead, we should use Nicholas C. Zakas's Combiner, at:

  <http://github.com/nzakas/combiner>

YUI Doc requires that files are grouped into modules. Since the current code 
layout is for a couple 
of master files in the build directory to 'load' source files located in other 
directories, there is a 
conflict.

To make it easier for YUI Doc, we need the 'loader' files to be in the same 
directory as their 
corresponding source files.

The Drupal module adds the script tag for the libraries, but uses its own 
methods to do so. This can 
come into conflict with other scripts that are loaded by Drupal itself, so we 
should use the built-in 
method 'drupal_add_js()'.

(Also, when adding CSS support in issue 24, we should also use 
'drupal_add_css()'.)

When developing and debugging client-side xforms, one of the most handy
things to be able to see is the current state of the form instance data. 

In the formsPlayer implementation there is a proprietary function,
HTMLSerialise(), that can be used with an xf:output control that can show
the current state of a form instance/part of an instance.

Using formsPlayer you can do something like:

<xf:output value="fp:HTMLSerialise(instance('inst-data'))">
    <xf:label>Current inst-data contents:</xf:label>
</xf:output>

I'm requesting to be able to do something similar with the backplanejs library.

Alex Sansom reports:

"A test form that replaces an empty instance with some XML served from a 
URL doesn't work. It was mentioned that both the form and the replacement 
data had to be served from the same server and they are.

The test form: http://67.202.30.116/submission.html

The XML that's trying to be inserted: http://67.202.30.116/product-list.xml

The files are located on the 'Drupal websites (Drupal 5.10 + 6.10 v1)' 
server at '/var/www/html/arc_work'."

What steps will reproduce the problem?
1. Generate the tests, using 'ant test-compile'.
2. Run the backplane unit-tests (in 'target/unit-tests/backplane').

What is the expected output? What do you see instead?

All tests should pass, but testFileGetPath is failing with the following 
message:

  FAIL: testFileGetPath: Values should be equal.
  Expected: file://C:/Documents and Settings/Mark Birbeck/My 
Documents/My Projects/backplanejs/target/unit-tests/backplane/test-
file.txt (string)
  Actual:C:\Documents and Settings\Mark Birbeck\My Documents\My 
Projects\backplanejs\target\unit-tests\backplane\test-file.txt (string)

We need an Ant task to create an archive for the Drupal module, and then upload 
it to the download 
area.

YUI provides an object extension function which is used in some places in the 
library. These direct 
uses need to be removed, and replaced with calls to the UX object.

Currently the unit-tests (YUI) and the functional and end-to-end tests 
(Selenium) are run manually 
be developers. It would be better to be able to run the tests from Ant, which 
would make it more 
useful for developers doing TDD, and also allows the tests to be run in CI 
scenarios.

(Note that we do have some level of automation already, from the Buildbot work. 
However, the 
command-line technique used doesn't return the number of tests passed, so it's 
not ideal for TDD 
use by developers.)

Although we use roll-up files for the YUI library, we don't bother for the 
testing framework (they are loaded from a CDN).

This would be a problem when testing offline, but a more pressing issue is 
that we need to use a newer version of YUI Test (see issue 35).

We therefore need to copy the newer version, and create a test driver roll-up 
file.

This is a significant issue with Internet Explorer.

Functions that are repeated frequently, such as getBoundNode() rely on 
EvaluateXPath() to obtain the node that they are bound to. Since this function 
is very slow on IE, overall performance is significantly impacted.

When installing the Drupal module a default entry is made in the database for 
the 0.6.2 version of 
backplanejs. However, the keys are wrong, so the entry is not actually usable.

The fix is probably to just remove this initialisation altogether, since we 
don't know which version of 
backplanejs administrators will install, anyway.

1.. Load an xform in Firefox.
2. Note that the form controls are not displaying correctly.
3. Caused some event, such as by moving the mouse over a control.
4. The forms should become fully rendered.