qml 0.0.1 → 0.0.2

data/lib/qml/data/list_model.rb

@@ -12,24 +12,16 @@ module QML
       include Wrappable
       include Dispatchable
 
-      class << self
-        # Declares the columns of the model.
-        # @param [Array<Symbol|String>] columns 
-        def column(*columns)
-          @columns ||= []
-          @columns |= columns
-        end
-
-        # The columns of the model.
-        attr_reader :columns
-      end
-
       # @api private
       # @return [Array<QtObjectBase>]
       attr_reader :qt_models
 
-      def initialize
-        fail Error, 'columns not specified' unless self.class.columns
+      # @return [Array<Symbol|String>]
+      attr_reader :columns
+
+      # @param [Array<Symbol|String>] columns the column names of the model.
+      def initialize(*columns)
+        @columns = columns
         @qt_models = []
       end
 
@@ -80,17 +72,16 @@ module QML
       # @see http://qt-project.org/doc/qt-5/qabstractitemmodel.html#endMoveRows QAbstractItemModel::endMoveRows
       # @see #inserting
       # @see #removing
-      def moving(range, destination, &block)
+      def moving(range, destination)
+        return if range.size == 0
+
         @qt_models.each do |qt_model|
           qt_model.begin_move(range.min, range.max, destination)
         end
-
-        ret = block.call
-
+        ret = yield
         @qt_models.each do |qt_model|
           qt_model.end_move
         end
-
         ret
       end
 
@@ -107,16 +98,15 @@ module QML
       # @see #removing
       # @see #moving
       def inserting(range, &block)
+        return if range.size == 0
+
         @qt_models.each do |qt_model|
           qt_model.begin_insert(range.min, range.max)
         end
-
-        ret = block.call
-
+        ret = yield
         @qt_models.each do |qt_model|
           qt_model.end_insert
         end
-
         ret
       end
 
@@ -129,16 +119,26 @@ module QML
       # @see #inserting
       # @see #moving
       def removing(range, &block)
+        return if range.size == 0
+
         @qt_models.each do |qt_model|
           qt_model.begin_remove(range.min, range.max)
         end
-
-        ret = block.call
-
+        ret = yield
         @qt_models.each do |qt_model|
           qt_model.end_remove
         end
+        ret
+      end
 
+      def resetting(&block)
+        @qt_models.each do |qt_model|
+          qt_model.begin_reset
+        end
+        ret = yield
+        @qt_models.each do |qt_model|
+          qt_model.end_reset
+        end
         ret
       end
     end

data/lib/qml/data/query_model.rb

@@ -0,0 +1,60 @@
+module QML
+  module Data
+    # {QueryModel} provides a list model implementation with database backends like ActiveRecord.
+    class QueryModel < ListModel
+      attr_reader :count
+
+      # @param [Array<Symbol|String>] columns
+      def initialize(*columns)
+        super
+        @count = 0
+        @caches = []
+        update
+      end
+
+      def [](index)
+        block_index = index / CACHE_SIZE
+        cache = @caches.find { |c| c.block_index == block_index } || add_cache(block_index)
+        cache.items[index % CACHE_SIZE]
+      end
+
+      # Updates the model.
+      def update
+        @caches = []
+        resetting do
+          @count = query_count
+        end
+      end
+
+      # @abstract
+      # Queries the count of the records.
+      # Called when {#update} is called and the result is set as the {#count} of the model.
+      # @return [Integer]
+      def query_count
+        fail ::NotImplementedError
+      end
+
+      # @abstract
+      # Queries a block of records. The results are chached.
+      # @param [Integer] offset
+      # @param [Integer] count
+      # @return [Array]
+      def query(offset, count)
+        fail ::NotImplementedError
+      end
+
+      private
+
+      Cache = Struct.new(:block_index, :items)
+      CACHE_SIZE = 256
+      CACHE_COUNT = 4
+
+      def add_cache(block_offset)
+        @caches.shift if @caches.size >= CACHE_COUNT
+        Cache.new(block_offset, query(block_offset * CACHE_SIZE, CACHE_SIZE)).tap do |cache|
+          @caches << cache
+        end
+      end
+    end
+  end
+end

data/lib/qml/version.rb

@@ -1,3 +1,3 @@
 module QML
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/qml.gemspec

@@ -19,10 +19,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/qml/extconf.rb"]
 
+  spec.required_ruby_version = '~> 2.0'
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'celluloid'
-  spec.add_development_dependency 'twitter'
+  spec.add_development_dependency 'twitter', '~> 5.11'
+  spec.add_development_dependency 'sequel', '~> 4.12'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/spec/qml/data/array_model_spec.rb

@@ -2,30 +2,12 @@ require 'spec_helper'
 
 describe QML::Data::ArrayModel do
 
-  class NoColumnArrayModel < QML::Data::ArrayModel
-  end
-
   class TestArrayModel < QML::Data::ArrayModel
-    column :title, :number
-  end
-
-  let(:context) { QML::Context.new }
-
-  let(:component) do
-    QML::Component.new context: context, data: <<-EOS
-      import QtQuick 2.0
-      ListView {
-        model: arrayModel
-        delegate: Item {
-          property var itemTitle: title
-          property var itemNumber: number
-        }
-      }
-    EOS
+    def initialize
+      super(:title, :number)
+    end
   end
 
-  let(:list_view) { component.create }
-
   let(:original_array) do
     [
       {title: 'hoge', number: 12},
@@ -45,41 +27,18 @@ describe QML::Data::ArrayModel do
 
   let(:model) do
     TestArrayModel.new.tap do |model|
-      model.push *original_array
+      model.push(*original_array)
     end
   end
 
-  before do
-    context[:arrayModel] = model
-  end
+  include_context 'ListView for model available'
 
-  shared_examples 'model content' do |text|
+  shared_examples 'same as expected array' do |text|
     it text do
       expect(model.to_a).to eq(expected_array)
     end
   end
 
-  shared_examples 'ListView' do
-    it 'updates QML ListView correctly' do
-      count = list_view.count
-      expect(count).to eq expected_array.size
-      list_view.count.times do |i|
-        list_view.current_index = i
-        current = list_view.current_item
-        expect(current.item_title).to eq(expected_array[i][:title])
-        expect(current.item_number).to eq(expected_array[i][:number])
-      end
-    end
-  end
-
-  describe '#initialize' do
-    context 'when columns are not specified' do
-      it 'fails' do
-        expect { NoColumnArrayModel.new }.to raise_error(QML::Data::Error)
-      end
-    end
-  end
-
   describe '#each' do
     context 'with no block' do
       it 'returns an Enumerator' do
@@ -129,8 +88,8 @@ describe QML::Data::ArrayModel do
         model[2] = additional_array[0]
         expected_array[2] = additional_array[0]
       end
-      include_examples 'model content', 'sets the element to given index'
-      include_examples 'ListView'
+      it_behaves_like 'same as expected array', 'sets the element to given index'
+      it_behaves_like 'ListView data source'
     end
   end
 
@@ -145,8 +104,8 @@ describe QML::Data::ArrayModel do
         model.insert(1, *additional_array)
         expected_array.insert(1, *additional_array)
       end
-      include_examples 'model content', 'inserts item'
-      include_examples 'ListView'
+      it_behaves_like 'same as expected array', 'inserts item'
+      it_behaves_like 'ListView data source'
     end
   end
 
@@ -161,8 +120,8 @@ describe QML::Data::ArrayModel do
           model.delete_at(1)
           expected_array.delete_at(1)
         end
-        include_examples 'model content', 'deletes item'
-        include_examples 'ListView'
+        it_behaves_like 'same as expected array', 'deletes item'
+        it_behaves_like 'ListView data source'
       end
     end
 
@@ -175,8 +134,8 @@ describe QML::Data::ArrayModel do
           model.delete_at(1, 2)
           2.times { expected_array.delete_at(1) }
         end
-        include_examples 'model content', 'deletes items'
-        include_examples 'ListView'
+        it_behaves_like 'same as expected array', 'deletes items'
+        it_behaves_like 'ListView data source'
       end
     end
   end
@@ -207,9 +166,37 @@ describe QML::Data::ArrayModel do
     end
   end
 
-  describe '<<' do
+  describe '#<<' do
     it 'is an alias of #push' do
       expect((model << additional_array[0]).to_a).to eq(expected_array << additional_array[0])
     end
   end
+
+  describe '#clear' do
+    it 'returns self' do
+      expect(model.clear).to be(model)
+    end
+    context 'after called' do
+      before do
+        model.clear
+        expected_array.clear
+      end
+      it_behaves_like 'same as expected array', 'clears items'
+      it_behaves_like 'ListView data source'
+    end
+  end
+
+  describe '#replace' do
+    it 'returns self' do
+      expect(model.replace(expected_array + additional_array)).to be(model)
+    end
+    context 'after called' do
+      before do
+        model.replace(expected_array + additional_array)
+        expected_array.push *additional_array
+      end
+      it_behaves_like 'same as expected array', 'replaces entire array'
+      it_behaves_like 'ListView data source'
+    end
+  end
 end

data/spec/qml/data/list_model_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe QML::Data::ListModel do
+  let(:model) { QML::Data::ListModel.allocate }
+
+  describe '#count' do
+    it 'fails with NotImplementedError by default' do
+      expect { model.count }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#[]' do
+    it 'fails with NotImplementedError by default' do
+      expect { model[0] }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/qml/data/query_model_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe QML::Data::QueryModel do
+
+  let(:klass) do
+    Class.new(QML::Data::QueryModel) do
+      attr_accessor :data
+
+      def initialize(count)
+        @data = count.times.map { |i| {title: "title: #{i}", number: i} }
+        super(:title, :number)
+      end
+
+      def query(offset, count)
+        @data[offset ... offset + count]
+      end
+
+      def query_count
+        @data.size
+      end
+    end
+  end
+
+  let(:model) { klass.new(2000) }
+  let(:expected_array) { model.data }
+
+  describe '#count' do
+    it 'returns the count and updated by #update' do
+      count = model.data.size
+      expect(model.count).to eq(count)
+      model.data << {value: 0}
+      expect(model.count).to eq(count)
+      model.update
+      expect(model.count).to eq(count + 1)
+    end
+  end
+
+  describe '#[]' do
+    it 'returns the item' do
+      model.data.size.times do |i|
+        expect(model[i]).to eq(model.data[i])
+      end
+    end
+  end
+
+  describe '#query_count' do
+    it 'fails with NotImplementedError by default' do
+      expect { QML::Data::QueryModel.allocate.query_count }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#query' do
+    it 'fails with NotImplementedError by default' do
+      expect { QML::Data::QueryModel.allocate.query(0, 100) }.to raise_error(NotImplementedError)
+    end
+  end
+
+  include_context 'ListView for model available'
+  it_behaves_like 'ListView data source' do
+    let(:model) { klass.new(10) }
+  end
+end

data/spec/shared_examples/qml/data/list_model.rb

@@ -0,0 +1,33 @@
+shared_context 'ListView for model available' do
+  let(:context) { QML::Context.new }
+  let(:component) do
+    QML::Component.new context: context, data: <<-EOS
+      import QtQuick 2.0
+      ListView {
+        model: the_model
+        delegate: Item {
+          property var itemTitle: title
+          property var itemNumber: number
+        }
+      }
+    EOS
+  end
+  let(:list_view) { component.create }
+
+  before do
+    context[:the_model] = model
+  end
+end
+
+shared_examples 'ListView data source' do
+  it 'updates ListView correctly' do
+    count = list_view.count
+    expect(count).to eq expected_array.size
+    list_view.count.times do |i|
+      list_view.current_index = i
+      current = list_view.current_item
+      expect(current.item_title).to eq(expected_array[i][:title])
+      expect(current.item_number).to eq(expected_array[i][:number])
+    end
+  end
+end