syncem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7d113c834d559321aeaa30fa6f9da68bb49f26b83e2309196fda47e70656a82
+  data.tar.gz: 277e6dd0a02a58113dc3aed41aeb250ebc0629c1d804f7a77050c2e2c3789908
+SHA512:
+  metadata.gz: efff7adc096e2036d36176221755cbcf353af7213f39eb03c211832fe7e0ed3ebbc7363585158cddaf320ac8d3f8901a42139cda770bddd50e3bfbb9f5f9ffa6
+  data.tar.gz: d7183f7a4731ef650f9909401f2b02712a001f6b06cc5685f8a783fdaacf692de0b0386fb26c57ba7c7583e61d8e67adbf84cc3eb3d848831e5125af1f8c5e22

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store
+rdoc/
+.idea/

data/.pdd

@@ -0,0 +1,5 @@
+--source=.
+--verbose
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Metrics/AbcSize:
+  Max: 65
+Metrics/BlockLength:
+  Max: 30
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 180
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Metrics/ParameterLists:
+  Max: 10
+Layout/AlignParameters:
+  Enabled: false

data/.rultor.yml

@@ -0,0 +1,26 @@
+assets:
+  rubygems.yml: zerocracy/home#assets/rubygems.yml
+install: |-
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
+release:
+  script: |-
+    bundle install
+    rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" syncem.gemspec
+    git add syncem.gemspec
+    git commit -m "Version set to ${tag}"
+    gem build syncem.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  commanders: []
+  script: |-
+    bundle install
+    rake
+deploy: {}

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.6.0
+branches:
+  only:
+    - master
+install:
+  - bundle install
+script:
+  - set -e
+  - rake
+

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018-2019 Yegor Bugayenko
+#
+# 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.
+
+source 'https://rubygems.org'
+ruby '~>2.3'
+gemspec

data/README.md

@@ -0,0 +1,69 @@
+[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/syncem)](http://www.rultor.com/p/yegor256/syncem)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/yegor256/syncem.svg)](https://travis-ci.org/yegor256/syncem)
+[![Build status](https://ci.appveyor.com/api/projects/status/po1mn8ca96jk0llr?svg=true)](https://ci.appveyor.com/project/yegor256/syncem)
+[![Gem Version](https://badge.fury.io/rb/syncem.svg)](http://badge.fury.io/rb/syncem)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5528e182bb5e4a2ecc1f/maintainability)](https://codeclimate.com/github/yegor256/syncem/maintainability)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/syncem/master/frames)
+
+Sometimes you have an object that is not thread-safe,
+but you need to make sure each of its methods is thread-safe, because they
+deal with some resources, like files or databases and you want them to
+manage those resources sequentially. This small gem will help you achieve
+exactly that without any re-design of the objects you already have. Just
+decorate them with `SyncEm` decorator and that is it.
+
+First, install it:
+
+```bash
+$ gem install syncem
+```
+
+Then, use it like this:
+
+```ruby
+require 'syncem'
+obj = SyncEm.new(obj)
+```
+
+That's it.
+
+# How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure you build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2018-2019 Yegor Bugayenko
+
+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/Rakefile

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018-2019 Yegor Bugayenko
+#
+# 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.
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+CLEAN = FileList['coverage']
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end

data/appveyor.yml

@@ -0,0 +1,25 @@
+version: '{build}'
+skip_tags: true
+clone_depth: 10
+branches:
+  only:
+    - master
+  except:
+    - gh-pages
+os: Windows Server 2012
+environment:
+  matrix:
+    - ruby_version: "25-x64"
+install:
+  - ps: |
+      $Env:PATH = "C:\Ruby${Env:ruby_version}\bin;${Env:PATH}"
+  - bundle config --local path vendor/bundle
+  - ruby -v
+  - bundle -v
+build_script:
+  - bundle update
+  - bundle install
+test_script:
+  - bundle exec rake --quiet
+cache:
+  - vendor/bundle

data/lib/syncem.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018-2019 Yegor Bugayenko
+#
+# 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.
+
+# SyncEm is a simple decorator of an existing object that makes all its
+# methods thread-safe.
+#
+# For more information read
+# {README}[https://github.com/yegor256/syncem/blob/master/README.md] file.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018-2019 Yegor Bugayenko
+# License:: MIT
+class SyncEm
+  def initialize(origin)
+    @origin = origin
+    @mutex = Mutex.new
+  end
+
+  def method_missing(*args)
+    @mutex.synchronize do
+      if @origin.respond_to?(args[0])
+        @origin.send(*args)
+      else
+        super
+      end
+    end
+  end
+
+  def respond_to?(method, include_private = false)
+    @origin.respond_to?(method, include_private)
+  end
+
+  def respond_to_missing?(_method, _include_private = false)
+    true
+  end
+end

data/syncem.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018-2019 Yegor Bugayenko
+#
+# 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.
+
+require 'English'
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.3.3'
+  s.required_ruby_version = '>=2.3'
+  s.name = 'syncem'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'Thread-safe decorator of Ruby objects'
+  s.description = 'Sometimes you have an object that is not thread-safe,
+but you need to make sure each of its methods is thread-safe, because they
+deal with some resources, like files or databases and you want them to
+manage those resources sequentially. This small gem will help you achieve
+exactly that without any re-design of the objects you already have. Just
+decorate them with SyncEm decorator and that is it.'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/syncem'
+  s.files = `git ls-files`.split($RS)
+  s.test_files = s.files.grep(%r{^(test)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md']
+  s.add_development_dependency 'minitest', '5.11.3'
+  s.add_development_dependency 'rake', '12.3.1'
+  s.add_development_dependency 'rdoc', '4.3.0'
+  s.add_development_dependency 'rubocop', '0.62.0'
+  s.add_development_dependency 'rubocop-rspec', '1.31.0'
+  s.add_development_dependency 'threads', '0.3.0'
+end

data/test/test_syncem.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018-2019 Yegor Bugayenko
+#
+# 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.
+
+require 'minitest/autorun'
+require 'threads'
+require_relative '../lib/syncem'
+
+# Syncem test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018-2019 Yegor Bugayenko
+# License:: MIT
+class SyncEmTest < Minitest::Test
+  class Account
+    def initialize(file)
+      @file = file
+    end
+
+    def balance
+      File.exist?(@file) ? IO.read(@file).to_i : 0
+    end
+
+    def add(amount)
+      now = File.exist?(@file) ? IO.read(@file).to_i : 0
+      IO.write(@file, (now + amount).to_s)
+    end
+  end
+
+  def test_wraps_simple_object
+    Dir.mktmpdir do |dir|
+      path = File.join(dir, 'f.txt')
+      acc = Account.new(path)
+      assert_equal(0, acc.balance)
+      acc.add(50)
+      assert_equal(50, acc.balance)
+      acc.add(-10)
+      assert_equal(40, acc.balance)
+    end
+  end
+
+  def test_respond_to
+    Dir.mktmpdir do |dir|
+      path = File.join(dir, 'f.txt')
+      acc = SyncEm.new(Account.new(path))
+      assert(acc.respond_to?(:balance))
+      assert(acc.respond_to?(:add))
+    end
+  end
+
+  def test_multiple_threads
+    Dir.mktmpdir do |dir|
+      path = File.join(dir, 'f.txt')
+      acc = SyncEm.new(Account.new(path))
+      threads = 10
+      Threads.new(threads).assert do
+        acc.add(10)
+      end
+      assert_equal(threads * 10, acc.balance)
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: syncem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.62.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: threads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: |-
+  Sometimes you have an object that is not thread-safe,
+  but you need to make sure each of its methods is thread-safe, because they
+  deal with some resources, like files or databases and you want them to
+  manage those resources sequentially. This small gem will help you achieve
+  exactly that without any re-design of the objects you already have. Just
+  decorate them with SyncEm decorator and that is it.
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".0pdd.yml"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/syncem.rb
+- syncem.gemspec
+- test/test_syncem.rb
+homepage: http://github.com/yegor256/syncem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 2
+summary: Thread-safe decorator of Ruby objects
+test_files:
+- test/test_syncem.rb