Skip to content
This repository was archived by the owner on Apr 27, 2023. It is now read-only.

Elegant wannabe solution #12

Open
adamsiemion wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Elegant wannabe solution #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6171b5
Elegant wannabe solution
Apr 23, 2017
f11c579
removed checkstyle-google.xml
Apr 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,30 @@ dependencies {
compile 'ch.qos.logback:logback-classic:1.0.1'
compile 'ch.qos.logback:logback-core:1.0.1'

compileOnly "org.projectlombok:lombok:1.16.10"
compileOnly 'org.projectlombok:lombok:1.16.10'

testCompile 'org.spockframework:spock-core:1.0-groovy-2.4'
testCompile 'org.codehaus.groovy:groovy:2.4.7'
testCompile 'cglib:cglib:3.2.2'

testCompile 'org.objenesis:objenesis:2.5'
testCompile 'com.google.code.findbugs:annotations:3.0.1'
}

apply plugin: 'pmd'
apply plugin: 'checkstyle'
checkstyleMain.source = 'src/main/java/com/softwaremill/java_fp_example/contest'
checkstyle {
toolVersion = '7.6.1'
}

apply plugin: 'findbugs'
tasks.withType(FindBugs) {
reports {
xml.enabled = false
html.enabled = true
}
}

apply plugin: 'jacoco'
test { finalizedBy jacocoTestReport }

219 changes: 219 additions & 0 deletions config/checkstyle/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!-- https://raw.githubusercontent.com/checkstyle/checkstyle/master/src/main/resources/google_checks.xml -->
<!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html.

Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).

To completely disable a check, just comment it out or delete it from the file.

Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<module name="TreeWalker">
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<module name="LineLength">
<property name="max" value="100"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
<module name="AvoidStarImport"/>
<module name="OneTopLevelClass"/>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces"/>
<module name="LeftCurly">
<property name="maxLineLength" value="100"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlySame"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlyAlone"/>
<property name="option" value="alone"/>
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
<property name="allowEmptyLoops" value="true"/>
<message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
<message key="ws.notPreceded"
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
</module>
<module name="OneStatementPerLine"/>
<module name="MultipleVariableDeclarations"/>
<module name="ArrayTypeStyle"/>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapDot"/>
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapComma"/>
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<!--<module name="PackageName">-->
<!--<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>-->
<!--<message key="name.invalidPattern"-->
<!--value="Package name ''{0}'' must match pattern ''{1}''."/>-->
<!--</module>-->
<module name="TypeName">
<message key="name.invalidPattern"
value="Type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="CatchParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="NoFinalizer"/>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="Indentation">
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="4"/>
<property name="throwsIndent" value="8"/>
<property name="lineWrappingIndentation" value="8"/>
<property name="arrayInitIndent" value="5"/>
</module>
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
<property name="allowedAbbreviationLength" value="1"/>
</module>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="VariableDeclarationUsageDistance"/>
<module name="CustomImportOrder">
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="separateLineBetweenGroups" value="true"/>
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
</module>
<module name="MethodParamPad"/>
<module name="ParenPad"/>
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases"/>
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationVariables"/>
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="NonEmptyAtclauseDescription"/>
<module name="JavadocTagContinuationIndentation"/>
<module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
<module name="JavadocParagraph"/>
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="minLineCount" value="2"/>
<property name="allowedAnnotations" value="Override, Test"/>
<property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation"/>
</module>
</module>
27 changes: 27 additions & 0 deletions src/main/java/com/softwaremill/java_fp_example/contest/adamsiemion/FacebookImage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package com.softwaremill.java_fp_example.contest.adamsiemion;

import static com.softwaremill.java_fp_example.contest.adamsiemion.OpenGraphImage.DEFAULT_IMAGE;
import static java.util.Objects.requireNonNull;

import com.softwaremill.java_fp_example.contest.adamsiemion.WebPageAddress.WebPageDownloadException;

public class FacebookImage {

private final WebPageAddress webPageAddress;

public FacebookImage(final WebPageAddress webPageAddress) {
this.webPageAddress = requireNonNull(webPageAddress);
}

public String extractImageAddress() {
return getImage().content();
}

private OpenGraphImage getImage() {
try {
return webPageAddress.download().openGraphHeadImages().getOrElse(DEFAULT_IMAGE);
} catch (WebPageDownloadException e) {
return DEFAULT_IMAGE;
}
}
}
2 changes: 1 addition & 1 deletion ...st/your_github_login/LICENSE-template.txt → ...va_fp_example/contest/adamsiemion/LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 <twój login na GitHubie>
Copyright (c) 2017 adamsiemion

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/com/softwaremill/java_fp_example/contest/adamsiemion/OpenGraphImage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.softwaremill.java_fp_example.contest.adamsiemion;

import com.softwaremill.java_fp_example.DefaultImage;

interface OpenGraphImage {
String content();

OpenGraphImage DEFAULT_IMAGE = () -> DefaultImage.DEFAULT_IMAGE;
}
17 changes: 17 additions & 0 deletions src/main/java/com/softwaremill/java_fp_example/contest/adamsiemion/ParsedOpenGraphImage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package com.softwaremill.java_fp_example.contest.adamsiemion;

import org.jsoup.nodes.Element;

class ParsedOpenGraphImage implements OpenGraphImage {

private final Element imageTag;

ParsedOpenGraphImage(final Element imageTag) {
this.imageTag = imageTag;
}

@Override
public String content() {
return imageTag.attr("content");
}
}
28 changes: 28 additions & 0 deletions src/main/java/com/softwaremill/java_fp_example/contest/adamsiemion/WebPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package com.softwaremill.java_fp_example.contest.adamsiemion;

import static java.util.Objects.requireNonNull;

import javaslang.collection.List;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;

class WebPage {

private static final String OPENGRAPH_IMAGE_TAG = "og:image";

private final Document document;

WebPage(final Document document) {
this.document = requireNonNull(document);
}

List<OpenGraphImage> openGraphHeadImages() {
return List.ofAll(head().getElementsByTag("meta"))
.filter(e -> OPENGRAPH_IMAGE_TAG.equals(e.attr("property")))
.map(ParsedOpenGraphImage::new);
}

private Element head() {
return document.head();
}
}
33 changes: 33 additions & 0 deletions src/main/java/com/softwaremill/java_fp_example/contest/adamsiemion/WebPageAddress.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package com.softwaremill.java_fp_example.contest.adamsiemion;

import static java.util.Objects.requireNonNull;

import java.io.IOException;
import java.net.URL;
import org.jsoup.Jsoup;

class WebPageAddress {

private static final int DOWNLOAD_TIMEOUT_IN_MS = 10_000;

private final String url;

static class WebPageDownloadException extends Exception {

WebPageDownloadException(final String message, final IOException cause) {
super(message, cause);
}
}

WebPageAddress(final String url) {
this.url = requireNonNull(url);
}

WebPage download() throws WebPageDownloadException {
try {
return new WebPage(Jsoup.parse(new URL(url), DOWNLOAD_TIMEOUT_IN_MS));
} catch (IOException e) {
throw new WebPageDownloadException("Could not download page " + url, e);
}
}
}
12 changes: 0 additions & 12 deletions src/main/java/com/softwaremill/java_fp_example/contest/your_github_login/Readme.txt
View file
Open in desktop

This file was deleted.

Loading