Make results classes fields non-nullable (#4)

* Make all RollResult/RollStatistics fields required

* Move files to src, to import it once as library

* Use pedantic

* Update examples

* Bump version

Author: comigor

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 0.3.0
+- Make some results fields non-nullable, 💅 to analysis_options.
+
 ## 0.2.0-nullsafety.0
 - Migrate to nullsafety.
 

README.md

@@ -4,15 +4,33 @@
 </p>
 
 <!-- Badges -->
+[![View at pub.dev][pub-badge]][pub-link]
+[![Test][actions-badge]][actions-link]
+[![PRs Welcome][prs-badge]][prs-link]
+[![Star on GitHub][github-star-badge]][github-star-link]
+[![Fork on GitHub][github-forks-badge]][github-forks-link]
 
-[![Pub Package](https://img.shields.io/pub/v/d20.svg)](https://pub.dartlang.org/packages/d20)
-[![CircleCI](https://circleci.com/gh/Igor1201/d20/tree/master.svg?style=svg&circle-token=376c1d43be17c8602903dfc02368f711ea1a4ed6)](https://circleci.com/gh/Igor1201/d20/tree/master)
+[pub-badge]: https://img.shields.io/pub/v/d20?style=for-the-badge
+[pub-link]: https://pub.dev/packages/d20
+
+[actions-badge]: https://img.shields.io/github/workflow/status/comigor/d20/CI?style=for-the-badge
+[actions-link]: https://github.com/comigor/d20/actions
+
+[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
+[prs-link]: https://github.com/comigor/d20/issues
+
+[github-star-badge]: https://img.shields.io/github/stars/comigor/d20.svg?style=for-the-badge&logo=github&logoColor=ffffff
+[github-star-link]: https://github.com/comigor/d20/stargazers
+
+[github-forks-badge]: https://img.shields.io/github/forks/comigor/d20.svg?style=for-the-badge&logo=github&logoColor=ffffff
+[github-forks-link]: https://github.com/comigor/d20/network/members
 
 D20 is a Dart library for RPG dice rolling. Supports standard notation (like "2d12", "d6+5" and "2d20-L").
 
 ## Installation
-add the following to your `pubspec.yaml` file:
-```shell
+
+Add the following to your `pubspec.yaml` file:
+```yaml
 dependencies:
   d20: <1.0.0
 ```
@@ -31,7 +49,7 @@ flutter packages get
 import 'package:d20/d20.dart';
 
 void main() {
-  final D20 d20 = D20();
+  final d20 = D20();
   print(d20.roll('2d8+5+5d6'));
 }
 
@@ -40,18 +58,16 @@ void main() {
 One can also get (probably) useful information of roll results:
 ```dart
 import 'package:d20/d20.dart';
-import 'package:d20/roll_statistics.dart';
 
 void main() {
-  final D20 d20 = D20();
-  final RollStatistics stats = d20.rollWithStatistics('2d8+5+5d6');
+  final d20 = D20();
+  final stats = d20.rollWithStatistics('2d8+5+5d6');
   print(stats.results[0].faces);
   print(stats.results[1].results);
 }
 
 ```
 
-
 ## Supported notation
 The [standard dice notation](https://en.wikipedia.org/wiki/Dice_notation) will be parsed, such as 2d8+4.
 

analysis_options.yaml

@@ -1,136 +1,10 @@
 # https://www.dartlang.org/guides/language/analysis-options
-# Source of linter options:
-# http://dart-lang.github.io/linter/lints/options/options.html
+
+include: package:pedantic/analysis_options.yaml
+
 analyzer:
   strong-mode:
     implicit-casts: false
-  errors:
-    todo: ignore
-    unused_element: error
-    unused_import: error
-    unused_local_variable: error
-    dead_code: error
-linter:
-  rules:
-    - always_declare_return_types
-    - always_put_control_body_on_new_line
-    - always_put_required_named_parameters_first
-    - always_require_non_null_named_parameters
-    - always_specify_types
-    - annotate_overrides
-    - avoid_annotating_with_dynamic
-    - avoid_as
-    - avoid_bool_literals_in_conditional_expressions
-    - avoid_catches_without_on_clauses
-    - avoid_catching_errors
-    - avoid_classes_with_only_static_members
-    - avoid_double_and_int_checks
-    - avoid_empty_else
-    - avoid_field_initializers_in_const_classes
-    - avoid_function_literals_in_foreach_calls
-    - avoid_init_to_null
-    - avoid_js_rounded_ints
-    - avoid_null_checks_in_equality_operators
-    - avoid_positional_boolean_parameters
-    - avoid_private_typedef_functions
-    - avoid_relative_lib_imports
-    - avoid_renaming_method_parameters
-    - avoid_return_types_on_setters
-    - avoid_returning_null
-    - avoid_returning_this
-    - avoid_setters_without_getters
-    - avoid_single_cascade_in_expression_statements
-    - avoid_slow_async_io
-    - avoid_types_as_parameter_names
-    # - avoid_types_on_closure_parameters
-    - avoid_unused_constructor_parameters
-    - await_only_futures
-    - camel_case_types
-    - cancel_subscriptions
-    - cascade_invocations
-    - close_sinks
-    - comment_references
-    - constant_identifier_names
-    - control_flow_in_finally
-    - curly_braces_in_flow_control_structures
-    - directives_ordering
-    - empty_catches
-    - empty_constructor_bodies
-    - empty_statements
-    - file_names
-    - hash_and_equals
-    - implementation_imports
-    - invariant_booleans
-    - iterable_contains_unrelated_type
-    - join_return_with_assignment
-    - library_names
-    - library_prefixes
-    - lines_longer_than_80_chars
-    - list_remove_unrelated_type
-    - literal_only_boolean_expressions
-    - no_adjacent_strings_in_list
-    - no_duplicate_case_values
-    - non_constant_identifier_names
-    - null_closures
-    # - omit_local_variable_types
-    - one_member_abstracts
-    - only_throw_errors
-    - overridden_fields
-    - package_api_docs
-    - package_names
-    - package_prefixed_library_names
-    - parameter_assignments
-    - prefer_adjacent_string_concatenation
-    - prefer_asserts_in_initializer_lists
-    # - prefer_bool_in_asserts
-    - prefer_collection_literals
-    - prefer_conditional_assignment
-    - prefer_const_constructors
-    - prefer_const_constructors_in_immutables
-    - prefer_const_declarations
-    - prefer_const_literals_to_create_immutables
-    - prefer_constructors_over_static_methods
-    - prefer_contains
-    - prefer_equal_for_default_values
-    - prefer_expression_function_bodies
-    - prefer_final_fields
-    - prefer_final_locals
-    - prefer_foreach
-    - prefer_function_declarations_over_variables
-    - prefer_generic_function_type_aliases
-    - prefer_initializing_formals
-    - prefer_interpolation_to_compose_strings
-    - prefer_is_empty
-    - prefer_is_not_empty
-    - prefer_iterable_whereType
-    - prefer_single_quotes
-    - prefer_typing_uninitialized_variables
-    - public_member_api_docs
-    - recursive_getters
-    - slash_for_doc_comments
-    - sort_constructors_first
-    - sort_unnamed_constructors_first
-    # - super_goes_last
-    - test_types_in_equals
-    - throw_in_finally
-    - type_annotate_public_apis
-    - type_init_formals
-    - unawaited_futures
-    - unnecessary_brace_in_string_interps
-    - unnecessary_const
-    - unnecessary_getters_setters
-    - unnecessary_lambdas
-    - unnecessary_new
-    - unnecessary_null_aware_assignments
-    - unnecessary_null_in_if_null_operators
-    - unnecessary_overrides
-    - unnecessary_parenthesis
-    - unnecessary_statements
-    - unnecessary_this
-    - unrelated_type_equality_checks
-    - use_rethrow_when_possible
-    - use_setters_to_change_properties
-    - use_string_buffers
-    - use_to_and_as_if_applicable
-    - valid_regexps
-    - void_checks
+  exclude:
+    - example/**/*.dart
+    - test/**/*.dart

example/main.dart

@@ -1,6 +1,6 @@
 import 'package:d20/d20.dart';
 
 void main() {
-  final D20 d20 = D20();
+  final d20 = D20();
   print(d20.roll('2d8+5+5d6'));
 }

example/main_statistics.dart

@@ -1,9 +1,8 @@
 import 'package:d20/d20.dart';
-import 'package:d20/roll_statistics.dart';
 
 void main() {
-  final D20 d20 = D20();
-  final RollStatistics stats = d20.rollWithStatistics('2d8+5+5d6');
-  print(stats.results![0].faces);
-  print(stats.results![1].results);
+  final d20 = D20();
+  final stats = d20.rollWithStatistics('2d8+5+5d6');
+  print(stats.results[0].faces);
+  print(stats.results[1].results);
 }

lib/d20.dart

@@ -1,120 +1,3 @@
-/// Dart library for RPG dice rolling.
-///
-/// Import this library as follows:
-///
-/// ```
-/// import 'package:d20/d20.dart';
-/// ```
-
-import 'dart:math';
-import 'package:math_expressions/math_expressions.dart';
-import 'roll_result.dart';
-import 'roll_statistics.dart';
-
-/// An expression-capable dice roller.
-///
-/// Simple usage:
-/// ```
-///   final D20 d20 = D20();
-///   d20.roll('2d6+3');
-/// ```
-///
-/// See also [rollWithStatistics], [RollStatistics] and [RollResult].
-class D20 {
-  /// Creates a dice roller.
-  ///
-  /// Optionally receives a [Random].
-  D20({Random? random}) {
-    _random = random == null ? Random() : random;
-  }
-
-  final Parser _parser = Parser();
-  final ContextModel _context = ContextModel();
-
-  /// A [Random] instance that can be customized for seeding.
-  late Random _random;
-
-  RollResult _rollSingleDie(Match match) {
-    final int numberOfRolls = match[1] == null ? 1 : int.parse(match[1]!);
-    final int faces = int.parse(match[2]!);
-    final List<int> results = List<int>.filled(numberOfRolls, faces)
-        .map((int die) => _random.nextInt(die) + 1)
-        .toList();
-
-    int sum = results.fold(0, (int sum, int roll) => sum + roll);
-
-    if (match[3] == '-l') {
-      sum -= results.fold<int>(faces, min);
-    } else if (match[3] == '-h') {
-      sum -= results.fold<int>(0, max);
-    }
-
-    return RollResult(
-      rollNotation: match[0],
-      faces: faces,
-      numberOfRolls: numberOfRolls,
-      results: results,
-      finalResult: sum,
-    );
-  }
-
-  String _sanitizeStringNotation(String dirty) => dirty
-      .toLowerCase()
-      .replaceAll(RegExp(r'\s'), '')
-      .replaceAll(RegExp(r'd%'), 'd100');
-
-  /// Compute and return a [RollStatistics] with all information from a roll,
-  /// including the result from each individual dice roll within.
-  ///
-  /// See [RollStatistics] and [RollResult] for more info.
-  RollStatistics rollWithStatistics(String roll) {
-    final String sanitizedRoll = _sanitizeStringNotation(roll);
-
-    final Iterable<Match> matches =
-        RegExp(r'(\d+)?d(\d+)(-[l|h])?').allMatches(sanitizedRoll);
-
-    String newRoll = sanitizedRoll;
-    final List<RollResult> results = <RollResult>[];
-
-    for (int i = matches.length - 1; i >= 0; i--) {
-      final RollResult result = _rollSingleDie(matches.elementAt(i));
-      results.add(result);
-      newRoll = newRoll.replaceRange(matches.elementAt(i).start,
-          matches.elementAt(i).end, result.finalResult.toString());
-    }
-
-    final double exactResult = _parser
-        .parse(newRoll)
-        // ignore: avoid_as
-        .evaluate(EvaluationType.REAL, _context) as double;
-
-    return RollStatistics(
-      rollNotation: sanitizedRoll,
-      results: results,
-      finalResult: exactResult.round(),
-    );
-  }
-
-  /// Compute an arithmetic expression from a roll defined on standard notation
-  /// format.
-  ///
-  /// Example:
-  /// ```
-  ///   d20.roll('2d6+3');
-  ///   d20.roll('2d20-L');
-  ///   d20.roll('d% * 8');
-  ///   d20.roll('cos(2 * 5d20)');
-  /// ```
-  int roll(String roll) {
-    final String newRoll = _sanitizeStringNotation(roll).replaceAllMapped(
-        RegExp(r'(\d+)?d(\d+)(-[l|h])?'),
-        (Match m) => _rollSingleDie(m).finalResult.toString());
-
-    final double exactResult = _parser
-        .parse(newRoll)
-        // ignore: avoid_as
-        .evaluate(EvaluationType.REAL, _context) as double;
-
-    return exactResult.round();
-  }
-}
+export 'src/d20.dart';
+export 'src/roll_result.dart';
+export 'src/roll_statistics.dart';