fastlane-plugin-ipa_scale 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6c18a2b93aa4a100dca452cc518dc131e838bc58
4
+ data.tar.gz: 8b8294b10821b5d49889f0015417eb2a8146be2f
5
+ SHA512:
6
+ metadata.gz: 35d092880e049ad30ad96b6749ed93c093ff2fbd85ef9d8abb70d56afba13781ebb6cc93ff19b403382d6b22ce2974cff0f8428a260c8d8e5f660b6610657547
7
+ data.tar.gz: df54ada3a03e66e5a96ccd32276b0cb8918cc5e1c53f71bd14c249a3b060dae8dbf6c93c45ee0494ae1453ef262be739e18d0dfe8d67c1ff983981bcf4410739
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Danilo Caetano <dcaetano@truecar.com>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # ipa_scale plugin
2
+
3
+ [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ipa_scale)
4
+
5
+ ## Getting Started
6
+
7
+ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ipa_scale`, add it to your project by running:
8
+
9
+ ```bash
10
+ fastlane add_plugin ipa_scale
11
+ ```
12
+
13
+ ## About ipa_scale
14
+
15
+ Checks the size of your built .ipa and warns you if you you are near the given threshold.
16
+
17
+ This is meant to be called after `gym` has finished building and signing your application to let you know if your latest changes have made your .ipa larger than your desired limit. This was made with the idea of keeping your application from getting above the 100.0 MB cellular network download limit!
18
+
19
+ 🚦 If you exceed your limit, the build will fail. If you are within 5MB of your limit, we will simply warn you but not force fail the build. Otherwise, we will tell you the .ipa size and nothing else!
20
+
21
+
22
+ ## Example
23
+
24
+ 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`.
25
+
26
+ Simply include this within your desired lane, like so
27
+ ```
28
+ desc "Builds your .ipa!"
29
+ lane :custom_build do
30
+ clean_build_artifacts
31
+ clear_derived_data
32
+ gym(
33
+ output_directory: "./build/",
34
+ export_method: "app-store",
35
+ output_name: "my-ios-app",
36
+ scheme: "MyApp",
37
+ )
38
+ ipa_size_check(
39
+ path_to_ipa: "./build/my-ios-app.ipa"
40
+ ipa_limit: "100.0"
41
+ )
42
+ end
43
+ ```
44
+
45
+ ## Run tests for this plugin
46
+
47
+ To run both the tests, and code style validation, run
48
+
49
+ ```
50
+ rake
51
+ ```
52
+
53
+ To automatically fix many of the styling issues, use
54
+ ```
55
+ rubocop -a
56
+ ```
57
+
58
+ ## Issues and Feedback
59
+
60
+ For any other issues and feedback about this plugin, please submit it to this repository.
61
+
62
+ ## Troubleshooting
63
+
64
+ If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
65
+
66
+ ## Using _fastlane_ Plugins
67
+
68
+ For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
69
+
70
+ ## About _fastlane_
71
+
72
+ _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).
@@ -0,0 +1,16 @@
1
+ require 'fastlane/plugin/ipa_scale/version'
2
+
3
+ module Fastlane
4
+ module IpaScale
5
+ # Return all .rb files inside the "actions" and "helper" directory
6
+ def self.all_classes
7
+ Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
8
+ end
9
+ end
10
+ end
11
+
12
+ # By default we want to import all available actions and helpers
13
+ # A plugin can contain any number of actions and plugins
14
+ Fastlane::IpaScale.all_classes.each do |current|
15
+ require current
16
+ end
@@ -0,0 +1,77 @@
1
+ module Fastlane
2
+ module Actions
3
+ module SharedValues
4
+ IPA_SIZE_CHECK_CUSTOM_VALUE = :IPA_SIZE_CHECK_CUSTOM_VALUE
5
+ end
6
+
7
+ class IpaScaleAction < Action
8
+ def self.run(params)
9
+ UI.message "⚖️ Path to IPA: #{params[:path_to_ipa]}"
10
+ ipa_limit = params[:ipa_limit].to_f || 100.0
11
+ ipa_size = (File.size((params[:path_to_ipa]).to_s).to_f / 2**20).round(2)
12
+ if ipa_size >= ipa_limit
13
+ UI.user_error!(" ❗️ IPA size exceeded #{ipa_limit}MB limit - #{ipa_size}MB!")
14
+ false
15
+ elsif ipa_size >= (ipa_limit - 5.0)
16
+ UI.error(" ⚠️ IPA size dangerously close to #{ipa_limit}MB limit - #{ipa_size}MB!")
17
+ true
18
+ else
19
+ UI.message(" ⚖️ IPA size is safe from your #{ipa_limit}MB limit - #{ipa_size}MB!")
20
+ true
21
+ end
22
+ end
23
+
24
+ #####################################################
25
+ # @!group Documentation
26
+ #####################################################
27
+
28
+ def self.description
29
+ "⚖️ Checks the size of your built .ipa and warns you if you you are near the given threshold."
30
+ end
31
+
32
+ def self.details
33
+ "This is meant to be called after your gym step as a CI tool to let you know if your latest changes have made your .ipa larger than your desired limit.🚦 If you exceed your limit, the build will fail. If you are within 5MB of your limit, we will simply warn you but not force fail the build. Otherwise, we will tell you the .ipa size and nothing else!"
34
+ end
35
+
36
+ def self.available_options
37
+ [
38
+ FastlaneCore::ConfigItem.new(key: :path_to_ipa,
39
+ env_name: "FL_IPA_SIZE_CHECK_IPA_PATH",
40
+ description: "IPA path for IpaSizeCheckAction",
41
+ verify_block: proc do |value|
42
+ UI.user_error!("Couldn't find file at path '#{path_to_ipa}'") unless File.exist?(value)
43
+ end),
44
+ FastlaneCore::ConfigItem.new(key: :ipa_limit,
45
+ env_name: "FL_IPA_SIZE_CHECK_IPA_LIMIT",
46
+ description: "IPA limit for IpaSizeCheckAction",
47
+ verify_block: proc do |value|
48
+ begin
49
+ UI.user_error!("#{ipa_limit} is not a string") unless String(value)
50
+ rescue
51
+ nil
52
+ end
53
+ end)
54
+ ]
55
+ end
56
+
57
+ def self.output
58
+ [
59
+ ['FL_IPA_SIZE_CHECK_IPA_PATH', 'Path to .ipa'],
60
+ ['FL_IPA_SIZE_CHECK_IPA_LIMIT', 'Set limit threshold']
61
+ ]
62
+ end
63
+
64
+ def self.return_value
65
+ "Returns `true` if the IPA is <= given limit, otherwise returns false."
66
+ end
67
+
68
+ def self.authors
69
+ ["Danilo Caetano - Github: UIGuigo, Twitter: @armadill"]
70
+ end
71
+
72
+ def self.is_supported?(platform)
73
+ platform == :ios
74
+ end
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,12 @@
1
+ module Fastlane
2
+ module Helper
3
+ class IpaScaleHelper
4
+ # class methods that you define here become available in your action
5
+ # as `Helper::IpaScaleHelper.your_method`
6
+ #
7
+ def self.show_message
8
+ UI.message("Hello from the ipa_scale plugin helper!")
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,5 @@
1
+ module Fastlane
2
+ module IpaScale
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,148 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fastlane-plugin-ipa_scale
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Danilo Caetano
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2017-08-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: pry
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: fastlane
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: 2.54.2
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: 2.54.2
111
+ description:
112
+ email: uiguigo@gmail.com
113
+ executables: []
114
+ extensions: []
115
+ extra_rdoc_files: []
116
+ files:
117
+ - LICENSE
118
+ - README.md
119
+ - lib/fastlane/plugin/ipa_scale.rb
120
+ - lib/fastlane/plugin/ipa_scale/actions/ipa_scale_action.rb
121
+ - lib/fastlane/plugin/ipa_scale/helper/ipa_scale_helper.rb
122
+ - lib/fastlane/plugin/ipa_scale/version.rb
123
+ homepage: https://github.com/UIGuigo/ipa_scale
124
+ licenses:
125
+ - MIT
126
+ metadata: {}
127
+ post_install_message:
128
+ rdoc_options: []
129
+ require_paths:
130
+ - lib
131
+ required_ruby_version: !ruby/object:Gem::Requirement
132
+ requirements:
133
+ - - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: '0'
136
+ required_rubygems_version: !ruby/object:Gem::Requirement
137
+ requirements:
138
+ - - ">="
139
+ - !ruby/object:Gem::Version
140
+ version: '0'
141
+ requirements: []
142
+ rubyforge_project:
143
+ rubygems_version: 2.6.12
144
+ signing_key:
145
+ specification_version: 4
146
+ summary: '"Checks the size of your built .ipa and warns you if you you are near the
147
+ given threshold."'
148
+ test_files: []