caddy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 557e6259f9f172bdaf516e829bb169d8a89663f9
+  data.tar.gz: 0f36ca38a97ff49e466d97206823e1ad78c1e34b
+SHA512:
+  metadata.gz: b54cbcab570b82c83f97d7e78823ee6affa185cfb8ec1f6edf9d81c6fd8ec01454266cdc496cbea6c656f8acf545c5b2e05ac1122eff5fcedd0805c5ef1468e6
+  data.tar.gz: 0a6b074bb61328edbd8ee7bfc05e94ab2fcca3d75f64b2e1a1cb5f44a981780e16f7b77fee5df06a707d3b38f92e7151c2c150f0de8d5ec5aaeb43c04dc00e94

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,219 @@
+AllCops:
+  Exclude:
+    - .git/**/*
+    - tmp/**/*
+    - suo.gemspec
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/TrailingWhitespace:
+  Enabled: true
+
+Style/Tab:
+  Enabled: true
+
+Style/TrailingBlankLines:
+  Enabled: true
+
+Style/NilComparison:
+  Enabled: true
+
+Style/NonNilCheck:
+  Enabled: true
+
+Style/Not:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/ClassCheck:
+  Enabled: true
+
+Style/EmptyLines:
+  Enabled: true
+
+Style/EmptyLiteral:
+  Enabled: true
+
+Style/Alias:
+  Enabled: true
+
+Style/MethodCallParentheses:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Style/SpaceInsideBlockBraces:
+  Enabled: true
+
+Style/SpaceInsideParens:
+  Enabled: true
+
+Style/DeprecatedHashMethods:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Style/SpaceInsideBrackets:
+  Enabled: true
+
+Style/AndOr:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+
+Style/SpaceBeforeComma:
+  Enabled: true
+
+Style/SpaceBeforeComment:
+  Enabled: true
+
+Style/SpaceBeforeSemicolon:
+  Enabled: true
+
+Style/SpaceAroundBlockParameters:
+  Enabled: true
+
+Style/SpaceAroundOperators:
+  Enabled: true
+
+Style/SpaceAfterColon:
+  Enabled: true
+
+Style/SpaceAfterComma:
+  Enabled: true
+
+Style/SpaceAroundKeyword:
+  Enabled: true
+
+Style/SpaceAfterNot:
+  Enabled: true
+
+Style/SpaceAfterSemicolon:
+  Enabled: true
+
+Lint/UselessComparison:
+  Enabled: true
+
+Lint/InvalidCharacterLiteral:
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Enabled: true
+
+Lint/LiteralInCondition:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Style/VariableInterpolation:
+  Enabled: true
+
+Style/RedundantSelf:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/WhileUntilDo:
+  Enabled: true
+
+Style/EmptyLineBetweenDefs:
+  Enabled: true
+
+Style/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Style/ColonMethodCall:
+  Enabled: true
+
+Lint/SpaceBeforeFirstArg:
+  Enabled: true
+
+Lint/UnreachableCode:
+  Enabled: true
+
+Style/UnlessElse:
+  Enabled: true
+
+Style/ClassVars:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 128
+
+Metrics/MethodLength:
+  Max: 32
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Disabled
+
+Style/EvenOdd:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Nick Elser
+
+MIT License
+
+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,54 @@
+# Caddy (WORK IN PROGRESS)
+
+Holds your stuff, and keeps it up to date.
+
+```ruby
+# in your initializers (caddy.rb would be a wonderful name)
+Caddy.refresher = -> { Hash[SomeKeyValueModel.all.map { |skvm| [skvm.key.to_sym, skvm.value } }
+Caddy.refresh_interval = 5.minutes # default is 60 seconds
+
+# ... in your unicorn.rb/puma.rb after fork/start
+Caddy.start
+
+# ... in a controller
+def index
+  # the Caddy requests are instant, and are up-to-date (as of 5 minutes ago, as specified above)
+  # you could use this for high-level feature flags, cache dumping
+  if Caddy[:use_the_fast_index]
+    Rails.cache.fetch("#{Caddy[:global_cache_version}/#{Caddy[:foo_index_cache_version}/foo/bar") do
+      # wonderful things happen here
+    end
+  end
+end
+```
+
+## Give it to me!
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "caddy"
+```
+
+## Semantic Versioning
+
+This project conforms to [semver](http://semver.org/). As a result of this
+policy, you can (and should) specify a dependency on this gem using the
+[Pessimistic Version Constraint](http://guides.rubygems.org/patterns/) with
+two digits of precision. For example:
+
+```ruby
+spec.add_dependency "caddy", "~> 1.0"
+```
+
+This means your project is compatible with caddy 1.0 up until 2.0.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Don't forget to run the tests with `rake`.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/caddy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "caddy/version"
+
+Gem::Specification.new do |s|
+  s.name          = "caddy"
+  s.version       = Caddy::VERSION
+  s.authors       = ["Nick Elser"]
+  s.email         = ["nick.elser@gmail.com"]
+  s.description   = %q{Caddy gives you a magical auto-updating global cache.}
+  s.summary       = %q{Caddy gives you a magical auto-updating global cache.}
+  s.homepage      = "http://github.com/nickelser/caddy"
+  s.licenses      = ["MIT"]
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "concurrent-ruby"
+
+  s.add_development_dependency "rake", "~> 10.5"
+  s.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/caddy.rb

@@ -0,0 +1,66 @@
+require "caddy/version"
+require "concurrent/timer_task"
+
+module Caddy
+  class << self
+    attr_accessor :refresher
+    attr_writer :refresh_interval
+  end
+
+  DEFAULT_REFRESH_INTERVAL = 60
+  REFRESH_INTERVAL_JITTER_PCT = 0.1
+  DEFAULT_INITIAL_VALUE_WAIT = 0.1
+
+  def self.[](k)
+    raise "Please run `Caddy.start` before attempting to access values" unless @task
+    raise "Caddy variable access before initial load; allow some more time for your system to warm up" unless @task.value
+    @task.value[k]
+  end
+
+  def self.start
+    unless refresher
+      raise "Please set your cache refresher via `Caddy.refresher = -> { <code that returns a value> }`"
+    end
+
+    if @task
+      puts "Caddy already running; shutting it down and starting over. Please ensure you run `Caddy.start`"\
+           " only after fork/worker start in your web processes."
+      @task.shutdown
+    end
+
+    jitter_amount = refresh_interval * REFRESH_INTERVAL_JITTER_PCT
+    interval = refresh_interval + rand(-jitter_amount...jitter_amount)
+
+    @task = Concurrent::TimerTask.new(
+      run_now: true,
+      freeze_on_deref: true,
+      execution_interval: interval,
+      timeout_interval: interval - 1) { refresher.call }
+
+    @task.add_observer(CaddyTaskObserver.new)
+    @task.execute
+  end
+
+  def self.stop
+    raise "Please run `Caddy.start` before running `Caddy.stop`" unless @task
+
+    @task.shutdown
+    @task = nil
+  end
+
+  def self.refresh_interval
+    @refresh_interval || DEFAULT_REFRESH_INTERVAL
+  end
+
+  class CaddyTaskObserver
+    def update(time, _, boom)
+      return unless boom
+
+      if boom.is_a?(Concurrent::TimeoutError)
+        puts "(#{time}) Caddy refresher timed out"
+      else
+        puts "(#{time}) Caddy refresher failed with error #{boom}"
+      end
+    end
+  end
+end

data/lib/caddy/version.rb

@@ -0,0 +1,3 @@
+module Caddy
+  VERSION = "0.0.1"
+end

data/test/caddy_test.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+require "caddy"
+
+class CaddyTest < Minitest::Test
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: caddy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Elser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !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'
+description: Caddy gives you a magical auto-updating global cache.
+email:
+- nick.elser@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- caddy.gemspec
+- lib/caddy.rb
+- lib/caddy/version.rb
+- test/caddy_test.rb
+homepage: http://github.com/nickelser/caddy
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Caddy gives you a magical auto-updating global cache.
+test_files:
+- test/caddy_test.rb
+has_rdoc: