global_configuration 1.4.0

Flutter Global Configuration #

A flutter package for managing different configurations by merging them together and making them available everythere inside the app via a singleton.

Table of Contents #

  1. Preamble
  2. Install
  3. Import
  4. Loading configuration
  5. Using the configuration in your app
  6. Overriding configuration
  7. Full Example
  8. Changelog
  9. Copyright and license

Preamble #

This package is also part of the EZ Flutter Framework.

Install #

pubspec.yaml #

Update pubspec.yaml and add the following line to your dependencies.

dependencies:
  global_configuration: ^1.4.0

Import #

Import the package with :

import 'package:global_configuration/global_configuration.dart';

Loading configuration #

There are many ways where you can store your configuration files and load them.

Load from asset #

Creating a configuration file inside assets/cfg folder #

Create a .json file and place it under assets/cfg/ Example filename: assets/cfg/app_settings.json

{
  "key1": "value1",
  "key2": "value2"
}

Remember to update your pubspec.yaml file, so the config can be loaded from the assets directory! The config files must be placed under the assets/cfg/ directory.

flutter:
 assets:
  - assets/cfg/

Load configuration from assets at app start #

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';

void main() async{
  await GlobalConfiguration().loadFromAsset("app_settings");
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  ...
}

Load from path #

Creating a configuration file anywhere #

Create a file anywhere inside your app.

Load configuration fro path at app start #

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';

void main(){
  GlobalConfiguration().loadFromPath("/path/file.json");
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  ...
}

Load from path into key #

The same as loadFromPath, but the config is added under the given key.

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';

void main(){
  GlobalConfiguration().loadFromPathIntoKey("/path/file.json", "env_settings");
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  ...
}

Load from map #

Creating a configuration inside .dart file #

Create a dart file which includes your configuration and import it in your main file. Example filename: /config/app_settings.config.dart

final Map<String, String> appSettings = {
  "key1": "value1",
  "key2": "value2"
};

Load configuration from map at app start #

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
import 'config/Config1.config.dart';

void main(){
  GlobalConfiguration().loadFromMap(appSettings);
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  ...
}

Load from url #

It is possible to load any json configuration file from a url. Use the method loadFromUrl to load the config via GET request. Please consider using a try / catch. This method will throw an exception if the status code of the GET request is not 200.

The method also accepts query parameters and headers! The header "Accept: application/json" is always included.

Load configuration from url at app start #

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';

void main() async{
  try{
    await GlobalConfiguration().loadFromUrl("http://urlToMyConfig.com");
  }catch(e){
    // something went wrong while fetching the config from the url ... do something
  }
  runApp(MyApp());
}
class MyApp extends StatelessWidget {
  ...
}

Using the configuration in your app #

Instatiate the GlobalConfiguration class and call any get($key) method.

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';

class CustomWidget extends StatelessWidget {

    CustomWiget(){
        // Access the config in the constructor
        print(GlobalConfiguration().getString("key1"); // prints value1
    }

    @override
     Widget build(BuildContext context) {
        // Access the config in the build method
        return Text(GlobalConfiguration().getString("key2")); // prints value2
     }
}

Overriding configuration #

Sometimes it is necessary to override data in the configuration. This can be done by the setValue method. This method makes a check for the given type of the value and then performs an update the configuration map.

  Map<String, String> appSettings = {
    "key1": "value1",
    "key2": 1
  };
  GlobalConfiguration().loadFromMap(appSettings); // loading the configuration
  print(GlobalConfiguration().getString("key1")); // output : value1
  print(GlobalConfiguration().getString("key2")); // output : 1
  GlobalConfiguration().updateValue("key1", "value2"); // update the value for key1
  GlobalConfiguration().updateValue("key2", 2); // update the value for key2
  print(GlobalConfiguration().getString("key1")); // output : value2
  print(GlobalConfiguration().getString("key2")); // output : 2

Full example #

You can find a full example in the example folder.

Changelog #

For a detailed changelog, see the CHANGELOG.md file

MIT License

Copyright (c) 2019 Ephenodrom

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.

Changelog #

[1.4.0] - 2019-09-16

  • Add new method updateValue(), that replaces setValue()
  • Add new method addValue()
  • Add new method clear()
  • Add new Unit tests
  • Update documentation

[1.3.0] - 2019-08-20

  • Add new method loadFromUrlIntoKey

[1.2.0] - 2019-07-25

  • Add new method loadFromPathIntoKey

[1.1.0] - 2019-06-17

  • Fix bug in setValue and improve usage of setValue method

[1.0.0] - 2019-06-01

  • Add new method loadFromPath

[0.1.4] - 2018-12-17

  • Add new method setValue

[0.1.3] - 2018-12-09

  • Add new method loadFromUrl

[0.1.2] - 2018-11-26

  • Improve README.md

[0.1.1] - 2018-11-25

  • Add loading file from asset folder

[0.1.0] - 2018-11-25

  • Add example folder

[0.0.2] - 2018-11-25

  • Fill README.md with content and examples

[0.0.1] - 2018-11-25

  • Initial release

example/main.dart

import 'package:flutter/material.dart';
import 'package:global_configuration/global_configuration.dart';
import 'AppSettings.config.dart';
import 'DevSettings.config.dart';

void main() async {
  GlobalConfiguration().loadFromMap(appSettings).loadFromMap(devSettings);
  await GlobalConfiguration().loadFromUrl("https://swapi.co/api/people/1");
  runApp(MyApp());
}

class MyApp extends StatelessWidget {

  MyApp(){
    // Access configuration at constructor
    GlobalConfiguration cfg = new GlobalConfiguration();
    print("Key1 has value ${cfg.getString("key1")}");
    print("Key2 has value ${GlobalConfiguration().getString("key2")}");
    print("Key5 has value ${cfg.getString("key5")}, this should be null!");
  }

  @override
  Widget build(BuildContext context) {
    // Access configuration at build method
    GlobalConfiguration cfg = new GlobalConfiguration();
    print("Key3 has value ${cfg.getString("key3")}");
    return MaterialApp(
      title: 'Welcome to Flutter',
      home: Scaffold(
        appBar: AppBar(
          title: Text('Welcome to Flutter'),
        ),
        body: Center(
          child: Text('Hello World'),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  global_configuration: ^1.4.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:global_configuration/global_configuration.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
94
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
97
Learn more about scoring.

We analyzed this package on Sep 20, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.2

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
http ^0.12.0 0.12.0+2
Transitive dependencies
async 2.3.0
charcode 1.1.2
collection 1.14.11 1.14.12
http_parser 3.1.3
meta 1.1.7
path 1.6.4
pedantic 1.8.0+1
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test