fastlane-plugin-auto_version_name 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 786d23d7922236df9c7f658a188c82be0e19c6de2135742caf00089a24cfbe39
+  data.tar.gz: 1b25b601ee511504b73ad010fdbf20c431af362946e43243b603a45298333f59
+SHA512:
+  metadata.gz: 21acb54c2d35390b0d109a1ac37abee5d87fa845fc4a490b1d10204c3574d399e2a47658d0817128292de3b9e99c059a252cb341a869e049acd726e953157de0
+  data.tar.gz: d6767ad0df99cc1f2715ee2f12ec9bceb237fa9ee794952ea67823d61aeb57fe20a51f6b1f04ea4f328196ad82a56d31e207c022cb6ecfbe90f93298eda5e55e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 gileadeteixeira <gileadeateixeira@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,183 @@
+# auto_version_name plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-auto_version_name)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-auto_version_name`, add it to your project by running:
+
+```bash
+fastlane add_plugin auto_version_name
+```
+
+## About auto_version_name
+
+Generate incremented version names from Apple and Google stores.
+
+## 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Recommended Steps (Android & iOS)
+
+1 - In your `Root Directory`, create a `file` called `version_name`, with a minimal version that must be set as default:
+
+
+![image](https://user-images.githubusercontent.com/77688036/187472195-0295a9de-6381-4978-83c1-be189c76e676.png)
+
+2 - In your `Fastfiles`, create a `method` that returns, in `String`, the last version name in production (Store):
+
+```ruby
+platform :android do
+  # [...]
+  def get_live_version() # METHOD
+    return google_play_track_release_names().first 
+    # main method returns an array by default. ["1.0.0"] => "1.0.0"
+  end
+  # [...]
+end
+```
+
+```ruby
+platform :ios do
+  # [...]
+  root_directory = `cd ../.. && pwd`.chomp
+
+  api_key = app_store_connect_api_key(
+    key_id: "YOURKEYID",
+    issuer_id: "YOUR-ISSUER-ID",
+    key_filepath: "path/to/your/key.p8",
+  )
+
+  app_identifier = "your.app.identifier"
+
+  def get_live_version() # METHOD
+    app_store_build_number(api_key: api_key, live: true, app_identifier: app_identifier)  
+    return lane_context[SharedValues::LATEST_VERSION] # "1.0.0"
+  end
+  # [...]
+end
+```
+
+3 - In your `Fastfiles`, create a `lane` to export the live version name:
+
+```ruby
+platform :android do
+  # [...]
+  desc "Export live version name"
+  lane :live_version_name do
+    get_live_version()
+  end
+  # [...]
+end
+```
+
+```ruby
+platform :ios do
+  # [...]
+  desc "Export live version name"
+  lane :live_version_name do
+    get_live_version()
+  end
+  # [...]
+end
+```
+
+4 - In your `Fastfiles`, inside your main `lane`, call the plugin, passing the minimum version, and the version referring to the current platform. To reference the version of another platform, import the respective Fastfile and invoke its respective version lane:
+
+```ruby
+platform :android do
+  # [...]
+  desc "Export live version name"
+  lane :live_version_name do
+    get_live_version()
+  end
+  
+  desc "Submit a new build to Internal Test on Google Play"
+  lane :deploy do
+    # [...]
+    root_directory = `cd ../.. && pwd`.chomp
+
+    ios_lane = import("../../ios/fastlane/Fastfile")
+
+    version = auto_version_name(
+      minimal_version_string: File.open("#{root_directory}/version_name").read.chomp,
+      android_live_version: get_live_version(),
+      ios_live_version: ios_lane.runner.execute("live_version_name", "ios"),
+      # IMPORTANT: if your version lanes have the same name, you need to especify the platform on execute
+    )
+
+    puts version
+    # [...]
+  end
+  # [...]
+end
+```
+
+```ruby
+platform :ios do
+  # [...]
+  desc "Export live version name"
+  lane :live_version_name do
+    get_live_version()
+  end
+  
+  desc "Push a new beta build to TestFlight"
+  lane :deploy do
+    # [...]
+    root_directory = `cd ../.. && pwd`.chomp
+
+    android_lane = import("#{root_directory}/android/fastlane/Fastfile")
+
+    version = auto_version_name(
+      minimal_version_string: File.open("#{root_directory}/version_name").read.chomp,
+      ios_live_version: get_live_version(),
+      android_live_version: android_lane.runner.execute("live_version_name", "android"),
+      # IMPORTANT: if your version lanes have the same name, you need to especify the platform on execute
+    )
+
+    puts version
+    # [...]
+  end
+  # [...]
+end
+```
+
+**Notes**
+
+- If you don't pass parameters, the version considered will always be "1.0.0".
+
+- Auto increment will only work if some live version is passed as parameter.
+
+- The base version will always be the largest among the options passed as a parameter. Version comparison uses [Gem::Version](https://ruby-doc.org/stdlib-2.5.0/libdoc/rubygems/rdoc/Gem/Version.html#method-i-3C-3D-3E).
+
+## 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/auto_version_name/actions/auto_version_name_action.rb

@@ -0,0 +1,136 @@
+require 'fastlane/action'
+require_relative '../helper/auto_version_name_helper'
+
+module Fastlane
+  module Actions
+    class AutoVersionNameAction < Action
+      def self.run(params)
+        def self.version_string_to_array(version_string)
+          return version_string.split('.').map { |value| value.to_i }
+        end
+
+        def self.get_greater_version(version1, version2, version3)
+          greater_version = ""
+
+          version1 = version1 == nil ? "" : version1
+          version2 = version2 == nil ? "" : version2
+          version3 = version3 == nil ? "" : version3
+
+          is_v1_greater = Gem::Version.new(version1) >= Gem::Version.new(version2) && Gem::Version.new(version1) >= Gem::Version.new(version3)
+
+          is_v2_greater = Gem::Version.new(version2) >= Gem::Version.new(version1) && Gem::Version.new(version2) >= Gem::Version.new(version3)
+
+          is_v3_greater = Gem::Version.new(version3) >= Gem::Version.new(version1) && Gem::Version.new(version3) >= Gem::Version.new(version2)
+
+          if (is_v1_greater)
+            greater_version = version1
+          elsif (is_v2_greater)
+            greater_version = version2
+          elsif (is_v3_greater)
+            greater_version = version3
+          end
+
+          if (greater_version.empty? || greater_version == nil)
+            greater_version = "1.0.0"
+          end
+
+          return greater_version
+        end
+
+        # Initialize
+        branch = Actions.git_branch()
+        final_version_array = []
+        final_version_string = ""
+        minimal_version_string = params[:minimal_version]
+        ios_version_string = params[:ios_live_version]
+        android_version_string = params[:android_live_version]
+
+        final_version_array = get_greater_version(
+          minimal_version_string, ios_version_string, android_version_string
+        ).split('.').map { |value| value.to_i }
+
+        # Upgrade final version array and return
+        major = final_version_array[0]
+        minor = final_version_array[1]
+        patch = final_version_array[2]
+
+        # Auto increment.
+        # 1.0.1 => 1.0.1(+1) => 1.0.2 || 1.0.1 => 1.0(+1).1 => 1.1.0
+        if (branch.include? 'hotfix')
+          patch += 1
+        else
+          minor += 1
+          patch = 0
+        end
+
+        # Auto replacement if it reaches the limit.
+        # 1.999.1000 => 1.999(+1).0 => 1(+1).0.0 => 2.0.0
+        if(patch > 999)
+          patch = 0
+          minor += 1
+        end
+
+        if(minor > 999)
+          minor = 0
+          major += 1
+        end
+
+        live_versions_not_setted = (ios_version_string == nil || ios_version_string.empty?) && (android_version_string == nil || android_version_string.empty?)
+
+        unless (live_versions_not_setted)
+          final_version_array[0] = major
+          final_version_array[1] = minor
+          final_version_array[2] = patch
+        end
+
+        final_version_string = final_version_array.join('.') # [1, 0, 0] => "1.0.0"
+        return final_version_string
+      end
+
+      def self.description
+        "Generate incremented version names from Apple and Google stores"
+      end
+
+      def self.authors
+        ["gileadeteixeira"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :minimal_version,
+                                  env_name: "MINIMAL_VERSION_STRING",
+                               description: "A minimal version to be set",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :android_live_version,
+                                  env_name: "ANDROID_LIVE_VERSION",
+                               description: "Android's live version name e.g. \"1.0.0\"",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :ios_live_version,
+                                  env_name: "IOS_LIVE_VERSION",
+                               description: "iOS's live version name e.g. \"1.0.0\"",
+                                  optional: true,
+                                      type: String),
+        ]
+      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
+    end
+  end
+end

data/lib/fastlane/plugin/auto_version_name/helper/auto_version_name_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class AutoVersionNameHelper
+      # class methods that you define here become available in your action
+      # as `Helper::AutoVersionNameHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the auto_version_name plugin helper!")
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/auto_version_name.rb

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

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-auto_version_name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gileadeteixeira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-30 00:00:00.000000000 Z
+dependencies:
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.206.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.206.2
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description:
+email: gileadeateixeira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/auto_version_name.rb
+- lib/fastlane/plugin/auto_version_name/actions/auto_version_name_action.rb
+- lib/fastlane/plugin/auto_version_name/helper/auto_version_name_helper.rb
+- lib/fastlane/plugin/auto_version_name/version.rb
+homepage: https://github.com/App2Sales/fastlane-plugin-auto_version_name
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Generate incremented version names from Apple and Google stores
+test_files: []