pocky 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4c00f616a39cb65bc9c21cc400499fc9342ac9eba29717662410c5b1cabbbd9
+  data.tar.gz: 8beb8794798ebf9e5bc31fc154a0a82602debe9f101d09a6d48b11cfd9e30ea1
+SHA512:
+  metadata.gz: de3d8cadae4b6167c2963d1960781236229b1cefdf3dc4ac8bf4a3942843f1926689e60a51a2c68d2d85dbf4efc7c54d9cd0422e86a9aa689167acadd99ca0fc
+  data.tar.gz: d75db5ddda124dc0d27409339a70bd5287f1c7b2710be9097cc5ebd5d835fa5f89891ec288b929315222d3884dea18fea49c3010d2941a8ec302de199809c540

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pocky.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    pocky (1.0.0)
+      ruby-graphviz (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    ruby-graphviz (1.2.5)
+      rexml
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  pocky!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Quan Nguyen
+
+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,47 @@
+# Pocky
+
+Pocky is used to generate dependency graphs for your packwerk packages. The gem is named after pocky, a beloved Japanese snack that comes in small packages.
+
+![Pocky](https://user-images.githubusercontent.com/138784/103248942-c141de80-4921-11eb-99bd-3744816abc37.png)
+
+## Usage
+
+```ruby
+Pocky::Graph.generate(
+  root_path: 'path/to/app/packages',
+  default_package: 'The Monolith', # The default package listed as "." in deprecated_references.yml
+  package_prefix: 'app/packages', # this is for matching package names listed in deprecated_references.yml
+  output_filename: 'pocky-graph.png'
+)
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pocky'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pocky
+
+## 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.
+
+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 the created tag, 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]/pocky.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pocky"
+
+# 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/pocky.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'pocky/version'
+require_relative 'pocky/graph'
+
+module Pocky
+end

data/lib/pocky/graph.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'ruby-graphviz'
+
+module Pocky
+  class Graph
+    def self.generate(params)
+      new(**params).generate
+    end
+
+    private_class_method :new
+    def initialize(
+      root_path:,
+      default_package: 'Default',
+      package_prefix: '',
+      image_filename: 'pocky-graph.png'
+    )
+      @root_path = root_path
+      @default_package = default_package
+      @package_prefix = package_prefix
+      @output_filename = image_filename
+
+      @deprecated_references = {}
+      @nodes = {}
+    end
+
+    def generate
+      load_package_dependencies
+      build_directed_graph
+    end
+
+    private
+
+    def build_directed_graph
+      graph = GraphViz.new(:G, type: :digraph, dpi: 300)
+      @deprecated_references.each do |package, references|
+        @nodes[package] ||= graph.add_nodes(package)
+        references.each do |provider, dependencies|
+          provider_package = package_name_for_dependency(provider)
+          @nodes[provider_package] ||= graph.add_nodes(provider_package)
+
+          graph.add_edges(
+            @nodes[package],
+            @nodes[provider_package],
+            penwidth: edge_width(dependencies.length)
+          )
+        end
+      end
+
+      graph.output(png: )
+    end
+
+    def edge_width(count)
+      [
+        [(count / 5).to_i, 1].max,
+        5
+      ].min
+    end
+
+    def load_dependencies
+      Dir.each_child(@root_path) do |elem|
+        if Dir.exist?(File.join(@root_path, elem))
+          load_deprecated_references_for_package(elem)
+        end
+      end
+    end
+
+    def load_deprecated_references_for_package(package)
+      @deprecated_references[package] ||= begin
+        filename = deprecated_references_file_for(package)
+        if File.exist?(filename)
+          YAML.load_file(filename) || {}
+        else
+          {}
+        end
+      end
+    end
+
+    def deprecated_references_file_for(package)
+      File.join(@root_path, package, 'deprecated_references.yml')
+    end
+
+    def package_name_for_dependency(name)
+      return @default_package if name == '.'
+
+      name.gsub(@package_prefix, '').gsub(/^\//, '')
+    end
+  end
+end

data/lib/pocky/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pocky
+  VERSION = "1.0.0"
+end

data/pocky.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/pocky/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pocky"
+  spec.version       = Pocky::VERSION
+  spec.authors       = ["Quan Nguyen"]
+  spec.email         = ["mquannie@gmail.com"]
+
+  spec.summary       = "A ruby gem that generates dependency graph for your packwerk packages"
+  spec.description   = "A ruby gem that generates dependency graph for your packwerk packages"
+  spec.homepage      = "https://github.com/mquan/pocky"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mquan/pocky"
+  spec.metadata["changelog_uri"] = "https://github.com/mquan/pocky"
+
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|static)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency "ruby-graphviz", "~> 1"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: pocky
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Quan Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A ruby gem that generates dependency graph for your packwerk packages
+email:
+- mquannie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pocky.rb
+- lib/pocky/graph.rb
+- lib/pocky/version.rb
+- pocky.gemspec
+homepage: https://github.com/mquan/pocky
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mquan/pocky
+  source_code_uri: https://github.com/mquan/pocky
+  changelog_uri: https://github.com/mquan/pocky
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A ruby gem that generates dependency graph for your packwerk packages
+test_files: []