Preparing first release (#14)

* Change all Gradle configuration options until I could make ./gradlew :app:lint work.
* Write a README describing how to use the project.
* Write a CONTRIBUTING file for people to contribute freely.
* Include codecov configuration (with jacoco) now that the project is public.

Author: Serchinastico

.github/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+Contributing
+============
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+If you would like to contribute code to this repository you can do so through GitHub by
+forking the repository and sending a pull request or opening an issue.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure your code compiles, passes the tests and the checkstyle configured for this repository.
+
+Some tips that will help you to contribute to this repository:
+
+* Write clean code and test it.
+* Follow the repository code style.
+* Write descriptive commit messages.
+* No PR will be merged if automatic checks are not passing.
+* Review if your changes affects the repository documentation and update it.
+* Describe the PR content and don't hesitate to add comments to explain us why you've added or changed something.
+
+Code of conduct
+---------------
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by sending me a message at [twitter](https://twitter.com/AtSerchinastico).
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/), version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/](http://contributor-covenant.org/version/1/3/0/).

.travis.yml

@@ -9,4 +9,7 @@ android:
     - extra
 
 script:
-    - ./gradlew check test
+    - ./gradlew check test
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -1,2 +1,88 @@
-# Lin
-Lin is an Android Lint tool but simpler
+![LIN](./readme/logo.png)
+
+---------------
+
+[![Build Status](https://travis-ci.org/Serchinastico/Lin.svg?branch=master)](https://travis-ci.org/Serchinastico/Lin)
+[![codecov](https://codecov.io/gh/Serchinastico/Lin/branch/master/graph/badge.svg)](https://codecov.io/gh/Serchinastico/Lin)
+
+Lin is an Android Lint tool made simpler. It has two different goals:
+
+1. To create a set of highly opinionated rules to apply to your Android projects.
+2. To offer a Kotlin DSL to write your own rules in a much easier way.
+
+## How to use
+
+Add the JitPack repository to your build file:
+
+```groovy
+allprojects {
+    repositories {
+        ...
+        maven { url 'https://jitpack.io' }
+    }
+}
+```
+
+### Lin-Rules
+
+Add the rules module dependencies to your project and the dsl module as part of the lint classpath:
+
+```groovy
+dependencies {
+    lintChecks 'com.serchinastico.lin:rules:0.0.1'
+    lintClassPath 'com.serchinastico.lin:dsl:0.0.1'
+}
+```
+
+### Lin-DSL
+
+If you want to write your own rules just add the dsl and annotations modules to your linting project:
+
+```groovy
+dependencies {
+    compileOnly 'com.serchinastico.lin:dsl:0.0.1'
+    compileOnly 'com.serchinastico.lin:annotations:0.0.1'
+}
+```
+
+## How to write your own rules
+
+Lin offers a DSL (Domain Specific Language) to write your own rules easily. The API is focused on representing your rules as concisely as possible. Let's bisect an example of a rule to understand how it works:
+
+```kotlin
+@Rule
+fun noElseInSwitchWithEnumOrSealed() = rule(
+    // Define the issue:
+    issue(
+        // 1. What files should the rule check
+        Scope.JAVA_FILE_SCOPE,
+        // 2. A brief description of the issue
+        "There should not be else/default branches on a switch statement checking for enum/sealed class values",
+        // 3. A more in-detail explanation of why are we detecting the issue
+        "Adding an else/default branch breaks extensibility because it won't let you know if there is a missing " +
+                "implementation when adding new types to the enum/sealed class",
+        // The category this issue falls into
+        Category.CORRECTNESS
+    )
+) {
+    /* The rule definition using the DSL. Define the
+     * AST node you want to look for and include a
+     * suchThat definition returning true when you want 
+     * your rule to report an issue.
+     * The best way to see what nodes you have
+     * available is by using your IDE autocomplete
+     * function
+    */
+    switch {
+        suchThat { node ->
+            val classReferenceType = node.expression?.getExpressionType() ?: (return@suchThat false)
+
+            if (!classReferenceType.isEnum && !classReferenceType.isSealed) {
+                return@suchThat false
+            }
+
+            node.clauses.any { clause -> clause.isElseBranch }
+        }
+    }
+}
+```

app/build.gradle

@@ -20,8 +20,14 @@ android {
     }
 }
 
+configurations {
+    lintChecks
+}
+
 dependencies {
-    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    lintChecks project(path: ":rules", configuration: 'lintChecks')
+    lintClassPath project(":dsl")
+
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.3.10"
     implementation 'com.android.support:appcompat-v7:28.0.0'
     testImplementation 'junit:junit:4.12'

app/src/main/java/com/serchinastico/lin/TestActivity.kt

@@ -1,7 +1,3 @@
 package com.serchinastico.lin
 
-import android.view.View
-
-class TestClass {
-    public val view: View = View(null)
-}
+class TestClass

build.gradle

@@ -5,7 +5,7 @@ buildscript {
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.2.1'
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.10"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.11"
     }
 }
 

dsl/build.gradle

@@ -1,6 +1,4 @@
-apply plugin: 'java-library'
 apply plugin: 'kotlin'
-apply plugin: 'kotlin-kapt'
 
 dependencies {
     compileOnly 'com.android.tools.lint:lint:26.2.1'

dsl/src/main/kotlin/com/serchinastico/lin/dsl/LinDsl.kt

@@ -128,26 +128,6 @@ sealed class LNode<T : UElement> {
 
 fun rule(issueBuilder: IssueBuilder, block: LinRule.() -> LinRule): LinRule = LinRule(issueBuilder).block()
 
-fun main(args: Array<String>) {
-    val detectorScope = Scope.JAVA_FILE_SCOPE
-
-    rule(
-        issue(
-            detectorScope,
-            "Framework classes to get or store data should never be called from Activities, Fragments or any other" +
-                    " Android related view.",
-            "Your Android classes should not be responsible for retrieving or storing information, that should be " +
-                    "responsibility of another classes.",
-            Category.INTEROPERABILITY
-        )
-    ) {
-        file {
-            import { suchThat { it.isFrameworkLibraryImport } }
-            type { suchThat { node -> node.uastSuperTypes.any { it.isAndroidFrameworkType } } }
-        }
-    }
-}
-
 fun issue(
     scope: EnumSet<Scope>,
     description: String,

processor/build.gradle

@@ -3,8 +3,8 @@ apply plugin: 'kotlin'
 apply plugin: 'kotlin-kapt'
 
 dependencies {
-    implementation project(":annotations")
-    implementation project(":dsl")
+    compile project(":annotations")
+    compile project(":dsl")
     implementation "org.jetbrains.kotlin:kotlin-stdlib:1.3.10"
     implementation "com.squareup:kotlinpoet:1.0.0-RC3"
     implementation "com.google.auto.service:auto-service:1.0-rc4"

processor/src/main/kotlin/com/serchinastico/lin/processor/RuleProcessor.kt

@@ -58,6 +58,7 @@ class RuleProcessor : AbstractProcessor() {
 
                 val className = "${issueId}Detector"
                 val ruleFile = FileSpec.builder(packageName, className)
+                    .addImport("com.serchinastico.lin.dsl", "report")
                     .addType(
                         TypeSpec.classBuilder(className)
                             .superclass(DETECTOR_CLASS_NAME)