danger-l10nlint 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d68a9a3efda594ed8050fcfec0ee12ed733ebec8867c8a3ed7350d27afdb366b
+  data.tar.gz: f52c7a6662c5316370afa32f1392575e109d4b88b31773d3965442ab2b9a7563
+SHA512:
+  metadata.gz: c8db3437b12ed5b61e3c97f9ec44abb29fadce5ceff947b68ca698cc928ac6cd6a284134ee19ae5fbd24049f18fc415887264b3a18b96bf82fba1c109214573c
+  data.tar.gz: 4ea82e1a07b6aff66389b5a92a1539daaf78193e478954e7dcbefb3c2624eea5922dd821ce1e9257f93d22eac60c9aa81cc76c64a5ab1cf0216465e70e28a073

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor/bundle"

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+.vscode/
+vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1,2 @@
+2.7.7
+

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.7
+
+script:
+    - bundle exec rake spec

data/Dangerfile

@@ -0,0 +1,10 @@
+# Disable linting of Dangerfile.
+# rubocop:disable all
+
+has_app_changes = !git.modified_files.grep(/(bin|ext|lib)/).empty?
+
+warn("PR is classed as Work in Progress") if github.pr_title.include? "[WIP]"
+
+warn("Big PR, try to keep changes smaller if you can") if git.lines_of_code > 500
+
+rubocop.lint

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-l10nlint.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    danger-l10nlint (0.0.5)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    claide (1.1.0)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (9.2.0)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 3.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 5.0)
+      terminal-table (>= 1, < 4)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.4.1)
+      faraday (>= 0.8)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    git (1.13.2)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (5.6.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  danger-l10nlint!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# 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) 2023 Kazumasa Shimomura <kazu.devapp@gmail.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,20 @@
+# danger-l10nlint
+
+A description of danger-l10nlint.
+
+## Installation
+
+    $ gem install danger-l10nlint
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `l10nlint` namespace.
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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/bin/danger-l10nlint

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+if $PROGRAM_NAME == __FILE__
+    $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'thor'
+require 'version'
+
+class DangerL10nLintCLI < Thor
+    desc 'version', 'The version of the installed danger-l10nlint plugin'
+    def version
+        puts DangerL10nLint::VERSION
+    end
+
+    desc 'l10nlint_version', 'The L10nLint version used by the plugin'
+    def l10nlint_version
+        puts DangerL10nLint::L10NLINT_VERSION
+    end
+end
+
+DangerL10nLintCLI.start(ARGV)

data/danger-l10nlint.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-l10nlint"
+  spec.version       = DangerL10nLint::VERSION
+  spec.authors       = ["Kazumasa Shimomura"]
+  spec.email         = ["kazu.devapp@gmail.com"]
+  spec.description   = "A short description of danger-l10nlint."
+  spec.summary       = "A longer description of danger-l10nlint."
+  spec.homepage      = "https://github.com/s2mr/danger-l10nlint"
+  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/ext/l10nlint/l10nlint.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+class L10nLint
+  def initialize(l10nlint_path = nil)
+    @l10nlint_path = l10nlint_path
+  end
+
+  def installed?
+    File.exist?(l10nlint_path)
+  end
+
+  def l10nlint_path
+    @l10nlint_path || default_l10nlint_path
+  end
+
+  def default_l10nlint_path
+    File.expand_path(File.join(File.dirname(__FILE__), 'bin', 'l10nlint'))
+  end
+
+  # Shortcut for running the lint command
+  def lint(options, additional_l10nlint_args, env = nil)
+    run('lint', additional_l10nlint_args, options, env)
+  end
+
+  def run(cmd = 'lint', additional_l10nlint_args = '', options = {}, env = nil)
+    # allow for temporary change to pwd before running l10nlint
+    pwd = options.delete(:pwd)
+    command = "#{l10nlint_path} #{cmd} #{l10nlint_arguments(options, additional_l10nlint_args)}"
+
+    # Add `env` to environment
+    update_env(env)
+    begin
+      # run l10nlint with provided options
+      if pwd
+        Dir.chdir(pwd) do
+          `#{command}`
+        end
+      else
+        `#{command}`
+      end
+    ensure
+      # Remove any ENV variables we might have added
+      restore_env()
+    end
+  end
+
+  # Parse options into shell arguments how swift expect it to be
+  # more information: https://github.com/Carthage/Commandant
+  # @param options (Hash) hash containing l10nlint options
+  def l10nlint_arguments(options, additional_l10nlint_args)
+    (options.
+      # filter not null
+      reject { |_key, value| value.nil? }.
+      # map booleans arguments equal true
+      map { |key, value| value.is_a?(TrueClass) ? [key, ''] : [key, value] }.
+      # map booleans arguments equal false
+      map { |key, value| value.is_a?(FalseClass) ? ["no-#{key}", ''] : [key, value] }.
+      # replace underscore by hyphen
+      map { |key, value| [key.to_s.tr('_', '-'), value] }.
+      # prepend '--' into the argument
+      map { |key, value| ["--#{key}", value] }.
+      # reduce everything into a single string
+      reduce('') { |args, option| "#{args} #{option[0]} #{option[1]}" } +
+      " #{additional_l10nlint_args}").
+      # strip leading spaces
+      strip
+  end
+
+  # Adds `env` to shell environment as variables
+  # @param env (Hash) hash containing environment variables to add
+  def update_env(env)
+    return if !env || env.empty?
+    # Keep the same @original_env if we've already set it, since that would mean
+    # that we're adding more variables, in which case, we want to make sure to
+    # keep the true original when we go to restore it.
+    @original_env = ENV.to_h if @original_env.nil?
+    # Add `env` to environment
+    ENV.update(env)
+  end
+
+  # Restores shell environment to values in `@original_env`
+  # All environment variables not in `@original_env` will be removed
+  def restore_env()
+    if !@original_env.nil?
+      ENV.replace(@original_env)
+      @original_env = nil
+    end
+  end
+end