out_put 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f0bbf9be68f7e714bb08b8a421ec1466399e769
-  data.tar.gz: d246c2858b54288aff98ae6ac12fc63aa46c239f
+  metadata.gz: c39b950419b24b87b7be771a242866ca754b66d4
+  data.tar.gz: e91476c98ce8e57c1f99f65ae5984adced45a407
 SHA512:
-  metadata.gz: 82b6913f4908c1c3ac71a8b2bfe07716cce4e2405a78a714a5bb9224b0f1788ba2acc2c8fbb16d83bdaf5626ff978a68d7f3ee48d1526c6c31a0a595bb712393
-  data.tar.gz: 189abd12eb85aa49b3ba77f92660c010fa4d8dec07aa87a3216aa83e75986e30268149186e6df250b6b35170baae5ca946ed21f9a8ef635c854a23ed2f7dbb43
+  metadata.gz: b71f6421cbcf135c415fe436336d5bd9bcd4c904d2c22246714008c17b5471b78219fa93fa89efcc56c8ec9d236480e8568182abe1e0ee98b1d49819ecadab58
+  data.tar.gz: 233b32f3cd0bad137225e799d3a68073975aa8458fcee54e7f6fda33eadeba538611850a7a28985496f86c8b6869593f5ba72418808e473e1fb667f4a9659bcc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    out_put (2.1.3)
+    out_put (2.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -105,9 +105,27 @@ output only: { foo: 'bar' }
 output only: [ 1, 2, 3 ]
 ```
 
-### 8. Other
+### 8. cache
 
-#### 8.a automatically set `total`:
+```ruby
+output cache: 24.hours do
+  { list: User.all }
+end # will render: { list: [...] }
+
+output foo: 'bar', cache: 24.hours do
+  { list: User.all }
+end # will render: { foo: 'bar', list: [...] }
+
+output only: { foo: 'bar' }, cache: 24.hours do
+  { only: { list: User.all } }
+end # will ONLY render: { foo: 'bar', list: [...] }
+```
+
+Note: the cache key will be `"output/#{action_name}"`
+
+### X. Other
+
+#### X.a automatically set `total`:
 
 if `config.pagination_for = :list`:
 
@@ -120,7 +138,7 @@ output 0, list: [ 1, 2, 3 ]
 # }
 ```
 
-#### 8.b use `build_with` to pass an variable `@view` to your view
+#### X.b use `build_with` to pass an variable `@view` to your view
 
 ```ruby
 build_with key: 'val'

data/lib/out_put.rb

@@ -3,9 +3,11 @@ require 'out_put/config'
 require 'out_put/view'
 
 module OutPut
-  def output(code = 0, msg = '', only: nil, http: 200, **data)
+  def output(code = 0, msg = '', only: nil, http: 200, cache: nil, **data, &block)
     if !code.is_a?(Integer) && code.respond_to?(:info)
       code, msg, http, only = code.info.slice(:code, :msg, :http, :only).values
+    elsif cache && block_given?
+      data, only = _output_cache(cache, data: data, only: only, &block)
     end
 
     return render json: only, status: http if only.present?
@@ -23,6 +25,11 @@ module OutPut
   alias error      output
   alias error_with output
 
+  def build_with(code = 0, msg = 'success', **data)
+    @view = View.new(code, msg, **data)
+    # Then jump to your view
+  end
+
   def _output_data(data)
     if data.key?(Config.pagination_for)
       # TODO now is only for AR
@@ -32,8 +39,11 @@ module OutPut
     data
   end
 
-  def build_with(code = 0, msg = 'success', **data)
-    @view = View.new(code, msg, **data)
-    # Then jump to your view
+  def _output_cache(time, data: { }, only: nil, &block)
+    cached = Rails.cache.fetch("output/#{action_name}", expires_in: time) do
+      instance_eval(&block)
+    end
+
+    [ data.merge(cached), only&.merge(cached[:only]) ]
   end
 end

data/lib/out_put/version.rb

@@ -1,3 +1,3 @@
 module OutPut
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: out_put
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler