fastlane-plugin-flutter_version 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a66f9721e5629bffa15e63e174ab0ece2c3927742ab659a9f36351a38bb0e82
-  data.tar.gz: 0f656f9d433c51ff08428a796d117dd5826fcd41d3724ddab205937a68a9e849
+  metadata.gz: 512186627d9a812af0d7e8429a7fece5da8eebb51980011a58aeb96489f49701
+  data.tar.gz: 544eb7cff0758a7e6691ceabe5f2fb83bb116916ef1867cd6b4106aac3e000bb
 SHA512:
-  metadata.gz: 5440cfaeaaa4715e3db2c9371cbc58930ca29d4142e3a23fbb683d5ef3fdf0c5d4e795d6a0382db03c7f977808e243190873bb4af59a2b185cc85a56bb0d2ef0
-  data.tar.gz: 85b7a7c8ae3b80a2d70beac18e34533ff3900a78203a6f5b50e4c1f715a2d0fbc46d38c26157646c491cbe98a027fd2e114b0fdaec624af1080ed8f2b3b676e7
+  metadata.gz: 3a4a6a0469a305b0f865f56cfa58a00eaf096142910310f84d03bc03124d40f92206ce3f5f774386aa872326243e73e5cb7bbaab3e58947b8331f672273e7637
+  data.tar.gz: 4efc7f6d4e36f16b652c4966f882fae70021510e09ed7e724ad93a7f2a297898a82517cc8dca8923d574e846c3c221997fc68374ebdc38349857c4019df3f526

data/README.md

@@ -1,12 +1,28 @@
 # flutter_version plugin
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_version)
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version) 
+[![codecov](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version/branch/master/graph/badge.svg)](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version)
 
-## Getting Started
+flutter_version is a Fastlane plugin to retrieve version code from Flutter projects which can be used to release changlogs and other metadata to marketplaces.
+
+## Installation
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-flutter_version`, add it to your project by adding the following lines in `Gemfile`:
 
+### From GitHub registry (Recommended)
+
+Check out the instructions [here](https://github.com/tianhaoz95/fastlane-plugin-flutter_version/packages/143774).
+
+### From gem registry
+
+Check out the instructions [here](https://rubygems.org/gems/fastlane-plugin-flutter_version).
+
+### Directly from Github
+
 ```Gemfile
 gem "fastlane-plugin-flutter_version", git: "https://github.com/tianhaoz95/fastlane-plugin-flutter-version"
 ```
@@ -17,34 +33,86 @@ A plugin to retrieve versioning information for Flutter projects.
 
 ## 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`.
+The following example releases a Android app to Google Play Store without needing to manually specify the app version:
+
+```ruby
+desc "submit to internal track in Google Play Store"
+lane :internal do
+  gradle(task: 'bundle', build_type: 'Release')
+  upload_to_play_store(
+    track: 'internal',
+    version_code: flutter_version()["version_code"],
+    aab: '../build/app/outputs/bundle/release/app-release.aab',
+    skip_upload_screenshots: true,
+    skip_upload_images: true
+  )
+end
+```
 
-## Run tests for this plugin
+The line `flutter_version()` fetches the version information from the `pubspec.yaml` file from the Flutter project and parses the version information from the file. This is convenient for continuous integration because it saves the effort for developers to keep track of version information in multiple places.
 
-To run both the tests, and code style validation, run
+For more details, check out the [example project configuration](https://github.com/tianhaoz95/photochat/blob/master/photochatapp/android/fastlane/Fastfile).
+
+## For developers
 
+### Install dependencies
+
+```bash
+bundle install
 ```
-rake
+
+If the command above complains about permission issue, use:
+
+```bash
+sudo bundle install --path ./vendor/bundle
 ```
 
-To automatically fix many of the styling issues, use
+### Run tests for this plugin
+
+To run both the tests, and code style validation, run
 
+```bash
+bunlde exec rake
 ```
-rubocop -a
+
+To automatically fix many of the styling issues, use
+
+```bash
+bundle exec rake rubocop:auto_correct -a
 ```
 
-## Issues and Feedback
+## Issues and feedback
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+For any other issues and feedback about this plugin, please submit it to [this repository](https://github.com/tianhaoz95/fastlane-plugin-flutter_version).
 
 ## Troubleshooting
 
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
 
-## Using _fastlane_ Plugins
+## 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_
+## 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).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://www.shunkakinoki.com/"><img src="https://avatars0.githubusercontent.com/u/39187513?v=4" width="100px;" alt=""/><br /><sub><b>Shun Kakinoki</b></sub></a><br /><a href="https://github.com/tianhaoz95/fastlane-plugin-flutter_version/commits?author=shunkakinoki" title="Code">💻</a></td>
+    <td align="center"><a href="http://tianhaoz.com"><img src="https://avatars3.githubusercontent.com/u/16887772?v=4" width="100px;" alt=""/><br /><sub><b>Tianhao Zhou</b></sub></a><br /><a href="https://github.com/tianhaoz95/fastlane-plugin-flutter_version/commits?author=tianhaoz95" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
-_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).
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/fastlane/plugin/flutter_version.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'fastlane/plugin/flutter_version/version'
 
 module Fastlane
+  # The plugin wrapper
   module FlutterVersion
     # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes

data/lib/fastlane/plugin/flutter_version/actions/flutter_version_action.rb

@@ -1,61 +1,79 @@
+# frozen_string_literal: true
+
 require 'fastlane/action'
 require 'yaml'
 require_relative '../helper/flutter_version_helper'
 
 module Fastlane
   module Actions
+    # The top-level plugin interface
     class FlutterVersionAction < Action
       def self.run(params)
-        UI.message("The flutter_version plugin is working!")
         pubspec_location = params[:pubspec_location]
-        pubspec = YAML.load_file(pubspec_location)
-        version = pubspec["version"]
-        UI.message("The full version is: ".concat(version))
-        if not version.include? "+"
-          raise "Verson code indicator (+) not foud in pubspec.yml"
+        begin
+          pubspec = YAML.load_file(pubspec_location)
+        # rubocop:disable Style/RescueStandardError
+        rescue
+          raise 'Read pubspec.yaml failed'
+        end
+        # rubocop:enable Style/RescueStandardError
+        version = pubspec['version']
+        UI.message('The full version is: '.dup.concat(version))
+        unless version.include?('+')
+          raise 'Verson code indicator (+) not found in pubspec.yml'
         end
-        version_sections = version.split("+")
+
+        version_sections = version.split('+')
         version_name = version_sections[0]
         version_code = version_sections[1]
-        UI.message("The version name: ".concat(version_name))
-        UI.message("The version code: ".concat(version_code))
-        return version_code
+        UI.message('The version name: '.dup.concat(version_name))
+        UI.message('The version code: '.dup.concat(version_code))
+        {
+          'version_code' => version_code,
+          'version_name' => version_name
+        }
       end
 
       def self.description
-        "A plugin to retrieve versioning information for Flutter projects."
+        'A plugin to retrieve versioning information for Flutter projects.'
       end
 
       def self.authors
-        ["tianhaoz95"]
+        ['tianhaoz95']
       end
 
       def self.return_value
         [
-          ['VERSION_CODE', 'The version code']
+          ['VERSION_CODE', 'The version code'],
+          ['VERSION_NAME', 'The verison name']
         ]
       end
 
       def self.details
-        "The plugin reads and parses pubspec.yml of a Flutter project and composes the versioning information into structured data to be consumed by various releasing automations."
+        "The plugin reads and parses pubspec.yml of a Flutter
+        project and composes the versioning information into
+        structured data to be consumed by various releasing
+        automations."
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
             key: :pubspec_location,
-            env_name: "PUBSPEC_LOCATION",
-            description: "The location of pubspec.yml",
+            env_name: 'PUBSPEC_LOCATION',
+            description: 'The location of pubspec.yml',
             optional: true,
             type: String,
-            default_value:"../pubspec.yaml"
-          ),
+            default_value: '../pubspec.yaml'
+          )
         ]
       end
 
-      def self.is_supported?(platform)
+      # rubocop:disable Naming/PredicateName
+      def self.is_supported?(_platform)
         true
       end
+      # rubocop:enable Naming/PredicateName
     end
   end
 end

data/lib/fastlane/plugin/flutter_version/helper/flutter_version_helper.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'fastlane_core/ui/ui'
 
+# Fastlane namespace
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
 
   module Helper
+    # Generated helper function for the plugin
     class FlutterVersionHelper
       # class methods that you define here become available in your action
       # as `Helper::FlutterVersionHelper.your_method`
-      #
       def self.show_message
-        UI.message("Hello from the flutter_version plugin helper!")
+        UI.message('Hello from the flutter_version plugin helper!')
       end
     end
   end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Fastlane
   module FlutterVersion
-    VERSION = "0.1.3"
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-flutter_version
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - tianhaoz95
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.142.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.142.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-require_tools
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fastlane
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.142.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.142.0
+        version: '0'
 description: 
 email: tianhaoz@umich.edu
 executables: []
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="