gitattributes 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ce63e4149e74cf32bbff64049cf633fac63ba63
-  data.tar.gz: 2cb92c1110a46176e0e4e973fd8a0c2c02087186
+  metadata.gz: 4055ed6765e1558b96eebb9b052de3fbfc27eff3
+  data.tar.gz: 34f605af19c5218246de1dcab55ddbb438217c62
 SHA512:
-  metadata.gz: e70fd5e6e915580d2aa0358556ba0e7dd338a2cf451557cc163df5cad9637098be78316c6cd93c0cb1e58e59831e51eafad699be992f34da702fb996f4f6cb37
-  data.tar.gz: 446c351faf8abda62986acb0ea4e2e7b742605baeeab662e04052f2e5509a97ee670683cabc805ea4e0d6144388f2712fd9a8584216e6214469140a9a86c71be
+  metadata.gz: cd290ced985cf1e8f854faffea25d7ed27d7ae260ccca267a43393090e55163590ac167b29d487c4a271bee9cd6c4fce6b6809fe96997219e91e682944bd7bdb
+  data.tar.gz: 65d810237cea85dcb80c1ea0a2be88cd3137e07e59bce344a1aab6956cd7abde8a3e288e2245e747fca6d0e3b9086d04e247c0a69412382aacca65f2006bce92

data/LICENSE

@@ -1,20 +1,202 @@
-Copyright (c) 2017 Peter Donald
-Copyright (c) 2013 Dmitriy Zaporozhets
-
-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.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -7,12 +7,6 @@ Classes to parse `.gitattributes` files.
 A simple example of it's usage:
 
 ```ruby
- attributes = Reality::GitAttributes.new('/home/user/myrepo')
+ attributes = Reality::Git::Attributes.parse('/home/user/myrepo')
  attributes.attributes('README.md') # => { "eol" => "lf }
 ```
-
-## Credit
-
-These classes were extracted from the [gitlab_git](https://gitlab.com/ben.boeckel/gitlab_git) by
-with the gitattribtues code originally authored by Douwe Maan. All credit goes to the original
-authors.

data/gitattributes.gemspec

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

data/lib/reality/git/attribute_rule.rb

@@ -0,0 +1,85 @@
+#
+# 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.
+#
+
+module Reality #nodoc
+  module Git
+    # Represents a rule within the attributes file
+    class AttributeRule
+      ATTR_ORDER = %w(text crlf binary eofnl)
+
+      def initialize(pattern, attributes)
+        @pattern = pattern
+        @attributes = {}
+        @priority = 1
+        attributes.each do |k, v|
+          if k.to_s == 'priority'
+            @priority = v
+          else
+            @attributes[k.to_s] = v
+          end
+        end
+      end
+
+      attr_reader :pattern
+      attr_reader :attributes
+      attr_reader :priority
+
+      def to_s
+        rule = self.pattern
+
+        attributes = self.attributes.dup
+        ATTR_ORDER.each do |key|
+          unless attributes[key].nil?
+            rule = "#{rule}#{attr_value(key, attributes[key])}"
+          end
+        end
+        attributes.keys.sort.each do |key|
+          unless ATTR_ORDER.include?(key)
+            rule = "#{rule}#{attr_value(key, attributes[key])}"
+          end
+        end
+
+        rule
+      end
+
+      # noinspection RubySimplifyBooleanInspection
+      def attr_value(key, value)
+        if true == value
+          " #{key}"
+        elsif false == value
+          " -#{key}"
+        else
+          " #{key}=#{value}"
+        end
+      end
+
+      def eql?(other)
+        self.pattern == other.pattern && self.attributes == other.attributes && self.priority == other.priority
+      end
+
+      def hash
+        self.pattern.hash + self.attributes.hash + self.priority
+      end
+
+      def <=>(other)
+        order = self.priority <=> other.priority
+        if 0 != order
+          order
+        else
+          to_s <=> other.to_s
+        end
+      end
+    end
+  end
+end

data/lib/reality/git/attributes.rb

@@ -0,0 +1,83 @@
+#
+# 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.
+#
+
+module Reality #nodoc
+  module Git #nodoc
+    # Representation of a gitattributes file.
+    class Attributes
+
+      class << self
+        # path - The path to the Git repository.
+        # attributes_file - The path to the ".gitattributes" file. Defaults to "<path>/.gitattributes".
+        # relative_path - The path to which attributes apply. Defaults to direcotyr containing attributes file.
+        def parse(repository_path, attributes_file = nil, relative_path = nil)
+          path = File.expand_path(repository_path)
+          attributes_file ||= "#{path}/.gitattributes"
+          rules = File.exist?(attributes_file) ? Reality::Git::AttributesParser.parse_file(attributes_file) : {}
+          Attributes.new(repository_path, attributes_file, relative_path, rules)
+        end
+      end
+
+      def initialize(repository_path, attributes_file = nil, relative_path = nil, rules = [])
+        @path = File.expand_path(repository_path)
+        @attributes_file = attributes_file || "#{@path}/.gitattributes"
+        @relative_path = relative_path || File.dirname(@attributes_file)
+        @rules = rules
+      end
+
+      attr_reader :attributes_file
+
+      # Returns the attributes for the specified path as a hash.
+      def attributes(path)
+        full_path = File.join(@path, path)
+
+        @rules.reverse.each do |rule|
+          return rule.attributes if File.fnmatch?(File.join(@relative_path, rule.pattern), full_path)
+        end
+
+        {}
+      end
+
+      def write_to(filename, options = {})
+        prefix = options[:prefix].nil? ? '' : "#{options[:prefix]}\n"
+        rules = options[:normalize] ? @rules.dup.sort.uniq : @rules
+        content = rules.collect {|r| r.to_s}.join("\n")
+        content += "\n" unless content.empty?
+        IO.write(filename, prefix + content)
+      end
+
+      def rule(pattern, attributes)
+        @rules << AttributeRule.new(pattern, attributes)
+      end
+
+      def text_rule(pattern, attributes = {})
+        rule(pattern, { :text => true, :crlf => false, :binary => false }.merge(attributes))
+      end
+
+      def dos_text_rule(pattern, attributes = {})
+        text_rule(pattern, { :crlf => true }.merge(attributes))
+      end
+
+      def binary_rule(pattern, attributes = {})
+        rule(pattern, { :binary => true }.merge(attributes))
+      end
+
+      # Returns a list of attribute rules to apply.
+      def rules
+        @rules.dup
+      end
+    end
+  end
+end
+

data/lib/reality/git/attributes_parser.rb

@@ -0,0 +1,104 @@
+# Copyright (c) 2017 Peter Donald
+# Copyright (c) 2013 Dmitriy Zaporozhets
+#
+# 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.
+
+# These classes were extracted from the https://gitlab.com/ben.boeckel/gitlab_git repository
+# with the gitattribtues code originally authored by Douwe Maan. Credit to the original authors.
+
+module Reality #nodoc
+  module Git
+    # Parse the Git attribute file extracting the attributes for file patterns.
+    module AttributesParser
+      class << self
+
+        # Parses the specified Git attributes file.
+        def parse_file(filename)
+          rules = []
+          comment = '#'
+
+          IO.readlines(filename).each do |line|
+            next if line.start_with?(comment) || line.empty?
+
+            pattern, attrs = line.split(/\s+/, 2)
+
+            parsed_attributes = attrs ? parse_attributes(attrs) : {}
+
+            rules << AttributeRule.new(pattern, parsed_attributes)
+          end
+
+          # Newer entries take precedence over older entries.
+          rules
+        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
+      end
+    end
+  end
+end
+

data/lib/reality/gitattributes.rb

@@ -1,123 +1,17 @@
-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
-
+#
+# 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 'reality/git/attribute_rule'
+require 'reality/git/attributes_parser'
+require 'reality/git/attributes'

data/test/reality/git/test_attribute_rule.rb

@@ -0,0 +1,59 @@
+#
+# 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::Git::TestAttributeRule < Reality::TestCase
+  def test_basic_operation
+    rule = Reality::Git::AttributeRule.new('*', 'text' => false)
+    assert_equal({ 'text' => false }, rule.attributes)
+    assert_equal('* -text', rule.to_s)
+    assert_equal(1, rule.priority)
+  end
+
+  def test_priority_specified
+    rule = Reality::Git::AttributeRule.new('*', 'text' => false, 'priority' => 3)
+    assert_equal(3, rule.priority)
+    assert_equal({ 'text' => false }, rule.attributes)
+    assert_equal('* -text', rule.to_s)
+  end
+
+  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)
+  end
+
+  def test_sorting
+    rule1 = Reality::Git::AttributeRule.new('*.a', 'priority' => 2, 'text' => true)
+    rule2 = Reality::Git::AttributeRule.new('*.b', 'priority' => 2, 'text' => true)
+    rule3 = Reality::Git::AttributeRule.new('*.c', 'priority' => 1, 'text' => true)
+    assert_equal(0, rule1 <=> rule1)
+    assert_equal(0, rule2 <=> rule2)
+    assert_equal(0, rule3 <=> rule3)
+    assert_equal(-1, rule1 <=> rule2)
+    assert_equal(1, rule1 <=> rule3)
+    assert_equal(1, rule2 <=> rule3)
+    assert_equal([rule3, rule1, rule2], [rule1, rule2, rule3].sort)
+  end
+
+  def test_eql
+    rule1 = Reality::Git::AttributeRule.new('*.a', 'priority' => 2, 'text' => true)
+    rule2 = Reality::Git::AttributeRule.new('*.a', 'priority' => 3, 'text' => true)
+    assert_equal(true, rule1.eql?(rule1))
+    assert_equal(rule1.hash, rule1.hash)
+    assert_equal(false, rule1.eql?(rule2))
+    assert_not_equal(rule1.hash, rule2.hash)
+  end
+end

data/test/reality/git/test_attributes.rb

@@ -0,0 +1,281 @@
+#
+# 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
+  def test_basic_operation_using_default_attributes
+    content = <<TEXT
+* -text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+
+    assert_equal({ 'text' => false }, attributes.attributes('README.md'))
+  end
+
+  def test_gitattributes_in_non_standard_location
+    content = <<TEXT
+* -text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    attributes_file = "#{dir}/non-standard-gitattributes"
+    write_file(attributes_file, content)
+
+    attributes = Reality::Git::Attributes.parse(dir, attributes_file)
+    assert_equal(attributes_file, attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+
+    assert_equal({ 'text' => false }, attributes.attributes('README.md'))
+    assert_equal({ 'text' => false }, attributes.attributes('docs/README.md'))
+  end
+
+  def test_multi_value_attribute
+    content = <<TEXT
+*.textile text -crlf -binary
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    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({}, attributes.attributes('README.md'))
+    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('README.textile'))
+    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('doc/X.textile'))
+  end
+
+  def test_multi_patterns
+    content = <<TEXT
+* -text
+*.textile text -crlf -binary
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    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' => false }, attributes.attributes('README.md'))
+    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('doc/X.textile'))
+  end
+
+  def test_ignore_comments
+    content = <<TEXT
+# DO NOT EDIT: File is auto-generated
+* -text
+# DO NOT EDIT: File is auto-generated
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+  end
+
+  def test_relative_dir
+    content = <<TEXT
+doc/*.md text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['doc/*.md text'], attributes.rules.collect {|p| p.to_s})
+
+    assert_equal({}, attributes.attributes('README.md'))
+    assert_equal({ 'text' => true }, attributes.attributes('doc/X.md'))
+  end
+
+  def test_gitattributes_in_subdirectory
+    content = <<TEXT
+* -text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    attributes_file = "#{dir}/foo/.gitattributes"
+    write_file(attributes_file, content)
+
+    attributes = Reality::Git::Attributes.parse(dir, attributes_file)
+    assert_equal(attributes_file, attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+
+    assert_equal({}, attributes.attributes('README.md'))
+    assert_equal({ 'text' => false }, attributes.attributes('foo/docs/README.md'))
+  end
+
+  def test_write_to
+    content = <<TEXT
+* -text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+
+    output_filename = "#{dir}/output_gitattributes"
+    attributes.write_to(output_filename)
+
+    assert_equal(<<TEXT, IO.read(output_filename))
+* -text
+TEXT
+  end
+
+  def test_write_to_with_multiple_rules
+    content = <<TEXT
+*.md text
+* -text
+*.java text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['*.md text', '* -text', '*.java text'], attributes.rules.collect {|p| p.to_s})
+
+    output_filename = "#{dir}/output_gitattributes"
+    attributes.write_to(output_filename)
+
+    assert_equal(<<TEXT, IO.read(output_filename))
+*.md text
+* -text
+*.java text
+TEXT
+  end
+
+  def test_write_to_with_normalization
+    content = <<TEXT
+*.md text
+* -text
+*.java text
+*.java text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['*.md text', '* -text', '*.java text', '*.java text'], attributes.rules.collect {|p| p.to_s})
+
+    output_filename = "#{dir}/output_gitattributes"
+    attributes.write_to(output_filename, :normalize => true)
+
+    assert_equal(<<TEXT, IO.read(output_filename))
+* -text
+*.java text
+*.md text
+TEXT
+  end
+
+  def test_write_to_with_prefix
+    content = <<TEXT
+* -text
+TEXT
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.parse(dir)
+    assert_equal("#{dir}/.gitattributes", attributes.attributes_file)
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+
+    output_filename = "#{dir}/output_gitattributes"
+    attributes.write_to(output_filename, :prefix => '# DO NOT EDIT: File is auto-generated')
+
+    assert_equal(<<TEXT, IO.read(output_filename))
+# DO NOT EDIT: File is auto-generated
+* -text
+TEXT
+  end
+
+  def test_add_rule
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    attributes.rule('*', :text => false)
+
+    assert_equal(['* -text'], attributes.rules.collect {|p| p.to_s})
+  end
+
+  def test_add_multiple_rules
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    attributes.rule('*', :text => false)
+    attributes.rule('*.so', :text => false)
+
+    assert_equal(['* -text', '*.so -text'], attributes.rules.collect {|p| p.to_s})
+  end
+
+  def test_add_text_rule
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    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})
+  end
+
+  def test_add_dos_text_rule
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    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})
+  end
+
+  def test_add_binary_rule
+    dir = "#{working_dir}/#{::SecureRandom.hex}"
+
+    attributes = Reality::Git::Attributes.new(dir)
+
+    assert_equal([], attributes.rules.collect {|p| p.to_s})
+
+    attributes.binary_rule('*.jpg')
+    attributes.binary_rule('*.jpg', :category => 3)
+
+    assert_equal(['*.jpg binary', '*.jpg binary category=3'], attributes.rules.collect {|p| p.to_s})
+  end
+
+  def write_standard_file(dir, content)
+    write_file("#{dir}/.gitattributes", content)
+  end
+
+  def write_file(attributes_file, content)
+    FileUtils.mkdir_p File.dirname(attributes_file)
+    IO.write(attributes_file, content)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitattributes
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -54,9 +54,13 @@ files:
 - README.md
 - Rakefile
 - gitattributes.gemspec
+- lib/reality/git/attribute_rule.rb
+- lib/reality/git/attributes.rb
+- lib/reality/git/attributes_parser.rb
 - lib/reality/gitattributes.rb
 - test/helper.rb
-- test/reality/test_gitattributes.rb
+- test/reality/git/test_attribute_rule.rb
+- test/reality/git/test_attributes.rb
 homepage: https://github.com/realityforge/gitattributes
 licenses: []
 metadata: {}

data/test/reality/test_gitattributes.rb

@@ -1,102 +0,0 @@
-#
-# 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::TestGitAttributes < Reality::TestCase
-  def test_basic_operation_using_default_attribtues
-    content = <<TEXT
-* -text
-TEXT
-    dir = working_dir
-    write_standard_file(dir, content)
-
-    attributes = Reality::GitAttributes.new(dir)
-    assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
-
-    assert_equal({ 'text' => false }, attributes.attributes('README.md'))
-  end
-
-  def test_gitattributes_in_non_standard_location
-    content = <<TEXT
-* -text
-TEXT
-    dir = working_dir
-    attributes_file = "#{dir}/non-standard-gitattributes"
-    write_file(attributes_file, content)
-
-    attributes = Reality::GitAttributes.new(dir, attributes_file)
-    assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
-
-    assert_equal({ 'text' => false }, attributes.attributes('README.md'))
-    assert_equal({ 'text' => false }, attributes.attributes('docs/README.md'))
-  end
-
-  def test_multi_value_attribute
-    content = <<TEXT
-*.textile text -crlf -binary
-TEXT
-    dir = working_dir
-    write_standard_file(dir, content)
-
-    attributes = Reality::GitAttributes.new(dir)
-    assert_equal({ "#{dir}/*.textile" => { 'text' => true, 'crlf' => false, 'binary' => false } },
-                 attributes.patterns)
-
-    assert_equal({}, attributes.attributes('README.md'))
-    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('README.textile'))
-    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('doc/X.textile'))
-  end
-
-  def test_multi_patterns
-    content = <<TEXT
-* -text
-*.textile text -crlf -binary
-TEXT
-    dir = working_dir
-    write_standard_file(dir, content)
-
-    attributes = Reality::GitAttributes.new(dir)
-    assert_equal({
-                   "#{dir}/*" => { 'text' => false },
-                   "#{dir}/*.textile" => { 'text' => true, 'crlf' => false, 'binary' => false }
-                 },
-                 attributes.patterns)
-
-    assert_equal({ 'text' => false }, attributes.attributes('README.md'))
-    assert_equal({ 'text' => true, 'crlf' => false, 'binary' => false }, attributes.attributes('doc/X.textile'))
-  end
-
-  def test_ignore_comments
-    content = <<TEXT
-# DO NOT EDIT: File is auto-generated
-* -text
-# DO NOT EDIT: File is auto-generated
-TEXT
-    dir = working_dir
-    write_standard_file(dir, content)
-
-    attributes = Reality::GitAttributes.new(dir)
-    assert_equal({ "#{dir}/*" => { 'text' => false } }, attributes.patterns)
-  end
-
-  def write_standard_file(dir, content)
-    write_file("#{dir}/.gitattributes", content)
-  end
-
-  def write_file(attributes_file, content)
-    FileUtils.mkdir_p File.dirname(attributes_file)
-    IO.write(attributes_file, content)
-  end
-end