gitattributes 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c283708237ba1a58d0f9d1a36eee187bc12020
-  data.tar.gz: 2a4778a8dd6c4143abe7076c68f7cfa2f6dedaa0
+  metadata.gz: 7ce63e4149e74cf32bbff64049cf633fac63ba63
+  data.tar.gz: 2cb92c1110a46176e0e4e973fd8a0c2c02087186
 SHA512:
-  metadata.gz: a232e58683f1ffb0c99e8e8431d37b1f1fb507f722a2c3da65a935fae27e2d47a97c4e811f00114db018f9fcaa4180dfaec914fc51eea3c6dd7eeb5240a66e11
-  data.tar.gz: 8b8e43b2b234988ad277c5cde56b782eb9a8d7999f16d228619d65d676ee7054b6609c09a14ee259c9ec957441bcf881cac6a903089cbe074b5c8eaf3b1f4cfe
+  metadata.gz: e70fd5e6e915580d2aa0358556ba0e7dd338a2cf451557cc163df5cad9637098be78316c6cd93c0cb1e58e59831e51eafad699be992f34da702fb996f4f6cb37
+  data.tar.gz: 446c351faf8abda62986acb0ea4e2e7b742605baeeab662e04052f2e5509a97ee670683cabc805ea4e0d6144388f2712fd9a8584216e6214469140a9a86c71be

data/README.md

@@ -7,7 +7,7 @@ Classes to parse `.gitattributes` files.
 A simple example of it's usage:
 
 ```ruby
- attributes = Reality::Git::Attributes.new(some_repo.path)
+ attributes = Reality::GitAttributes.new('/home/user/myrepo')
  attributes.attributes('README.md') # => { "eol" => "lf }
 ```
 

data/gitattributes.gemspec

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

data/lib/reality/gitattributes.rb

@@ -0,0 +1,123 @@
+module Reality
+  # Class for parsing Git attribute files and extracting the attributes for
+  # file patterns.
+  #
+  # Basic usage:
+  #
+  #     attributes = Reality::Git::Attributes.new(some_repo.path)
+  #
+  #     attributes.attributes('README.md') # => { "eol" => "lf }
+  class GitAttributes
+    # path - The path to the Git repository.
+    # attributes_file - The path to the ".gitattribtues" file. Defaults to "<path>/.gitattribtues".
+    def initialize(repository_path, attributes_file = nil)
+      @path = File.expand_path(repository_path)
+      @attributes_file = attributes_file || "#{@path}/.gitattributes"
+      @patterns = nil
+    end
+
+    # Returns all the Git attributes for the given path.
+    #
+    # path - A path to a file for which to get the attributes.
+    #
+    # Returns a Hash.
+    def attributes(path)
+      full_path = File.join(@path, path)
+
+      patterns.each do |pattern, attrs|
+        return attrs if File.fnmatch?(pattern, full_path)
+      end
+
+      {}
+    end
+
+    # Returns a Hash containing the file patterns and their attributes.
+    def patterns
+      @patterns ||= parse_file
+    end
+
+    private
+
+    # Parses an attribute string.
+    #
+    # These strings can be in the following formats:
+    #
+    #     text      # => { "text" => true }
+    #     -text     # => { "text" => false }
+    #     key=value # => { "key" => "value" }
+    #
+    # string - The string to parse.
+    #
+    # Returns a Hash containing the attributes and their values.
+    def parse_attributes(string)
+      values = {}
+      dash = '-'
+      equal = '='
+      binary = 'binary'
+
+      string.split(/\s+/).each do |chunk|
+        # Data such as "foo = bar" should be treated as "foo" and "bar" being
+        # separate boolean attributes.
+        next if chunk == equal
+
+        key = chunk
+
+        # Input: "-foo"
+        if chunk.start_with?(dash)
+          key = chunk.byteslice(1, chunk.length - 1)
+          value = false
+
+          # Input: "foo=bar"
+        elsif chunk.include?(equal)
+          key, value = chunk.split(equal, 2)
+
+          # Input: "foo"
+        else
+          value = true
+        end
+
+        values[key] = value
+
+        # When the "binary" option is set the "diff" option should be set to
+        # the inverse. If "diff" is later set it should overwrite the
+        # automatically set value.
+        values['diff'] = false if key == binary && value
+      end
+
+      values
+    end
+
+    # Iterates over every line in the attributes file.
+    def each_line
+      full_path = @attributes_file
+
+      return unless File.exist?(full_path)
+
+      File.open(full_path, 'r') do |handle|
+        handle.each_line do |line|
+          yield line.strip
+        end
+      end
+    end
+
+    # Parses the Git attributes file.
+    def parse_file
+      pairs = []
+      comment = '#'
+
+      each_line do |line|
+        next if line.start_with?(comment) || line.empty?
+
+        pattern, attrs = line.split(/\s+/, 2)
+
+        parsed = attrs ? parse_attributes(attrs) : {}
+
+        pairs << [File.join(@path, pattern), parsed]
+      end
+
+      # Newer entries take precedence over older entries.
+      pairs.reverse.to_h
+    end
+  end
+end
+

data/test/helper.rb

@@ -1,9 +1,23 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'securerandom'
 require 'minitest/autorun'
 require 'test/unit/assertions'
-require 'reality/attributes'
+require 'reality/gitattributes'
 
 class Reality::TestCase < Minitest::Test
   include Test::Unit::Assertions
@@ -32,14 +46,6 @@ class Reality::TestCase < Minitest::Test
     end
   end
 
-  def random_local_dir
-    local_dir(random_string)
-  end
-
-  def local_dir(directory)
-    "#{working_dir}/#{directory}"
-  end
-
   def working_dir
     @working_dir ||= "#{workspace_dir}/#{self.class.name.gsub(/[\.\:]/, '_')}_#{name}_#{::SecureRandom.hex}"
   end
@@ -47,8 +53,4 @@ class Reality::TestCase < Minitest::Test
   def workspace_dir
     @workspace_dir ||= File.expand_path(ENV['TEST_TMP_DIR'] || "#{File.dirname(__FILE__)}/../tmp/workspace")
   end
-
-  def random_string
-    ::SecureRandom.hex
-  end
 end

data/test/reality/{test_attributes.rb → test_gitattributes.rb}

@@ -1,14 +1,28 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require File.expand_path('../../helper', __FILE__)
 
-class Reality::TestAttributes < Reality::TestCase
+class Reality::TestGitAttributes < Reality::TestCase
   def test_basic_operation_using_default_attribtues
     content = <<TEXT
 * -text
 TEXT
-    dir = random_local_dir
+    dir = working_dir
     write_standard_file(dir, content)
 
-    attributes = Reality::Git::Attributes.new(dir)
+    attributes = Reality::GitAttributes.new(dir)
     assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
 
     assert_equal({ 'text' => false }, attributes.attributes('README.md'))
@@ -18,11 +32,11 @@ TEXT
     content = <<TEXT
 * -text
 TEXT
-    dir = random_local_dir
+    dir = working_dir
     attributes_file = "#{dir}/non-standard-gitattributes"
     write_file(attributes_file, content)
 
-    attributes = Reality::Git::Attributes.new(dir, attributes_file)
+    attributes = Reality::GitAttributes.new(dir, attributes_file)
     assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
 
     assert_equal({ 'text' => false }, attributes.attributes('README.md'))
@@ -33,10 +47,10 @@ TEXT
     content = <<TEXT
 *.textile text -crlf -binary
 TEXT
-    dir = random_local_dir
+    dir = working_dir
     write_standard_file(dir, content)
 
-    attributes = Reality::Git::Attributes.new(dir)
+    attributes = Reality::GitAttributes.new(dir)
     assert_equal({ "#{dir}/*.textile" => { 'text' => true, 'crlf' => false, 'binary' => false } },
                  attributes.patterns)
 
@@ -50,10 +64,10 @@ TEXT
 * -text
 *.textile text -crlf -binary
 TEXT
-    dir = random_local_dir
+    dir = working_dir
     write_standard_file(dir, content)
 
-    attributes = Reality::Git::Attributes.new(dir)
+    attributes = Reality::GitAttributes.new(dir)
     assert_equal({
                    "#{dir}/*" => { 'text' => false },
                    "#{dir}/*.textile" => { 'text' => true, 'crlf' => false, 'binary' => false }
@@ -70,10 +84,10 @@ TEXT
 * -text
 # DO NOT EDIT: File is auto-generated
 TEXT
-    dir = random_local_dir
+    dir = working_dir
     write_standard_file(dir, content)
 
-    attributes = Reality::Git::Attributes.new(dir)
+    attributes = Reality::GitAttributes.new(dir)
     assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitattributes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Donald
@@ -54,9 +54,9 @@ files:
 - README.md
 - Rakefile
 - gitattributes.gemspec
-- lib/reality/attributes.rb
+- lib/reality/gitattributes.rb
 - test/helper.rb
-- test/reality/test_attributes.rb
+- test/reality/test_gitattributes.rb
 homepage: https://github.com/realityforge/gitattributes
 licenses: []
 metadata: {}

data/lib/reality/attributes.rb

@@ -1,124 +0,0 @@
-module Reality
-  module Git
-    # Class for parsing Git attribute files and extracting the attributes for
-    # file patterns.
-    #
-    # Basic usage:
-    #
-    #     attributes = Reality::Git::Attributes.new(some_repo.path)
-    #
-    #     attributes.attributes('README.md') # => { "eol" => "lf }
-    class Attributes
-      # path - The path to the Git repository.
-      # attributes_file - The path to the ".gitattribtues" file. Defaults to "<path>/.gitattribtues".
-      def initialize(repository_path, attributes_file = nil)
-        @path = File.expand_path(repository_path)
-        @attributes_file = attributes_file || "#{@path}/.gitattributes"
-        @patterns = nil
-      end
-
-      # Returns all the Git attributes for the given path.
-      #
-      # path - A path to a file for which to get the attributes.
-      #
-      # Returns a Hash.
-      def attributes(path)
-        full_path = File.join(@path, path)
-
-        patterns.each do |pattern, attrs|
-          return attrs if File.fnmatch?(pattern, full_path)
-        end
-
-        {}
-      end
-
-      # Returns a Hash containing the file patterns and their attributes.
-      def patterns
-        @patterns ||= parse_file
-      end
-
-      private
-
-      # Parses an attribute string.
-      #
-      # These strings can be in the following formats:
-      #
-      #     text      # => { "text" => true }
-      #     -text     # => { "text" => false }
-      #     key=value # => { "key" => "value" }
-      #
-      # string - The string to parse.
-      #
-      # Returns a Hash containing the attributes and their values.
-      def parse_attributes(string)
-        values = {}
-        dash = '-'
-        equal = '='
-        binary = 'binary'
-
-        string.split(/\s+/).each do |chunk|
-          # Data such as "foo = bar" should be treated as "foo" and "bar" being
-          # separate boolean attributes.
-          next if chunk == equal
-
-          key = chunk
-
-          # Input: "-foo"
-          if chunk.start_with?(dash)
-            key = chunk.byteslice(1, chunk.length - 1)
-            value = false
-
-          # Input: "foo=bar"
-          elsif chunk.include?(equal)
-            key, value = chunk.split(equal, 2)
-
-          # Input: "foo"
-          else
-            value = true
-          end
-
-          values[key] = value
-
-          # When the "binary" option is set the "diff" option should be set to
-          # the inverse. If "diff" is later set it should overwrite the
-          # automatically set value.
-          values['diff'] = false if key == binary && value
-        end
-
-        values
-      end
-
-      # Iterates over every line in the attributes file.
-      def each_line
-        full_path = @attributes_file
-
-        return unless File.exist?(full_path)
-
-        File.open(full_path, 'r') do |handle|
-          handle.each_line do |line|
-            yield line.strip
-          end
-        end
-      end
-
-      # Parses the Git attributes file.
-      def parse_file
-        pairs = []
-        comment = '#'
-
-        each_line do |line|
-          next if line.start_with?(comment) || line.empty?
-
-          pattern, attrs = line.split(/\s+/, 2)
-
-          parsed = attrs ? parse_attributes(attrs) : {}
-
-          pairs << [File.join(@path, pattern), parsed]
-        end
-
-        # Newer entries take precedence over older entries.
-        pairs.reverse.to_h
-      end
-    end
-  end
-end