attractor 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 699413053fc8137c150694aa57bc7f4b4ed4c51c2f65d7e3af4549d15d33d274
-  data.tar.gz: f630cd630d43770d34fd1afbffbb717deef4c76942f38917bdf811d8082f33f2
+  metadata.gz: 87ed2febd5e08be404f8589b1f6da07779ce7cef6730395df2bc6940f6b60864
+  data.tar.gz: ac539bf8bab537ae633934f985b1df1223e8a4b3ee783a08c21cd609086d1448
 SHA512:
-  metadata.gz: 0d52ffc4e2b05bcc970cc6f9555baeebbee6dc9dde9de83cb0ce15a0a9e8359a5f7d204d3afe5001110d9936c988f0349703fca5d666577be38c3473e3e6cef2
-  data.tar.gz: '088f7c37f1e2769f15c439a295b3e2bb12ee6c1c1b6c2e2ee34dd8920d3a65e9a994509a23adb50c12da5fbb07ec07f94afd5b2d34dc2e6b7709ba65ee746e5b'
+  metadata.gz: c46f972f805ed3a86da19a5fbccadd774d65b50f919f1d31d48ac5b0b2393282e332cb513d9c451c61f5e12c962d8923f2ab5133e43706a93811e2ada47dfecd
+  data.tar.gz: 00ca0589082b0ffd7a094beca428d7129cfc05f12b6fd988c013279f3bc7a43d1345c154d5ebc77d4de503481d46c0f0d7e042e1bed84998c6bf5a4b1855c563

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## RELEASE 2.0.1
+
+* ENHANCEMENT: Add CLI option to Output gem version
+
 ## RELEASE 2.0.0
 
 * BREAKING: Move to a plug-in architecture, see README

data/README.md

@@ -1,77 +1,157 @@
-# Attractor ![build status](https://travis-ci.org/julianrubisch/attractor.svg?branch=master) <img src="https://user-images.githubusercontent.com/4352208/65411858-3dc84200-ddee-11e9-99b6-c9cdbeb533c5.png" width="32">
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- Shields -->
+[forks-shield]: https://img.shields.io/github/forks/julianrubisch/attractor.svg?style=flat-square
+[forks-url]: https://github.com/julianrubisch/attractor/network/members
+[stars-shield]: https://img.shields.io/github/stars/julianrubisch/attractor.svg?style=flat-square
+[stars-url]: https://github.com/julianrubisch/attractor/stargazers
+[issues-shield]: https://img.shields.io/github/issues/julianrubisch/attractor.svg?style=flat-square
+[issues-url]: https://github.com/julianrubisch/attractor/issues
+[license-shield]: https://img.shields.io/github/license/julianrubisch/attractor.svg?style=flat-square
+[license-url]: https://github.com/julianrubisch/attractor/blob/master/LICENSE
+[build-status]: https://travis-ci.org/julianrubisch/attractor.svg?branch=master
+[twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
+[ruby-tests-action-shield]: https://github.com/julianrubisch/attractor/workflows/Ruby%20Tests/badge.svg
+<!-- Media -->
+[demo-gif]: https://user-images.githubusercontent.com/4352208/67033292-b41e4280-f115-11e9-8c91-81b3bea4451c.gif
+[logo-source]: https://thenounproject.com/term/black-hole/1043893
+<!-- References -->
+[medium-article]: https://medium.com/better-programming/why-i-made-my-own-code-quality-tool-c44b40ceaafd
+[sandi-metz-article]: https://www.sandimetz.com/blog/2017/9/13/breaking-up-the-behemoth
+[michael-feathers-article]: https://www.agileconnection.com/article/getting-empirical-about-refactoring
+[bundler]: https://bundler.io
+[rack-livereload]: https://github.com/johnbintz/rack-livereload
+[guard-livereload]: https://github.com/guard/guard-livereload
+[attractor-action]: https://github.com/julianrubisch/attractor-action
+[attractor-action-marketplace]: https://github.com/marketplace/actions/attractor-action
+[repo]: https://github.com/julianrubisch/attractor
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/julianrubisch/attractor">
+    <img src="https://user-images.githubusercontent.com/4352208/65411858-3dc84200-ddee-11e9-99b6-c9cdbeb533c5.png" alt="Logo" width="80" height="80">
+  </a>
+  <h2 align="center">Attractor</h2>
+  <p align="center">A code complexity metrics visualization and exploration tool for Ruby and JavaScript</p>
+
+---
+
+<!-- PROJECT SHIELDS -->
+![Build Status][build-status]
+![Ruby Tests Action Status][ruby-tests-action-shield]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
+  <a href="https://www.patreon.com/user?u=24747270"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="Become a Patron!" width="160" /></a>
+</div>
 
-![attractor_v0 6 1](https://user-images.githubusercontent.com/4352208/67033292-b41e4280-f115-11e9-8c91-81b3bea4451c.gif)
+<!-- GIF -->
+![attractor_v0 6 1][demo-gif]
 
-Many authors ([Michael Feathers](https://www.agileconnection.com/article/getting-empirical-about-refactoring), [Sandi Metz](https://www.sandimetz.com/blog/2017/9/13/breaking-up-the-behemoth)) have shown that an evaluation of churn vs complexity of files in software projects provide a valuable metric towards code quality. This is another take on the matter, for ruby code, using the `churn` and `flog` projects.
+## Table of Contents
 
-Here's an [article on medium](https://medium.com/better-programming/why-i-made-my-own-code-quality-tool-c44b40ceaafd) explaining the approach in greater detail.
+- [Table of Contents](#table-of-contents)
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Live Reloading](#live-reloading)
+- [CI Usage](#ci-usage)
+  - [Github Action](#github-action)
+  - [Gitlab Example](#gitlab-example)
+- [CLI Commands and Options](#cli-commands-and-options)
+- [Development](#development)
+- [Contributing](#contributing)
+- [Logo Attribution](#logo-attribution)
+- [Contributors ✨](#contributors-%e2%9c%a8)
 
-## Table of Contents
+## Introduction
 
-  * [Installation](#installation)
-  * [Usage](#usage)
-    + [Live Reloading](#live-reloading)
-  * [CI Usage](#ci-usage)
-    + [Github Action](#github-action)
-    + [Gitlab Example](#gitlab-example)
-  * [CLI Commands and Options](#cli-commands-and-options)
-  * [Development](#development)
-  * [Contributing](#contributing)
-  * [Social](#social)
-  * [Logo Attribution](#logo-attribution)
+Many authors ([Michael Feathers][michael-feathers-article], [Sandi Metz][sandi-metz-article] have shown that an evaluation of churn vs complexity of files in software projects provide a valuable metric towards code quality. This is another take on the matter, for ruby code, using the `churn` and `flog` projects.
+
+Here's an [article on medium][medium-article] explaining the approach in greater detail.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Attractor's installation is standard for a Ruby gem:
+
+```sh
+gem install attractor
+```
+
+You'll also want to install some plugins to go along with the main gem:
+
+```sh
+gem install attractor-ruby # https://github.com/julianrubisch/attractor-ruby
+gem install attractor-javascript # https://github.com/julianrubisch/attractor-javascript
+```
+
+You will most likely want to install Attractor using [Bundler][bundler]:
 
 ```ruby
 gem 'attractor'
+gem 'attractor-ruby'
+gem 'attractor-javascript'
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install attractor
+```sh
+bundle
+```
 
 ## Usage
 
-To create a HTML report in `attractor_output/index.html`, try
-    
-    $ attractor report
+To create a HTML report in `attractor_output/index.html`:
+
+```sh
+attractor report
+```
 
 If you'd like to specify a directory, use the file prefix option:
 
-    $ attractor report --file_prefix app/models
+```sh
+attractor report --file_prefix app/models
+```
 
 Or shorter:
 
-    $ attractor report -p app/models
+```sh
+attractor report -p app/models
+```
 
-Check javascript:
+Check JavaScript:
 
-    $ attractor report -p app/javascript -t js
+```sh
+attractor report -p app/javascript -t js
+```
 
 Watch for file changes:
 
-    $ attractor report -p app/models --watch
+```sh
+attractor report -p app/models --watch
+```
+
+Serve at `http://localhost:7890`:
 
-Serve at http://localhost:7890:
+```sh
+attractor serve -p app/models
+```
 
-    $ attractor serve -p app/models
+Enable [rack-livereload][rack-livereload]:
 
-Enable rack-livereload:
+```sh
+attractor serve -p app/models --watch
+```
 
-    $ attractor serve -p app/models --watch
+_Make sure you prefix these commands with `bundle exec` if you are using Bundler._
 
 ### Live Reloading
 
-If you have `guard-livereload` (or a similar service) running on your project, you can leverage the hot reloading functionality by specifying `--watch|-w`. Attractor will then live-reload the browser window when a file watched by `guard-livereload` changes.
+If you have [guard-livereload][guard-livereload] (or a similar service) running on your project, you can leverage the hot reloading functionality by specifying `--watch|-w`. Attractor will then live-reload the browser window when a file watched by `guard-livereload` changes.
 
 ## CI Usage
 
@@ -79,7 +159,9 @@ To use this CLI in a CI environment, use the `--ci` option, which will suppress
 
 ### Github Action
 
-There is a dedicated [Github Action](https://github.com/julianrubisch/attractor-action) that will compile Attractor's output. Here's the action on the [Marketplace](https://github.com/marketplace/actions/attractor-action).
+There is a dedicated [Github Action][attractor-action] that will compile Attractor's output.
+
+You can quickly integrate it into your action's workflow by grabbing it on the [Marketplace][attractor-action-marketplace].
 
 ### Gitlab Example
 
@@ -98,56 +180,57 @@ attractor:
       - attractor_output
 ```
 
-Alternatively, 
-
 ## CLI Commands and Options
 
 Print a simple output to console:
 
-    $ attractor calc
-    $   --file_prefix|-p app/models
-    $   --type|-t rb|js
-    $   --watch|-w
-    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
-    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
+```sh
+attractor calc
+  --file_prefix|-p app/models
+  --type|-t rb|js
+  --watch|-w
+  --start_ago|-s  (e.g. 5y, 3m, 7w)
+  --minimum_churn|-c (minimum times a file must have changed to be processed)
+```
 
 Generate a full report
 
-    $ attractor report 
-    $   --file_prefix|-p app/models
-    $   --type|-t rb|js
-    $   --watch|-w
-    $   --no-open-browser|--ci
-    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
-    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
+```sh
+attractor report
+  --file_prefix|-p app/models
+  --type|-t rb|js
+  --watch|-w
+  --no-open-browser|--ci
+  --start_ago|-s  (e.g. 5y, 3m, 7w)
+  --minimum_churn|-c (minimum times a file must have changed to be processed)
+```
 
-Serve the output on http://localhost:7890
+Serve the output on `http://localhost:7890`
 
-    $ attractor serve
-    $   --file_prefix|-p app/models
-    $   --watch|-w
-    $   --no-open-browser|--ci
-    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
-    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
+```sh
+attractor serve
+  --file_prefix|-p app/models
+  --watch|-w
+  --no-open-browser|--ci
+  --start_ago|-s  (e.g. 5y, 3m, 7w)
+  --minimum_churn|-c (minimum times a file must have changed to be processed)
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To run all tests, run `bin/test`. You can run the specs by themselves with `bundle exec rspec`, and the cucumber features with `bundle exec cucumber`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/julianrubisch/attractor.
-
-## Social
-
-[Twitter](https://twitter.com/AttractorGem)
-
-[Patreon](https://www.patreon.com/user?u=24747270)
+Bug reports and pull requests are welcome on [GitHub][repo].
 
 ## Logo Attribution
-[Black Hole by Eynav Raphael from the Noun Project](https://thenounproject.com/term/black-hole/1043893)
+
+[Black Hole by Eynav Raphael from the Noun Project][logo-source]
 
 ## Contributors ✨
 

data/bin/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+echo "== Running Specs =="
+bundle exec rspec
+echo "== Running Cucumber Features =="
+bundle exec cucumber

data/lib/attractor/cli.rb

@@ -17,6 +17,14 @@ module Attractor
                         [:no_open_browser, type: :boolean],
                         [:ci, type: :boolean]]
 
+    desc "version", "Prints Attractor's version information"
+    map %w(-v --version) => :version
+    def version
+      puts "Attractor version #{Attractor::VERSION}"
+    rescue RuntimeError => e
+      puts "Runtime error: #{e.message}"
+    end
+
     desc 'calc', 'Calculates churn and complexity for all ruby files in current directory'
     shared_options.each do |shared_option|
       option(*shared_option)

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-06 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -379,6 +379,7 @@ files:
 - attractor.gemspec
 - bin/console
 - bin/setup
+- bin/test
 - dist/calculator.bundle.js
 - exe/attractor
 - lib/attractor.rb