somecache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87c3ebe1590cf315cd82cfbf0239809f96883f36e1785770f7bd2294d1b1242f
+  data.tar.gz: f1502fe85ffc5b6c09a7fc43cce618f5957db3323161a7041863e2928d2e926f
+SHA512:
+  metadata.gz: 14591e0a428bfb6a2ded32d6b599f95834e5ea299fc848307fa0a55178f5f5a29d5fc6ee4a7ae10ea2d2f4e2cb8b6125588a774ca40595d5b8a3fb7a470a0790
+  data.tar.gz: a3c10b06b395fe6af8fa2265dda85843222324c0a8ac69fc409af91828eb3947df260ca14f0ded8e0902b18a10d80e957fc32491ab770d952b36f452d36daefa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in somecache.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    somecache (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  somecache!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Carlos Atkinson Ferreira Filho
+
+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,63 @@
+# Somecache
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'somecache'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install somecache
+
+## Usage
+
+Somecache is a wrapper to cache objects (following the `read`, `write`, `fetch` and `delete` api)
+
+The aim is to easily create custom caches (with custom namespace or expiration options)
+
+When working with cache is easy to spread the logic of creation and deletion, like so:
+
+```ruby
+# Some Class
+Rails.cache.fetch("products/#{product_id}", expires_in: 1.day) { Product.find(product_id) }
+
+# Some Worker
+Rails.cache.delete("products/#{product_id}")
+```
+
+Somecache allows you to create and use the cache without spreading cache logic (like the namespace)
+
+```ruby
+# product_cache.rb
+ProductCache = Somecache::Custom.new(namespace: 'products' , cache: Rails.cache, expires_in: 1.day)
+
+# Some Class
+ProductCache.fetch(product_id) { Product.find(product_id) }
+
+# Some Worker
+
+ProductCache.delete(product_id)
+
+```
+
+## Development
+
+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.
+
+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]/somecache.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "somecache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/somecache.rb

@@ -0,0 +1,5 @@
+require 'somecache/version'
+require 'somecache/custom'
+
+module Somecache
+end

data/lib/somecache/custom.rb

@@ -0,0 +1,31 @@
+module Somecache
+  class Custom
+    def initialize(namespace:, cache:, **options)
+      @namespace = namespace
+      @options = options
+      @cache = cache
+    end
+
+    def fetch(key, &block)
+      @cache.fetch(key_with_namespace(key), **@options, &block)
+    end
+
+    def write(key, value)
+      @cache.write(key_with_namespace(key), value, **@options)
+    end
+
+    def read(key)
+      @cache.read(key_with_namespace(key), **@options)
+    end
+
+    def delete(key)
+      @cache.delete(key_with_namespace(key))
+    end
+
+    private
+
+    def key_with_namespace(key)
+      "#{@namespace}/#{key}"
+    end
+  end
+end

data/lib/somecache/version.rb

@@ -0,0 +1,3 @@
+module Somecache
+  VERSION = "0.1.0"
+end

data/somecache.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/somecache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "somecache"
+  spec.version       = Somecache::VERSION
+  spec.authors       = ["Carlos Atkinson Ferreira Filho"]
+  spec.email         = ["carlos.atkinson@vagas.com.br"]
+
+  spec.summary       = %q{Somecache is a ruby microlib to create custom caches}
+  spec.homepage      = "https://github.com/VAGAScom/somecache"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: somecache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Atkinson Ferreira Filho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 
+email:
+- carlos.atkinson@vagas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/somecache.rb
+- lib/somecache/custom.rb
+- lib/somecache/version.rb
+- somecache.gemspec
+homepage: https://github.com/VAGAScom/somecache
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/VAGAScom/somecache
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+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: 4
+summary: Somecache is a ruby microlib to create custom caches
+test_files: []