callback-locker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e38ddbf64c1989a65c8ae972c59727ffc29e9d8
+  data.tar.gz: 93c024695d68ea5e78a6e0867f020b1c373addd4
+SHA512:
+  metadata.gz: 5c54a12f7d18440f4a4623ea3b2f91959c1ffeb6fb8a002765ccf72c88857164d58aaf36030882e2488e377425da1b0f53a85ef352af4fc38531b6cf7524b59e
+  data.tar.gz: 807f23545b9e4f8a0dab1911c1c9b74795335199379d6a454938a8b2674d26f6a2e6ad98b00b112573f2e4e6fae9e0003f6e786805dedec088172e459db7bcf2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>mp Ruby Callback Locker</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/CHANGES.txt

@@ -0,0 +1,3 @@
+
+0.1.0 (2015-07-18)
+* initial version

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.5.2"
+  gem "riot", ">= 0.12.3"
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    jwt (1.5.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    riot (0.12.7)
+      rr
+    rr (1.1.2)
+    thread_safe (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (>= 1.5.2)
+  riot (>= 0.12.3)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 - 2015 Martin Poljak (martin@poljak.cz)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+Callback Locker
+===============
+
+"Locker" is lockable box for equipment -- at this case box for
+collecting the callbacks (in its locked state) and running them
+after unlocking. So, in fact, it serves as some kind of callback
+semaphore or mutex.
+
+Some trivial example:
+
+```ruby
+require "callback-locker"
+locker = CallbackLocker::new
+
+foo = nil
+locker.synchronize do
+    foo = "bar"
+end
+
+# ^^^ locker is unlocked, so #synchronize will execute callback
+#     immediately
+
+foo = nil
+locker.lock!
+locker.synchronize do
+    foo = "1"
+end
+locker.synchronize do
+    foo << "2"
+end
+locker.unlock!
+
+# ^^^ locker is locked, so callbacks are stacked and executed
+#     immediately after the #unlock! method is call, so foo
+#     will contain "12"
+```
+
+Copyright
+---------
+
+Copyright &copy; 2011 &ndash; 2015 [Martin Poljak][10]. See `LICENSE.txt` for
+further details.
+
+[8]: http://rubyeventmachine.com/
+[9]: http://github.com/martinkozak/callback-adapter/issues
+[10]: http://www.martinpoljak.net/

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "callback-locker"
+  gem.homepage = "http://github.com/martinkozak/callback-locker"
+  gem.license = "MIT"
+  gem.summary = 'Semaphore (mutex) like primitive for synchronizing callbacks.'
+    gem.email = "martin@poljak.net"
+  gem.authors = ["Martin Poljak"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/callback-locker.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: callback-locker 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "callback-locker"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Martin Poljak"]
+  s.date = "2015-07-18"
+  s.email = "martin@poljak.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".project",
+    "CHANGES.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "callback-locker.gemspec",
+    "lib/callback-locker.rb",
+    "test"
+  ]
+  s.homepage = "http://github.com/martinkozak/callback-locker"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5"
+  s.summary = "Semaphore (mutex) like primitive for synchronizing callbacks."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_development_dependency(%q<riot>, [">= 0.12.3"])
+    else
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+      s.add_dependency(%q<riot>, [">= 0.12.3"])
+    end
+  else
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
+    s.add_dependency(%q<riot>, [">= 0.12.3"])
+  end
+end
+

data/lib/callback-locker.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# Runs or defers callbacks according to its internal locked
+# or unlocked state.
+#
+
+class CallbackLocker
+  
+    ##
+    # Indicates locker is locked.
+    # @returns [Boolean] +true+ if it's, +false+ otherwise
+    #
+    
+    @locked
+    
+    ##
+    # Indicates, locker is just in synchronization state, 
+    # so stack of callbacks is evaluated just now.
+    #
+    # @returns [Boolean] +true+ if it's, +false+ otherwise
+    #
+    
+    @syncing
+    
+    ##
+    # Holds callback stack.
+    # @return [Array]  array of callbacks
+    #
+    
+    attr_accessor :stack
+    @stack
+    
+    ##
+    # Constructor.
+    #
+    
+    def initialize
+        @syncing = false
+        @locked = false
+        @stack = [ ]
+    end
+
+    ##
+    # Locks the locker. Note, it's also alias for 
+    # {#try_lock} which is multiple pass-in so sets 
+    # lock although it's locked. 
+    #
+    
+    def lock
+        @locked = true
+    end
+    
+    alias :try_lock :lock
+    alias :lock! :lock
+    alias :try_lock! :try_lock
+    
+    ##
+    # Unlocks the locker.
+    #
+    
+    def unlock
+        @locked = false
+        self.eval!
+    end
+    
+    alias :unlock! :unlock
+    
+    ##
+    # Indicates, locker is locked.
+    # @return [Boolean] +true+ if it's, +false+ otherwise
+    #
+    
+    def locked?
+        @locked
+    end
+    
+    ##
+    # Indicates, locker is unlocked.
+    # @return [Boolean] +true+ if it's, +false+ otherwise
+    #
+    
+    def unlocked?
+        not self.locked?
+    end
+        
+    ##
+    # Synchronizes using the lock. Works by similiar 
+    # way as standard +Mutex#synchronize+.
+    #
+    # @yield if locker is unlocked the given callback
+    #
+    
+    def synchronize(&block)
+        if self.locked? or @syncing
+            @stack << block
+        else
+            @syncing = true
+            yield
+            @syncing = false
+            
+            if not @stack.empty?
+                self.eval!
+            end
+        end
+    end
+    
+    
+    ##
+    # Evals the stack.
+    #
+
+    protected    
+    def eval!
+        @syncing = true
+        @stack.each { |b| b.call() }
+        @stack.clear()
+        @syncing = false        
+    end
+
+end
+

data/test

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+$:.unshift("./lib")
+
+require "callback-locker"
+require "riot"
+  
+context "CallbackLocker" do
+    setup do
+        CallbackLocker::new
+    end
+    
+    asserts("#initialize") do
+        not topic.locked? and topic.stack == [ ]
+    end
+    asserts("#lock, #locked?") do
+        topic.lock
+        topic.locked?
+    end
+    asserts("#unlock, #unlocked?") do
+        topic.unlock
+        topic.unlocked?
+    end
+    asserts("#synchronize") do
+        foo1 = nil
+        topic.synchronize do
+            foo1 = :a
+        end
+        
+        foo2 = nil
+        topic.lock!
+        topic.synchronize do
+            foo2 = "1"
+        end
+        topic.synchronize do
+            foo2 << "2"
+        end
+        foo3 = foo2
+        topic.unlock!
+        
+        foo1 == :a and foo2 == "12" and foo3.nil?
+    end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: callback-locker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Poljak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.3
+description: 
+email: martin@poljak.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".project"
+- CHANGES.txt
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- callback-locker.gemspec
+- lib/callback-locker.rb
+- test
+homepage: http://github.com/martinkozak/callback-locker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Semaphore (mutex) like primitive for synchronizing callbacks.
+test_files: []