fastlane-plugin-unity3d 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7934a1f963e0edd69bc7bfe4aabbfa4c2116b7b856d1cd9559f55e7fba88c077
+  data.tar.gz: 6c19c86142845fb24c74a46318701e193b5eaeb724334696ff60189a05034a24
+SHA512:
+  metadata.gz: fd34d58a93a5825980232f7e3cfaaa253b8474a46098eddc45d52b08ac629b1e83784365db6c65194c05004404e6b4b5b928756e9ae15db9248a8bec13721aab
+  data.tar.gz: c26cf42c2ba9b7fddbdcc3992a2b00368570f34f8543782e657eeecef3e3756464e26dadb33a7e030ed8ee729393be28fd366e59e84eb7d12a6b7a22a1c729f3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 fuzhongqing <fuzhongqing1995@gmail.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,84 @@
+# unity3d plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-unity3d)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-unity3d`, add it to your project by running:
+
+```bash
+fastlane add_plugin unity3d
+```
+
+## About unity3d
+
+fastlane pulgin for unity3d engine
+
+## Usage
+
+```ruby
+unity3d(
+  execute_method: "SomeClass.YourBuildMethod"
+)
+```
+
+**recommend**:
+
+Add the following code to your `build script` to get a better experience
+
+```c#
+var result = BuildPipeline.BuildPlayer(scene, path, isAndroid ? BuildTarget.Android : BuildTarget.iOS, option);
+var summary = result.summary;
+var summaryJson = JsonConvert.SerializeObject(summary);
+        
+System.IO.File.WriteAllText(@".build_summary.json", summaryJson);
+```
+
+
+
+## Context Values
+
+if you genreated the `.build_summary.json` , There will be some [Lane Variables](https://docs.fastlane.tools/advanced/lanes/#lane-context)
+
+| SharedValue                                | **Description** |
+| ------------------------------------------ | --------------- |
+| SharedValues::UNITY3D_OUTPUT_PATH          |                 |
+| SharedValues::UNITY3D_BUILD_STARTED_AT     |                 |
+| SharedValues::UNITY3D_BUILD_ENDED_AT       |                 |
+| SharedValues::UNITY3D_PLATFORM             |                 |
+| SharedValues::UNITY3D_OPTIONS              |                 |
+| SharedValues::UNITY3D_TOTAL_ERRORS         |                 |
+| SharedValues::UNITY3D_TOTAL_TOTAL_WARNINGS |                 |
+| SharedValues::UNITY3D_TOTAL_TIME           |                 |
+| SharedValues::UNITY3D_TOTAL_SIZE           |                 |
+
+
+
+## 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/unity3d.rb

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

data/lib/fastlane/plugin/unity3d/actions/unity3d_action.rb

@@ -0,0 +1,163 @@
+require 'fastlane/action'
+require_relative '../helper/unity3d_helper'
+
+module Fastlane
+  module Actions
+
+    module SharedValues
+      UNITY3D_OUTPUT_PATH = :UNITY3D_OUTPUT_PATH
+      UNITY3D_BUILD_STARTED_AT = :UNITY3D_BUILD_STARTED_AT
+      UNITY3D_BUILD_ENDED_AT = :UNITY3D_BUILD_ENDED_AT
+      UNITY3D_PLATFORM = :UNITY3D_PLATFORM
+      UNITY3D_OPTIONS = :UNITY3D_OPTIONS 
+      UNITY3D_TOTAL_ERRORS = :UNITY3D_TOTAL_ERRORS
+      UNITY3D_TOTAL_TOTAL_WARNINGS = :UNITY3D_TOTAL_TOTAL_WARNINGS
+      UNITY3D_TOTAL_TIME =:UNITY3D_TOTAL_TIME
+      UNITY3D_TOTAL_SIZE =:UNITY3D_TOTAL_SIZE
+    end
+
+    class Unity3dAction < Action
+      def self.run(params)
+
+        build_cmd = "#{params[:executable]}"
+        build_cmd << " -projectPath #{params[:project_path]}"
+        build_cmd << " -batchmode"
+        build_cmd << " -quit"
+        build_cmd << " -logfile #{params[:logfile]}"
+        build_cmd << " -nographics" if params[:nographics]
+        build_cmd << " -executeMethod #{params[:execute_method]}" if params[:execute_method]
+
+        UI.message "\n#{
+          Terminal::Table.new(
+            title: "Unity".green,
+            headings: ["Option", "Value"],
+            rows: params.values
+        )}\n"
+
+
+        UI.message "Start running"
+
+        sh build_cmd unless params[:skip_building]
+
+        if File.exist?('.build_summary.json') then
+          summary = Helper::BuildSummary.new(JSON.parse(File.read('.build_summary.json')))
+
+          UI.message "\n#{
+            Terminal::Table.new(
+              title: "build summary".green,
+              headings: ["Key", "Value"],
+              rows: summary.kv
+          )}\n"
+
+          UI.error "build faild, check logfile" unless summary.success?
+
+          Actions.lane_context[SharedValues::UNITY3D_BUILD_STARTED_AT] = summary.kv['buildStartedAt']
+          Actions.lane_context[SharedValues::UNITY3D_PLATFORM] = summary.kv['platform']
+          Actions.lane_context[SharedValues::UNITY3D_OPTIONS] = summary.kv['options']
+          Actions.lane_context[SharedValues::UNITY3D_OUTPUT_PATH] = summary.kv['outputPath']
+          Actions.lane_context[SharedValues::UNITY3D_TOTAL_SIZE] = summary.kv['totalSize']
+          Actions.lane_context[SharedValues::UNITY3D_TOTAL_TIME] = summary.kv['totalTime']
+          Actions.lane_context[SharedValues::UNITY3D_BUILD_ENDED_AT] = summary.kv['buildEndedAt']
+          Actions.lane_context[SharedValues::UNITY3D_TOTAL_ERRORS] = summary.kv['totalErrors']
+          Actions.lane_context[SharedValues::UNITY3D_TOTAL_TOTAL_WARNINGS] = summary.kv['totalWarnings']
+
+          if summary.is_android? then
+            build_script_file = Dir[File.join(summary.build_path, '*', 'build.gradle')].find { |path| File.exist?(path) }
+            if build_script_file then
+              # if export mode
+              sh "gradle -p \'#{File.dirname(build_script_file)}\' wrapper"
+              ENV["FL_GRADLE_PROJECT_DIR"] = File.dirname(build_script_file)
+            end
+          end
+
+        else
+          UI.message "file `build_summary.json` not found"
+        end
+
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "fastlane plugin for unity3d engine"
+      end
+
+      def self.authors
+        ["fuzhongqing"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "fastlane for unity3d engine"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :executable,
+                                       env_name: "FL_UNITY_EXECUTABLE",
+                                       description: "Path for Unity executable",
+                                       optional: true,
+                                       default_value: Helper::Unity3dHelper.default_exe_path),
+
+          FastlaneCore::ConfigItem.new(key: :project_path,
+                                       env_name: "FL_UNITY_PROJECT_PATH",
+                                       description: "Path for Unity project",
+                                       optional: true,
+                                       default_value: "#{Dir.pwd}"),
+
+          FastlaneCore::ConfigItem.new(key: :execute_method,
+                                       env_name: "FL_UNITY_EXECUTE_METHOD",
+                                       description: "Method to execute",
+                                       optional: true,
+                                       default_value: nil),
+
+          FastlaneCore::ConfigItem.new(key: :build_type,
+                                       env_name: "FL_UNITY_BUILD_TYPE",
+                                       description: "`Debug` or `Release`",
+                                       optional: true,
+                                       default_value: "Release"),
+
+          FastlaneCore::ConfigItem.new(key: :nographics,
+                                       env_name: "FL_UNITY_NOGRAPHICS",
+                                       description: "Initialize graphics device or not",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: true),
+
+          FastlaneCore::ConfigItem.new(key: :logfile,
+                                       env_name: "FL_UNITY_LOGFILE",
+                                       description: "log file",
+                                       optional: true,
+                                       is_string: true,
+                                       default_value: ""),
+
+          FastlaneCore::ConfigItem.new(key: :skip_building,
+                                       env_name: "FL_UNITY_SKIP_BUILDING",
+                                       description: "Need skip building",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: false),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+
+      def self.category
+        :building
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/unity3d/helper/unity3d_helper.rb

@@ -0,0 +1,66 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class Unity3dHelper
+      # class methods that you define here become available in your action
+      # as `Helper::Unity3dHelper.your_method`
+      #
+      # https://github.com/safu9/fastlane-plugin-unity/blob/main/lib/fastlane/plugin/unity/helper/unity_helper.rb
+      def self.default_exe_path
+        paths = []
+
+        if OS::Underlying.docker?
+          # See: https://gitlab.com/gableroux/unity3d
+          paths << "/opt/Unity/Editor/Unity"
+        end
+
+        if OS.windows?
+          paths << "C:\\Program Files\\Unity\\Editor\\Unity.exe"
+        elsif OS.mac?
+          paths << "/Applications/Unity/Unity.app/Contents/MacOS/Unity"
+          paths << Dir[File.join('Applications', '**', 'Unity.app', 'Contents', 'MacOS', 'Unity')]
+        elsif OS.linux?
+          paths << "~/Unity/Editor/Unity"
+        end
+
+        return paths.find { |path| File.exist?(path) }
+      end
+    end
+
+    class BuildSummary
+
+      @@object = nil
+
+      def initialize(json_obj)
+        @object = json_obj
+      end
+
+      def build_path
+        @object['outputPath']
+      end
+
+      def success?
+        @object['result'] == 1
+      end
+
+      def is_android?
+        @object['platform'] == 13
+      end
+
+      def is_ios?
+        @object['platform'] == 9
+      end
+
+      def kv
+        @object.merge!(
+          {
+            "android" => self.is_android?,
+            "ios" => self.is_ios?,
+          })
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-unity3d
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fuzhongqing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-05 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.171.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.171.0
+description: 
+email: fuzhongqing1995@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/unity3d.rb
+- lib/fastlane/plugin/unity3d/actions/unity3d_action.rb
+- lib/fastlane/plugin/unity3d/helper/unity3d_helper.rb
+- lib/fastlane/plugin/unity3d/version.rb
+homepage: https://github.com/fuzhongqing/fastlane-plugin-unity3d
+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.3
+signing_key: 
+specification_version: 4
+summary: fastlane for unity3d engine
+test_files: []