1. Olemis Lang
  2. trac-gviz

Commits

Olemis Lang  committed 4821140

Documenting changes before releasing TracGViz 1.4.1

  • Participants
  • Parent commits 816eb06
  • Branches default

Comments (0)

Files changed (2)

File trac-dev/gviz/CHANGES

View file
+
+What's new in version 1.4.1
+---------------------------
+
+- New! The plugin is easy-installable. Modules like `dutest`,  
+  `TracXmlRpcPlugin` and `Pygments` are external dependencies.
+
+- New! Simple test cases (doctests) have been written for RPC handlers 
+  implemented by TracGViz : `TimelineRPC`, `ReportRPC`. They are run 
+  using a minimalistic framework built on top of `dutest` and allowing 
+  to (efficiently) write readable doctests for Trac plugins.
+
+- New! It is possible to select the columns to be returned, their 
+  order, and labels. There is partial support for `SELECT` statement, 
+  since only column names are allowed so far, and full support for 
+  `LABEL` clause.
+
+- New! Added full support for limitting the number of returned rows, 
+  as well as skipping a given number of first rows (i.e. `OFFSET` and 
+  `LIMIT` clauses in GViz QL).
+
+- New! A GViz QL error message is sent back to the caller if the data 
+  source doesn't support the base table specified in `FROM` clause. 
+  This clause has been deprecated in recent versions of the API.
+
+- New! Added data source and infrastructure to convert files containing 
+  tabular data in different formats to the JSON representation 
+  defined by Google Visualization API. It is integrated with Trac 
+  MIME conversions. The contents may be retrieved from anywhere if 
+  the right plugin is implemented. 
+  
+- New! Added GViz provider to convert contents of files under version 
+  control to GViz Data Tables (provided that a MIME conversion is 
+  available). Further optimizations have been deferred.
+
+- New! Added GViz provider to convert files attached to Trac resources 
+  in order to obtain GViz Data Tables (provided that a MIME conversion 
+  is available). Especially implemented to help users like 
+  Robert Obertholtzer. Thanks for the feedback and help !
+
+- New! Included helper to convert CSV files under version control to 
+  GViz API JSON format. Especially implemented to help users like 
+  Robert Obertholtzer. Thanks for the feedback and help !
+
+- New! Added `GVizTableMacro`, a macro that embeds in TracWiki pages 
+  the data tables returned by *LOCAL* GViz data providers (i.e. 
+  instances of `IGVizDataProvider`). It is possible to include custom 
+  parameters (e.g. `tq` for queries written using Google 
+  Visualization API Query Language). The table contents are displayed 
+  using HTML tables, hence neither gadgets nor internet connection 
+  are needed in this case.
+
+- New! Implemented TSV Response Format encoder. It is compliant with 
+  the specification and response is encoded using UTF-16 charset. 
+  Nonetheless `outFileName` parameter is not supported yet.
+
+- New! Added sample TracGViz providers. They illustrate how easy is 
+  to implement custom GViz providers in order to offer your data to 
+  the world.
+
+- New! Added support for `HMAC` (`RFC 2104`) hash by using `hmac` module.
+
+- New! GViz providers list rendered on accessing `/gviz` path.
+
+- CSV and TSV encoders are implemented by using `csv` module in stdlib.
+
+- Include helper to convert CSV attachments to GViz API JSON format.
+
+- It is possible to create reports from remote via XML-RPC API.
+
+- Report SQL is not shown in `ReportRPC.get` if client is not granted 
+  `REPORT_SQL_VIEW` permission.
+
+- Added support in the test suite for adding and loading test data.
+
+- Test cases written for all supported (and unsupported) GVizQL 
+  features.
+
+- Some test cases written for data sources included in TracGViz 1.3.4 
+  that are not about version control. Much more work is needed :(
+
+- The plugin works even if `Pygments` is not installed. In that case 
+  only GViz QL will be missing and thereby all other features will be 
+  available.
+
+- Further precautions to ensure that responses are UTF-8 encoded, 
+  unless otherwise stated.
+
+- Added support for GViz queries (i.e. `tq` parameter) in GViz 
+  TracLinks providers.
+
+- Included provider documentation in a resource file.
+
+- It is possible to iterate over rows and values of `DataTable` 
+  instances.
+
+- Bug fixed: Relative URL converted into absolute in 
+  `ReportRPC.execute` only if needed.
+
+- Bug fixed: Data provided by `GVizChagesetProvider` in columns `chg` 
+  and `target` were exchanged. Now they are in the right place.
+
+- Bug fixed: Details about the latest changeset are shown by 
+  `GVizChagesetProvider` when only `since` and `until` parameters are 
+  specified.
+
+- Bug fixed: Enhanced compatibilty with Trac XmlRpcPlugin=1.0.6 and 
+  the way it handles datetime values. Errors like 
+  `TypeError: unsupported operand type(s) for -: instance and datetime.datetime`
+  and `AttributeError: datetime.datetime object has no attribute value`
+  do not happen anymore.
+
+- Bug fixed #57 : `ValueError` was raised (sometimes) in 
+  `GadgetAliases.__init__` when parsing aliases in config file. Not 
+  anymore.
 
 What's new in version 1.3.4
 ---------------------------

File trac-dev/gviz/TODO

View file
 Outstanding tasks
 -----------------
 
-X Fix #57 : `ValueError` raised in `GadgetAliases.__init__` while 
-  parsing aliases in config file.
-
-X Data provided by `GVizChagesetProvider` in columns `chg` 
-  and `target` needs to be exchanged.
-
-X Details about the latest changeset are shown by `GVizChagesetProvider` 
-  when only `since` and `until` parameters are specified.
-
-X Fix `TypeError` `unsupported operand type(s) for -: instance and datetime.datetime`
-  and `AttributeError` `datetime.datetime object has no attribute value`
-  on accessing ticket data without selecting specific IDs. It seems 
-  that the problem happens because of changes introduced in 
-  different implementations of TracXmlRpc plugin. The former happens 
-  if using version 1.0.6, whereas the later shows up if using version 
-  1.0.0 (but under different circumstances).
-X Add support for GViz queries in GViz TracLinks providers.
-
-X Implement a WikiMacro to embed the data exposed by instances of 
-  `IGVizDataProvider`.
-X Include GVizProviderListMacro.PROVIDER_DOC in a resource file.
-X Ensure that responses are UTF-8 encoded, unless otherwise stated.
-X Iterate over rows and values of `DataTable` instances.
-
-X Implement TSV Response Format encoder. 
-
-X Implement report creation from remote via XML-RPC protocol.
-
-X Do not show report SQL in `ReportRPC.get` if client is not granted 
-  `REPORT_SQL_VIEW` permission.
-
-X Fix convert relative URL into absolute in `ReportRPC.execute` only 
-  if needed.
-
-X Add in `dutest` the doctest suite having `setUp` and `tearDown`. 
-  Use it in RPC tests.
-
-X Write simple tests for RPC handlers implemented by TracGViz : 
-  `TimelineRPC`, `ReportRPC`.
-
-X Add support for adding and loading test data.
-
-X Use correct MIME type in TSV encoder.
-
-X GViz API QL: Allow to select the columns to be returned, their 
-  order, and labels.
-
-X GViz API QL: Add support for limitting the number of returned rows, 
-  as well as skipping a given number of first rows.
-
-X GViz API QL: Ensure that columns are always arranged in the same order (use 
-  GVizQL SELECT clause)
-
-X GViz API QL: Notify that the data source doesn't support the base 
-  table specified in `from` clause.
-
-X GViz API QL: Protect against pygments imports.
-X GViz API QL: Write tests for all supported GVizQL features.
-
-X Make the plugin easy-installable.
-
-X Add support for `HMAC` (`RFC 2104`) hash by using `hmac` module.
-
-X Render GViz provider list on accessing `/gviz` path.
-
-X Implement CSV and TSV encoders by using `csv` module.
-
-X Include helper to convert CSV attachments to GViz API JSON format.
-
-X Provide `dutest` as an external dependency.
-
-X Add data source and infrastructure to convert files containing 
-  tabular data in different formats to the JSON representation 
-  defined by Google Visualization API. The contents may be 
-  retrieved from anywhere (e.g. VCS, attachments, ...).
-
-X Include helper to convert CSV files under version control to GViz 
-  API JSON format.
-
 ~ Write tests for data sources included in TracGViz 1.3.4 that are 
   not about version control.