gitattributes 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dc92733e0082ca268d4b9f6abc03e5c8f33cd14
-  data.tar.gz: e2c35f9ec4cebfb13a27d53c56ee2790093bdd91
+  metadata.gz: f2759e748dc351ded9388399184c90221e585fa4
+  data.tar.gz: e0806187ce98ed16a53d968ab396509c0d4b796c
 SHA512:
-  metadata.gz: c9cc69a1152dc647d27a5717ba1bc025a1c954e4d557b93b43200b08d6a9f31480af96ca8361a1fc93a4e437353cf9c95a9ddf1c869cf602c9381ec3328a7808
-  data.tar.gz: b32cc7ac4ab3d2c7cfd3ac508df6f497e7c5cb2bb7a05f4924b58abcaefbf2a8a1e6d3311a430c6f8827449e05b25b485fd82205d0adf8bd0b35c0d11728fc17
+  metadata.gz: c97e8f630ef87a46056c906f655004c3ac15bbf5dd93e4e51eb3a2eb1f07ee8714935e881d7ff805e2b9f5ac8c7ed124af08e73229afa844f30ca6862fdedc36
+  data.tar.gz: a7163bb1a24119ebe960bbd902146b922da59bee50417259a139f8175d188e518f4cfa654bea741bdd8da4aea245a7115194b2b552336ede42cb2497e16834bf

data/README.md

@@ -6,7 +6,62 @@ Classes to parse `.gitattributes` files.
 
 A simple example of it's usage:
 
+### Read an existing .gitattributes
+
+Read an existing file that looks like
+
+```
+README.md text eol=lf
+*.jpg binary
+```
+
+With code that looks like
+
 ```ruby
- attributes = Reality::Git::Attributes.parse('/home/user/myrepo')
- attributes.attributes('README.md') # => { "eol" => "lf }
+require 'reality/gitattributes'
+
+attributes = Reality::Git::Attributes.parse('/home/user/myrepo')
+attributes.attributes('README.md') # => { "text" => true, "eol" => "lf }
+attributes.attributes('*.jpg') # => { "binary" => true }
+```
+
+### Write .gitattributes
+
+```ruby
+require 'reality/gitattributes'
+
+attributes = Reality::Git::Attributes.new('/home/user/myrepo')
+attributes.dos_text_rule('*.cmd')
+attributes.dos_text_rule('*.rdl', :eofnl => false)
+attributes.unix_text_rule('*.sh')
+attributes.text_rule('*.md')
+attributes.binary_rule('*.jpg')
+
+attributes.write_to('/home/user/myrepo/.gitattributes')
+```
+
+produces a file that looks like
+
+```
+*.cmd text eol=crlf
+*.rdl text eol=crlf -eofnl
+*.sh text eol=lf
+*.md text
+*.jpg binary
+```
+
+You could also pass `:prefix` and `:normalize` options to write_to method like
+
+```ruby
+attributes.write_to('/home/user/myrepo/.gitattributes', :normalize => true, :prefix => '# DO NOT EDIT: File is auto-generated')
+```
+
+to produce a file that looks like:
+
+```
+# DO NOT EDIT: File is auto-generated
+*.cmd text eol=crlf
+*.md text
+*.rdl text eol=crlf -eofnl
+*.sh text eol=lf
 ```

data/gitattributes.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{gitattributes}
-  s.version            = '2.1.0'
+  s.version            = '2.2.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']

data/lib/reality/git/attribute_rule.rb

@@ -16,7 +16,7 @@ module Reality #nodoc
   module Git
     # Represents a rule within the attributes file
     class AttributeRule
-      ATTR_ORDER = %w(text crlf binary eofnl)
+      ATTR_ORDER = %w(text binary eol encoding eofnl)
 
       def initialize(pattern, attributes)
         @pattern = pattern

data/lib/reality/git/attributes.rb

@@ -61,12 +61,24 @@ module Reality #nodoc
         @rules << AttributeRule.new(pattern, attributes)
       end
 
+      # Adds a rule for pattern that sets the text attribute.
+      # This means that the file will be stored in the repository with line endings converted to LF
       def text_rule(pattern, attributes = {})
-        rule(pattern, { :text => true, :crlf => false, :binary => false }.merge(attributes))
+        rule(pattern, { :text => true }.merge(attributes))
       end
 
+      # Adds a rule for pattern that sets the text attribute and eol=lf.
+      # This means that the file will be stored in the repository with line endings converted to LF
+      # *and* the local checkout will have line endings converted to LF
+      def unix_text_rule(pattern, attributes = {})
+        text_rule(pattern, { :eol => 'lf' }.merge(attributes))
+      end
+
+      # Adds a rule for pattern that sets the text attribute and eol=crlf.
+      # This means that the file will be stored in the repository with line endings converted to LF
+      # *and* the local checkout will have line endings converted to CRLF
       def dos_text_rule(pattern, attributes = {})
-        text_rule(pattern, { :crlf => true }.merge(attributes))
+        text_rule(pattern, { :eol => 'crlf' }.merge(attributes))
       end
 
       def binary_rule(pattern, attributes = {})

data/test/reality/git/test_attribute_rule.rb

@@ -32,7 +32,7 @@ class Reality::Git::TestAttributeRule < Reality::TestCase
   def test_many_attributes
     rule = Reality::Git::AttributeRule.new('*.rdl', 'eofnl' => false, 'text' => true, 'crlf' => true, 'binary' => false, 'ms-file' => 'RPT', 'age' => '22')
     assert_equal({ 'eofnl' => false, 'text' => true, 'crlf' => true, 'binary' => false, 'ms-file' => 'RPT', 'age' => '22' }, rule.attributes)
-    assert_equal('*.rdl text crlf -binary -eofnl age=22 ms-file=RPT', rule.to_s)
+    assert_equal('*.rdl text -binary -eofnl age=22 crlf ms-file=RPT', rule.to_s)
   end
 
   def test_sorting

data/test/reality/git/test_attributes.rb

@@ -53,7 +53,7 @@ TEXT
     write_standard_file(dir, content)
 
     attributes = Reality::Git::Attributes.parse(dir)
-    assert_equal(['*.textile text -crlf -binary'], attributes.rules.collect {|p| p.to_s})
+    assert_equal(['*.textile text -binary -crlf'], attributes.rules.collect {|p| p.to_s})
 
     assert_equal({}, attributes.attributes('README.md'))
     assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('README.textile'))
@@ -69,7 +69,7 @@ TEXT
     write_standard_file(dir, content)
 
     attributes = Reality::Git::Attributes.parse(dir)
-    assert_equal(['* -text', '*.textile text -crlf -binary'], attributes.rules.collect {|p| p.to_s})
+    assert_equal(['* -text', '*.textile text -binary -crlf'], attributes.rules.collect {|p| p.to_s})
 
     assert_equal({ 'text' => false }, attributes.attributes('README.md'))
     assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('doc/X.textile'))
@@ -241,7 +241,20 @@ TEXT
     attributes.text_rule('*.md')
     attributes.text_rule('*.rake', :eofnl => false)
 
-    assert_equal(['*.md text -crlf -binary', '*.rake text -crlf -binary -eofnl'], attributes.rules.collect {|p| p.to_s})
+    assert_equal(['*.md text', '*.rake text -eofnl'], attributes.rules.collect {|p| p.to_s})
+  end
+
+  def test_add_unix_text_rule
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    attributes.unix_text_rule('*.sh')
+    attributes.unix_text_rule('*.init', :eofnl => false)
+
+    assert_equal(['*.sh text eol=lf', '*.init text eol=lf -eofnl'], attributes.rules.collect {|p| p.to_s})
   end
 
   def test_add_dos_text_rule
@@ -254,7 +267,7 @@ TEXT
     attributes.dos_text_rule('*.cmd')
     attributes.dos_text_rule('*.rdl', :eofnl => false)
 
-    assert_equal(['*.cmd text crlf -binary', '*.rdl text crlf -binary -eofnl'], attributes.rules.collect {|p| p.to_s})
+    assert_equal(['*.cmd text eol=crlf', '*.rdl text eol=crlf -eofnl'], attributes.rules.collect {|p| p.to_s})
   end
 
   def test_add_binary_rule

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitattributes
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest