fastlane-plugin-versioning_ios 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43b0fd56934ffd80a4de7e24e8abbff53f242757
+  data.tar.gz: 0ff86f254bf9dca1e7e7d728c44d90d1671c2677
+SHA512:
+  metadata.gz: 7c19c77505c26ce1ce765da9f64432454fdb260365f4c46de5692d62241ae4cdc8d9e92b204f142dba1e74be7461ca871b1a3ecbe471f92560ba9d81925e21ca
+  data.tar.gz: 5b46e8366f2f021b90253bd7338b37addd88f568b376356675984d2e0b90ea0ca5ecb80cf0b8bf9459582fae2474e7c3eb2382dec1af723497aaf068df4ced6d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Lamos <igor@be.plus>
+
+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,58 @@
+# versioning_ios plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-versioning_ios)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-versioning_ios`, add it to your project by running:
+
+```bash
+fastlane add_plugin versioning_ios
+```
+
+## About versioning_ios
+
+iOS Versioning Plugin for Fastlane
+
+### Available actions
+- `ios_get_build_number` to get the Build Number
+- `ios_get_version` to get the Version
+- `ios_set_build_number` to set the new Build Number
+- `ios_set_version` to set the new Version
+
+## 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`.
+
+### Example project
+
+You can find a fully functional setup of this plugin in the [UdemyFastlane](https://github.com/igorlamos/udemy-fastlane) repo, where you also can find more info about versioning of iOS apps.
+
+## 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/versioning_ios.rb

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

data/lib/fastlane/plugin/versioning_ios/actions/ios_get_build_number.rb

@@ -0,0 +1,78 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      IOS_BUILD_NUMBER = :IOS_BUILD_NUMBER
+    end
+
+    class IosGetBuildNumberAction < Action
+      # More information about how to set up your project and how it works:
+      # https://developer.apple.com/library/ios/qa/qa1827/_index.html
+      # Attention: This is NOT the Version - but the Build Number
+
+      def self.run(params)
+        xcodeproj = params[:xcodeproj]
+
+        command_get = Helper::VersioningIosHelper.get_build_number_command(xcodeproj)
+        Helper::VersioningIosHelper.is_agv_enabled(xcodeproj)
+
+        build_number = Helper.test? ? `#{command_get}` : (Actions.sh command_get)
+        build_number = Helper::VersioningIosHelper.parse_build_number(build_number)
+
+        UI.success("👍  Current Build Number is: #{build_number}")
+
+        # Store the Build Number in the shared hash
+        Actions.lane_context[SharedValues::IOS_BUILD_NUMBER] = build_number
+      end
+
+      def self.description
+        "Get the Build Number of your iOS project"
+      end
+
+      def self.details
+        [
+          "This action will return current Build Number of your iOS project.",
+          "You have to set up your Xcode project to use AGV. For more info:",
+          "https://developer.apple.com/library/ios/qa/qa1827/_index.html"
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "FL_IOS_GET_BUILD_NUMBER_XCODEPROJ",
+                               description: "(optional) Specify the path to your main Xcode project if it isn't in the project root directory",
+                                  optional: true,
+                              verify_block: proc do |value|
+                                UI.user_error!("Please specify the path to the project, not workspace") if value.end_with? ".xcworkspace"
+                                UI.user_error!("Could not find Xcode project") unless File.exist?(value)
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['IOS_BUILD_NUMBER', 'The Build Number of your iOS project']
+        ]
+      end
+
+      def self.return_value
+        "The Build Number of your iOS project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include? platform
+      end
+
+      def self.example_code
+        [
+          'build_number = ios_get_build_number # Xcode project is in the project root directory',
+          'build_number = ios_get_build_number(xcodeproj: "/path/to/Project.xcodeproj")'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_ios/actions/ios_get_version.rb

@@ -0,0 +1,78 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      IOS_VERSION = :IOS_VERSION
+    end
+
+    class IosGetVersionAction < Action
+      # More information about how to set up your project and how it works:
+      # https://developer.apple.com/library/ios/qa/qa1827/_index.html
+      # Attention: This is NOT the Version - but the Build Number
+
+      def self.run(params)
+        xcodeproj = params[:xcodeproj]
+
+        command_get = Helper::VersioningIosHelper.get_version_command(xcodeproj)
+        Helper::VersioningIosHelper.is_agv_enabled(xcodeproj)
+
+        version = Helper.test? ? `#{command_get}` : (Actions.sh command_get)
+        version = Helper::VersioningIosHelper.parse_version(version)
+
+        UI.success("👍  Current Version is: #{version}")
+
+        # Store the Version in the shared hash
+        Actions.lane_context[SharedValues::IOS_VERSION] = version
+      end
+
+      def self.description
+        "Get the Version of your iOS project"
+      end
+
+      def self.details
+        [
+          "This action will return current Version of your iOS project.",
+          "You have to set up your Xcode project to use AGV. For more info:",
+          "https://developer.apple.com/library/ios/qa/qa1827/_index.html"
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "FL_IOS_GET_VERSION_XCODEPROJ",
+                               description: "(optional) Specify the path to your main Xcode project if it isn't in the project root directory",
+                                  optional: true,
+                              verify_block: proc do |value|
+                                UI.user_error!("Please specify the path to the project, not workspace") if value.end_with? ".xcworkspace"
+                                UI.user_error!("Could not find Xcode project") unless File.exist?(value)
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['IOS_VERSION', 'The Version of your iOS project']
+        ]
+      end
+
+      def self.return_value
+        "The Version of your iOS project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include? platform
+      end
+
+      def self.example_code
+        [
+          'build_number = ios_get_version # Xcode project is in the project root directory',
+          'build_number = ios_get_version(xcodeproj: "/path/to/Project.xcodeproj")'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_ios/actions/ios_set_build_number.rb

@@ -0,0 +1,99 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      IOS_NEW_BUILD_NUMBER = :IOS_NEW_BUILD_NUMBER
+    end
+
+    class IosSetBuildNumberAction < Action
+      # More information about how to set up your project and how it works:
+      # https://developer.apple.com/library/ios/qa/qa1827/_index.html
+      # Attention: This is NOT the Version - but the Build Number
+
+      def self.run(params)
+        xcodeproj = params[:xcodeproj]
+        build_number = params[:build_number]
+
+        command_get = Helper::VersioningIosHelper.get_build_number_command(xcodeproj)
+        command_set = Helper::VersioningIosHelper.set_build_number_command(xcodeproj, build_number)
+        Helper::VersioningIosHelper.is_agv_enabled(xcodeproj)
+
+        if Helper.test?
+          `#{command_set}`
+          new_build_number = `#{command_get}`
+        else
+          (Actions.sh command_set)
+          new_build_number = (Actions.sh command_get)
+        end
+
+        new_build_number = Helper::VersioningIosHelper.parse_build_number(new_build_number)
+
+        UI.success("👍  Build Number has been set to: #{new_build_number}")
+
+        # Store the Build Number in the shared hash
+        Actions.lane_context[SharedValues::IOS_NEW_BUILD_NUMBER] = new_build_number
+      end
+
+      def self.description
+        "Set the Build Number of your iOS project"
+      end
+
+      def self.details
+        [
+          "This action will set the new Build Number on your iOS project.",
+          "You have to set up your Xcode project to use AGV. For more info:",
+          "https://developer.apple.com/library/ios/qa/qa1827/_index.html"
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :build_number,
+                                  env_name: "FL_IOS_SET_BUILD_NUMBER_BUILD_NUMBER",
+                               description: "Change to a specific Build Number",
+                                  optional: true,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "FL_IOS_SET_BUILD_NUMBER_XCODEPROJ",
+                               description: "(optional) Specify the path to your main Xcode project if it isn't in the project root directory",
+                                  optional: true,
+                              verify_block: proc do |value|
+                                UI.user_error!("Please specify the path to the project, not workspace") if value.end_with? ".xcworkspace"
+                                UI.user_error!("Could not find Xcode project") unless File.exist?(value)
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['IOS_NEW_BUILD_NUMBER', 'The new Build Number of your iOS project']
+        ]
+      end
+
+      def self.return_value
+        "The new Build Number of your iOS project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include? platform
+      end
+
+      def self.example_code
+        [
+          'ios_set_build_number # Automatically increment by one',
+          'ios_set_build_number(
+            build_number: "17" # Set a specific number
+          )',
+          'ios_set_build_number(
+            build_number: "17",
+            xcodeproj: "/path/to/Project.xcodeproj" # Xcode project is not in the project root directory
+          )',
+          'build_number = ios_set_build_number # Save returned Build Number to a variable'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_ios/actions/ios_set_version.rb

@@ -0,0 +1,97 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      IOS_NEW_VERSION = :IOS_NEW_VERSION
+    end
+
+    class IosSetVersionAction < Action
+      # More information about how to set up your project and how it works:
+      # https://developer.apple.com/library/ios/qa/qa1827/_index.html
+      # Attention: This is NOT the Version - but the Build Number
+
+      def self.run(params)
+        xcodeproj = params[:xcodeproj]
+        version = params[:version]
+
+        command_get = Helper::VersioningIosHelper.get_version_command(xcodeproj)
+        command_set = Helper::VersioningIosHelper.set_version_command(xcodeproj, version)
+        Helper::VersioningIosHelper.is_agv_enabled(xcodeproj)
+
+        if Helper.test?
+          `#{command_set}`
+          new_version = `#{command_get}`
+        else
+          (Actions.sh command_set)
+          new_version = (Actions.sh command_get)
+        end
+
+        new_version = Helper::VersioningIosHelper.parse_version(new_version)
+
+        UI.success("👍  Version has been set to: #{new_version}")
+
+        # Store the Version in the shared hash
+        Actions.lane_context[SharedValues::IOS_NEW_VERSION] = new_version
+      end
+
+      def self.description
+        "Set the Version of your iOS project"
+      end
+
+      def self.details
+        [
+          "This action will set the new Version on your iOS project.",
+          "You have to set up your Xcode project to use AGV. For more info:",
+          "https://developer.apple.com/library/ios/qa/qa1827/_index.html"
+        ].join(' ')
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                  env_name: "FL_IOS_SET_VERSION_VERSION",
+                               description: "Change to a specific Version",
+                                  optional: true,
+                                 is_string: true),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "FL_IOS_SET_VERSION_XCODEPROJ",
+                               description: "(optional) Specify the path to your main Xcode project if it isn't in the project root directory",
+                                  optional: true,
+                              verify_block: proc do |value|
+                                UI.user_error!("Please specify the path to the project, not workspace") if value.end_with? ".xcworkspace"
+                                UI.user_error!("Could not find Xcode project") unless File.exist?(value)
+                              end)
+        ]
+      end
+
+      def self.output
+        [
+          ['IOS_NEW_VERSION', 'The new Version of your iOS project']
+        ]
+      end
+
+      def self.return_value
+        "The new Version of your iOS project"
+      end
+
+      def self.authors
+        ["Igor Lamoš"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include? platform
+      end
+
+      def self.example_code
+        [
+          'ios_set_version(
+            version: "1.23.4" # Set a specific version
+          )',
+          'ios_set_version(
+            version: "1.23.4", # Set a specific version
+            xcodeproj: "/path/to/Project.xcodeproj" # Xcode project is not in the project root directory
+          )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning_ios/helper/versioning_ios_helper.rb

@@ -0,0 +1,68 @@
+module Fastlane
+  module Helper
+    class VersioningIosHelper
+      require "shellwords"
+
+      XCODEPROJ_TEST = "/tmp/fastlane/tests/versioning/Project.xcodeproj"
+
+      def self.get_xcodeproj(xcodeproj)
+        return Helper.test? ? XCODEPROJ_TEST : xcodeproj
+      end
+
+      def self.get_xcodeproj_path(xcodeproj)
+        project_file = self.get_xcodeproj(xcodeproj)
+        path = project_file ? File.join(project_file, "..") : "."
+        return File.expand_path(path).shellescape
+      end
+
+      def self.get_version_command(xcodeproj)
+        path = self.get_xcodeproj_path(xcodeproj)
+        return [
+          "cd", path, "&&", "agvtool", "what-marketing-version", "-terse1"
+        ].join(" ")
+      end
+
+      def self.set_version_command(xcodeproj, version)
+        path = self.get_xcodeproj_path(xcodeproj)
+        version = self.parse_version(version)
+        return [
+          "cd", path, "&&", "agvtool", "new-marketing-version", version
+        ].join(" ")
+      end
+
+      def self.get_build_number_command(xcodeproj)
+        path = self.get_xcodeproj_path(xcodeproj)
+        return [
+          "cd", path, "&&", "agvtool", "what-version", "-terse"
+        ].join(" ")
+      end
+
+      def self.set_build_number_command(xcodeproj, build_number)
+        path = self.get_xcodeproj_path(xcodeproj)
+        agvtool_command = build_number ? "new-version -all #{self.parse_build_number(build_number)}" : "next-version -all"
+        return [
+          "cd", path, "&&", "agvtool", agvtool_command
+        ].join(" ")
+      end
+
+      def self.parse_version(version)
+        # @todo SemVer check
+        return version.to_s.strip
+      end
+
+      def self.parse_build_number(build_number)
+        return build_number.to_s.strip
+      end
+
+      def self.is_agv_enabled(xcodeproj)
+        # We do not want to run agvtool under tests to avoid
+        # output about not having a project configured for AGV
+        command_get = "#{self.get_version_command(xcodeproj)} > /dev/null 2>&1"
+        unless Helper.test?
+          agv_enabled = system(command_get)
+          raise "Apple Generic Versioning (AGV) is not enabled." unless agv_enabled
+        end
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-versioning_ios
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Lamoš
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 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: 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.66.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.66.0
+description: 
+email: igor@be.plus
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/versioning_ios.rb
+- lib/fastlane/plugin/versioning_ios/actions/ios_get_build_number.rb
+- lib/fastlane/plugin/versioning_ios/actions/ios_get_version.rb
+- lib/fastlane/plugin/versioning_ios/actions/ios_set_build_number.rb
+- lib/fastlane/plugin/versioning_ios/actions/ios_set_version.rb
+- lib/fastlane/plugin/versioning_ios/helper/versioning_ios_helper.rb
+- lib/fastlane/plugin/versioning_ios/version.rb
+homepage: https://github.com/beplus/fastlane-plugin-versioning_ios
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: iOS Versioning Plugin for Fastlane
+test_files: []