pluggaloid 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb97cc313e04d222f6f4513ce075cffb211337e5d4bda1f95b6be810d6faeee5
-  data.tar.gz: af791c5310e60264c2e0ea17591bd9e5baf65e57a5c2c97e8d0ba282c751cf11
+  metadata.gz: 9a93383e1c1e927a50677dac1de618e66f2b558c9dd03ab0e1a4d8ca4d67a7c8
+  data.tar.gz: 226442cc3d33c6441ac51d705ac3b230fd53ba26de52e7b82cd82d0629a69bdc
 SHA512:
-  metadata.gz: 36d56d8c824ec9e6f5486316aaf928bb9cd5a5a9966ec621150dac344cc8c3b9180e7ba51299aeb65b8332ce587e7ba9a82a963aa05024878247ef0000a40335
-  data.tar.gz: 937450b9967accb7197a16b4a1815aa11ed7bd7e86d933302392d04b32c6e7e055978a5878d4974bd45e610929def0e66bfaf27c0c3c9255a96233a4f7f9eef4
+  metadata.gz: 04a64880fef38f6092ff1efb49b40f4eb84cc714b02605077663f3f9937453dec61de160aa727311f646a465aad79c0e3a15c6cd2dc935a2e6d33955d409b36c
+  data.tar.gz: 95d9e7309b800f3eee223336e00568e946e6d59eea3599db51c3b7c70fa380f8fca368611dd8622f32c6bc35309670f8f857e80a7bba5df6eb1d1c2f038a47df

data/.circleci/config.yml

@@ -31,10 +31,13 @@ workflows:
     jobs:
       - build:
           name: 'ruby-2.5'
-          ruby-version: '2.5.7'
+          ruby-version: '2.5.9'
       - build:
           name: 'ruby-2.6'
-          ruby-version: '2.6.5'
+          ruby-version: '2.6.7'
       - build:
           name: 'ruby-2.7'
-          ruby-version: '2.7.0'
+          ruby-version: '2.7.3'
+      - build:
+          name: 'ruby-3.0'
+          ruby-version: '3.0.1'

data/lib/pluggaloid.rb

@@ -10,6 +10,7 @@ require 'pluggaloid/subscriber'
 require 'pluggaloid/filter'
 require 'pluggaloid/stream_generator'
 require "pluggaloid/handler_tag"
+require 'pluggaloid/mirage'
 require 'pluggaloid/error'
 
 require 'delayer'

data/lib/pluggaloid/filter.rb

@@ -19,7 +19,8 @@ class Pluggaloid::Filter < Pluggaloid::Handler
   # [tags:] Pluggaloid::HandlerTag|Array フィルタのタグ
   # [&callback] コールバック
   def initialize(event, **kwrest, &callback)
-    super
+    kwrest[:name] ||= '%s line %i' % callback.source_location
+    super(event, **kwrest)
     @callback = callback
     event.add_filter self end
 

data/lib/pluggaloid/mirage.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Pluggaloid
+  module Mirage
+    MIRAGE_ID_BASE_NUMBER = 36
+
+    module Extend
+      # `Pluggaloid::Mirage` をincludeしたClassのうち、`pluggaloid_mirage_identity`
+      # メソッドを呼ばれたインスタンスを記録するオブジェクトを返す。
+      # 戻り値は、以下のメソッドに応答すること。
+      # - `repository#[](String id)` idに対応するオブジェクトを返す
+      # - `repository#[]=(String id, self obj)` objを記録する
+      # Class毎に適したコンテナを返すようにoverrideすること
+      def pluggaloid_mirage_repository
+        @pluggaloid_mirage_repository ||= {}
+      end
+    end
+
+    def self.unwrap(namespace:, id:)
+      klass = pluggaloid_mirage_classes[namespace]
+      if klass
+        result = klass.pluggaloid_mirage_repository[id]
+        unless result&.is_a?(Pluggaloid::Mirage) # nilの場合は常にraise
+          raise ArgumentError, "The id `#{id}' was not found."
+        end
+        result
+      else
+        raise ArgumentError, "The namespace `#{namespace}' was not found."
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(Extend)
+      pluggaloid_mirage_classes[klass.to_s] = klass
+    end
+
+    def self.pluggaloid_mirage_classes
+      @pluggaloid_mirage_classes ||= {}
+    end
+
+    # このClassのなかで、Pluggaloid::Mirageがインスタンスを同定するためのid(String)を返す。
+    # このメソッドではなく、 `generate_pluggaloid_mirage_id` をoverrideすること
+    def pluggaloid_mirage_id
+      generate_pluggaloid_mirage_id.freeze.tap do |id|
+        self.class.pluggaloid_mirage_repository[id] = self
+        Mirage.pluggaloid_mirage_classes[self.class.to_s] ||= self.class
+      end
+    end
+
+    private
+
+    # このClassのなかで、Pluggaloid::Mirageがインスタンスを同定するためのid(String)を返す。
+    # Class毎に適したコンテナを返すようにoverrideすること
+    def generate_pluggaloid_mirage_id
+      object_id.to_s(MIRAGE_ID_BASE_NUMBER)
+    end
+  end
+end

data/lib/pluggaloid/plugin.rb

@@ -181,7 +181,7 @@ module Pluggaloid
     def collection(event_name, *specs, &block)
       event = vm.Event[event_name]
       mutation = Pluggaloid::Collection.new(event, *specs)
-      add_event_filter(event_name) do |*args|
+      add_event_filter(event_name, name: 'collection(%s line %i)' % block.source_location) do |*args|
         if mutation.argument_hash_same?(args)
           mutation.values.each(&args[event.collect_index].method(:<<))
         end

data/lib/pluggaloid/version.rb

@@ -1,3 +1,3 @@
 module Pluggaloid
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/test/mirage_test.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'minitest/autorun'
+
+require 'pluggaloid'
+require_relative 'helper'
+
+describe(Pluggaloid::Plugin) do
+  include PluggaloidTestHelper
+
+  it 'resume' do
+    k = Class.new do
+      include Pluggaloid::Mirage
+    end
+    a = k.new
+    assert_equal(a, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: a.pluggaloid_mirage_id))
+  end
+
+  it 'custom mirage id' do
+    k = Class.new do
+      include Pluggaloid::Mirage
+
+      def initialize(a)
+        @a = a
+      end
+
+      def generate_pluggaloid_mirage_id
+        @a.to_s
+      end
+    end
+
+    a = k.new('same')
+    b = k.new('differ')
+    assert_equal('same', a.pluggaloid_mirage_id)
+    assert_equal(a, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: a.pluggaloid_mirage_id))
+    assert_equal('differ', b.pluggaloid_mirage_id)
+    assert_equal(b, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: b.pluggaloid_mirage_id))
+  end
+
+  it 'not confuse other mirage classese' do
+    definition = ->(*) do
+      include Pluggaloid::Mirage
+
+      def initialize(a)
+        @a = a
+      end
+
+      def generate_pluggaloid_mirage_id
+        @a.to_s
+      end
+    end
+
+    k = Class.new(&definition)
+    l = Class.new(&definition)
+
+    a = k.new('same')
+    b = l.new('same')
+    c = l.new('differ')
+
+    refute_equal(k.to_s, l.to_s)
+    assert_equal('same', a.pluggaloid_mirage_id)
+    assert_equal('same', b.pluggaloid_mirage_id)
+    assert_equal('differ', c.pluggaloid_mirage_id)
+
+    assert_equal(b, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'same'))
+    assert_equal(c, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'differ'))
+    assert_equal(a, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'same'))
+    assert_raises(Pluggaloid::ArgumentError) { Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'differ') }
+  end
+
+  it 'inherit class' do
+    k = Class.new do
+      include Pluggaloid::Mirage
+
+      def initialize(a)
+        @a = a
+      end
+
+      def generate_pluggaloid_mirage_id
+        @a.to_s
+      end
+    end
+    l = Class.new(k)
+
+    a = k.new('same')
+    b = l.new('same')
+    c = l.new('differ')
+
+    refute_equal(k.to_s, l.to_s)
+    assert_equal('same', a.pluggaloid_mirage_id)
+    assert_equal('same', b.pluggaloid_mirage_id)
+    assert_equal('differ', c.pluggaloid_mirage_id)
+
+    assert_equal(b, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'same'))
+    assert_equal(c, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'differ'))
+    assert_equal(a, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'same'))
+    assert_raises(Pluggaloid::ArgumentError) { Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'differ') }
+  end
+
+  it 'inherit before include mirage' do
+    k = Class.new do
+      def initialize(a)
+        @a = a
+      end
+
+      def generate_pluggaloid_mirage_id
+        @a.to_s
+      end
+    end
+    l = Class.new(k)
+    k.include Pluggaloid::Mirage
+
+    a = k.new('same')
+    b = l.new('same')
+    c = l.new('differ')
+
+    refute_equal(k.to_s, l.to_s)
+    assert_equal('same', a.pluggaloid_mirage_id)
+    assert_equal('same', b.pluggaloid_mirage_id)
+    assert_equal('differ', c.pluggaloid_mirage_id)
+
+    assert_equal(b, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'same'))
+    assert_equal(c, Pluggaloid::Mirage.unwrap(namespace: l.to_s, id: 'differ'))
+    assert_equal(a, Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'same'))
+    assert_raises(Pluggaloid::ArgumentError) { Pluggaloid::Mirage.unwrap(namespace: k.to_s, id: 'differ') }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluggaloid
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Toshiaki Asai
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayer
@@ -114,6 +114,7 @@ files:
 - lib/pluggaloid/handler_tag.rb
 - lib/pluggaloid/identity.rb
 - lib/pluggaloid/listener.rb
+- lib/pluggaloid/mirage.rb
 - lib/pluggaloid/plugin.rb
 - lib/pluggaloid/stream.rb
 - lib/pluggaloid/stream_generator.rb
@@ -125,6 +126,7 @@ files:
 - test/handle_in_generate_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
+- test/mirage_test.rb
 - test/multi_vm_test.rb
 - test/plugin_test.rb
 - test/reactive_test.rb
@@ -132,7 +134,7 @@ homepage: https://rubygems.org/gems/pluggaloid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.13
+signing_key:
 specification_version: 4
 summary: Extensible plugin system
 test_files:
@@ -157,6 +159,7 @@ test_files:
 - test/handle_in_generate_test.rb
 - test/handler_tag_test.rb
 - test/helper.rb
+- test/mirage_test.rb
 - test/multi_vm_test.rb
 - test/plugin_test.rb
 - test/reactive_test.rb