Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pat/inkan

Unique file markers for tracking whether files have been changed.
https://github.com/pat/inkan

Last synced: 17 days ago
JSON representation

Unique file markers for tracking whether files have been changed.

Host: GitHub
URL: https://github.com/pat/inkan
Owner: pat
License: mit
Created: 2010-11-14T08:22:18.000Z (about 14 years ago)
Default Branch: master
Last Pushed: 2024-03-02T00:08:05.000Z (10 months ago)
Last Synced: 2024-12-01T16:36:56.122Z (22 days ago)
Language: Ruby
Homepage:
Size: 20.5 KB
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.textile

Awesome Lists containing this project

README

h1. inkan

Inspired by coming features for "Ben Hoskings'":http://benhoskin.gs/ "Babushka":http://babushka.me/, *inkan* is a library for writing out (generated) files and then checking whether they've had (manual) changes made to them.

This is particularly useful for generating configuration files and then wanting to check whether people have edited it before overwriting, but you may find other uses for it.

All it actually does is generate a SHA hash of the file's contents, and adds it as a comment at the top of the file. If the file's contents are changed, the SHA won't match, and then you can decide whether you want to overwrite the file.

The name *inkan* comes from "the Japanese word for a document seal":http://en.wikipedia.org/wiki/Inkan#Japanese_usage.

h2. Installing

gem install inkan

h2. Usage

h3. Reading

To write the files

inkan = Inkan.new('path/to/file.txt')

inkan.print 'foo'

inkan.seal

Or:

Inkan.seal('path/to/file.txt') { |inkan|

  inkan.print 'foo'

}

h3. Writing

Inkan.legitimate?('/path/to/file.txt')

h3. Customising

You can customise the header comment using the following settings:

inkan = Inkan.new('/path/to/file.txt')

inkan.comment_prefix = '/*'            # Default is '#'.

inkan.comment_suffix = '*/'            # Default is ''.

inkan.credit         = 'My Magic Code' # Default is 'Generated by Inkan'

h2. Note on Patches/Pull Requests

The process is (ideally):

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so things don't break in future versions.
* When committing, please don't mess with Rakefile or VERSION file. Unless, of course, you want your own version, but it'd be nice if you keep custom changes in a branch to be easily merged in.
* Send a pull request. Bonus points for topic branches.