qml 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 525fa2715a8aadc120216147318e0179a578d546
-  data.tar.gz: ca001300069503c335494e26bd443ef123b56179
+  metadata.gz: 281f3641f4c5a3441c260dd874168fe99e6ce991
+  data.tar.gz: 46b5c43d00a8a73d1553b327910581fe4569d147
 SHA512:
-  metadata.gz: e6468fcf25055c17367415cca0d62b540eacf732de0028958a1337af8e9b157c85a9602e4fc07b47b9a64f130a8797e76dfdf6bcd43b2f9907c41cbfb354f627
-  data.tar.gz: 865173142d1e3e4ed48d52c08fc52cb77e0fa51b43188388b3fe9074d9b273e1fc9dfdf5f27667505c1b618447038be10f61c1377c82ff007c0010c039e0a291
+  metadata.gz: 77c9acdfec3b5689b21425bcdfe4a5a11c2b27e615388faf520dc5c134cde441cfa1700b14f231d59a1a56d3dcc84f8c809b5400d1a4dbc6d5ffc3e8a52ab22b
+  data.tar.gz: 83496cea61eb036a083457ee84d7be63b7b7b46d4c8968384eff708ad062b2cc1c5171716bec20c4ec9378a6e93f0d450491bd26835fe9e40ab0d04db94c0663

data/README.md

@@ -1,25 +1,23 @@
-ruby-qml
+ruby-qml [![Gem Version](https://badge.fury.io/rb/qml.svg)](http://badge.fury.io/rb/qml)
 ================
 
-[![Gem Version](https://badge.fury.io/rb/qml.svg)](http://badge.fury.io/rb/qml)
+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)
+* [Changelog](https://github.com/seanchas116/ruby-qml/blob/master/changes.md)
+
 [![Dependency Status](https://gemnasium.com/seanchas116/ruby-qml.svg)](https://gemnasium.com/seanchas116/ruby-qml)
 [![Build Status](https://travis-ci.org/seanchas116/ruby-qml.svg?branch=master)](https://travis-ci.org/seanchas116/ruby-qml)
 [![Coverage Status](https://coveralls.io/repos/seanchas116/ruby-qml/badge.png?branch=master)](https://coveralls.io/r/seanchas116/ruby-qml?branch=master)
 [![Inline docs](http://inch-ci.org/github/seanchas116/ruby-qml.png?branch=master)](http://inch-ci.org/github/seanchas116/ruby-qml)
 
-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.
-
 ## What you can do with ruby-qml
 
 * Develop desktop GUI applications only with Ruby and QML
 * Easily combine codes written in C++ and Qt with your Ruby code
 
-## Documentation and Examples
-
-* [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)
@@ -28,29 +26,41 @@ It provides bindings between QML and Ruby and enables you to use Qt Quick-based
 
 ## Installation
 
-ruby-qml requires **Ruby 1.9 or later**.
+### Requirements
+
+* **Ruby 1.9 or later**
+* **OS X or Linux**
+* pkg-config
+* libffi
+* Qt 5.2 or later
 
 ### OS X with Homebrew
 
-Run the following commands to install ruby-qml on OS X with Homebrew:
+To install ruby-qml on OS X with Homebrew, run the following commands:
 
-    $ brew install pkg-config
-    $ brew install libffi
-    $ brew install qt5
+    $ brew install pkg-config libffi qt5
     $ gem install qml -- --with-libffi-dir=$(brew --prefix libffi) --with-qt-dir=$(brew --prefix qt5)
 
-### General (OSX and Linux)
+Both libffi and Qt5 are keg-only in Homebrew, so you must specify their paths explicitly (or force linking).
 
-#### Requirements
+If you use [official Qt installation](http://qt-project.org/downloads), for example:
 
-* pkg-config
-* libffi
-* Qt 5.2 or later
+    $ brew install pkg-config libffi
+    $ gem install qml -- --with-libffi-dir=$(brew --prefix libffi) --with-qt-dir=~/Qt/5.3/clang_64
 
-To install, use this command after installing requirements:
+The Qt installation path (`~/Qt/5.3/clang_64` in this example) depends on your Qt installation configuration and Qt version.
+
+### General (OSX and Linux)
 
     $ gem install qml
 
+#### Options
+
+* `--with-libffi-dir=[dir]`
+  * libffi installation directory (optional).
+* `--with-qt-dir=[dir]`
+  * Qt installation directory (optional).
+
 ### Use Gemfile
 
 Add this line to your Gemfile:
@@ -75,6 +85,8 @@ The configuration will be saved in `~/.bundle/config`.
 The following code loads a QML file and shows an application window titled "Hello, world!".
 
 ```ruby
+require 'qml'
+
 QML.application do |app|
   app.load_path Pathname(__FILE__) + '../main.qml'
 end
@@ -158,7 +170,6 @@ ApplicationWindow {
             id: textField
         }
         Text {
-            y: 100
             id: text
             text: fizzBuzz.result
         }
@@ -373,9 +384,14 @@ class MyPlugin : public QObject
 {
     Q_OBJECT
     Q_PLUGIN_METADATA(IID "org.myplugin.MyPlugin")
+signals:
+    void added(int value);
+
 public slots:
-    void foo() {
-        qDebug() << "foo";
+    int add(int x, int y) {
+        int result = x + y;
+        emit added(result);
+        return result;
     }
 };
 ```
@@ -383,7 +399,12 @@ public slots:
 ```ruby
 # Ruby
 plugin = QML::PluginLoader.new(directory, "myplugin").instance
-plugin.foo
+
+plugin.added.connect do |value|
+  puts "added value: #{value}"
+end
+
+plugin.add(1, 2) #=> 3
 ```
 
 ### Garbage collection

data/changes.md

@@ -1,3 +1,7 @@
+## 0.0.5 (2014-07-31)
+
+* Support official Qt installation on Mac
+
 ## 0.0.4 (2014-07-24)
 
 * Fix 100% CPU usage in idling

data/examples/fizzbuzz/main.qml

@@ -18,7 +18,6 @@ ApplicationWindow {
             id: textField
         }
         Text {
-            y: 100
             id: text
             text: fizzBuzz.result
         }

data/ext/qml/extconf.rb

@@ -39,7 +39,9 @@ class Configurator
     qmake_opts = @debug_enabled ? 'CONFIG+=debug' : ''
     Pathname(__FILE__).+("../plugins").children.select(&:directory?).each do |dir|
       Dir.chdir(dir) do
-        system("#{@qmake} #{qmake_opts}") && system('make clean') && system('make') or abort "failed to build plugin: #{dir.basename}"
+        system("#{@qmake} #{qmake_opts}") or abort "failed to configurate plugin: #{dir.basename}"
+        system('make clean') if enable_config('clean-plugin', false)
+        system('make') or abort "failed to build plugin: #{dir.basename}"
       end
     end
   end
@@ -49,15 +51,33 @@ class Configurator
 
     PKGS.each do |mod|
       @cppflags << `#{@pkgconfig} --cflags #{mod}`.chomp
-      @ldflags << `#{@pkgconfig} --libs #{mod}`.chomp
+
+      libs =`#{@pkgconfig} --libs #{mod}`.chomp
+      @ldflags << libs
+
+      # add framework search path to cppflags
+      libs.split.each do |lib|
+        @cppflags << lib if /^-F/ =~ lib
+      end
     end
 
+    # add private header directory of QtCore
     qtversion = `#{@pkgconfig} --modversion Qt5Core`.chomp
     `#{@pkgconfig} --cflags-only-I Qt5Core`.split.map { |i| Pathname(i.gsub("-I", "")) }.each do |dir|
       private_dir = dir + "#{qtversion}/QtCore"
       @cppflags << "-I#{private_dir}" if private_dir.exist?
     end
 
+    # include framework headers in Mac
+    # (Qt official installer for Mac does not install header files in /include directory)
+    if /darwin/ =~ RUBY_PLATFORM
+      PKGS.map { |pkg| pkg.gsub(/^Qt5/, 'Qt') }.each do |framework|
+        @cppflags << "-I#{@qt_path + "lib/#{framework}.framework/Headers"}"
+      end
+      # add private header directory of QtCore
+      @cppflags << "-I#{@qt_path}/lib/QtCore.framework/Headers/#{qtversion}/QtCore"
+    end
+
     $CPPFLAGS += " #{@cppflags.join(" ")}"
     $LDFLAGS += " #{@ldflags.join(" ")}"
     $CPPFLAGS += " -fPIC"

data/ext/qml/plugins/testutil/imageprovidertest.cpp

@@ -0,0 +1,40 @@
+#include "imageprovidertest.h"
+#include <QQuickImageProvider>
+#include <QCoreApplication>
+#include <future>
+#include <atomic>
+
+namespace RubyQml {
+
+ImageProviderTest::ImageProviderTest(QObject *parent) :
+    QObject(parent)
+{
+}
+
+bool ImageProviderTest::requestAndCompare(QObject *imageProvider, const QString &id, const QByteArray &imageData)
+{
+    auto provider = dynamic_cast<QQuickImageProvider *>(imageProvider);
+    if (!provider) {
+        throw std::runtime_error("invalid iamge provider");
+    }
+    std::atomic_bool finished(false);
+    auto result = std::async(std::launch::async, [=, &finished] {
+        QSize size;
+        auto result = provider->requestImage(id, &size, QSize());
+        finished = true;
+        return result;
+    });
+    auto start = std::chrono::steady_clock::now();
+    while (!finished) {
+        QCoreApplication::processEvents();
+        auto current = std::chrono::steady_clock::now();
+        if (current - start > std::chrono::seconds(1)) {
+            throw std::runtime_error("image request timeout");
+        }
+    }
+    auto actual = result.get();
+    auto expected = QImage::fromData(imageData);
+    return actual == expected;
+}
+
+}

data/ext/qml/plugins/testutil/imageprovidertest.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include <QObject>
+
+namespace RubyQml {
+
+class ImageProviderTest : public QObject
+{
+    Q_OBJECT
+public:
+    explicit ImageProviderTest(QObject *parent = 0);
+
+public slots:
+    bool requestAndCompare(QObject *imageProvider, const QString &id, const QByteArray &imageData);
+};
+
+}

data/ext/qml/plugins/testutil/testutil.pro

@@ -1,6 +1,6 @@
 TEMPLATE = lib
 CONFIG += plugin c++11
-QT += qml
+QT += qml quick
 
 TARGET = rubyqml-testutil
 INCLUDEPATH += .
@@ -10,11 +10,13 @@ SOURCES += testobject.cpp \
     testobjectsubclass.cpp \
     ownershiptest.cpp \
     testutilplugin.cpp \
-    objectlifechecker.cpp
+    objectlifechecker.cpp \
+    imageprovidertest.cpp
 
 HEADERS += \
     testobject.h \
     testobjectsubclass.h \
     ownershiptest.h \
     testutilplugin.h \
-    objectlifechecker.h
+    objectlifechecker.h \
+    imageprovidertest.h

data/ext/qml/plugins/testutil/testutilplugin.cpp

@@ -3,7 +3,9 @@
 #include "testobjectsubclass.h"
 #include "ownershiptest.h"
 #include "objectlifechecker.h"
+#include "imageprovidertest.h"
 #include <QtQml>
+#include <QQuickWindow>
 
 Q_DECLARE_METATYPE(const QMetaObject*)
 
@@ -17,6 +19,7 @@ TestUtilPlugin::TestUtilPlugin(QObject *parent) :
     qRegisterMetaType<TestObjectSubclass *>();
     qRegisterMetaType<OwnershipTest *>();
     qRegisterMetaType<ObjectLifeChecker *>();
+    qRegisterMetaType<ImageProviderTest *>();
 
     auto metaObjects = { &TestObject::staticMetaObject, &ObjectLifeChecker::staticMetaObject};
     for (auto metaobj : metaObjects) {
@@ -44,4 +47,9 @@ ObjectLifeChecker *TestUtilPlugin::createObjectLifeChecker(QObject *target)
     return new ObjectLifeChecker(target);
 }
 
+ImageProviderTest *TestUtilPlugin::createImageProviderTest()
+{
+    return new ImageProviderTest();
+}
+
 } // namespace RubyQml

data/ext/qml/plugins/testutil/testutilplugin.h

@@ -2,12 +2,15 @@
 #include <QObject>
 #include <QVariant>
 
+class QQuickWindow;
+
 namespace RubyQml {
 
 class TestObject;
 class TestObjectSubclass;
 class OwnershipTest;
 class ObjectLifeChecker;
+class ImageProviderTest;
 
 class TestUtilPlugin : public QObject
 {
@@ -24,6 +27,7 @@ public slots:
     RubyQml::TestObjectSubclass *createTestObjectSubclass();
     RubyQml::OwnershipTest *createOwnershipTest();
     RubyQml::ObjectLifeChecker *createObjectLifeChecker(QObject *target);
+    RubyQml::ImageProviderTest *createImageProviderTest();
 
 private:
     QVariantHash mMetaObjects;

data/lib/qml/version.rb

@@ -1,3 +1,3 @@
 module QML
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/qml.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["iofg2100@gmail.com"]
   spec.summary       = %q{A QML / Qt Quick wrapper for Ruby}
   spec.description   = "ruby-qml provides bindings between QML and Ruby and enables you to use Qt Quick-based GUI from Ruby."
-  spec.homepage      = "https://github.com/seanchas116/ruby-qml"
+  spec.homepage      = "http://seanchas116.github.io/ruby-qml/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/qml/application_spec.rb

@@ -2,9 +2,24 @@ require 'spec_helper'
 
 describe QML::Application do
   let(:application) { QML.application }
-  describe '.instance' do
-    it 'returns the QML::Application instance' do
-      expect(application).to be_a(QML::Application)
+
+  describe '.new' do
+    it 'fails with QML::ApplicationError' do
+      expect { QML::Application.new }.to raise_error(QML::ApplicationError)
+    end
+  end
+  describe '.notify_error' do
+    let(:error) do
+      begin
+        fail "hoge"
+      rescue => e
+        e
+      end
+    end
+
+    it 'prints an error to stderr' do
+      expect { QML::Application.notify_error(error) }
+        .to output(/#{error.message}/).to_stderr
     end
   end
   describe '#engine' do
@@ -41,3 +56,11 @@ describe QML::Application do
     end
   end
 end
+
+describe QML do
+  describe '.application' do
+    it 'returns the QML::Application instance' do
+      expect(QML.application).to be_a(QML::Application)
+    end
+  end
+end

data/spec/qml/component_spec.rb

@@ -41,4 +41,12 @@ describe QML::Component do
       end
     end
   end
+
+  describe '#initialize' do
+    context 'when neither string nor path specified' do
+      it 'fails with QMLError' do
+        expect { QML::Component.new({}) }.to raise_error(QML::QMLError)
+      end
+    end
+  end
 end

data/spec/qml/engine_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe QML::Engine do
+  describe '.new' do
+    it 'fails with QML::EngineError' do
+      expect { QML::Engine.new }.to raise_error(QML::EngineError)
+    end
+  end
+end
+
+describe QML do
+  describe '.engine' do
+    it 'returns the instance of QML::Engine' do
+      expect(QML.engine).to be_a(QML::Engine)
+    end
+  end
+end

data/spec/qml/image_provider_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe QML::ImageProvider do
+
+  describe '#request' do
+    it 'is not implemented by default' do
+      expect { QML::ImageProvider.new.request(nil) }.to raise_error(NotImplementedError)
+    end
+  end
+
+  context 'with test image' do
+    let(:klass) do
+      Class.new QML::ImageProvider do
+        attr_reader :image
+
+        def initialize
+          @image = (Pathname(__FILE__) + '../../assets/test.png').binread
+          super
+        end
+
+        def request(req)
+          req.finish(image)
+        end
+      end
+    end
+    let(:image_provider) { klass.new }
+
+    it 'provides image to QML' do
+      test = QML::Plugins.test_util.create_image_provider_test
+      expect(test.request_and_compare(image_provider.qt_image_provider, 'test', image_provider.image)).to eq true
+    end
+  end
+end

data/spec/qml/wrappable_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe QML::Wrappable do
+  describe '#create_wrapper' do
+    it 'is not implemented by default' do
+      obj = Class.new { include QML::Wrappable }.new
+      expect { obj.create_wrapper }.to raise_error(NotImplementedError)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qml
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryohei Ikegami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,6 +209,8 @@ files:
 - ext/qml/plugins/core/imagerequestpromise.h
 - ext/qml/plugins/core/qmlexception.cpp
 - ext/qml/plugins/core/qmlexception.h
+- ext/qml/plugins/testutil/imageprovidertest.cpp
+- ext/qml/plugins/testutil/imageprovidertest.h
 - ext/qml/plugins/testutil/objectlifechecker.cpp
 - ext/qml/plugins/testutil/objectlifechecker.h
 - ext/qml/plugins/testutil/ownershiptest.cpp
@@ -286,6 +288,7 @@ files:
 - lib/qml/version.rb
 - lib/qml/wrappable.rb
 - qml.gemspec
+- spec/assets/test.png
 - spec/assets/testobj.qml
 - spec/qml/access_spec.rb
 - spec/qml/application_spec.rb
@@ -297,9 +300,11 @@ files:
 - spec/qml/data/query_model_spec.rb
 - spec/qml/dispatchable_spec.rb
 - spec/qml/dispatcher_spec.rb
+- spec/qml/engine_spec.rb
 - spec/qml/geometry/point_spec.rb
 - spec/qml/geometry/rectangle_spec.rb
 - spec/qml/geometry/size_spec.rb
+- spec/qml/image_provider_spec.rb
 - spec/qml/plugin_loader_spec.rb
 - spec/qml/qt_object_base_spec.rb
 - spec/qml/reactive/object_spec.rb
@@ -307,10 +312,11 @@ files:
 - spec/qml/reactive/signal_spec.rb
 - spec/qml/reactive/signal_spy_spec.rb
 - spec/qml/test_object_spec.rb
+- spec/qml/wrappable_spec.rb
 - spec/qml_spec.rb
 - spec/shared_examples/qml/data/list_model.rb
 - spec/spec_helper.rb
-homepage: https://github.com/seanchas116/ruby-qml
+homepage: http://seanchas116.github.io/ruby-qml/
 licenses:
 - MIT
 metadata: {}
@@ -335,6 +341,7 @@ signing_key:
 specification_version: 4
 summary: A QML / Qt Quick wrapper for Ruby
 test_files:
+- spec/assets/test.png
 - spec/assets/testobj.qml
 - spec/qml/access_spec.rb
 - spec/qml/application_spec.rb
@@ -346,9 +353,11 @@ test_files:
 - spec/qml/data/query_model_spec.rb
 - spec/qml/dispatchable_spec.rb
 - spec/qml/dispatcher_spec.rb
+- spec/qml/engine_spec.rb
 - spec/qml/geometry/point_spec.rb
 - spec/qml/geometry/rectangle_spec.rb
 - spec/qml/geometry/size_spec.rb
+- spec/qml/image_provider_spec.rb
 - spec/qml/plugin_loader_spec.rb
 - spec/qml/qt_object_base_spec.rb
 - spec/qml/reactive/object_spec.rb
@@ -356,6 +365,7 @@ test_files:
 - spec/qml/reactive/signal_spec.rb
 - spec/qml/reactive/signal_spy_spec.rb
 - spec/qml/test_object_spec.rb
+- spec/qml/wrappable_spec.rb
 - spec/qml_spec.rb
 - spec/shared_examples/qml/data/list_model.rb
 - spec/spec_helper.rb