inkan 1.0.0 → 1.1.0

data/README.textile

@@ -6,6 +6,8 @@ This is particularly useful for generating configuration files and then wanting
 
 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
 
 <pre><code>gem install inkan</code></pre>
@@ -22,7 +24,7 @@ inkan.seal</code></pre>
 
 Or:
 
-<pre><code>Inkan.seal('destination') { |inkan|
+<pre><code>Inkan.seal('path/to/file.txt') { |inkan|
   inkan.print 'foo'
 }</code></pre>
 
@@ -35,7 +37,7 @@ 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_prefix = '/*'            # Default is '#'.
 inkan.comment_suffix = '*/'            # Default is ''.
 inkan.credit         = 'My Magic Code' # Default is 'Generated by Inkan'</code></pre>
 

data/lib/inkan.rb

@@ -1,7 +1,7 @@
 require 'digest/sha1'
 
 class Inkan
-  attr_accessor :credit, :comment, :comment_suffix
+  attr_accessor :credit, :comment_prefix, :comment_suffix
   
   def self.legitimate?(file)
     legit = false
@@ -29,7 +29,7 @@ class Inkan
     
     # Set Defaults
     @credit         = 'Generated by Inkan'
-    @comment        = '#'
+    @comment_prefix = '#'
     @comment_suffix = ''
   end
   
@@ -43,7 +43,7 @@ class Inkan
   
   def seal
     File.open(@file, 'w') do |f|
-      f.puts "#{comment} #{credit}. #{sha} #{comment_suffix}"
+      f.puts "#{comment_prefix} #{credit}. #{sha} #{comment_suffix}"
       f.print file_content
     end
   end

data/spec/inkan_spec.rb

@@ -97,15 +97,15 @@ describe "Inkan" do
     end
   end
   
-  describe '#comment' do
+  describe '#comment_prefix' do
     let(:inkan) { Inkan.new('/tmp/spec.txt') }
     
     it "defaults to a hash symbol" do
-      inkan.comment.should == '#'
+      inkan.comment_prefix.should == '#'
     end
     
     it "should pass through changes to the file credit" do
-      inkan.comment = "//"
+      inkan.comment_prefix = "//"
       inkan.print "foo bar baz"
       inkan.seal
       

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inkan
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-14 00:00:00 +08:00
+date: 2011-07-18 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,13 +27,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: -1876988220
+        hash: 1
         segments: 
         - 1
         - 5
-        - 0
-        - pre5
-        version: 1.5.0.pre5
+        - 1
+        version: 1.5.1
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -60,12 +59,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 23
         segments: 
         - 2
+        - 6
         - 0
-        - 1
-        version: 2.0.1
+        version: 2.6.0
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :development