motion-realm 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a15ecd791d1c966a720c45c29448c2be273cd4fc
+  data.tar.gz: d70a0d971061f8b6ed50a7534b54925804cde2b9
+SHA512:
+  metadata.gz: a1130480e8fa233851ef5da1f9910a95840eb8a29d148db8ca5f2ef6d726afe7372bbde7c66fedae4be8290735b08b0e8274c709f759ecf2e56578f8f9b90625
+  data.tar.gz: d8d5274581d12cc6ebba30ca367b8e3842ff8e375d94dc7fd299b9a5f0347c817091a9dae980859e63adc4c53eeaa76367c31c7a0ddaff637eb5f6c12110fc8c

data/README.md

@@ -0,0 +1,264 @@
+# motion-realm
+
+`motion-realm` gem has been made to Rubyfy Realm's syntax. You will
+still need to read some Realm's docs in order to understand how it works. Also because
+of Realm's specific, we still have to vendor Objective-C schema files.
+
+## Realm setup
+
+I would suggest compiling Realm from their sources available at https://github.com/realm/realm-cocoa
+
+`git clone https://github.com/realm/realm-cocoa`
+`cd realm-cocoa`
+`sh build.sh build`
+
+When build will be finished, copy `build/ios/Realm.framework` into your app's `vendor/realm` folder. Don't forget to create `schemas` folder that will contain your DB schema definitions.
+
+Now we need to tell Rubymotion to include realm and schemas. In your `Rakefile` add:
+
+`app.libs << '/usr/lib/libc++.dylib'`
+`app.external_frameworks << 'vendor/realm/Realm.framework'`
+`app.vendor_project 'schemas', :static, :cflags => '-F ../vendor/realm/'`
+
+You can start using Realm in your project now.
+
+## motion-realm installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-realm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-realm
+
+## Usage
+
+### Schemas and Models
+
+Your schemas should be defined in `/schemas` folder. Unfortunately because of
+the Realm's specific we will have to use Objective-C here. You can check Realm's docs on models at https://realm.io/docs/objc/latest/#models
+
+`schemas/schema.h`
+
+```objective-c
+#import <Realm/Realm.h>
+
+@class Parent;
+
+@interface Child : RLMObject
+
+@property BOOL          likes_math;
+@property NSInteger     favourite_number;
+@property NSString     *name;
+@property NSString     *sex;
+@property NSDate       *birthday;
+@property NSData       *some_data;
+
+@property Parent *parent;
+
+@end
+
+RLM_ARRAY_TYPE(Child)
+
+@interface Parent : RLMObject
+
+@property NSString     *job;
+@property NSString     *name;
+@property NSString     *sex;
+@property NSDate       *birthday;
+@property BOOL          likes_ruby;
+@property NSInteger     apps_in_appstore;
+@property NSData       *some_data;
+
+@property RLMArray<Child *> <Child> *children;
+
+@end
+```
+
+And don't forget about implementation `.mm` file:
+
+`schemas/schema.mm`
+
+```objective-c
+#import "schema.h"
+
+@implementation Child
+@end
+
+@implementation Parent
+@end
+```
+
+Now when we have schema defined, we can create `app/models/child.rb` and
+`app/models/parent.rb`:
+
+```ruby
+class Child
+  # it is important to include MotionRealm module in your model classes:
+  include MotionRealm
+
+  # if you want to set some default values, do it in this method:
+  def self.default_values
+    {
+      likes_math: true,
+    }
+  end
+
+  # indexes can be defined here:
+  def self.indexes
+    ["name", "favourite_number"]
+  end
+
+  # primary key, if needed:
+  def self.primary_key
+    "name"
+  end
+end
+
+class Parent
+  include MotionRealm
+end
+```
+
+This is it! Schema and Models were defined, and everything is ready for usage!
+
+### Create/Read/Update/Delete
+
+```ruby
+# create in-memory objects:`
+child = Child.new
+child.name = "John"
+
+parent = Parent.create name: "Jack"
+parent.children << child
+
+# persist them:
+RLMRealm.write do |realm|
+  realm << child
+  realm << parent
+end
+
+# find objects:
+parent = Parent.where("name = 'Jack'").first
+
+# or using predicates:
+predicate = NSPredicate.predicateWithFormat "name == %@", "some cool name"
+cool_parents = Parent.with_predicate predicate
+
+# we have to update objects inside write block only:
+RLMRealm.write do |realm|
+  parent.name = 'Jack Smith'
+end
+
+# delete objects:
+parent.delete
+
+# or
+RLMRealm.write do |realm|
+  realm.delete parent
+end
+
+# delete all objects:
+RLMRealm.write do |realm|
+  realm.delete_all
+end
+
+# or all objects for a given class:
+Parent.delete_all
+```
+
+### Saving objects
+
+```ruby
+result = RLMRealm.write do |realm|
+  # add objects to realm, update objects, delete them here
+end
+# result is a Hash: { saved: true/false, error: error_if_any }
+
+
+# RLMRealm.write is just a shorthand for:
+realm = RLMRealm.default
+realm.start_writing
+  # add objects to realm, update objects, delete them here
+realm.end_writing
+```
+
+By default if you are going to save an object without setting all its properties
+to some value, they will be set to:
+
+- Number or Mixed property to 0
+- Array properties to []
+- All other properties will be set to Nil.
+
+If you want to change this behaviour, you can use class method `default_values`.
+For example:
+
+```ruby
+def self.default_values
+  {
+    bool_prop: true,
+    int_prop: 1
+  }
+end
+```
+
+### Notifications
+
+You can post notifications each time realm data has been updated. To do it
+just tell your realm that you want to add a notification:
+
+```ruby
+@notification_token = realm.add_notification do |notification, realm|
+  # some your actions here
+end
+```
+
+Don't forget to remove it when you won't need it anymore with:
+
+```ruby
+realm.remove_notification @notification_token
+```
+
+## Migrations
+
+Sometimes we have to update DB schema. Realm's docs describe it very well at https://realm.io/docs/objc/latest/#migrations
+
+To migrate your DB to a newer schema version, you can use `RLMRealmConfiguration.migrate_to_version(new_version, &block)` method.
+
+It is a good idea to use non-nested `if` conditions, because some users
+may update your app rarely, and they may accidentally skip migration from X to Y
+schema version:
+
+```ruby
+RLMRealmConfiguration.migrate_to_version(3) do |migration, old_version|
+  migration.enumerate "Parent" do |old_object, new_object|
+    # user has not updated his app to the 1st schema version yet:
+    if old_version < 1
+      # migrate the object to 1st version
+    end
+
+    # user had 1st version of the schema already:
+    if old_version < 2
+      # migrate the object to the 2nd version
+    end
+
+    # user had latest available schema. Update him to a newer one:
+    if old_version < 3
+      # migrate the object to the 3rd version
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/motion-realm.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
+end

data/lib/project/motion-realm.rb

@@ -0,0 +1,101 @@
+module MotionRealm
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def create(opts={})
+      # # Does not work correct in current version of RM or Realm:
+      # self.alloc.initWithValue opts
+
+      object = self.new
+      opts.each do |key, value|
+        method_name = "set" + key.to_s.capitalize
+        method_name = key.to_s + "="
+
+        # object.performSelector method_name, withObject: value
+        object.send(method_name, value)
+      end
+
+      object
+
+    end
+
+    def count
+      all.count
+    end
+
+    def first
+      all.first
+    end
+
+    def last
+      all.last
+    end
+
+    def defaultPropertyValues
+      # set all properties to nil
+      values = {}
+
+      self.schema.properties_by_name.each do |name, property|
+        values[name] = if default_values[name]
+          default_values[name]
+        elsif property.bool?
+          false
+        elsif property.number? || property.mixed?
+          0
+        elsif property.array?
+          []
+        else
+          nil
+        end
+      end
+
+      values
+    end
+
+    def default_values
+      {}
+    end
+
+    def indexedProperties
+      indexes
+    end
+
+    def indexes
+      []
+    end
+
+    def primaryKey
+      primary_key
+    end
+
+    def primary_key
+      nil
+    end
+
+    def where(query)
+      self.objectsWhere(query)
+    end
+
+    def create_or_update(object, realm=nil)
+      if realm.nil?
+        realm = RLMRealm.default
+      end
+
+      self.createOrUpdateInRealm realm, withValue: object
+    end
+
+    def delete_all
+      RLMRealm.write do |realm|
+        self.all.each { |object| realm.delete(object) }
+      end
+    end
+  end
+
+  def delete
+    RLMRealm.write do |realm|
+      realm.delete(self)
+    end
+  end
+end

data/lib/project/realm/array.rb

@@ -0,0 +1,5 @@
+class RLMArray
+  def <<(object)
+    self.addObject(object)
+  end
+end

data/lib/project/realm/migration.rb

@@ -0,0 +1,6 @@
+class RLMMigration
+  def enumerate(class_name, &block)
+    # block should accept two variables: old_object and new_object
+    self.enumerateObjects class_name, block: block
+  end
+end

data/lib/project/realm/object.rb

@@ -0,0 +1,16 @@
+class RLMObject
+  class << self
+    alias :schema :sharedSchema
+    alias :all :allObjects
+  end
+
+  def self.with_predicate(predicate)
+    self.objectsWithPredicate(predicate)
+  end
+
+  def save
+    RLMRealm.write do |realm|
+      realm << self
+    end
+  end
+end

data/lib/project/realm/object_schema.rb

@@ -0,0 +1,3 @@
+class RLMObjectSchema
+  alias :properties_by_name :propertiesByName
+end

data/lib/project/realm/property.rb

@@ -0,0 +1,78 @@
+class RLMProperty
+
+  # Primitives
+
+  def int?
+    type == RLMPropertyTypeInt
+  end
+
+  def bool?
+    type == RLMPropertyTypeBool
+  end
+
+  def float?
+    type == RLMPropertyTypeFloat
+  end
+
+  def double?
+    type == RLMPropertyTypeDouble
+  end
+
+  def number?
+    int? || float? || double?
+  end
+
+  # Objects
+
+  def string?
+    type == RLMPropertyTypeString
+  end
+
+  def data?
+    type == RLMPropertyTypeData
+  end
+
+  def mixed?
+    type == RLMPropertyTypeAny
+  end
+
+  def date?
+    type == RLMPropertyTypeDate
+  end
+
+  # Arrays/Linked types
+
+  def object?
+    type == RLMPropertyTypeObject
+  end
+
+  def array?
+    type == RLMPropertyTypeArray
+  end
+
+  def type_name
+    if int?
+      :int
+    elsif bool?
+      :bool
+    elsif float?
+      :float
+    elsif double?
+      :double
+    elsif string?
+      :string
+    elsif data?
+      :data
+    elsif mixed?
+      :mixed
+    elsif date?
+      :date
+    elsif object?
+      :object
+    elsif array?
+      :array
+    else
+      nil
+    end
+  end
+end

data/lib/project/realm/realm.rb

@@ -0,0 +1,41 @@
+class RLMRealm
+  class << self
+    alias :default :defaultRealm
+  end
+
+  alias :start_writing :beginWriteTransaction
+
+  alias :delete_all :deleteAllObjects
+
+
+  def end_writing(error_ptr=nil)
+    self.commitWriteTransaction(error_ptr)
+  end
+
+  def delete(object)
+    self.deleteObject(object)
+  end
+
+  def add_notification(&block)
+    self.addNotificationBlock(block)
+  end
+
+  def remove_notification(token)
+    self.removeNotification(token)
+  end
+
+  def self.write(&block)
+    realm = RLMRealm.defaultRealm
+    error_ptr = Pointer.new(:object)
+
+    realm.start_writing
+    block.call(realm)
+    saved = realm.end_writing(error_ptr)
+
+    { saved: saved, error: error_ptr[0] }
+  end
+
+  def <<(object)
+    self.addObject(object)
+  end
+end

data/lib/project/realm/realm_configuration.rb

@@ -0,0 +1,19 @@
+class RLMRealmConfiguration
+  class << self
+    alias :default :defaultConfiguration
+  end
+
+  alias :schema_version :schemaVersion
+
+  def schema_version=(new_version)
+    self.schemaVersion = new_version
+  end
+
+  def self.migrate_to_version(version, &block)
+    config = self.default
+    config.schema_version = version
+
+    config.migrationBlock = block
+    RLMRealmConfiguration.setDefaultConfiguration(config)
+  end
+end

data/lib/project/realm/results.rb

@@ -0,0 +1,19 @@
+class RLMResults
+  alias :first :firstObject
+  alias :last :lastObject
+  alias :where :objectsWhere
+
+  def [](index)
+    self.objectAtIndex(index)
+  end
+
+  def sort_by(property, opts={})
+    ascending = if opts[:asc].nil?
+      true
+    else
+      opts[:asc]
+    end
+
+    self.sortedResultsUsingProperty property, ascending: ascending
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: motion-realm
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Kyrylo Savytskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Realm for Rubymotion
+email:
+- mail@savytskyi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-realm.rb
+- lib/project/motion-realm.rb
+- lib/project/realm/array.rb
+- lib/project/realm/migration.rb
+- lib/project/realm/object.rb
+- lib/project/realm/object_schema.rb
+- lib/project/realm/property.rb
+- lib/project/realm/realm.rb
+- lib/project/realm/realm_configuration.rb
+- lib/project/realm/results.rb
+homepage: https://github.com/savytskyi/motion-realm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Realm for Rubymotion
+test_files: []