<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2310] 2013/ahoereth/trunk: Bump to version 0.9.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2310">2310</a></dd>
<dt>Author</dt> <dd>a.hoereth</dd>
<dt>Date</dt> <dd>2013-09-14 19:00:40 +0000 (Sat, 14 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Bump to version 0.9.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013ahoerethtrunkcoderevisionsphp">2013/ahoereth/trunk/code-revisions.php</a></li>
<li><a href="#2013ahoerethtrunkincclasscoderevisionsphp">2013/ahoereth/trunk/inc/class-code-revisions.php</a></li>
<li><a href="#2013ahoerethtrunkreadmetxt">2013/ahoereth/trunk/readme.txt</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#2013ahoerethtrunkdoctxt">2013/ahoereth/trunk/doc.txt</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013ahoerethtrunkcoderevisionsphp"></a>
<div class="modfile"><h4>Modified: 2013/ahoereth/trunk/code-revisions.php (2309 => 2310)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/ahoereth/trunk/code-revisions.php 2013-09-14 03:58:27 UTC (rev 2309)
+++ 2013/ahoereth/trunk/code-revisions.php 2013-09-14 19:00:40 UTC (rev 2310)
</span><span class="lines">@@ -4,7 +4,7 @@
</span><span class="cx"> Plugin URI: http://yrnxt.com/wordpress/code-revisions/
</span><span class="cx"> Description: Brings native code revisions to the WordPress integrated code editors.
</span><span class="cx"> Author: Alexander Höreth
</span><del>-Version: 0.8
</del><ins>+Version: 0.9
</ins><span class="cx"> Author URI: http://yrnxt.com
</span><span class="cx"> License: GPL2
</span><span class="cx">
</span><span class="lines">@@ -25,7 +25,7 @@
</span><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> if ( ! defined( 'CODE_REVISIONS_VER' ) )
</span><del>- define( 'CODE_REVISIONS_VER', '0.8' );
</del><ins>+ define( 'CODE_REVISIONS_VER', '0.9' );
</ins><span class="cx"> if ( ! defined( 'CODE_REVISIONS_NAME') )
</span><span class="cx"> define( 'CODE_REVISIONS_NAME', basename(__FILE__, '.php') );
</span><span class="cx"> if ( ! defined( 'CODE_REVISIONS_DIR' ) )
</span><span class="lines">@@ -69,7 +69,7 @@
</span><span class="cx"> */
</span><span class="cx"> function code_revisions_uninstall() {
</span><span class="cx"> if ( ! current_user_can( 'delete_plugins' ) )
</span><del>- return;
</del><ins>+ return;
</ins><span class="cx">
</span><span class="cx"> $metakey = '_' . str_replace( '-', '_', CODE_REVISIONS_NAME );
</span><span class="cx">
</span></span></pre></div>
<a id="2013ahoerethtrunkdoctxt"></a>
<div class="delfile"><h4>Deleted: 2013/ahoereth/trunk/doc.txt (2309 => 2310)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/ahoereth/trunk/doc.txt 2013-09-14 03:58:27 UTC (rev 2309)
+++ 2013/ahoereth/trunk/doc.txt 2013-09-14 19:00:40 UTC (rev 2310)
</span><span class="lines">@@ -1,28 +0,0 @@
</span><del>-== Documentation ==
-
-= Editor file data =
-`inc/editors.php`
-
-**Themes:**
-
-* `$_REQUEST['theme']` contains the theme-slug.
-* `$_REQUEST['file']` contains the file name without any path information. The theme editor only allows editing for files in the specific theme's root directory.
-* If no specific file was selected both variables are empty and the editor displays the current active theme's `style.css`.
-
-The absolute path to the file can be built like this: `get_theme_root()/$_REQUEST['theme']/$_REQUEST['file']` or `get_theme_root()/current_theme_slug/style.css`
-
-**Plugins:**
-
-* `$_REQUEST['file']` contains the file' relative path from `WP_PLUGIN_DIR`. E.g. `plugin-slug/subfolder/filename.php`
-* One would expect `$_REQUEST['plugin']` to hold the currently viewed plugin's basename or relative url to main file, but it doesn't. It contains the last viewed file (as in `$_REQUEST['file']`). For easier processing we retrieve the plugin main file using the first part of the file path in a call to `get_plugins()`.
-* If no specific file was selected both variables are empty and the editor displays the first file retrieved using `get_plugins()` and `get_plugin_files()`.
-
-**File/Post connection**
-Posts get a title in the style "Package: File" and an slug structured accordingly. Further more the file information (type ['theme'/'plugin'], the package [theme-slug/plugin-main-file] and the file [as in `$_REQUEST['file']`) is saved in a custom post meta associated with the file's post. When the editor is opened we check if a post associated with it exists using the slug.
-
-= Revision viewing =
-`js/editors.js`, `inc/ajax.php`, `inc/metabox.php`, `css/editors.css`
-
-Below the editors a revision list is added. It uses WordPress core functionality for generation and tries to replicate the metabox style known from WordPress post editor pages. To add it we rely on JS and an AJAX request.
-
-For viewing revisions we rely on the native revision viewer, located in `wp-admin/revision.php`. For code viewing purposes some modifications to provide a better (more code-editor like) feeling are applied. For example to handle multi-space indentations at line beginnings and inbetween words (for multi-line alignment) and smaller line spacings.
</del><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="2013ahoerethtrunkincclasscoderevisionsphp"></a>
<div class="modfile"><h4>Modified: 2013/ahoereth/trunk/inc/class-code-revisions.php (2309 => 2310)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/ahoereth/trunk/inc/class-code-revisions.php 2013-09-14 03:58:27 UTC (rev 2309)
+++ 2013/ahoereth/trunk/inc/class-code-revisions.php 2013-09-14 19:00:40 UTC (rev 2310)
</span><span class="lines">@@ -31,7 +31,7 @@
</span><span class="cx"> add_action( 'init', array( $this, 'post_type' ) );
</span><span class="cx"> add_action( 'load-post.php', array( $this, 'redirect' ) );
</span><span class="cx"> add_action( 'wp_restore_post_revision', array( $this, 'restore' ), 10, 2 );
</span><del>- add_action( 'admin_enqueue_scripts', array( $this, 'scripts' ) );
</del><ins>+ add_action( 'admin_enqueue_scripts', array( $this, 'styles' ) );
</ins><span class="cx"> add_filter( 'parent_file', array( $this, 'parentage' ) );
</span><span class="cx">
</span><span class="cx"> $this->metakey = '_' . str_replace( '-', '_', CODE_REVISIONS_NAME );
</span><span class="lines">@@ -64,7 +64,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.4
</span><span class="cx"> */
</span><del>- public function scripts() {
</del><ins>+ public function styles() {
</ins><span class="cx"> if ( ! $this->id = $this->viewing_code_revision() )
</span><span class="cx"> return;
</span><span class="cx">
</span></span></pre></div>
<a id="2013ahoerethtrunkreadmetxt"></a>
<div class="modfile"><h4>Modified: 2013/ahoereth/trunk/readme.txt (2309 => 2310)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/ahoereth/trunk/readme.txt 2013-09-14 03:58:27 UTC (rev 2309)
+++ 2013/ahoereth/trunk/readme.txt 2013-09-14 19:00:40 UTC (rev 2310)
</span><span class="lines">@@ -5,18 +5,18 @@
</span><span class="cx"> Tags: code, revisions, plugin, theme, editors, revision.php
</span><span class="cx"> Author: Alexander Höreth
</span><span class="cx"> Author URI: http://yrnxt.com/
</span><del>-Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=a%2ehoereth%40gmail%2ecom
</del><ins>+Donate link:
</ins><span class="cx"> License: GPLv2 or later
</span><span class="cx"> License URI: http://www.gnu.org/licenses/gpl-2.0.html
</span><span class="cx"> Requires at least: 3.6
</span><span class="cx"> Tested up to: 3.6
</span><del>-Stable tag: 0.8
</del><ins>+Stable tag: 0.9
</ins><span class="cx">
</span><span class="cx"> WordPress native revisions for the theme and plugin editors.
</span><span class="cx">
</span><span class="cx"> == Description ==
</span><span class="cx">
</span><del>-This plugin will help you to keep track of changes made to theme and plugin files through the WordPress code editors. The revisions are handled in a way native to WordPress. Comfortably view revisions using the new revision viewer shipped with WordPress 3.6.
</del><ins>+This plugin will help you to keep track of changes made to theme and plugin files through the WordPress code editors. You no longer need to worry about possibly breaking something with bad changes because you can always return to an older version of the file. Additionally the plugin helps you to redo your changes when they might have been overwritten by a plugin update by easily showing you what changed. The revisions are handled in a way native to WordPress. Comfortably view revisions using the new revision viewer introduced in WordPress 3.6.
</ins><span class="cx">
</span><span class="cx"> This plugin is part of my Google Summer of Code 2013 project at WordPress. You can find more information on [make/core](http://make.wordpress.org/core/tag/code-revisions/).
</span><span class="cx">
</span><span class="lines">@@ -45,3 +45,35 @@
</span><span class="cx">
</span><span class="cx"> = 0.8 =
</span><span class="cx"> * WordPress.org release with uninstall automatism and bug fixes
</span><ins>+
+= 0.9 =
+* Bug fixes, smaller enhancements and readme update
+
+== Developer's Guide ==
+
+_code-revisions.php:_ The main plugin file. It defines constants, loads the other files, instantiates the classes if appropriate and contains the uninstall automatism.
+
+_inc/class-code-revisions.php:_ Loaded on all pages this class does multiple general things. It adds the custom post type required for saving the code revisions (`post_type()`) and redirects the user from the post editor (`wp-admin/edit.php`) to the appropriate code editor (`wp-admin/theme-editor.php` or `wp-admin/plugin-editor.php`) when he tries to view those posts directly (`redirect()`). Further more this class hooks into the WordPress revision restore process to not only restore the post but also the related file (`restore()`) and handles styling the WordPress revision viewer (`wp-admin/revisions.php`) when viewing code revisions so it feels more code-editor-ish (`styles()`).
+
+_inc/code-revisions-editors.php:_ This file contains the `Code_Revisions_Editors` class which, in contrast to the `Code_Revisions` class in `class-code-revisions.php`, is only loaded on the WordPress code editor pages using the `load-plugin-editor.php` and `load-theme-editor.php` hooks. Using either, if available, `POST` and `GET` data or falling back to the appropriate default file the class generates an array containing meta information on the currently viewed file (`generate_meta()`). In an attempt to have as less theme or plugin file specific code this array contains 4 strings:
+
+* type: 'plugin'/'theme'
+* package: theme slug or 'plugin/plugin.php'
+* file: relative file path from the theme's folder or the WordPress plugin directory
+* checksum: md5-checksum of the file
+
+Using this data the plugin can check the database for a related post and retrieve it's id if available (`retrieve()`). The meta information array is stored as custom post meta data alongside a file's post.
+
+When a file is opened in the editor and a related post is found in the database the plugin checks if the post's content and the file's content still match. If they don't the post is updated with the new content (which results in a new revision) and the user is notified about the change using an admin notice (`handle_direct_changes()`).
+
+On file updates through the code editor the plugin checks if the file has actually changed before WordPress writes to it. Only when changes are found a revision needs to be created. If no post is associated with the file yet a new post is created with the old contents. This post is then updated with the new content. This process guarantees that there is a revision with the initial file content to which the user can revert to (`handle_file_update()`). Additionally the plugin tries to do a syntax check for `*.php` files to prevent breaking the WordPress installation (`check_syntax()`). As mostly recommended the plugin utilizes `php -l` for this by writing the new contents to a temporary file. If this feature is not available a more basic check using eval is performed. When a syntax error is found the actual file is not written, but the user is redirected back to the editor with a notification about the error and it's location with line highlighting.
+
+_inc/plugged.php:_ Contains a slightly changed version of the pluggable `wp_text_diff()` function. `wp_text_diff()` is utilized for generating the diffs rendered in the revision viewer. Normally it strips leading, trailing and multiple successive whitespaces. However this behavior is not very helpful when viewing code revisions, wherefore the plugin suppresses it for revisions associated with the custom code revisions post type.
+
+_inc/metabox.php:_ The template for the revision metabox.
+
+_js/editors.js:_ JavaScript for customizing the code editor pages (`wp-admin/plugin-editor.php` and `wp-admin/theme-editor.php`). It adds the revisions metabox below the editors, the revisions text with link next to the 'Update File' button and handles the text replacement and line highlighting when a syntax error was found.
+
+_css/editors.css:_ Styles for the code editors. Enqueued in `inc/class-code-revisions-editors.php -> scripts()`.
+
+_css/viewer.css:_ Styles for the revision viewer (`wp-admin/revisions.php`). Enqueued only when viewing code revisions in `inc/class-code-revisions.php -> styles()`.
</ins><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>