Navaron Bracke

rename mobile scanner state enum

@@ -5,8 +5,8 @@ export 'src/enums/camera_facing.dart'; @@ -5,8 +5,8 @@ export 'src/enums/camera_facing.dart';
5 export 'src/enums/detection_speed.dart'; 5 export 'src/enums/detection_speed.dart';
6 export 'src/enums/email_type.dart'; 6 export 'src/enums/email_type.dart';
7 export 'src/enums/encryption_type.dart'; 7 export 'src/enums/encryption_type.dart';
  8 +export 'src/enums/mobile_scanner_authorization_state.dart';
8 export 'src/enums/mobile_scanner_error_code.dart'; 9 export 'src/enums/mobile_scanner_error_code.dart';
9 -export 'src/enums/mobile_scanner_state.dart';  
10 export 'src/enums/phone_type.dart'; 10 export 'src/enums/phone_type.dart';
11 export 'src/enums/torch_state.dart'; 11 export 'src/enums/torch_state.dart';
12 export 'src/mobile_scanner.dart'; 12 export 'src/mobile_scanner.dart';
1 /// The authorization state of the scanner. 1 /// The authorization state of the scanner.
2 -enum MobileScannerState { 2 +enum MobileScannerAuthorizationState {
3 /// The scanner has not yet requested the required permissions. 3 /// The scanner has not yet requested the required permissions.
4 undetermined(0), 4 undetermined(0),
5 5
@@ -9,16 +9,16 @@ enum MobileScannerState { @@ -9,16 +9,16 @@ enum MobileScannerState {
9 /// The user denied the required permissions. 9 /// The user denied the required permissions.
10 denied(2); 10 denied(2);
11 11
12 - const MobileScannerState(this.rawValue); 12 + const MobileScannerAuthorizationState(this.rawValue);
13 13
14 - factory MobileScannerState.fromRawValue(int value) { 14 + factory MobileScannerAuthorizationState.fromRawValue(int value) {
15 switch (value) { 15 switch (value) {
16 case 0: 16 case 0:
17 - return MobileScannerState.undetermined; 17 + return MobileScannerAuthorizationState.undetermined;
18 case 1: 18 case 1:
19 - return MobileScannerState.authorized; 19 + return MobileScannerAuthorizationState.authorized;
20 case 2: 20 case 2:
21 - return MobileScannerState.denied; 21 + return MobileScannerAuthorizationState.denied;
22 default: 22 default:
23 throw ArgumentError.value(value, 'value', 'Invalid raw value.'); 23 throw ArgumentError.value(value, 'value', 'Invalid raw value.');
24 } 24 }
@@ -4,8 +4,8 @@ import 'dart:io'; @@ -4,8 +4,8 @@ import 'dart:io';
4 import 'package:flutter/services.dart'; 4 import 'package:flutter/services.dart';
5 import 'package:flutter/widgets.dart'; 5 import 'package:flutter/widgets.dart';
6 import 'package:mobile_scanner/src/enums/barcode_format.dart'; 6 import 'package:mobile_scanner/src/enums/barcode_format.dart';
  7 +import 'package:mobile_scanner/src/enums/mobile_scanner_authorization_state.dart';
7 import 'package:mobile_scanner/src/enums/mobile_scanner_error_code.dart'; 8 import 'package:mobile_scanner/src/enums/mobile_scanner_error_code.dart';
8 -import 'package:mobile_scanner/src/enums/mobile_scanner_state.dart';  
9 import 'package:mobile_scanner/src/enums/torch_state.dart'; 9 import 'package:mobile_scanner/src/enums/torch_state.dart';
10 import 'package:mobile_scanner/src/mobile_scanner_exception.dart'; 10 import 'package:mobile_scanner/src/mobile_scanner_exception.dart';
11 import 'package:mobile_scanner/src/mobile_scanner_platform_interface.dart'; 11 import 'package:mobile_scanner/src/mobile_scanner_platform_interface.dart';
@@ -92,10 +92,10 @@ class MethodChannelMobileScanner extends MobileScannerPlatform { @@ -92,10 +92,10 @@ class MethodChannelMobileScanner extends MobileScannerPlatform {
92 /// 92 ///
93 /// Throws a [MobileScannerException] if the permission is not granted. 93 /// Throws a [MobileScannerException] if the permission is not granted.
94 Future<void> _requestCameraPermission() async { 94 Future<void> _requestCameraPermission() async {
95 - final MobileScannerState authorizationState; 95 + final MobileScannerAuthorizationState authorizationState;
96 96
97 try { 97 try {
98 - authorizationState = MobileScannerState.fromRawValue( 98 + authorizationState = MobileScannerAuthorizationState.fromRawValue(
99 await methodChannel.invokeMethod<int>('state') ?? 0, 99 await methodChannel.invokeMethod<int>('state') ?? 0,
100 ); 100 );
101 } on PlatformException catch (error) { 101 } on PlatformException catch (error) {
@@ -111,13 +111,13 @@ class MethodChannelMobileScanner extends MobileScannerPlatform { @@ -111,13 +111,13 @@ class MethodChannelMobileScanner extends MobileScannerPlatform {
111 } 111 }
112 112
113 switch (authorizationState) { 113 switch (authorizationState) {
114 - case MobileScannerState.denied: 114 + case MobileScannerAuthorizationState.denied:
115 throw const MobileScannerException( 115 throw const MobileScannerException(
116 errorCode: MobileScannerErrorCode.permissionDenied, 116 errorCode: MobileScannerErrorCode.permissionDenied,
117 ); 117 );
118 - case MobileScannerState.authorized: 118 + case MobileScannerAuthorizationState.authorized:
119 return; // Already authorized. 119 return; // Already authorized.
120 - case MobileScannerState.undetermined: 120 + case MobileScannerAuthorizationState.undetermined:
121 try { 121 try {
122 final bool permissionResult = await methodChannel.invokeMethod<bool>('request') ?? false; 122 final bool permissionResult = await methodChannel.invokeMethod<bool>('request') ?? false;
123 123
1 import 'package:flutter_test/flutter_test.dart'; 1 import 'package:flutter_test/flutter_test.dart';
2 -import 'package:mobile_scanner/src/enums/mobile_scanner_state.dart'; 2 +import 'package:mobile_scanner/src/enums/mobile_scanner_authorization_state.dart';
3 3
4 void main() { 4 void main() {
5 - group('$MobileScannerState tests', () { 5 + group('$MobileScannerAuthorizationState tests', () {
6 test('can be created from raw value', () { 6 test('can be created from raw value', () {
7 const values = { 7 const values = {
8 - 0: MobileScannerState.undetermined,  
9 - 1: MobileScannerState.authorized,  
10 - 2: MobileScannerState.denied, 8 + 0: MobileScannerAuthorizationState.undetermined,
  9 + 1: MobileScannerAuthorizationState.authorized,
  10 + 2: MobileScannerAuthorizationState.denied,
11 }; 11 };
12 12
13 - for (final MapEntry<int, MobileScannerState> entry in values.entries) {  
14 - final MobileScannerState result = MobileScannerState.fromRawValue( 13 + for (final MapEntry<int, MobileScannerAuthorizationState> entry in values.entries) {
  14 + final MobileScannerAuthorizationState result = MobileScannerAuthorizationState.fromRawValue(
15 entry.key, 15 entry.key,
16 ); 16 );
17 17
@@ -24,23 +24,23 @@ void main() { @@ -24,23 +24,23 @@ void main() {
24 const int outOfRange = 3; 24 const int outOfRange = 3;
25 25
26 expect( 26 expect(
27 - () => MobileScannerState.fromRawValue(negative), 27 + () => MobileScannerAuthorizationState.fromRawValue(negative),
28 throwsArgumentError, 28 throwsArgumentError,
29 ); 29 );
30 expect( 30 expect(
31 - () => MobileScannerState.fromRawValue(outOfRange), 31 + () => MobileScannerAuthorizationState.fromRawValue(outOfRange),
32 throwsArgumentError, 32 throwsArgumentError,
33 ); 33 );
34 }); 34 });
35 35
36 test('can be converted to raw value', () { 36 test('can be converted to raw value', () {
37 - const values = <MobileScannerState, int>{  
38 - MobileScannerState.undetermined: 0,  
39 - MobileScannerState.authorized: 1,  
40 - MobileScannerState.denied: 2, 37 + const values = <MobileScannerAuthorizationState, int>{
  38 + MobileScannerAuthorizationState.undetermined: 0,
  39 + MobileScannerAuthorizationState.authorized: 1,
  40 + MobileScannerAuthorizationState.denied: 2,
41 }; 41 };
42 42
43 - for (final MapEntry<MobileScannerState, int> entry in values.entries) { 43 + for (final MapEntry<MobileScannerAuthorizationState, int> entry in values.entries) {
44 final int result = entry.key.rawValue; 44 final int result = entry.key.rawValue;
45 45
46 expect(result, entry.value); 46 expect(result, entry.value);