zache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54dd40fa91ad83f55060c983e59e4e371064313a10954e10a616fb991b8d1f43
+  data.tar.gz: 3cbf51535b7b696e8d02fbb917739b3a46d9a39e22416e3b4de0b0527fc2eb75
+SHA512:
+  metadata.gz: 1afff4f4fcf1f5250e291486a324a97bb8f78ce70eb042293c7f9d06bc745b043e1329c725e089f9b7579e389c405bad7469d085961dc3e909a00c0b46813d85
+  data.tar.gz: 2e88abe56d9447451253aa3a0829451ece1c8a6393cb2dd9cb1676bc0cc062722f5bd2bdf446a25cae8cd78cca3576a78f54553a408b5b6c5e67a0459559ce53

data/.0pdd.yml

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

data/.gitignore

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

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,10 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3.3
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 30
+Metrics/MethodLength:
+  Max: 30

data/.rultor.yml

@@ -0,0 +1,23 @@
+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" zache.gemspec
+    git add zache.gemspec
+    git commit -m "Version set to ${tag}"
+    gem build zache.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  commanders: []
+deploy: {}

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 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'
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/zache)](http://www.rultor.com/p/yegor256/zache)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/yegor256/zache.svg)](https://travis-ci.org/yegor256/zache)
+[![Gem Version](https://badge.fury.io/rb/zache.svg)](http://badge.fury.io/rb/zache)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c136afe340fa94f14696/maintainability)](https://codeclimate.com/github/yegor256/zache/maintainability)
+
+It's a simple Ruby gem for in-memory cache.
+
+First, install it:
+
+```bash
+$ gem install zache
+```
+
+Then, use it like this
+
+```ruby
+require 'zache'
+zache = Zache.new
+# Expires in 5 minutes
+v = zache.get(:count, lifetime: 5 * 60) { expensive() }
+```
+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 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,52 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 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 '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/lib/zache.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 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.
+
+# Cache.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class Zache
+  def initialize
+    @hash = {}
+    @mutex = Mutex.new
+  end
+
+  def get(key, lifetime: 60 * 60)
+    @mutex.synchronize do
+      rec = @hash[key]
+      rec = nil if !rec.nil? && rec[:start] < Time.now - rec[:lifetime]
+      if rec.nil?
+        @hash[key] = {
+          value: yield,
+          start: Time.now,
+          lifetime: lifetime
+        }
+      end
+      @hash[key][:value]
+    end
+  end
+end

data/test/test_zache.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 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/zache'
+
+# Cache test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class ZacheTest < Minitest::Test
+  def test_caches
+    cache = Zache.new
+    first = cache.get(:hey, lifetime: 5) { Random.rand }
+    second = cache.get(:hey) { Random.rand }
+    assert(first == second)
+  end
+
+  def test_caches_and_expires
+    cache = Zache.new
+    first = cache.get(:hey, lifetime: 0.01) { Random.rand }
+    sleep 0.1
+    second = cache.get(:hey) { Random.rand }
+    assert(first != second)
+  end
+
+  def test_caches_in_threads
+    cache = Zache.new
+    Threads.new(10).assert(100) do
+      cache.get(:hey, lifetime: 0.0001) { Random.rand }
+    end
+  end
+end

data/zache.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 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 = 'zache'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'In-memory Cache'
+  s.description = 'Zero-footprint in-memory thread-safe cache'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/zache'
+  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'
+  s.add_development_dependency 'rake', '~>12'
+  s.add_development_dependency 'rdoc', '~>4'
+  s.add_development_dependency 'rubocop', '0.58.1'
+  s.add_development_dependency 'rubocop-rspec', '~>1'
+  s.add_development_dependency 'threads', '~>0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: zache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: threads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Zero-footprint in-memory thread-safe cache
+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
+- lib/zache.rb
+- test/test_zache.rb
+- zache.gemspec
+homepage: http://github.com/yegor256/zache
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 2
+summary: In-memory Cache
+test_files:
+- test/test_zache.rb