danger-app_size_report 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ae19f7d03dad68a467738ede966441747a12a27a5a0b572de6c25de2bef082e
+  data.tar.gz: 5d9765041e4e3b4731d3263f397f1957995ad89fe09ce9e274119953d8255e54
+SHA512:
+  metadata.gz: 7c90b189990e4d26379f21523a11c52525bc4a4f4dc3947c8a1f55cfb47758e23d6ea38f5c3cfd5f55a689fc356ebb7996d4fe86d8b7f0f87f336460cc79d340
+  data.tar.gz: 3751d8710bc6595d6b513726370e78e5f3b99474f54d21f0e79cb8f3ec5a5114b425b504ccf6581e2ef35e57c1e54d475630eeeb1d4aebf41c54d6105e609234

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Vido Shaweddy <vido.shaweddy@chargepoint.com>
+
+MIT License
+
+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,17 @@
+# danger-app_size_report
+
+Danger-app_size_report. A danger plugin for reporting app sizes.
+
+## Installation
+    put `$ gem danger-app_size_report` to your project 'Gemfile'
+
+## Usage
+
+    Simply add `app_size_report.report` to your `Dangerfile` passing the path to report JSON path and app size limit.
+
+    ```ruby
+    app_size_report.report(
+        "./report.json", 
+        10
+    )
+    ```

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-app_size_report.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_size_report/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-app_size_report'
+  spec.version       = AppSizeReport::VERSION
+  spec.authors       = ['Vido Shaweddy']
+  spec.email         = ['vido.shaweddy@chargepoint.com']
+  spec.description   = %q{A danger plugin for reporting app sizes.}
+  spec.summary       = %q{Validates variant sizes of app thinning report json within a Pull Request and generates a brief report.}
+  spec.homepage      = 'https://github.com/ChargePoint/danger-app_size_report'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/app_size_report/gem_version.rb

@@ -0,0 +1,3 @@
+module AppSizeReport
+  VERSION = "0.0.1".freeze
+end

data/lib/app_size_report/plugin.rb

@@ -0,0 +1,111 @@
+require 'json'
+require 'set'
+
+module Danger
+  # Validates variant sizes of app thinning report json within a Pull Request and generates a brief report.
+  #
+  # @example Validating code coverage for app_th (easy-peasy.io)
+  #
+  #    # Get the path to your app thinning report
+  #   
+  #    # The result is sent to the pull request with a markdown format and
+  #    # notifies failure which variants is violating the size limit.
+  #
+  #    app_size_report.report(
+  #      [path_to_report],
+  #      [app_size_limit]
+  #    )
+  #
+  class DangerAppSizeReport < Plugin
+    # A method that create app thinning report
+    # @return   [Array<Variant>]
+    #
+    def report(report_path, app_size_limit)
+      if File.exist?(report_path)
+        report = File.read(report_path)
+        json = JSON.parse(report)
+        
+        flagged_variants = parse_json(*json, app_size_limit)
+
+        if flagged_variants.length > 0
+          failure "The App Clip size limit of 10 MB has been exceeded by one or more variants"
+        end
+
+        init_app_size_violation_table(*json, flagged_variants, app_size_limit)
+        init_supported_variant_descriptors(*json)
+        init_ads()
+      end
+    end
+
+    # A method that create an array of variants that violate app size limit
+    # @return   [Array<Variant>]
+    #
+    def parse_json(*json, app_size_limit)
+      flagged_variants = Array.new
+
+      json.each do |variant, value|
+        app_size = variant["app_size"]["uncompressed"]["value"]
+        app_odr_size = variant["app_on_demand_resources_size"]["uncompressed"]["value"]
+        if app_size > app_size_limit || app_odr_size > app_size_limit
+          flagged_variants.append(variant)
+        end
+      end
+      
+      if flagged_variants.length > 0
+        failure "The App Clip size limit of 10 MB has been exceeded by one or more variants"
+      end
+
+      return flagged_variants
+    end
+
+    # A method that create the violation table in Github
+    # 
+    #
+    def init_app_size_violation_table(*json, flagged_variants, app_size_limit)
+      size_report = "# App Thinning Size Report\n"
+      size_report << "### Size limit = #{app_size_limit} MB\n\n"
+      size_report << "| Under Limit | Variant | App Size - Compressed | App Size - Uncompressed | ODR Size - Compressed | ODR Size - Uncompressed |\n"
+      size_report << "| ---------- | ------- | --------------------- | --------------------- | --------------------- | --------------------- |\n"
+      flagged_variants_set = flagged_variants.to_set
+      json.each do |variant, _|
+        isViolating = flagged_variants_set.include?(variant) ? "❌" : "✅"
+        app_size_compressed = "#{variant["app_size"]["compressed"]["value"]} #{variant["app_size"]["uncompressed"]["unit"]}"
+        app_size_uncompressed = "#{variant["app_size"]["uncompressed"]["value"]} #{variant["app_size"]["uncompressed"]["unit"]}" 
+        odr_size_compressed = "#{variant["on_demand_resources_size"]["compressed"]["value"]} #{variant["app_size"]["uncompressed"]["unit"]}"
+        odr_size_uncompressed = "#{variant["on_demand_resources_size"]["uncompressed"]["value"]} #{variant["app_size"]["uncompressed"]["unit"]}"
+        
+        size_report << "#{isViolating} | #{variant["variant"]} | #{app_size_compressed} | #{app_size_uncompressed} | #{odr_size_compressed} | #{odr_size_uncompressed} |\n"
+      end
+
+      markdown size_report
+    end
+
+    # A method that create the supported variant table in Github
+    # 
+    #
+    def init_supported_variant_descriptors(*json)
+      variant_descriptor_report = "### Supported Variant Descriptors \n\n"
+      json.each do |variant, _|
+        variant_descriptor_report << "<details> \n"
+        variant_descriptor_report << "<summary> Variant #{variant["variant"]} </summary> \n\n"
+        variant_descriptor_report << "| Model | Operating System | \n"
+        variant_descriptor_report << "| ----- | ---------------- | \n"
+        variant["supported_variant_descriptors"].each do |model, _|
+          variant_descriptor_report << "#{model["device"]} | #{model["os_version"]} | \n"
+        end
+        variant_descriptor_report << "</details> \n\n"
+      end
+
+      markdown variant_descriptor_report
+    end
+
+    # A method that create the footnote label in Github
+    # 
+    #
+    def init_ads
+      ads_label = "Powered by [danger-app_size_report](https://github.com/ChargePoint)"
+      markdown ads_label
+    end
+
+  end
+end

data/lib/danger_app_size_report.rb

@@ -0,0 +1 @@
+require "app_size_report/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "app_size_report/plugin"

data/spec/app_size_report_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerAppSizeReport do
+    it "should be a plugin" do
+      expect(Danger::DangerAppSizeReport.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.app_size_report
+
+        # mock the PR data
+        # you can then use this, eg. github.pr_author, later in the spec
+        json = File.read(File.dirname(__FILE__) + '/support/fixtures/github_pr.json') # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
+        allow(@my_plugin.github).to receive(:pr_json).and_return(json)
+      end
+
+      # Some examples for writing tests
+      # You should replace these with your own.
+
+      it "Warns on a monday" do
+        monday_date = Date.parse("2016-07-11")
+        allow(Date).to receive(:today).and_return monday_date
+
+        @my_plugin.warn_on_mondays
+
+        expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+      end
+
+      it "Does nothing on a tuesday" do
+        monday_date = Date.parse("2016-07-12")
+        allow(Date).to receive(:today).and_return monday_date
+
+        @my_plugin.warn_on_mondays
+
+        expect(@dangerfile.status_report[:warnings]).to eq([])
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ''
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: danger-app_size_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vido Shaweddy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: 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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: yard
+  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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !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'
+description: A danger plugin for reporting app sizes.
+email:
+- vido.shaweddy@chargepoint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-app_size_report.gemspec
+- lib/app_size_report/gem_version.rb
+- lib/app_size_report/plugin.rb
+- lib/danger_app_size_report.rb
+- lib/danger_plugin.rb
+- spec/app_size_report_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ChargePoint/danger-app_size_report
+licenses:
+- MIT
+metadata: {}
+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.2.3
+signing_key:
+specification_version: 4
+summary: Validates variant sizes of app thinning report json within a Pull Request
+  and generates a brief report.
+test_files:
+- spec/app_size_report_spec.rb
+- spec/spec_helper.rb