Skip to content

Commit

Permalink
put jqa rules into Asciidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JensNercheKE committed Oct 15, 2015
1 parent 5ef00ee commit 9ffa136
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 1 deletion.
21 changes: 20 additions & 1 deletion build.gradle
@@ -1,5 +1,7 @@
apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'org.asciidoctor.gradle.asciidoctor'
apply plugin: 'com.github.jruby-gradle.base'

project.ext["jqaversion"] = "1.0.0"
project.group = 'de.kontext-e.jqassistant.plugin'
Expand All @@ -16,6 +18,19 @@ buildscript {
}
}

asciidoctor {
dependsOn jrubyPrepareGems
requires = ['asciidoctor-diagram']
gemPath = jrubyPrepareGems.outputDir
sourceDir = file('doc/architecture')

resources {
from('doc/architecture') {
include '**/*.png'
}
}
}

subprojects {
apply plugin: 'java'
apply plugin: 'maven'
Expand Down Expand Up @@ -151,6 +166,9 @@ dependencies {
runtime 'com.sun.jersey:jersey-server:1.13'
runtime 'com.sun.jersey:jersey-core:1.13'
runtime 'com.sun.jersey:jersey-servlet:1.13'


gems 'rubygems:asciidoctor-diagram:1.2.1'
}

task removeJQAReport(type: Delete) {
Expand Down Expand Up @@ -189,7 +207,8 @@ task(jqaanalyze, type: JavaExec) {
classpath = sourceSets.main.runtimeClasspath
args 'analyze'
args '-r'
args 'jqassistant/jqassistant-rules'
args 'doc/architecture'
//args 'jqassistant/jqassistant-rules'
}

task(jqa, dependsOn: ['jqascan','jqaanalyze']) {
Expand Down
119 changes: 119 additions & 0 deletions doc/architecture/05_building_block_view.adoc
@@ -0,0 +1,119 @@
[[section-building-block-view]]
== Building Block View


[[naming-rules:TestsMustEndWithTest]]
.All Unit Tests must end with suffix 'Test'
[source, cypher, role=constraint, depends=junit4:TestClass, severity=blocker]
----
MATCH
(t)
RETURN
t AS InvalidTestClass
----


=== Level 1


The following diagram shows the main building blocks of the system and their interdependencies:

<insert overview diagram here>
[plantuml,level1,png]
....
package de.kontext_e.jqassistant.plugin.plantuml.scanner {}
package de.kontext_e.jqassistant.plugin.plantuml.store.descriptor {}
de.kontext_e.jqassistant.plugin.plantuml.scanner --> de.kontext_e.jqassistant.plugin.plantuml.store.descriptor
....

Comments regarding structure and interdependencies at Level 1:

==== Building Block Name 1 (Black Box Description)


<insert the building block’s black box template here>

==== Building Block Name 2 (Black Box Description)

<insert the building block’s black box template here>

==== ...

<insert the building block’s black box template here>

==== Building Block Name n (Black Box Description)

<insert the building block’s black box template here>

==== Open Issues

=== Level 2



==== Building Block Name 1 (White Box Description)


<insert diagram of building block 1 here>

===== Building Block Name 1.1 (Black Box Description)


===== Building Block Name 1.2 (Black Box Description)

Structure according to black box template

===== ...

===== Building Block Name 1.n (Black Box Description)


===== Description of Relationships

===== Open Issues

==== Building Block Name 2 (White Box Description)


<insert diagram of building block 2 here>

===== Building Block Name 2.1 (Black Box Description)

Structure according to black box template

===== Building Block Name 2.2 (Black Box Description)


===== ...

===== Building Block Name 2.n (Black Box Description)


===== Description of Relationships

===== Open Issues

==== Building Block Name 3 (White Box Description)

...

<insert diagram of building block 3 here>

===== Building Block Name 3.1 (Black Box Description)


===== Building Block Name 3.2 (Black Box Description)

===== ...

===== Building Block Name 3.n (Black Box Description)


===== Description of Relationships

===== Open Issues

=== Level 3

0 comments on commit 9ffa136

Please sign in to comment.