zapwhite 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c25ab12f3242c55f77939e13b490e0e43a06acd5
-  data.tar.gz: 017e4bcaf501f92565ffb7c0c1adcd1ec98ae593
+  metadata.gz: 8658aeee48480bf54a4b34c2f47f604bd1794ffb
+  data.tar.gz: b877979084895a497561d98e67304b968f7963c7
 SHA512:
-  metadata.gz: c287d0db17c22631d3c9de92e93683af4dc8a06aed43cfe4866f7069ad76cdc8ea210e0071d32dbef7f62c7e6c4cba615960e7c2cca6875539e48fe80bf4e343
-  data.tar.gz: 0d447308e8b4aebb7c242720c3ae1dc9c65ca62cf378441ae9eb1c2bed8a21c19678d33a57a4924db80c004cee4ccf546eb5ecebc42bff7225e8c3f12f7c51e2
+  metadata.gz: 2ccfe5ec550b04c9b16730359744615d1df941df36f3be9715937c29bf53c98126b577a69f70d1e2fc0f07eb7e3cf1982decce1ca1036cb4ed6556575db68f6a
+  data.tar.gz: 8dfd58c741c1a57322dc22bd9f049fc0fd7e0d46db4a5df94f90d03621630f848f02c2ef806d6ab52bb7f175089592f4980e6a3d0a31391e59c7bb69534af7a3

data/.gitattributes

@@ -1,6 +1,12 @@
+# DO NOT EDIT: File is auto-generated
 * -text
-*.rb text -crlf -binary
-*.rdoc text -crlf -binary
-*.textile text -crlf -binary
-*.txt text -crlf -binary
-*.erb text -crlf -binary
+*.gemspec text
+*.md text
+*.rb text
+*.yml text
+.gitattributes text
+.gitignore text
+.ruby-version text
+Gemfile text
+LICENSE text
+Rakefile text

data/bin/zapwhite

@@ -7,7 +7,9 @@ require 'optparse'
 require 'reality/zapwhite'
 
 @check_only = false
+@generate_gitattributes = true
 @exclude_patterns = []
+@rules = []
 @base_directory = Dir.pwd
 OptionParser.new do |opts|
   opts.banner = 'Usage: zapwhite [options] directory'
@@ -16,6 +18,10 @@ OptionParser.new do |opts|
     @check_only = true
   end
 
+  opts.on('-g', '--[no-]generate-gitattributes', 'Generate the .gitattributes file based on files present on filesystem') do |generate_gitattributes|
+    @generate_gitattributes = generate_gitattributes
+  end
+
   opts.on('-d', '--directory DIR', 'Base directory of git repository') do |base_directory|
     @base_directory = base_directory
   end
@@ -23,6 +29,10 @@ OptionParser.new do |opts|
   opts.on('-e', '--exclude-pattern PATTERN', 'Replace default exclude patterns with pattern(s) specified.') do |pattern|
     @exclude_patterns << pattern
   end
+
+  opts.on('-r', '--rule RULE', 'Additional rule(s) (a.k.a. lines) to add when generating .gitattributes file.') do |rule|
+    @rules << rule
+  end
 end.parse!
 
 unless ARGV.empty?
@@ -32,6 +42,8 @@ end
 
 runner = Reality::Zapwhite.new(File.expand_path(@base_directory))
 runner.check_only = @check_only
+runner.generate_gitattributes = @generate_gitattributes
+runner.additional_gitattribute_rules = @rules
 unless @exclude_patterns.empty?
   runner.exclude_patterns.clear
   @exclude_patterns.each do |exclude_pattern|

data/lib/reality/zapwhite.rb

@@ -22,12 +22,21 @@ module Reality
       @attributes = Reality::Git::Attributes.parse(@base_directory)
       @exclude_patterns = %w(vendor/.* node_modules/.*)
       @check_only = false
+      @additional_gitattribute_rules = []
     end
 
     def exclude_patterns
       @exclude_patterns
     end
 
+    attr_accessor :additional_gitattribute_rules
+
+    attr_writer :generate_gitattributes
+
+    def generate_gitattributes?
+      @generate_gitattributes
+    end
+
     def check_only?
       !!@check_only
     end
@@ -38,9 +47,27 @@ module Reality
     # Return the number of files that need normalization
     def run
       normalize_count = 0
+
+      if generate_gitattributes?
+        output_options = {:prefix => '# DO NOT EDIT: File is auto-generated', :normalize => true}
+        new_gitattributes = generate_gitattributes!
+        new_content = new_gitattributes.as_file_contents(output_options)
+        old_content = File.exist?(@attributes.attributes_file) ? IO.read(@attributes.attributes_file) : nil
+        if new_content != old_content
+          @attributes = new_gitattributes
+          if check_only?
+            puts 'Non-normalized .gitattributes file'
+          else
+            puts 'Fixing: .gitattributes'
+            @attributes.write(output_options)
+          end
+          normalize_count += 1
+        end
+      end
+
       files = {}
 
-      collect_files(files)
+      collect_file_attributes(files)
 
       files.each_pair do |filename, config|
         full_filename = "#{@base_directory}/#{filename}"
@@ -75,23 +102,46 @@ module Reality
 
     private
 
-    def collect_files(files)
+    def generate_gitattributes!
+      attributes = Reality::Git::Attributes.new(@base_directory)
+      template = create_template_gitattributes
+      each_git_filename do |f|
+        full_filename = "#{@base_directory}/#{f}"
+        template.rules_for_path(full_filename).each do |rule|
+          attributes.rule(rule.pattern, rule.attributes.merge(:priority => rule.priority))
+          template.remove_rule(rule)
+        end
+      end
+      self.additional_gitattribute_rules.each do |line|
+        rule = Reality::Git::AttributeRule.parse_line(line)
+        attributes.rule(rule.pattern, rule.attributes.merge(:priority => 2))
+      end
+      attributes
+    end
+
+    def collect_file_attributes(files)
+      each_git_filename do |f|
+        full_filename = "#{@base_directory}/#{f}"
+        if File.exist?(full_filename)
+          attr = @attributes.attributes(f)
+          if attr['text']
+            files[f] = {
+              :dos => (attr['eol'] == 'crlf'),
+              :encoding => attr['encoding'],
+              :nodupnl => attr['dupnl'].nil? ? false : !attr['dupnl'],
+              :eofnl => attr['eofnl'].nil? ? true : !!attr['eofnl']
+            }
+          end
+        end
+      end
+    end
+
+    def each_git_filename
       exclude_patterns = self.exclude_patterns.collect {|s| /^#{s}$/}
 
       in_dir(@base_directory) do
         `git ls-files`.split("\n").each do |f|
-          full_filename = "#{@base_directory}/#{f}"
-          if !exclude_patterns.any? {|p| p =~ f} && File.exist?(full_filename)
-            attr = @attributes.attributes(f)
-            if attr['text']
-              files[f] = {
-                :dos => (attr['eol'] == 'crlf'),
-                :encoding => attr['encoding'],
-                :nodupnl => attr['dupnl'].nil? ? false : !attr['dupnl'],
-                :eofnl => attr['eofnl'].nil? ? true : !!attr['eofnl']
-              }
-            end
-          end
+          yield f unless exclude_patterns.any? {|p| p =~ f}
         end
       end
     end
@@ -140,5 +190,92 @@ module Reality
         Dir.chdir(original_dir)
       end
     end
+
+    def create_template_gitattributes
+      attributes = Reality::Git::Attributes.new(@base_directory)
+      attributes.rule('*', :text => false)
+
+      attributes.dos_text_rule('*.rdl', :eofnl => false)
+      attributes.unix_text_rule('*.sh')
+      attributes.text_rule('*.md')
+      attributes.binary_rule('*.jpg')
+
+      attributes.text_rule('.gitignore')
+      attributes.text_rule('.gitattributes')
+
+      # Ruby defaults
+      attributes.text_rule('Gemfile')
+      attributes.text_rule('*.gemspec')
+      attributes.text_rule('.ruby-version')
+      attributes.text_rule('*.rb')
+      attributes.text_rule('*.yaml')
+      attributes.text_rule('*.yml')
+
+      # Documentation defaults
+      attributes.text_rule('*.txt')
+      attributes.text_rule('*.md')
+      attributes.text_rule('*.textile')
+      attributes.text_rule('*.rdoc')
+      attributes.text_rule('*.html')
+      attributes.text_rule('*.xhtml')
+      attributes.text_rule('*.css', :encoding => 'UTF8')
+      attributes.text_rule('*.js')
+      attributes.binary_rule('*.jpg')
+      attributes.binary_rule('*.jpeg')
+      attributes.binary_rule('*.png')
+      attributes.binary_rule('*.bmp')
+      attributes.binary_rule('*.ico')
+
+      attributes.binary_rule('*.pdf')
+      attributes.binary_rule('*.doc')
+
+      # Common file formats
+      attributes.text_rule('*.json')
+      attributes.text_rule('*.xml')
+      attributes.text_rule('*.xsd')
+      attributes.text_rule('*.xsl')
+      attributes.text_rule('*.wsdl')
+
+      # Build system defaults
+      attributes.text_rule('buildfile')
+      attributes.text_rule('Buildfile')
+      attributes.text_rule('Rakefile')
+      attributes.text_rule('rakefile')
+      attributes.text_rule('*.rake')
+
+      attributes.text_rule('*.graphql')
+      attributes.text_rule('*.graphqls')
+      attributes.text_rule('*.ts')
+      attributes.text_rule('*.tsx')
+      attributes.text_rule('*.ts')
+      attributes.text_rule('*.tsx')
+      attributes.text_rule('Jenkinsfile')
+      attributes.text_rule('*.groovy')
+      attributes.dos_text_rule('*.rdl', :eofnl => false)
+      attributes.text_rule('*.erb')
+      attributes.text_rule('*.sass')
+      attributes.text_rule('*.scss')
+      attributes.text_rule('*.less')
+      attributes.text_rule('*.sql')
+      attributes.text_rule('*.java')
+      attributes.text_rule('*.jsp')
+      attributes.text_rule('*.properties')
+      attributes.rule('*.jar', :binary => true)
+      attributes.text_rule('Dockerfile')
+      attributes.text_rule('LICENSE')
+      attributes.text_rule('CHANGELOG')
+
+      # Shell scripts
+      attributes.dos_text_rule('*.cmd')
+      attributes.dos_text_rule('*.bat')
+      attributes.text_rule('*.sh')
+
+      # Native development files
+      attributes.text_rule('*.c')
+      attributes.binary_rule('*.dll')
+      attributes.binary_rule('*.so')
+
+      attributes
+    end
   end
 end

data/test/helper.rb

@@ -82,7 +82,7 @@ module Reality
 
       in_dir(directory) do
         run_command('git init')
-        run_command("git config --local commit.gpgsign false")
+        run_command('git config --local commit.gpgsign false')
         run_command("git config --local user.name \"Your Name\"")
         run_command("git config --local user.email \"you@example.com\"")
         yield

data/test/reality/test_zapwhite.rb

@@ -9,7 +9,7 @@ TEXT
       write_file('README.md', "Hello\n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 0)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 0)
       assert_equal '', output
     end
   end
@@ -22,7 +22,7 @@ TEXT
       write_file('README.md', "Hello \n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: README.md\n", output
       assert_equal "Hello\n", IO.binread("#{dir}/README.md")
     end
@@ -36,7 +36,7 @@ TEXT
       write_file('Read Me.txt', "Hello \n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: Read Me.txt\n", output
       assert_equal "Hello\n", IO.binread("#{dir}/Read Me.txt")
     end
@@ -50,7 +50,7 @@ TEXT
       write_file('README.md', "Hello \n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: README.md\n", output
       assert_equal "Hello\n", IO.binread("#{dir}/README.md")
     end
@@ -64,7 +64,7 @@ TEXT
       write_file('README.md', 'Hello')
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: README.md\n", output
       assert_equal "Hello\n", IO.binread("#{dir}/README.md")
     end
@@ -78,7 +78,7 @@ TEXT
       write_file('run.bat', "echo hi\n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: run.bat\n", output
       assert_equal "echo hi\r\n", IO.binread("#{dir}/run.bat")
     end
@@ -92,7 +92,7 @@ TEXT
       write_file('README.md', "Hello\n\n\n\n\nHow are you?\n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 1)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 1)
       assert_equal "Fixing: README.md\n", output
       assert_equal "Hello\n\nHow are you?\n", IO.binread("#{dir}/README.md")
     end
@@ -106,7 +106,7 @@ TEXT
       write_file('README.md', "Hello\n\n\n\nHow are you?\n")
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 0)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 0)
       assert_equal '', output
       assert_equal "Hello\n\n\n\nHow are you?\n", IO.binread("#{dir}/README.md")
     end
@@ -120,9 +120,64 @@ TEXT
       write_file('README.md', 'Hello')
     end
     in_dir(dir) do
-      output = run_command("#{ZAPWHITE_BIN}", 0)
+      output = run_command("#{ZAPWHITE_BIN} --no-generate-gitattributes", 0)
       assert_equal '', output
       assert_equal 'Hello', IO.binread("#{dir}/README.md")
     end
   end
+
+  def test_generate_gitattributes
+    dir = create_git_repo do
+      write_file('README.md', "Hello\n")
+    end
+    in_dir(dir) do
+      output = run_command("#{ZAPWHITE_BIN} --generate-gitattributes", 1)
+      assert_equal "Fixing: .gitattributes\n", output
+      assert_equal "Hello\n", IO.binread("#{dir}/README.md")
+      assert_equal "# DO NOT EDIT: File is auto-generated\n* -text\n*.md text\n", IO.binread("#{dir}/.gitattributes")
+    end
+  end
+
+  def test_generate_gitattributes_updates_whitespace_subsequently
+    dir = create_git_repo do
+      write_file('README.md', "Hello  \n")
+    end
+    in_dir(dir) do
+      output = run_command("#{ZAPWHITE_BIN} --generate-gitattributes", 2)
+      assert_equal "Fixing: .gitattributes\nFixing: README.md\n", output
+      assert_equal "Hello\n", IO.binread("#{dir}/README.md")
+      assert_equal "# DO NOT EDIT: File is auto-generated\n* -text\n*.md text\n", IO.binread("#{dir}/.gitattributes")
+    end
+  end
+
+  def test_generate_gitattributes_matches
+    dir = create_git_repo do
+      write_gitattributes_file(<<TEXT)
+# DO NOT EDIT: File is auto-generated
+* -text
+*.md text
+TEXT
+      write_file('README.md', "Hello\n")
+    end
+    in_dir(dir) do
+      output = run_command("#{ZAPWHITE_BIN} --generate-gitattributes", 0)
+      assert_equal '', output
+      assert_equal "Hello\n", IO.binread("#{dir}/README.md")
+      assert_equal "# DO NOT EDIT: File is auto-generated\n* -text\n*.md text\n", IO.binread("#{dir}/.gitattributes")
+    end
+  end
+
+  def test_generate_gitattributes_with_additional_rules
+    dir = create_git_repo do
+      write_file('README.md', "Hello\n")
+    end
+    in_dir(dir) do
+      output = run_command("#{ZAPWHITE_BIN} --generate-gitattributes --rule '*.bin -diff' --rule '*.rxt text'", 1)
+      assert_equal "Fixing: .gitattributes\n", output
+      assert_equal "Hello\n", IO.binread("#{dir}/README.md")
+      assert_equal "# DO NOT EDIT: File is auto-generated\n* -text\n*.md text\n*.bin -diff\n*.rxt text\n", IO.binread("#{dir}/.gitattributes")
+    end
+  end
+
+
 end

data/zapwhite.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{zapwhite}
-  s.version            = '2.4.0'
+  s.version            = '2.5.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.has_rdoc           = false
   s.rdoc_options       = %w(--line-numbers --inline-source --title zapwhite)
 
-  s.add_dependency 'gitattributes', '= 2.4.0'
+  s.add_dependency 'gitattributes', '= 2.9.0'
 
   s.add_development_dependency(%q<minitest>, ['= 5.9.1'])
   s.add_development_dependency(%q<test-unit>, ['= 3.1.5'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zapwhite
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitattributes
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement