Plugin page: http://artifacts.griffon-framework.org/plugin/couchdb
The Couchdb plugin enables lightweight access to Couchdb databases with jcouchdb. This plugin does NOT provide domain classes nor dynamic finders like GORM does.
Upon installation the plugin will generate the following artifacts in
$appdir/griffon-app/conf
:
- CouchdbConfig.groovy - contains the database definitions.
- BootstrapCouchdb.groovy - defines init/destroy hooks for data to be manipulated during app startup/shutdown.
A new dynamic method named withCouchdb
will be injected into all controllers,
giving you access to a org.jcouchdb.db.Database
object, with which you'll be
able to make calls to the database. Remember to make all database calls off the
UI thread otherwise your application may appear unresponsive when doing long
computations inside the UI thread.
This method is aware of multiple databases. If no databaseName is specified when calling it then the default database will be selected. Here are two example usages, the first queries against the default database while the second queries a database whose name has been configured as 'internal'
package sample
class SampleController {
def queryAllDatabases = {
withCouchdb { databaseName, database -> ... }
withCouchdb('internal') { databaseName, database -> ... }
}
}
The following list enumerates all the variants of the injected method
<R> R withCouchdb(Closure<R> stmts)
<R> R withCouchdb(CallableWithArgs<R> stmts)
<R> R withCouchdb(String databaseName, Closure<R> stmts)
<R> R withCouchdb(String databaseName, CallableWithArgs<R> stmts)
These methods are also accessible to any component through the singleton
griffon.plugins.couchdb.CouchdbConnector
. You can inject these methods to
non-artifacts via metaclasses. Simply grab hold of a particular metaclass and
call CouchdbEnhancer.enhance(metaClassInstance, couchdbProviderInstance)
.
The preferred way to mark a class for method injection is by annotating it with
@griffon.plugins.couchdb.CouchdbAware
. This transformation injects the
griffon.plugins.couchdb.CouchdbContributionHandler
interface and default
behavior that fulfills the contract.
Dynamic methods will be added to controllers by default. You can
change this setting by adding a configuration flag in griffon-app/conf/Config.groovy
griffon.couchdb.injectInto = ['controller', 'service']
Dynamic method injection will be skipped for classes implementing
griffon.plugins.couchdb.CouchdbContributionHandler
.
The following events will be triggered by this addon
- CouchdbConnectStart[config, databaseName] - triggered before connecting to the database
- CouchdbConnectEnd[databaseName, conn] - triggered after connecting to the database
- CouchdbDisconnectStart[config, databaseName, conn] - triggered before disconnecting from the database
- CouchdbDisconnectEnd[config, databaseName] - triggered after disconnecting from the database
The config file CouchdbConfig.groovy
defines a default database block. As the name
implies this is the database used by default, however you can configure named databases
by adding a new config block. For example connecting to a database whose name is 'internal'
can be done in this way
databases {
internal {
host = "localhost"
port = 5566
username = "private"
password = "secret"
datastore = "myapp"
}
}
This block can be used inside the environments()
block in the same way as the
default database block is used.
The plugin will load and store the contents of CouchdbConfig.groovy
inside the
application's configuration, under the pluginConfig
namespace. You may retrieve
and/or update values using
app.config.pluginConfig.couchdb
The plugin will attempt a connection to the default database at startup. If this
behavior is not desired then specify the following configuration flag in
Config.groovy
griffon.couchdb.connect.onstartup = false
A trivial sample application can be found at https://github.com/aalmiray/griffon_sample_apps/tree/master/persistence/couchdb
Dynamic methods will not be automatically injected during unit testing, because
addons are simply not initialized for this kind of tests. However you can use
CouchdbEnhancer.enhance(metaClassInstance, couchdbProviderInstance)
where
couchdbProviderInstance
is of type griffon.plugins.couchdb.CouchdbProvider
.
The contract for this interface looks like this
public interface CouchdbProvider {
<R> R withCouchdb(Closure<R> closure);
<R> R withCouchdb(CallableWithArgs<R> callable);
<R> R withCouchdb(String databaseName, Closure<R> closure);
<R> R withCouchdb(String databaseName, CallableWithArgs<R> callable);
}
It's up to you define how these methods need to be implemented for your tests. For example, here's an implementation that never fails regardless of the arguments it receives
class MyCouchdbProvider implements CouchdbProvider {
public <R> R withCouchdb(Closure<R> closure) { null }
public <R> R withCouchdb(CallableWithArgs<R> callable) { null }
public <R> R withCouchdb(String databaseName, Closure<R> closure) { null }
public <R> R withCouchdb(String databaseName, CallableWithArgs<R> callable) { null }
}
This implementation may be used in the following way
class MyServiceTests extends GriffonUnitTestCase {
void testSmokeAndMirrors() {
MyService service = new MyService()
CouchdbEnhancer.enhance(service.metaClass, new MyCouchdbProvider())
// exercise service methods
}
}
On the other hand, if the service is annotated with @CouchdbAware
then usage
of CouchdbEnhancer
should be avoided at all costs. Simply set couchdbProviderInstance
on the service instance directly, like so, first the service definition
@griffon.plugins.couchdb.CouchdbAware
class MyService {
def serviceMethod() { ... }
}
Next is the test
class MyServiceTests extends GriffonUnitTestCase {
void testSmokeAndMirrors() {
MyService service = new MyService()
service.couchdbProvider = new MyCouchdbProvider()
// exercise service methods
}
}
This plugin provides DSL descriptors for Intellij IDEA and Eclipse (provided
you have the Groovy Eclipse plugin installed). These descriptors are found
inside the griffon-couchdb-compile-x.y.z.jar
, with locations
- dsdl/couchdb.dsld
- gdsl/couchdb.gdsl
Rewriting Java AST in a similar fashion to Groovy AST transformations is possible thanks to the lombok plugin.
Support for this compiler is provided out-of-the-box by the command line tools. There's no additional configuration required.
Follow the steps found in the Lombok plugin for setting up Eclipse up to number 5.
-
Go to the path where the
lombok.jar
was copied. This path is either found inside the Eclipse installation directory or in your local settings. Copy the following file from the project's working directory$ cp $USER_HOME/.griffon/<version>/projects/<project>/plugins/couchdb-<version>/dist/griffon-couchdb-compile-<version>.jar .
-
Edit the launch script for Eclipse and tweak the boothclasspath entry so that includes the file you just copied
-Xbootclasspath/a:lombok.jar:lombok-pg-<version>.jar: griffon-lombok-compile-<version>.jar:griffon-couchdb-compile-<version>.jar
-
Launch Eclipse once more. Eclipse should be able to provide content assist for Java classes annotated with
@CouchdbAware
.
Follow the instructions found in Annotation Processors Support in the NetBeans
IDE, Part I: Using Project Lombok. You may need to specify
lombok.core.AnnotationProcessor
in the list of Annotation Processors.
NetBeans should be able to provide code suggestions on Java classes annotated
with @CouchdbAware
.
Follow the steps found in the Lombok plugin for setting up Intellij IDEA up to number 5.
-
Copy
griffon-couchdb-compile-<version>.jar
to thelib
directory$ pwd $USER_HOME/Library/Application Support/IntelliJIdea11/lombok-plugin $ cp $USER_HOME/.griffon/<version>/projects/<project>/plugins/couchdb-<version>/dist/griffon-couchdb-compile-<version>.jar lib
-
Launch IntelliJ IDEA once more. Code completion should work now for Java classes annotated with
@CouchdbAware
.
This project requires all of its dependencies be available from maven compatible repositories. Some of these dependencies have not been pushed to the Maven Central Repository, however you can obtain them from lombok-dev-deps.
Follow the instructions found there to install the required dependencies into your local Maven repository before attempting to build this plugin.