kemitix/thorp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve Code Quality (#37)

Browse source 
* [core] convert QuoteStripper to an object and move to core

* [aws-lib]S3ClientUploader: use case matching instead of else if blocks

* [aws-lib] put imports at top of file

* [domain] remove redundant braces after class definition

* [aws-lib] remove redundant braces after class definition

* [core] avoid using head on a collection
This commit is contained in:
Paul Campbell 2019-06-06 19:49:07 +01:00 committed by GitHub
parent f54c50aaf3
commit 8ec667343a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 30 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/QuoteStripper.scala
View file

@ -1,7 +0,0 @@
package net.kemitix.s3thorp.aws.lib
trait QuoteStripper {
def stripQuotes: Char => Boolean = _ != '"'
}

4
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/S3ClientMultiPartUploader.scala
View file

@ -6,6 +6,7 @@ import com.amazonaws.services.s3.AmazonS3
import com.amazonaws.services.s3.model._
import net.kemitix.s3thorp.aws.api.S3Action.{ErroredS3Action, UploadS3Action}
import net.kemitix.s3thorp.aws.api.{S3Action, UploadProgressListener}
import net.kemitix.s3thorp.core.QuoteStripper.stripQuotes
import net.kemitix.s3thorp.core.MD5HashGenerator.md5FilePart
import net.kemitix.s3thorp.domain.{Bucket, LocalFile, MD5Hash}
@ -14,8 +15,7 @@ import scala.util.control.NonFatal
private class S3ClientMultiPartUploader(s3Client: AmazonS3)
extends S3ClientUploader
with S3ClientMultiPartUploaderLogging
with QuoteStripper {
with S3ClientMultiPartUploaderLogging {
def accepts(localFile: LocalFile)
(implicit multiPartThreshold: Long): Boolean =

4
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/S3ClientObjectLister.scala
View file

@ -2,6 +2,7 @@ package net.kemitix.s3thorp.aws.lib
import cats.effect.IO
import com.github.j5ik2o.reactive.aws.s3.cats.S3CatsIOClient
import net.kemitix.s3thorp.core.QuoteStripper.stripQuotes
import net.kemitix.s3thorp.domain._
import software.amazon.awssdk.services.s3.model.{ListObjectsV2Request, S3Object}
@ -9,8 +10,7 @@ import scala.collection.JavaConverters._
class S3ClientObjectLister(s3Client: S3CatsIOClient)
extends S3ClientLogging
with S3ObjectsByHash
with QuoteStripper {
with S3ObjectsByHash {
def listObjects(bucket: Bucket,
prefix: RemoteKey)

4
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/S3ClientPutObjectUploader.scala
View file

@ -5,12 +5,12 @@ import com.amazonaws.services.s3.AmazonS3
import com.amazonaws.services.s3.model.PutObjectRequest
import net.kemitix.s3thorp.aws.api.S3Action.UploadS3Action
import net.kemitix.s3thorp.aws.api.UploadProgressListener
import net.kemitix.s3thorp.core.QuoteStripper.stripQuotes
import net.kemitix.s3thorp.domain.{Bucket, LocalFile, MD5Hash}
class S3ClientPutObjectUploader(amazonS3: => AmazonS3)
extends S3ClientUploader
with S3ClientLogging
with QuoteStripper {
with S3ClientLogging {
override def accepts(localFile: LocalFile)(implicit multiPartThreshold: Long): Boolean = true

11
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/S3ClientUploader.scala
View file

@ -23,12 +23,11 @@ trait S3ClientUploader {
def progressListener(uploadProgressListener: UploadProgressListener): ProgressListener = {
new ProgressListener {
override def progressChanged(event: ProgressEvent): Unit = {
if (event.getEventType.isTransferEvent)
TransferEvent(event.getEventType.name)
else if (event.getEventType equals ProgressEventType.RESPONSE_BYTE_TRANSFER_EVENT)
ByteTransferEvent(event.getEventType.name)
else
RequestEvent(event.getEventType.name, event.getBytes, event.getBytesTransferred)
event match {
case e if e.getEventType.isTransferEvent => TransferEvent(e.getEventType.name)
case e if e.getEventType equals ProgressEventType.RESPONSE_BYTE_TRANSFER_EVENT => ByteTransferEvent(e.getEventType.name)
case e => RequestEvent(e.getEventType.name, e.getBytes, e.getBytesTransferred)
}
}
}
}

3
aws-lib/src/main/scala/net/kemitix/s3thorp/aws/lib/ThorpS3Client.scala
View file

@ -13,8 +13,7 @@ class ThorpS3Client(ioS3Client: S3CatsIOClient,
amazonS3Client: => AmazonS3,
amazonS3TransferManager: => TransferManager)
extends S3Client
with S3ClientLogging
with QuoteStripper {
with S3ClientLogging {
// lazy val amazonS3Client = AmazonS3ClientBuilder.defaultClient
// lazy val amazonS3TransferManager = TransferManagerBuilder.defaultTransferManager

4
aws-lib/src/test/scala/net/kemitix/s3thorp/aws/lib/S3ClientMultiPartTransferManagerSuite.scala
View file

@ -4,12 +4,12 @@ import java.io.File
import java.time.Instant
import com.amazonaws.AmazonClientException
import com.amazonaws.event.ProgressListener
import com.amazonaws.services.s3.model
import com.amazonaws.services.s3.transfer.model.UploadResult
import com.amazonaws.services.s3.transfer._
import net.kemitix.s3thorp.aws.api.S3Action.UploadS3Action
import net.kemitix.s3thorp.aws.api.UploadProgressListener
import net.kemitix.s3thorp.aws.lib.S3ClientMultiPartTransferManager
import net.kemitix.s3thorp.core.KeyGenerator.generateKey
import net.kemitix.s3thorp.core.{MD5HashGenerator, Resource}
import net.kemitix.s3thorp.domain._
@ -115,8 +115,6 @@ class S3ClientMultiPartTransferManagerSuite
override def getProgress: TransferProgress = ???
import com.amazonaws.event.ProgressListener
override def addProgressListener(listener: ProgressListener): Unit = ???
override def removeProgressListener(listener: ProgressListener): Unit = ???

2
aws-lib/src/test/scala/net/kemitix/s3thorp/aws/lib/S3ClientMultiPartUploaderSuite.scala
View file

@ -283,7 +283,7 @@ class S3ClientMultiPartUploaderSuite
override def abortMultipartUpload(abortMultipartUploadRequest: AbortMultipartUploadRequest): Unit = {
canceled set true
}
}) {}
})
}
private def invoke(uploader: S3ClientMultiPartUploader, theFile: LocalFile, progressListener: UploadProgressListener) = {

8
core/src/main/scala/net.kemitix.s3thorp.core/ActionGenerator.scala
View file

@ -50,11 +50,7 @@ object ActionGenerator {
private def copyFile(bucket: Bucket,
localFile: LocalFile,
matchByHash: Set[RemoteMetaData]): Stream[Action] =
Stream(
ToCopy(
bucket,
sourceKey = matchByHash.head.remoteKey,
hash = localFile.hash,
targetKey = localFile.remoteKey))
matchByHash.headOption.map(_.remoteKey).toStream.map {sourceKey =>
ToCopy(bucket, sourceKey, localFile.hash, localFile.remoteKey)}
}

7
core/src/main/scala/net.kemitix.s3thorp.core/QuoteStripper.scala Normal file
View file

@ -0,0 +1,7 @@
package net.kemitix.s3thorp.core
object QuoteStripper {
def stripQuotes: Char => Boolean = _ != '"'
}

4
domain/src/main/scala/net/kemitix/s3thorp/domain/Bucket.scala
View file

@ -1,5 +1,3 @@
package net.kemitix.s3thorp.domain
final case class Bucket(name: String) {
}
final case class Bucket(name: String)

4
domain/src/main/scala/net/kemitix/s3thorp/domain/HashModified.scala
View file

@ -1,6 +1,4 @@
package net.kemitix.s3thorp.domain
final case class HashModified(hash: MD5Hash,
modified: LastModified) {
}
modified: LastModified)

4
domain/src/main/scala/net/kemitix/s3thorp/domain/KeyModified.scala
View file

@ -1,6 +1,4 @@
package net.kemitix.s3thorp.domain
final case class KeyModified(key: RemoteKey,
modified: LastModified) {
}
modified: LastModified)

4
domain/src/main/scala/net/kemitix/s3thorp/domain/LastModified.scala
View file

@ -2,6 +2,4 @@ package net.kemitix.s3thorp.domain
import java.time.Instant
final case class LastModified(when: Instant) {
}
final case class LastModified(when: Instant)

4
domain/src/main/scala/net/kemitix/s3thorp/domain/RemoteMetaData.scala
View file

@ -2,6 +2,4 @@ package net.kemitix.s3thorp.domain
final case class RemoteMetaData(remoteKey: RemoteKey,
hash: MD5Hash,
lastModified: LastModified) {
}
lastModified: LastModified)

7
domain/src/main/scala/net/kemitix/s3thorp/domain/S3ObjectsData.scala
View file

@ -3,8 +3,5 @@ package net.kemitix.s3thorp.domain
/**
* A list of objects and their MD5 hash values.
*/
final case class S3ObjectsData(
byHash: Map[MD5Hash, Set[KeyModified]],
byKey: Map[RemoteKey, HashModified]) {
}
final case class S3ObjectsData(byHash: Map[MD5Hash, Set[KeyModified]],
byKey: Map[RemoteKey, HashModified])