stale_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a0e6a29f2972f187cb1732bccd2228d97e4fcc4
+  data.tar.gz: a9415cbdc4633d3874a4f74c7d47592c7f644876
+SHA512:
+  metadata.gz: 621005d40aef390b2fb9e16f0973e1fef10100b3c4c822859209b29bec5d047266ae3f2ca4ebf2bdebeb3ba07f35093b140df957fe56dbb1b43f653bcba996bc
+  data.tar.gz: 4404a71ec56fe989b666f2608ce74cf01d3a6e37807bae31be693abc232648b16d8580edafdbedbcab2e7745ebd6684f3d7216a5a5f9de8bb2f83c4ae9949c18

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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 stale_options.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    stale_options (0.1.0)
+      activerecord (>= 5.0, < 6.0)
+      activesupport (>= 5.0, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    docile (1.3.1)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.3.13)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.16.3)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls (~> 0.8)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sqlite3 (~> 1.3)
+  stale_options!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nikolay Digaev
+
+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,147 @@
+# StaleOptions
+
+[![Build Status](https://travis-ci.org/digaev/stale_options.svg?branch=master)](https://travis-ci.org/digaev/stale_options) [![Coverage Status](https://coveralls.io/repos/github/digaev/stale_options/badge.svg?branch=master)](https://coveralls.io/github/digaev/stale_options?branch=master)
+
+A gem for caching HTTP responses.
+
+The gem was built with an idea to implement a class which will create options for `ActionController::ConditionalGet#stale?` method, without caring of type of object class.
+
+___
+
+* Installation
+* Usage
+  * Caching options
+  * Examples
+  * Controller helpers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stale_options'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install stale_options
+```
+
+## Usage
+
+There are three main classes, each class is designed to create options for the corresponding object class:
+
+* `StaleOptions::ArrayOptions` - For caching Arrays.
+* `StaleOptions::RelationOptions` - For caching relations `ActiveRecord::Relation`.
+* `StaleOptions::ObjectOptions` - For caching any other objects.
+
+There is also base class `StaleOptions::AbstractOptions`. Constructor of these classes looks like:
+
+```ruby
+def initialize(record, options = {})
+...
+end
+```
+
+* `record` - Basically any Ruby object. Arrays and relations are "specials".
+* `options` - `Hash`. Caching options (see detailed description in corresponding section).
+
+Here is the very basic example of usage:
+
+```
+[1] pry(main)> options = StaleOptions::RelationOptions.new(Item.all)
+[2] pry(main)> options.to_h
+=> {:etag=>"39f08c583b023142dd64b0922dfaefd4", :last_modified=>2018-07-04 18:05:22 UTC}
+```
+
+In order to help create different classes of `StaleOptions` for different objects there is method `StaleOptions.create`, so above example can be rewritten like:
+
+```
+[3] pry(main)> StaleOptions.create(Item.all)
+=> {:etag=>"39f08c583b023142dd64b0922dfaefd4", :last_modified=>2018-07-04 18:05:22 UTC}
+```
+
+And this is the way how you'll use it in most cases :)
+
+### Caching options
+
+There are two options for caching:
+
+* `:cache_by`
+  * `String` or `Symbol`. A name of method which returns unique identifier of object for caching.
+  * For arrays and relations if value is `itself`, then it will be cached "as it is" (relations will be converted to arrays by calling `#to_a`), otherwise this method will be called on each element. *Hint: To cache arrays of "simple" objects (e.g. `String` or `Numeric`) set it to `itself`*.
+  * Default: `:updated_at`.
+* `:last_modified`
+  * `String` or `Symbol`. A name of method which returns an instance of `ActiveSupport::TimeWithZone`, `DateTime`, `Time`.
+    * If `record` is a relation, then an attribute name.
+    * If `record` is an `Array` or `Object`, then a method name.
+  * `ActiveSupport::TimeWithZone`, `DateTime`, `Time` or `nil` to set `:last_modified`.
+  * Default: `:updated_at`.
+
+### Examples
+
+```
+[1] pry(main)> StaleOptions.create(Task.all, last_modified: :done_at)
+=> {:etag=>"ce8d2fbc9b815937b59e8815d8a85c21", :last_modified=>2018-06-30 18:25:07 UTC}
+
+[2] pry(main)> StaleOptions.create([1, 2, 3], cache_by: :itself, last_modified: nil)
+=> {:etag=>"73250e72da5d8950b6bbb16044353d26", :last_modified=>nil}
+
+[3] pry(main)> StaleOptions.create({ a: 'a', b: 'b', c: 'c' }, cache_by: :itself, last_modified: Time.now)
+=> {:etag=>"fec76eca1192bc7371e44d517b56c93f", :last_modified=>2018-07-08 07:08:48 UTC}
+```
+
+### Controller helpers
+
+In your controller:
+
+```ruby
+# To render a template:
+
+class PostsController < ApplicationController
+  include StaleOptions::Backend
+
+  def index
+    if_stale?(Post.all) do |posts|
+      @posts = posts
+    end
+  end
+end
+
+# Or, to render json:
+
+class PostsController < ApplicationController
+  include StaleOptions::Backend
+
+  def index
+    if_stale?(Post.all) do |posts|
+      render json: posts
+    end
+  end
+end
+```
+
+Here we're using method `#if_stale?` (there is also `#unless_stale?` btw) which was added to controller by including `StaleOptions::Backend` module. The method accepts two arguments `record` and `options` (yeah, just like `StaleOptions.create`).
+
+Under the hood it calls `ActionController::ConditionalGet#stale?` with options created by `StaleOptions.create`:
+
+```ruby
+def if_stale?(record, options = {})
+  yield(record) if stale?(StaleOptions.create(record, options))
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/digaev/stale_options.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,25 @@
+module StaleOptions
+  module Backend
+    protected
+
+    # Usage:
+    #
+    #  class ItemsController < ApplicationController
+    #    include StaleOptions::Backend
+    #
+    #    def index
+    #      if_stale?(Item.all) do |items|
+    #        render json: items
+    #      end
+    #    end
+    #  end
+    #
+    def if_stale?(record, options = {})
+      yield(record) if stale?(StaleOptions.create(record, options))
+    end
+
+    def unless_stale?(record, options = {})
+      yield(record) unless stale?(StaleOptions.create(record, options))
+    end
+  end
+end

data/lib/stale_options.rb

@@ -0,0 +1,34 @@
+require 'active_record'
+require 'active_support/time'
+
+require 'backend/backend'
+
+module StaleOptions
+  autoload :AbstractOptions, 'stale_options/abstract_options'
+  autoload :ArrayOptions, 'stale_options/array_options'
+  autoload :ObjectOptions, 'stale_options/object_options'
+  autoload :RelationOptions, 'stale_options/relation_options'
+
+  def self.create(record, options = {})
+    klass =
+      case record
+      when ActiveRecord::Relation
+        RelationOptions
+      when Array
+        ArrayOptions
+      else
+        ObjectOptions
+      end
+
+    klass.new(record, options).to_h
+  end
+
+  def self.time?(obj)
+    case obj
+    when ActiveSupport::TimeWithZone, DateTime, Time
+      true
+    else
+      false
+    end
+  end
+end

data/lib/stale_options/abstract_options.rb

@@ -0,0 +1,84 @@
+module StaleOptions
+  class AbstractOptions
+    # Params:
+    # +record+:: +Object+:: An +Object+, +Array+ or +ActiveRecord::Relation+.
+    # +options+:: +Hash+::
+    #               * +:cache_by+::
+    #                 * +String+ or +Symbol+::
+    #                   A name of method which returns unique identifier of object for caching.
+    #
+    #                   For arrays and relations if value is +itself+, then it will be cached as it is,
+    #                   otherwise this method will be called on each element.
+    #                   Relations will be converted to arrays by calling <tt>#to_a</tt>.
+    #
+    #                   Hint: To cache an array of "simple" objects (e.g. +String+ or +Numeric+) set it to +itself+.
+    #                 Default: +:updated_at+.
+    #               * +:last_modified+::
+    #                 * +String+ or +Symbol+::
+    #                   If +record+ is a relation, then an attribute name.
+    #                   If +record+ is an +Array+ or +Object+, then a method name.
+    #                   Expected an instance of +ActiveSupport::TimeWithZone+, +DateTime+, +Time+.
+    #                 * +ActiveSupport::TimeWithZone+, +DateTime+, +Time+ or +nil+::
+    #                   To set +last_modified+.
+    #                 Default: +:updated_at+.
+    def initialize(record, options = {})
+      @record = record
+      @options = {
+        cache_by: :updated_at,
+        last_modified: :updated_at
+      }.merge!(options)
+    end
+
+    # Returns options for <tt>ActionController::ConditionalGet#stale?</tt>
+    def to_h
+      { etag: etag, last_modified: nil }.tap do |h|
+        unless last_modified_opt.nil?
+          h[:last_modified] = StaleOptions.time?(last_modified_opt) ? last_modified_opt : last_modified
+          h[:last_modified] = h[:last_modified]&.utc
+        end
+      end
+    end
+
+    private
+
+    def cache_by_opt
+      @options[:cache_by]
+    end
+
+    def cache_by_itself?
+      cache_by_opt.to_s == 'itself'
+    end
+
+    def read_cache_by(obj)
+      value = obj.public_send(cache_by_opt)
+
+      StaleOptions.time?(value) ? value.to_f : value
+    end
+
+    def last_modified_opt
+      @options[:last_modified]
+    end
+
+    def read_last_modified(obj)
+      obj.public_send(last_modified_opt)
+    end
+
+    def object_hash(obj)
+      Digest::MD5.hexdigest(Marshal.dump(obj))
+    end
+
+    def collection_hash(collection)
+      object_hash(collection.map { |obj| read_cache_by(obj) })
+    end
+
+    protected
+
+    def etag
+      raise NotImplementedError
+    end
+
+    def last_modified
+      raise NotImplementedError
+    end
+  end
+end

data/lib/stale_options/array_options.rb

@@ -0,0 +1,21 @@
+module StaleOptions
+  class ArrayOptions < AbstractOptions
+    private
+
+    def most_recent
+      @most_recent ||= @record.max do |a, b|
+        read_last_modified(a) <=> read_last_modified(b)
+      end
+    end
+
+    protected
+
+    def etag
+      cache_by_itself? ? object_hash(@record) : collection_hash(@record)
+    end
+
+    def last_modified
+      read_last_modified(most_recent) if most_recent
+    end
+  end
+end

data/lib/stale_options/object_options.rb

@@ -0,0 +1,13 @@
+module StaleOptions
+  class ObjectOptions < AbstractOptions
+    protected
+
+    def etag
+      object_hash(read_cache_by(@record)) if @record
+    end
+
+    def last_modified
+      read_last_modified(@record) if @record
+    end
+  end
+end

data/lib/stale_options/relation_options.rb

@@ -0,0 +1,17 @@
+module StaleOptions
+  class RelationOptions < AbstractOptions
+    protected
+
+    def etag
+      cache_by_itself? ? object_hash(@record.to_a) : collection_hash(@record)
+    end
+
+    def last_modified
+      # FIXME: ActiveRecord#maximum ignores order,
+      # so we can't just say `@record.maximum(last_modified_opt)`.
+      # See: https://stackoverflow.com/questions/23243828/rails-activerecord-maximumcolumn-ignores-order
+
+      @record.pluck(last_modified_opt).max
+    end
+  end
+end

data/lib/stale_options/version.rb

@@ -0,0 +1,3 @@
+module StaleOptions
+  VERSION = '0.1.0'.freeze
+end

data/stale_options.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stale_options/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stale_options'
+  spec.version       = StaleOptions::VERSION
+  spec.authors       = ['Nikolay Digaev']
+  spec.email         = ['ffs.cmp@gmail.com']
+
+  spec.summary       = 'A gem for caching HTTP responses'
+  spec.homepage      = 'https://github.com/digaev/stale_options'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0', '< 6.0'
+  spec.add_dependency 'activesupport', '>= 5.0', '< 6.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: stale_options
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolay Digaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- ffs.cmp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/backend/backend.rb
+- lib/stale_options.rb
+- lib/stale_options/abstract_options.rb
+- lib/stale_options/array_options.rb
+- lib/stale_options/object_options.rb
+- lib/stale_options/relation_options.rb
+- lib/stale_options/version.rb
+- stale_options.gemspec
+homepage: https://github.com/digaev/stale_options
+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.14
+signing_key: 
+specification_version: 4
+summary: A gem for caching HTTP responses
+test_files: []