commit 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 525332be2b7dd147395cdc951b849ea9bd41c96824c3140264de5bb7f531d0c0
+  data.tar.gz: '019c86addf56a91823cb337bc3438c9c6e8a002d453ed2383a429fcc77432df1'
+SHA512:
+  metadata.gz: 8b1e74b61b336af2aa2793fd0749062f2ccdc434841dd2022ad78c6311527062f48a82f2ae16e2e238670dd18194ff01e84702c38ab0c5c66948fcf1515ad594
+  data.tar.gz: 857d5edf90f4022dd4a71e66dcdfdabee3607edfe811e520b5a94f7fd8bbe3db5dd4bdd4f8e5993d0e1443f352d9908f6f5d86f9b5e452eea07fd0c8b7ba9ddd

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require:
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - commit.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Change Log
+
+## 0.7.0 / 2025-06-14
+
+* Options are processed once again; this broke in v0.6.0.
+* Now works from any subdirectory of a git repository.
+* Now verifies that the command is run from within a git repository.
+
+
+## 0.6.0 / 2025-06-09
+
+* Filename with embedded single quotes are now processed correctly.
+* The `.gitignore` documentation states that filenames with embedded spaces need to escape the spaces with backslashes.
+  It fails to mention that `[]` characters must also be escaped.
+  This version escapes all three characters.
+
+
+## 0.5.0
+
+* First version of this code as a Ruby gem.
+
+
+## 0.4.0
+
+* Last version of this code as a standalone script.

data/README.md

@@ -0,0 +1,98 @@
+# `Commit` [![Gem Version](https://badge.fury.io/rb/commit.svg)](https://badge.fury.io/rb/commit)
+
+Runs git commit without prompting for a message.
+Files larger than 2 GB are added to .gitignore instead of being committed.
+
+This gem is further described in [A Streamlined Git Commit](https://mslinn.com/git/1050-commit.html).
+
+
+## Installation
+
+1) [Install the `rugged` gem.](https://mslinn.com/git/4400-rugged.html)
+2) Type:
+
+    ```ruby
+    gem install commit
+    ```
+
+
+## Usage
+
+```shell
+$ commit [options] [file...]
+```
+
+Where options are:
+
+- `-a "tag message"`
+- `-m "commit message"`
+- `-v 0 # Minimum verbosity`
+- `-v 1 # Default verbosity`
+- `-v 2 # Maximum verbosity`
+
+
+### Examples
+
+```shell
+$ commit  # The default commit message is just a single dash (-)
+$ commit -v 0
+$ commit -m "This is a commit message"
+$ commit -v 0 -m "This is a commit message"
+$ commit -a 0.1.2
+```
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/commit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'commit/version.rb'
+  system "gem push pkg/commit-#{Commit::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/commit.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/commit/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/commit'
+
+  spec.authors               = ['Mike Slinn']
+  spec.bindir                = 'exe'
+  spec.executables           = ['commit']
+  spec.description           = <<~END_DESC
+    Performs the following:
+      1) git add
+      2) git commit
+      3) git push
+      Works with Git LFS
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://github.com/mslinn/commit'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'commit'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 3.1.0'
+  spec.summary               = 'Write summary of what the gem is for'
+  spec.version               = Commit::VERSION
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'colorator'
+  spec.add_dependency 'optparse'
+  spec.add_dependency 'rugged'
+end

data/exe/commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/commit'
+
+Commit.main

data/lib/commit/cli.rb

@@ -0,0 +1,20 @@
+require 'colorator'
+require 'fileutils'
+require 'pathname'
+
+def require_subdirectory(dir)
+  Dir[File.join(dir, '*.rb')].each do |file|
+    require file unless file == __FILE__
+  end
+end
+
+require_subdirectory File.realpath(__dir__) # Require all Ruby files in 'lib/', except this file
+Pathname(__dir__).children.select(&:directory?).each do |directory|
+  require_subdirectory directory.to_s
+end
+
+module Commit
+  def self.main
+    GitCommit.new.main
+  end
+end

data/lib/commit/git_commit.rb

@@ -0,0 +1,109 @@
+require 'active_support'
+require 'active_support/core_ext/numeric/conversions'
+require 'colorator'
+require 'optparse'
+require 'rugged'
+
+KB = 1024
+MB = KB * KB
+GB = KB * MB
+# File size limits for git commits depend on the type of your GitHub account:
+GITHUB_FREE             = 100 * MB
+GITHUB_PRO              = 2 * GB
+GITHUB_TEAM             = 4 * GB
+GITHUB_ENTERPRISE_CLOUD = 5 * GB
+
+GIT_LFS_ENABLED = false
+
+MAX_SIZE = GIT_LFS_ENABLED ? GITHUB_FREE : 100 * MB # Adjust this to suit your GitHub account
+
+# Originally written in bash by Mike Slinn 2005-09-05
+# Converted to Ruby and added MAX_SIZE 2024-12-11
+# See https://docs.github.com/en/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage
+# See https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github
+class GitCommit
+  ActiveSupport::NumberHelper.alias_method :to_human, :number_to_human_size
+
+  def initialize(default_branch: 'master')
+    @branch = default_branch
+    @commit_size = 0
+    @gitignore_dirty = false
+    @nh = ActiveSupport::NumberHelper
+  end
+
+  def commit_push(msg = '-')
+    puts msg.yellow if msg
+    msg = @options[:commit_message] if @options[:commit_message]
+    discover_branch
+
+    puts "Committing with message '#{msg}'".green unless @options[:verbosity].zero?
+    run("git commit -m '#{msg}' 2>&1 | sed -e '/^X11/d' -e '/^Warning:/d'", verbose: @options[:verbosity] >= 2)
+    # @repo.push 'origin', ['refs/heads/master'] # Needs a callback to handle authentication
+    puts "Pushing to origin #{@branch}".green unless @options[:verbosity].zero?
+    run("git push origin #{@branch} --tags 3>&1 1>&2 2>&3 | sed -e '/^X11/d' -e '/^Warning:/d'", verbose: @options[:verbosity] >= 2)
+    @change_count = 0
+    @commit_size = 0
+  end
+
+  def discover_branch
+    if @repo.branches.entries.empty?
+      # puts "\nYour git repository is empty. Please add at least one file before committing.".red
+      # exit 4
+      run "git branch -M #{@branch}"
+    else
+      @branch = @repo.head.name.sub(%r{^refs/heads/}, '')
+    end
+  end
+
+  def git_project?
+    run 'git rev-parse 2> /dev/null', verbose: false
+  end
+
+  def large_files
+    large = []
+    @repo.status do |path, flags|
+      puts "#{path} #{flags}" if @options[:verbosity].positive?
+      if File(path).dir?
+        scan_dir path
+      elsif large_file?(filename)
+        large << path.gsub(' ', '\ ').gsub('[', '\[').gsub(']', '\]')
+      end
+    end
+    large
+  end
+
+  def main
+    @options = parse_options
+    repo_dir = ARGV.empty? ? Dir.pwd : ARGV[0]
+    Dir.chdir(repo_dir) unless ARGV.empty?
+    if git_project?
+      process_tag # Exits if a tag was created
+      @repo = Rugged::Repository.new repo_dir
+      recursive_add
+      commit_push if @commit_size.positive?
+    else
+      puts "Error: '#{repo_dir}' does not contain a git project".red
+      exit 3
+    end
+  end
+
+  def process_tag
+    tag = @options[:tag]
+    return unless tag
+
+    run("git tag -a #{tag} -m 'v#{tag}'", verbose: @options[:verbosity] >= 2)
+    run('git push origin --tags', verbose: @options[:verbosity] >= 2)
+    exit
+  end
+
+  # @param command can be a String or an Array of String
+  def run(command, verbose: true, do_not_execute: false)
+    if command.instance_of?(Array)
+      puts command.join(' ') if verbose
+      Kernel.system(*command) unless do_not_execute
+    else
+      puts command if verbose
+      `#{command}`.chomp unless do_not_execute
+    end
+  end
+end

data/lib/commit/helper.rb

@@ -0,0 +1,99 @@
+class GitCommit
+  # Needs absolute path or the path relative to the current directory, not just the name of the directory
+  def add_recursively(name)
+    Dir.entries(name).each do |entry|
+      path = "#{name}/#{entry}"
+      if File.directory(entry)
+        scan_directory path
+      else
+        file_add path
+      end
+    end
+  end
+
+  # Handles single quotes, spaces and square braces in the given string
+  def escape(string)
+    string.gsub("'", "\\\\'")
+          .gsub(' ', '\\ ')
+          .gsub('[', '\\[')
+          .gsub(']', '\\]')
+  end
+
+  # @param filename [String] Must be a path relative to the git root
+  def file_add(filename)
+    file_size = File.exist?(filename) ? File.size(filename) : 0
+    if large_file?(filename)
+      msg = <<~MESSAGE
+        Not adding '#{filename}' because the git file size limit is #{@nh.to_human MAX_SIZE},
+        however the file is #{@nh.to_human file_size}.
+        The file will be added to .gitignore.
+      MESSAGE
+      puts msg.yellow unless @options[:verbosity].zero?
+
+      newline = needs_newline('.gitignore') ? "\n" : ''
+      File.write('.gitignore', "#{newline}#{filename}\n", mode: 'a')
+      @gitignore_dirty = true
+    elsif filename == '.gitignore'
+      @gitignore_dirty = true
+    else
+      commit_push('A portion of the files to be committed is being pushed now because they are large.') if @commit_size + file_size >= MAX_SIZE / 2.0
+      puts "Adding '#{escape filename}'".green unless @options[:verbosity].zero?
+      run ['git', 'add', escape(filename)], verbose: @options[:verbosity] >= 2
+    end
+    @change_count += 1
+    @commit_size += file_size
+  end
+
+  # Assumes .gitignore is never large
+  def large_file?(filename)
+    File.size(filename) > MAX_SIZE if File.exist?(filename)
+  end
+
+  def needs_newline(filename)
+    return false unless File.exist? filename
+
+    file_contents = File.read filename
+    file_contents.nil? || file_contents.empty? || !file_contents.end_with?("\n")
+  end
+
+  # Exclude big files, git add all others
+  # @repo.status returns the following values for flags:
+  #  - +:index_new+: the file is new in the index
+  #  - +:index_modified+: the file has been modified in the index
+  #  - +:index_deleted+: the file has been deleted from the index
+  #  - +:worktree_new+: the file is new in the working directory
+  #  - +:worktree_modified+: the file has been modified in the working directory
+  #  - +:worktree_deleted+: the file has been deleted from the working directory
+  def recursive_add
+    @change_count = 0
+    @repo.status do |path, flags|
+      next if flags.include? :ignored
+
+      if File.directory? path
+        scan_directory path
+      else
+        file_add path
+      end
+    end
+    if @gitignore_dirty
+      puts 'Changing .gitignore'.green unless @options[:verbosity].zero?
+      run 'git add .gitignore', verbose: @options[:verbosity] >= 2
+      @change_count += 1
+    end
+    return unless @change_count.zero?
+
+    puts 'No changes were detected to this git repository.'.green if @options[:verbosity].positive?
+    exit
+  end
+
+  def scan_directory(path)
+    Dir.children(path) do |name|
+      child_path = "#{path}/#{name}"
+      if File.directory? child_path
+        scan_directory child_path
+      else
+        file_add child_path
+      end
+    end
+  end
+end

data/lib/commit/options.rb

@@ -0,0 +1,58 @@
+require 'colorator'
+require 'optparse'
+
+class GitCommit
+  def help(msg = nil)
+    printf "Error: #{msg}\n\n".yellow unless msg.nil?
+    msg = <<~HELP
+      commit v#{Commit::VERSION}
+
+      Runs git commit without prompting for a message.
+      Files larger than #{@nh.to_human MAX_SIZE} are added to .gitignore instead of being committed.
+
+      Usage: commit [options]
+      Where options are:
+        -a "tag message"
+        -m "commit message"
+        -v 0 # Minimum verbosity
+        -v 1 # Default verbosity
+        -v 2 # Maximum verbosity
+
+      Examples:
+        commit  # The default commit message is just a single dash (-)
+        commit -v 0
+        commit -m "This is a commit message"
+        commit -v 0 -m "This is a commit message"
+        commit -a 0.1.2
+
+      This gem is further described in https://mslinn.com/git/1050-commit.html
+    HELP
+    puts msg.yellow
+    exit 1
+  end
+
+  def parse_options
+    options = { message: '-', verbosity: 1 }
+    OptionParser.new do |parser|
+      parser.program_name = File.basename __FILE__
+      @parser = parser
+
+      parser.on('-a', '--tag TAG_MESSAGE', 'Specify tag message')
+      parser.on('-m', '--message COMMIT_MESSAGE', 'Specify commit message')
+      parser.on('-v', '--verbosity VERBOSITY', Integer, 'Verbosity (0..2)')
+
+      parser.on_tail('-h', '--help', 'Show this message') do
+        help
+      end
+    end.order!(into: options)
+    help "Invalid verbosity value (#{options[:verbosity]})." if options[:verbosity].negative? || options[:verbosity] > 2
+    if ARGV.length > 1
+      help <<~END_MSG
+        Incorrect syntax.
+        After removing the options, the remaining command line was:
+        #{ARGV.join ' '}
+      END_MSG
+    end
+    options
+  end
+end

data/lib/commit/version.rb

@@ -0,0 +1,3 @@
+module Commit
+  VERSION = '0.7.0'.freeze unless defined? VERSION
+end

data/lib/commit.rb

@@ -0,0 +1,21 @@
+require 'pathname'
+require 'colorator'
+require 'fileutils'
+
+def require_subdirectory(dir)
+  Dir[File.join(dir, '*.rb')].each do |file|
+    require file unless file == __FILE__
+  end
+end
+
+git_dir = `git rev-parse --show-toplevel`.chomp
+if git_dir.empty?
+  puts 'This script must be run from within a git repository.'.red
+  exit 1
+end
+Dir.chdir(git_dir) # Change to the root of the git repository
+
+require_subdirectory File.realpath(__dir__) # Require all Ruby files in 'lib/', except this file
+Pathname(__dir__).children.select(&:directory?).each do |directory|
+  require_subdirectory directory.to_s
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: commit
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Mike Slinn
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Performs the following:
+    1) git add
+    2) git commit
+    3) git push
+    Works with Git LFS
+email:
+- mslinn@mslinn.com
+executables:
+- commit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- commit.gemspec
+- exe/commit
+- lib/commit.rb
+- lib/commit/cli.rb
+- lib/commit/git_commit.rb
+- lib/commit/helper.rb
+- lib/commit/options.rb
+- lib/commit/version.rb
+homepage: https://github.com/mslinn/commit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/commit/issues
+  changelog_uri: https://github.com/mslinn/commit/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/commit
+  source_code_uri: https://github.com/mslinn/commit
+post_install_message: |2+
+
+  Thanks for installing commit!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Write summary of what the gem is for
+test_files: []
+...