gig 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f93b55797c23f2060a6a00602e4097d19356f80efe0f24daee2fa71c287900
-  data.tar.gz: cbdeab6b788fbe1c54c0a18b341b667f78fb606d4b607f4564c5ae309f4d99ea
+  metadata.gz: f943dab3aba7fb52891beaaeb7408e835a60fc190f964f7afa6bab43145d7e81
+  data.tar.gz: 8b1139ef896f849a8013602ceeb16d5d370daa56ad0d0fa2e3f3ded5c7923dfe
 SHA512:
-  metadata.gz: 026147464ac6706f93adb5ad6e13395e5a754911575493016caaf2f3761b7f207463794398290aff760af4f696d2a13237262fecc64d080bcbf41033093f02fa
-  data.tar.gz: ba5e22da9c9bb8b6f59c8f6247991ea9465abdf21a3e4d5edbbad4964f0fd6ff0e9ba2bbc2bfc1321cd81887c54ec4886fb75e61b1476c4ea47a9106d9eca06b
+  metadata.gz: 3e3f4a87eee4b3bcfe6cbd517eef485efe2ebb61f902790b81455dfbba57b4d4652803ff533d10fdf816613a8221806b6310c169f554218a4a5b6a029cc4a73e
+  data.tar.gz: 29e571ba1108209a2fc4f1d4bafc8ff40f28b03f2f1f55c4dbde1e151fa3bdd930cb202abbc0fa81b19f2fe1d277955c8daf80331c23ff2674c7c1b67fd57de9

data/README.md

@@ -1,5 +1,23 @@
 `gig` contains a rake task of the same name to check for consistency of files between git, gemspec, and the filesystem before building.
 
+## Usage
+
+In your rakefile, `require 'gig'` and invoke [Gig.make_task](https://rubydoc.info/gems/gig/Gig), passing `gemspec_filename` and `ignore_files`. Globs are useful for `ignore_files`, and `File::FNM_DOTMATCH` should be used when globs may contain dotfiles. For example:
+
+```ruby
+require 'gig'
+
+ignore_files = %w(
+  .github/**/*
+  .gitignore
+  .gitmodules
+  Gemfile
+  Rakefile.rb
+  test/**/*
+).map { |glob| Dir.glob(glob, File::FNM_DOTMATCH) }.inject([], &:|)
+Gig.make_task(gemspec_filename: 'my_gem.gemspec', ignore_files: ignore_files)
+```
+
 ## License
 
 The gem is available under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/gig.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gig/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "gig"
+  spec.version = Gig::VERSION
+  spec.authors = ["Ethan"]
+  spec.email   = ["ethan@unth.net"]
+
+  spec.summary     = "gig"
+  spec.description = "a rake task to check a gem's consistency with git and the filesystem before building"
+  spec.homepage    = "https://github.com/notEthan/gig"
+  spec.license     = "MIT"
+
+  spec.files = [
+    'LICENSE.txt',
+    'README.md',
+    'gig.gemspec',
+    *Dir['lib/**/*'],
+  ].reject { |f| File.lstat(f).ftype == 'directory' }
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rake'
+end

data/lib/gig/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gig
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/gig.rb

@@ -6,8 +6,9 @@ module Gig
   class << self
     # @param name [#to_s] rake task name
     # @param gemspec_filename
-    # @param ignore_files [Enumerable]
+    # @param ignore_files [Enumerable<String>]
     def make_task(name: 'gig', gemspec_filename: , ignore_files: )
+      Rake.application.last_description = "check consistency of gemspec files with git and filesystem before building the gem"
       Rake::Task.define_task(name) do
         require 'shellwords'
         require 'set'
@@ -30,31 +31,38 @@ module Gig
           in_git = git_files.include?(file)
           in_fs = fs_files.include?(file)
           in_spec = spec.files.include?(file) || spec.test_files.include?(file)
+          in_ignore = ignore_files.include?(file)
 
-          if in_git
-            if in_fs
-              if in_spec
+          if in_spec
+            if in_ignore
+              file_error.("file in gig ignore_files, but present in gemspec: #{file}")
+            end
+
+            if in_git
+              if in_fs
                 git_status = `git status --porcelain #{Shellwords.escape(file)}`
                 if git_status.empty?
                   # pass
                 else
-                  file_error.("file modified from git: #{file}")
+                  file_error.("file in gemspec, but modified from git: #{file}")
                 end
               else
-                if ignore_files.include?(file)
-                  # pass
-                else
-                  file_error.("git file not in gemspec: #{file}")
-                end
+                file_error.("file in gemspec, but not in filesystem: #{file}")
               end
             else
-              file_error.("git file not in fs: #{file}")
+              if in_fs
+                file_error.("file in gemspec and filesystem, but not in git: #{file}")
+              else
+                file_error.("file in gemspec, but not in git and not in filesystem: #{file}")
+              end
             end
+          elsif in_ignore
+            # in ignore_files, and not in gemspec: pass (regardless of git or fs)
           else
-            if in_spec
-              file_error.("file in gemspec but not in git: #{file}")
+            if in_git
+              file_error.("file in git, but in neither gemspec nor gig ignore_files: #{file}")
             else
-              # in fs but ignored by git and spec: pass
+              # not in gemspec, not in ignore_files, not in git: pass - it's in the filesystem but can be ignored
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gig
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Ethan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,7 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: a rake task to check a gem's consistency with git and the filesystem
+  before building
 email:
 - ethan@unth.net
 executables: []
@@ -33,13 +34,14 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- gig.gemspec
 - lib/gig.rb
 - lib/gig/version.rb
 homepage: https://github.com/notEthan/gig
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: gig
 test_files: []