Skip to content

Commit

Permalink
🔖 Release 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mfalcier committed Jun 12, 2017
1 parent 36a11bb commit 7e5c428
Show file tree
Hide file tree
Showing 30 changed files with 112 additions and 113 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
[![Build Status](https://travis-ci.org/h-omer/neo4j-core-versioner.svg?branch=master)](https://travis-ci.org/h-omer/neo4j-core-versioner)
[![Build Status](https://travis-ci.org/h-omer/neo4j-versioner-core.svg?branch=master)](https://travis-ci.org/h-omer/neo4j-versioner-core)
[![Dependency Status](https://www.versioneye.com/user/projects/593a42a03601b10036e095b7/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/593a42a03601b10036e095b7)

# Neo4j Core Versioner
# Neo4j Versioner Core

Neo4j Core Versioner is a collection of procedures, aimed to help developers to manage the Entity-State model, by creating, updating and querying the graph.
Neo4j Versioner Core is a collection of procedures, aimed to help developers to manage the Entity-State model, by creating, updating and querying the graph.

## License

Apache License 2.0

## Installation

1. Download the latest [release](https://github.com/h-omer/neo4j-core-versioner/releases);
1. Download the latest [release](https://github.com/h-omer/neo4j-versioner-core/releases);
2. Put the downloaded jar file into `$NEO4J_HOME/plugins` folder;
3. Start/Restart Neo4j.

## About

Neo4j Core Versioner has been developed by [Alberto D'Este](https://github.com/albertodeste) and [Marco Falcier](https://github.com/mfalcier).
Neo4j Versioner Core has been developed by [Alberto D'Este](https://github.com/albertodeste) and [Marco Falcier](https://github.com/mfalcier).

It's based on the following data model:

![Data Model](https://raw.githubusercontent.com/h-omer/neo4j-core-versioner/master/docs/images/data-model.png)
![Data Model](https://raw.githubusercontent.com/h-omer/neo4j-versioner-core/master/docs/images/data-model.png)

## Examples

Expand All @@ -36,7 +37,7 @@ And how to retrieve the current `State`:
MATCH (d:Device) WITH d CALL graph.versioner.get.current.state(d) YIELD node RETURN node
```

If you want to use Neo4j Core Versioner procedures on your procedures/functions you simply create a new instance:
If you want to use Neo4j Versioner Core procedures on your procedures/functions you simply create a new instance:

```java
Optional<Init> result = new InitBuilder().withDb(db).withLog(log).build();
Expand All @@ -45,8 +46,8 @@ result.ifPresent(a -> a.init("EntityLabel", entityProps, stateProps, additionalL

## Full documentation

You can find the full documentation [here](https://h-omer.github.io/neo4j-core-versioner/).
You can find the full documentation [here](https://h-omer.github.io/neo4j-versioner-core/).

## Feedback

We would appreciate your feedback about our Core Versioner, how to improve and fix (we hope not so many! :see_no_evil:) any bad things. Say yours in the [issue](https://github.com/h-omer/neo4j-core-versioner/issues) section.
We would appreciate your feedback about our Core Versioner, how to improve and fix (we hope not so many! :see_no_evil:) any bad things. Say yours in the [issue](https://github.com/h-omer/neo4j-versioner-core/issues) section.
8 changes: 4 additions & 4 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apply plugin: 'java'

group = 'org.homer'
version = '1.1-SNAPSHOT'
version = '1.1.0'

description = """Neo4j Procedures for Graph Versioning"""

Expand All @@ -17,10 +17,10 @@ repositories {
}

dependencies {
testCompile group: 'org.neo4j.test', name: 'neo4j-harness', version:'3.2.0'
testCompile group: 'org.neo4j.driver', name: 'neo4j-java-driver', version:'1.3.0'
testCompile group: 'org.neo4j.test', name: 'neo4j-harness', version:'3.2.1'
testCompile group: 'org.neo4j.driver', name: 'neo4j-java-driver', version:'1.4.0'
testCompile group: 'junit', name: 'junit', version:'4.12'
testCompile group: 'org.hamcrest', name: 'hamcrest-junit', version:'2.0.0.0'
testCompile group: 'org.mockito', name: 'mockito-core', version:'2.8.9'
compile group: 'org.neo4j', name: 'neo4j', version:'3.2.0'
compile group: 'org.neo4j', name: 'neo4j', version:'3.2.1'
}
28 changes: 14 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Neo4j Core Versioner Documentation
# Neo4j Versioner Core Documentation

Neo4j Core Versioner is a collection of procedures, aimed to help developers to manage the Entity-State model, by creating, updating and querying the graph.
Neo4j Versioner Core is a collection of procedures, aimed to help developers to manage the Entity-State model, by creating, updating and querying the graph.

## License

Apache License 2.0

## Installation

1. Download the latest [release](https://github.com/h-omer/neo4j-core-versioner/releases);
1. Download the latest [release](https://github.com/h-omer/neo4j-versioner-core/releases);
2. Put the downloaded jar file into `$NEO4J_HOME/plugins` folder;
3. Start/Restart Neo4j.

# About

Neo4j Core Versioner has been developed by [Alberto D'Este](https://github.com/albertodeste) and [Marco Falcier](https://github.com/mfalcier).
Neo4j Versioner Core has been developed by [Alberto D'Este](https://github.com/albertodeste) and [Marco Falcier](https://github.com/mfalcier).

## Data Model

Expand All @@ -28,19 +28,19 @@ There are 4 different relationships:

This is how the data model looks like:

![Data Model](https://raw.githubusercontent.com/h-omer/neo4j-core-versioner/master/docs/images/data-model.png)
![Data Model](https://raw.githubusercontent.com/h-omer/neo4j-versioner-core/master/docs/images/data-model.png)

## Use cases

You can find some examples and use cases in the repository [wiki](https://github.com/h-omer/neo4j-core-versioner/wiki) (work in progress!).
You can find some examples and use cases in the repository [wiki](https://github.com/h-omer/neo4j-versioner-core/wiki) (work in progress!).

# Procedures Reference

Neo4j procedure documentation can also be found using `CALL dbms.procedures()`.

## How to call Core Versioner Procedures on your procedures/functions

If you want to use Neo4j Core Versioner procedures on your procedures/functions you simply create a new instance:
If you want to use Neo4j Versioner Core procedures on your procedures/functions you simply create a new instance:

```java
Optional<Init> result = new InitBuilder().withDb(db).withLog(log).build();
Expand All @@ -61,8 +61,8 @@ Add the following repository and dependency to your `pom.xml` file

<dependency>
<groupId>com.github.h-omer</groupId>
<artifactId>neo4j-core-versioner</artifactId>
<version>1.1-SNAPSHOT</version>
<artifactId>neo4j-versioner-core</artifactId>
<version>1.1.0</version>
<scope>provided</scope>
</dependency>
```
Expand All @@ -76,11 +76,11 @@ repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
compile 'com.github.h-omer:neo4j-core-versioner:1.1-SNAPSHOT'
compile 'com.github.h-omer:neo4j-versioner-core:1.1.0'
}
```

Neo4j Core Versioner must be a provided dependency on your project and it must be installed on your neo4j instance.
Neo4j Versioner Core must be a provided dependency on your project and it must be installed on your neo4j instance.

## Procedure CheatSheet

Expand Down Expand Up @@ -211,7 +211,7 @@ This procedure is used to retrieve the current path: by a given Entity node, it

This is how the returned path looks like:

![Get Current Path](https://raw.githubusercontent.com/h-omer/neo4j-core-versioner/master/docs/images/get-current-path.png)
![Get Current Path](https://raw.githubusercontent.com/h-omer/neo4j-versioner-core/master/docs/images/get-current-path.png)

### Details

Expand Down Expand Up @@ -272,7 +272,7 @@ This procedure is used to retrieve all Entity's history in a path, including the

Here is how the returned path looks like:

![Get All](https://raw.githubusercontent.com/h-omer/neo4j-core-versioner/master/docs/images/get-all.png)
![Get All](https://raw.githubusercontent.com/h-omer/neo4j-versioner-core/master/docs/images/get-all.png)

### Details

Expand Down Expand Up @@ -519,4 +519,4 @@ MATCH (s:State {code:2}) WITH s CALL graph.versioner.diff.from.current(s) YIELD

# Feedback

We would appreciate your feedback about our Core Versioner, how to improve and fix (we hope not so many!) any bad things. Say yours in the [issue](https://github.com/h-omer/neo4j-core-versioner/issues) section.
We would appreciate your feedback about our Versioner Core, how to improve and fix (we hope not so many!) any bad things. Say yours in the [issue](https://github.com/h-omer/neo4j-versioner-core/issues) section.
2 changes: 1 addition & 1 deletion settings.gradle
Original file line number Diff line number Diff line change
@@ -1 +1 @@
rootProject.name = 'neo4j-core-versioner'
rootProject.name = 'neo4j-versioner-core'
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.homer.core.versioner;
package org.homer.versioner.core;

import org.neo4j.graphdb.*;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.core.CoreProcedure;
import org.homer.versioner.core.core.CoreProcedure;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.logging.Log;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.procedure.Diff;
import org.homer.versioner.core.procedure.Diff;

import java.util.Optional;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.procedure.Get;
import org.homer.versioner.core.procedure.Get;

import java.util.Optional;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.procedure.Init;
import org.homer.versioner.core.procedure.Init;

import java.util.Optional;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.procedure.Rollback;
import org.homer.versioner.core.procedure.Rollback;

import java.util.Optional;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package org.homer.core.versioner.builders;
package org.homer.versioner.core.builders;

import org.homer.core.versioner.procedure.Update;
import org.homer.versioner.core.procedure.Update;

import java.util.Optional;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.homer.core.versioner.core;
package org.homer.versioner.core.core;

import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.logging.Log;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.homer.core.versioner.output;
package org.homer.versioner.core.output;

public class DiffOutput{
public String operation;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.homer.core.versioner.output;
package org.homer.versioner.core.output;

import org.neo4j.graphdb.Node;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.homer.core.versioner.output;
package org.homer.versioner.core.output;

import org.neo4j.graphdb.Path;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package org.homer.core.versioner.procedure;
package org.homer.versioner.core.procedure;

import org.homer.core.versioner.Utility;
import org.homer.core.versioner.output.DiffOutput;
import org.homer.versioner.core.Utility;
import org.homer.versioner.core.output.DiffOutput;
import org.neo4j.graphdb.Direction;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package org.homer.core.versioner.procedure;
package org.homer.versioner.core.procedure;

import org.homer.core.versioner.Utility;
import org.homer.core.versioner.output.NodeOutput;
import org.homer.core.versioner.output.PathOutput;
import org.homer.versioner.core.Utility;
import org.homer.versioner.core.output.NodeOutput;
import org.homer.versioner.core.output.PathOutput;
import org.neo4j.cypher.internal.compiler.v3_2.commands.expressions.PathValueBuilder;
import org.neo4j.graphdb.*;
import org.neo4j.procedure.Description;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package org.homer.core.versioner.procedure;
package org.homer.versioner.core.procedure;

import org.homer.core.versioner.Utility;
import org.homer.core.versioner.core.CoreProcedure;
import org.homer.core.versioner.output.NodeOutput;
import org.homer.versioner.core.Utility;
import org.homer.versioner.core.core.CoreProcedure;
import org.homer.versioner.core.output.NodeOutput;
import org.neo4j.graphdb.Node;
import org.neo4j.procedure.Description;
import org.neo4j.procedure.Mode;
Expand Down
Loading

0 comments on commit 7e5c428

Please sign in to comment.