Prepare 3.1.0 release

This is a binary-compatible change that changes the underlying semantics to use a Call.Factory rather than OkHttpClient directly. This allows for a few benefits:

- Not tightly coupled to OkHttpClient
- Allows for lazy/delegating/deferred initialization
- Matches other OkHttpClient-dependent libraries' APIs, namely Retrofit and Apollo GraphQL

.travis.yml

@@ -1,5 +1,6 @@
 # https://docs.travis-ci.com/user/languages/android/
 language: android
+dist: trusty
 jdk: openjdk8
 sudo: false
 

gradle.properties

@@ -6,7 +6,7 @@ org.gradle.configureondemand=true
 android.enableBuildCache=true
 android.buildCacheDir=build/pre-dex-cache
 
-VERSION_NAME=3.0.1
+VERSION_NAME=3.1.0
 
 GROUP=ru.noties.markwon
 POM_DESCRIPTION=Markwon markdown for Android

markwon-core/src/main/java/ru/noties/markwon/image/AsyncDrawable.java

@@ -32,7 +32,7 @@ public class AsyncDrawable extends Drawable {
     public AsyncDrawable(
             @NonNull String destination,
             @NonNull AsyncDrawableLoader loader,
-            @Nullable ImageSizeResolver imageSizeResolver,
+            @NonNull ImageSizeResolver imageSizeResolver,
             @Nullable ImageSize imageSize
     ) {
         this.destination = destination;
@@ -51,6 +51,45 @@ public class AsyncDrawable extends Drawable {
         return destination;
     }
 
+    /**
+     * @since 3.1.0
+     */
+    @Nullable
+    public ImageSize getImageSize() {
+        return imageSize;
+    }
+
+    /**
+     * @since 3.1.0
+     */
+    @NonNull
+    public ImageSizeResolver getImageSizeResolver() {
+        return imageSizeResolver;
+    }
+
+    /**
+     * @since 3.1.0
+     */
+    public boolean hasKnownDimentions() {
+        return canvasWidth > 0;
+    }
+
+    /**
+     * @see #hasKnownDimentions()
+     * @since 3.1.0
+     */
+    public int getLastKnownCanvasWidth() {
+        return canvasWidth;
+    }
+
+    /**
+     * @see #hasKnownDimentions()
+     * @since 3.1.0
+     */
+    public float getLastKnowTextSize() {
+        return textSize;
+    }
+
     public Drawable getResult() {
         return result;
     }
@@ -80,7 +119,7 @@ public class AsyncDrawable extends Drawable {
                 result.setCallback(callback);
             }
 
-            loader.load(destination, this);
+            loader.load(this);
         } else {
             if (result != null) {
 
@@ -91,7 +130,7 @@ public class AsyncDrawable extends Drawable {
                     ((Animatable) result).stop();
                 }
             }
-            loader.cancel(destination);
+            loader.cancel(this);
         }
     }
 

markwon-core/src/main/java/ru/noties/markwon/image/AsyncDrawableLoader.java

@@ -3,6 +3,7 @@ package ru.noties.markwon.image;
 import android.graphics.drawable.Drawable;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.util.Log;
 
 import java.util.Collection;
 import java.util.HashMap;
@@ -36,10 +37,37 @@ public abstract class AsyncDrawableLoader {
         return new AsyncDrawableLoaderNoOp();
     }
 
+    /**
+     * @since 3.1.0
+     */
+    public abstract void load(@NonNull AsyncDrawable drawable);
 
-    public abstract void load(@NonNull String destination, @NonNull AsyncDrawable drawable);
+    /**
+     * @since 3.1.0
+     */
+    public abstract void cancel(@NonNull AsyncDrawable drawable);
 
-    public abstract void cancel(@NonNull String destination);
+    /**
+     * @see #load(AsyncDrawable)
+     * @deprecated 3.1.0
+     */
+    @Deprecated
+    public void load(@NonNull String destination, @NonNull AsyncDrawable drawable) {
+        load(drawable);
+    }
+
+    /**
+     * Method is deprecated because cancellation won\'t work for markdown input
+     * with multiple images with the same source
+     *
+     * @deprecated 3.1.0
+     */
+    @Deprecated
+    public void cancel(@NonNull String destination) {
+        Log.e("MARKWON-IL", "Image loading cancellation must be triggered " +
+                "by AsyncDrawable, please use #cancel(AsyncDrawable) method instead. " +
+                "No op, nothing is cancelled for destination: " + destination);
+    }
 
     @Nullable
     public abstract Drawable placeholder();

markwon-core/src/main/java/ru/noties/markwon/image/AsyncDrawableLoaderImpl.java

@@ -4,12 +4,12 @@ import android.graphics.drawable.Drawable;
 import android.net.Uri;
 import android.os.Handler;
 import android.os.Looper;
+import android.os.SystemClock;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.lang.ref.WeakReference;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.ExecutorService;
@@ -23,10 +23,12 @@ class AsyncDrawableLoaderImpl extends AsyncDrawableLoader {
     private final MediaDecoder defaultMediaDecoder;
     private final DrawableProvider placeholderDrawableProvider;
     private final DrawableProvider errorDrawableProvider;
+    private final Handler handler = new Handler(Looper.getMainLooper());
 
-    private final Handler mainThread;
 
-    private final Map<String, Future<?>> requests = new HashMap<>(2);
+    // @since 3.1.0 use a hash-map with an AsyncDrawable (allows multiple drawables
+    // referencing the same source)
+    private final Map<AsyncDrawable, Future<?>> requests = new HashMap<>(2);
 
     AsyncDrawableLoaderImpl(@NonNull Builder builder) {
         this.executorService = builder.executorService;
@@ -35,21 +37,25 @@ class AsyncDrawableLoaderImpl extends AsyncDrawableLoader {
         this.defaultMediaDecoder = builder.defaultMediaDecoder;
         this.placeholderDrawableProvider = builder.placeholderDrawableProvider;
         this.errorDrawableProvider = builder.errorDrawableProvider;
-        this.mainThread = new Handler(Looper.getMainLooper());
     }
 
     @Override
-    public void load(@NonNull String destination, @NonNull AsyncDrawable drawable) {
-        // if drawable is not a link -> show loading placeholder...
-        requests.put(destination, execute(destination, drawable));
+    public void load(@NonNull final AsyncDrawable drawable) {
+        final Future<?> future = requests.get(drawable);
+        if (future == null) {
+            requests.put(drawable, execute(drawable));
+        }
     }
 
     @Override
-    public void cancel(@NonNull String destination) {
-        final Future<?> request = requests.remove(destination);
-        if (request != null) {
-            request.cancel(true);
+    public void cancel(@NonNull final AsyncDrawable drawable) {
+
+        final Future<?> future = requests.remove(drawable);
+        if (future != null) {
+            future.cancel(true);
         }
+
+        handler.removeCallbacksAndMessages(drawable);
     }
 
     @Nullable
@@ -60,20 +66,10 @@ class AsyncDrawableLoaderImpl extends AsyncDrawableLoader {
                 : null;
     }
 
-    private Future<?> execute(@NonNull final String destination, @NonNull AsyncDrawable drawable) {
+    @NonNull
+    private Future<?> execute(@NonNull final AsyncDrawable drawable) {
 
-        final WeakReference<AsyncDrawable> reference = new WeakReference<AsyncDrawable>(drawable);
-
-        // todo: should we cancel pending request for the same destination?
-        //      we _could_ but there is possibility that one resource is request in multiple places
-
-        // todo: error handing (simply applying errorDrawable is not a good solution
-        //      as reason for an error is unclear (no scheme handler, no input data, error decoding, etc)
-
-        // todo: more efficient ImageMediaDecoder... BitmapFactory.decodeStream is a bit not optimal
-        //      for big images for sure. We _could_ introduce internal Drawable that will check for
-        //      image bounds (but we will need to cache inputStream in order to inspect and optimize
-        //      input image...)
+        final String destination = drawable.getDestination();
 
         return executorService.submit(new Runnable() {
             @Override
@@ -125,23 +121,18 @@ class AsyncDrawableLoaderImpl extends AsyncDrawableLoader {
                             : null;
                 }
 
-                if (result != null) {
                 final Drawable out = result;
-                    mainThread.post(new Runnable() {
+
+                handler.postAtTime(new Runnable() {
                     @Override
                     public void run() {
-                            final boolean canDeliver = requests.remove(destination) != null;
-                            if (canDeliver) {
-                                final AsyncDrawable asyncDrawable = reference.get();
-                                if (asyncDrawable != null && asyncDrawable.isAttached()) {
-                                    asyncDrawable.setResult(out);
+                        if (requests.remove(drawable) != null) {
+                            if (out != null && drawable.isAttached()) {
+                                drawable.setResult(out);
                             }
                         }
                     }
-                    });
-                } else {
-                    requests.remove(destination);
-                }
+                }, drawable, SystemClock.uptimeMillis());
             }
         });
     }

markwon-core/src/main/java/ru/noties/markwon/image/AsyncDrawableLoaderNoOp.java

@@ -6,12 +6,12 @@ import android.support.annotation.Nullable;
 
 class AsyncDrawableLoaderNoOp extends AsyncDrawableLoader {
     @Override
-    public void load(@NonNull String destination, @NonNull AsyncDrawable drawable) {
+    public void load(@NonNull AsyncDrawable drawable) {
 
     }
 
     @Override
-    public void cancel(@NonNull String destination) {
+    public void cancel(@NonNull AsyncDrawable drawable) {
 
     }
 

markwon-ext-latex/src/main/java/ru/noties/markwon/ext/latex/JLatexMathPlugin.java

@@ -80,12 +80,8 @@ public class JLatexMathPlugin extends AbstractMarkwonPlugin {
         }
     }
 
-    @NonNull
-    public static String makeDestination(@NonNull String latex) {
-        return SCHEME + "://" + latex;
-    }
-
     private static final String SCHEME = "jlatexmath";
+    private static final String SCHEME_START = SCHEME + "://";
     private static final String CONTENT_TYPE = "text/jlatexmath";
 
     private final Config config;
@@ -112,9 +108,11 @@ public class JLatexMathPlugin extends AbstractMarkwonPlugin {
 
                 final RenderProps renderProps = visitor.renderProps();
 
-                ImageProps.DESTINATION.set(renderProps, makeDestination(latex));
+                ImageProps.DESTINATION.set(renderProps, SCHEME_START + latex);
                 ImageProps.REPLACEMENT_TEXT_IS_LINK.set(renderProps, false);
-                ImageProps.IMAGE_SIZE.set(renderProps, new ImageSize(new ImageSize.Dimension(100, "%"), null));
+                ImageProps.IMAGE_SIZE.set(
+                        renderProps,
+                        new ImageSize(new ImageSize.Dimension(100, "%"), null));
 
                 visitor.setSpansForNode(Image.class, length);
             }
@@ -132,7 +130,7 @@ public class JLatexMathPlugin extends AbstractMarkwonPlugin {
                         ImageItem item = null;
 
                         try {
-                            final byte[] bytes = raw.substring(SCHEME.length()).getBytes("UTF-8");
+                            final byte[] bytes = raw.substring(SCHEME_START.length()).getBytes("UTF-8");
                             item = new ImageItem(
                                     CONTENT_TYPE,
                                     new ByteArrayInputStream(bytes));

markwon-image-okhttp/src/main/java/ru/noties/markwon/image/okhttp/OkHttpImagesPlugin.java

@@ -4,6 +4,7 @@ import android.support.annotation.NonNull;
 
 import java.util.Arrays;
 
+import okhttp3.Call;
 import okhttp3.OkHttpClient;
 import ru.noties.markwon.AbstractMarkwonPlugin;
 import ru.noties.markwon.image.AsyncDrawableLoader;
@@ -28,20 +29,25 @@ public class OkHttpImagesPlugin extends AbstractMarkwonPlugin {
 
     @NonNull
     public static OkHttpImagesPlugin create(@NonNull OkHttpClient okHttpClient) {
-        return new OkHttpImagesPlugin(okHttpClient);
+        return create((Call.Factory) okHttpClient);
     }
 
-    private final OkHttpClient client;
+    @NonNull
+    public static OkHttpImagesPlugin create(@NonNull Call.Factory callFactory) {
+        return new OkHttpImagesPlugin(callFactory);
+    }
 
-    OkHttpImagesPlugin(@NonNull OkHttpClient client) {
-        this.client = client;
+    private final Call.Factory callFactory;
+
+    OkHttpImagesPlugin(@NonNull Call.Factory callFactory) {
+        this.callFactory = callFactory;
     }
 
     @Override
     public void configureImages(@NonNull AsyncDrawableLoader.Builder builder) {
         builder.addSchemeHandler(
                 Arrays.asList(NetworkSchemeHandler.SCHEME_HTTP, NetworkSchemeHandler.SCHEME_HTTPS),
-                new OkHttpSchemeHandler(client)
+                new OkHttpSchemeHandler(callFactory)
         );
     }
 

markwon-image-okhttp/src/main/java/ru/noties/markwon/image/okhttp/OkHttpSchemeHandler.java

@@ -3,11 +3,9 @@ package ru.noties.markwon.image.okhttp;
 import android.net.Uri;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
-
 import java.io.IOException;
 import java.io.InputStream;
-
-import okhttp3.OkHttpClient;
+import okhttp3.Call;
 import okhttp3.Request;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
@@ -18,10 +16,10 @@ class OkHttpSchemeHandler extends SchemeHandler {
 
     private static final String HEADER_CONTENT_TYPE = "Content-Type";
 
-    private final OkHttpClient client;
+    private final Call.Factory callFactory;
 
-    OkHttpSchemeHandler(@NonNull OkHttpClient client) {
-        this.client = client;
+    OkHttpSchemeHandler(@NonNull Call.Factory callFactory) {
+        this.callFactory = callFactory;
     }
 
     @Nullable
@@ -36,7 +34,7 @@ class OkHttpSchemeHandler extends SchemeHandler {
 
         Response response = null;
         try {
-            response = client.newCall(request).execute();
+            response = callFactory.newCall(request).execute();
         } catch (IOException e) {
             e.printStackTrace();
         }