qml 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd71ef4746849334db1b91614801963b036e5f9
-  data.tar.gz: 364c1f9e5d2fd15f937dd5ab009982160fdcd121
+  metadata.gz: 31d0f1bbab5b1fa3d4b602baa55fc7df071f65a4
+  data.tar.gz: 4ba0b8cecc4f63b26f2284e56f132d19bd176c2b
 SHA512:
-  metadata.gz: 6843d7ff307be7803b1748943a7cd83ee0a84e29016e9714fbb4545ed4759e94b664c27ac9956deff501823ac9c1f24af768c977833ee91dd8d89b2ec419e58b
-  data.tar.gz: 6eca2b5f9227c63241d1066053d922a9b5309b530476eeb780caa7a2e37be609a004fcb374ddbce3238846d4d03115f405cd1b9574487ea3803cc9e791b78979
+  metadata.gz: 29d4ae1d6ff4f3218cea47dd8d40b0b02441beb1a82f678138618c654dcc9ac0bf71f5cac6c11717ae13a6dc6d43cc1fab7fce3d061b01efe6761a308cba8c10
+  data.tar.gz: cb4a008e7083492d416a09d472668f67dc751db63ffd7d31d97d72726e9ec21610d4562e638c410548aaddedda3a1f2bc533bb2b0e7e021f4b9d77ec01e23ff1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in qml.gemspec
 gemspec name: "qml"
+
+gem 'coveralls', require: false

data/README.md

@@ -1,14 +1,25 @@
 # ruby-qml
 
+[![Gem Version](https://badge.fury.io/rb/qml.svg)](http://badge.fury.io/rb/qml)
 [![Build Status](https://travis-ci.org/seanchas116/ruby-qml.svg?branch=master)](https://travis-ci.org/seanchas116/ruby-qml)
-
-**NOTE: ruby-qml is not yet released as a gem.**
+[![Coverage Status](https://coveralls.io/repos/seanchas116/ruby-qml/badge.png?branch=master)](https://coveralls.io/r/seanchas116/ruby-qml?branch=master)
 
 ruby-qml is a QML / Qt Quick wrapper for Ruby.
 It provides bindings between QML and Ruby and enables you to use Qt Quick-based GUI from Ruby.
 
+* [Documentation](http://rubydoc.info/github/seanchas116/ruby-qml/master/frames)
+* [Examples](https://github.com/seanchas116/ruby-qml/tree/master/examples)
+
+## Gallery
+
+[![Screenshot](https://raw.github.com/seanchas116/ruby-qml/master/examples/todo_sequel/capture.png)](https://github.com/seanchas116/ruby-qml/tree/master/examples/todo_sequel)
+
+[![Screenshot](https://raw.github.com/seanchas116/ruby-qml/master/examples/twitter/capture.png)](https://github.com/seanchas116/ruby-qml/tree/master/examples/twitter)
+
 ## Installation
 
+ruby-qml currently requires **Ruby 2.0 or later**.
+
 ### OS X with Homebrew
 
 Run the following commands to install ruby-qml on OS X with Homebrew:
@@ -59,9 +70,8 @@ QML.application do |app|
 end
 ```
 
-#### main.qml
-
 ```qml
+// main.qml
 import QtQuick 2.2
 import QtQuick.Controls 1.1
 
@@ -82,7 +92,10 @@ By including `QML::Access`, you can also define **properties and signals** in Ru
 Properties are used to bind data between QML and Ruby.
 Signals are used to provide the observer pattern-like notification from Ruby to QML.
 
+![Screenshot](https://raw.github.com/seanchas116/ruby-qml/master/examples/fizzbuzz/capture.png)
+
 ```ruby
+# Ruby
 class FizzBuzz
   include QML::Access
   register_to_qml under: "Example", version: "1.0"
@@ -114,8 +127,7 @@ end
 ```
 
 ```qml
-// main.qml
-
+// QML - main.qml
 import QtQuick 2.2
 import QtQuick.Controls 1.1
 import QtQuick.Layouts 1.1
@@ -196,25 +208,30 @@ To bind list data between QML ListView and Ruby, you can use ListModels.
 
 * `QML::Data::ArrayModel` - provides a simple list model implementation using Array.
 
+* `QML::Data::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.
 
-```ruby
-class TodoModel < QML::Data::ArrayModel
-  column :title, :description, :due_date
-end
+#### Examples
 
+* [Todo example](https://github.com/seanchas116/ruby-qml/tree/master/examples/todo_sequel)
+
+```ruby
+# Ruby
 class TodoController
   include QML::Access
   register_to_qml under: "Example", version: "1.0"
 
-  property :model, TodoModel.new
+  property :model, QML::Data::ArrayModel.new(:title, :description, :due_date)
 
   def add(title, description, due_date)
-    item = OpenStruct.new(
+    # Items of list models must be "Hash-like" (have #[] method to get columns)
+    item = {
       title: title,
       description: description,
-      due_date: due_date)
+      due_date: due_date
+    }
     p item
     model << item
   end
@@ -222,6 +239,7 @@ end
 ```
 
 ```qml
+// QML
 ListView {
     model: todo.model
     delegate: Text {
@@ -233,6 +251,54 @@ 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`.
+
+#### Examples
+
+* [Twitter Example](https://github.com/seanchas116/ruby-qml/tree/master/examples/twitter)
+
+```ruby
+# Ruby
+class HeavyTaskController
+  # QML::Access includes QML::Dispathable
+  include QML::Access
+  register_to_qml under: "Example", version: "1.0"
+
+  property :result, ''
+
+  def set_result(result)
+    self.result = result
+  end
+
+  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
+        set_result do_heavy_task()
+      end
+    end
+  end
+end
+```
+
+```qml
+// QML
+Text {
+  text: controller.result
+}
+Button {
+  text: "Start!!"
+  onClicked: controller.start_heavy_task()
+}
+HeavyTaskController {
+  id: controller
+}
+```
+
 ### Use Qt objects in Ruby
 
 In ruby-qml, Qt objects (QObject-derived C++ objects and QML objects) can be accessed from Ruby via the meta-object system of Qt.
@@ -292,7 +358,7 @@ It enables you to use your Qt C++ codes from Ruby easily.
 
 
 ```c++
-// plugin example
+// C++ - plugin example
 class MyPlugin : public QObject
 {
     Q_OBJECT
@@ -305,6 +371,7 @@ public slots:
 ```
 
 ```ruby
+# Ruby
 plugin = QML::PluginLoader.new(directory, "myplugin").instance
 plugin.foo
 ```
@@ -322,7 +389,7 @@ All objects created inside QML and objects returned from C++ methods will be *ma
 #### Unmanaged objects
 
 *Unmanaged* objects are not managed and never garbage collected.
-Objects that have parents and that obtained from properties of other Qt objects will be *unmanaged* by default.
+Objects that have parents or that obtained from properties of other Qt objects will be *unmanaged* by default.
 
 #### Specify management status explicitly
 
@@ -336,10 +403,6 @@ obj = plugin.create_object
 obj.prefer_managed false
 ```
 
-## Examples
-
-See the `/example` directory.
-
 ## Contributing
 
 Contributions are welcome. When you are contributing to ruby-qml:

data/changes.md

@@ -0,0 +1,17 @@
+# 0.0.2 (2014-07-21)
+
+* Improve list models
+  
+  * Add ArrayModel#replace
+  * Add QueryModel for ORMs
+  * Specify column names in ListModel#initialize
+
+* Add To-do example with [Sequel](http://sequel.jeremyevans.net/)
+
+* Bug fixes
+
+* Improve README
+
+# 0.0.1 (2014-07-19)
+
+* Initial release

data/examples/{todo → todo_array}/main.qml

@@ -55,7 +55,7 @@ ApplicationWindow {
                         text: "\uf073"
                     }
                     Text {
-                        text: due_date
+                        text: Qt.formatDateTime(due_date)
                     }
                 }
             }

data/examples/{todo/todo.rb → todo_array/todo_array.rb}

@@ -6,10 +6,6 @@ module Examples
   module Todo
     VERSION = '0.1'
 
-    class TodoModel < QML::Data::ArrayModel
-      column :title, :description, :due_date
-    end
-
     class TodoController
       include QML::Access
       register_to_qml
@@ -17,13 +13,14 @@ module Examples
       property :title, ''
       property :description, ''
       property :due_date, ''
-      property :model, TodoModel.new
+      property :model, QML::Data::ArrayModel.new(:title, :description, :due_date)
 
       def add
-        item = OpenStruct.new(
+        item = {
           title: title,
           description: description,
-          due_date: due_date)
+          due_date: due_date
+        }
         p item
         model << item
       end

data/examples/todo_sequel/main.qml

@@ -0,0 +1,87 @@
+import QtQuick 2.3
+import QtQuick.Controls 1.2
+import QtQuick.Layouts 1.1
+import Examples.Todo 0.1
+
+ApplicationWindow {
+    visible: true
+    title: "Todo with Sequel"
+
+    FontLoader {
+        source: "../assets/fonts/fontawesome-webfont.ttf"
+    }
+    id: window
+    property int margin: 10
+    width: layout.implicitWidth + 2 * margin
+    height: layout.implicitHeight + 2 * margin
+
+    RowLayout {
+        id: layout
+        anchors.fill: parent
+        anchors.margins: window.margin
+        ColumnLayout {
+            TextField {
+                placeholderText: "Title"
+                id: titleField
+            }
+            TextField {
+                placeholderText: "Description"
+                id: descriptionField
+            }
+            Calendar {
+                id: calendar
+            }
+            Button {
+                text: "Add"
+                onClicked: todo.add()
+            }
+        }
+        ColumnLayout {
+            RowLayout {
+                Label { text: "Sort by" }
+                ComboBox {
+                    id: orderComboBox
+                    model: ListModel {
+                        ListElement { text: "Title"; column: "title" }
+                        ListElement { text: "Description"; column: "description" }
+                        ListElement { text: "Due Date"; column: "due_date" }
+                    }
+                    property string currentColumn: model.get(currentIndex).column
+                }
+            }
+            ListView {
+                model: todo.model
+                spacing: 10
+                Layout.fillWidth: true
+                Layout.fillHeight: true
+                Layout.alignment: Qt.AlignTop
+                Layout.minimumWidth: 300
+                delegate: ColumnLayout {
+                    Text {
+                        font.bold: true
+                        text: title
+                    }
+                    Text {
+                        text: description
+                    }
+                    RowLayout {
+                        Text {
+                            font.family: "FontAwesome"
+                            text: "\uf073"
+                        }
+                        Text {
+                            text: Qt.formatDate(due_date)
+                        }
+                    }
+                }
+            }
+        }
+    }
+    TodoController {
+        id: todo
+        title: titleField.text
+        description: descriptionField.text
+        due_date: calendar.selectedDate
+        order_by: orderComboBox.currentColumn
+    }
+}

data/examples/todo_sequel/todo_sequel.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+require 'qml'
+require 'sequel'
+
+module Examples
+  module Todo
+    VERSION = '0.1'
+
+    DB = Sequel.sqlite
+
+    DB.create_table :todos do
+      primary_key :id
+      String :title
+      String :description
+      Date :due_date
+    end
+
+    class SequelModel < QML::Data::QueryModel
+      attr_accessor :dataset
+
+      def initialize(dataset)
+        @dataset = dataset
+        super(*dataset.columns)
+      end
+
+      def query_count
+        @dataset.count
+      end
+
+      def query(offset, count)
+        @dataset.offset(offset).limit(count).all
+      end
+    end
+
+    class TodoController
+      include QML::Access
+      register_to_qml
+
+      def initialize
+        super
+        @todo_dataset = DB[:todos]
+        self.model = SequelModel.new(@todo_dataset)
+      end
+
+      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)
+        model.update
+      end
+
+      on_changed :order_by do
+        model.dataset = @todo_dataset.order(order_by.to_sym)
+        model.update
+      end
+    end
+  end
+end
+
+QML.application do |app|
+  app.load_path Pathname(__FILE__) + '../main.qml'
+end

data/examples/twitter/main.qml

@@ -5,32 +5,44 @@ import Examples.Twitter 0.1
 
 ApplicationWindow {
     visible: true
-    width: 200
-    height: 100
-    title: "Twitter Test"
+    width: 300
+    height: 500
+    title: "Twitter Search Test - " + controller.word
 
-    ListView {
+    ColumnLayout {
         anchors.fill: parent
-        model: controller.model
-        delegate: RowLayout {
-            Image {
-                width: 100
-                height: 100
-                source: user_icon
-            }
-            ColumnLayout {
-                Text {
-                    font.bold: true
-                    text: user_name
-                }
-                Text {
-                    text: tweet_text
+        anchors.margins: 10
+        TextField {
+            id: wordField
+            placeholderText: 'Search...'
+            onEditingFinished: controller.fetch_tweets()
+        }
+        ScrollView {
+            Layout.fillHeight: true
+            Layout.fillWidth: true
+            ListView {
+                model: controller.model
+                delegate: RowLayout {
+                    Image {
+                        width: 100
+                        height: 100
+                        source: user_icon
+                    }
+                    ColumnLayout {
+                        Text {
+                            font.bold: true
+                            text: user_name
+                        }
+                        Text {
+                            text: tweet_text
+                        }
+                    }
                 }
             }
         }
     }
-
     TwitterController {
         id: controller
+        word: wordField.text
     }
 }