artirix_cache_service 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8925a97c03f8fda41870180966bfef9e8b224a3
+  data.tar.gz: 453fb7acd85987d1ee0ed7728718a91dc00d68c8
+SHA512:
+  metadata.gz: 1dd2bae6ef68232ae2971aa016f3a04173ff4a03fc9d41598ffc07d10a91eeefde48be2fafe1357f03e564bdeee62c28d45e92bf2ee4f551a06f359d3a443721
+  data.tar.gz: 443f473eccdbf0908a9efdf11e05e046abc052ac8ebe6faf6811cc75717bed1c23c3f13280a6b22929da0c89c20766cf9411e48bb666328b0fd090d35da24064

data/.gitignore

@@ -0,0 +1,10 @@
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.3
+
+addons:
+  code_climate:
+    repo_token: 39d61ce8353fb7524448b8deb2b5a4c0147dd787ed4a47dd0c6e133d812139b4
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - eturino@eturino.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in html_surgeon.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'pry-stack_explorer'
+  gem 'pry-doc'
+  gem 'pry-rescue'
+end
+
+gem 'codeclimate-test-reporter', :group => :test, :require => nil

data/README.md

@@ -0,0 +1,111 @@
+# ArtirixCacheService
+
+[![Gem Version](https://badge.fury.io/rb/artirix_cache_service.svg)](http://badge.fury.io/rb/artirix_cache_service)
+[![Build Status](https://travis-ci.org/artirix/artirix_cache_service.svg?branch=master)](https://travis-ci.org/artirix/artirix_cache_service)
+[![Code Climate](https://codeclimate.com/github/artirix/artirix_cache_service.png)](https://codeclimate.com/github/artirix/artirix_cache_service)
+[![Code Climate Coverage](https://codeclimate.com/github/artirix/artirix_cache_service/coverage.png)](https://codeclimate.com/github/artirix/artirix_cache_service)
+
+The basic use of this gem is to compile a cache key based on a given key prefix 
+and some extra variables or options, with some helper methods.
+
+TODO: also help with the cache options.
+
+## Usage
+
+The basic way of using it is with the `key` method, which will return the key based on the given arguments. 
+
+```ruby
+ArtirixCacheService.key :some_key # => will return a string with the cache key to use
+```
+
+### Prefix
+
+The service can use a prefix to be applied to all keys
+
+```ruby
+ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+ArtirixCacheService.key :some_key # => "configured_prefix/some_key"
+ArtirixCacheService.key :another # => "configured_prefix/another"
+```
+
+### Extra Arguments
+
+We can pass other arguments, that will be treated and appended to the cache key.
+
+note: `blank?` arguments will be skipped.
+
+```ruby
+ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+
+ArtirixCacheService.key :some_key, :arg1, nil, 'arg2' 
+  # => "configured_prefix/some_key/arg1/arg2"
+```
+
+#### `cache_key` compliant arguments
+
+if an argument (including the first argument) responds to `cache_key`, 
+it will be called.
+
+```ruby
+ArtirixCacheService.config_params[:key_prefix] = :configured_prefix
+
+article = Article.find 17
+article.cache_key # => "cache_key_article_17"
+
+ArtirixCacheService.key :some_key, :arg1, article, 'arg2' 
+  # => "configured_prefix/some_key/arg1/cache_key_article_17/arg2"
+```
+
+#### Digest
+
+we may want to add a digest to the cache key instead of all arguments, 
+for example in case that we're giving it a long list.
+
+It will use SHA1.
+
+```ruby
+ArtirixCacheService.config_params[:key_prefix] = :prfx
+
+arg3 = { a: 1, b: 2 }
+ArtirixCacheService.digest arg3 
+  # => "032b5f154d4ada01bc89a2e8fae8251c090212db"
+
+ArtirixCacheService.key :some_key, :arg1, 'arg2', digest: arg3
+  # => "prfx/some_key/arg1/arg2/032b5f154d4ada01bc89a2e8fae8251c090212db"
+
+arg4 = [1, 2, 3]
+ArtirixCacheService.digest [arg3, arg4] 
+  # => "7448a071aeee91fc9ee1c705f15445fdd8411224"
+
+
+ArtirixCacheService.key :some_key, :arg1, 'arg2', digest: [arg3, arg4]
+  # => "prfx/some_key/arg1/arg2/7448a071aeee91fc9ee1c705f15445fdd8411224"
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'artirix_cache_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install artirix_cache_service
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/artirix/artirix_cache_service.
+

data/Rakefile

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

data/artirix_cache_service.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'artirix_cache_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'artirix_cache_service'
+  spec.version       = ArtirixCacheService::VERSION
+  spec.authors       = ['Eduardo Turiño']
+  spec.email         = ['eturino@eturino.com']
+
+  spec.summary       = %q{Common Cache Helpers for rails apps}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/artirix/artirix_cache_service'
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'faker'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "artirix_cache_service"
+
+# 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

data/bin/setup

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

data/lib/artirix_cache_service/key.rb

@@ -0,0 +1,48 @@
+module ArtirixCacheService
+  class Key
+    KEY_SEPARATOR = '/'.freeze
+
+    attr_reader :args, :service
+
+    def initialize(given_args, service)
+      @service = service
+      @args    = clean_key_args given_args
+    end
+
+    delegate :key_prefix, :digest, to: :service
+
+    def call
+      clean_parts.join KEY_SEPARATOR
+    end
+
+    private
+
+    def clean_parts
+      parts.map(&:presence).compact.map(&:to_s)
+    end
+
+    def parts
+      [key_prefix].concat(args)
+    end
+
+    def clean_key_args(args)
+      args.map { |a| clean_arg a }.flatten
+    end
+
+    def clean_arg(arg)
+      cache_key_from_model(arg) || cache_key_from_options(arg) || arg
+    end
+
+    def cache_key_from_model(model)
+      model.try(:cache_key)
+    end
+
+    def cache_key_from_options(hash)
+      return nil unless hash.kind_of? Hash
+      return nil unless hash[:digest]
+
+      digest hash[:digest]
+    end
+
+  end
+end

data/lib/artirix_cache_service/service.rb

@@ -0,0 +1,20 @@
+module ArtirixCacheService
+  class Service
+    # Instance
+    def config_params
+      @config_params ||= { key_prefix: nil }
+    end
+
+    def key_prefix
+      config_params[:key_prefix]
+    end
+
+    def key(*given_args)
+      Key.new(given_args, self).call
+    end
+
+    def digest(arg)
+      Digest::SHA1.hexdigest arg.to_s
+    end
+  end
+end

data/lib/artirix_cache_service/version.rb

@@ -0,0 +1,3 @@
+module ArtirixCacheService
+  VERSION = '0.1.1'
+end

data/lib/artirix_cache_service.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'artirix_cache_service/version'
+require 'artirix_cache_service/key'
+require 'artirix_cache_service/service'
+
+module ArtirixCacheService
+
+  # Delegation of static methods to the Service instance
+  class << self
+    delegate :key, :config_params, :key_prefix, :digest, to: :service
+  end
+
+  def self.service
+    @service ||= reload_service
+  end
+
+  def self.reload_service
+    @service = Service.new
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: artirix_cache_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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:
+- eturino@eturino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- artirix_cache_service.gemspec
+- bin/console
+- bin/setup
+- lib/artirix_cache_service.rb
+- lib/artirix_cache_service/key.rb
+- lib/artirix_cache_service/service.rb
+- lib/artirix_cache_service/version.rb
+homepage: https://github.com/artirix/artirix_cache_service
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Common Cache Helpers for rails apps
+test_files: []
+has_rdoc: