attractor-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f49f91fe9ce4ac23462d87c370dc81c9d566df19c9c830e0b5d0718eb7e88be1
+  data.tar.gz: d1203212d502ff645aebde5652f3bfc906db3270429cb74e3eb271283a7358a1
+SHA512:
+  metadata.gz: 34dc390b7985db69ef4d8fd0f7e2dc015a84f469c5e87ac71862d4ee280514827c02728e93e4e802a91c64ac8d1168e965c5f5cc94071688947c5a36af43a241
+  data.tar.gz: a1c62f7ad1d10bf0a8750e8b4d9a4ed09b3d58dfcf57e685fd8a2978850586e00be9dea006d4d966697042d0d319e45c35773a6791030f7cc571810a4472a5eb

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+*~
+\#*\#

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in attractor-ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,138 @@
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+[attractor]: https://github.com/julianrubisch/attractor-ruby
+[forks-shield]: https://img.shields.io/github/forks/julianrubisch/attractor-ruby.svg?style=flat-square
+[forks-url]: https://github.com/julianrubisch/attractor-ruby/network/members
+[stars-shield]: https://img.shields.io/github/stars/julianrubisch/attractor-ruby.svg?style=flat-square
+[stars-url]: https://github.com/julianrubisch/attractor-ruby/stargazers
+[issues-shield]: https://img.shields.io/github/issues/julianrubisch/attractor-ruby.svg?style=flat-square
+[issues-url]: https://github.com/julianrubisch/attractor-ruby/issues
+<!-- [license-shield]: https://img.shields.io/github/license/julianrubisch/attractor-ruby.svg?style=flat-square -->
+<!-- [license-url]: https://github.com/julianrubisch/attractor-ruby/blob/master/LICENSE.txt -->
+
+<!-- PROJECT SHIELDS -->
+
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+<!--[![MIT License][license-shield]][license-url]-->
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p 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 Ruby Plugin</h2>
+</p>
+
+[Attractor][attractor] plugin for the Ruby programming language and its ecosystem
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+This is a plugin to help you visualize code complexity metrics for your Ruby code. If you are not familiar with [Attractor][attractor], take a look at the main repo first.
+
+### Installation
+
+Add this to your application's Gemfile:
+
+```ruby
+gem 'attractor'
+gem 'attractor-ruby'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+To create a HTML report in `attractor_output/index.html`, try
+
+```sh
+bundle exec attractor report
+```
+
+If you'd like to specify a directory, use the file prefix option:
+
+```sh
+bundle exec attractor report --file_prefix app/models
+```
+
+Or shorter:
+
+```sh
+bundle exec attractor report -p app/models
+```
+
+Watch for file changes:
+
+```sh
+bundle exec attractor report -p app/models --watch
+```
+
+Serve at http://localhost:7890:
+
+```sh
+bundle exec attractor serve -p app/models
+```
+
+Enable rack-livereload:
+
+```sh
+bundle exec attractor serve -p app/models --watch
+```
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<!-- LICENSE -->
+<!--## License -->
+
+<!-- Distributed under the MIT License. See `LICENSE` for more information. -->
+
+## 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="https://www.andrewmason.me/"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor-ruby/commits?author=andrewmcodes" title="Documentation">📖</a> <a href="https://github.com/julianrubisch/attractor-ruby/commits?author=andrewmcodes" title="Code">💻</a></td>
+    <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-ruby/commits?author=julianrubisch" title="Code">💻</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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/attractor-ruby.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attractor/ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attractor-ruby'
+  spec.version       = Attractor::Ruby::VERSION
+  spec.authors       = ['Julian Rubisch']
+  spec.email         = ['julian@julianrubisch.at']
+
+  spec.summary       = 'Attractor plugin for the Ruby programming language and its ecosystem'
+  spec.description   = <<-DESCRIPTION
+    Attractor plugin for the Ruby programming language and its ecosystem
+  DESCRIPTION
+  spec.homepage = 'https://github.com/julianrubisch/attractor-ruby'
+  spec.licenses = ['MIT']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/julianrubisch/attractor-ruby'
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri'] = 'https://github.com/julianrubisch/attractor-ruby/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(src|tmp|test|spec|features|\.github)/}) ||
+        %w[.all-contributorsrc .rspec .rspec_status .travis.yml].include?(f)
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'attractor', '~> 2.0'
+
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'standard'
+  spec.add_development_dependency 'structured_changelog'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attractor/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/attractor/calculators/ruby_calculator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'flog'
+
+module Attractor
+  class RubyCalculator < BaseCalculator
+    def initialize(file_prefix: '', minimum_churn_count: 3, start_ago: 365 * 5)
+      super(file_prefix: file_prefix, file_extension: 'rb', minimum_churn_count: minimum_churn_count, start_ago: start_ago)
+      @type = "Ruby"
+    end
+
+    def calculate
+      super do |change|
+        flogger = Flog.new(all: true)
+        flogger.flog(change[:file_path])
+        complexity = flogger.total_score
+        details = flogger.totals
+        [complexity, details]
+      end
+    end
+  end
+end

data/lib/attractor/detectors/ruby_detector.rb

@@ -0,0 +1,11 @@
+module Attractor
+  class RubyDetector < BaseDetector
+    def detect
+      gemfile_exists?
+    end
+    
+    def gemfile_exists?
+      File.exist? File.expand_path("Gemfile", Dir.pwd)
+    end
+  end 
+end

data/lib/attractor/ruby.rb

@@ -0,0 +1,16 @@
+require "attractor/ruby/version"
+
+require "attractor"
+require "attractor/registry_entry"
+require "attractor/calculators/base_calculator"
+require "attractor/calculators/ruby_calculator"
+require "attractor/detectors/base_detector"
+require "attractor/detectors/ruby_detector"
+
+module Attractor
+  module Ruby
+    class Error < StandardError; end
+
+    Attractor.register(Attractor::RegistryEntry.new(type: "rb", detector_class: RubyDetector, calculator_class: RubyCalculator))
+  end
+end

data/lib/attractor/ruby/version.rb

@@ -0,0 +1,5 @@
+module Attractor
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: attractor-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Rubisch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: attractor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: structured_changelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Attractor plugin for the Ruby programming language and its ecosystem\n"
+email:
+- julian@julianrubisch.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- attractor-ruby.gemspec
+- bin/console
+- bin/setup
+- lib/attractor/calculators/ruby_calculator.rb
+- lib/attractor/detectors/ruby_detector.rb
+- lib/attractor/ruby.rb
+- lib/attractor/ruby/version.rb
+homepage: https://github.com/julianrubisch/attractor-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/julianrubisch/attractor-ruby
+  source_code_uri: https://github.com/julianrubisch/attractor-ruby
+  bug_tracker_uri: https://github.com/julianrubisch/attractor-ruby/issues
+  changelog_uri: https://github.com/julianrubisch/attractor-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Attractor plugin for the Ruby programming language and its ecosystem
+test_files: []