delayer 0.0.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40812fa4ace5f5b6bf079c393927bc028e466720edbd9b7e5bbd09b224fe9fb5
+  data.tar.gz: a07eca82e3a3bdb77ca4fbd6dc957d871ee9da591436ebedf14a88c46cfaf924
+SHA512:
+  metadata.gz: de7563e47139c0d59ab569114fc6f03234bab94fbdc8af27ba6dc3d0bea3aa87e04f64aebb5d97ac0f0019c3dab2499e772a43934ce2c1faa168da454cf10692
+  data.tar.gz: 370139c813d0f04d00ef1c5a5c69b034a033bdb7a70999a5c1d38c0c536064d037312025a0dd5bd88c843325c3819a95a3ca1c97ca685e4ee08f90123568c701

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/vendor/

data/delayer.gemspec

@@ -10,14 +10,16 @@ Gem::Specification.new do |spec|
   spec.email         = ["toshi.alternative@gmail.com"]
   spec.description   = %q{Delay the processing}
   spec.summary       = %q{Delay the processing}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/toshia/delayer"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.4.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.2.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", '>= 12.3.2'
+  spec.add_development_dependency "test-unit", '>= 3.3.3', '< 4.0'
 end

data/lib/delayer.rb

@@ -3,17 +3,12 @@ require "delayer/version"
 require "delayer/error"
 require "delayer/extend"
 require "delayer/procedure"
-require "delayer/priority"
 require "monitor"
 
 module Delayer
   class << self
     attr_accessor :default
 
-    def included(klass)
-      klass.extend Extend
-    end
-
     # Generate new Delayer class.
     # ==== Args
     # [options]
@@ -24,17 +19,15 @@ module Delayer
     # ==== Return
     # A new class
     def generate_class(options = {})
-      if options[:priority]
-        Class.new do
-          include Priority
-          @expire = options[:expire] || 0
+      Class.new do
+        include ::Delayer
+        @expire = options[:expire] || 0
+        if options.has_key?(:priority)
           @priorities = options[:priority]
           @default_priority = options[:default]
-        end
-      else
-        Class.new do
-          include ::Delayer
-          @expire = options[:expire] || 0
+        else
+          @priorities = [:normal]
+          @default_priority = :normal
         end
       end
     end
@@ -43,19 +36,4 @@ module Delayer
       (@default ||= generate_class).__send__(*args, &proc)
     end
   end
-
-  def initialize(*args)
-    super
-    @procedure = Procedure.new(self, &Proc.new)
-  end
-
-  # Cancel this job
-  # ==== Exception
-  # Delayer::AlreadyExecutedError :: if already called run()
-  # ==== Return
-  # self
-  def cancel
-    @procedure.cancel
-    self
-  end
 end

data/lib/delayer/error.rb

@@ -7,6 +7,11 @@ module Delayer
   class AlreadyCanceledError < TooLate; end
   class AlreadyRunningError < TooLate; end
   class InvalidPriorityError < Error; end
+
+  class RecursiveError < Error; end
+  class NoLowerLevelError < RecursiveError; end
+  class RemainJobsError < RecursiveError; end
+
   def self.StateError(state)
     case state
     when :run

data/lib/delayer/extend.rb

@@ -1,19 +1,53 @@
 # -*- coding: utf-8 -*-
 
 module Delayer
+  attr_reader :priority
+
+  Bucket = Struct.new(:first, :last, :priority_of, :stashed) do
+    def stash_size
+      if stashed
+        1 + stashed.stash_size
+      else
+        0
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.class_eval do
+      extend Extend
+    end
+  end
+
+  def initialize(priority = self.class.instance_eval{ @default_priority }, *args)
+    self.class.validate_priority priority
+    @priority = priority
+    @procedure = Procedure.new(self, &Proc.new)
+  end
+
+  # Cancel this job
+  # ==== Exception
+  # Delayer::AlreadyExecutedError :: if already called run()
+  # ==== Return
+  # self
+  def cancel
+    @procedure.cancel
+    self
+  end
+
   module Extend
     attr_accessor :expire
     attr_reader :exception
 
     def self.extended(klass)
       klass.class_eval do
-        @first_pointer = @last_pointer = nil
         @busy = false
         @expire = 0
         @remain_hook = nil
         @exception = nil
         @remain_received = false
         @lock = Mutex.new
+        @bucket = Bucket.new(nil, nil, {}, nil)
       end
     end
 
@@ -51,10 +85,10 @@ module Delayer
     # ==== Return
     # self
     def run_once
-      if @first_pointer
+      if @bucket.first
         @busy = true
         procedure = forward
-        procedure = forward while @first_pointer and procedure.canceled?
+        procedure = forward while @bucket.first and procedure.canceled?
         procedure.run unless procedure.canceled?
       end
     ensure
@@ -74,13 +108,13 @@ module Delayer
     # ==== Return
     # true if no jobs has.
     def empty?
-      !@first_pointer
+      !@bucket.first
     end
 
     # Return remain jobs quantity.
     # ==== Return
     # Count of remain jobs
-    def size(node = @first_pointer)
+    def size(node = @bucket.first)
       if node
         1 + size(node.next)
       else
@@ -94,11 +128,17 @@ module Delayer
     # ==== Return
     # self
     def register(procedure)
+      priority = procedure.delayer.priority
       lock.synchronize do
-        if @last_pointer
-          @last_pointer = @last_pointer.break procedure
+        last_pointer = get_prev_point(priority)
+        if last_pointer
+          @bucket.priority_of[priority] = last_pointer.break procedure
         else
-          @last_pointer = @first_pointer = procedure
+          procedure.next = @bucket.first
+          @bucket.priority_of[priority] = @bucket.first = procedure
+        end
+        if @bucket.last
+          @bucket.last = @bucket.priority_of[priority]
         end
         if @remain_hook and not @remain_received
           @remain_received = true
@@ -112,13 +152,55 @@ module Delayer
       @remain_hook = Proc.new
     end
 
+    def get_prev_point(priority)
+      if @bucket.priority_of[priority]
+        @bucket.priority_of[priority]
+      else
+        next_index = @priorities.index(priority) - 1
+        get_prev_point @priorities[next_index] if 0 <= next_index
+      end
+    end
+
+    def validate_priority(symbol)
+      unless @priorities.include? symbol
+        raise Delayer::InvalidPriorityError, "undefined priority '#{symbol}'"
+      end
+    end
+
+    # DelayerのStashレベルをインクリメントする。
+    # このメソッドが呼ばれたら、その時存在するジョブは退避され、stash_exit!が呼ばれるまで実行されない。
+    def stash_enter!
+      @bucket = Bucket.new(nil, nil, {}, @bucket)
+      self
+    end
+
+    # DelayerのStashレベルをデクリメントする。
+    # このメソッドを呼ぶ前に、現在のレベルに存在するすべてのジョブを実行し、Delayer#empty?がtrueを返すような状態になっている必要がある。
+    # ==== Raises
+    # [Delayer::NoLowerLevelError] stash_enter!が呼ばれていない時
+    # [Delayer::RemainJobsError] ジョブが残っているのにこのメソッドを呼んだ時
+    def stash_exit!
+      raise Delayer::NoLowerLevelError, 'stash_exit! called in level 0.' if !@bucket.stashed
+      raise Delayer::RemainJobsError, 'Current level has remain jobs. It must be empty current level jobs in call this method.' if !self.empty?
+      @bucket = @bucket.stashed
+    end
+
+    # 現在のDelayer Stashレベルを返す。
+    def stash_level
+      @bucket.stash_size
+    end
+
     private
 
     def forward
       lock.synchronize do
-        prev = @first_pointer
-        @first_pointer = @first_pointer.next
-        @last_pointer = nil unless @first_pointer
+        prev = @bucket.first
+        @bucket.first = @bucket.first.next
+        @bucket.last = nil unless @bucket.first
+        @bucket.priority_of.each do |priority, pointer|
+          @bucket.priority_of[priority] = @bucket.first if prev == pointer
+        end
+        prev.next = nil
         prev
       end
     end
@@ -126,6 +208,5 @@ module Delayer
     def lock
       @lock
     end
-
   end
 end

data/lib/delayer/version.rb

@@ -1,3 +1,3 @@
 module Delayer
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/test/test_delayer.rb

@@ -270,7 +270,7 @@ class TestDelayer < Test::Unit::TestCase
       end
     end
     delayer.run
-    threads.each &:join
+    threads.each(&:join)
     delayer.run
     assert_equal(10000, buffer.size)
     assert_equal((0..999).inject(&:+)*10, buffer.inject(&:+))
@@ -314,4 +314,43 @@ class TestDelayer < Test::Unit::TestCase
     assert_equal([:remain, 0, 1, :remain, 2, 3, 4], a)
 
   end
+
+  def test_recursive_mainloop
+    delayer = Delayer.generate_class
+    a = 0
+    delayer.new { a = 1 }
+
+    assert_equal(0, delayer.stash_level)
+    delayer.stash_enter!
+    assert_equal(1, delayer.stash_level)
+
+    delayer.new { a = 2 }
+
+    assert_equal(0, a)
+    delayer.run
+    assert_equal(2, a)
+
+    delayer.stash_exit!
+    assert_equal(0, delayer.stash_level)
+
+    delayer.run
+    assert_equal(1, a)
+  end
+
+  def test_pop_recursive_mainloop_remain_jobs
+    delayer = Delayer.generate_class
+    delayer.stash_enter!
+    delayer.new{ ; }
+    assert_raise Delayer::RemainJobsError do
+      delayer.stash_exit!
+    end
+  end
+
+  def test_pop_recursive_mainloop_in_level_zero
+    delayer = Delayer.generate_class
+    assert_raise Delayer::NoLowerLevelError do
+      delayer.stash_exit!
+    end
+  end
+
 end

data/test/test_priority.rb

@@ -214,7 +214,7 @@ class TestPriorityDelayer < Test::Unit::TestCase
       end
     end
     delayer.run
-    threads.each &:join
+    threads.each(&:join)
     delayer.run
     assert_equal(10000, buffer.size)
     assert_equal((0..999).inject(&:+)*10, buffer.inject(&:+))

metadata

@@ -1,38 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: delayer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Toshiaki Asai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &8375180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8375180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &8374760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.2
   type: :development
   prerelease: false
-  version_requirements: *8374760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Delay the processing
 email:
 - toshi.alternative@gmail.com
@@ -40,7 +65,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -49,35 +74,32 @@ files:
 - lib/delayer.rb
 - lib/delayer/error.rb
 - lib/delayer/extend.rb
-- lib/delayer/priority.rb
 - lib/delayer/procedure.rb
 - lib/delayer/version.rb
 - test/test_delayer.rb
 - test/test_priority.rb
-homepage: ''
+homepage: https://github.com/toshia/delayer
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Delay the processing
 test_files:
 - test/test_delayer.rb

data/lib/delayer/priority.rb

@@ -1,84 +0,0 @@
-# -*- coding: utf-8 -*-
-
-module Delayer
-  module Priority
-    attr_reader :priority
-
-    def self.included(klass)
-      klass.class_eval do
-        include ::Delayer
-        extend Extend
-      end
-    end
-
-    def initialize(priority = self.class.instance_eval{ @default_priority }, *args)
-      self.class.validate_priority priority
-      @priority = priority
-      super(*args)
-    end
-
-    module Extend
-      def self.extended(klass)
-        klass.class_eval do
-          @priority_pointer = {}
-        end
-      end
-
-      # register new job.
-      # ==== Args
-      # [procedure] job(Delayer::Procedure)
-      # ==== Return
-      # self
-      def register(procedure)
-        priority = procedure.delayer.priority
-        lock.synchronize do
-          last_pointer = get_prev_point(priority)
-          if last_pointer
-            @priority_pointer[priority] = last_pointer.break procedure
-          else
-            procedure.next = @first_pointer
-            @priority_pointer[priority] = @first_pointer = procedure
-          end
-          if @last_pointer
-            @last_pointer = @priority_pointer[priority]
-          end
-          if @remain_hook and not @remain_received
-            @remain_received = true
-            @remain_hook.call
-          end
-        end
-        self
-      end
-
-      def get_prev_point(priority)
-        if @priority_pointer[priority]
-          @priority_pointer[priority]
-        else
-          next_index = @priorities.index(priority) - 1
-          get_prev_point @priorities[next_index] if 0 <= next_index
-        end
-      end
-
-      def validate_priority(symbol)
-        unless @priorities.include? symbol
-          raise Delayer::InvalidPriorityError, "undefined priority '#{symbol}'"
-        end
-      end
-
-      private
-
-      def forward
-        lock.synchronize do
-          prev = @first_pointer
-          @first_pointer = @first_pointer.next
-          @last_pointer = nil unless @first_pointer
-          @priority_pointer.each do |priority, pointer|
-            @priority_pointer[priority] = @first_pointer if prev == pointer
-          end
-          prev
-        end
-      end
-
-    end
-  end
-end