gumball 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46cbe13b04129dc45db4d922b943eba73b653745
-  data.tar.gz: 24dc7b3f61ff28295d104ffa4b4e53965d6c2af4
+SHA256:
+  metadata.gz: 433f05d0f09a006ff0377604af119ee8b15caaef113947241bd3bd98b263f9d7
+  data.tar.gz: 6ad50e2602e18e7aa76ca103a6bc4e6d7d479594176ed7baa832dec159ee6a61
 SHA512:
-  metadata.gz: 520b55c18544eadda7c062ed83a1fc1d574119400994020cf23a36dd183b1404a46064da6022d50965805b4da109f87ced5fa06646f441e81d147365636bf642
-  data.tar.gz: 9b98c5891ff0b3c69ef9b19203e14695ad32081680d7587d850530e168a01c5e1d0759d09d2a976dbc54da905ccc071d1215836c594adcf2c538f6754adf6b17
+  metadata.gz: 8199f329c68fb2412374a57cdbab0232152ada9a3aae7ddc5121bfc99307853c558ac8db9f101d3c634b7ec8d93d98122e13a91dd54c7bb3a16c1ff68b12dde5
+  data.tar.gz: df736c193c10978a2756c87214e73b98ea58c98d6b35626f784a02d43083b1f579dea5261df030a547cc8d2e4924da7a38d1063fae987b8547bed37d5cea6314

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/{ruby.yml → ruby-build.yml}

@@ -5,7 +5,7 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Ruby
+name: Ruby Build
 
 on:
   push:
@@ -17,6 +17,9 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2
@@ -24,10 +27,9 @@ jobs:
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
-        ruby-version: 2.6
-    - name: Install dependencies
-      run: bundle install
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rspec

data/.travis.yml

@@ -1,14 +1,15 @@
 language: ruby
 rvm:
-- 2.4
 - 2.5
 - 2.6
+- 2.7
+- 3.0
 script:
 - bundle exec rspec
 deploy:
   provider: rubygems
   api_key:
-    secure: jUWa2Jx0HRVv7Dl0zYPTskHQ+RJGy2TUcBWOjyFbBUbeDKiRh8J/NnbMuCOvmL94htSaFk5lcs6k74Itu6jW12+KyT98OAnOardFPFuI0cHHhIMEhF6ms8EhyOCZ0vvR9zav11gfNzyF716qO09DQSDuoKWWNdhrYj8a5paLdbHuRqQiw3YUmnjVQ/v9SPYaZ7ziXC4X4tBxQhK2ujNsNfztSVrpYb6pnsXnt+hFQOnskzi0+er4854iymykeyNVgB71KgivrE3T55ZTXPPglshsZQE7M7FlYA5L3bwzR7SlA202yFYHB3hUN3obwO3BjO4OiAdKQnSosBHaXI13ZvCOz02AfEJhwoxkBXw1/2CvSQ12QQPVgqkpxWY03h+URk+gGHCV+JaqZPCV9excmVWg/IOQou0IJ6h84VFViyVc2aFVN2AIdoaG3NsppbV3j4VuLG6J2VVpNmUzN3pGgi5YSjVq9Hp+huXZFfWpnUgAxc680hKgcFajE3JNANG+NbNEeoDmITvZyV5kvJklgUKPsl2wNk+wY/GGrSBgNOVlyXqTWLZb/8Z/cSrN5DEc6D5BIS/SG95wlCRT8jUqbyEPjT+H77TH2ySfwWZzblLqbIxaLiZr3hX16oMdUx7Cya5LKLFgQBpU6cFUxvZX7SqHwjk1vnuG592Kxd9GkX4=
+    secure: OUlCntNtWloKunpBLvEIgrNthLtVl04uk7VD76kx8h+xXorjJCWaU3KKfi2MSyEtWB/fgUrAnEbzETfCt154Hq8TyKyMQqixAgDVTvXt84fB0IjKcszhtv3yUNGb+l1LWdEVkdzcRyf/yTZE3rPJi5VHqHe++G6hehmm417sPS/Wo+xEJ+2EVq/KX0aMahtrhqvuYJCSv/L25e3ExAHx27u8Q3w5vUQW3cy/FcyYUxGWL6JIWHMcI9fGu417AQd9nHOOys6DsLl+/7yMblbPNz0UyBaKqioEv+EFWpcvV8qKRi81s4sAbzJwF5DcOxYvtumrNJWi2slRiDmUx7q821hscsRlfMfYARMVLm0CuFhg9q7ldagOdCdD/reE88ofqStVVjDNj7u3zwBeeuwtKY6frGO2fR81pec/JYA8LlKEeVjFv/HZL4qJ5vgf/BSX4EQ6vEmL0gTXvS3CBFEL36h1PPSnzrwB7ktiCG8typ0CVrYPjDqm1naneraXm2dCVw2wAXLqOdJGq9pAFnKnwi3b+twTE9px5ttEkoEIZ2ASEK4L1edK508Uh90127kokfCKmv0wCSr3zr4F3tQy0pRiNuDUvZaF9QwE4uzzp2HYHvptT5OkcA1B9TQ9x9dsdQe+4siTkcF0Rz/LWmlrmVrExYhxptyeS6yP7rLotiM=
   gem: gumball
   on:
     tags: true

data/Gemfile

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# Gumball [![Build Status](https://travis-ci.com/kevinstuffandthings/gumball.svg?branch=master)](https://travis-ci.com/kevinstuffandthings/gumball) [![Gem Version](https://badge.fury.io/rb/gumball.svg)](https://badge.fury.io/rb/gumball)
+# Gumball ![Build Status](https://github.com/kevinstuffandthings/gumball/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/gumball.svg)](https://badge.fury.io/rb/gumball)
 
 A gem providing a mechanism to dispense instances of a class, somewhere between a true singleton and new instance each time.
 
@@ -63,7 +63,8 @@ dispenser.item # we've saved our refreshed version, and our response is immediat
 If we want to be able to set up our dispenser so that we can perform some other operation in the event the value actually changes:
 
 ```ruby
-dispenser = Gumball::Dispenser.new(300) { ExpensiveThing.value }
+# note the optional logger paseed in below...
+dispenser = Gumball::Dispenser.new(300, logger: Logger.new($stdout)) { ExpensiveThing.value }
 dispenser.on_change { |o, n| puts "OUR VALUE CHANGED: #{o} -> #{n}" }
 ```
 

data/Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require "bundler/setup"
 require "bundler/gem_tasks"
+require "standard/rake"
 
-Dir.glob('lib/tasks/*.rake').each { |r| load r }
+Dir.glob("lib/tasks/*.rake").each { |r| load r }

data/gumball.gemspec

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gumball/version'
+require "gumball/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "gumball"
-  spec.version       = Gumball::VERSION
-  spec.authors       = ["Kevin McDonald"]
-  spec.email         = ["kevinstuffandthings@gmail.com"]
-  spec.summary       = %q{Dispense expensive objects with ease}
-  spec.description   = spec.summary
-  spec.homepage      = "https://github.com/kevinstuffandthings/gumball"
-  spec.license       = "MIT"
+  spec.name = "gumball"
+  spec.version = Gumball::VERSION
+  spec.authors = ["Kevin McDonald"]
+  spec.email = ["kevinstuffandthings@gmail.com"]
+  spec.summary = "Dispense expensive objects with ease"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/kevinstuffandthings/gumball"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
   spec.add_development_dependency "yard"
 end

data/lib/gumball.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "gumball/version"
 require "gumball/dispenser"
 

data/lib/gumball/dispenser.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require "logger"
+
 module Gumball
   class Dispenser
     attr_reader :ttl
@@ -7,8 +10,9 @@ module Gumball
     # @param ttl [???]
     # @param block
     # @return [Dispenser]
-    def initialize(ttl, &block)
+    def initialize(ttl, logger: nil, &block)
       @ttl = ttl
+      @logger = logger || Logger.new("/dev/null")
       @last_refreshed = nil
       @refresh_block = block
       @on_change_block = nil
@@ -33,7 +37,11 @@ module Gumball
       @_item = nil if expired?
       unless @_item
         @_item = @refresh_block.call
-        @on_change_block.call(old_item, @_item) if @last_refreshed && @on_change_block && (old_item != @_item)
+        @logger.info "#{self.class} refreshed, new_value=#{@_item}"
+        if @last_refreshed && @on_change_block && (old_item != @_item)
+          @logger.debug "#{self.class} executing on_change block; detected change from previous value #{old_item}"
+          @on_change_block.call(old_item, @_item)
+        end
         @last_refreshed = now
       end
       @_item

data/lib/gumball/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Gumball
-  VERSION = "0.0.1"
+  VERSION = "0.0.7"
 end

data/spec/dispenser_spec.rb

@@ -1,27 +1,58 @@
 # frozen_string_literal: true
+
 module Gumball
   describe Dispenser do
     def now
       Time.now.to_i
     end
 
+    let(:ttl) { 5 }
+    let(:logger) { nil }
+    let(:subject) { described_class.new(ttl, logger: logger) { now }.on_change { |_, nv| @about = {new_value: nv, now: now} } }
+
     it "lives for a bit, and then refreshes" do
-      ttl = 5
-      data = described_class.new(ttl) { now }.on_change { |_, nv| @about = {new_value: nv, now: now} }
-      data.item # this "primes" it
+      subject.item # this "primes" it
 
       n = now
-      5.times { expect(data.item).to be <= n }
+      5.times { expect(subject.item).to be <= n }
       expect(@about).to be nil
 
       sleep ttl - 1
-      5.times { expect(data.item).to be <= n }
+      5.times { expect(subject.item).to be <= n }
       expect(@about).to be nil
 
       sleep 2
-      5.times { expect(data.item).to be > n }
-      expect(@about[:new_value]).to eq data.item
+      5.times { expect(subject.item).to be > n }
+      expect(@about[:new_value]).to eq subject.item
       expect(@about[:now]).to be > n
     end
+
+    context "with logger" do
+      let(:log) { StringIO.new }
+      let(:logger) { Logger.new(log) }
+      let(:log_lines) { log.string.lines }
+
+      it "lives for a bit, and then refreshes" do
+        subject.item # this "primes" it
+
+        n = now
+        5.times { expect(subject.item).to be <= n }
+        expect(@about).to be nil
+
+        sleep ttl - 1
+        5.times { expect(subject.item).to be <= n }
+        expect(@about).to be nil
+
+        sleep 2
+        5.times { expect(subject.item).to be > n }
+        expect(@about[:new_value]).to eq subject.item
+        expect(@about[:now]).to be > n
+
+        expect(log_lines.length).to eq 3
+        expect(log_lines[0]).to include("INFO", described_class.to_s, "refreshed, new_value=")
+        expect(log_lines[1]).to include("INFO", described_class.to_s, "refreshed, new_value=")
+        expect(log_lines[2]).to include("DEBUG", described_class.to_s, "executing on_change")
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'gumball'
+require "gumball"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gumball
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Kevin McDonald
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +131,8 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby-build.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -137,7 +152,7 @@ homepage: https://github.com/kevinstuffandthings/gumball
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -152,9 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Dispense expensive objects with ease
 test_files: