git-newline-at-eof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9174c33ef7a822bbbe6b7f0b791bed36d7b3ad19
+  data.tar.gz: f3b93079fee26591df3bc50f29a8176dd6206289
+SHA512:
+  metadata.gz: 373d11b4fdabfcdda3299720c92211f35d4c06e77119bbe434c488e771a24d35694df78e5a287d2ddb68b8f8b478fe314d8869759a0fcaaba77f42e46c44a81d
+  data.tar.gz: e79543fb3b7e4aa15abefda059db662d90043f4b57911d4399d873509acadb1996d677a5b9f85d112460b7939e18479825d259071edf0c77aee6f611235b30f2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+.ruby-version

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.7.0
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git-newline-at-eof.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Code Ass
+
+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,149 @@
+# git-newline-at-eof
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install git-newline-at-eof
+
+## Description
+
+[`POSIX.1-2008`](http://pubs.opengroup.org/onlinepubs/9699919799/) says about [definition of `Line`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206):
+
+> ### 3.206 Line
+> A sequence of zero or more non- \<newline\> characters plus a terminating \<newline\> character.
+
+And also says about [definition of `Text File`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_403):
+
+> ### 3.403 Text File
+> A file that contains characters organized into zero or more lines. The lines do not contain NUL characters and none can exceed {LINE_MAX} bytes in length, including the \<newline\> character. Although POSIX.1-2008 does not distinguish between text files and binary files (see the ISO C standard), many utilities only produce predictable or meaningful output when operating on text files. The standard utilities that have such restrictions always specify "text files" in their STDIN or INPUT FILES sections.
+
+This Git subcommand checks and fixes newlines at end of file in your Git repository.
+
+## Usage
+
+### `--feed-last-line`
+
+Add newline to line what is not terminated by newline at end of file.
+
+```bash
+$ mkdir /tmp/test
+$ cd /tmp/test
+$ printf "" > file0
+$ printf "aaa" > file1
+$ printf "bbb\n" > file2
+$ git init
+Initialized empty Git repository in /tmp/test/.git/
+$ git add .
+$ git commit -m "Initial commit"
+[master (root-commit) 7c4d543] Initial commit
+ 3 files changed, 2 insertions(+)
+ create mode 100644 file0
+ create mode 100644 file1
+ create mode 100644 file2
+$ git newline-at-eof --feed-last-line
+$ git diff
+diff --git a/file1 b/file1
+index 7c4a013..72943a1 100644
+--- a/file1
++++ b/file1
+@@ -1 +1 @@
+-aaa
+
++aaa
+$ git add file1
+$ git commit -m "Fix last line terminator"
+[master aba3275] Fix last line terminator
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+```
+
+### `--discard-last-newline`
+
+Remove discarded newline at end of file.
+
+```bash
+$ mkdir /tmp/test
+$ cd /tmp/test
+$ printf "" > file0
+$ printf "aaa\n" > file1
+$ printf "bbb\n\n\n" > file2
+$ git init
+Initialized empty Git repository in /tmp/test/.git/
+$ git add .
+$ git commit -m "Initial commit"
+[master (root-commit) 1ef005b] Initial commit
+ 3 files changed, 4 insertions(+)
+ create mode 100644 file0
+ create mode 100644 file1
+ create mode 100644 file2
+$ git newline-at-eof --discard-last-newline
+$ git diff
+diff --git a/file2 b/file2
+index 6da7e67..f761ec1 100644
+--- a/file2
++++ b/file2
+@@ -1,3 +1 @@
+ bbb
+-
+-
+$ git add file1
+$ git commit -m "Discard newlines at eof"
+[master 68de945] Discard newlines at eof
+ 1 file changed, 2 deletions(-)
+```
+
+### `--treat-all`
+
+This is identical with `--feed-last-line --discard-last-newline`.
+
+### `--check-all`
+
+Check and show warning about newline at end of file.
+
+```bash
+$ mkdir /tmp/test
+$ cd /tmp/test
+$ printf "" > file0
+$ printf "aaa" > file1
+$ printf "bbb\n\n" > file2
+$ printf "ccc\n\n\n" > file3
+$ git init
+Initialized empty Git repository in /tmp/test/.git/
+$ git add .
+$ git commit -m "Initial commit"
+[master (root-commit) 28cf1f0] Initial commit
+ 4 files changed, 6 insertions(+)
+ create mode 100644 file0
+ create mode 100644 file1
+ create mode 100644 file2
+ create mode 100644 file3
+$ git newline-at-eof --check-all
+file1: no newline at end of file
+file2: discarded 1 newline at end of file
+file3: discarded 2 newlines at end of file
+```
+
+## Supported Versions
+
+- Ruby 2.3
+- Ruby 2.4
+- JRuby 9.1.x.x
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aycabta/git-newline-at-eof.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Badges
+
+[![Build Status](https://travis-ci.org/aycabta/git-newline-at-eof.svg)](https://travis-ci.org/aycabta/git-newline-at-eof)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = Dir[ 'test/**/*_test.rb' ]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "git/newline/at/eof"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/git-newline-at-eof

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# vim: set filetype=ruby:
+$: << File.expand_path('../../lib/', __FILE__)
+
+require 'git-newline-at-eof'
+
+GitNewlineAtEof::Application.new(ARGV).run

data/git-newline-at-eof.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-newline-at-eof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'git-newline-at-eof'
+  spec.version       = GitNewlineAtEof::VERSION
+  spec.authors       = ['Code Ass']
+  spec.email         = ['aycabta@gmail.com']
+
+  spec.summary       = %q{Check and fix newline at end of file in Git respository.}
+  spec.description   = %q{Check and fix newline at end of file in Git respository.}
+  spec.homepage      = 'https://github.com/aycabta/git-newline-at-eof'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+end

data/lib/git-newline-at-eof.rb

@@ -0,0 +1,163 @@
+require 'git-newline-at-eof/version'
+require 'optparse'
+
+module GitNewlineAtEof
+  class Application
+    def initialize(argv)
+      @files = files
+      @is_feed_last_line = false
+      @is_discard_last_newline = false
+      @is_treat_all = false
+      @is_check_all = false
+
+      opt = OptionParser.new
+      opt.on('-f', '--feed-last-line') { |v| @is_feed_last_line = true }
+      opt.on('-d', '--discard-last-newline') { |v| @is_discard_last_newline = true }
+      opt.on('-a', '--treat-all') { |v| @is_treat_all = true }
+      opt.on('-c', '--check-all') { |v| @is_check_all = true }
+      opt.parse!(argv)
+    end
+
+    def run
+      if @is_check_all
+        check_all
+      elsif @is_treat_all
+        treat_all
+      else
+        if @is_feed_last_line
+          feed_last_line_all
+        end
+        if @is_discard_last_newline
+          discard_last_newline_all
+        end
+      end
+    end
+
+    def check_all
+      @files.each do |f|
+        if no_newline?(f[:last_newlines_num])
+          puts "#{f[:filename]}: no newline at end of file"
+        elsif discarded_newline?(f[:last_newlines_num])
+          discarded_num = f[:last_newlines_num] - 1
+          puts "#{f[:filename]}: discarded #{discarded_num} newline#{discarded_num > 1 ? 's' : ''} at end of file"
+        end
+      end
+    end
+
+    def treat_all
+      @files.each do |f|
+        if no_newline?(f[:last_newlines_num])
+          feed_last_line(f[:filename])
+        elsif discarded_newline?(f[:last_newlines_num])
+          discard_last_newline(f[:filename], f[:last_newlines_num] - 1)
+        end
+      end
+    end
+
+    def feed_last_line_all
+      @files.each do |f|
+        if no_newline?(f[:last_newlines_num])
+          feed_last_line(f[:filename])
+        end
+      end
+    end
+
+    def discard_last_newline_all
+      @files.each do |f|
+        if discarded_newline?(f[:last_newlines_num])
+          discard_last_newline(f[:filename], f[:last_newlines_num] - 1)
+        end
+      end
+    end
+
+    def feed_last_line(filename)
+      filepath = current_dir(filename)
+      File.open(filepath, 'at') do |f|
+        f.write("\n")
+      end
+    end
+    private :feed_last_line
+
+    def discard_last_newline(filename, discard_num)
+      filepath = current_dir(filename)
+      lines = nil
+      File.open(filepath, 'rt') do |f|
+        lines = f.readlines
+      end
+      File.open(filepath, 'wt') do |f|
+        lines[0, lines.size - discard_num].each do |l|
+          f.write(l)
+        end
+      end
+    end
+    private :discard_last_newline
+
+    def no_newline?(last_newlines_num)
+      if last_newlines_num.nil?
+        false
+      elsif last_newlines_num == 0
+        true
+      else
+        false
+      end
+    end
+    private :no_newline?
+
+    def discarded_newline?(last_newlines_num)
+      if last_newlines_num.nil?
+        false
+      elsif last_newlines_num > 1
+        true
+      else
+        false
+      end
+    end
+    private :discarded_newline?
+
+    def files
+      `git ls-files`.split("\n").map { |filename|
+        filepath = current_dir(filename)
+        num = 0
+        begin
+          num = File.open(filepath, 'rt') { |f| count_last_newlines(f) }
+        rescue
+          num = nil
+        end
+        {
+          filename: filename,
+          last_newlines_num: num
+        }
+      }
+    end
+    private :files
+
+    def count_last_newlines(f)
+      if f.size == 0
+        nil
+      else
+        count = 0
+        f.size.step(1, -1) do |offset|
+          offset -= 1
+          f.seek(offset, IO::SEEK_SET)
+          if f.getc == "\n"
+            count += 1
+          else
+            break
+          end
+        end
+        count
+      end
+    end
+    private :count_last_newlines
+
+    def repository_toplevel_dir
+      `git rev-parse --show-toplevel`.chomp
+    end
+    private :repository_toplevel_dir
+
+    def current_dir(filename)
+      File.join(repository_toplevel_dir, `git rev-parse --show-prefix`.chomp, filename)
+    end
+    private :current_dir
+  end
+end

data/lib/git-newline-at-eof/version.rb

@@ -0,0 +1,3 @@
+module GitNewlineAtEof
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: git-newline-at-eof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Code Ass
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check and fix newline at end of file in Git respository.
+email:
+- aycabta@gmail.com
+executables:
+- git-newline-at-eof
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-newline-at-eof
+- git-newline-at-eof.gemspec
+- lib/git-newline-at-eof.rb
+- lib/git-newline-at-eof/version.rb
+homepage: https://github.com/aycabta/git-newline-at-eof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Check and fix newline at end of file in Git respository.
+test_files: []