fastlane-plugin-flutter_version_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a445dfae711ec9546ca087a5fe8915eec0527a50404e22abd2b6ce5ff121728
+  data.tar.gz: 9b41962257e201c4bb5ce1f5b8d224c25cde3ba865c2ef07b1520da30d5ef969
+SHA512:
+  metadata.gz: cee00234ac5ae70bdd130f486c001b5343b44cf4be6bc2b946c231b6bbf1ff7071e68af3914b48eb50715fbabec6a75e03c1dbcd304ca84bc1a8b945839c843b
+  data.tar.gz: 16d4dec2fbb25437635b3ae8521db3a059a4577a760ecc72e5156c73d35b044670d8ccc3befd52c73e7c6f553ab273db7cdc68f470fb94121f51e9718dbfdc33

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Davor Maric <davormaric@outlookc.com> and Rubicon <info@rubicon-world.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,58 @@
+# flutter_version_manager plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_version_manager)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-flutter_version_manager`, add it to your project by running:
+
+```bash
+fastlane add_plugin flutter_version_manager
+```
+
+Inside project root, create new `version.yml` file and add the following:
+```
+---
+major: 0
+minor: 0
+patch: 1
+
+```
+## About flutter_version_manager
+
+Manages app versioning of a Flutter project. This plugin heavily resides on having a git repository and at least one commit as version code is applied through timestamp of HEAD commit. As for app version, `version.yml` should be used as a single source of truth. In order to apply changes to pubspec, use `-apply` as an argument of a plugin.
+
+This plugin accepts 4 arguments:
+`yml` - Path to version.yml file
+`pubspec` - Path to pubspec.yaml file
+`git_repo` - Path to git repository (optional)
+`arguments` - Additional arguments (optional)
+```
+-h: Access this menu
+-version: Reads current version name
+-code: Reads current version code
+-major: Bumps major version
+-minor: Bumps minor version
+-patch: Bumps patch version
+-apply: Applies version specified from version.yml to pubspec
+```
+
+## 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`.
+
+## 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/flutter_version_manager.rb

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

data/lib/fastlane/plugin/flutter_version_manager/actions/flutter_version_manager_action.rb

@@ -0,0 +1,248 @@
+require 'fastlane/action'
+require_relative '../helper/flutter_version_manager_helper'
+require 'git'
+require 'yaml'
+
+GIT_OFFSET = 1598622000 # IMPORTANT: Do not change!
+
+module Fastlane
+  module Actions
+
+    class ArgumentManager
+      def evaluateArgument(argument)
+        case argument
+        when '-h'
+          true
+        when "-version"
+          true
+        when "-code"
+          true
+        when "-major"
+          true
+        when "-minor"
+          true
+        when "-patch"
+          true
+        when "-apply"
+          true
+        else
+          false
+        end
+      end
+  
+      def invalid_argument
+        UI.message("You have to pass at least one argument: Use -h view all commands")
+      end
+  
+      def missing_required_arguments
+        UI.message("You have to pass paths to version.yml and pubspec.yml: Use -h for more info")
+      end
+  
+      def commands
+        "
+        -h: Access this menu
+        -version: Reads current version name
+        -code: Reads current version code
+        -major: Bumps major version
+        -minor: Bumps minor version
+        -patch: Bumps patch version
+        -apply: Applies version specified from version.yml to pubspec
+        "
+      end
+    end
+  
+    class GitReader
+      def initialize(git_path)
+        @git = Git.open(git_path)
+      end
+  
+      def get_timestamp
+        head = @git.object('HEAD')
+        commit = @git.gcommit(head.sha)
+        commit.date.to_i
+      end
+    end
+  
+    class YamlReader
+      def initialize(yaml_path)
+        @yamlFile = YAML.load_file(yaml_path)
+      end
+  
+      def field(fieldName)
+        @yamlFile[fieldName]
+      end
+  
+      def all
+        @yamlFile
+      end
+    end
+  
+    class YamlWritter
+      def initialize(yaml_path)
+        @yaml_path = yaml_path
+      end
+  
+      def write(yaml)
+        File.open(@yaml_path, "w") { |file| file.write(yaml.to_yaml) }
+      end
+    end
+  
+    class FileReader
+      def initialize(yaml_path)
+        @yaml_path = yaml_path
+      end
+  
+      def read
+        IO.readlines(@yaml_path)
+      end
+    end
+  
+    class FileWritter
+      def initialize(yaml_path)
+        @yaml_path = yaml_path
+      end
+  
+      def write(content)
+        File.open(@yaml_path, "w") { |file|
+          file.puts(content)
+          file.close
+        }
+      end
+    end
+  
+    class VersionManager
+      def initialize(yaml_path, pubspec_path, git_path)
+        @version_reader = YamlReader.new(yaml_path)
+        @version_writter = YamlWritter.new(yaml_path)
+        @pubspec_yaml_reader = YamlReader.new(pubspec_path)
+        @pubspec_file_reader = FileReader.new(pubspec_path)
+        @pubspec_file_writter = FileWritter.new(pubspec_path)
+        @git_reader = GitReader.new(git_path)
+      end
+  
+      def get_current_version_name
+        "#{@version_reader.field('major')}.#{@version_reader.field('minor')}.#{@version_reader.field('patch')}"
+      end
+  
+      def get_current_version_code
+        @git_reader.get_timestamp - GIT_OFFSET
+      end
+  
+      def bump_major
+        context = @version_reader.all
+        context['major'] = context['major'] + 1
+        context['minor'] = 0
+        context['patch'] = 0
+        @version_writter.write(context)
+        update_pubspec
+      end
+  
+      def bump_minor
+        context = @version_reader.all
+        context['minor'] = context['minor'] + 1
+        context['patch'] = 0
+        @version_writter.write(context)
+        update_pubspec
+      end
+  
+      def bump_patch
+        context = @version_reader.all
+        context['patch'] = context['patch'] + 1
+        @version_writter.write(context)
+        update_pubspec
+      end
+      
+      def update_pubspec
+        previousVersion = @pubspec_yaml_reader.field('version')
+        newVersion = "#{get_current_version_name}+#{get_current_version_code}"
+        newContent = @pubspec_file_reader.read.map { |s| s.gsub(previousVersion, newVersion) }
+        @pubspec_file_writter.write(newContent)
+        UI.message("Previous app version: #{previousVersion}")
+        UI.message("New app version: #{newVersion}")
+      end
+    end
+  
+    ARGUMENT_MANAGER = ArgumentManager.new()
+
+    class FlutterVersionManagerAction < Action
+      def self.run(params)
+        version_path = params[:yml]
+        pubspec_path = params[:pubspec]
+        git_path = params[:git_repo] || './'
+        args = (params[:arguments] || "").split(" ")
+
+        # Paths valid, continue
+        versionManager = VersionManager.new(version_path, pubspec_path, git_path)
+
+        # Check if the user has passed additional arguments
+        if(args.include?("-h") || args.include?("-version") || args.include?("-code") || args.include?("-major") || args.include?("-minor") || args.include?("-patch") || args.include?("-apply"))
+          args.each { |a|
+            case a
+            when '-h'
+              UI.message(ARGUMENT_MANAGER.commands)
+            when "-version"
+              UI.message(versionManager.get_current_version_name)
+            when "-code"
+              UI.message(versionManager.get_current_version_code)
+            when "-major"
+              versionManager.bump_major
+            when "-minor"
+              versionManager.bump_minor
+            when "-patch"
+              versionManager.bump_patch
+            when "-apply"
+              versionManager.update_pubspec
+            end
+          }
+        else
+          ARGUMENT_MANAGER.invalid_argument
+        end
+      end
+
+      def self.description
+        "Manages app versioning of a Flutter project."
+      end
+
+      def self.authors
+        ["Davor Maric", "rubicon-world.com"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "App versioning tool for Flutter projects that can be plugged into pipeline via CI/CD"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :arguments,
+            description: "Additional arguments",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(
+            key: :yml,
+            description: "Path to version.yml",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(
+            key: :pubspec,
+            description: "Path to pubspec.yaml",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(
+            key: :git_repo,
+            description: "Path to root folder of git repository",
+            optional: true,
+            type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/flutter_version_manager/helper/flutter_version_manager_helper.rb

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

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module FlutterVersionManager
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-flutter_version_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Davor Maric
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-01 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.149.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.149.1
+description:
+email: davormaric@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/flutter_version_manager.rb
+- lib/fastlane/plugin/flutter_version_manager/actions/flutter_version_manager_action.rb
+- lib/fastlane/plugin/flutter_version_manager/helper/flutter_version_manager_helper.rb
+- lib/fastlane/plugin/flutter_version_manager/version.rb
+homepage: https://github.com/rubiconba/fastlane-plugin-flutter-version-manager
+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.1.2
+signing_key:
+specification_version: 4
+summary: Manages app versioning of Flutter project
+test_files: []