Skip to content

Latest commit

 

History

History
439 lines (309 loc) · 9.97 KB

README.md

File metadata and controls

439 lines (309 loc) · 9.97 KB

Build Status Code Climate Couchmotion

A gem for integration couchbase-lite-android and couchbase-lite-ios into a RubyMotion application.

Not maintained anymore

This Gem is currently not maintained anymore. If anybody wants to maintain the Gem and implement some Features you welcome to do it!!

Setup

IOS

Add to your Gemfile:

gem 'couchmotion', :git => 'git://github.com/jannishuebl/couchmotion.git'
bundle install

Setup motion-cocoapods:

pod setup

Install pods:

rake pod:install

Setup database by adding following line to your startup-code of your app:

CouchDB.open 'Databasename'

Android

Add to your Gemfile:

gem 'couchmotion', :git => 'git://github.com/jannishuebl/couchmotion.git'
bundle install

Install Maven:
Maven has to be installed, for details see: https://github.com/HipByte/motion-maven

brew install maven

Add maven-repository:

Add couchbase-repository to your ~/.m2/settings.xml: http://files.couchbase.com/maven2 Create the ~/.m2/settings.xml if it does not exists.

My settings.xml looks like:

<settings>
  <profiles>
    <profile>
      <id>couchmotion</id>
      <repositories>
        <repository>
          <id>couchbase</id>
          <name>the repository for couchdb</name>
          <url>http://files.couchbase.com/maven2</url>
        </repository>
      </repositories>
    </profile>
  </profiles>

  <activeProfiles>
    <activeProfile>couchmotion</activeProfile>
  </activeProfiles>
</settings>

Install maven-dependencies:

rake maven:install

Setup database by adding following lines to onCreate-method of MainActivity:

CouchDB.open 'Databasename', self.getApplicationContext

Example:

class MainActivity < Android::App::Activity

  def onCreate(savedInstanceState)
    super savedInstanceState
    CouchDB.open 'Databasename', self.getApplicationContext
    true
  end

end

Usage

Open/Create Database

Please refer to usage guide for opening a couchdb on Android and IOS. This is the only thing that should be different on the plattforms.

Create a Document

  document = CouchDB.create_document

Get a Document by id

  document = CouchDB.document_by('your-id')

Working with Documents

>>document = CouchDB.create_document
=> #<AndroidDocument:0x31d00025>
  # add properties by hash and save the Document
>>document.put({name:'value of property :name of the Document..'})
=> "effb030a-a483-40e8-bc42-bac9abfa80c8"

>>document = CouchDB.document_by("effb030a-a483-40e8-bc42-bac9abfa80c8")
  
  # get property by key (must be a Symbol)
>>id = document.property_for(:_id)
=> "effb030a-a483-40e8-bc42-bac9abfa80c8" 
>>name = document.property_for(:name)
=> "value of property :name of the Document.."

  # get a hash of all properties
>>properties_as_hash = document.properties
=> {:_id=>"effb030a-a483-40e8-bc42-bac9abfa80c8", :_rev=>"1-aa795a38d952089aea79ea82fb618d39", :name=>"value of property :name of the Document.."}

Working with Views, Querys and Enumerator

Given database contains following documents:

  {string: 'string1', document: 1}
  {string: 'string2', document: 2}
  {string: 'string1', document: 3}
  {string: 'string3', document: 4}
  {integer: 123, document: 5}
  {integer: 123, document: 6}
  {integer: 321, document: 7}
  {integer: 987, document: 8}
  {float: 12.3, document: 9}
  {float: 12.3, document: 10}
  {float: 3.21, document: 11}
  {float: 9.87, document: 12}

Define a View without reduce block:

  view = CouchDB.view_by 'test-view'

  view.map do |document, emitter|

    if document.property_for(:string)
      emitter.emit document.property_for(:string), nil
    end
  end
  view.version 1

Create a Query and add searchkeys

  view = database.view_by 'test-view'

  query = view.create_query
  
  query.with_key = 'string1'

  enumerator = query.execute
  enumerator.map do | key, document |
    # will be :
    # {string: 'string1', document: 1}
    # {string: 'string1', document: 3}
  end

  query = view.create_query
  
  query.with_keys = ['string1', 'string2']

  enumerator = query.execute
  enumerator.map do | key, document |
    # will be :
    # {string: 'string1', document: 1}
    # {string: 'string2', document: 2}
    # {string: 'string1', document: 3}
  end

For now you can only search for keys. For example start- and endkey are not implemented yet, you are welcome to do this ;)

Define a View with reduce block:

  view = database.view_by 'test-view'

  view.map do |document, emitter|

    if document.property_for(:integer)
      emitter.emit document.property_for(:integer), nil
    end
  end

  view.reduce do |keys, values, rereduce|
      # e.g. do summing up somthing
      reduce_value = 0
      keys.each { |x| reduce_value = reduce_value + x}
      reduce_value
    end
  view.version 1

  enumerator = view.create_query.execute
  # should be 1554 ;)
  puts enumerator.reduce_value

Development

Testing Couchmotion API for Android, iOS and DoubleDB

All tests that belong to Classes which are used in the API part of this gem should be put to the ./specs directory.

There should be 4 kinds of tests:

AbstractTest:

should be placed in the ./abstract_specs/abstract_*classToTest*_spec.rb directory

In this spec-file the tests are implemented, all plattform dependencies have to be included in methods. In the AbstractTest the method should throw a NotImplementedError. Instead of the describe method call the shared method.

Example:

shared 'AbstractCouchDB' do
  it 'should create a new document' do
    database = set_up_database

    document = database.create_document

    expect(document).to be_kind_of document_class

    database.destroy
  end

  it 'should get a document by id' do
    database = set_up_database

    old_document = database.create_document
    old_document.put({name:123})

    id = old_document.property_for :_id

    new_document = database.document_with id

    expect(new_document).to be_kind_of document_class
    expect(new_document.property_for(:name)).to eq 123

    database.destroy
  end

  def set_up_database
    raise NotImplementedError
  end

  def document_class
    raise NotImplementedError
  end
end

AndroidTest:

should be placed in the ./android/android_*classToTest*_spec.rb directory

In this spec-file the specifications for android are added. Sym-link the AbstractTest to ./specs/android/abstract_specs:

cd specs/android/abstract_specs
ln -s ../../abstract_specs/abstract_*classToTest*_spec.rb

The AbstractTest is included with behaves_like-method Overwrite the specification before including the AbstractTest!!!

Example:

describe 'AndroidCouchDB' do

  def set_up_database
    CouchDB::AndroidCouchDB.new 'test-db', self.main_activity.getApplicationContext
  end

  def document_class
    CouchDB::Document::AndroidDocument
  end

  behaves_like 'AbstractCouchDB'
end

iOSTest:

should be placed in the ./ios/ios_*classToTest*_spec.rb directory

In this spec-file the specifications for iOS are added. Sym-link the AbstractTest to ./specs/ios/abstract_specs:

cd specs/ios/abstract_specs
ln -s ../../abstract_specs/abstract_*classToTest*_spec.rb

The AbstractTest is incuded with behaves_like-method

Example:

describe 'IOSCouchDB' do

  behaves_like 'AbstractCouchDB'

  def set_up_database
    CouchDB::IOSCouchDB.new 'test-database'
  end

  def document_class
    CouchDB::Document::IOSDocument
  end

end

DoubleTest:

should be placed in the ./double/double_*classToTest*_spec.rb directory

In this spec-file the specifications for the both are added. The AbstractTest is incuded with include_examples-method Do not forget to add the require 'helpers/spec_helper'-statement. Add the AbstractTest to the spec helper(./spec/helpers/spec_helpers.rb) like all other tests.

Example:

require 'helpers/spec_helper'

describe 'DoubleCouchDB' do

  include_examples 'AbstractCouchDB'

  def set_up_database
    CouchDB::DoubleCouchDB.new
  end

  def document_class
    CouchDB::Document::DoubleDocument
  end

end

Please add all specs for all plattforms.

Double CouchDB

There is a Double Database for testing the database logic without a device.

Your spec-file requires double_db:

require_relative '../lib/double/double_db'

Setup the Database with:

CouchDB.open

Use it as a normal implementation.

Goals

First goal is to build a uniform API for Android and iOS therefor all Direct API calls are wrapped. The Wrapper must ensure that the interface of the Android couchdb and iOS couchdb are uniform.

After this is reached couchmotion wants to give the possibility to store OpenStructs and fetch them again. So its can be used as the database layer of a rubymotion application plattform independently.

Example:

class Item < CouchDBObject
end

item = Item.new
item.name = 'MyFantasticName'
item.price = 1.34

id = item.save

item = Item.find_by(id)

Projectstructure

For testing the Android API there is a test project in /android-test-app and there will be one for iOS in /ios-test-app. All tests for the Wrappers around the native couchbase-API should be placed in /android-test-app/spec or /ios-test-app/spec.

For details see https://github.com/jannishuebl/couchmotion/tree/master/android-test-app

All other tests that are not accessing the native API and are using the Wrappers around it should be taken to the /spec folder.

A Mock Wrapper will be added for testing purposes.