Skip to content

Commit 5d5dc70

Browse files
authored
Merge pull request #803 from AVSystem/deprecate-spring-module
deprecate `spring` module and related components in preparation for removal
2 parents 3c8c8fe + a678b1a commit 5d5dc70

File tree

8 files changed

+19
-2
lines changed

8 files changed

+19
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@
4040
* `commons-hocon` - Utilities for working with [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md)
4141
* `HoconInput` - an `Input` implementation for `GenCodec` that can read Lightbend Config (`com.typesafe.config.Config`)
4242
* An AST (`HTree`) and a lexer/parser for HOCON (`HLexer`, `HParser`)
43-
* `commons-spring` - Spring framework utilities:
43+
* `commons-spring` (DEPRECATED) - Spring framework utilities:
4444
* `HoconBeanDefinitionReader` - an utility that allows you to define Spring application context using
4545
[HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) format

spring/src/main/scala/com/avsystem/commons/spring/AttrNames.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import org.springframework.beans.factory.support.AbstractBeanDefinition
66

77
/** Created: 17-03-2014 Author: ghik
88
*/
9+
@deprecated(spring.DeprecatedMessage, spring.DeprecatedSince)
910
object AttrNames {
1011
final val AbstractAttr = "%abstract"
1112
final val ArgTypesAttr = "%arg-types"

spring/src/main/scala/com/avsystem/commons/spring/HoconBeanDefinitionReader.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import org.springframework.core.io.Resource
1313
import java.{util => ju}
1414
import scala.annotation.nowarn
1515

16+
@deprecated(spring.DeprecatedMessage, spring.DeprecatedSince)
1617
class HoconBeanDefinitionReader(registry: BeanDefinitionRegistry) extends AbstractBeanDefinitionReader(registry) {
1718

1819
import com.avsystem.commons.spring.HoconBeanDefinitionReader.Keys._

spring/src/main/scala/com/avsystem/commons/spring/HoconType.scala

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ package com.avsystem.commons
22
package spring
33

44
import com.typesafe.config._
5+
import scala.annotation.nowarn
56

7+
@deprecated(spring.DeprecatedMessage, spring.DeprecatedSince)
68
trait HoconType[T] {
79

810
protected def requireNonNull(value: ConfigValue): ConfigValue = {
@@ -21,6 +23,7 @@ trait HoconType[T] {
2123
def get(value: ConfigValue): T
2224
}
2325

26+
@nowarn("msg=deprecated")
2427
object HoconType {
2528

2629
import com.typesafe.config.ConfigValueType._

spring/src/main/scala/com/avsystem/commons/spring/ScalaDefaultValuesInjector.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import scala.annotation.tailrec
1111
import scala.beans.BeanProperty
1212
import scala.reflect.{ScalaLongSignature, ScalaSignature}
1313

14+
@deprecated(spring.DeprecatedMessage, spring.DeprecatedSince)
1415
class ScalaDefaultValuesInjector extends BeanDefinitionRegistryPostProcessor {
1516
@BeanProperty var paramNameDiscoverer: ParameterNameDiscoverer =
1617
new StandardReflectionParameterNameDiscoverer
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package com.avsystem.commons
2+
3+
package object spring {
4+
private[spring] final val DeprecatedMessage = "spring module is deprecated and it is going to be removed"
5+
private[spring] final val DeprecatedSince = "2.27.0"
6+
}

spring/src/test/scala/com/avsystem/commons/spring/HoconBeanDefinitionReaderTest.scala

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ import org.springframework.beans.factory.support.DefaultListableBeanFactory
88
import org.springframework.context.support.GenericApplicationContext
99
import org.springframework.core.StandardReflectionParameterNameDiscoverer
1010

11-
import java.{util => ju}
11+
import java.util as ju
12+
import scala.annotation.nowarn
1213
import scala.beans.BeanProperty
1314

1415
class TestBean(val constrInt: Int = 1, val constrString: String = "constrDefault") {
@@ -35,6 +36,7 @@ object ConditionalTestBean {
3536
var initializedCount = 0
3637
}
3738

39+
@nowarn("msg=deprecated")
3840
class HoconBeanDefinitionReaderTest extends AnyFunSuite with BeforeAndAfterEach {
3941
def createContext(resource: String): GenericApplicationContext = {
4042
val beanFactory = new DefaultListableBeanFactory

spring/src/test/scala/com/avsystem/commons/spring/XmlPlayground.scala

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ package spring
44
import com.typesafe.config.ConfigFactory
55
import org.springframework.context.support.GenericApplicationContext
66

7+
import scala.annotation.nowarn
8+
9+
@nowarn("msg=deprecated")
710
object XmlPlayground {
811
def main(args: Array[String]): Unit = {
912
val ctx = new GenericApplicationContext

0 commit comments

Comments
 (0)