fastlane-plugin-flutter 0.3.17 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c074866e0966b7ede427c98d5fa61b359d9453d09a0db3ef5e24ee2b1204325
-  data.tar.gz: 6a8e7b42e826e404a46c5d94744b2b1e4f54b4ef3aa537e9381be93bf7653785
+  metadata.gz: e08545073c4e4d3d8f8b4abbf1c8dc35a6aeae562e5fea8f888a5ef562990390
+  data.tar.gz: 55e6d48ffd6a7f5d0189f111c31f95c0ff70941078ef7c72dc090d1eeec096c5
 SHA512:
-  metadata.gz: 8a3a165a042faa309d277ca9a4d03a48c566849fa935cdee9a7b21fe9c1bfb8229018a715df7ae767a61812ba14284bd6c4b3f94488036c6f5ff41a3f7662b81
-  data.tar.gz: 9361f891a5720c357da65f92c69ba87340f9e37240c874b9b6b67ae9a674e8cdebd70825bac220695e6125f4d4beb25deea1122e401fe6de4168e5c99831639b
+  metadata.gz: 57e28fc3cdf69975601f68d55a35baf2d5346896209e8b64db482f1138ce0f613e4a980512a61280be13c58332f84dd7b9053867ab369415cbe73d2a65ecf93b
+  data.tar.gz: b2fa06f9134c563edc33bcb89d2e4d460313977f1212dc7ce2396ee1f9031f8257652e001d896fb053a0b084bd91334a428d94aa2650cc336955ffbeaff1b5a9

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-flutter.svg)](https://badge.fury.io/rb/fastlane-plugin-flutter)
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter)
+[![codecov](https://codecov.io/gh/dotdoom/fastlane-plugin-flutter/branch/master/graph/badge.svg)](https://codecov.io/gh/dotdoom/fastlane-plugin-flutter)
 [![Build Status](https://github.com/dotdoom/fastlane-plugin-flutter/workflows/end-to-end%20test/badge.svg?branch=master)](https://github.com/dotdoom/fastlane-plugin-flutter/actions?query=workflow%3A"end-to-end+test"+branch%3Amaster)
 
 Automated end-to-end test (download Flutter, create an app, build it) on the

data/lib/fastlane/plugin/flutter/actions/flutter_action.rb

@@ -9,7 +9,9 @@ module Fastlane
 
       def self.run(params)
         if params[:capture_stdout]
-          Helper::FlutterHelper.flutter(*params[:args]) {}
+          Helper::FlutterHelper.flutter(*params[:args]) do |status, output|
+            output
+          end
         else
           Helper::FlutterHelper.flutter(*params[:args])
         end

data/lib/fastlane/plugin/flutter/actions/flutter_bootstrap_action.rb

@@ -34,13 +34,16 @@ module Fastlane
         else
           Helper::FlutterHelper.git(
             'clone', # no --depth limit to keep Flutter tag-based versioning.
-            "--branch=#{flutter_channel || 'beta'}",
+            "--branch=#{flutter_channel || 'stable'}",
             '--quiet',
             '--',
             FLUTTER_REMOTE_REPOSITORY,
             flutter_sdk_root,
           )
         end
+
+        # Return installation path of Flutter SDK.
+        flutter_sdk_root
       end
 
       def self.need_upgrade_to_channel?(flutter_sdk_root, flutter_channel)

data/lib/fastlane/plugin/flutter/actions/flutter_build_action.rb

@@ -52,12 +52,7 @@ module Fastlane
 
         Helper::FlutterHelper.flutter('build', *build_args) do |status, res|
           if status.success?
-            if res =~ /Built (.*?)(:? \([^)]*\))?\.$/
-              lane_context[SharedValues::FLUTTER_OUTPUT] =
-                File.absolute_path($1)
-            else
-              UI.important('Cannot parse built file path from "flutter build"')
-            end
+            process_build_output(res, build_args)
             # gym (aka build_ios_app) action call may follow build; let's help
             # it identify the project, since Flutter project structure is
             # usually standard.
@@ -71,6 +66,17 @@ module Fastlane
           false
         end
 
+        # Fill in some well-known context variables so that next commands may
+        # pick them up.
+        case params[:build]
+        when 'apk'
+          lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] =
+            lane_context[SharedValues::FLUTTER_OUTPUT]
+        when 'appbundle'
+          lane_context[SharedValues::GRADLE_AAB_OUTPUT_PATH] =
+            lane_context[SharedValues::FLUTTER_OUTPUT]
+        end
+
         lane_context[SharedValues::FLUTTER_OUTPUT]
       end
 
@@ -110,6 +116,21 @@ form instead.
         end
       end
 
+      def self.process_build_output(output, build_args)
+        artifacts = output.scan(/Built (.*?)(:? \([^)]*\))?\.$/).
+                    map { |path| File.absolute_path(path[0]) }
+        if artifacts.size == 1
+          lane_context[SharedValues::FLUTTER_OUTPUT] = artifacts.first
+        elsif artifacts.size > 1
+          # Could be the result of "flutter build apk --split-per-abi".
+          lane_context[SharedValues::FLUTTER_OUTPUT] = artifacts
+        elsif build_args.include?('--config-only')
+          UI.message('Config-only "build" detected, no output file name')
+        else
+          UI.important('Cannot parse built file path from "flutter build"')
+        end
+      end
+
       def self.description
         'Run "flutter build" to build a Flutter application'
       end

data/lib/fastlane/plugin/flutter/actions/flutter_generate_action.rb

@@ -9,6 +9,13 @@ module Fastlane
     class FlutterGenerateAction < Action
       extend FlutterActionBase
 
+      # Although this file is autogenerated, we should not call it ".g.dart",
+      # because it is common for coverage configuration to exclude such files.
+      # Note that it's also common to configure Dart analyser to exclude these
+      # files from checks; this won't match, and we have to use ignore_for_file
+      # for all known lint rules that we might be breaking.
+      ALL_IMPORTS_TEST_FILE = 'test/all_imports_for_coverage_test.dart'
+
       def self.run(params)
         Helper::FlutterHelper.flutter(*%w(packages get)) {}
 
@@ -26,6 +33,38 @@ module Fastlane
           UI.message('Found build_runner dependency, running build...')
           Helper::FlutterGenerateBuildRunnerHelper.build
         end
+
+        if params[:coverage_all_imports]
+          UI.message("Generating #{ALL_IMPORTS_TEST_FILE} for coverage...")
+
+          dart_file_literals = Dir['lib/**/*.dart'].reject do |file_name|
+            # ".g.dart" files often are "part of" files and can not be imported
+            # directly. Commonly coverage for generated files is not that useful
+            file_name.end_with?('.g.dart')
+          end.map do |file_name|
+            Helper::FlutterHelper.
+              import_path_for_test(file_name, '..').
+              gsub("'", "\\\\'")
+          end
+
+          File.write(
+            ALL_IMPORTS_TEST_FILE,
+            <<-DART
+// This file is autogenerated by fastlane flutter_generate action.
+// It imports all files in lib/ so that test coverage in percentage
+// of overall project is calculated correctly. Do not modify this
+// file manually!
+
+// ignore_for_file: unused_import, directives_ordering
+// ignore_for_file: avoid_relative_lib_imports
+// ignore_for_file: lines_longer_than_80_chars
+
+#{dart_file_literals.map { |fn| "import '#{fn}';" }.sort.join("\n")}
+
+void main() {}
+            DART
+          )
+        end
       end
 
       def self.generate_translation?
@@ -33,11 +72,15 @@ module Fastlane
       end
 
       def self.description
-        "1. Run `build_runner build` if build_runner is in dev_dependencies\n" \
-        "2. According to `package:intl`, take `$strings_file` and generate " \
+        "(1) Run `flutter packages get`;  " \
+        "(2) Run `build_runner build` if build_runner is in dev_dependencies;" \
+        "   " \
+        "(3) According to `package:intl`, take `$strings_file` and generate " \
         "`${strings_file.dirname}/arb/intl_messages.arb`, then take all " \
         "files matching `${strings_file.dirname}/intl_*.arb`, fix them and " \
-        "generate .dart files from them"
+        "generate .dart files from them.  " \
+        "(4) Generate an empty test importing all files, which would be used " \
+        "to calculate correct full coverage numbers."
       end
 
       def self.available_options
@@ -62,6 +105,19 @@ module Fastlane
             description: 'Locale of the default data in the strings_file',
             optional: true,
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :coverage_all_imports,
+            env_name: 'FL_FLUTTER_COVERAGE_ALL_IMPORTS',
+            description: <<-DESCRIPTION,
+            Set to true to generate an empty test importing all .dart files in
+            lib/, which would allow calculating correct coverage numbers for the
+            whole project. NOTE: Don't forget to add
+              /#{ALL_IMPORTS_TEST_FILE}
+            to .gitignore!
+            DESCRIPTION
+            optional: true,
+            type: Boolean,
+          ),
         ]
       end
     end

data/lib/fastlane/plugin/flutter/helper/flutter_helper.rb

@@ -45,6 +45,30 @@ module Fastlane
         (YAML.load_file('pubspec.yaml')['dev_dependencies'] || {}).key?(package)
       end
 
+      def self.pub_package_name
+        YAML.load_file('pubspec.yaml')['name']
+      end
+
+      def self.import_path_for_test(file_to_import, relative_path)
+        unless file_to_import.start_with?('lib/')
+          return File.join(relative_path, file_to_import)
+        end
+
+        # Import file schema in tests have to match files in lib/ exactly. From
+        # Dart perspective, symbols in files imported via relative and
+        # "package:" file paths are different symbols.
+        package_specification = "package:#{pub_package_name}/"
+        if File.read(file_to_import, 4096).include?(package_specification)
+          # If there's a package reference in the first few bytes of the file,
+          # chances are, it's using "package:..." imports. Indeed, checking the
+          # file itself isn't sufficient to explore all of its dependencies, but
+          # we expect imports to be consistent in the project.
+          "#{package_specification}#{file_to_import['lib/'.size..-1]}"
+        else
+          File.join(relative_path, file_to_import)
+        end
+      end
+
       def self.execute(*command)
         # TODO(dotdoom): make CommandExecutor (and Actions.sh) behave similarly.
         command = command.shelljoin

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Flutter
-    VERSION = '0.3.17'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-flutter
 version: !ruby/object:Gem::Version
-  version: 0.3.17
+  version: 0.5.0
 platform: ruby
 authors:
 - Artem Sheremet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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
@@ -174,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Flutter actions plugin for Fastlane