Skip to content
This repository

tool for diff-based templating / fragmentation control

branch: master
README.md

Fragments

Build Status

Fragments uses concepts from version control to replace many uses of templating languages. Instead of a templating language, it provides diff-based templating; instead of revision control, it provides "fragmentation control".

Fragments is a DRY (Don't Repeat Yourself) violation manager; it is a Multiple Source of Truth engine.

What is diff-based templating?

Generating HTML with templating languages is difficult because templating languages often have two semi-incompatible purposes. The first purpose is managing common HTML elements & structure: headers, sidebars, and footers; across multiple templates. This is sometimes called page "inheritance". The second purpose is to perform idiosyncratic display logic on data coming from another source. When these two purposes can be separated, templates can be much simpler.

Fragments manages this first purpose, common HTML elements and structure, with diff and merge algorithms. The actual display logic is left to your application, or to a templating language whose templates are themselves managed by Fragments.

What is fragmentation control?

The machinery to manage common and different code fragments across multiple versions of a single file already exists in modern version control systems. Fragments adapts these tools to manage common and different versions of several different files.

Each file is in effect its own "branch", and whenever you modify a file ("branch") you can apply ("merge") that change into whichever other files ("branches") you choose. In this sense Fragments is a different kind of "source control"--rather than controlling versions/revisions over time, it controls fragments across many files that all exist simultaneously. Hence the term "fragmentation control".

As I am a linguist, I have to point out that the distinction between Synchronic and Diachronic Linguistics gave me this idea in the first place.

How does it work?

The merge algorithm is a version of Precise Codeville Merge modified to support cherry-picking. Precise Codeville Merge was chosen because it supports accidental clean merges and convergence. That is, if two files are independently modified in the same way, they merge together cleanly. This makes adding new files easy; use Fragment's fork command to create a new file based on other files (or just cp one of your files), change it as desired, and commit it. Subsequent changes to any un-modified, common sections, in that file or in its siblings, will be applicable across the rest of the repository.

Like version control, you run Fragments on the command line each time you make a change to your HTML, not before each page render.

What is it good for?

Fragments was designed with the task of simplifying large collections of HTML or HTML templates. It could replace simpler CMS-managed websites with pure static HTML. It could also handle several different translations of an HTML website, ensuring that the same HTML structure was wrapped around each translation of the content.

But Fragments is also not HTML specific. If it's got newlines, Fragments can manage it. That means XML, CSS, JSON, YAML, or source code from any programming language where newlines are common (sorry, Perl). cFragments is even smart enough to know not to merge totally different files together. You could use it to manage a large set of configuration files for different servers and deployment configurations, for example. Or you could use it to manage bug fixes to that mess of duplicated source files on that legacy project you wish you didn't have to maintain.

In short, Fragments can be used anyplace where you have thought to yourself "this group of files really is violating DRY".

Integration with version control

Fragments has no history; It only stores the previous committed state of a file. Storing history is up to your version control system. But Fragments stores its repository configuration in such a way to allow your version control system to manage it painlessly and obviously. Configuration is stored in a _fragments directory. This directory name is not preceded by a ., and all the files in it are stored as plain text. You want to make sure to run fragments init from your repository root, which is usually at least one directory level above your actual content. Otherwise your _fragments directory may get accidentally deployed to production or interfere with template loaders.

The rename and forget commands in Fragments are written to not interfere with a version control's rename and remove commands, as these commands sometimes need to be used in tandem.

Invisibility

Fragments is invisible to people who don't know it's being used. If you (or someone else) make more than one change to a file, Fragments' apply command allows you to perform chunk-based interactive application of changes, similar to git commit --patch or hg record. So, you can give a single HTML file to your web designer or junior programmer, let him or her modify it as desired. Later, you can selectively apply some of those changes across all other HTML files, while leaving other changes only in the modified file.

Installation

Fragments is on PyPI. You can install it with pip install fragments.

Usage

Fragments installs a fragments command line script. Like version control, the first argument to Fragments is the command. And like version control, you must first $ fragments init a repository, then $ fragments follow some files, then $ fragments commit them. Deliberately different command names are used in some cases, to remind you that Fragments is not version control.

If you are red-green color-blind (protanopic or deutanopic), set the COLORBLIND environment variable to protan or deutan and fragments will use blue instead of green for displaying added lines.

export COLORBLIND=protan

Commands

  • help [COMMAND]

    Display global help, or help for COMMAND if specified.

  • init [FRAGMENTS_ROOT]

    Initialize a new fragments repository. Repository is in a directory named _fragments/, created in either the current working directory, or FRAGMENTS_ROOT if specified.

  • status [[ -l | --limit] STATUS ] [FILENAME [FILENAME ...]]

    Get the current status of the fragments repository, limited to FILENAME(s) if specified. Limit output to files with status STATUS, if present.

  • follow FILENAME [FILENAME ...]

    Start following changes to one or more FILENAME(s).

  • forget FILENAME [FILENAME ...]

    Stop following changes to one or more FILENAME(s).

  • rename OLD_FILENAME NEW_FILENAME or rename OLD_FILENAME [OLD_FILENAME ...] NEW_DIRECTORY

    Rename OLD_FILENAME to NEW_FILENAME or move OLD_FILENAME(s) to NEW_DIRECTORY. Files on disk, including unfollowed files, are moved, if they are not already in the new location.

  • move is an alias for rename

  • diff [[-U | --unified] NUM] [FILENAME [FILENAME ...]]

    Show differences between committed and uncommitted versions, limited to FILENAME(s) if specified.

    -U NUM, --unified NUM number of lines of context to show

  • commit [FILENAME [FILENAME ...]]

    Commit changes to the fragments repository, limited to FILENAME(s) if specified.

  • revert [FILENAME [FILENAME ...]]

    Revert changes to the fragments repository, limited to FILENAME(s) if specified.

  • fork [[-U | --unified] NUM] SOURCE_FILENAME [SOURCE_FILENAME ...] TARGET_FILENAME

    Create a new file in TARGET_FILENAME based on one or more SOURCE_FILENAME(s). Large common sections are preserved; differing sections, and common sections shorter than NUM lines between differing sections, are replaced with one newline for each line or conflict.

  • apply [-i | -a] [[-U | --unified] NUM] SOURCE_FILENAME [TARGET_FILENAME [TARGET_FILENAME ...]]

    Apply changes in SOURCE_FILENAME that were made since last commit, where possible. Limit application to TARGET_FILENAME(s) if specified. Files that conflict in their entirety will be skipped. Smaller conflicts will be written to the file as conflict sections.

    -i, --interactive interactively select changes to apply

    -a, --automatic automatically apply all changes

    -U NUM, --unified NUM number of lines of context to show

    In interactive mode, you can use the following commands:

    • y include this change
    • n do not include this change
    • a include this change and all remaining changes
    • d done, do not include this change nor any remaining changes
    • j leave this change undecided, see next undecided change
    • k leave this change undecided, see previous undecided change
    • ? interactive apply mode help

Future improvements

Preprocessors

Since Fragments is diff-based, it will not do well with minified or otherwise compressed content. Do not expect it to handle changes to your 10,000 character, single line, über-compressed CSS or JavaScript file, or to the inline JavaScript function in an onclick attribute in your HTML. The more newlines there are in your files, the more robust Fragments' merging will be.

Adding preprocessors to enforce consistent newline placement and indentation across all followed files would potentially make Fragments' merging even more robust. The preprocessors would run before commit, fork, and apply, and there would be different preprocessors for different file formats.

Miscellaneous improvements

  • Better command-line completion mode for bash
  • Command-line completion mode for zsh
  • Command aliasing and default configuration
  • Pluggable diff & merge algorithms, if they prove useful

Credits

Fragments is Copyright 2012 by Matt Chisholm, and is released under the BSD License. It is available on GitHub and on PyPI. Many thanks to Ross Cohen for his thoughts on the idea, and for preparing Precise Codeville Merge for use in Fragments.

Something went wrong with that request. Please try again.