Merge pull request #22 from cookpad/v2.0.0

[Proposal] New interfaces to configure Puree

Author: rejasupotaro

README.md

@@ -30,8 +30,8 @@ public class DemoApplication extends Application {
     public static PureeConfiguration buildConfiguration(Context context) {
         PureeFilter addEventTimeFilter = new AddEventTimeFilter();
         return new PureeConfiguration.Builder(context)
-                .registerOutput(new OutLogcat())
-                .registerOutput(new OutBufferedLogcat(), addEventTimeFilter)
+                .source(ClickLog.class).to(new OutLogcat())
+                .source(ClickLog.class).filter(addEventTimeListener).to(new OutBufferedLogcat())
                 .build();
     }
 }
@@ -58,7 +58,7 @@ public class ClickLog extends JsonConvertible {
 Call `Puree.send` in an arbitrary timing.
 
 ```java
-Puree.send(new ClickLog("MainActivity", "Hello"), OutLogcat.TYPE);
+Puree.send(new ClickLog("MainActivity", "Hello"));
 // => {"page":"MainActivity","label":"Hello"}
 ```
 
@@ -73,7 +73,7 @@ If you don't need buffering, you can use PureeOutput.
 
 ```java
 public class OutLogcat extends PureeOutput {
-    public static final String TYPE = "out_logcat";
+    private static final String TYPE = "out_logcat";
 
     @Override
     public String type() {
@@ -96,7 +96,7 @@ If you need beffering, you can use PureeBufferedOutput.
 
 ```java
 public class OutFakeApi extends PureeBufferedOutput {
-    public static final String TYPE = "out_fake_api";
+    private static final String TYPE = "out_fake_api";
 
     private static final FakeApiClient CLIENT = new FakeApiClient();
 
@@ -170,8 +170,8 @@ Register filters when initializing Puree.
 
 ```java
 new PureeConfiguration.Builder(context)
-        .registerOutput(new OutLogcat(), addEventTimeFilter)
-        .registerOutput(new OutFakeApi(), addEventTimeFilter, samplingFilter)
+        .source(ClickLog.class).to(new OutLogcat())
+        .source(ClickLog.class).filters(addEventTimeFilter).filter(samplingFilter).to(new OutFakeApi())
         .build();
 ```
 
@@ -188,5 +188,5 @@ buildscript {
     ...
 
 // app/build.gradle
-compile 'com.cookpad:puree:1.2.0'
+compile 'com.cookpad:puree:2.0.0'
 ```

demo/src/main/java/com/example/puree/MainActivity.java

@@ -1,15 +1,14 @@
 package com.example.puree;
 
-import android.support.v7.app.ActionBarActivity;
 import android.os.Bundle;
+import android.support.v7.app.ActionBarActivity;
 import android.view.Menu;
 import android.view.MenuItem;
 import android.view.View;
 import android.widget.Button;
 import android.widget.TextView;
 
 import com.cookpad.puree.Puree;
-import com.cookpad.puree.plugins.OutLogcat;
 import com.example.puree.logs.ClickLog;
 import com.example.puree.logs.PvLog;
 import com.example.puree.logs.plugins.OutBufferedDisplay;
@@ -20,8 +19,8 @@
 
 public class MainActivity extends ActionBarActivity {
     private TextView logDisplayTextView;
-    private Button logDisplayButton;
-    private Button logBufferedDisplayButton;
+    private Button button1;
+    private Button button2;
 
     private final OutDisplay.Callback outDisplayCallback = new OutDisplay.Callback() {
         @Override
@@ -57,7 +56,7 @@ protected void onCreate(Bundle savedInstanceState) {
         findViews();
         OutDisplay.register(outDisplayCallback);
         OutBufferedDisplay.register(outBufferedDisplayCallback);
-        Puree.send(new PvLog(this), OutLogcat.TYPE);
+        Puree.send(new PvLog(this));
         setupViews();
     }
 
@@ -70,21 +69,21 @@ protected void onDestroy() {
 
     private void findViews() {
         logDisplayTextView = (TextView) findViewById(R.id.log_display);
-        logDisplayButton = (Button) findViewById(R.id.display_button);
-        logBufferedDisplayButton = (Button) findViewById(R.id.buffered_display_button);
+        button1 = (Button) findViewById(R.id.button1);
+        button2 = (Button) findViewById(R.id.button2);
     }
 
     private void setupViews() {
-        logDisplayButton.setOnClickListener(new View.OnClickListener() {
+        button1.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View view) {
-                Puree.send(new ClickLog("MainActivity", "track"), OutDisplay.TYPE);
+                Puree.send(new ClickLog("MainActivity", "BUTTON 1"));
             }
         });
-        logBufferedDisplayButton.setOnClickListener(new View.OnClickListener() {
+        button2.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View view) {
-                Puree.send(new ClickLog("MainActivity", "track"), OutBufferedDisplay.TYPE);
+                Puree.send(new ClickLog("MainActivity", "BUTTON 2"));
             }
         });
     }

demo/src/main/java/com/example/puree/logs/PureeConfigurator.java

@@ -8,7 +8,6 @@
 import com.cookpad.puree.plugins.OutBufferedLogcat;
 import com.cookpad.puree.plugins.OutLogcat;
 import com.example.puree.AddEventTimeFilter;
-import com.example.puree.logs.plugins.OutBufferedDisplay;
 import com.example.puree.logs.plugins.OutDisplay;
 
 public class PureeConfigurator {
@@ -18,12 +17,13 @@ public static void configure(Context context) {
 
     public static PureeConfiguration buildConf(Context context) {
         PureeFilter addEventTimeFilter = new AddEventTimeFilter();
-        return new PureeConfiguration.Builder(context)
-                .registerOutput(new OutLogcat(), addEventTimeFilter)
-                .registerOutput(new OutBufferedLogcat(), addEventTimeFilter)
-                .registerOutput(new OutDisplay())
+        PureeConfiguration conf = new PureeConfiguration.Builder(context)
+                .source(ClickLog.class).to(new OutDisplay())
+                .source(ClickLog.class).filter(addEventTimeFilter).to(new OutBufferedLogcat())
+                .source(PvLog.class).filter(addEventTimeFilter).to(new OutLogcat())
 //                .registerOutput(new OutDisplay(), new SamplingFilter(0.5F)) // you can sampling logs
-                .registerOutput(new OutBufferedDisplay())
                 .build();
+        conf.printMapping();
+        return conf;
     }
 }

demo/src/main/java/com/example/puree/logs/plugins/OutBufferedDisplay.java

@@ -12,8 +12,6 @@
 import java.lang.ref.WeakReference;
 
 public class OutBufferedDisplay extends PureeBufferedOutput {
-    public static final String TYPE = "buffered_display";
-
     private static WeakReference<Callback> callbackRef = new WeakReference<>(null);
 
     public static void register(Callback callback) {
@@ -26,7 +24,7 @@ public static void unregister() {
 
     @Override
     public String type() {
-        return TYPE;
+        return "out_buffered_display";
     }
 
     @Override

demo/src/main/java/com/example/puree/logs/plugins/OutFakeApi.java

@@ -8,13 +8,11 @@
 import org.json.JSONArray;
 
 public class OutFakeApi extends PureeBufferedOutput {
-    public static final String TYPE = "out_fake_api";
-
     private static final FakeApiClient CLIENT = new FakeApiClient();
 
     @Override
     public String type() {
-        return TYPE;
+        return "out_fake_api";
     }
 
     @Override

demo/src/main/res/layout/activity_main.xml

@@ -11,22 +11,22 @@
         android:orientation="horizontal">
 
         <Button
-            android:id="@+id/display_button"
+            android:id="@+id/button1"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_weight="1"
             android:background="@drawable/clickable_button_background"
-            android:text="display"
+            android:text="BUTTON 1"
             android:textColor="@android:color/white" />
 
         <Button
-            android:id="@+id/buffered_display_button"
+            android:id="@+id/button2"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_marginLeft="8dp"
             android:layout_weight="1"
             android:background="@drawable/clickable_button_background"
-            android:text="buffered display"
+            android:text="BUTTON 2"
             android:textColor="@android:color/white" />
     </LinearLayout>
 

plugins/src/main/java/com/cookpad/puree/plugins/OutLogcat.java

@@ -8,11 +8,9 @@
 import org.json.JSONObject;
 
 public class OutLogcat extends PureeOutput {
-    public static final String TYPE = "out_logcat";
-
     @Override
     public String type() {
-        return TYPE;
+        return "out_logcat";
     }
 
     @Override
@@ -22,6 +20,6 @@ public OutputConfiguration configure(OutputConfiguration conf) {
 
     @Override
     public void emit(JSONObject jsonLog) {
-        Log.d(TYPE, jsonLog.toString());
+        Log.d("out_logcat", jsonLog.toString());
     }
 }

puree/build.gradle

@@ -11,6 +11,8 @@ android {
         targetSdkVersion 21
         versionCode 1
         versionName "1.0"
+
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
         release {
@@ -20,9 +22,14 @@ android {
     }
 
     compileOptions {
+        encoding = 'UTF-8'
         sourceCompatibility JavaVersion.VERSION_1_7
         targetCompatibility JavaVersion.VERSION_1_7
     }
+    packagingOptions {
+        exclude 'META-INF/services/javax.annotation.processing.Processor'
+        exclude 'LICENSE.txt'
+    }
 }
 
 android.libraryVariants.all { variant ->
@@ -47,6 +54,9 @@ dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     compile 'com.android.support:appcompat-v7:21.0.2'
     compile 'com.google.code.gson:gson:2.3'
+
+    androidTestCompile 'com.android.support.test.espresso:espresso-core:2.0'
+    androidTestCompile 'com.android.support.test:testing-support-lib:0.1'
 }
 
 task androidJar(type: Jar) {
@@ -63,7 +73,7 @@ artifacts {
     archives androidSourcesJar
 }
 
-version = "1.2.0"
+version = "2.0.0"
 
 publishing {
     publications {

puree/src/androidTest/java/com/cookpad/puree/KeyTest.java

@@ -0,0 +1,44 @@
+package com.cookpad.puree;
+
+import android.support.test.runner.AndroidJUnit4;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static org.hamcrest.Matchers.is;
+import static org.junit.Assert.assertThat;
+
+@RunWith(AndroidJUnit4.class)
+public class KeyTest {
+    @Test
+    public void getId() {
+        {
+            Key key = Key.from(FooLog.class);
+            assertThat(key.getId(), is("com.cookpad.puree.KeyTest$FooLog"));
+        }
+        {
+            Key key = Key.from(BarLog.class);
+            assertThat(key.getId(), is("com.cookpad.puree.KeyTest$BarLog"));
+        }
+    }
+
+    @Test
+    public void equals() {
+        {
+            Key key1 = Key.from(FooLog.class);
+            Key key2 = Key.from(BarLog.class);
+            assertThat(key1.equals(key2), is(false));
+        }
+        {
+            Key key1 = Key.from(FooLog.class);
+            Key key2 = Key.from(FooLog.class);
+            assertThat(key1.equals(key2), is(true));
+        }
+    }
+
+    private static class FooLog extends JsonConvertible {
+    }
+
+    private static class BarLog extends JsonConvertible {
+    }
+}