fastlane-plugin-gitlab_increate_swiftlint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d0a7848e9d643283e4135e73322e67c38a0bf04113c998b708880fd8a4e48e4
+  data.tar.gz: 844a76bcdf4c27ac742c28e07449ad83ecb18ec5558dd25019c2c590a0c39165
+SHA512:
+  metadata.gz: 3fe5f9f7a5c00c868322426dc3f897060d0353ac8f756f9d666548c63370c9bd8ed017cf2ef79ba709a7ed279af8bff5b9ee43a1788bf62a6e596cce46fc01ec
+  data.tar.gz: 774f309c3381a8cbb75aa7645a4075a9a47447fd74880df925a08d71b1131093fbc5e5683a304f1cc7e583c87740b25e18018a2c52d41f3fa33b926b64421bca

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 xiongzenghui <zxcvb1234001@163.com>
+
+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,107 @@
+# gitlab_increate_swiftlint plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-gitlab_increate_swiftlint)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-gitlab_increate_swiftlint`, add it to your project by running:
+
+```bash
+fastlane add_plugin gitlab_increate_swiftlint
+```
+
+## About gitlab_increate_swiftlint
+
+Incremental Code Check using swiftlint for swift language files on gitlab platform !
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+```ruby
+gitlab_increate_swiftlint(
+  gitlab_host: 'https://xxx.com/api/v4',
+  gitlab_token: 'xxxx',
+  projectid: '16456',
+  mrid: '33',
+  lint_dir: '/Users/xiongzenghui/Desktop/ZHUDID',
+  swiftlint_result_json: '/Users/xiongzenghui/Desktop/result.json',
+  config_file: '/Users/xiongzenghui/Desktop/.swiftlint.yml'
+)
+
+pp Actions.lane_context[SharedValues::GITLAB_INCREATE_SWIFTLINT_RESULT_JSON]
+```
+
+得到如下的 json 数据
+
+```json
+[
+  {
+    "character": 13,
+    "file": "/Users/xxx/ci-jenkins/workspace/xxx-iOS-module-xiongzenghui/ZHUDID/ZHUDID/Classes/Demo.swift",
+    "line": 18,
+    "reason": "Colons should be next to the identifier when specifying a type and next to the key in dictionary literals.",
+    "rule_id": "colon",
+    "severity": "Warning",
+    "type": "Colon"
+  },
+  {
+    "character": 28,
+    "file": "/Users/xxx/ci-jenkins/workspace/xxx-iOS-module-xiongzenghui/ZHUDID/ZHUDID/Classes/Demo.swift",
+    "line": 28,
+    "reason": "Force casts should be avoided.",
+    "rule_id": "force_cast",
+    "severity": "Error",
+    "type": "Force Cast"
+  },
+  {
+    "character": 13,
+    "file": "/Users/xxx/ci-jenkins/workspace/xxx-iOS-module-xiongzenghui/ZHUDID/ZHUDID/Classes/Haha.swift",
+    "line": 18,
+    "reason": "Colons should be next to the identifier when specifying a type and next to the key in dictionary literals.",
+    "rule_id": "colon",
+    "severity": "Warning",
+    "type": "Colon"
+  },
+  {
+    "character": 28,
+    "file": "/Users/xxx/ci-jenkins/workspace/xxx-iOS-module-xiongzenghui/ZHUDID/ZHUDID/Classes/Haha.swift",
+    "line": 28,
+    "reason": "Force casts should be avoided.",
+    "rule_id": "force_cast",
+    "severity": "Error",
+    "type": "Force Cast"
+  }
+]
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/gitlab_increate_swiftlint.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/gitlab_increate_swiftlint/version'
+
+module Fastlane
+  module GitlabIncreateSwiftlint
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::GitlabIncreateSwiftlint.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/gitlab_increate_swiftlint/actions/gitlab_increate_swiftlint_action.rb

@@ -0,0 +1,168 @@
+require 'fastlane/action'
+require_relative '../helper/gitlab_increate_swiftlint_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITLAB_INCREATE_SWIFTLINT_RESULT_JSON = :GITLAB_INCREATE_SWIFTLINT_RESULT_JSON
+      # GITLAB_INCREATE_SWIFTLINT_INTERVAL_JSON = :GITLAB_INCREATE_SWIFTLINT_INTERVAL_JSON
+    end
+    
+    class GitlabIncreateSwiftlintAction < Action
+      def self.run(params)
+        require 'pp'
+        require 'json'
+        require 'gitlab'
+
+        gitlab_host = params[:gitlab_host]
+        gitlab_token = params[:gitlab_token]
+        projectid = params[:projectid]
+        mrid = params[:mrid]
+        lint_dir = params[:lint_dir]
+        swiftlint_result_json = params[:swiftlint_result_json]
+        config_file = params[:config_file]
+
+        # begin_time = Time.new
+
+        # 1. 得到 MR 变动的 文件 list
+        gc = Gitlab.client(endpoint: gitlab_host, private_token: gitlab_token)
+        mr_hash = gc.merge_request_changes(projectid, mrid).to_hash
+        changes_file_paths = mr_hash['changes'].map { |c|
+          c['new_path'] #=> 始终使用【当前最新】文件路径
+        }
+        UI.success('[GitlabIncreateSwiftlintAction] get merge_request_changes ✅')
+        pp changes_file_paths
+
+        # 2. 过滤只对 *.swift 进行 lint
+        swift_files = changes_file_paths.select do |file|
+          file =~ /.swift$/
+        end
+        pp swift_files
+        return true if swift_files.empty?
+
+        # 3. 拼接 swiftlint command
+        #
+        # SCRIPT_INPUT_FILE_COUNT=2 \
+        # SCRIPT_INPUT_FILE_0=Classes/Answer/Views/AnswerHybridContainer.swift \
+        # SCRIPT_INPUT_FILE_1=Classes/Invite/View/InviteeUserListViewCell.swift \
+        # swiftlint lint \
+        # --reporter json \
+        # --quiet \
+        # --use-script-input-files \
+        # > swiftlint.result.json
+        #
+        cmd = "SCRIPT_INPUT_FILE_COUNT=#{swift_files.count} "
+        swift_files.each_with_index do |ite, idx|
+          # - lint_dir: git clone git@xxx.com:user/pod.git /path/to/pod
+          # - ite: Class/aa/bb/xx.swift
+          # - filepath = #{lint_dir}/#{ite}
+          filepath = File.expand_path(ite, lint_dir)
+          cmd << "SCRIPT_INPUT_FILE_#{idx}=#{filepath} "
+        end
+
+        if config_file
+          cmd << "swiftlint lint --reporter json --quiet --config #{config_file} --use-script-input-files "
+        else
+          cmd << "swiftlint lint --reporter json --quiet --use-script-input-files "
+        end
+        cmd << "> #{swiftlint_result_json} " if swiftlint_result_json
+        UI.message("[GitlabIncreateSwiftlintAction] sh: #{cmd} ⚠️")
+        # Actions.sh(cmd) #=> swiftlitn 返回 2 , 而不是 0 , 会导致 fastlane action 判断为执行【失败】
+        rt = system(cmd)
+
+        # 4.
+        ajson = File.read(swiftlint_result_json)
+        Actions.lane_context[SharedValues::GITLAB_INCREATE_SWIFTLINT_RESULT_JSON] = JSON.parse(ajson)
+
+        # 5.
+        # end_time = Time.new
+        # interval_diff = (end_time - begin_time).to_i
+        # swiftlint_result = {
+        #   interval_diff: interval_diff
+        # }
+        # File.open(swiftlint_result_others_json, 'w') do |f|
+        #   f.write(swiftlint_result.to_json)
+        # end
+        # Actions.lane_context[SharedValues::SWIFTLINT_POD_RESULT_INTERVAL_JSON] = swiftlint_result
+
+        rt
+      end
+
+      def self.description
+        "Incremental Code Check using swiftlint for swift language files on gitlab platform !"
+      end
+
+      def self.authors
+        ["xiongzenghui"]
+      end
+
+      def self.return_value
+        'boolean return true is success, otherwaise false is error'
+      end
+
+      def self.output
+        [
+          ['GITLAB_INCREATE_SWIFTLINT_RESULT_JSON', 'swiftlint lint result json']
+        ]
+      end
+
+      def self.details
+        "Incremental Code Check using swiftlint for swift language files on gitlab platform !"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_host,
+            description: "your gitlab host"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :gitlab_token,
+            description: "your gitlab token"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :projectid,
+            description: "your gitlab project id"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :mrid,
+            description: "your gitlab merge request id"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :lint_dir,
+            description: "where your pod dir"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :swiftlint_result_json,
+            description: "where save swiftlint report json file",
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :config_file,
+            description: "if you pass your custom .swiftlint.yml rule file",
+            optional: true
+          )
+        ]
+      end
+
+      def self.example_code
+        [
+          'gitlab_increate_swiftlint(
+            gitlab_host: "https://xxx.com/api/v4",
+            gitlab_token: "xxxx",
+            projectid: "16456",
+            mrid: "33",
+            lint_dir: "/Users/xiongzenghui/Desktop/AFNetworking",
+            swiftlint_result_json: "/Users/xiongzenghui/Desktop/result.json",
+            config_file: "/Users/xiongzenghui/Desktop/.swiftlint.yml"
+          )
+          pp Actions.lane_context[SharedValues::GITLAB_INCREATE_SWIFTLINT_RESULT_JSON]'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/gitlab_increate_swiftlint/helper/gitlab_increate_swiftlint_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class GitlabIncreateSwiftlintHelper
+      # class methods that you define here become available in your action
+      # as `Helper::GitlabIncreateSwiftlintHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the gitlab_increate_swiftlint plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/gitlab_increate_swiftlint/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module GitlabIncreateSwiftlint
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-gitlab_increate_swiftlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xiongzenghui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: rspec_junit_formatter
+  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: rake
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: simplecov
+  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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.128.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.128.0
+description: 
+email: zxcvb1234001@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/gitlab_increate_swiftlint.rb
+- lib/fastlane/plugin/gitlab_increate_swiftlint/actions/gitlab_increate_swiftlint_action.rb
+- lib/fastlane/plugin/gitlab_increate_swiftlint/helper/gitlab_increate_swiftlint_helper.rb
+- lib/fastlane/plugin/gitlab_increate_swiftlint/version.rb
+homepage: 
+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.0.4
+signing_key: 
+specification_version: 4
+summary: Incremental Code Check using swiftlint for swift language files on gitlab
+  platform !
+test_files: []