https://github.com/menny/frankenrobot

A simple injection library for Android. Uses the Android resources qualification mechanism to create concrete instances.
https://github.com/menny/frankenrobot

Last synced: about 7 hours ago
JSON representation

A simple injection library for Android. Uses the Android resources qualification mechanism to create concrete instances.

• Host: GitHub
• URL: https://github.com/menny/frankenrobot
• Owner: menny
• Created: 2012-12-26T13:01:31.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2015-09-04T08:59:13.000Z (about 9 years ago)
• Last Synced: 2024-05-01T19:16:47.238Z (7 months ago)
• Language: Java
• Size: 293 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#FrankenRobot#

[![Build Status](https://api.shippable.com/projects/540f735a21c97efdb898a1ae/badge?branchName=master)](https://app.shippable.com/projects/540f735a21c97efdb898a1ae/builds/latest)

A simple injection library for Android: uses [Android resources qualification mechanism](http://developer.android.com/guide/topics/resources/providing-resources.html#table2) to map interfaces to concrete implementations.


FrankenRobot takes two _string-array_ resources; one of canonical interface names, and the second of canonical concrete implementations.


You can specify a different implementation for every imaginable resource qualifier (be it API level, screen-size, locale, etc.), and FrankenRobot will instantize the most appropriate implementation using Android's resource qualifier mechanism.

##How To Use##

### Dependency ###

I'm using [![JitPack](https://img.shields.io/github/release/menny/FrankenRobot.svg?label=JitPack)](https://jitpack.io/#menny/FrankenRobot) to publish this library.

Add it in your build.gradle at the end of repositories:

```

repositories {

    //...

    maven { url "https://jitpack.io" }

}

```

Step 2. Add the dependency in the form

```

dependencies {

    compile 'com.github.menny:FrankenRobot:1.1.5'

}

```

### Usage ###

This is how [AnySoftKeyboard](https://github.com/AnySoftKeyboard/AnySoftKeyboard) uses FrankenRobot:

Create two _string-array_ resources in the _res/values_ folder (say, in a designated _frankenrobot.xml_ file):


One for the interfaces definition

    

        com.anysoftkeyboard.devicespecific.DeviceSpecific

    

And another _string-array_ resource for the concrete implementations

    

        @string/frankenrobot_device_specific_implementation

    

Specify the concrete implementation class name, first in the _res/values_ folder:

    com.anysoftkeyboard.devicespecific.DeviceSpecific_V3

Where special implemenations are needed:


In the _res/values-v5_ folder:

    com.anysoftkeyboard.devicespecific.DeviceSpecific_V5

In the _res/values-v7_ folder:

    com.anysoftkeyboard.devicespecific.DeviceSpecific_V7

Etc.


Initialize FrankenRobot, and embody the interface

    FrankenRobot frank = Lab.build(getApplicationContext(),

            R.array.frankenrobot_interfaces,

            R.array.frankenrobot_concreate_classes);

    //using a diagram to create the monster

    DeviceSpecific deviceSpecific = frank.embody(new FrankenRobot.Diagram(){});

It is guaranteed that the returned instance is the most suitable, based on the qualifier rules.


_AnySoftKeyboard_ achives impressive backword compatibility using this method, using API-level-bound implementations, with no complex coding, and no reflection.