inkan 1.0.0

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Pat Allan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,54 @@
+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.
+
+h2. Installing
+
+<pre><code>gem install inkan</code></pre>
+
+h2. Usage
+
+h3. Reading
+
+To write the files
+
+<pre><code>inkan = Inkan.new('path/to/file.txt')
+inkan.print 'foo'
+inkan.seal</code></pre>
+
+Or:
+
+<pre><code>Inkan.seal('destination') { |inkan|
+  inkan.print 'foo'
+}</code></pre>
+
+h3. Writing
+
+<pre><code>Inkan.legitimate?('/path/to/file.txt')</code></pre>
+
+h3. Customising
+
+You can customise the header comment using the following settings:
+
+<pre><code>inkan = Inkan.new('/path/to/file.txt')
+inkan.comment        = '/*'            # Default is '#'.
+inkan.comment_suffix = '*/'            # Default is ''.
+inkan.credit         = 'My Magic Code' # Default is 'Generated by Inkan'</code></pre>
+
+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.
+
+h2. Copyright
+
+Copyright (c) 2010 Pat Allan, released under an MIT licence.

data/lib/inkan.rb

@@ -0,0 +1,60 @@
+require 'digest/sha1'
+
+class Inkan
+  attr_accessor :credit, :comment, :comment_suffix
+  
+  def self.legitimate?(file)
+    legit = false
+    
+    File.open(file) do |file|
+      first_line = file.gets
+      legit = !first_line[/\s#{sha(file.read)}\s*\n$/].nil?
+    end
+    
+    legit
+  end
+  
+  def self.seal(file)
+    inkan = new(file)
+    yield inkan
+    inkan.seal
+  end
+  
+  def self.sha(content)
+    Digest::SHA1.hexdigest(content)
+  end
+  
+  def initialize(file)
+    @file = file
+    
+    # Set Defaults
+    @credit         = 'Generated by Inkan'
+    @comment        = '#'
+    @comment_suffix = ''
+  end
+  
+  def print(string)
+    file_content << string
+  end
+  
+  def puts(string)
+    file_content << string << "\n"
+  end
+  
+  def seal
+    File.open(@file, 'w') do |f|
+      f.puts "#{comment} #{credit}. #{sha} #{comment_suffix}"
+      f.print file_content
+    end
+  end
+  
+  private
+  
+  def sha
+    self.class.sha(file_content)
+  end
+  
+  def file_content
+    @file_content ||= ''
+  end
+end

data/spec/inkan_spec.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Inkan" do
+  describe '.legitimate?' do
+    let(:content) { 'foo bar baz' }
+    
+    it "returns true if the file contents match the SHA" do
+      open('/tmp/spec.txt', 'w') do |file|
+        file.puts "# Generated by Inkan: #{Digest::SHA1.hexdigest(content)}"
+        file.print content
+      end
+      
+      Inkan.legitimate?('/tmp/spec.txt').should be_true
+    end
+    
+    it "returns false if the file contents don't match the SHA" do
+      open('/tmp/spec.txt', 'w') do |file|
+        file.puts "# Generated by Inkan: #{Digest::SHA1.hexdigest(content)}"
+        file.puts content
+      end
+      
+      Inkan.legitimate?('/tmp/spec.txt').should be_false
+    end
+    
+    it "returns false if there is no SHA" do
+      open('/tmp/spec.txt', 'w') do |file|
+        file.print content
+      end
+      
+      Inkan.legitimate?('/tmp/spec.txt').should be_false
+    end
+  end
+  
+  describe '.seal' do
+    it "should write the file after closing the block" do
+      Inkan.seal('/tmp/spec.txt') do |inkan|
+        inkan.print 'foo bar baz'
+      end
+      
+      contents = open('/tmp/spec.txt').read
+      contents.should match(/foo bar baz$/)
+      contents.should match(/^# Generated by Inkan/)
+    end
+  end
+  
+  describe '#seal' do
+    let(:inkan) { Inkan.new('/tmp/spec.txt') }
+    
+    it "writes out the contents of the buffer" do
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/foo bar baz$/)
+    end
+    
+    it "adds the credit line to the top of the file" do
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/^# Generated by Inkan/)
+    end
+    
+    it "adds the SHA to the top of the file" do
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      sha = Digest::SHA1.hexdigest("foo bar baz")
+      
+      open('/tmp/spec.txt').read.should match(/#{sha}/)
+    end
+  end
+  
+  describe '#puts' do
+    let(:inkan) { Inkan.new('/tmp/spec.txt') }
+    
+    it "adds an extra new line to the output" do
+      inkan.puts "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/foo bar baz\n$/)
+    end
+  end
+  
+  describe '#credit' do
+    let(:inkan) { Inkan.new('/tmp/spec.txt') }
+    
+    it "defaults to 'Generated by Inkan'" do
+      inkan.credit.should == 'Generated by Inkan'
+    end
+    
+    it "should pass through changes to the file comment" do
+      inkan.credit = "Pat's Magic Code"
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/^# Pat's Magic Code/)
+    end
+  end
+  
+  describe '#comment' do
+    let(:inkan) { Inkan.new('/tmp/spec.txt') }
+    
+    it "defaults to a hash symbol" do
+      inkan.comment.should == '#'
+    end
+    
+    it "should pass through changes to the file credit" do
+      inkan.comment = "//"
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/^\/\/ Generated by Inkan/)
+    end
+  end
+  
+  describe '#comment_suffix' do
+    let(:inkan) { Inkan.new('/tmp/spec.txt') }
+    
+    it "defaults to a blank string" do
+      inkan.comment_suffix.should == ''
+    end
+    
+    it "should pass through changes to the file comment" do
+      inkan.comment_suffix = "*/"
+      inkan.print "foo bar baz"
+      inkan.seal
+      
+      open('/tmp/spec.txt').read.should match(/\*\/\n/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+require 'inkan'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: inkan
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-14 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1876988220
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre5
+        version: 1.5.0.pre5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: yard
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  requirement: *id004
+description: ""
+email: pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- LICENCE
+- README.textile
+- lib/inkan.rb
+- spec/inkan_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/freelancing-god/inkan
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Unique file markers for tracking whether files have been changed.
+test_files: 
+- spec/inkan_spec.rb
+- spec/spec_helper.rb