Update callback event name

worldia · Nov 17, 2016 · 13e45a9 · 13e45a9
1 parent 9fad862
commit 13e45a9
Show file tree

Hide file tree

Showing 12 changed files with 85 additions and 43 deletions.
diff --git a/lib/Textmaster/CallbackHandler.php b/lib/Textmaster/CallbackHandler.php
@@ -107,7 +107,7 @@ private function getEvent(array $data)
         }
 
         if (!isset($type)) {
-            throw new InvalidArgumentException(sprintf('Couldnt determine callback type from "%s".', serialize($data)));
+            throw new InvalidArgumentException(sprintf('Could not determine callback type from "%s".', serialize($data)));
         }
 
         $name = sprintf('textmaster.%s.%s', $type, $data['status']);

diff --git a/lib/Textmaster/Event/CallbackEvent.php b/lib/Textmaster/Event/CallbackEvent.php
@@ -15,15 +15,30 @@
 
 class CallbackEvent extends GenericEvent
 {
+    /**
+     * @var string
+     */
     private $eventName;
 
+    /**
+     * Constructor.
+     *
+     * @param string $eventName
+     * @param array  $subject
+     * @param mixed  $data
+     */
     public function __construct($eventName, $subject, $data)
     {
         parent::__construct($subject, $data);
 
         $this->eventName = $eventName;
     }
 
+    /**
+     * Get name.
+     *
+     * @return string
+     */
     public function getName()
     {
         return $this->eventName;

diff --git a/lib/Textmaster/Model/Document.php b/lib/Textmaster/Model/Document.php
@@ -203,14 +203,6 @@ public function getSourceContent()
         return $this->formatTranslatedContent();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getTranslatedContent()
-    {
-        return $this->getSourceContent();
-    }
-
     /**
      * {@inheritdoc}
      */

diff --git a/lib/Textmaster/Model/DocumentInterface.php b/lib/Textmaster/Model/DocumentInterface.php
@@ -128,15 +128,6 @@ public function getType();
      */
     public function getSourceContent();
 
-    /**
-     * Get translated content.
-     *
-     * @deprecated since version 0.2.7, to be removed in 0.3. Use getSourceContent().
-     *
-     * @return string|array
-     */
-    public function getTranslatedContent();
-
     /**
      * Get word count.
      *

diff --git a/lib/Textmaster/Translator/Adapter/AbstractAdapter.php b/lib/Textmaster/Translator/Adapter/AbstractAdapter.php
@@ -34,7 +34,7 @@ public function supports($subject)
     /**
      * {@inheritdoc}
      */
-    public function create($subject, array $properties, DocumentInterface $document)
+    public function push($subject, array $properties, DocumentInterface $document)
     {
         $this->failIfDoesNotSupport($subject);
         $project = $document->getProject();
@@ -86,6 +86,16 @@ public function compare(DocumentInterface $document)
      * {@inheritdoc}
      */
     public function complete(DocumentInterface $document, $satisfaction = null, $message = null)
+    {
+        $document->complete($satisfaction, $message);
+
+        return $document;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function pull(DocumentInterface $document)
     {
         $subject = $this->getSubjectFromDocument($document);
         $this->failIfDoesNotSupport($subject);
@@ -98,8 +108,6 @@ public function complete(DocumentInterface $document, $satisfaction = null, $mes
 
         $this->setProperties($subject, $properties, $language);
 
-        $document->complete($satisfaction, $message);
-
         return $subject;
     }
 

diff --git a/lib/Textmaster/Translator/Adapter/AbstractDoctrineAdapter.php b/lib/Textmaster/Translator/Adapter/AbstractDoctrineAdapter.php
@@ -36,9 +36,9 @@ public function __construct(ManagerRegistry $registry)
     /**
      * {@inheritdoc}
      */
-    public function complete(DocumentInterface $document, $satisfaction = null, $message = null)
+    public function pull(DocumentInterface $document)
     {
-        $subject = parent::complete($document, $satisfaction, $message);
+        $subject = parent::pull($document);
 
         $this->persist($subject);
 

diff --git a/lib/Textmaster/Translator/Adapter/AdapterInterface.php b/lib/Textmaster/Translator/Adapter/AdapterInterface.php
@@ -18,20 +18,22 @@ interface AdapterInterface
     /**
      * Whether the adapter supports the given subject.
      *
+     * @param mixed $subject
+     *
      * @return bool
      */
     public function supports($subject);
 
     /**
-     * Launch a translation.
+     * Push document to textmaster.
      *
      * @param mixed             $subject
      * @param array             $properties
      * @param DocumentInterface $document
      *
      * @return DocumentInterface
      */
-    public function create($subject, array $properties, DocumentInterface $document);
+    public function push($subject, array $properties, DocumentInterface $document);
 
     /**
      * Make a comparison between textmaster document and its subject.
@@ -43,16 +45,25 @@ public function create($subject, array $properties, DocumentInterface $document)
     public function compare(DocumentInterface $document);
 
     /**
-     * Complete a translation.
+     * Complete a document.
      *
      * @param DocumentInterface $document
      * @param string            $satisfaction
      * @param string            $message
      *
-     * @return mixed
+     * @return DocumentInterface
      */
     public function complete(DocumentInterface $document, $satisfaction = null, $message = null);
 
+    /**
+     * Pull document from textmaster.
+     *
+     * @param DocumentInterface $document
+     *
+     * @return mixed The subject passed on creation.
+     */
+    public function pull(DocumentInterface $document);
+
     /**
      * Get subject from document.
      *

diff --git a/lib/Textmaster/Translator/Translator.php b/lib/Textmaster/Translator/Translator.php
@@ -54,7 +54,7 @@ public function __construct(
     /**
      * {@inheritdoc}
      */
-    public function create($subject, $documentOrParams = null, $save = true)
+    public function push($subject, $documentOrParams = null, $save = true)
     {
         $document = $documentOrParams;
 
@@ -66,7 +66,7 @@ public function create($subject, $documentOrParams = null, $save = true)
 
         foreach ($this->adapters as $adapter) {
             if ($adapter->supports($subject)) {
-                $document = $adapter->create($subject, $properties, $document);
+                $document = $adapter->push($subject, $properties, $document);
 
                 if ($save) {
                     $document->save();
@@ -111,6 +111,22 @@ public function complete(DocumentInterface $document, $satisfaction = null, $mes
         throw new InvalidArgumentException(sprintf('No adapter found for document "%s".', $document->getId()));
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function pull(DocumentInterface $document)
+    {
+        foreach ($this->adapters as $adapter) {
+            try {
+                return $adapter->pull($document);
+            } catch (UnexpectedTypeException $e) {
+                continue;
+            }
+        }
+
+        throw new InvalidArgumentException(sprintf('No adapter found for document "%s".', $document->getId()));
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/lib/Textmaster/Translator/TranslatorInterface.php b/lib/Textmaster/Translator/TranslatorInterface.php
@@ -16,7 +16,7 @@
 interface TranslatorInterface
 {
     /**
-     * Launch a translation.
+     * Push document to textmaster.
      *
      * @param mixed                   $subject
      * @param mixed|DocumentInterface $documentOrParams Either pass a document instance
@@ -25,7 +25,7 @@ interface TranslatorInterface
      *
      * @return DocumentInterface
      */
-    public function create($subject, $documentOrParams = null, $save = true);
+    public function push($subject, $documentOrParams = null, $save = true);
 
     /**
      * Make a comparison between textmaster document and its subject.
@@ -37,16 +37,25 @@ public function create($subject, $documentOrParams = null, $save = true);
     public function compare(DocumentInterface $document);
 
     /**
-     * Complete a translation.
+     * Complete a document.
      *
      * @param DocumentInterface $document
      * @param string            $satisfaction
      * @param string            $message
      *
-     * @return mixed The subject passed on creation.
+     * @return DocumentInterface
      */
     public function complete(DocumentInterface $document, $satisfaction = null, $message = null);
 
+    /**
+     * Pull document from textmaster.
+     *
+     * @param DocumentInterface $document
+     *
+     * @return mixed The subject passed on creation.
+     */
+    public function pull(DocumentInterface $document);
+
     /**
      * Get subject from document.
      *

diff --git a/test/Textmaster/Unit/Translator/Adapter/GedmoTranslatableAdapterTest.php b/test/Textmaster/Unit/Translator/Adapter/GedmoTranslatableAdapterTest.php
@@ -52,7 +52,7 @@ public function shouldCreateSameLocale()
             ->willReturn('en');
 
         $adapter = new GedmoTranslatableAdapter($managerRegistryMock, $listenerMock);
-        $adapter->create($translatableMock, ['name'], $documentMock);
+        $adapter->push($translatableMock, ['name'], $documentMock);
     }
 
     /**
@@ -95,6 +95,6 @@ public function shouldCreateDifferentLocale()
             ->method('refresh');
 
         $adapter = new GedmoTranslatableAdapter($managerRegistryMock, $listenerMock);
-        $adapter->create($translatableMock, ['name'], $documentMock);
+        $adapter->push($translatableMock, ['name'], $documentMock);
     }
 }
diff --git a/test/Textmaster/Unit/Translator/Adapter/SyliusTranslatableAdapterTest.php b/test/Textmaster/Unit/Translator/Adapter/SyliusTranslatableAdapterTest.php
@@ -72,7 +72,7 @@ public function shouldCreate()
             ->willReturn(1);
 
         $adapter = new SyliusTranslatableAdapter($managerRegistryMock);
-        $adapter->create($translatableMock, ['name'], $documentMock);
+        $adapter->push($translatableMock, ['name'], $documentMock);
     }
 
     /**
@@ -125,7 +125,7 @@ public function shouldComplete()
             ->willReturn(ProjectInterface::ACTIVITY_TRANSLATION);
 
         $adapter = new SyliusTranslatableAdapter($managerRegistryMock);
-        $subject = $adapter->complete($documentMock);
+        $subject = $adapter->pull($documentMock);
 
         $this->assertSame($translatableMock, $subject);
         $this->assertSame('my translation', $translationMock->getName());

diff --git a/test/Textmaster/Unit/Translator/TranslatorTest.php b/test/Textmaster/Unit/Translator/TranslatorTest.php
@@ -37,11 +37,11 @@ public function shouldCreate()
             ->willReturn(true);
 
         $adapterMock->expects($this->once())
-            ->method('create')
+            ->method('push')
             ->willReturn($documentMock);
 
         $translator = new Translator($adapters, $mappingProviderMock);
-        $translator->create($subjectMock, $documentMock);
+        $translator->push($subjectMock, $documentMock);
     }
 
     /**
@@ -70,11 +70,11 @@ public function shouldCreateFromFactory()
             ->willReturn(true);
 
         $adapterMock->expects($this->once())
-            ->method('create')
+            ->method('push')
             ->willReturn($documentMock);
 
         $translator = new Translator($adapters, $mappingProviderMock, $documentFactoryMock);
-        $translator->create($subjectMock);
+        $translator->push($subjectMock);
     }
 
     /**
@@ -192,7 +192,7 @@ public function shouldNotCreate()
             ->willReturn(false);
 
         $translator = new Translator($adapters, $mappingProviderMock);
-        $translator->create($subjectMock, $documentMock);
+        $translator->push($subjectMock, $documentMock);
     }
 
     /**
@@ -223,7 +223,7 @@ public function shouldNotCreateFromFactory()
         $subjectMock = $this->getMock('Subject');
 
         $translator = new Translator($adapters, $mappingProviderMock);
-        $translator->create($subjectMock);
+        $translator->push($subjectMock);
     }
 
     /**