A Repository that uses MongoDB as backend.

import popcorn
import popcorn::pop_repos
import popcorn::pop_json

# First, let's create a User abstraction:

# Serializable user representation.
class User
    super RepoObject
    serialize

    # User login
    var login: String

    # User password
    var password: String is writable

    redef fun to_s do return login
end

# We then need to subclass the `MongoRepository` to provide User specific services:

# User repository for Mongo
class UserRepo
    super MongoRepository[User]

    # Find a user by its login
    fun find_by_login(login: String): nullable User do
        var q = new JsonObject
        q["login"] = login
        return find(q)
    end
end

# The repository can then be used with User instances:

# Init database
var mongo = new MongoClient("mongodb://mongo:27017/")
var db = mongo.database("tests")
var coll = db.collection("test_pop_repo_{100000.rand}")

# Create a user repo to store User instances
var repo = new UserRepo(coll)

# Create some users
repo.save(new User("Morriar", "1234"))
repo.save(new User("Alex", "password"))

assert repo.find_all.length == 2
assert repo.find_by_login("Morriar").password == "1234"
repo.clear
assert repo.find_all.length == 0

Introduced properties

fun aggregate(pipeline: JsonArray): Array[E]

popcorn :: MongoRepository :: aggregate

Perform an aggregation query over the repo.
fun collection: MongoCollection

popcorn :: MongoRepository :: collection

MongoDB collection used to store objects
protected fun collection=(collection: MongoCollection)

popcorn :: MongoRepository :: collection=

MongoDB collection used to store objects

Redefined properties

redef type QUERY: JsonObject

popcorn $ MongoRepository :: QUERY

Kind of queries accepted
redef type SELF: MongoRepository[E]

popcorn $ MongoRepository :: SELF

Type of this instance, automatically specialized in every class
redef fun clear: Bool

popcorn $ MongoRepository :: clear

Remove all instances
redef fun count(query: nullable QUERY): Int

popcorn $ MongoRepository :: count

Count instances that matches query
redef fun find(query: QUERY): nullable E

popcorn $ MongoRepository :: find

Find an instance based on query
redef fun find_all(query: nullable QUERY, skip: nullable Int, limit: nullable Int): Array[E]

popcorn $ MongoRepository :: find_all

Find all instances based on query
redef fun find_by_id(id: String): nullable E

popcorn $ MongoRepository :: find_by_id

Find an instance by it's id
redef fun remove(query: nullable QUERY): Bool

popcorn $ MongoRepository :: remove

Remove the instance based on query
redef fun remove_all(query: nullable QUERY): Bool

popcorn $ MongoRepository :: remove_all

Remove all the instances matching on query
redef fun remove_by_id(id: String): Bool

popcorn $ MongoRepository :: remove_by_id

Remove the instance with id
redef fun save(item: E): Bool

popcorn $ MongoRepository :: save

Save an instance

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type QUERY: RepositoryQuery

popcorn :: Repository :: QUERY

Kind of queries accepted
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun aggregate(pipeline: JsonArray): Array[E]

popcorn :: MongoRepository :: aggregate

Perform an aggregation query over the repo.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
abstract fun clear: Bool

popcorn :: Repository :: clear

Remove all instances
fun collection: MongoCollection

popcorn :: MongoRepository :: collection

MongoDB collection used to store objects
protected fun collection=(collection: MongoCollection)

popcorn :: MongoRepository :: collection=

MongoDB collection used to store objects
abstract fun count(query: nullable QUERY): Int

popcorn :: Repository :: count

Count instances that matches query
abstract fun deserialize(string: nullable String): nullable E

popcorn :: Repository :: deserialize

Deserialize a string to an instance.
abstract fun find(query: QUERY): nullable E

popcorn :: Repository :: find

Find an instance based on query
abstract fun find_all(query: nullable QUERY, skip: nullable Int, limit: nullable Int): Array[E]

popcorn :: Repository :: find_all

Find all instances based on query
abstract fun find_by_id(id: String): nullable E

popcorn :: Repository :: find_by_id

Find an instance by it's id
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
abstract fun remove(query: nullable QUERY): Bool

popcorn :: Repository :: remove

Remove the instance based on query
abstract fun remove_all(query: nullable QUERY): Bool

popcorn :: Repository :: remove_all

Remove all the instances matching on query
abstract fun remove_by_id(id: String): Bool

popcorn :: Repository :: remove_by_id

Remove the instance with id
abstract fun save(instance: E): Bool

popcorn :: Repository :: save

Save an instance
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
abstract fun serialize(instance: nullable E): nullable String

popcorn :: Repository :: serialize

Serialize an instance to a String.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram popcorn::MongoRepository MongoRepository popcorn::JsonRepository JsonRepository popcorn::MongoRepository->popcorn::JsonRepository popcorn::Repository Repository popcorn::JsonRepository->popcorn::Repository ...popcorn::Repository ... ...popcorn::Repository->popcorn::Repository github::LoaderJobRepo LoaderJobRepo github::LoaderJobRepo->popcorn::MongoRepository github::RepoRepo RepoRepo github::RepoRepo->popcorn::MongoRepository github::BranchRepo BranchRepo github::BranchRepo->popcorn::MongoRepository github::CommitRepo CommitRepo github::CommitRepo->popcorn::MongoRepository github::IssueRepo IssueRepo github::IssueRepo->popcorn::MongoRepository github::PullRequestRepo PullRequestRepo github::PullRequestRepo->popcorn::MongoRepository github::IssueCommentRepo IssueCommentRepo github::IssueCommentRepo->popcorn::MongoRepository github::IssueEventRepo IssueEventRepo github::IssueEventRepo->popcorn::MongoRepository popcorn::TrackerRepo TrackerRepo popcorn::TrackerRepo->popcorn::MongoRepository

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Repository[E: Serializable]

popcorn :: Repository

A Repository is an object that can store serialized instances.

Parents

abstract class JsonRepository[E: Serializable]

popcorn :: JsonRepository

A Repository for JsonObjects.

Children

Class definitions

popcorn $ MongoRepository
# A Repository that uses MongoDB as backend.
#
# ~~~nitish
# import popcorn
# import popcorn::pop_repos
# import popcorn::pop_json
#
# # First, let's create a User abstraction:
#
# # Serializable user representation.
# class User
#	super RepoObject
#	serialize
#
#	# User login
#	var login: String
#
#	# User password
#	var password: String is writable
#
#	redef fun to_s do return login
# end
#
# # We then need to subclass the `MongoRepository` to provide User specific services:
#
# # User repository for Mongo
# class UserRepo
#	super MongoRepository[User]
#
#	# Find a user by its login
#	fun find_by_login(login: String): nullable User do
#		var q = new JsonObject
#		q["login"] = login
#		return find(q)
#	end
# end
#
# # The repository can then be used with User instances:
#
# # Init database
# var mongo = new MongoClient("mongodb://mongo:27017/")
# var db = mongo.database("tests")
# var coll = db.collection("test_pop_repo_{100000.rand}")
#
# # Create a user repo to store User instances
# var repo = new UserRepo(coll)
#
# # Create some users
# repo.save(new User("Morriar", "1234"))
# repo.save(new User("Alex", "password"))
#
# assert repo.find_all.length == 2
# assert repo.find_by_login("Morriar").password == "1234"
# repo.clear
# assert repo.find_all.length == 0
# ~~~
class MongoRepository[E: Serializable]
	super JsonRepository[E]

	redef type QUERY: JsonObject

	# MongoDB collection used to store objects
	var collection: MongoCollection

	redef fun find_by_id(id) do
		var query = new JsonObject
		query["_id"] = id
		return find(query)
	end

	redef fun find(query) do
		var res = collection.find(query)
		if res == null then return null
		return deserialize(res.to_json)
	end

	redef fun find_all(query, skip, limit) do
		var res = new Array[E]
		for e in collection.find_all(query or else new JsonObject, skip, limit) do
			res.add deserialize(e.to_json).as(E)
		end
		return res
	end

	redef fun count(query) do
		return collection.count(query or else new JsonObject)
	end

	redef fun save(item) do
		var json = serialize(item).as(String)
		var obj = json.parse_json.as(JsonObject)
		return collection.save(obj)
	end

	redef fun remove_by_id(id) do
		var query = new JsonObject
		query["_id"] = id
		return remove(query)
	end

	redef fun remove(query) do
		return collection.remove(query or else new JsonObject)
	end

	redef fun remove_all(query) do
		return collection.remove_all(query or else new JsonObject)
	end

	redef fun clear do return collection.drop

	# Perform an aggregation query over the repo.
	fun aggregate(pipeline: JsonArray): Array[E] do
		var res = new Array[E]
		for obj in collection.aggregate(pipeline) do
			var instance = deserialize(obj.to_json)
			if instance == null then continue
			res.add instance
		end
		return res
	end
end
lib/popcorn/pop_repos.nit:253,1--373,3