cachengue 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abdbe3f73ef48939bcd5a527588d3dabdcb9f743
+  data.tar.gz: 184300301128c201b944546a928fc9192c2ac052
+SHA512:
+  metadata.gz: 2a312074235e514cfc7cf6275c2fe87adabd6cb1e545e5920d0337a2ebeb36b3211c6b4deb17b489841e7238750d43ab5aaded5424ba0e68f96c47edc1471991
+  data.tar.gz: 5d104102cddeca4a0075c0d9ecf8e568ac975f39aee63d879706f39dff34338b53c8038edaab32a2a3ffe1fb64bb268e2e0869e8ce18d9be5fef71afaaf3a150

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,67 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - config/**/*
+    - db/*
+    - db/migrate/*
+    - lib/tasks/*
+    - test/*
+    - Gemfile
+    - Rakefile
+    - config.ru
+    - lib/onfleet/onfleet-ruby/**/*
+
+  TargetRubyVersion: 2.4
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - test/*/**
+
+Metrics/ClassLength:
+  Max: 300
+  Exclude:
+    - test/*/**
+
+Metrics/CyclomaticComplexity:
+  Max: 21
+
+Metrics/PerceivedComplexity:
+  Max: 21
+
+Metrics/LineLength:
+  Max: 90
+  Exclude:
+    - test/*/**
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ModuleLength:
+  Max: 300
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cachengue (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.3.5)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.1.5)
+  bundler (~> 1.16)
+  cachengue!
+  minitest (~> 5.3.4)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,48 @@
+# Cachengue
+
+Welcome to cachengue gem!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cachengue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cachengue
+
+## Usage
+
+
+###Examples:
+
+In ```models/user.rb```
+```ruby
+class User < ApplicationRecord
+  include Cachengue::ActiveRecord
+end
+
+User.cachengue.find_by(name: 'Jhon Doe')
+```
+
+## 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 GitLab https://gitlab.com/shipnow/cachengue. 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.
+
+## 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,12 @@
+require 'bundler/gem_tasks'
+# require "rspec/core/rake_task"
+require 'rake/testtask'
+
+# RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cachengue/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachengue"
+  spec.version       = Cachengue::VERSION
+  spec.licenses      = ["MIT"]
+  spec.authors       = ["shipnow developers"]
+  spec.email         = ["developers@shipnow.com.ar"]
+
+  spec.summary       = %q{cache gem for ruby on rails}
+  spec.description   = %q{A gem for caching}
+  spec.homepage      = "https://gitlab.com/shipnow/cachengue"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = ""
+  # else
+    # raise "RubyGems 2.0 or newer is required to protect against " \
+      # "public gem pushes."
+  # end
+
+  # 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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "activesupport", "~> 5.1"
+end

data/lib/cachengue.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'cachengue/version'
+require 'cachengue/proxy'
+require 'cachengue/caching'
+
+module Cachengue
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    included do
+      extend Cachengue::Caching
+      before_save do
+        self.class.cachengue.cache_clear
+      end
+    end
+  end
+end

data/lib/cachengue/caching.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Cachengue
+  module Caching
+    def cachengue(method_name = nil, &block)
+      return Cachengue::Proxy.new(self) if method_name.blank?
+
+      fetch(self, method_name, [], &block)
+    end
+
+    def module_cachengue(method_name, &block)
+      singleton_class.instance_eval do
+        define_method(method_name) do |*args|
+          Cachengue::Caching.fetch(self, method_name, args, &block)
+        end
+      end
+    end
+
+    module_function
+
+    def key_by(classx, method_name, args)
+      args = args.map(&:as_json)
+
+      "#{key_prefix(classx)}:#{method_name}:#{args}"
+    end
+
+    def key_prefix(classx)
+      "cache:#{classx.to_s.underscore}"
+    end
+
+    def keys(classx)
+      prefix = Cachengue::Caching.key_prefix(classx)
+
+      Rails.cache.data.keys("#{prefix}:*")
+    end
+
+    def clear(classx)
+      return if Rails.env.test?
+
+      keys(classx).map { |k| Rails.cache.delete(k) }.size
+    end
+
+    def fetch(classx, method_name, args)
+      key = Cachengue::Caching.key_by(classx, method_name, args)
+
+      new_block = proc do
+        value = yield(*args)
+
+        if defined?(::ActiveRecord) && value.is_a?(::ActiveRecord::Relation)
+          value.to_a
+        else
+          value
+        end
+      end
+
+      Rails.cache.fetch(key, &new_block)
+    end
+  end
+end

data/lib/cachengue/proxy.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/MethodMissingSuper
+
+module Cachengue
+  class Proxy
+    def initialize(classx)
+      @classx = classx
+    end
+
+    def cache_keys
+      Cachengue::Caching.keys(@classx)
+    end
+
+    def cache_clear
+      Cachengue::Caching.clear(@classx)
+    end
+
+    private
+
+    def respond_to_missing?(method_name, include_all = false)
+      @classx.respond_to?(method_name, include_all) || super
+    end
+
+    def method_missing(method_name, *args)
+      Cachengue::Caching.fetch(@classx, method_name, args) do
+        @classx.public_send(method_name, *args)
+      end
+    end
+  end
+end

data/lib/cachengue/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Cachengue
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: cachengue
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- shipnow developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: A gem for caching
+email:
+- developers@shipnow.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cachengue.gemspec
+- lib/cachengue.rb
+- lib/cachengue/caching.rb
+- lib/cachengue/proxy.rb
+- lib/cachengue/version.rb
+homepage: https://gitlab.com/shipnow/cachengue
+licenses:
+- MIT
+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.6.13
+signing_key: 
+specification_version: 4
+summary: cache gem for ruby on rails
+test_files: []