gumball 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46cbe13b04129dc45db4d922b943eba73b653745
+  data.tar.gz: 24dc7b3f61ff28295d104ffa4b4e53965d6c2af4
+SHA512:
+  metadata.gz: 520b55c18544eadda7c062ed83a1fc1d574119400994020cf23a36dd183b1404a46064da6022d50965805b4da109f87ced5fa06646f441e81d147365636bf642
+  data.tar.gz: 9b98c5891ff0b3c69ef9b19203e14695ad32081680d7587d850530e168a01c5e1d0759d09d2a976dbc54da905ccc071d1215836c594adcf2c538f6754adf6b17

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add code/outputs to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: kevinstuffandthings
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# 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
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # 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
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.4
+- 2.5
+- 2.6
+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=
+  gem: gumball
+  on:
+    tags: true
+    repo: kevinstuffandthings/gumball
+  skip_cleanup: 'true'

data/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevinstuffandthings@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin McDonald
+
+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,75 @@
+# 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)
+
+A gem providing a mechanism to dispense instances of a class, somewhere between a true singleton and new instance each time.
+
+Originally developed for [Simulmedia](https://simulmedia.com).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'gumball'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install gumball
+```
+
+## Usage
+Let's say we have some expensive operation we need to utilize the value of. We need to refresh it occasionally, but if we sometimes get a
+slightly-stale copy, that's ok.
+
+```ruby
+class ExpensiveThing
+  def self.value
+    sleep 5
+    rand(1..100)
+  end
+end
+```
+
+We set up a new dispenser for that operation. These dispensers are best saved as class variables, so the dispenser itself is a singleton.
+
+```ruby
+require 'gumball'
+
+dispenser = Gumball::Dispenser.new(300) { ExpensiveThing.value }
+# => #<Gumball::Dispenser:0x007f87eff446c8 @ttl=300, @last_refreshed=nil, @refresh_block=#<Proc:0x007f87eff44678@(irb):9>, @on_change_block=nil>
+
+dispenser.item # this will take a while
+# => 90
+
+dispenser.item # if run in quick succession, returned result is immediate, and value is the same
+# => 90
+
+sleep 305
+
+dispenser.item # ttl has expired... prepare to wait
+# => 41
+
+dispenser.item # we've saved our refreshed version, and our response is immediate!
+# => 41
+```
+
+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 }
+dispenser.on_change { |o, n| puts "OUR VALUE CHANGED: #{o} -> #{n}" }
+```
+
+The `on_change` method counts on equality being properly implemented between the values, and ONLY fires when inequality between
+old and new items is detected. If the refresh pulls in the same value, the `on_change` block is not triggered.
+
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/gumball/issues).
+We'll figure out how to get you up and running with Gumball as smoothly as possible.

data/Rakefile

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

data/gumball.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/gumball.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "gumball/version"
+require "gumball/dispenser"
+
+# Gumball
+module Gumball
+end

data/lib/gumball/dispenser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Gumball
+  class Dispenser
+    attr_reader :ttl
+
+    # Set up a new dispenser.
+    # @param ttl [???]
+    # @param block
+    # @return [Dispenser]
+    def initialize(ttl, &block)
+      @ttl = ttl
+      @last_refreshed = nil
+      @refresh_block = block
+      @on_change_block = nil
+    end
+
+    # Add a block to execute upon detection of a change in the item.
+    # The block should accept the old/new versions of the item.
+    # @param block
+    # @return [self]
+    def on_change(&block)
+      @on_change_block = block
+      self
+    end
+
+    # Retrieve an item from the dispenser. On the first retrieval, a
+    # new instance of the item will be created, and returned until deemed
+    # expired by the specified `ttl`.
+    # @return item
+    def item
+      now = Time.now
+      old_item = @_item
+      @_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)
+        @last_refreshed = now
+      end
+      @_item
+    end
+
+    private
+
+    def expired?
+      return false unless @last_refreshed
+      @last_refreshed + ttl < Time.now
+    end
+  end
+end

data/lib/gumball/version.rb

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

data/spec/dispenser_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Gumball
+  describe Dispenser do
+    def now
+      Time.now.to_i
+    end
+
+    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
+
+      n = now
+      5.times { expect(data.item).to be <= n }
+      expect(@about).to be nil
+
+      sleep ttl - 1
+      5.times { expect(data.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
+      expect(@about[:now]).to be > n
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'gumball'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: gumball
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin McDonald
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: pry-byebug
+  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: rack-test
+  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: rake
+  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: rspec
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dispense expensive objects with ease
+email:
+- kevinstuffandthings@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gumball.gemspec
+- lib/gumball.rb
+- lib/gumball/dispenser.rb
+- lib/gumball/version.rb
+- spec/dispenser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kevinstuffandthings/gumball
+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: Dispense expensive objects with ease
+test_files:
+- spec/dispenser_spec.rb
+- spec/spec_helper.rb