danger-dangermattic 1.0.0

data/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/README.md

@@ -0,0 +1,68 @@
+# Dangermattic
+`Dangermattic` builds on [Danger on Ruby](https://danger.systems/ruby/) and is essentially a collection of Danger plugins. Its goal is to provide customisable checks and common utilities to help perform checks on Pull Requests, from simple routine validations to more sophisticated ones.
+
+## Installation
+
+Add to your project's `Gemfile`
+```
+gem 'danger-dangermattic', git: 'https://github.com/Automattic/dangermattic'
+```
+
+## Example of available plugins and their usage
+
+Once the main Gem is installed, all Dangermattic plugins are available in your `Dangerfile` under their corresponding namespace. A few examples:
+
+- `manifest_pr_checker` - Plugin to check if changes on a manifest file (i.e. `Gemfile`, `Podfile`) has a corresponding change in a lock file (i.e. `Gemfile.lock`, `Podfile.lock`)
+    ```ruby
+    # Reports a warning if the Gemfile was changed but the Gemfile.lock wasn't
+    manifest_pr_checker.check_gemfile_lock_updated
+    ```
+- `milestone_checker` - Plugin for performing checks on a milestone associated with a pull request
+    ```ruby
+    # Checks if the pull request's milestone is due in 3 days or less, reporting a warning if that's the case
+    milestone_checker.check_milestone_due_date(days_before_due: 3)
+    ```
+- `pr_size_checker` - Plugin to check the size of a Pull Request content and text body
+    ```ruby
+    # Reports a warning if a pull request diff size is greater than 300
+    pr_size_checker.check_diff_size(max_size: 300)
+    ```
+- `view_changes_checker` - Detects view changes in a PR and reports a warning if there are no attached screenshots
+    ```ruby
+    # Reports a warning if a pull request changing views doesn't have a screenshot
+    view_changes_checker.check
+    ```
+
+All available plugins are defined here: https://github.com/Automattic/dangermattic/tree/trunk/lib/dangermattic/plugins
+
+## Development
+
+- Clone the repo and run `bundle install` to setup dependencies
+- Run `bundle exec rake` to run the all the tests, RuboCop and Danger Lint
+- Run `bundle exec rake specs` / `bundle exec rspec` to run only the unit tests
+- Run `bundle exec rake lint` to run only the linting tasks: RuboCop and Danger Lint
+- Use `bundle exec guard` to automatically have tests run as you make changes.
+- You can generate the documentation using `bundle exec yard doc`. The documentation is generated locally in the `yard-doc/` folder.
+
+### Adding a new plugin
+
+Adding a new plugin to Dangermattic is very simple: just create a new subclass of `Danger::Plugin` inside `./lib/dangermattic/plugins/`, similarly to the other classes you'll find there:
+
+```ruby
+module Danger
+  class MyNewPluginChecker < Plugin
+    def check_method(param:)
+      # ...
+    end
+  end
+end
+```
+
+It will be [automatically imported](https://github.com/Automattic/dangermattic/blob/trunk/lib/danger_plugin.rb), exposed by Dangermattic's Gem and visible in your `Dangerfile` once you add it as a dependency:
+
+```ruby
+# In a Dangerfile
+my_new_plugin_checker.check_method(param: my_param_value)
+```
+
+Please follow the existing naming convention for validation and check plugins: classes end with a `*Checker` suffix and the main validation methods are named with a `check_*` prefix.

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :all
+
+desc 'Runs all tasks: :specs, :rubocop and :danger_lint'
+task all: %i[specs lint]
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :danger_lint do
+  sh 'bundle exec danger plugins lint'
+end
+
+desc 'Runs linting tasks: :rubocop and :danger_lint'
+task lint: %i[rubocop danger_lint]
+
+desc 'Run Unit Tests'
+RSpec::Core::RakeTask.new(:specs)
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop)

data/danger-dangermattic.gemspec

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dangermattic/gem_version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-dangermattic'
+  spec.version       = Dangermattic::VERSION
+  spec.author        = 'Automattic'
+  spec.email         = 'mobile@automattic.com'
+  spec.description   = 'A shared collection of Danger plugins'
+  spec.summary       = 'A shared collection of Danger plugins'
+  spec.homepage      = 'https://github.com/Automattic/dangermattic'
+  spec.license       = 'MPL-2.0'
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 3.2'
+
+  spec.add_dependency 'danger', '~> 9.4'
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # Danger plugins
+  spec.add_dependency 'danger-junit', '~> 1.0'
+  spec.add_dependency 'danger-rubocop', '~> 0.12'
+  spec.add_dependency 'danger-swiftlint', '~> 0.35'
+  spec.add_dependency 'danger-xcode_summary', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.1'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_dependency 'rubocop', '~> 1.60'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'yard'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.18'
+  spec.add_development_dependency 'guard-rspec', '~> 4.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/danger_dangermattic.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'dangermattic/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'dangermattic/plugins', '*.rb')].each { |file| require file }
+Dir[File.join(__dir__, 'dangermattic/plugins/common', '*.rb')].each { |file| require file }

data/lib/dangermattic/gem_version.rb

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

data/lib/dangermattic/plugins/android_release_checker.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Danger
+  # Plugin for performing Android release-related checks in a pull request.
+  #
+  # @example Checking Android release notes and Play Store strings:
+  #          android_release_checker.check_release_notes_and_play_store_strings
+  #
+  # @example Checking for changes in internal release notes:
+  #          android_release_checker.check_internal_release_notes_changed
+  #
+  # @see Automattic/dangermattic
+  # @tags android, process, release
+  #
+  class AndroidReleaseChecker < Plugin
+    STRINGS_FILE = 'strings.xml'
+    MESSAGE_STRINGS_FILE_UPDATED = "`#{STRINGS_FILE}` files should only be updated on release branches, when the translations are downloaded by our automation.".freeze
+
+    # Checks if changes made to the release notes are also followed by changes in the Play Store strings file.
+    #
+    # @return [void]
+    def check_release_notes_and_play_store_strings
+      common_release_checker.check_release_notes_and_store_strings(
+        release_notes_file: 'metadata/release_notes.txt',
+        po_file: 'metadata/PlayStoreStrings.po'
+      )
+    end
+
+    # Checks if any strings file (values*/strings.xml) has been modified on a release branch, otherwise reporting a warning / error.
+    #
+    # @return [void]
+    def check_modified_strings_on_release(report_type: :warning)
+      common_release_checker.check_file_changed(
+        file_comparison: ->(path) { File.basename(path) == STRINGS_FILE },
+        message: MESSAGE_STRINGS_FILE_UPDATED,
+        on_release_branch: false,
+        report_type: report_type
+      )
+    end
+
+    # Check if there are changes to the internal release notes file RELEASE-NOTES.txt and report a message if that's the case.
+    #
+    # @param report_type [Symbol] (optional) The type of report for the message. Types: :error, :warning (default), :message.
+    #
+    # @return [void]
+    def check_internal_release_notes_changed(report_type: :warning)
+      common_release_checker.check_internal_release_notes_changed(report_type: report_type)
+    end
+  end
+end

data/lib/dangermattic/plugins/android_strings_checker.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Danger
+  # Plugin for checking the strings.xml localization files for Android.
+  #
+  # @example Check if a strings.xml file refers to another string resource
+  #
+  #          android_strings_checker.check_strings_do_not_refer_resource
+  #
+  # @see Automattic/dangermattic
+  # @tags android, localization
+  #
+  class AndroidStringsChecker < Plugin
+    MESSAGE = "This PR adds a translatable entry which references another string resource; this usually causes issues with translations.\n" \
+              'Please make sure to set the `translatable="false"` attribute.'
+
+    # Check if translatable strings reference another string resource in 'strings.xml' files in a pull request.
+    #
+    # @param report_type [Boolean] (optional) Type of report (:error, :warning, :message) whenever a line matches the criteria. Default is :warning.
+    #
+    # @return [void]
+    def check_strings_do_not_refer_resource(report_type: :warning)
+      git_utils.check_added_diff_lines(
+        file_selector: ->(path) { File.basename(path) == 'strings.xml' },
+        line_matcher: ->(line) { line.include?('@string/') && !line.include?('translatable="false"') },
+        message: MESSAGE,
+        report_type: report_type
+      )
+    end
+  end
+end