docstat 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a81ecdb74a67ba1a5967c49a783931698d8ea7b9
-  data.tar.gz: a257d38855848d5be991c0c91036850d20876b8b
+  metadata.gz: d4c4a9742e07f2ad0449ae0ea037f482524bec5e
+  data.tar.gz: 4bea10458a173884f61dcb40c4361922a6fb99cc
 SHA512:
-  metadata.gz: 6a593a72575ab0702c2271eba71f51fa411336c0ec40dae756bca027af0a1658f802296b12e992a8055fa6cdc1800c12515648423c47eef6532444e7e49078d4
-  data.tar.gz: f88dc4505a35140a5836ae89af37e6d37e04cf355a98068cf6650a9079dd3ca8d725e6d2f9fd24a08bada8ff45e1d616391c0f3a5aaffc403de5cdc482fd7896
+  metadata.gz: c01f96f86bc6b602ae62977192d6a4a96fc48d2e0d33d1de597fdfedc1b56f38a7957ca4624c5ba6f3ac22c1159c3bd36b394363561e7ad3863484e59e7895da
+  data.tar.gz: 455c6e1cd9ebcb383e9e641f4750f1c38354a23fdb184e633c7deb7e801376e67d1829dc70da1c62d61d0c8aceb561078566a215d9a91d6e43a3b6c9b4e237a5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.2
+
+* Show current version with `--version` or `-v`
+
 # 1.0.1
 
 * Fix missing test binary

data/bin/docstat

@@ -2,7 +2,9 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/docstat'))
 
-if docset_path = ARGV[0]
+if ARGV.include?('--version') || ARGV.include?('-v')
+  print "#{DocStat::VERSION}\n"
+elsif docset_path = ARGV[0]
   stats  = DocStat.process(docset_path)
   tokens = stats['containers'].map {|c| c['tokens']}.flatten
   ratio  = stats['ratio']

data/bin/docstat-test

@@ -2,7 +2,9 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/docstat'))
 
-if docset_path = ARGV[0] and passing_ratio = (ARGV[1] || '0.9')
+if ARGV.include?('--version') || ARGV.include?('-v')
+  print "#{DocStat::VERSION}\n"
+elsif docset_path = ARGV[0] and passing_ratio = (ARGV[1] || '0.9')
   state = DocStat.test_ratio(docset_path, passing_ratio.to_f) ? 'PASSED' : 'FAILED'
   print "Documentation coverage must be greater than or equal to #{passing_ratio.to_f * 100}%: #{state}"
   exit(state ? 0 : 1)

data/lib/docstat.rb

@@ -2,6 +2,7 @@ $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'sqlite3'
 require 'docstat/container'
+require 'version'
 
 module DocStat
 
@@ -33,6 +34,8 @@ module DocStat
     { "containers" => containers.map(&:to_hash) , "ratio" => overall_ratio(containers) }
   end
 
+  # Returns true if the coverage ratio of a docset at
+  # docset_path is greater than or equal to passing_ratio
   def self.test_ratio docset_path, passing_ratio
     containers = containers_from_docset(docset_path)
     overall_ratio(containers) >= passing_ratio

data/lib/version.rb

@@ -0,0 +1,3 @@
+module DocStat
+  VERSION = '1.0.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docstat
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Delisa Mason
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - CHANGELOG.md
+- LICENSE
 files:
 - Gemfile
 - LICENSE
@@ -70,9 +71,10 @@ files:
 - bin/docstat
 - bin/docstat-test
 - lib/docstat.rb
+- lib/version.rb
 - lib/docstat/container.rb
 - lib/docstat/token.rb
-homepage: https://github.com/docstat
+homepage: https://github.com/kattrali/docstat
 licenses: []
 metadata: {}
 post_install_message: