Simplify running outside of an app

Author: andyw8

CHANGELOG.md

@@ -1,6 +1,6 @@
 # main ([unreleased](https://github.com/fastruby/rails_stats/compare/v1.0.2...main))
 
-*
+* [FEATURE: Simplify running outside of an app](https://github.com/fastruby/rails_stats/pull/34)
 
 # v2.0.1 ([commits](https://github.com/fastruby/rails_stats/compare/v2.0.0...v2.0.1))
 
@@ -22,4 +22,4 @@
 # v1.0.1 / 2018-10-8
 
 * [FEATURE: add more aggregate stats](https://github.com/fastruby/rails_stats/pull/5)
-* [FEATURE: More detailed introspection of app](https://github.com/fastruby/rails_stats/pull/1)
+* [FEATURE: More detailed introspection of app](https://github.com/fastruby/rails_stats/pull/1)

README.md

@@ -8,18 +8,20 @@ RailsStats mainly adds the ability to be run from outside the project in questio
 
 ### Run it outside Rails project
 
-You will need a `Rakefile` in the directory where you call `rake` and you will
-need to require `rails_stats`:
+Install the gem globally with:
 
-```ruby
-# Rakefile
-require "rails_stats"
-```
+`gem install rails_stats`
+
+You can then run:
+
+`rails_stats PATH_TO_APP [FORMAT]`
+
+(the format is optional and defaults to the console formatter).
 
 Then you can call it:
 
 ```bash
-$ rake stats\[/path/to/app/\]
+$ rails_stats /path/to/app/
 
 Directory: /path/to/app/
 
@@ -48,7 +50,7 @@ Directory: /path/to/app/
 ### Run it on many Rails engines
 
 ```bash
-$ for dir in /path/to/many/engines/*/; do bundle exec rake stats[$dir]; done
+$ for dir in /path/to/many/engines/*/; do rails_stats /users/brian/examples/$dir; done
 ```
 
 ### Within your Rails project
@@ -80,7 +82,7 @@ RailsStats adds more coverage than the default.
 Here are some open source Rails projects and their output.
 
 ```bash
-$ bundle exec rake stats[/users/brian/examples/diaspora/]
+$ rails_stats /users/brian/examples//users/brian/examples/diaspora
 
 Directory: /users/brian/examples/diaspora
 
@@ -116,7 +118,7 @@ Directory: /users/brian/examples/diaspora
   Code LOC: 19333     Test LOC: 17403     Code to Test Ratio: 1:0.9
 
 
-$ bundle exec rake stats[/users/brian/examples/discourse]
+$ rails_stats /users/brian/examples//users/brian/examples/discourse
 
 Directory: /users/brian/examples/discourse
 
@@ -149,7 +151,7 @@ Directory: /users/brian/examples/discourse
   Code LOC: 59738     Test LOC: 28167     Code to Test Ratio: 1:0.5
 
 
-$ bundle exec rake stats[/users/brian/examples/gitlabhq]
+$ rails_stats /users/brian/examples//users/brian/examples/gitlabhq
 
 Directory: /users/brian/examples/gitlabhq
 
@@ -188,7 +190,7 @@ Directory: /users/brian/examples/gitlabhq
   Code LOC: 20039     Test LOC: 24857     Code to Test Ratio: 1:1.2
 
 
-$ bundle exec rake stats[/users/brian/examples/redmine/]
+$ rails_stats /users/brian/examples//users/brian/examples/redmine/
 
 Directory: /users/brian/examples/redmine
 
@@ -212,7 +214,7 @@ Directory: /users/brian/examples/redmine
   Code LOC: 31437     Test LOC: 42912     Code to Test Ratio: 1:1.4
 
 
-$ bundle exec rake stats[/users/brian/examples/refinerycms]
+$ rails_stats /users/brian/examples//users/brian/examples/refinerycms
 
 Directory: /users/brian/examples/refinerycms
 
@@ -240,7 +242,7 @@ Directory: /users/brian/examples/refinerycms
   Code LOC: 5447     Test LOC: 5219     Code to Test Ratio: 1:1.0
 
 
-$ bundle exec rake stats[/users/brian/examples/spree]
+$ rails_stats /users/brian/examples//users/brian/examples/spree
 
 Directory: /users/brian/examples/spree
 

exe/rails_stats

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rails_stats/all"
+
+root_directory = ARGV[0]
+fmt = ARGV[1] || ""
+
+RailsStats::CodeStatistics.new(root_directory, {format: fmt}).to_s

lib/rails_stats/console_formatter.rb

@@ -3,8 +3,6 @@
 module RailsStats
   class ConsoleFormatter < StatsFormatter
     def to_s
-      Bundler::Stats::CLI.start
-
       print_header
       sorted_keys = @statistics.keys.sort
       sorted_keys.each { |key| print_line(key, @statistics[key]) }
@@ -54,4 +52,4 @@ def print_code_test_stats
         puts ""
       end
   end
-end
+end

rails_stats.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]