Merge pull request #22 from rosvit/document-event

Added DocumentEvent support

src/main/java/rx/observables/SwingObservable.java

@@ -31,11 +31,14 @@
 
 import javax.swing.AbstractButton;
 import javax.swing.SwingUtilities;
+import javax.swing.event.DocumentEvent;
+import javax.swing.text.Document;
 
 import rx.Observable;
 import rx.functions.Func1;
 import rx.swing.sources.AbstractButtonSource;
 import rx.swing.sources.ComponentEventSource;
+import rx.swing.sources.DocumentEventSource;
 import rx.swing.sources.FocusEventSource;
 import rx.swing.sources.ItemEventSource;
 import rx.swing.sources.KeyEventSource;
@@ -243,7 +246,35 @@ public Boolean call(PropertyChangeEvent event) {
             }
         });
     }
-
+
+    /**
+     * Creates an observable corresponding to document events.
+     *
+     * @param document The document to register the observable for.
+     * @return Observable of document events.
+     */
+    public static Observable<DocumentEvent> fromDocumentEvents(Document document) {
+        return DocumentEventSource.fromDocumentEventsOf(document);
+    }
+
+    /**
+     * Creates an observable corresponding to document events restricted to a
+     * set of given event types.
+     *
+     * @param document The document to register the observable for.
+     * @param eventTypes The set of event types for which the observable should
+     * emit document events.
+     * @return Observable of document events.
+     */
+    public static Observable<DocumentEvent> fromDocumentEvents(Document document, final Set<DocumentEvent.EventType> eventTypes) {
+        return fromDocumentEvents(document).filter(new Func1<DocumentEvent, Boolean>() {
+            @Override
+            public Boolean call(DocumentEvent event) {
+                return eventTypes.contains(event.getType());
+            }
+        });
+    }
+
     /**
      * Check if the current thead is the event dispatch thread.
      * 

src/main/java/rx/swing/sources/DocumentEventSource.java

@@ -0,0 +1,65 @@
+/**
+ * Copyright 2015 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package rx.swing.sources;
+
+import javax.swing.event.DocumentEvent;
+import javax.swing.event.DocumentListener;
+import javax.swing.text.Document;
+
+import rx.Observable;
+import rx.Observable.OnSubscribe;
+import rx.Subscriber;
+import rx.functions.Action0;
+import rx.schedulers.SwingScheduler;
+import rx.subscriptions.Subscriptions;
+
+public enum DocumentEventSource { ; // no instances
+
+    /**
+     * @see rx.observables.SwingObservable#fromDocumentEvents(Document)
+     */
+    public static Observable<DocumentEvent> fromDocumentEventsOf(final Document document) {
+        return Observable.create(new OnSubscribe<DocumentEvent>() {
+            @Override
+            public void call(final Subscriber<? super DocumentEvent> subscriber) {
+                final DocumentListener listener = new DocumentListener() {
+                    @Override
+                    public void insertUpdate(DocumentEvent event) {
+                        subscriber.onNext(event);
+                    }
+
+                    @Override
+                    public void removeUpdate(DocumentEvent event) {
+                        subscriber.onNext(event);
+                    }
+
+                    @Override
+                    public void changedUpdate(DocumentEvent event) {
+                        subscriber.onNext(event);
+                    }
+                };
+                document.addDocumentListener(listener);
+                subscriber.add(Subscriptions.create(new Action0() {
+                    @Override
+                    public void call() {
+                        document.removeDocumentListener(listener);
+                    }
+                }));
+            }
+        }).subscribeOn(SwingScheduler.getInstance())
+                .unsubscribeOn(SwingScheduler.getInstance());
+    }
+}

src/test/java/rx/swing/sources/DocumentEventSourceTest.java

@@ -0,0 +1,162 @@
+/**
+ * Copyright 2015 Netflix, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package rx.swing.sources;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+import javax.swing.JEditorPane;
+import javax.swing.event.DocumentEvent;
+import javax.swing.text.BadLocationException;
+import javax.swing.text.Document;
+import javax.swing.text.Style;
+import javax.swing.text.StyleContext;
+import javax.swing.text.html.HTMLDocument;
+import org.hamcrest.Matcher;
+import org.junit.Test;
+import org.mockito.ArgumentMatcher;
+import rx.functions.Action0;
+import rx.functions.Action1;
+import org.mockito.Matchers;
+import org.mockito.Mockito;
+import rx.Subscription;
+import static org.mockito.Mockito.*;
+import rx.observables.SwingObservable;
+
+public class DocumentEventSourceTest {
+
+    @Test
+    public void testObservingDocumentEvents() throws Throwable {
+        SwingTestHelper.create().runInEventDispatchThread(new Action0() {
+
+            @Override
+            public void call() {
+                @SuppressWarnings("unchecked")
+                Action1<DocumentEvent> action = mock(Action1.class);
+                @SuppressWarnings("unchecked")
+                Action1<Throwable> error = mock(Action1.class);
+                Action0 complete = mock(Action0.class);
+
+                final JEditorPane pane = new JEditorPane();
+                // Document must by StyledDocument to test changeUpdate
+                pane.setContentType("text/html");
+                final Document doc = (HTMLDocument) pane.getDocument();
+
+                final Subscription subscription = DocumentEventSource.fromDocumentEventsOf(doc)
+                        .subscribe(action, error, complete);
+
+                verify(action, never()).call(Matchers.<DocumentEvent>any());
+                verify(error, never()).call(Matchers.<Throwable>any());
+                verify(complete, never()).call();
+
+                // test insertUpdate
+                insertStringToDocument(doc, 0, "test text");
+                verify(action).call(Mockito.argThat(documentEventMatcher(DocumentEvent.EventType.INSERT)));
+                verifyNoMoreInteractions(action, error, complete);
+
+                // test removeUpdate
+                removeFromDocument(doc, 0, 5);
+                verify(action).call(Mockito.argThat(documentEventMatcher(DocumentEvent.EventType.REMOVE)));
+                verifyNoMoreInteractions(action, error, complete);
+
+                // test changeUpdate
+                Style defaultStyle = StyleContext.getDefaultStyleContext().getStyle(StyleContext.DEFAULT_STYLE);
+                ((HTMLDocument) doc).setCharacterAttributes(0, doc.getLength(), defaultStyle, true);
+                verify(action).call(Mockito.argThat(documentEventMatcher(DocumentEvent.EventType.CHANGE)));
+                verifyNoMoreInteractions(action, error, complete);
+
+                // test unsubscribe
+                subscription.unsubscribe();
+                insertStringToDocument(doc, 0, "this should be ignored");
+                verifyNoMoreInteractions(action, error, complete);
+            }
+
+        }).awaitTerminal();
+    }
+
+    @Test
+    public void testObservingFilteredDocumentEvents() throws Throwable {
+        SwingTestHelper.create().runInEventDispatchThread(new Action0() {
+
+            @Override
+            public void call() {
+                @SuppressWarnings("unchecked")
+                Action1<DocumentEvent> action = mock(Action1.class);
+                @SuppressWarnings("unchecked")
+                Action1<Throwable> error = mock(Action1.class);
+                Action0 complete = mock(Action0.class);
+
+                final Document doc = new JEditorPane().getDocument();
+
+                // filter only INSERT, others will be ignored
+                final Set<DocumentEvent.EventType> filteredTypes
+                        = new HashSet<DocumentEvent.EventType>(Arrays.asList(DocumentEvent.EventType.INSERT));
+                final Subscription subscription = SwingObservable.fromDocumentEvents(doc, filteredTypes)
+                        .subscribe(action, error, complete);
+
+                verify(action, never()).call(Matchers.<DocumentEvent>any());
+                verify(error, never()).call(Matchers.<Throwable>any());
+                verify(complete, never()).call();
+
+                // test insertUpdate
+                insertStringToDocument(doc, 0, "test text");
+                verify(action).call(Mockito.argThat(documentEventMatcher(DocumentEvent.EventType.INSERT)));
+                verifyNoMoreInteractions(action, error, complete);
+
+                // test removeUpdate
+                removeFromDocument(doc, 0, 5);
+                // removeUpdate should be ignored
+                verifyNoMoreInteractions(action, error, complete);
+
+                // test unsubscribe
+                subscription.unsubscribe();
+                insertStringToDocument(doc, 0, "this should be ignored");
+                verifyNoMoreInteractions(action, error, complete);
+            }
+
+        }).awaitTerminal();
+    }
+
+    private static Matcher<DocumentEvent> documentEventMatcher(final DocumentEvent.EventType eventType) {
+        return new ArgumentMatcher<DocumentEvent>() {
+            @Override
+            public boolean matches(Object argument) {
+                if (!(argument instanceof DocumentEvent)) {
+                    return false;
+                }
+
+                return ((DocumentEvent) argument).getType().equals(eventType);
+            }
+        };
+    }
+
+    private static void insertStringToDocument(Document doc, int offset, String text) {
+        try {
+            doc.insertString(offset, text, null);
+        } catch (BadLocationException ex) {
+            throw new RuntimeException(ex);
+        }
+    }
+
+    private static void removeFromDocument(Document doc, int offset, int length) {
+        try {
+            doc.remove(offset, length);
+        } catch (BadLocationException ex) {
+            throw new RuntimeException(ex);
+        }
+    }
+
+}