fastlane-plugin-swift_doc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a68f7d1342f015577ba8d77a3c9ebde05b9ecbd1ed9f157bca7d7ba195a6c9bd
+  data.tar.gz: 50502af44822e98dfc437de8af38ef54fa32950389374f917d52dd7f00796e12
+SHA512:
+  metadata.gz: 35749a6449c8dfaf34638f3f1df21dfc4015ea443d94cd6aec030146522d35f548eef905ee2c0fc588ab0b15529bffbee1f975228455a9d46bc325df8f4166f1
+  data.tar.gz: fefce209aa14bec6c9ea3e1f10774208f05142410e3542363123113823a9faa6697193526c4df27c70025635c16488ad20dcd9eca9208e82a96a47ec820b7a59

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 josh <josh@pepabo.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,48 @@
+# swift_doc plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-swift_doc)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-swift_doc`, add it to your project by running:
+
+```bash
+fastlane add_plugin swift_doc
+```
+
+## About swift_doc
+
+Generate documentation, documentation coverage, or a class diagram using [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc)
+
+## 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`.
+
+## 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/swift_doc.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/swift_doc/version'
+
+module Fastlane
+  module SwiftDoc
+    # 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::SwiftDoc.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/swift_doc/actions/swift_doc_action.rb

@@ -0,0 +1,122 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    class SwiftDocAction < Action
+      def self.run(params)
+        if `which swift-doc`.to_s.length == 0 && params[:executable].nil? && !Helper.test?
+          UI.user_error!("You have to install swift-doc using `brew install swiftdocorg/formulae/swift-doc` or specify the executable path with the `:executable` option.")
+        end
+
+        command = params[:executable] || "swift-doc"
+        mode = params[:mode] || :generate
+        command << " #{mode}"
+        command << optional_flags(params, mode)
+
+        Actions.sh(command)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Generate documentation, documentation coverage, or a class diagram using SwiftDoc"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :executable,
+                                       env_name: "FL_SWIFT_DOC_EXECUTABLE",
+                                       description: "Path to the `swift-doc` executable on your machine",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :mode,
+                                       env_name: "FL_SWIFT_DOC_MODE",
+                                       description: "SwiftDoc mode: :generate, :coverage, or :diagram",
+                                       type: Symbol,
+                                       default_value: :generate,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :minimum_access_level,
+                                       env_name: "FL_SWIFT_DOC_MINIMUM_ACCESS_LEVEL",
+                                       description: "SwiftDoc minimum access level: public, internal, etc",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :input_paths,
+                                       env_name: "FL_SWIFT_DOC_INPUT_PATHS",
+                                       description: "SwiftDoc input paths for Swift files",
+                                       type: Array,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       env_name: "FL_SWIFT_DOC_OUTPUT_PATH",
+                                       description: "The output path for generated files",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :module_name,
+                                       env_name: "FL_SWIFT_DOC_MODULE_NAME",
+                                       description: "The module name to work on",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :output_format,
+                                       env_name: "FL_SWIFT_DOC_OUTPUT_FORMAT",
+                                       description: "The output format: :commonmark or :html",
+                                       type: Symbol,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :base_url,
+                                       env_name: "FL_SWIFT_DOC_BASE_URL",
+                                       description: "The base url to work off of",
+                                       type: String,
+                                       optional: true),
+        ]
+      end
+
+      def self.optional_flags(params, mode)
+        command = ""
+        command << " --minimum-access-level #{params[:minimum_access_level]}" if params[:minimum_access_level]
+        command << " --inputs #{params[:input_paths].map(&:shellescape).join(', ')}" if params[:input_paths]
+
+        case mode
+        when :generate
+          command << " --module-name #{params[:module_name]}" if params[:module_name]
+          command << " --output #{params[:output_path].shellescape}" if params[:output_path]
+          command << " --format #{params[:output_format]}" if params[:output_format]
+          command << " --base-url #{params[:base_url].shellescape}" if params[:base_url]
+        when :coverage
+          command << " --output #{params[:output_path].shellescape}" if params[:output_path]
+        when :diagram
+          # No unique options here
+        else
+          UI.user_error!("Unexpected mode: #{mode}")
+        end
+
+        return command
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ["Joshua Kaplan"]
+      end
+
+      def self.example_code
+        [
+          'swift_doc',
+          'swift_doc(mode: :coverage)',
+          'swift_doc(module_name: "FooModule")',
+        ]
+      end
+
+      def self.category
+        :documentation
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-swift_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Kaplan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-08 00:00:00.000000000 Z
+dependencies:
+- !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.180.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.180.0
+description:
+email: yhkaplan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/swift_doc.rb
+- lib/fastlane/plugin/swift_doc/actions/swift_doc_action.rb
+- lib/fastlane/plugin/swift_doc/version.rb
+homepage: https://github.com/yhkaplan/fastlane-plugin-swift_doc
+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.1.4
+signing_key:
+specification_version: 4
+summary: Generate documentation, documentation coverage, or a class diagram using
+  SwiftDoc
+test_files: []