[MISC] deprecate seqan3::views::to_upper (#2538)

* [MISC] deprecate seqan3::views::to_upper * Update include/seqan3/range/views/to_upper.hpp Co-authored-by: marehr <[email protected]> Co-authored-by: Marcel <[email protected]>
seqan · Apr 23, 2021 · dca7146 · dca7146 · vercel · Apr 23, 2021
1 parent 7de10d6
commit dca7146
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -203,6 +203,9 @@ regression test suite and patches at https://github.com/seqan/seqan3/tree/master
   [Cookbook](https://docs.seqan.de/seqan/3.0.3/cookbook.html#cookbook_convert_alphabet_range).
 * Deprecated `seqan3::views::drop`, use `std::views::drop` or `seqan3::views::type_reduce | std::views::drop`.
   ([\#2540](https://github.com/seqan/seqan3/pull/2540))
+* We deprecated `seqan3::views::to_upper` and it will be removed in 3.1.0, use
+  `std::views::transform([](auto && chr){return std::toupper(chr)})`.
+  ([\#2540](https://github.com/seqan/seqan3/pull/2538))
 
 #### Search
 

diff --git a/include/seqan3/range/views/to_upper.hpp b/include/seqan3/range/views/to_upper.hpp
@@ -7,7 +7,7 @@
 
 /*!\file
  * \author Tobias Loka <LokaT AT rki.de>
- * \brief Provides seqan3::views::to_upper.
+ * \brief [DEPRECATED] Provides seqan3::views::to_upper.
  */
 
 #pragma once
@@ -63,13 +63,17 @@ namespace seqan3::views
  * ### Example
  * \include test/snippet/range/views/to_upper.cpp
  * \hideinitializer
+ *
+ * \deprecated Use std::views::transform([](auto && chr){return std::toupper(chr)});
  */
-inline auto const to_upper = deep{std::views::transform([] (auto const in) noexcept
+#ifdef SEQAN3_DEPRECATED_310
+SEQAN3_DEPRECATED_310 inline auto const to_upper = deep{std::views::transform([] (auto const in) noexcept
 {
     static_assert(builtin_character<std::remove_cvref_t<decltype(in)>>,
                   "The value type of seqan3::views::to_upper must model the seqan3::builtin_character.");
     return seqan3::to_upper(in);
 })};
+#endif // SEQAN3_DEPRECATED_310
 
 //!\}
 

diff --git a/test/snippet/range/views/to_upper.cpp b/test/snippet/range/views/to_upper.cpp
@@ -1,3 +1,6 @@
+#ifdef SEQAN3_DEPRECATED_310
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 #include <string>
 #include <vector>
 
@@ -14,3 +17,5 @@ int main()
     seqan3::debug_stream << v1 << '\n'; // => "CHANGED!"
     seqan3::debug_stream << v2 << '\n'; // => ["CHANGED", "UNCHANGED!"]
 }
+#pragma GCC diagnostic pop
+#endif // SEQAN3_DEPRECATED_310
diff --git a/test/unit/range/views/to_upper_test.cpp b/test/unit/range/views/to_upper_test.cpp
@@ -15,6 +15,9 @@
 #include <seqan3/range/views/to_upper.hpp>
 #include <seqan3/test/expect_range_eq.hpp>
 
+#ifdef SEQAN3_DEPRECATED_310
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 
 using seqan3::operator""_dna5;
 
@@ -95,3 +98,5 @@ TEST(view_to_upper, concepts)
     EXPECT_FALSE((std::ranges::output_range<decltype(upper_view), char>));
     EXPECT_FALSE(std::ranges::contiguous_range<decltype(upper_view)>);
 }
+#pragma GCC diagnostic pop
+#endif // SEQAN3_DEPRECATED_310