attractor-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b08f5079f640ca044dfdbbbc86c84e3db91fea4845e43a473e49ae35ad3bf9c1
-  data.tar.gz: e614b92f84cba0cb1b9c46f94958b8c6058966aa3bea673f3feaa2c534c51f42
+  metadata.gz: 839e5677606f57d100c540ed9174b861f023fea46d2971f8d764a9041d03541e
+  data.tar.gz: 6bc124d3f394777e1b9606d32ae7e9a4e054ff0d9e36657c202e4054fc8c2710
 SHA512:
-  metadata.gz: 46aa6d89c4347fc3cbbbe8892a2db5d8099e8b423d896cf18b5fe1b20c71b0cdd664a97ed590ddd689cb2ebe1628826b68f7590c5f422057151af6e56c4da40b
-  data.tar.gz: 89a2efff10f776db3c47c4f8e1ea60f18484925f9fe7f4a2b0ecf7eb2c496b3f8bdba97f4a741211abfcc6a6698a89f6e8c5f5d0b6935e5090d635eea70aa092
+  metadata.gz: bd9888f9f014fd6ebb77374056804fca152f127d1b82ecad4770c75e1fd7801e5a72a37a0f9bc618864f3712e7702d442f26fc2ab015e27127869e39afb208dc
+  data.tar.gz: f9febb52b9b74e5d3748a2b07d630cb444d7e34a7a7a42d6f035db273568f5e30f4b08e89d3d0b77d9c1645d6313fa228f606ef2ce233d49c5b0ebf768acbaf9

data/README.md

@@ -1,28 +1,118 @@
-# Attractor::Rails
-Short description and motivation.
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- Shields -->
+[forks-shield]: https://img.shields.io/github/forks/julianrubisch/attractor-rails.svg?style=flat-square
+[forks-url]: https://github.com/julianrubisch/attractor-rails/network/members
+[stars-shield]: https://img.shields.io/github/stars/julianrubisch/attractor-rails.svg?style=flat-square
+[stars-url]: https://github.com/julianrubisch/attractor-rails/stargazers
+[issues-shield]: https://img.shields.io/github/issues/julianrubisch/attractor-rails.svg?style=flat-square
+[issues-url]: https://github.com/julianrubisch/attractor-rails/issues
+[license-shield]: https://img.shields.io/github/license/julianrubisch/attractor-rails.svg?style=flat-square
+[license-url]: https://github.com/julianrubisch/attractor-rails/blob/master/LICENSE
+[build-status]: https://travis-ci.org/julianrubisch/attractor-rails.svg?branch=master
+[twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
 
-## Usage
-How to use my plugin.
+<!-- Media -->
+[logo-source]: https://thenounproject.com/term/black-hole/1043893
+
+[repo]: https://github.com/julianrubisch/attractor-rails
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/julianrubisch/attractor-rails">
+    <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 Rails Engine</h2>
+  <p align="center">A code complexity metrics visualization and exploration tool for Ruby and JavaScript</p>
+  <p align="center">baked into a mountable Rails Engine</p>  
+
+---
+
+<!-- PROJECT SHIELDS -->
+![Build Status][build-status]
+[![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-1-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>
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+- [Logo Attribution](#logo-attribution)
+- [Contributors ✨](#contributors-%e2%9c%a8)
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Add the gem to your Gemfile:
 
 ```ruby
-gem 'attractor-rails'
+group :development do
+  gem 'attractor-rails'
+end
 ```
 
 And then execute:
-```bash
-$ bundle
+
+```sh
+bundle install
+```
+
+This will install `attractor`, along with two plugins (`attractor-ruby`, `attractor-javascript`) for you.
+
+Mount the engine in your `routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Attractor::Rails::Engine, at: "/attractor" if Rails.env.development?
+# ...
+end
 ```
 
-Or install it yourself as:
-```bash
-$ gem install attractor-rails
+And that's it! Browse to http://localhost:3000/attractor and enjoy your code metrics!
+
+## Configuration
+
+`attractor-rails` ships with sensible defaults, but you can override the following configuration options in an initializer, if you like:
+
+```ruby
+# config/initializers/attractor.rb
+Attractor::Rails.minimum_churn_count = 1     # default: 3
+Attractor::Rails.file_prefix = "app"         # default: ""
+Attractor::Rails.start_ago = "3m"            # default: "5y"
 ```
 
 ## Contributing
-Contribution directions go here.
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on [GitHub][repo].
+
+## Logo Attribution
+
+[Black Hole by Eynav Raphael from the Noun Project][logo-source]
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Documentation">📖</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/app/controllers/attractor/rails/reporter_controller.rb

@@ -23,7 +23,8 @@ module Attractor::Rails
 
     def suggestions
       threshold = params[:t] || 95
-      render json: @reporter.suggestions(threshold).map(&:to_h)
+      type = params[:type] || "rb"
+      render json: @reporter.suggestions(quantile: threshold, type: type).map(&:to_h)
     end
 
     private

data/lib/attractor/rails/version.rb

@@ -1,5 +1,5 @@
 module Attractor
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -138,7 +138,7 @@ homepage: https://github.com/julianrubisch/attractor-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Churn vs Complexity Chart Generator
 test_files: []