venduitz 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cc6a028fa63bd40f96535d661fc2a8452d96148
-  data.tar.gz: b583d6e4bf160b0b4b7c705439ef9f43711aed07
+  metadata.gz: 384de3930c931de488374367ac00caea085a6b62
+  data.tar.gz: a143824344b230d069ec60690c0e121c9af4b485
 SHA512:
-  metadata.gz: 96466bc3eb64cc8bdb8b6f3f244168c644c19d617c8db78d0a0f8e9229ee3e5754a9156ea7e6c3574455ed55fe093ed4c0431c6817a412f50fb0acef051afa94
-  data.tar.gz: ee9aeb8158cb506316a62471ee525f205bdc4b184f65e518268942f524bf368dfc836a9ff5346374b6112f5637d60f2b2bbf1dc0482c0a8c96ae9a15b6c29b52
+  metadata.gz: 1ab8cab911841cfcfd7a3a073d068f08b408103df125e87801ed26ef5fcfe40329858d0dae50f5b3bb1cdfa07b9114ea794bf3f3090b8ff04a773c646426732d
+  data.tar.gz: 132d6ad295873f43c0807cc0f43c605a4c48d571a74e81740eede1e28edc6606b5c404860be51716d8caa7e7fe37834b529af607b1a94e8ec8bbb4f98f702673

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    venduitz (0.1.0)
+    venduitz (0.2.0)
       multi_json
       oj
 

data/README.md

@@ -70,6 +70,28 @@ res = SearchView.to_json(search, [:images])
 [200, {'Content-Type' => 'application/json'}, res]
 ```
 
+### Using Cache
+To use cache you have to define a Driver for the Venduitz:
+```
+# Defining the CacheDriver
+Venduitz::Cache.driver = CacheDriver
+
+# This cache driver must define some methods (specified on the Vendtuiz::Cache module)
+
+# As common, generate your view but with some differences
+# `true` in this case will enable the cache
+res = SearchView.to_json(search, [:images], true)
+
+# To use a 'partial views' the method #generate also supports cache
+class CachedView < ProductView
+  prop :cover, -> (product) { ImageView.generate(product.cover, [], true) }
+end
+
+# To pass the expiration time to your driver just use a fourth argument
+# to define the driver call options
+res = SearchView.to_json(search, [:images], true, { expire_in: 10.minutes })
+```
+
 ## Development
 * Building the docker container: `docker build -t venduitz .`
 * Running the tests:

data/lib/venduitz/cache.rb

@@ -0,0 +1,84 @@
+#
+module Venduitz
+  # Module responsible for creating an interface
+  # for the different cache storages
+  module Cache
+    # Static methods
+    class << self
+      #
+      attr_accessor :digestor, :driver, :namespace
+
+      # Before use it you have to specify the driver used by
+      # this module. The driver must define the following
+      # methods:
+      #   - exist?(key)
+      #   - get(key)
+      #   - set(key, value, options)
+      #   - clear(options)
+
+      # Digest
+      def digest(object)
+        # The dumped data
+        dump = Marshal::dump(object)
+
+        # Check if the digestor is empty
+        digestor = Digest::MD5 if digestor.nil?
+
+        # Digest it
+        digestor.hexdigest dump
+      end
+
+      # Check if the key exists
+      def exist?(key)
+        _driver.exist?(key)
+      end
+
+      # Get the key
+      def get(key)
+        # Using the driver itself
+        _driver.get(key)
+      end
+
+      # Set the cache
+      # @param {Any} key The key used on the cache
+      # @param {Boolean} dump If is necessary to dump the Key
+      # @param {Any} value The value of the cache
+      def set(key, value, dump = true, options = {})
+        #
+        key = digest(key) if dump
+
+        # If the driver has any namespace method or fixed value
+        key = "#{namespace}/#{key}" if namespace?
+
+        #
+        _driver.set(key, value, options)
+      end
+
+      # Clear the full cache
+      # @param {Hash} opts Options to use while clear the cache
+      def clear(opts = nil)
+        _driver.clear(opts)
+      end
+
+      # Check if there is namespace
+      def namespace?
+        !@namespace.nil?
+      end
+
+      # Get the namespace
+      def namespace
+        @namespace.respond_to(:call) ? @namespace.call : @namespace
+      end
+
+      private
+
+      def _driver
+        # Check if the driver was defined
+        throw 'You have to define your cache driver before start using it' if driver.nil?
+
+        # Return the driver
+        driver
+      end
+    end
+  end
+end

data/lib/venduitz/version.rb

@@ -2,6 +2,6 @@
 module Venduitz
   # Gem version
   def self.version
-    '0.2.0'.freeze
+    '0.3.0'.freeze
   end
 end

data/lib/venduitz/view.rb

@@ -37,8 +37,16 @@ module Venduitz
       # for the specific argument
       # @param {Object} obj This must contain the declared properies and collections
       # @param {Array} excluded This array contain the keys that will not be added to the result
+      # @param {Boolean} cache This flag indicates if cache will be performed
+      # @param {Hash} cache_options Cache options
       # @return {Hash} JSON ready hash containing the specified view fields
-      def generate(obj, excluded = [])
+      def generate(obj, excluded = [], cache = false, cache_options = {})
+        # Generate the cache key if cache is enabled
+        key = cache_key(obj, excluded, :generate) if cache
+
+        # Cache?
+        return Cache.get(key) if cache && Cache.exist?(key)
+
         # Reset the values to prevent errors
         @props = {} if @props.nil?
         @collects = {} if @collects.nil?
@@ -60,17 +68,47 @@ module Venduitz
           [collect, values.map {|val| info[:view].generate(val, info[:excluded]) }]
         end
 
-        # Return the full hash
-        Hash[props].merge(Hash[coll])
+        # Full hash
+        result = Hash[props].merge(Hash[coll])
+
+        # Check if cache has to be created
+        Cache.set(key, result, cache_options) if cache
+
+        # Return the result
+        result
       end
 
       # Parse it
       # @param {Object} obj This must contain the declared properies and collections
       # @param {Array} excluded This array contain the keys that will not be added to the result
+      # @param {Boolean} cache This flag indicates if cache will be performed
+      # @param {Hash} cache_options Cache options
       # @return {Hash} The JSON string itself
-      def to_json(obj, excluded = [])
+      def to_json(obj, excluded = [], cache = false, cache_options = {})
+        # Generate the cache key if cache is enabled
+        key = cache_key(obj, excluded, :json) if cache
+
+        # Cache?
+        return Cache.get(key) if cache && Cache.exist?(key)
+
         # Transform the result into json
-        MultiJson.dump generate(obj, excluded)
+        result = MultiJson.dump generate(obj, excluded)
+
+        # Cache must be performed?
+        Cache.set(key, result, cache_options) if cache
+
+        # Return the result
+        result
+      end
+
+      #
+      private
+
+      # Generate the cache key
+      # CACHE
+      #   Key: "{object}/{excluded}/{type}"
+      def cache_key(obj, excluded, type)
+        "#{Cache.digest(obj)}/#{Cache.digest(excluded)}/#{type.to_s}"
       end
     end
   end

data/lib/venduitz.rb

@@ -5,6 +5,8 @@ end
 # Dependencies
 require 'oj'
 require 'multi_json'
+require 'digest/md5'
 
 # Core
+require 'venduitz/cache'
 require 'venduitz/view'

data/spec/venduitz/cache_spec.rb

@@ -0,0 +1,95 @@
+# Include the helper
+require 'spec_helper'
+
+# Define a simple cache driver
+class CacheDriver
+  # Define the storage
+  attr_reader :storage
+
+  # Init!
+  def initialize
+    # Initialize the storage
+    @storage = {}
+  end
+
+  #
+  def exist?(key)
+    @storage.key?(key)
+  end
+
+  #
+  def set(key, value, options = {})
+    @storage[key] = value
+  end
+
+  #
+  def get(key)
+    @storage[key]
+  end
+
+  #
+  def clear(options = nil)
+    @storage = {}
+  end
+end
+
+# Cache object tes
+class CacheSample < SubSample
+  #
+  attr_reader :other
+
+  # Init!
+  def initialize(time)
+    @other = time
+  end
+end
+
+# Set the driver to the Venduitz
+Venduitz::Cache.driver = CacheDriver.new
+
+#
+describe Venduitz::Cache do
+  #
+  before(:each) do
+    # Clear the cache
+    Venduitz::Cache.clear
+  end
+
+  #
+  it 'should set/get a cache withoud digest' do
+    # Set the cache (withoud digest)
+    Venduitz::Cache.set 'hello', 'here', false
+
+    # Assertions
+    expect(Venduitz::Cache.exist?('hello')).to eq(true)
+    expect(Venduitz::Cache.get('hello')).to eq('here')
+  end
+
+  #
+  it 'should set/get a cache withoud digest' do
+    # Set the cache (withoud digest)
+    Venduitz::Cache.set 'hello', 'here'
+
+    # Get the digested key
+    key = Venduitz::Cache.digest 'hello'
+
+    # Get it
+    expect(Venduitz::Cache.get(key)).to eq('here')
+  end
+
+  #
+  it 'should generate a view with cache' do
+    # Get the time now and save it
+    time = Time.now
+
+    # Gen the JSON
+    res = [SubSampleView.to_json(CacheSample.new(time), [], true)]
+
+    # Generate it again
+    res += [SubSampleView.to_json(CacheSample.new(time), [], true)]
+
+    # Check Cache entries
+    expect(Venduitz::Cache.driver.storage.keys.size).to eq(1)
+    expect(Venduitz::Cache.get(Venduitz::Cache.driver.storage.keys[0])).to eq(res[0])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: venduitz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gabriel Corado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -65,10 +65,12 @@ files:
 - Gemfile.lock
 - README.md
 - lib/venduitz.rb
+- lib/venduitz/cache.rb
 - lib/venduitz/grape.rb
 - lib/venduitz/version.rb
 - lib/venduitz/view.rb
 - spec/spec_helper.rb
+- spec/venduitz/cache_spec.rb
 - spec/venduitz/grape_spec.rb
 - spec/venduitz/view_spec.rb
 - venduitz.gemspec