fastlane-plugin-build_app_for_simulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c42d17b51edca770b9ddf685fd7c4a2ee4579908bdbb38a37922b598860771f4
+  data.tar.gz: dc2f6a66809aeb60fc281bf538a9fcc6552c5c1131def52b0c1271021a7ff4ea
+SHA512:
+  metadata.gz: 852d571b3ebae7573fd1593f76efeda0e5cc79dbdbe1ee0b51a60b95ceab14ac84d22280df04e1500e28f1c5f30992c2d0355ab8df3f1eb468dbbb13c90969f1
+  data.tar.gz: 386a0d2ca76ac0801f7670f0063e295335da597406e49d93497b32bd3f35c63ef2b683a603a224a30cdf950927c32645ae63d0007cc85bb146897da240db3690

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alexey Alter-Pesotskiy
+
+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,53 @@
+# fastlane-plugin-build_app_for_simulator
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-build_app_for_simulator)
+
+## About build_app_for_simulator
+
+This plugin builds apps exclusively for iOS, tvOS or watchOS Simulators 🚀
+
+## Parameters
+
+| **Key** | **Description** | **Default** |
+| ------- |---------------- | ----------- |
+| `output_directory` | The directory in which the app file should be stored in | `.` |
+| `workspace` | Path to the workspace file | |
+| `project` | Path to the project file | |
+| `scheme` | The project's scheme. Make sure it's marked as `Shared` | |
+| `platform` | Use a custom simulator destination for building the app (`iOS`, `tvOS` or `watchOS`) | `iOS` |
+| `configuration` | The configuration to use when building the app | `Debug` |
+| `derived_data_path` | The directory where built products and other derived data will go | |
+| `result_bundle_path` | Path to the result bundle directory to create | |
+| `buildlog_path` | The directory where to store the build log | |
+| `raw_buildlog` | Set to `true` to see xcodebuild raw output | `false` |
+| `xcargs` | Pass additional xcodebuild options. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS='-ObjC -lstdc++' | |
+
+## Requirements
+
+* [Xcode](https://developer.apple.com/downloads)
+* [Xcode Command Line Tools](http://railsapps.github.io/xcode-command-line-tools.html)
+
+## Getting Started
+
+To get started with `build_app_for_simulator`, add it to your project by running:
+
+```bash
+$ fastlane add_plugin build_app_for_simulator
+```
+
+## Usage
+
+```ruby
+build_app_for_simulator(
+  scheme: 'AppName',
+  workspace: 'Example.xcworkspace',
+  configuration: 'Release',
+  output_directory: 'build'
+)
+```
+
+## Lane Variables
+
+| **SharedValue**                         | **Description**                          |
+| --------------------------------------- | ---------------------------------------- |
+| SharedValues::SIMULATOR_APP_OUTPUT_PATH | The path to the newly generated app file |

data/lib/fastlane/plugin/build_app_for_simulator.rb

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

data/lib/fastlane/plugin/build_app_for_simulator/actions/build_app_for_simulator_action.rb

@@ -0,0 +1,187 @@
+require 'fastlane/action'
+require 'fastlane/actions/xcodebuild'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      SIMULATOR_APP_OUTPUT_PATH ||= :SIMULATOR_APP_OUTPUT_PATH
+    end
+
+    class BuildAppForSimulatorAction < Action
+      def self.run(params)
+        params[:platform] = verify_destination(params)
+        params[:xcargs] = update_xcargs(params)
+        params[:archive] = nil if params[:archive]
+        params[:configuration] = 'Debug' unless params[:configuration]
+        params[:derivedDataPath] = params[:derived_data_path] if params[:derived_data_path]
+
+        clean(params)
+
+        XcodebuildAction.run(params)
+
+        new_path = copy_app(params)
+
+        provide_shared_values(new_path)
+      end
+
+      def self.clean(params)
+        if params[:output_directory]
+          FastlaneCore::UI.important('🧹 Clearing output directory.')
+          FileUtils.rm_rf(params[:output_directory])
+        end
+
+        path = "./#{params[:scheme]}.app"
+        if File.directory?(path)
+          FastlaneCore::UI.important('🧹 Removing previous build.')
+          FileUtils.rm_rf(path)
+        end
+
+        path = "build/#{params[:scheme]}.app"
+        if File.directory?(path)
+          FastlaneCore::UI.important('🧹 Removing previous build.')
+          FileUtils.rm_rf(path)
+        end
+      end
+
+      def self.update_xcargs(params)
+        if params[:xcargs] && params[:xcargs].include?('destination')
+          FastlaneCore::UI.important(
+            '🎭 Overwriting `xcargs` option for safety reasons. Consider excluding `-destination` argument from it.'
+          )
+          params[:xcargs] = ''
+        end
+
+        platform = available_destinations[params[:platform]][:destination]
+        destination = "-destination 'generic/platform=#{platform}'"
+        products_path = "-IDECustomBuildProductsPath='#{products_path(params)}'"
+        if params[:derived_data_path]
+          "#{params[:xcargs]} #{products_path} #{destination}"
+        else
+          derived_data_path = "-derivedDataPath '#{products_path(params)}'"
+          "#{params[:xcargs]} #{products_path} #{destination} #{derived_data_path}"
+        end
+      end
+
+      def self.products_path(params)
+        params[:output_directory] ? params[:output_directory] : 'build'
+      end
+
+      def self.copy_app(params)
+        platform = available_destinations[params[:platform]][:folder]
+        postfix = "#{params[:configuration]}-#{platform}/#{params[:scheme]}.app"
+        products_path = products_path(params)
+
+        products_app_path =
+          if params[:project]
+            "#{File.dirname(File.expand_path(params[:project]))}/#{products_path}/#{postfix}"
+          elsif params[:workspace]
+            "#{File.dirname(File.expand_path(params[:workspace]))}/#{products_path}/#{postfix}"
+          else
+            "#{Dir.pwd}/#{products_path}/#{postfix}"
+          end
+
+        derived_data_app_path =
+          if params[:derived_data_path]
+            "#{params[:derived_data_path]}/Build/Products/#{postfix}"
+          else
+            "#{Dir.pwd}/#{products_path}/Build/Products/#{postfix}"
+          end
+
+        app_path = File.directory?(derived_data_app_path) ? derived_data_app_path : products_app_path
+
+        if params[:output_directory]
+          FileUtils.mkdir_p(params[:output_directory])
+          FileUtils.cp_r(app_path, params[:output_directory])
+          "#{params[:output_directory]}/#{params[:scheme]}.app"
+        else
+          FileUtils.rm_rf("#{params[:scheme]}.app")
+          FileUtils.cp_r(app_path, './')
+          "./#{params[:scheme]}.app"
+        end
+      end
+
+      def self.verify_destination(params)
+        case params[:platform]
+        when 'iOS'
+          :iOS
+        when 'tvOS'
+          :tvOS
+        when 'watchOS'
+          :watchOS
+        when nil
+          :iOS
+        else
+          FastlaneCore::UI.user_error!(
+            "🔬 Unrecognized platform: '#{params[:platform]}'. Available: 'iOS', 'tvOS' and 'watchOS'"
+          )
+        end
+      end
+
+      def self.available_destinations
+        {
+          iOS: { destination: 'iOS Simulator', folder: 'iphonesimulator' },
+          tvOS: { destination: 'tvOS Simulator', folder: 'appletvsimulator' },
+          watchOS: { destination: 'watchOS Simulator', folder: 'applewatchsimulator' }
+        }
+      end
+
+      def self.provide_shared_values(path)
+        Actions.lane_context[SharedValues::SIMULATOR_APP_OUTPUT_PATH] = File.expand_path(path)
+        ENV[SharedValues::SIMULATOR_APP_OUTPUT_PATH.to_s] = File.expand_path(path)
+      end
+
+      #####################################################
+      #                   Documentation                   #
+      #####################################################
+
+      def self.description
+        "This plugin builds apps exclusively for iOS, tvOS or watchOS Simulators."
+      end
+
+      def self.example_code
+        [
+          build_app_for_simulator(
+            scheme: 'sample-app',
+            project: 'sample-app/sample-app.xcodeproj',
+            configuration: 'Release',
+            output_directory: 'build'
+          )
+        ]
+      end
+
+      def self.output
+        [
+          ['SIMULATOR_APP_OUTPUT_PATH', 'The path to the newly generated app file']
+        ]
+      end
+
+      def self.authors
+        ["alteral"]
+      end
+
+      def self.available_options
+        XcodebuildAction.available_options + [
+          ['output_directory', 'The directory in which the app file should be stored in'],
+          ['workspace', 'Path to the workspace file'],
+          ['project', 'Path to the project file'],
+          ['scheme', "The project's scheme. Make sure it's marked as `Shared`"],
+          ['platform', "Use a custom simulator destination for building the app (iOS, tvOS or watchOS)"],
+          ['configuration', 'The configuration to use when building the app. Defaults to "Release"'],
+          ['derived_data_path', 'The directory where built products and other derived data will go'],
+          ['result_bundle_path', 'Path to the result bundle directory to create'],
+          ['buildlog_path', 'The directory where to store the build log'],
+          ['raw_buildlog', 'Set to true to see xcodebuild raw output'],
+          ['xcargs', "Pass additional xcodebuild options. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS='-ObjC -lstdc++'"]
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :tvos, :watchos].include?(platform)
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-build_app_for_simulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Alter-Pesotskiy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-16 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: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !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.144.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.144.0
+description:
+email: a.alterpesotskiy@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/build_app_for_simulator.rb
+- lib/fastlane/plugin/build_app_for_simulator/actions/build_app_for_simulator_action.rb
+- lib/fastlane/plugin/build_app_for_simulator/version.rb
+homepage: https://github.com/alteral/fastlane-plugin-build_app_for_simulator
+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: This plugin builds apps exclusively for iOS, tvOS or watchOS Simulators.
+test_files: []