entruby 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9891022b30149b2a54971b292957b6c32374d4c40dd13b316afe3ad8f456ba0d
+  data.tar.gz: 5ff335f46aac2c12e77a2085d2609a75dc8d344b2f1a57f943ba1ef1483e0d82
+SHA512:
+  metadata.gz: 226a60b530abe737bf4fe598ce6dad4c0d0a89a0a0af610c1747d9ded61b2fcfba5b5704d857d733ed9e3ddae8f6eec4d6a09173a6006cded4c64bd73e362a31
+  data.tar.gz: cb3a456af8a3e58b5a615c24aa44e3aaecc17c01923075b9056ac9fd8317ab89c4907dc55c008453c744870ce6a91660a285b8f9c8a7fab72316100002abe360

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at canmor.lam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in entruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Canmor Lam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Entruby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/entruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'entruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install entruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/entruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Entruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/entruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "entruby"
+
+# 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/entruby.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "entruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "entruby"
+  spec.version       = Entruby::VERSION
+  spec.authors       = ["Canmor Lam"]
+  spec.email         = ["canmor.lam@gmail.com"]
+
+  spec.summary       = "Entropy in ruby"
+  spec.description   = "Entropy in ruby"
+  spec.homepage      = "https://canmor.lams.io"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end + Dir["vendor/**/*"].reject { |f| f.match(%r{(report\.json|\.map)$}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.10"
+  spec.add_runtime_dependency "doxyparser", "~> 1.5"
+  spec.add_runtime_dependency "launchy", "~> 2.5"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

data/exe/entruby

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require "entruby"
+require "json"
+require 'uri'
+require "launchy"
+require "fileutils"
+
+app = Entruby::App.new(ARGV)
+report = app.report
+
+output_dir = File.expand_path(app.output_dir)
+output_dir = File.join(output_dir, 'shower')
+
+shower_dir = File.join(__dir__, '..', 'vendor', 'shower')
+FileUtils.copy_entry shower_dir, output_dir
+
+File.open(File.join(output_dir, 'report.json'), 'w') { |file| file.write(JSON.dump(report)) }
+puts "Index is: #{report[:overview][:index]}"
+report[:overview][:metrics].each { |metric| puts "  - #{metric[:name]}: #{metric[:value]}" }
+
+puts "
+Report is generated to: #{output_dir}
+Launching browser to reveal report..."
+
+uri = URI.join('file:///', File.join(output_dir, 'index.html'))
+Launchy.open(uri)

data/lib/entruby.rb

@@ -0,0 +1,167 @@
+require "entruby/version"
+require "doxyparser"
+require "find"
+
+class Reference
+  def initialize(element)
+    @id = element[:refid]
+    @content = element.content
+  end
+
+  # @return Doxyparser::Function
+  def reveal(collection)
+    collection.find { |member| member.basename == @content }
+  end
+end
+
+module Doxyparser
+  class Member
+    def col
+      aux = self.xpath("location")[0]
+      bodyEnd, bodyStart = aux["bodyend"], aux["bodystart"]
+      @col = bodyEnd && bodyStart ? Integer(bodyEnd) - Integer(bodyStart) : nil
+    end
+  end
+
+  class Param
+    def as_json(*)
+      {type: {name: type.name, basename: type.basename}, name: declname}
+    end
+  end
+
+  class Function
+    # @return Array[Reference]
+    def references
+      node.css('references').map { |ref| Reference.new(ref) }
+    end
+
+    def referenced_by
+      node.css('referencedby').map { |ref| Reference.new(ref) }
+    end
+
+    def efferent(all = nil)
+      all.to_a.empty? ? references : references.map { |ref| ref.reveal(all) }.compact
+    end
+
+    def afferent(all = nil)
+      all.to_a.empty? ? referenced_by : referenced_by.map { |ref| ref.reveal(all) }.compact
+    end
+
+    def fan_out(all = nil)
+      efferent(all).size
+    end
+
+    def fan_in(all = nil)
+      afferent(all).size
+    end
+
+    def coupling_metric(all = nil)
+      fan_out = fan_out(all).to_f
+      fan_in = fan_in(all).to_f
+      denominator = fan_out + fan_in
+      denominator == 0 ? 0 : fan_out / (denominator)
+    end
+
+    def global_name
+      "global::#{signature}"
+    end
+
+    def valid_params
+      params.reject { |p| p.type.name == 'void' }
+    end
+
+    def signature
+      "#{basename}(#{valid_params.map { |p| p.type.name }.join(', ')})"
+    end
+
+    # @return Report
+    def report(all)
+      {id: id, name: basename, signature: signature, location: location, metric: coupling_metric(all), col: col,
+       params: valid_params.map(&:as_json),
+       imports: efferent(all).map(&:signature)}
+    end
+  end
+end
+
+module Entruby
+  class Error < StandardError; end
+
+  class OverviewMetric
+    attr_reader :name, :description, :value, :weight
+
+    def initialize(name, description, value, weight)
+      @name, @description, @value, @weight = name, description, value, weight
+    end
+
+    def as_json(*args)
+      {name: name, description: description, value: value, weight: weight}
+    end
+  end
+
+  class Overview
+    attr_reader :metrics
+
+    COMPLEX_FUNCTION_PARAMS = 7
+    HIGH_COUPLING_METRIC = 0.7
+    HUGE_FUNCTION_COL = 50
+
+    def initialize(couplings)
+      huge_functions = couplings.count { |c| c[:col] >= HUGE_FUNCTION_COL }
+      complex_functions = couplings.count { |c| c[:params].size >= COMPLEX_FUNCTION_PARAMS }
+      couplers = couplings.count { |c| c[:metric] >= HIGH_COUPLING_METRIC }
+      @metrics = [
+          OverviewMetric.new("Excessive Couplers", "(Metric >= 0.7)", couplers, 3),
+          OverviewMetric.new("Complex Functions", "(Params >= 7)", complex_functions, 2),
+          OverviewMetric.new("Huge Functions", "(CoL >= 50)", huge_functions, 1),
+      ]
+    end
+
+    def report
+      {index: index, metrics: metrics.map(&:as_json)}
+    end
+
+    def index
+      metrics.reduce(0.0) { |memo, metric| memo + metric.value * metric.weight }
+    end
+  end
+
+  class App
+    attr_reader :output_dir
+
+    def initialize(argv)
+      if argv.size < 2
+        puts "USAGE: $ entruby <source directory> <doxygen xml directory>"
+        exit 1
+      end
+
+      @source_dir, @xml_dir, @output_dir = argv[0], argv[1], Dir.pwd
+    end
+
+    # @return [Array<Doxyparser::Function>]
+    def functions
+      source_file_paths = []
+      Find.find(@source_dir) do |path|
+        source_file_paths << File.basename(path).gsub('_', '__') if path =~ /.*\.c$/
+      end
+      source_file_paths.reduce([]) do |functions, file|
+        hfile = Doxyparser::parse_file(file, @xml_dir)
+        functions + hfile.functions
+      end
+    end
+
+    def functions_report
+      all_functions = functions
+      report = all_functions.map { |func| func.report(all_functions) }
+      report.sort_by! { |row| row[:metric] }.reverse!
+    end
+
+    def overview(couplings)
+      Overview.new(couplings).report
+    end
+
+    def report
+      couplings = functions_report
+      {overview: overview(couplings), functions: couplings}
+    end
+  end
+end

data/lib/entruby/version.rb

@@ -0,0 +1,3 @@
+module Entruby
+  VERSION = "0.1.2"
+end