Rename getChangelog() to getChangelogLink().

This is what it does, and the old name was confusing.
midahp · Dec 4, 2017 · e693453 · e693453
1 parent 860733e
commit e693453
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 21 deletions.
diff --git a/data/distribute/openSUSE/components.php b/data/distribute/openSUSE/components.php
@@ -150,6 +150,6 @@ function processDependencies($component) {
 }
 // build a text containing only the last change. Use dash instead of *
 
-$changes = "updated to version $package_version\n- [xxx] something changed\n- [yyy] This changed too" . $component->getChangelog(new Components_Helper_ChangeLog($this->_output, $this->_config));
+$changes = "updated to version $package_version\n- [xxx] something changed\n- [yyy] This changed too" . $component->getChangelogLink();
 //$changes = $component->getInstallationFileList();
 shell_exec("cd $destination && mv package.spec $package_name.spec && osc vc -m \"$changes\" &> file");
diff --git a/lib/Components/Component.php b/lib/Components/Component.php
@@ -121,11 +121,9 @@ public function hasLocalPackageXml();
     /**
      * Returns the link to the change log.
      *
-     * @param Components_Helper_ChangeLog $helper  The change log helper.
-     *
-     * @return string|null The link to the change log.
+     * @return string The link to the change log.
      */
-    public function getChangelog($helper);
+    public function getChangelogLink();
 
     /**
      * Return the path to the release notes.

diff --git a/lib/Components/Component/Base.php b/lib/Components/Component/Base.php
@@ -223,11 +223,9 @@ public function hasLocalPackageXml()
     /**
      * Returns the link to the change log.
      *
-     * @param Components_Helper_ChangeLog $helper  The change log helper.
-     *
-     * @return string|null The link to the change log.
+     * @return string The link to the change log.
      */
-    public function getChangelog($helper)
+    public function getChangelogLink()
     {
         throw new Components_Exception('Not supported!');
     }

diff --git a/lib/Components/Component/Source.php b/lib/Components/Component/Source.php
@@ -103,14 +103,12 @@ public function hasLocalPackageXml()
     /**
      * Returns the link to the change log.
      *
-     * @param Components_Helper_ChangeLog $helper  The change log helper.
-     *
-     * @return string|null The link to the change log.
+     * @return string The link to the change log.
      */
-    public function getChangelog($helper)
+    public function getChangelogLink()
     {
         $base = $this->getFactory()->getGitRoot()->getRoot();
-        return $helper->getChangelog(
+        return $this->getFactory()->createChangelog($this)->getChangelogLink(
             preg_replace(
                 '#^' . $base . '#', '', $this->_directory
             )

diff --git a/lib/Components/Helper/ChangeLog.php b/lib/Components/Helper/ChangeLog.php
@@ -398,7 +398,7 @@ public function changes($log, $options)
      *
      * @return string  The link to the change log.
      */
-    public function getChangelog($root)
+    public function getChangelogLink($root)
     {
         if ($changes = $this->changesFileExists()) {
             $hordeInfo = $this->_getHordeInfo();

diff --git a/lib/Components/Release/Task/Announce.php b/lib/Components/Release/Task/Announce.php
@@ -80,12 +80,7 @@ public function run(&$options)
         $mailer->append("\n\n" .
             'The full list of changes can be viewed here:' .
             "\n\n" .
-            $this->getComponent()->getChangelog(
-                new Components_Helper_ChangeLog(
-                    $this->getOutput(),
-                    $this->getComponent()->getConfig()
-                )
-            ) .
+            $this->getComponent()->getChangelogLink() .
             "\n\n" .
             'Have fun!' .
             "\n\n" .