any_cache 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 143bed36460bc0933747966980cb735113a59b2f3b018d25f0b86ddb2cce17c3
-  data.tar.gz: 05afa376e37f2e504cd87aa296048b67085ccd4a58157cebd52a9665421473a1
+  metadata.gz: 8b5cb4e91050841afb6fb75ae7cdf793a209291e28521a07467c3172ca6327b7
+  data.tar.gz: 127050e1c3e23797c9ea49c418818ecb54dc34c2c882cf3a20ea095bfe5a852b
 SHA512:
-  metadata.gz: 6527203702f2cc6de87163dae5ec5262699a117f7fb2bb4544ee41e1f7c261a7c088fa71605962d941235e870987776f99f10690674568df9c1b04bea48b9c53
-  data.tar.gz: c81ea6185abc84cb2936b3e42211edf97092809a77701e38210b538548b7875f93766c05f91b646a1924d372e2812e1e9914a138a0d215520d44742fd642a9db
+  metadata.gz: dac1643ccf2b3ade6a75c5c7f55c37b69bd41ac8b057c43cb581a58bd2eb3f82e0e5d66562a66f8545a4ec1289f004f5bb3bc589861f6b9c980b297dc41bc58c
+  data.tar.gz: 83ec5094b541f79268691ea95e8daeaa01a6d296fbe7e1728289cf7e96ba03536787a3af137350a88194f7264067ffb2a6457611a22bccdf3ef26731e7a46c44

data/.gitignore

@@ -1,11 +1,15 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
+.rspec_status
+.ruby-version
+gemfiles/*.lock
+*.gem
+/spec/support/artifacts/*
 .rspec_status

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_gem:
+  armitage-rubocop:
+    - lib/rubocop.general.yml
+    - lib/rubocop.rspec.yml
+
+AllCops:
+  UseCache: true
+  TargetRubyVersion: 2.5.1
+  Include:
+    - bin/console
+    - lib/**/*.rb
+    - spec/**/*.rb
+    - Gemfile
+    - Rakefile
+    - any_cache.gemspec
+
+Layout/MultilineOperationIndentation:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,84 @@
-sudo: false
 language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.2
+sudo: false
+before_install: gem install bundler
+cache: bundler
+script:
+- bundle exec rspec
+services:
+- redis-server
+- memcached
+matrix:
+  fast_finish: true
+  include:
+  - rvm: 2.3.7
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_MEMORY_STORE_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_MEMORY_STORE_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_MEMORY_STORE_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_MEMORY_STORE_CACHE=true
+  - rvm: 2.3.7
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_FILE_STORE_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_FILE_STORE_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_FILE_STORE_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/active_support.gemfile
+    env: TEST_AS_FILE_STORE_CACHE=true
+  - rvm: 2.3.7
+    gemfile: gemfiles/active_support_with_redis.gemfile
+    env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/active_support_with_redis.gemfile
+    env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/active_support_with_redis.gemfile
+    env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/active_support_with_redis.gemfile
+    env: TEST_AS_REDIS_CACHE_STORE_CACHE=true
+  - rvm: 2.3.7
+    gemfile: gemfiles/dalli.gemfile
+    env: TEST_DALLI_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/dalli.gemfile
+    env: TEST_DALLI_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/dalli.gemfile
+    env: TEST_DALLI_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/dalli.gemfile
+    env: TEST_DALLI_CACHE=true
+  - rvm: 2.3.7
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_STORE_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_STORE_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_STORE_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_STORE_CACHE=true
+  - rvm: 2.3.7
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_CACHE=true
+  - rvm: 2.4.4
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_CACHE=true
+  - rvm: 2.5.1
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_CACHE=true
+  - rvm: ruby-head
+    gemfile: gemfiles/redis_store.gemfile
+    env: TEST_REDIS_CACHE=true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2018-08-26
+- Release :)

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in any_cache.gemspec
 gemspec

data/README.md

@@ -1,43 +1,266 @@
-# AnyCache
+# AnyCache · [![Gem Version](https://badge.fury.io/rb/any_cache.svg)](https://badge.fury.io/rb/any_cache) [![Build Status](https://travis-ci.org/0exp/any_cache.svg?branch=master)](https://travis-ci.org/0exp/any_cache) [![Coverage Status](https://coveralls.io/repos/github/0exp/any_cache/badge.svg)](https://coveralls.io/github/0exp/any_cache)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/any_cache`. To experiment with that code, run `bin/console` for an interactive prompt.
+AnyCache - a simplest cache wrapper that provides a minimalistic generic interface for all well-known cache storages and includes a minimal set of necessary operations:
+`read`, `write`, `delete`, `expire`, `persist`, `clear`, `increment`, `decrement`.
 
-TODO: Delete this and the text above, and describe your gem
+Supported clients:
 
-## Installation
+- `Redis` ([gem redis](https://github.com/redis/redis-rb)) ([redis storage](https://redis.io/))
+- `Redis::Store` ([gem redis-store](https://github.com/redis-store/redis-store)) ([redis storage](https://redis.io/))
+- `Dalli::Client` ([gem dalli](https://github.com/petergoldstein/dalli)) ([memcached storage](https://memcached.org/))
+- `ActiveSupport::Cache::FileStore` ([gem activesupport](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/file_store.rb)) ([file storage](https://api.rubyonrails.org/classes/ActiveSupport/Cache/FileStore.html))
+- `ActiveSupport::Cache::MemoryStore` ([gem activesupport](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/memory_store.rb)) ([in memory storage](https://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html))
+- `ActiveSupport::Cache::RedisCacheStore` ([gem activesupport](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/cache/redis_cache_store.rb)) ([redis cache storage](https://api.rubyonrails.org/classes/ActiveSupport/Cache/RedisCacheStore.html))
+
+---
 
-Add this line to your application's Gemfile:
+## Installation
 
 ```ruby
 gem 'any_cache'
 ```
 
-And then execute:
+```shell
+bundle install
+# --- or ---
+gem install any_cache
+```
+
+```ruby
+require 'any_cache'
+```
+
+---
+
+## Usage / Table of Contents
+
+- [Creation](#creation)
+- **Operations**
+    - [Read](#read)
+    - [Write](#write)
+    - [Delete](#delete)
+    - [Increment](#increment)
+    - [Decrement](#decrement)
+    - [Expire](#expire)
+    - [Persist](#persist)
+    - [Clear](#clear)
+
+---
+
+### Creation
+
+To instantiate AnyCache instance you have to provide a client.
+Client - an independent driver that works with a corresponding cache storage (external dependency).
+Supported clients:
+
+- `Redis`
+- `Redis::Store`
+- `Dalli::Client`
+- `ActiveSupport::Cache::RedisCacheStore`
+- `ActiveSupport::Cache::FileStore`
+- `ActiveSupport::Cache::MemoryStore`
+
+`AnyCache` instantiation:
+
+```ruby
+# 1) create client object
+client = Redis.new(...)
+# -- or --
+client = Redis::Store.new(...)
+# -- or --
+client = Dalli::Client.new(...)
+# -- or --
+client = ActiveSupport::Cache::RedisCacheStore.new(...)
+# -- or --
+client = ActiveSupport::Cache::FileStore.new(...)
+# -- or --
+client = ActiveSupport::Cache::MemoryStore.new(...)
+
+# 2) build AnyCache instance
+any_cache = AnyCache.build(client) # => <AnyCache:0x00007f990527f268 ...>
+```
+
+If you want to use your own cache client implementation, you should provide an object that responds to:
+
+- `#read(key, [**options])` ([doc](#read))
+- `#write(key, value, [**options])` ([doc](#write))
+- `#delete(key, [**options])` ([doc](#delete))
+- `#increment(key, amount, [**options])` ([doc](#increment))
+- `#decrmeent(key, amount, [**options])` ([doc](#decrement))
+- `#expire(key, [**options])` ([doc](#expire))
+- `#persist(key, [**options])` ([doc](#persist))
+- `#clear([**options])` ([doc](#clear))
+
+---
 
-    $ bundle
+### Read
 
-Or install it yourself as:
+- `AnyCache#read(key)` - get entry value from cache storage
 
-    $ gem install any_cache
+```ruby
+# --- entry exists ---
+any_cache.read("data") # => "some_data"
+
+# --- entry doesnt exist ---
+any_cache.read("data") # => nil
+```
+
+---
+
+### Write
+
+- `AnyCache#write(key, value, [expires_in:])` - write new entry to cache storage
+
+```ruby
+# --- permanent entry ---
+any_cache.write("data", 123)
+
+# --- temporal entry (expires in 60 seconds) ---
+any_cache.write("data", 123, expires_in: 60)
+```
+
+---
+
+### Delete
+
+- `AnyCache#delete(key)` - remove entry from cache storage
+
+```ruby
+any_cache.delete("data")
+```
+
+---
+
+### Increment
+
+- `AnyCache#increment(key, amount = 1, [expires_in:])` - increment entry's value by passed amount
+  and set new expiration time if needed
+
+```ruby
+# --- increment existing entry ---
+any_cache.write("data", 1)
 
-## Usage
+# --- increment by default value (1) ---
+any_cache.increment("data") # => 2
+
+# --- increment by custom value ---
+any_cache.increment("data", 12) # => 14
+
+# --- increment and expire after 31 seconds
+any_cache.incrmeent("data", expires_in: 31) # => 15
+
+# --- increment nonexistent entry (create new entry) ---
+any_cache.increment("another_data", 5, expires_in: 5) # => 5
+```
+
+---
+
+### Decrement
+
+- `AnyCache#decrement(key, amount = 1, [expires_in:])` - decrement entry's value by passed amount
+  and set new expiration time if needed
+
+```ruby
+# --- decrement existing entry ---
+any_cache.write("data", 15)
+
+# --- decrement by default value (1) ---
+any_cache.decrement("data") # => 14
+
+# --- decrement by custom value ---
+any_cache.decrement("data", 10) # => 4
+
+# --- decrement and expire after 5 seconds
+any_cache.decrememnt("data", expirs_in: 5) # => 3
+
+# --- decrement nonexistent entry (create new entry) ---
+any_cache.decrememnt("another_data", 2, expires_in: 10) # => -2 (or 0 for Dalli::Client)
+```
+
+---
+
+### Expire
+
+- `AnyCache#expire(key, [expires_in:])` - expire entry immediately or set the new expiration time
+
+```ruby
+# --- expire immediately ---
+any_cache.expire("data")
+
+# --- set new expiration time (in seconds) --
+any_cache.expire("data", expires_in: 36)
+```
+
+---
+
+### Persist
+
+- `AnyCache#persist(key)` - change entry's expiration time to permanent
+
+```ruby
+# --- create temporal entry (30 seconds) ---
+any_cache.write("data", { a: 1 }, expires_in: 30)
+
+# --- remove entry expiration (make it permanent) ---
+any_cache.persist("data")
+```
+
+---
+
+### Clear
+
+- `AnyCache#clear()` - clear cache database
+
+```ruby
+# --- prepare cache data ---
+any_cache.write("data", { a: 1, b: 2 })
+any_cache.write("another_data", 123_456)
+
+any_cache.read("data") # => { a: 1, b: 2 }
+any_cache.read("another_data") # => 123_456
+
+# --- clear cache ---
+any_cache.clear
+
+any_cache.read("data") # => nil
+any_cache.read("another_data") # => nil
+```
+
+---
+
+## Build
+
+- see [bin/rspec](bin/rspec)
+
+```shell
+bin/rspec --test-redis # run specs with Redis
+bin/rspec --test-redis-store # run specs with Redis::Store
+bin/rspec --test-dalli # run specs with Dalli::Client
+bin/rspec --test-as-file-store # run specs with ActiveSupport::Cache::FileStore
+bin/rspec --test-as-memory-store # run specs with ActiveSupport::Cache::MemoryStore
+bin/rspec --test-as-redis-cache-store # run specs with ActiveSupport::Cache::RedisCacheStore
+```
 
-TODO: Write usage instructions here
+---
 
-## Development
+## Roadmap
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- configuration layer with ability to instantiate cache clients implicitly
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+---
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/any_cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+- Fork it (https://github.com/0exp/any_cache/fork)
+- Create your feature branch (`git checkout -b feature/my-new-feature`)
+- Commit your changes (`git commit -am 'Add some feature'`)
+- Push to the branch (`git push origin feature/my-new-feature`)
+- Create new Pull Request
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Released under MIT License.
 
-## Code of Conduct
+## Authors
 
-Everyone interacting in the AnyCache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/any_cache/blob/master/CODE_OF_CONDUCT.md).
+Created by [Rustam Ibragimov](https://github.com/0exp/)