tsafe 0.0.11 → 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4f86e8634d75137b3cc4e0028ea91ecd817b3bb
+  data.tar.gz: a808258388e5f91e46968714eb244f9441d32923
+SHA512:
+  metadata.gz: 5e1cd00910e7af20774471c76ba8458ff24534cfa466b31ad94bccfc6c5396cbada12771423f9fa0469e89f0450ecae6ecca8c2c392af87998261fa9185031c7
+  data.tar.gz: 02b4accddafaf35f3aceb98bf309bdccd58c67361ed41ebc0be2e146e98971c8e03965ede29d70785165aabc22f5cfd002ef70cc8701190024b61abb3b32bf8c

data/.rubocop.yml

@@ -0,0 +1,73 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - tsafe.gemspec
+
+# https://github.com/AtomLinter/linter-rubocop/issues/2
+Style/FileName:
+  Enabled: false
+
+# Metrics/LineLength:
+#  Max: 160
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 250
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLines:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/NilComparison:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+  Enabled: true
+
+# Disabled on purpose: https://github.com/bbatsov/rubocop/issues/1758
+Style/ClosingParenthesisIndentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-08 11:42:03 +0100 using RuboCop version 0.37.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 298
+
+# Offense count: 1
+Style/ClassAndModuleCamelCase:
+  Exclude:
+    - 'lib/tsafe_mrswlock_synmodule.rb'

data/Gemfile

@@ -10,4 +10,6 @@ group :development do
   gem "rdoc", "~> 3.12"
   gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.8.3"
+  gem "best_practice_project", github: "kaspernj/best_practice_project", require: false
+  gem "rubocop", "0.37.0", require: false
 end

data/Gemfile.lock

@@ -1,17 +1,61 @@
+GIT
+  remote: git://github.com/kaspernj/best_practice_project.git
+  revision: 9c747dd3b66ee18010c6f5c839e05c36452d44ea
+  specs:
+    best_practice_project (0.0.9)
+      auto_autoloader
+
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.4.0)
+    ast (2.2.0)
+    auto_autoloader (0.0.4)
+      string-cases
+    builder (3.2.2)
     diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
+    faraday (0.8.11)
+      multipart-post (~> 1.2.0)
+    git (1.2.9.1)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    jeweler (1.8.8)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.7.3)
-    json (1.7.3-java)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    json (1.8.3)
+    json (1.8.3-java)
+    jwt (1.5.1)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    nokogiri (1.5.10-java)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.3.0.3)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -21,13 +65,27 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    rubocop (0.37.0)
+      parser (>= 2.3.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    string-cases (0.0.4)
+    unicode-display_width (0.3.1)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
+  best_practice_project!
   bundler (>= 1.0.0)
   jeweler (~> 1.8.3)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
+  rubocop (= 0.37.0)
+
+BUNDLED WITH
+   1.11.2

data/{README.rdoc → README.md}

@@ -1,9 +1,9 @@
-= tsafe
+= Tsafe
 
-Description goes here.
+Various classes for thread safe operations in Ruby and JRuby.
 
 == Contributing to tsafe
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,41 +9,44 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
+require "rake"
 
-require 'jeweler'
+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 = "tsafe"
   gem.homepage = "http://github.com/kaspernj/tsafe"
   gem.license = "MIT"
-  gem.summary = %Q{Threadsafe proxy, array, hash and framework for making other classes threadsafe.}
-  gem.description = %Q{Proxy-objects for making another object threadsafe by proxying calls through mutex and method_missing. Monitored array and hash where all methods are going through monitor. Threadsafe class for including into a class that extends another class in order to make it threadsafe.}
+  gem.summary = %(Threadsafe proxy, array, hash and framework for making other classes threadsafe.)
+  gem.description = %(Proxy-objects for making another object threadsafe by proxying calls through mutex and method_missing. Monitored array and hash where all methods are going through monitor. Threadsafe class for including into a class that extends another class in order to make it threadsafe.)
   gem.email = "k@spernj.org"
   gem.authors = ["Kasper Johansen"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
   spec.rcov = true
 end
 
-task :default => :spec
+task default: :spec
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "tsafe #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
+
+require "best_practice_project"
+BestPracticeProject.load_tasks

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/lib/tsafe.rb

@@ -1,24 +1,24 @@
 require "monitor"
 
-#This module contains various tools to handle thread-safety easily and pretty.
+# This module contains various tools to handle thread-safety easily and pretty.
 module Tsafe
-  #Autoloader for subclasses.
+  # Autoloader for subclasses.
   def self.const_missing(name)
-    filep = "#{File.dirname(__FILE__)}/tsafe_#{name.to_s.downcase}"
-    
-    if RUBY_ENGINE == "jruby" and File.exists?("#{filep}_jruby.rb")
-      require "#{filep}_jruby.rb"
+    file_path = "#{File.dirname(__FILE__)}/tsafe_#{name.to_s.downcase}"
+
+    if RUBY_ENGINE == "jruby" && File.exist?("#{file_path}_jruby.rb")
+      require "#{file_path}_jruby.rb"
     else
-      require filep
+      require file_path
     end
-    
-    raise "Still not loaded: '#{name}'." if !Tsafe.const_defined?(name)
-    return Tsafe.const_get(name)
+
+    return Tsafe.const_get(name) if Tsafe.const_defined?(name)
+    super
   end
-  
-  #JRuby can corrupt an array in a threadded env. Use this method to only get a synchronized array when running JRuby in order to not having to write "if RUBY_ENGINE"-stuff.
+
+  # JRuby can corrupt an array in a threadded env. Use this method to only get a synchronized array when running JRuby in order to not having to write "if RUBY_ENGINE"-stuff.
   def self.std_array
     return Tsafe::MonArray.new if RUBY_ENGINE == "jruby"
-    return []
+    []
   end
-end
+end

data/lib/tsafe_monarray.rb

@@ -1,12 +1,14 @@
-#Predefined synchronized array.
+# Predefined synchronized array.
 #
 #===Examples
 #  arr = Tsafe::MonArray.new
 #  arr << 5
 #  ret = arr[0]
 class Tsafe::MonArray < ::Array
+  # rubocop:disable Style/ClassVars
   @@tsafe_mrswlock_w_methods = [:<<, :collect, :collect!, :compact!, :delete, :delete_at, :delete_if, :drop, :drop_while, :fill, :flatten!, :insert, :keep_if, :map, :map!, :replace, :shuffle!, :slice!, :shift, :sort!, :sort_by!, :unshift]
   @@tsafe_mrswlock_r_methods = [:each, :each_index, :take_while]
-  
+  # rubocop:enable Style/ClassVars
+
   include Tsafe::Mrswlock_synmodule
-end
+end

data/lib/tsafe_monhash.rb

@@ -1,12 +1,14 @@
-#Predefined synchronized hash.
+# Predefined synchronized hash.
 #
 #===Examples
 #  h = Tsafe::MonHash.new
 #  h['test'] = 'trala'
 #  ret = h['test']
 class Tsafe::MonHash < ::Hash
+  # rubocop:disable Style/ClassVars
   @@tsafe_mrswlock_w_methods = [:[]=, :clear, :delete, :delete_if, :keep_if, :merge!, :rehash, :reject!, :replace, :select!, :shift, :store, :update, :values_at]
   @@tsafe_mrswlock_r_methods = [:each, :each_key, :each_pair, :each_value]
-  
+  # rubocop:enable Style/ClassVars
+
   include Tsafe::Mrswlock_synmodule
-end
+end

data/lib/tsafe_monitored.rb

@@ -1,4 +1,4 @@
-#This module can be included on a class to make all method-calls synchronized (by using monitor). Examples with array and hash are below.
+# This module can be included on a class to make all method-calls synchronized (by using monitor). Examples with array and hash are below.
 #
 #===Examples
 #  class MySyncedClass < SomeOtherClassThatNeedsToBeSynchronized
@@ -7,23 +7,23 @@
 module Tsafe::Monitored
   def self.included(base)
     base.to_s.split("::").inject(Object, :const_get).class_eval do
-      self.instance_methods.each do |method_name|
-        #These two methods create warnings under JRuby.
+      instance_methods.each do |method_name|
+        # These two methods create warnings under JRuby.
         if RUBY_ENGINE == "jruby"
-          next if method_name == :instance_exec or method_name == :instance_eval
+          next if method_name == :instance_exec || method_name == :instance_eval
         end
-        
+
         new_method_name = "_ts_#{method_name}"
         alias_method(new_method_name, method_name)
-        
+
         define_method method_name do |*args, &block|
-          #Need to use monitor, since the internal calls might have to run not-synchronized, and we have just overwritten the internal methods.
-          @_ts_mutex = Monitor.new if !@_ts_mutex
+          # Need to use monitor, since the internal calls might have to run not-synchronized, and we have just overwritten the internal methods.
+          @_ts_mutex = Monitor.new unless @_ts_mutex
           @_ts_mutex.synchronize do
-            return self._ts___send__(new_method_name, *args, &block)
+            return _ts___send__(new_method_name, *args, &block)
           end
         end
       end
     end
   end
-end
+end

data/lib/tsafe_mrswlock.rb

@@ -7,70 +7,66 @@ class Tsafe::Mrswlock
     @reads = 0
     @w_mutex = Mutex.new
     @threads_read_stopped = []
-    
-    #This variable is used to allow reads from the writing thread (monitor-behavior).
+
+    # This variable is used to allow reads from the writing thread (monitor-behavior).
     @locked_by = nil
-    
-    #This hash holds thread-IDs for threads that are reading.
+
+    # This hash holds thread-IDs for threads that are reading.
     @reading_threads = {}
   end
-  
+
   # Runs the given block through the read-synchronization.
   def rsync
     begin
-      begin
-        tid = Thread.current.__id__
-        
-        while @w_mutex.locked? and @locked_by != tid
-          @threads_read_stopped << Thread.current
-          Thread.stop
-        end
-        
-        @threads_read_stopped.delete(Thread.current)
-        @reading_threads[tid] = true
-        @reads += 1
-        yield
-      ensure
-        @reading_threads.delete(tid)
-        @reads -= 1
+      tid = Thread.current.__id__
+
+      while @w_mutex.locked? && @locked_by != tid
+        @threads_read_stopped << Thread.current
+        Thread.stop
       end
+
+      @threads_read_stopped.delete(Thread.current)
+      @reading_threads[tid] = true
+      @reads += 1
+      yield
     ensure
-      #Restart stopped writing-thread.
-      @threads_write_stopped.run if @threads_write_stopped and @reads <= 0
+      @reading_threads.delete(tid)
+      @reads -= 1
     end
+  ensure
+    # Restart stopped writing-thread.
+    @threads_write_stopped.run if @threads_write_stopped && @reads <= 0
   end
-  
-  #Runs the given block through the write-synchronization (locks both reading and writing).
+
+  # Runs the given block through the write-synchronization (locks both reading and writing).
   #===Examples
   #  lock.wsync do
   #    #do something within lock.
   #  end
   def wsync
-    begin
-      @w_mutex.synchronize do
-        begin
-          tid = Thread.current.__id__
-          @locked_by = tid
-          
-          #Wait for any reads to finish that might have started while we were getting the lock.
-          #Also allow write if there is only one reading thread and that reading thread is the current thread.
-          while @reads > 0
-            raise ThreadError, "Deadlock: Writing is not allowed while reading." if @reading_threads.key?(tid)
-            @threads_write_stopped = Thread.current
-            Thread.stop
-          end
-          
-          yield
-        ensure
-          @locked_by = nil
-          @threads_write_stopped = nil
+    @w_mutex.synchronize do
+      begin
+        tid = Thread.current.__id__
+        @locked_by = tid
+
+        # Wait for any reads to finish that might have started while we were getting the lock.
+        # Also allow write if there is only one reading thread and that reading thread is the current thread.
+        while @reads > 0
+          raise ThreadError, "Deadlock: Writing is not allowed while reading." if @reading_threads.key?(tid)
+          @threads_write_stopped = Thread.current
+          Thread.stop
         end
+
+        yield
+      ensure
+        @locked_by = nil
+        @threads_write_stopped = nil
       end
-    ensure
-      #Restart any stopped reading-threads.
-      while thread = @threads_read_stopped.shift
-        thread.run
-      end
+    end
+  ensure
+    # Restart any stopped reading-threads.
+    while (thread = @threads_read_stopped.shift)
+      thread.run
     end
   end
-end
+end