danger-l10nlint 0.0.5

data/lib/danger_plugin.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require_relative '../ext/l10nlint/l10nlint'
+
+module Danger
+  # This is your plugin class. Any attributes or methods you expose here will
+  # be available from within your Dangerfile.
+  #
+  # To be published on the Danger plugins site, you will need to have
+  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
+  # for generating documentation from your plugin source, and you can verify
+  # by running `danger plugins lint` or `bundle exec rake spec`.
+  #
+  # You should replace these comments with a public description of your library.
+  #
+  # @example Ensure people are well warned about merging on Mondays
+  #
+  #          my_plugin.warn_on_mondays
+  #
+  # @see  Kazumasa Shimomura/danger-l10nlint
+  # @tags monday, weekends, time, rattata
+  #
+  class DangerL10nlint < Plugin
+    # The path to L10nLint's execution
+    attr_accessor :binary_path
+
+    # The path to L10nLint's configuration file
+    attr_accessor :config_file
+
+    # Maximum number of issues to be reported.
+    attr_accessor :max_num_violations
+
+    # Provides additional logging diagnostic information.
+    attr_accessor :verbose
+
+    # Whether we should fail on warnings
+    attr_accessor :strict
+
+    # Warnings found
+    attr_accessor :warnings
+
+    # Errors found
+    attr_accessor :errors
+
+    # All issues found
+    attr_accessor :issues
+
+    # Lints Localizable.strings
+    # @return [void]
+    #
+    def lint_files(inline_mode: false, fail_on_error: false, additional_l10nlint_args: '')
+      raise 'l10nlint is not installed' unless l10nlint.installed?
+
+      config_file_path = config_file
+      if config_file_path
+        log "Using config file: #{config_file_path}"
+      else
+        log 'config file was not specified'
+      end
+
+      # Prepare l10nlint options
+      options = {
+        # Make sure we don't fail when config path has spaces
+        config: config_file_path ? Shellwords.escape(config_file_path) : nil,
+        reporter: 'json'
+      }
+
+      log "linting with options: #{options}"
+
+      issues = run_l10nlint(options, additional_l10nlint_args)
+
+      @issues = issues
+      other_issues_count = 0
+      unless @max_num_violations.nil? || no_comment
+        other_issues_count = issues.count - @max_num_violations if issues.count > @max_num_violations
+        issues = issues.take(@max_num_violations)
+      end
+      log "Received from L10nLint: #{issues}"
+
+      # Filter warnings and errors
+      @warnings = issues.select { |issue| issue['severity'] == 'warning' }
+      @errors = issues.select { |issue| issue['severity'] == 'error' }
+
+      if inline_mode
+        # Report with inline comment
+        send_inline_comment(warnings, strict ? :fail : :warn)
+        send_inline_comment(errors, (fail_on_error || strict) ? :fail : :warn)
+        warn other_issues_message(other_issues_count) if other_issues_count > 0
+      elsif warnings.count > 0 || errors.count > 0
+        # Report if any warning or error
+        message = "### L10nLint found issues\n\n".dup
+        message << markdown_issues(warnings, 'Warnings') unless warnings.empty?
+        message << markdown_issues(errors, 'Errors') unless errors.empty?
+        message << "\n#{other_issues_message(other_issues_count)}" if other_issues_count > 0
+        markdown message
+
+        # Fail danger on errors
+        should_fail_by_errors = fail_on_error && errors.count > 0
+        # Fail danger if any warnings or errors and we are strict
+        should_fail_by_strict = strict && (errors.count > 0 || warnings.count > 0)
+        if should_fail_by_errors || should_fail_by_strict
+          fail 'Failed due to L10nLint errors'
+        end
+      end
+    end
+
+    # Make L10nLint object for binary_path
+    #
+    # @return [L10nLint]
+    def l10nlint
+      L10nLint.new(binary_path)
+    end
+
+    def log(text)
+      puts text if @verbose
+    end
+
+    # Run l10nlint on all files and returns the issues
+    #
+    # @return [Array] l10nlint issues
+    def run_l10nlint(options, additional_l10nlint_args)
+      result = l10nlint.lint(options, additional_l10nlint_args)
+      if result == ''
+        {}
+      else
+        JSON.parse(result)
+      end
+    end
+
+    # Create a markdown table from l10nlint issues
+    #
+    # @return  [String]
+    def markdown_issues(results, heading)
+      message = "#### #{heading}\n\n".dup
+
+      message << "File | Line | Reason |\n"
+      message << "| --- | ----- | ----- |\n"
+
+      results.each do |r|
+        puts r
+
+        filename = r['location']['file'].split('/').last(2).join("/")
+        line = r['location']['line']
+        reason = r['reason']
+        rule = r['ruleIdentifier']
+        # Other available properties can be found int L10nLint/…/JSONReporter.swift
+        message << "#{filename} | #{line} | #{reason} (#{rule})\n"
+      end
+
+      message
+    end
+
+    # Send inline comment with danger's warn or fail method
+    #
+    # @return [void]
+    def send_inline_comment(results, method)
+      dir = "#{Dir.pwd}/"
+      results.each do |r|
+        github_filename = r['location']['file'].gsub(dir, '')
+        message = "#{r['reason']}".dup
+
+        # extended content here
+        filename = r['location']['file'].split('/').last
+        message << "\n"
+        message << "`#{r['ruleIdentifier']}`"
+        message << " `#{filename}:#{r['location']['line']}`" # file:line for pasting into Xcode Quick Open
+
+        send(method, message, file: github_filename, line: r['line'])
+      end
+    end
+
+    def other_issues_message(issues_count)
+      violations = issues_count == 1 ? 'violation' : 'violations'
+      "L10nLint also found #{issues_count} more #{violations} with this PR."
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DangerL10nLint
+  VERSION = '0.0.5'
+  L10NLINT_VERSION = '0.0.5'
+end

data/spec/l10nlint_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerL10nLint do
+    it "should be a plugin" do
+      expect(Danger::DangerL10nLint.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
+        @l10nlint = @dangerfile.l10nlint
+
+        # 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(@l10nlint.github).to receive(:pr_json).and_return(json)
+      end
+
+      it 'handles l10nlint not being installed' do
+        allow_any_instance_of(L10nLint).to receive(:installed?).and_return(false)
+        expect { @l10nlint.lint_files }.to raise_error('l10nlint is not installed')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.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

data/spec/support/fixtures/github_pr.json

@@ -0,0 +1,278 @@
+{
+  "url": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18",
+  "id": 185317229,
+  "node_id": "MDExOlB1bGxSZXF1ZXN0MTg1MzE3MjI5",
+  "html_url": "https://github.com/danger/danger-plugin-template/pull/18",
+  "diff_url": "https://github.com/danger/danger-plugin-template/pull/18.diff",
+  "patch_url": "https://github.com/danger/danger-plugin-template/pull/18.patch",
+  "issue_url": "https://api.github.com/repos/danger/danger-plugin-template/issues/18",
+  "number": 18,
+  "state": "closed",
+  "locked": false,
+  "title": "add exmaple of how to mock PRs",
+  "user": {
+    "login": "wilrnh",
+    "id": 555966,
+    "node_id": "MDQ6VXNlcjU1NTk2Ng==",
+    "avatar_url": "https://avatars.githubusercontent.com/u/555966?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/wilrnh",
+    "html_url": "https://github.com/wilrnh",
+    "followers_url": "https://api.github.com/users/wilrnh/followers",
+    "following_url": "https://api.github.com/users/wilrnh/following{/other_user}",
+    "gists_url": "https://api.github.com/users/wilrnh/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/wilrnh/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/wilrnh/subscriptions",
+    "organizations_url": "https://api.github.com/users/wilrnh/orgs",
+    "repos_url": "https://api.github.com/users/wilrnh/repos",
+    "events_url": "https://api.github.com/users/wilrnh/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/wilrnh/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "body": "Fixes danger/danger#661\r\n\r\nadd example how to mock PRs",
+  "created_at": "2018-05-02T01:52:26Z",
+  "updated_at": "2018-05-02T10:37:04Z",
+  "closed_at": "2018-05-02T10:37:04Z",
+  "merged_at": "2018-05-02T10:37:04Z",
+  "merge_commit_sha": "39eacac22d52a2b70fc49bd8aba19eb7d2864717",
+  "assignee": null,
+  "assignees": [
+
+  ],
+  "requested_reviewers": [
+
+  ],
+  "requested_teams": [
+
+  ],
+  "labels": [
+
+  ],
+  "milestone": null,
+  "draft": false,
+  "commits_url": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18/commits",
+  "review_comments_url": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18/comments",
+  "review_comment_url": "https://api.github.com/repos/danger/danger-plugin-template/pulls/comments{/number}",
+  "comments_url": "https://api.github.com/repos/danger/danger-plugin-template/issues/18/comments",
+  "statuses_url": "https://api.github.com/repos/danger/danger-plugin-template/statuses/abe89bee0cdc5f45b1dee62c60e74c70f3fcb5d5",
+  "head": {
+    "label": "wilrnh:661-mocking-prs",
+    "ref": "661-mocking-prs",
+    "sha": "abe89bee0cdc5f45b1dee62c60e74c70f3fcb5d5",
+    "user": {
+      "login": "wilrnh",
+      "id": 555966,
+      "node_id": "MDQ6VXNlcjU1NTk2Ng==",
+      "avatar_url": "https://avatars.githubusercontent.com/u/555966?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/wilrnh",
+      "html_url": "https://github.com/wilrnh",
+      "followers_url": "https://api.github.com/users/wilrnh/followers",
+      "following_url": "https://api.github.com/users/wilrnh/following{/other_user}",
+      "gists_url": "https://api.github.com/users/wilrnh/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/wilrnh/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/wilrnh/subscriptions",
+      "organizations_url": "https://api.github.com/users/wilrnh/orgs",
+      "repos_url": "https://api.github.com/users/wilrnh/repos",
+      "events_url": "https://api.github.com/users/wilrnh/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/wilrnh/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "repo": null
+  },
+  "base": {
+    "label": "danger:master",
+    "ref": "master",
+    "sha": "30bd69c1c09d927abde0695fcb39dd70d4cc0f81",
+    "user": {
+      "login": "danger",
+      "id": 17147106,
+      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE3MTQ3MTA2",
+      "avatar_url": "https://avatars.githubusercontent.com/u/17147106?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/danger",
+      "html_url": "https://github.com/danger",
+      "followers_url": "https://api.github.com/users/danger/followers",
+      "following_url": "https://api.github.com/users/danger/following{/other_user}",
+      "gists_url": "https://api.github.com/users/danger/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/danger/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/danger/subscriptions",
+      "organizations_url": "https://api.github.com/users/danger/orgs",
+      "repos_url": "https://api.github.com/users/danger/repos",
+      "events_url": "https://api.github.com/users/danger/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/danger/received_events",
+      "type": "Organization",
+      "site_admin": false
+    },
+    "repo": {
+      "id": 60424063,
+      "node_id": "MDEwOlJlcG9zaXRvcnk2MDQyNDA2Mw==",
+      "name": "danger-plugin-template",
+      "full_name": "danger/danger-plugin-template",
+      "private": false,
+      "owner": {
+        "login": "danger",
+        "id": 17147106,
+        "node_id": "MDEyOk9yZ2FuaXphdGlvbjE3MTQ3MTA2",
+        "avatar_url": "https://avatars.githubusercontent.com/u/17147106?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/danger",
+        "html_url": "https://github.com/danger",
+        "followers_url": "https://api.github.com/users/danger/followers",
+        "following_url": "https://api.github.com/users/danger/following{/other_user}",
+        "gists_url": "https://api.github.com/users/danger/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/danger/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/danger/subscriptions",
+        "organizations_url": "https://api.github.com/users/danger/orgs",
+        "repos_url": "https://api.github.com/users/danger/repos",
+        "events_url": "https://api.github.com/users/danger/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/danger/received_events",
+        "type": "Organization",
+        "site_admin": false
+      },
+      "html_url": "https://github.com/danger/danger-plugin-template",
+      "description": "An opinionated template for creating a Danger plugin",
+      "fork": false,
+      "url": "https://api.github.com/repos/danger/danger-plugin-template",
+      "forks_url": "https://api.github.com/repos/danger/danger-plugin-template/forks",
+      "keys_url": "https://api.github.com/repos/danger/danger-plugin-template/keys{/key_id}",
+      "collaborators_url": "https://api.github.com/repos/danger/danger-plugin-template/collaborators{/collaborator}",
+      "teams_url": "https://api.github.com/repos/danger/danger-plugin-template/teams",
+      "hooks_url": "https://api.github.com/repos/danger/danger-plugin-template/hooks",
+      "issue_events_url": "https://api.github.com/repos/danger/danger-plugin-template/issues/events{/number}",
+      "events_url": "https://api.github.com/repos/danger/danger-plugin-template/events",
+      "assignees_url": "https://api.github.com/repos/danger/danger-plugin-template/assignees{/user}",
+      "branches_url": "https://api.github.com/repos/danger/danger-plugin-template/branches{/branch}",
+      "tags_url": "https://api.github.com/repos/danger/danger-plugin-template/tags",
+      "blobs_url": "https://api.github.com/repos/danger/danger-plugin-template/git/blobs{/sha}",
+      "git_tags_url": "https://api.github.com/repos/danger/danger-plugin-template/git/tags{/sha}",
+      "git_refs_url": "https://api.github.com/repos/danger/danger-plugin-template/git/refs{/sha}",
+      "trees_url": "https://api.github.com/repos/danger/danger-plugin-template/git/trees{/sha}",
+      "statuses_url": "https://api.github.com/repos/danger/danger-plugin-template/statuses/{sha}",
+      "languages_url": "https://api.github.com/repos/danger/danger-plugin-template/languages",
+      "stargazers_url": "https://api.github.com/repos/danger/danger-plugin-template/stargazers",
+      "contributors_url": "https://api.github.com/repos/danger/danger-plugin-template/contributors",
+      "subscribers_url": "https://api.github.com/repos/danger/danger-plugin-template/subscribers",
+      "subscription_url": "https://api.github.com/repos/danger/danger-plugin-template/subscription",
+      "commits_url": "https://api.github.com/repos/danger/danger-plugin-template/commits{/sha}",
+      "git_commits_url": "https://api.github.com/repos/danger/danger-plugin-template/git/commits{/sha}",
+      "comments_url": "https://api.github.com/repos/danger/danger-plugin-template/comments{/number}",
+      "issue_comment_url": "https://api.github.com/repos/danger/danger-plugin-template/issues/comments{/number}",
+      "contents_url": "https://api.github.com/repos/danger/danger-plugin-template/contents/{+path}",
+      "compare_url": "https://api.github.com/repos/danger/danger-plugin-template/compare/{base}...{head}",
+      "merges_url": "https://api.github.com/repos/danger/danger-plugin-template/merges",
+      "archive_url": "https://api.github.com/repos/danger/danger-plugin-template/{archive_format}{/ref}",
+      "downloads_url": "https://api.github.com/repos/danger/danger-plugin-template/downloads",
+      "issues_url": "https://api.github.com/repos/danger/danger-plugin-template/issues{/number}",
+      "pulls_url": "https://api.github.com/repos/danger/danger-plugin-template/pulls{/number}",
+      "milestones_url": "https://api.github.com/repos/danger/danger-plugin-template/milestones{/number}",
+      "notifications_url": "https://api.github.com/repos/danger/danger-plugin-template/notifications{?since,all,participating}",
+      "labels_url": "https://api.github.com/repos/danger/danger-plugin-template/labels{/name}",
+      "releases_url": "https://api.github.com/repos/danger/danger-plugin-template/releases{/id}",
+      "deployments_url": "https://api.github.com/repos/danger/danger-plugin-template/deployments",
+      "created_at": "2016-06-04T18:17:02Z",
+      "updated_at": "2021-10-27T08:26:48Z",
+      "pushed_at": "2022-09-04T13:16:52Z",
+      "git_url": "git://github.com/danger/danger-plugin-template.git",
+      "ssh_url": "git@github.com:danger/danger-plugin-template.git",
+      "clone_url": "https://github.com/danger/danger-plugin-template.git",
+      "svn_url": "https://github.com/danger/danger-plugin-template",
+      "homepage": null,
+      "size": 42,
+      "stargazers_count": 19,
+      "watchers_count": 19,
+      "language": "Ruby",
+      "has_issues": true,
+      "has_projects": true,
+      "has_downloads": true,
+      "has_wiki": true,
+      "has_pages": false,
+      "has_discussions": false,
+      "forks_count": 13,
+      "mirror_url": null,
+      "archived": false,
+      "disabled": false,
+      "open_issues_count": 2,
+      "license": {
+        "key": "other",
+        "name": "Other",
+        "spdx_id": "NOASSERTION",
+        "url": null,
+        "node_id": "MDc6TGljZW5zZTA="
+      },
+      "allow_forking": true,
+      "is_template": false,
+      "web_commit_signoff_required": false,
+      "topics": [
+
+      ],
+      "visibility": "public",
+      "forks": 13,
+      "open_issues": 2,
+      "watchers": 19,
+      "default_branch": "master"
+    }
+  },
+  "_links": {
+    "self": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18"
+    },
+    "html": {
+      "href": "https://github.com/danger/danger-plugin-template/pull/18"
+    },
+    "issue": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/issues/18"
+    },
+    "comments": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/issues/18/comments"
+    },
+    "review_comments": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18/comments"
+    },
+    "review_comment": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/pulls/comments{/number}"
+    },
+    "commits": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/pulls/18/commits"
+    },
+    "statuses": {
+      "href": "https://api.github.com/repos/danger/danger-plugin-template/statuses/abe89bee0cdc5f45b1dee62c60e74c70f3fcb5d5"
+    }
+  },
+  "author_association": "CONTRIBUTOR",
+  "auto_merge": null,
+  "active_lock_reason": null,
+  "merged": true,
+  "mergeable": null,
+  "rebaseable": null,
+  "mergeable_state": "unknown",
+  "merged_by": {
+    "login": "orta",
+    "id": 49038,
+    "node_id": "MDQ6VXNlcjQ5MDM4",
+    "avatar_url": "https://avatars.githubusercontent.com/u/49038?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/orta",
+    "html_url": "https://github.com/orta",
+    "followers_url": "https://api.github.com/users/orta/followers",
+    "following_url": "https://api.github.com/users/orta/following{/other_user}",
+    "gists_url": "https://api.github.com/users/orta/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/orta/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/orta/subscriptions",
+    "organizations_url": "https://api.github.com/users/orta/orgs",
+    "repos_url": "https://api.github.com/users/orta/repos",
+    "events_url": "https://api.github.com/users/orta/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/orta/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "comments": 2,
+  "review_comments": 0,
+  "maintainer_can_modify": false,
+  "commits": 2,
+  "additions": 5,
+  "deletions": 0,
+  "changed_files": 1
+}