qml 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 481b84b8d826ec6fd5a2f307d8edfe4f33ad3d8f
-  data.tar.gz: d4394d24401e9b9c4d244b240670d46ec063d28c
+  metadata.gz: c3e17be31c7cb2d6c9530581484a9146c71718e1
+  data.tar.gz: 0fa4538a3960c37c4afe368986e0d1565ce401c5
 SHA512:
-  metadata.gz: 0b0219afde5a224d1018d1561571f5667da11aa4716f37720a3d85df8addbd52de3687924ff2c7fa3c508b7cb60e2f000928f600da3f8e983a72463436e99ed8
-  data.tar.gz: eec31c2af2ca479301637ea4b87cf6dd29e0968a80d2b2278e5dc6078a86e641e8d2f7e7ce68c4febbf24114a31a138b9470bef2a3469d2994c074138e51f606
+  metadata.gz: 643d0c001ba1f018b5784ab472cd789278be85721678c5b4c5dbd1edd9e89beb46b585fa273b12da771594b7d3f6ac147b28ea4e7f72ec4835babe125e08e836
+  data.tar.gz: 3fdc78678a5790c2123869b66905b40bc24613a6d47cfecbdf322be58ac403d3f60007e9d4856a44b15d64698639d4b6d95b6cc61844fa66610f2322e7fdcf16

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ext/qml/lib/libqmlbind"]
+	path = ext/qml/lib/libqmlbind
+	url = https://github.com/seanchas116/libqmlbind.git

data/.travis.yml

@@ -1,17 +1,13 @@
 language: ruby
 rvm:
-  - 2.2.0-rc1
-  - 2.1.2
-  - 2.0.0
-  - 1.9.3
+  - 2.2.2
+  - 2.1.6
 before_install:
-  - sudo apt-add-repository -y ppa:beineri/opt-qt521
-  - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+  - sudo apt-add-repository -y ppa:beineri/opt-qt541
   - sudo apt-get update
-  - sudo apt-get install -y g++-4.7 libffi-dev qt52base qt52declarative
-  - sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.7 90
+  - sudo apt-get install -y qt54base qt54declarative
 before_script:
-  - source /opt/qt52/bin/qt52-env.sh
+  - source /opt/qt54/bin/qt54-env.sh
   - cd ext/qml
   - bundle exec ruby extconf.rb
   - make

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Ryohei Ikegami
+Copyright (c) 2014-2015 Ryohei Ikegami
 
 MIT License
 

data/README.md

@@ -15,7 +15,7 @@ It provides bindings between QML and Ruby and enables you to use Qt Quick-based
 
 ## What you can do with ruby-qml
 
-* Develop desktop GUI applications only with Ruby and QML
+* Develop desktop GUI applications only with Ruby and QML / JavaScript
 * Easily combine codes written in C++ and Qt with your Ruby code
 
 ## Gallery
@@ -28,27 +28,24 @@ It provides bindings between QML and Ruby and enables you to use Qt Quick-based
 
 ### Requirements
 
-* **Ruby 1.9 or later**
+* **Ruby 2.1 or later**
 * **OS X or Linux**
-* pkg-config
-* libffi
 * Qt 5.2 or later
 
 ### OS X with Homebrew
 
 To install ruby-qml on OS X with Homebrew, run the following commands:
 
-    $ brew install pkg-config libffi qt5
-    $ gem install qml -- --with-libffi-dir=$(brew --prefix libffi) --with-qt-dir=$(brew --prefix qt5)
+    $ brew install qt5
+    $ gem install qml -- --with-qmake=$(brew --prefix qt5)/bin/qmake
 
 Both libffi and Qt5 are keg-only in Homebrew, so you must specify their paths explicitly (or force linking).
 
 If you use [official Qt installation](http://qt-project.org/downloads), for example:
 
-    $ brew install pkg-config libffi
-    $ gem install qml -- --with-libffi-dir=$(brew --prefix libffi) --with-qt-dir=$HOME/Qt/5.3/clang_64
+    $ gem install qml -- --with-qmake=$HOME/Qt/5.4/clang_64/bin/qmake
 
-The Qt installation path (`$HOME/Qt/5.3/clang_64` in this example) depends on your Qt installation configuration and Qt version.
+The Qt installation path (`$HOME/Qt/5.4/clang_64` in this example) depends on your Qt installation configuration and Qt version.
 
 ### General (OSX and Linux)
 
@@ -56,10 +53,8 @@ The Qt installation path (`$HOME/Qt/5.3/clang_64` in this example) depends on yo
 
 #### Options
 
-* `--with-libffi-dir=[dir]`
-  * libffi installation directory (optional).
-* `--with-qt-dir=[dir]`
-  * Qt installation directory (optional).
+* `--with-qmake=[dir]`
+  * Qt qmake executable path (optional).
 
 ### Use Gemfile
 
@@ -74,7 +69,7 @@ And then execute:
 To pass build options, use `bundle config`.
 For example:
 
-    $ bundle config build.qml --with-libffi-dir=$(brew --prefix libffi) --with-qt-dir=$(brew --prefix qt5)
+    $ bundle config build.qml --with-qmake=$(brew --prefix qt5)/bin/qmake
 
 The configuration will be saved in `~/.bundle/config`.
 
@@ -122,8 +117,8 @@ class FizzBuzz
   include QML::Access
   register_to_qml under: "Example", version: "1.0"
 
-  property :input, '0'
-  property :result , ''
+  property(:input) { '0' }
+  property(:result) { '' }
   signal :inputWasFizzBuzz, []
 
   on_changed :input do
@@ -204,32 +199,15 @@ module Example
 end
 ```
 
-If the Ruby object is singleton, you can use the root context to make it available to QML.
-In this case, you don't have to use `register_to_qml`.
-
-```ruby
-class Foo
-  include QML::Access
-  def foo
-    puts "foo"
-  end
-end
-
-QML.run do |app|
-  app.context[:foo] = Foo.new
-  app.load_path Pathname(__FILE__) + '../main.qml'
-end
-```
-
 ### Pass data to QML ListModels
 
 To bind list data between QML ListView and Ruby, you can use ListModels.
 
-* `QML::Data::ListModel` - the base class for ruby-qml list models.
+* `QML::ListModel` - the base class for ruby-qml list models.
 
-* `QML::Data::ArrayModel` - provides a simple list model implementation using Array.
+* `QML::ArrayModel` - provides a simple list model implementation using Array.
 
-* `QML::Data::QueryModel` - for databases (like ActiveRecord, Sequel or something)
+* `QML::QueryModel` - for databases (like ActiveRecord, Sequel or something)
 
 This example uses `ArrayModel` to provide list data for a QML ListView.
 When the content of the ArrayModel is changed, the list view is also automatically updated.
@@ -244,7 +222,7 @@ class TodoController
   include QML::Access
   register_to_qml under: "Example", version: "1.0"
 
-  property :model, QML::Data::ArrayModel.new(:title, :description, :due_date)
+  property(:model) { QML::ArrayModel.new(:title, :description, :due_date) }
 
   def add(title, description, due_date)
     # Items of list models must be "Hash-like" (have #[] method to get columns)
@@ -253,7 +231,6 @@ class TodoController
       description: description,
       due_date: due_date
     }
-    p item
     model << item
   end
 end
@@ -275,7 +252,7 @@ TodoController {
 ### Combile asynchronous operations
 
 In QML, all UI-related operations are done synchronously in the event loop.
-To set result of asynchronous operations to the UI, use `QML.later` or `QML::Dispatchable#later`.
+To set result of asynchronous operations to the UI, use `QML.next_tick`.
 
 #### Examples
 
@@ -284,11 +261,10 @@ To set result of asynchronous operations to the UI, use `QML.later` or `QML::Dis
 ```ruby
 # Ruby
 class HeavyTaskController
-  # QML::Access includes QML::Dispathable
   include QML::Access
   register_to_qml under: "Example", version: "1.0"
 
-  property :result, ''
+  property(:result) { '' }
 
   def set_result(result)
     self.result = result
@@ -296,9 +272,7 @@ class HeavyTaskController
 
   def start_heavy_task
     Thread.new do
-      self.later.set_result do_heavy_task() # #set_result is called in the main thread in the next event loop
-      # or
-      QML.later do
+      QML.next_tick do
         set_result do_heavy_task()
       end
     end
@@ -320,64 +294,77 @@ HeavyTaskController {
 }
 ```
 
-### Use Qt objects in Ruby
+### Value conversions between Ruby and QML JavaScript
+
+
+#### Ruby to QML
+
+|Ruby            |QML/JavaScript                  |
+|----------------|--------------------------------|
+|nil             |null                            |
+|true/false      |boolean                         |
+|Numeric         |number                          |
+|String/Symbol   |string                          |
+|Array           |Array                           |
+|Hash            |plain Object                    |
+|Proc            |Function                        |
+|Time            |Date                            |
+|QML::Access     |Object(QObject derived)         |
+|QML::ListModel  |Object(QAbstractListModel)      |
 
-In ruby-qml, Qt objects (QObject-derived C++ objects and QML objects) can be accessed from Ruby via the meta-object system of Qt.
+You can customize this by implementing `#to_qml` method.
 
-You can access:
+#### QML to Ruby
 
-* Properties
-* Signals
-* Slots (as methods), Q_INVOKAVLE methods, QML methods
+|QML/JavaScript                  |Ruby            |
+|--------------------------------|----------------|
+|null/undefined                  |nil             |
+|boolean                         |true/false      |
+|number                          |Float           |
+|string                          |String          |
+|Array                           |QML::JSArray    |
+|Function                        |QML::JSFunction |
+|Object                          |QML::JSObject   |
+|Object wrapping QML::Access     |QML::JSWrapper  |
 
-You cannot access:
+You can convert Objects further through QML::JSObject methods.
 
-* Normal C++ member functions
 
-If their names are camelCase in Qt, ruby-qml aliases them as underscore_case.
+### QML::JSObject usage
+
+`QML::JSObject` is the wrapper class for JavaScript objects.
 
 ```ruby
-# QML::Application is a wrapper for QApplication
-app = QML.application
+obj = QML.engine.evaluate <<-JS
+  ({
+    value: 1,
+    add: function(d) {
+      this.value += d;
+    }
+  })
+JS
 
-# set property
-app.applicationName = "Test"
-app.application_name = "Test" # aliased version
+# Getter
+obj.value #=> 1
 
-# connect to signal
-app.aboutToQuit.connect do # "about_to_quit" is also OK
-  puts "quitting..."
-end
+# Setter
+obj.value = 2
+obj.vaue #=> 2
 
-# call method (slot)
-app.quit
-```
+# Call method if the property is a function
+obj.add(10)
+obj.value #=> 11
 
-### Value conversions
-
-The following types are automatically converted between Ruby and QML:
-
-* Integer
-* Double
-* String
-* Time
-* Date
-* DateTime
-* Array
-* Hash
-* QML::Geometry::Point (QPoint, QPointF)
-* QML::Geometry::Size (QSize, QSizeF)
-* QML::Geometry::Rectangle (QRect, QRectF)
-* QML::QtObjectBase (Qt objects)
-* QML::Access
-* QML::Data::ListModel
+# Subscription
+obj[:value] #=> 11
+obj[:add] #=> #<QML::JSFunction:...>
+```
 
 ### Load and use Qt C++ plugins
 
 `PluginLoader` loads Qt C++ plugins.
 It enables you to use your Qt C++ codes from Ruby easily.
 
-
 ```c++
 // C++ - plugin example
 class MyPlugin : public QObject
@@ -398,42 +385,18 @@ public slots:
 
 ```ruby
 # Ruby
+
+# The instance will be a `QML::JSObject` which represents the plugin Qt object
 plugin = QML::PluginLoader.new(directory, "myplugin").instance
 
-plugin.added.connect do |value|
+# Connect to signal (see http://doc.qt.io/qt-5/qtqml-syntax-signals.html#connecting-signals-to-methods-and-signals)
+plugin[:added].connect do |value|
   puts "added value: #{value}"
 end
 
 plugin.add(1, 2) #=> 3
 ```
 
-### Garbage collection
-
-To support garbage collection of Qt objects used in ruby-qml,
-`#managed?` attribute of each Qt object wrappr determines its memory management status.
-
-#### Managed objects
-
-*Manged objects* are managed by Ruby and QML and garbage collected when no longer reachable.
-All objects created inside QML and objects returned from C++ methods will be *managed* by default.
-
-#### Unmanaged objects
-
-*Unmanaged* objects are not managed and never garbage collected.
-Objects that have parents or that obtained from properties of other Qt objects will be *unmanaged* by default.
-
-#### Specify management status explicitly
-
-The `#managed?` method returns whether the object is managed or not.
-The `#prefer_managed` methods sets management status safely
-(e.g., objects that are created by QML will remain managed and objects that have parents will remain unmanaged).
-
-```ruby
-plugin = PluginLoader.new(path).instance
-obj = plugin.create_object
-obj.prefer_managed false
-```
-
 ### Use with EventMachine
 
 You can use [EventMachine](https://github.com/eventmachine/eventmachine) with ruby-qml.
@@ -464,7 +427,7 @@ require 'em-http-request'
 
 class Controller
   include QML::Access
-  property :result, ''
+  property(:result) { '' }
 
   def get
     EM.synchrony do
@@ -489,6 +452,13 @@ end
 
 ## Contributing
 
+### Init submodules
+
+```
+$ git submodule init
+$ git submodule update
+```
+
 ### Install dependencies
 
 ```
@@ -502,7 +472,7 @@ To build it, run the following commands:
 
 ```
 $ cd ext/qml
-$ bundle exec ruby extconf.rb --with-qt-dir=/path/to/qt --with-libffi-dir=/path/to/libffi
+$ bundle exec ruby extconf.rb --with-qmake=/path/to/qmake
 $ make -j4
 ```
 

data/changes.md

@@ -1,3 +1,8 @@
+## 1.0.0 (2015-06-16)
+
+* A lot of changes (see examples and docs)
+* Now uses [libqmlbind](https://github.com/seanchas116/libqmlbind)
+
 ## 0.0.7 (2014-12-25)
 
 * Support Ruby 2.2 (rc1) and Qt 5.4

data/examples/fizzbuzz/fizzbuzz.rb

@@ -8,9 +8,10 @@ module Examples
 
     class FizzBuzz
       include QML::Access
+      register_to_qml
 
-      property :input, '0'
-      property :result , ''
+      property(:input) { '0' }
+      property(:result) { '' }
       signal :inputWasFizzBuzz, []
 
       on_changed :input do
@@ -32,8 +33,6 @@ module Examples
         puts "quitting..."
         QML.application.quit
       end
-
-      register_to_qml
     end
   end
 end

data/examples/todo_array/todo_array.rb

@@ -10,10 +10,10 @@ module Examples
       include QML::Access
       register_to_qml
 
-      property :title, ''
-      property :description, ''
-      property :due_date, ''
-      property :model, QML::Data::ArrayModel.new(:title, :description, :due_date)
+      property(:title) { '' }
+      property(:description) { '' }
+      property(:due_date) { '' }
+      property(:model) { QML::ArrayModel.new(:title, :description, :due_date) }
 
       def add
         item = {

data/examples/todo_sequel/todo_sequel.rb

@@ -12,10 +12,10 @@ module Examples
       primary_key :id
       String :title
       String :description
-      Date :due_date
+      Time :due_date
     end
 
-    class SequelModel < QML::Data::QueryModel
+    class SequelModel < QML::QueryModel
       attr_accessor :dataset
 
       def initialize(dataset)
@@ -42,14 +42,14 @@ module Examples
         self.model = SequelModel.new(@todo_dataset)
       end
 
-      property :title, ''
-      property :description, ''
-      property :due_date, ''
-      property :order_by, ''
+      property(:title) { '' }
+      property(:description) { '' }
+      property(:due_date) { '' }
+      property(:order_by) { '' }
       property :model
 
       def add
-        @todo_dataset.insert(title: title, description: description, due_date: due_date)
+        @todo_dataset.insert(title: title, description: description, due_date: due_date.to_time)
         model.update
       end