this_is_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2047298c7f0c4729968ed6827707200b80ad5810ccde2c5fcd6fb009d4b662
-  data.tar.gz: 541e8c560fdb8441a4aa4ec0f040827a10454feb8bd467cad44840a614a05455
+  metadata.gz: 7cb3f275dd3475b96089c47a5dbef85a28240daae468e08fbac08e283afd6c96
+  data.tar.gz: 5ac450e2705dafa4176d89960356825d47511faeaf79e0f6420022bf18b403e3
 SHA512:
-  metadata.gz: f09cc8394377d79592a9e8e845a6da04c1dd4fcfa113ebebcf0460af1d8cc3b8c240f8e944048b9a471790d926e1d49123533546aaa093b111598255173de0f4
-  data.tar.gz: f4eeae23cde25381e1fd4132f6904e7c4f5a07a1980a8e7855e115d5532ad8c84fb6b25af916264b786e2ec64f2e93f1679597edddfe70c7c7251aea287f35c2
+  metadata.gz: 275d332b9ff9b7b8039a58c77875f539d9e9769322df96b7cddfe1bb7e640ee0074312641e1fd0855b95b331563a71115c5bce3d8b4b51bb9bebb8326c1f4b89
+  data.tar.gz: fa0bbf5a22382f4da346e9c5725cd982635a9ab7dd2130efb19a98465b0a34f7eb20a0537e56a50d57d5a4ad86c9164c4335d7ba0600e611f663ee5f99846c04

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.1
+
+- The "now" column no longer counts files that are already out of GitHub's
+  language bar. It asks `git check-attr`, so Rails' own `db/schema.rb` line and
+  anything written by hand are honoured, and it subtracts only what this run
+  claims, so re-running on a repository already converted still shows the
+  contrast rather than reporting that nothing would change.
+
 ## 0.1.0
 
 Initial release.
@@ -8,18 +16,8 @@ Initial release.
   Webpacker and Vite builds, SimpleCov reports, SQL structure dumps and
   shadcn/ui components.
 - Writes a managed block in `.gitattributes`, leaving the rest of the file
-  untouched, and stays quiet about anything already declared there.
-- `plan`, `apply` and `check` commands; `--all-frontend` opt-in.
-
-## Unreleased
-
-- Exit 1 on an unknown command or option instead of 0, so a typo in a CI step
-  fails rather than silently skipping `check`.
-- Leave a path alone when its Linguist attribute is already decided, including
-  when it was explicitly unset (`-linguist-generated`) or made unspecified
-  (`!linguist-generated`). Writing our line after such a declaration reversed
-  it, because the last match wins.
-- Rewrite the managed block where it already sits, so content below it stays
-  below it.
-- Read `git rev-parse` from stdout alone: with `GIT_TRACE` set, or on any git
-  warning, the merged stream became part of the repository root.
+  untouched, and stays quiet about anything already decided there, including an
+  attribute the owner explicitly unset.
+- Rewrites the block where it sits, so content below it stays below it.
+- `plan`, `apply` and `check` commands; `--all-frontend` opt-in, which uses
+  `linguist-vendored` so diffs keep working.

data/README.md

@@ -1,5 +1,8 @@
 # this_is_ruby
 
+[![Gem](https://img.shields.io/gem/v/this_is_ruby)](https://rubygems.org/gems/this_is_ruby)
+[![CI](https://github.com/evilmartians/this_is_ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/evilmartians/this_is_ruby/actions/workflows/ci.yml)
+
 GitHub decides a repository's language by counting bytes. Ruby code can often be outnumbered by sheer volume of JS/TS/HTML boilerplate. So GitHub labels the repo HTML or TypeScript.
 
 This gem gives you controls.
@@ -12,6 +15,9 @@ group :development do
 end
 ```
 
+Or `gem install this_is_ruby` to run it against any repository without adding
+it to a project.
+
 ## Use
 
 ```console

data/lib/this_is_ruby/plan.rb

@@ -65,8 +65,12 @@ module ThisIsRuby
       @claimed_paths ||= emissions.flat_map(&:paths).to_set
     end
 
-    def before = @before ||= LanguageEstimate.of(repo)
+    # The bar without our block: what GitHub reports today, minus the paths this
+    # run is claiming. Asking git means Rails' own `db/schema.rb` line and
+    # anything hand-written are honoured, while re-running on a repository we
+    # already converted still shows the contrast rather than "nothing changes".
+    def before = @before ||= LanguageEstimate.of(repo, excluding: repo.already_excluded - claimed_paths)
 
-    def after = @after ||= LanguageEstimate.of(repo, excluding: claimed_paths)
+    def after = @after ||= LanguageEstimate.of(repo, excluding: repo.already_excluded | claimed_paths)
   end
 end

data/lib/this_is_ruby/repo.rb

@@ -17,6 +17,9 @@ module ThisIsRuby
     # markers we check for all sit in the first few lines.
     PEEK_BYTES = 4096
 
+    # The attributes that take a file out of GitHub's language statistics.
+    LINGUIST_EXCLUSIONS = %w[linguist-generated linguist-vendored linguist-documentation].freeze
+
     attr_reader :root
 
     def self.at(path)
@@ -55,6 +58,17 @@ module ThisIsRuby
       full.open("rb") { |io| io.read(PEEK_BYTES) }
     end
 
+    # Paths git already reports as excluded from Linguist's counts, whoever
+    # declared them: our own block, the lines Rails generates, or something
+    # written by hand. Resolving the patterns ourselves would mean
+    # reimplementing gitignore matching, so ask git, which owns the answer.
+    def already_excluded
+      @already_excluded ||= begin
+        paths = tracked
+        paths.empty? ? Set.new : Set.new(check_attr(paths))
+      end
+    end
+
     def size(path)
       full = root.join(path)
       full.file? ? full.size : 0
@@ -62,6 +76,18 @@ module ThisIsRuby
 
     private
 
+    # `check-attr --stdin -z` reads NUL-separated paths and answers with
+    # NUL-separated (path, attribute, value) triples.
+    def check_attr(paths)
+      out, _err, status = Open3.capture3(
+        "git", "-C", root.to_s, "check-attr", "--stdin", "-z", *LINGUIST_EXCLUSIONS,
+        stdin_data: paths.join("\0")
+      )
+      return [] unless status.success?
+
+      out.split("\0").each_slice(3).filter_map { |path, _attribute, value| path if value == "set" }
+    end
+
     def tracked_set
       @tracked_set ||= tracked.to_set
     end

data/lib/this_is_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThisIsRuby
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: this_is_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Irina Nazarova