gitattributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00c283708237ba1a58d0f9d1a36eee187bc12020
+  data.tar.gz: 2a4778a8dd6c4143abe7076c68f7cfa2f6dedaa0
+SHA512:
+  metadata.gz: a232e58683f1ffb0c99e8e8431d37b1f1fb507f722a2c3da65a935fae27e2d47a97c4e811f00114db018f9fcaa4180dfaec914fc51eea3c6dd7eeb5240a66e11
+  data.tar.gz: 8b8e43b2b234988ad277c5cde56b782eb9a8d7999f16d228619d65d676ee7054b6609c09a14ee259c9ec957441bcf881cac6a903089cbe074b5c8eaf3b1f4cfe

data/.gitattributes

@@ -0,0 +1,6 @@
+* -text
+*.rb text -crlf -binary
+*.rdoc text -crlf -binary
+*.textile text -crlf -binary
+*.txt text -crlf -binary
+*.erb text -crlf -binary

data/.gitignore

@@ -0,0 +1,9 @@
+*.iml
+/*.ipr
+/*.iws
+/.rakeTasks
+/Gemfile.lock
+/patch.diff
+/pkg
+/rdoc
+/tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.1
+git:
+  depth: 10
+before_install:
+  - gem update bundler

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# How to Contribute
+
+Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+
+* Fork it
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Commit your changes (`git commit -am 'Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create new Pull Request
+
+Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+
+## How to speed the merging of pull requests
+
+* Describe your changes in the CHANGELOG.
+* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Make commits of logical units.
+* Ensure your commit messages help others understand what you are doing and why.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Maintain the same code style.
+* Maintain the same level of test coverage or improve it.
+
+## Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '= 0.9.2.2'

data/LICENSE

@@ -0,0 +1,20 @@
+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.

data/README.md

@@ -0,0 +1,18 @@
+# gitattributes
+
+[![Build Status](https://secure.travis-ci.org/realityforge/gitattributes.png?branch=master)](http://travis-ci.org/realityforge/gitattributes)
+
+Classes to parse `.gitattributes` files.
+
+A simple example of it's usage:
+
+```ruby
+ attributes = Reality::Git::Attributes.new(some_repo.path)
+ 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/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+desc 'Default Task'
+task :default => [:test, :build]
+
+desc 'Test Task'
+Rake::TestTask.new do |t|
+  files = FileList['test/helper.rb', 'test/**/test_*.rb']
+  t.loader = :rake
+  t.test_files = files
+  t.libs << '.'
+  t.warning = true
+end

data/gitattributes.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name               = %q{gitattributes}
+  s.version            = '1.0.0'
+  s.platform           = Gem::Platform::RUBY
+
+  s.authors            = ['Peter Donald']
+  s.email              = %q{peter@realityforge.org}
+
+  s.homepage           = %q{https://github.com/realityforge/gitattributes}
+  s.summary            = %q{Class to parse gitattributes files.}
+  s.description        = %q{Class to parse gitattributes files.}
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.default_executable = []
+  s.require_paths      = %w(lib)
+
+  s.has_rdoc           = false
+  s.rdoc_options       = %w(--line-numbers --inline-source --title gitattributes)
+
+  s.add_development_dependency(%q<minitest>, ['= 5.9.1'])
+  s.add_development_dependency(%q<test-unit>, ['= 3.1.5'])
+end

data/lib/reality/attributes.rb

@@ -0,0 +1,124 @@
+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

data/test/helper.rb

@@ -0,0 +1,54 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'securerandom'
+require 'minitest/autorun'
+require 'test/unit/assertions'
+require 'reality/attributes'
+
+class Reality::TestCase < Minitest::Test
+  include Test::Unit::Assertions
+
+  def setup
+    self.setup_working_dir
+  end
+
+  def teardown
+    self.teardown_working_dir
+  end
+
+  def setup_working_dir
+    @cwd = Dir.pwd
+
+    FileUtils.mkdir_p self.working_dir
+    Dir.chdir(self.working_dir)
+  end
+
+  def teardown_working_dir
+    Dir.chdir(@cwd)
+    if passed?
+      FileUtils.rm_rf self.working_dir if File.exist?(self.working_dir)
+    else
+      $stderr.puts "Test #{self.class.name}.#{name} Failed. Leaving working directory #{self.working_dir}"
+    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
+
+  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

@@ -0,0 +1,88 @@
+require File.expand_path('../../helper', __FILE__)
+
+class Reality::TestAttributes < Reality::TestCase
+  def test_basic_operation_using_default_attribtues
+    content = <<TEXT
+* -text
+TEXT
+    dir = random_local_dir
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.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 = random_local_dir
+    attributes_file = "#{dir}/non-standard-gitattributes"
+    write_file(attributes_file, content)
+
+    attributes = Reality::Git::Attributes.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 = random_local_dir
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.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 = random_local_dir
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.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 = random_local_dir
+    write_standard_file(dir, content)
+
+    attributes = Reality::Git::Attributes.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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: gitattributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Donald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.9.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+description: Class to parse gitattributes files.
+email: peter@realityforge.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gitattributes.gemspec
+- lib/reality/attributes.rb
+- test/helper.rb
+- test/reality/test_attributes.rb
+homepage: https://github.com/realityforge/gitattributes
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- gitattributes
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Class to parse gitattributes files.
+test_files: []