gloc 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '03680f8522160a0bd3f6b4f6d2294c9683010dbd'
-  data.tar.gz: dc7387860aaa9e4737f3953e64ab738c0cfc09ed
+  metadata.gz: bb008de5d3e4876e1fdfc917d9c9f8c8b29560c0
+  data.tar.gz: a90bd40e3e81f8f5f5a9bd1848d1ac219dac3b1d
 SHA512:
-  metadata.gz: f3246c72e55d068e2e2c9e88258ac5425ab8c91dade985c62d7e19d8f84bda4d16032c0c6afc121f52342c25ee2b2b5ba4898a2e26be9504c414db14299e55b9
-  data.tar.gz: be2f66713645f3318901361da7317034f9e2040ba56123692e2ee2629af2e90c62e08c9d2f921484aa1207d27385c76ce91fd2ed2d046b3100d48fccd5febbb6
+  metadata.gz: 329271c34e3ce802253be45beabe866e8747ceaa5705dde7448359248d6a3bfc6071a9f065f00392fed5ece92aed9ec9b67904e02ddd6ef138a20208ec8cf47a
+  data.tar.gz: a669b54dd3a4875954ec6002d47e9be98d5fbfcc237b023e44fd34f70cc343921f5d5f8de7361ab2404f6ab0c00323402cd1707c60c90c69b25fed8107df53a5

data/README.md

@@ -1,8 +1,60 @@
-# Gloc
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gloc`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## What it is not:
+# Gloc(k) Model 17 - 9mm
+
+`gloc` is an opinionated utility to count lines of code.
+
+* it groups files based on their file extension, instead of trying to guess their language and grouping them that way
+* it doesn't ignore files just because it doesn't recognise them _(ie. cannot correctly guess their language)_
+* in a git repo, it processes `$( git ls-files )` by default
+* in a non-git repo, it processes `$( find . -type f)` by default
+* it generates human-friendly, `loc`-alike output
+* it is Unix pipeline friendly, by design:
+   * it reads the list of filenames to process from `stdin` if `[ ! -t 0 ]`
+   * it writes machine-parsable JSON output to `stdout` if `[ ! -t 1 ]`
+
+## Example
+
+For the popular Ruby on Rails framework, `gloc` generates the following `loc`-alike output:
+
+    --------------------------------------------------------------------------------
+     Language             Files        Lines        Blank      Comment         Code
+    --------------------------------------------------------------------------------
+     *.rb                 2,149      304,495       47,846       42,651      213,998
+     *.md                    74       49,604       14,204            0       35,400
+     *.js                    39        9,717        1,452          564        7,701
+     *.yml                  150        3,367          278            0        3,089
+     *.erb                  408        2,183          254            0        1,929
+     *                       81        2,255          392            0        1,863
+     *.css                   24        1,640          214           32        1,394
+     *.coffee                24        1,190          197            0          993
+     *.rake                  16          864          137            0          727
+     *.rdoc                  11          985          352            0          633
+     *.tt                    28          515           88            0          427
+     *.lock                   1          437           11            0          426
+     *.yaml                   1          231            1            0          230
+     *.gemspec               11          306           79            0          227
+     *.html                  28          225           15            3          207
+     *.json                   3           65            0            0           65
+     *.builder               19           62            2            0           60
+     *.y                      1           50            4            0           46
+     *.sql                    1           49            6            0           43
+     *.zoo                    2            8            0            0            8
+     *.ru                     2            8            2            0            6
+     *.txt                    6            6            0            0            6
+     *.ruby                   2            4            0            0            4
+     *.erb~                   4            4            0            0            4
+     *.raw                    2            2            0            0            2
+     *.styles                 1            1            0            0            1
+     *.log                    1            1            0            0            1
+     *.dtd                    1            1            0            0            1
+     *.mab                    1            1            0            0            1
+     *.javascript             1            1            0            0            1
+    --------------------------------------------------------------------------------
+     Total                3,092      378,277       65,534       43,250      269,493
+    --------------------------------------------------------------------------------
+
+## What It Is Not!
+
+For various reasons, none of these existing utilities to count lines of code are fit for _(my)_ purpose:
 
 * [cgag/loc](https://github.com/cgag/loc)
 * [AlDanial/cloc](https://github.com/AlDanial/cloc)
@@ -11,23 +63,45 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install gloc
 
-```ruby
-gem 'gloc'
-```
+## Usage
 
-And then execute:
+The simplest way to use `gloc` is to simply run:
 
-    $ bundle
+    gloc
 
-Or install it yourself as:
+It should behave pretty much as you'd expect!
 
-    $ gem install gloc
+### in a git repo
 
-## Usage
+In a git repo, running `gloc` will process all files known to git, so is roughly equivalent to:
+
+    git ls-files | gloc
+
+### in a non-git repo
+
+In a non-git repo, running `gloc` will process all files in the directory, so is roughly equivalent to:
 
-TODO: Write usage instructions here
+    find . -type f | gloc
+
+## Sorting
+
+The results are sorted by "lines of code" by default _(with "lines of code" defined as lines that aren't blank or comment-only)_ but the following options are supported to sort the results differently:
+
+    gloc -files     # sort by number of files
+    gloc -lines     # sort by the total number of lines
+    gloc -blank     # sort by the number of blank lines
+    gloc -comment   # sort by the number of comment lines
+    gloc -code      # sort by lines of code (default)
+
+## Known Issues
+
+* identify comment-only lines for a lot more languages
+* support more file encodings (not just `UTF-8` and `ISO-8859-1`)
+
+* (?) installation via Homebrew
+* (?) convert script to Perl for performance
 
 ## Development
 
@@ -43,4 +117,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pvdb/g
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/exe/gloc

@@ -33,10 +33,11 @@ end
 # see buffer_is_binary() function
 source_files.delete_if { |file|
   (
-    File.extname(file) == '.pdf' || # skip bl**dy PDF documents
-    !File.exist?(file) ||           # skip non-existent paths
-    !File.file?(file)  ||           # skip directories
-    !File.size?(file)  ||           # skip empty files
+    File.extname(file) == '.pdf'      || # skip bl**dy PDF documents
+    File.basename(file) =~ /\A\..*\z/ || # skip hidden ".*" files
+    !File.exist?(file)                || # skip non-existent paths
+    !File.file?(file)                 || # skip directories
+    !File.size?(file)                 || # skip empty files
     !File.read(file, 16)["\0"].nil? # skip binary files
   ) && ( $verbose && warn("SKIPPING #{file}...") ; true )
 }
@@ -64,7 +65,9 @@ source_stats = source_files.each_with_object({}) { |file, stats|
       comment_count: 0,
     })
   end
-  source_lines = File.read(file).each_line
+  file_content = File.read(file, :encoding => 'UTF-8') # FIXME what about other encodings?
+  file_content = File.read(file, :encoding => 'ISO-8859-1') unless content.valid_encoding?
+  source_lines = file_content.each_line
   stats_for_ext.file_count    += 1
   stats_for_ext.line_count    += source_lines.count
   stats_for_ext.blank_count   += source_lines.grep(BLANKS).count
@@ -94,11 +97,11 @@ source_stats = Hash[
 ]
 
 source_stats["TOTAL"] = OpenStruct.new({
-  file_count:    source_stats.values.map(&:file_count).reduce(:+),
-  line_count:    source_stats.values.map(&:line_count).reduce(:+),
-  blank_count:   source_stats.values.map(&:blank_count).reduce(:+),
-  comment_count: source_stats.values.map(&:comment_count).reduce(:+),
-  code_count:    source_stats.values.map(&:code_count).reduce(:+),
+  file_count:    source_stats.values.map(&:file_count).reduce(:+)    || 0,
+  line_count:    source_stats.values.map(&:line_count).reduce(:+)    || 0,
+  blank_count:   source_stats.values.map(&:blank_count).reduce(:+)   || 0,
+  comment_count: source_stats.values.map(&:comment_count).reduce(:+) || 0,
+  code_count:    source_stats.values.map(&:code_count).reduce(:+)    || 0,
 })
 
 #

data/lib/gloc/version.rb

@@ -1,3 +1,3 @@
 module GLOC
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Vandenberk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler