fresh_objects 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebc619340a5b428eecb98a339179d2e34fded10b7f4aa504e4b18e657e329d6d
+  data.tar.gz: 2f9cccab381e4c60efe6131a7e3830f54658e547e4e004bea68c1d735c53c155
+SHA512:
+  metadata.gz: 066aec06f31fd8d86bd3721c286c31b42a6c320066d2009a43021f96a3bfd6063208ee8539b6cfbca6005e4efe3ccf5d2862b36381bbb6ed1139c0189b6ec3dc
+  data.tar.gz: 3a72e3f846a61683a8d5a946ba7d1cb7349237985a2fe24634d289e650427e404adfd0b3ae83d1cdc46e95b28d4c7162a59e8b5fcaf81becc2e37382db9a702e

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - fresh_objects.gemspec
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,25 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b569b140239d7341120e5d507f418e417bc9f4e78ba008f46eb8ee3015ab45ec
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0-alpha (November 11th, 2019)
+
+Published pre-reviewed initial implementation.
+
+# 0.0.1 (November 8th, 2019)
+
+Published initial shell.  Library has no functionality yet.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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, gender identity and expression, level of experience,
+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 oss@bluemarblepayroll.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+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,149 @@
+# Fresh Objects
+
+[![Gem Version](https://badge.fury.io/rb/fresh_objects.svg)](https://badge.fury.io/rb/fresh_objects) [![Build Status](https://travis-ci.org/bluemarblepayroll/fresh_objects.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/fresh_objects) [![Maintainability](https://api.codeclimate.com/v1/badges/157958522c93760a396c/maintainability)](https://codeclimate.com/github/bluemarblepayroll/fresh_objects/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/157958522c93760a396c/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/fresh_objects/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This library was built to support incoming data streams where you may or may not get the data in order.  Since the data coming in is guaranteed to be complete "per object", you only need to keep the latest copy of it and discard stale versions.  You can use this library to pass in all this data (in or out of order) and it will ensure only the freshest data is kept (stale copies are discarded.)
+
+Note: persistence is outside of the scope of this library.  You can, however, use this library to access the "object id => timestamp" hash structure that is used for filtering and persist it.  Then, you can use it to re-hydrate a filter and pick up where you left off.
+
+## Installation
+
+To install through Rubygems:
+
+````bash
+gem install install fresh_objects
+````
+
+You can also add this to your Gemfile:
+
+````bash
+bundle add fresh_objects
+````
+
+## Examples
+
+Say we have the following dataset:
+
+````ruby
+objects = [
+  {
+    id: 1,
+    name: 'Batman'
+    timestamp: '2019-01-02 12:00:00 UTC'
+  },
+  {
+    id: 1,
+    name: 'Superman'
+    timestamp: '2019-01-02 12:00:01 UTC'
+  },
+  {
+    id: 1,
+    name: 'Ironman'
+    timestamp: '2019-01-02 11:59:59 UTC'
+  }
+]
+````
+
+You could pass these objects into this library in order to resolve that the object you really want is the "Superman" object:
+
+````ruby
+filter = FreshObjects.filter(timestamp_key: :timestamp).add_each(objects)
+
+filtered_objects = filter.objects
+````
+
+Now, filtered_objects should equal:
+
+````ruby
+[
+  {
+    id: 1,
+    name: 'Superman'
+    timestamp: '2019-01-02 12:00:01 UTC'
+  }
+]
+````
+
+Notes:
+
+* You can change the object ID key by passing in the `id_key` into `FreshObjects#filter`.
+* You can change the timestamp key by passing in the `timestamp_key` into `FreshObjects#filter`.
+* You can change the resolver by passing in a custom `resolver` into `FreshObjects#filter`. Technically, a resolver can be anything with a #get ethod based on the [Objectable resolver#get method](https://github.com/bluemarblepayroll/objectable/blob/master/lib/objectable/resolver.rb).
+
+### Saving a Filter
+
+Ultimately what backs a filter is a hash with strings as keys and Time objects as values.  This can be accessed for persistence:
+
+````ruby
+lookup = filter.timestamps_by_id
+````
+
+Then, you can re-constitute a filter from this:
+
+````ruby
+filter = FreshObjects.filter(lookup: timestamps_by_id)
+````
+
+Notes:
+
+* The lookup is just the timestamp cache, it does not contain the other options such as other Filter#new options.
+* The next time you use a re-constituted filter, objects will be empty.  That means the `#objects` method is not cumulative across uses (per object instance.)  Remember, the goal of this library is the core filtering algorithm, not persistence.
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check fresh_objects.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/fresh_objects.git)
+4. Navigate to the root folder (cd fresh_objects)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite and code-coverage tool, run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+or run all three in one command:
+
+````bash
+bundle exec rake
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/fresh_objects/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/fresh_objects/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/setup'
+require 'fresh_objects'
+
+# 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.
+
+require 'pry'
+Pry.start

data/fresh_objects.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require './lib/fresh_objects/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'fresh_objects'
+  s.version     = FreshObjects::VERSION
+  s.summary     = 'Filtering algorithm that keeps track of object timestamps and only keeps the freshest version of each object.'
+
+  s.description = <<-DESCRIPTION
+    This library provides a simple algorithm for object filtering based on an object's timestamp.
+    A master list of object ID's and timestamps are managed by this library and can be persisted
+    (outside of this library) for picking up where you last left off.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/fresh_objects'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('objectable', '~>1')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 12')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~>0.74.0')
+  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('simplecov-console', '~>0.5.0')
+end

data/lib/fresh_objects.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'objectable'
+require 'time'
+
+require_relative 'fresh_objects/filter'
+
+# Top-level namespace
+module FreshObjects
+  class << self
+    # Syntactic sugary proxy for easy building of Filter instances.
+    def filter(*args)
+      Filter.new(*args)
+    end
+  end
+end

data/lib/fresh_objects/filter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'lookup'
+
+module FreshObjects
+  # This class can do a "row/timestamp-based semantic merge".  In other words:
+  # you can use this class to dump any number of arrays of objects into and it will sift
+  # through them and only keep the latest, non-stale copies of the objects.
+  class Filter
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :id_key,
+                :lookup,
+                :resolver,
+                :timestamp_key
+
+    def_delegators :lookup, :timestamps_by_id
+
+    def_delegators :objects, :each
+
+    def initialize(lookup: {}, id_key: :id, timestamp_key: nil, resolver: Objectable.resolver)
+      @lookup        = Lookup.make(lookup)
+      @id_key        = id_key
+      @timestamp_key = timestamp_key
+      @resolver      = resolver
+      @objects_by_id = {}
+    end
+
+    def add_each(objects, default_timestamp: Time.now.utc)
+      tap { objects.each { |o| add(o, default_timestamp: default_timestamp) } }
+    end
+
+    def add(object, default_timestamp: Time.now.utc)
+      id        = resolver.get(object, id_key).to_s
+      timestamp = resolve_timestamp(object, default_timestamp)
+
+      objects_by_id[id] = object if lookup.fresh_set?(id, timestamp)
+
+      self
+    end
+
+    private
+
+    attr_reader :objects_by_id
+
+    def objects
+      objects_by_id.values
+    end
+
+    def resolve_timestamp(object, default_timestamp)
+      # If we have a timestamp key then lets try and get it from the record.
+      # If we don't then we can defer to the default.
+      retrieved = timestamp_key ? resolver.get(object, timestamp_key) : default_timestamp
+
+      # One last check, just in case the record returned back something "null-like" like a blank
+      # string, lets treat that as nil.
+      return default_timestamp if retrieved.to_s.empty?
+
+      retrieved
+    end
+  end
+end

data/lib/fresh_objects/lookup.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module FreshObjects
+  # A data structure which holds a timestamp per ID.  It can then be used as a performant lookup
+  # to see if an incoming timestamp is stale or new.  It is essentially backed by a hash
+  # where the key is a string and the value is a Time object.
+  # You can also pass in a hash into the constructor for configuration ease.
+  class Lookup
+    class << self
+      def make(timestamps_by_id = {})
+        if timestamps_by_id.is_a?(self)
+          timestamps_by_id
+        else
+          new(timestamps_by_id)
+        end
+      end
+    end
+
+    attr_reader :timestamps_by_id
+
+    def initialize(timestamps_by_id = {})
+      @timestamps_by_id = timestamps_by_id.map do |id, timestamp|
+        [id.to_s, parse_time(timestamp)]
+      end.to_h
+
+      freeze
+    end
+
+    def fresh_set?(id, timestamp)
+      fresh?(id, timestamp).tap do |fresh|
+        set(id, timestamp) if fresh
+      end
+    end
+
+    def fresh?(id, timestamp)
+      !stale?(id, timestamp)
+    end
+
+    def stale?(id, timestamp)
+      id        = id.to_s
+      current   = get(id)
+      timestamp = parse_time(timestamp)
+
+      current && timestamp <= current
+    end
+
+    def get(id)
+      timestamps_by_id[id.to_s]
+    end
+
+    def set(id, timestamp)
+      tap { timestamps_by_id[id.to_s] = parse_time(timestamp) }
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && timestamps_by_id == other.timestamps_by_id
+    end
+    alias eql? ==
+
+    private
+
+    def parse_time(time)
+      time.is_a?(Time) ? time : Time.parse(time.to_s).utc
+    end
+  end
+end

data/lib/fresh_objects/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module FreshObjects
+  VERSION = '1.0.0-alpha'
+end

data/spec/fresh_objects/filter_spec.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe FreshObjects::Filter do
+  let(:lookup) do
+    {
+      'rizzo': '1950-01-03 12:00:00 UTC'
+    }
+  end
+
+  subject { described_class.new(lookup: lookup, timestamp_key: :timestamp) }
+
+  specify '#timestamps_by_id returns the underlying lookup hash' do
+    expected = {
+      'rizzo' => Time.parse('1950-01-03 12:00:00 UTC').utc
+    }
+
+    expect(subject.timestamps_by_id).to eq(expected)
+  end
+
+  context 'using default_timestamp' do
+    it 'skips existing objects before timestamp' do
+      object = {
+        id: :rizzo,
+        first: :frank
+      }
+
+      subject.add(object, default_timestamp: '1950-01-03 11:59:59 UTC')
+
+      expect(subject.to_a).to eq([])
+    end
+
+    it 'adds existing objects after timestamp' do
+      object = {
+        id: :rizzo,
+        first: :frank
+      }
+
+      subject.add(object, default_timestamp: '1950-01-03 12:00:01 UTC')
+
+      expect(subject.to_a).to eq([object])
+    end
+
+    it 'adds new objects' do
+      object = {
+        id: :bozo,
+        first: 'the clown'
+      }
+
+      subject.add(object, default_timestamp: '1950-01-03 12:00:01 UTC')
+
+      expect(subject.to_a).to eq([object])
+    end
+  end
+
+  context 'using object timestamp' do
+    it 'skips existing objects before timestamp' do
+      object = {
+        id: :rizzo,
+        first: :frank,
+        timestamp: '1950-01-03 11:59:59 UTC'
+      }
+
+      subject.add(object)
+
+      expect(subject.to_a).to eq([])
+    end
+
+    it 'adds existing objects after timestamp' do
+      object = {
+        id: :rizzo,
+        first: :frank,
+        timestamp: '1950-01-03 12:00:01 UTC'
+      }
+
+      subject.add(object)
+
+      expect(subject.to_a).to eq([object])
+    end
+  end
+
+  context 'overriding objects' do
+    let(:object1) do
+      {
+        id: :rizzo,
+        first: :frank1,
+        timestamp: '1950-01-03 12:00:01 UTC'
+      }
+    end
+
+    let(:object2) do
+      {
+        id: :rizzo,
+        first: :frank2,
+        timestamp: '1950-01-03 12:00:02 UTC'
+      }
+    end
+
+    context 'in chonological add order' do
+      before(:each) { subject.add_each([object1, object2]) }
+
+      it 'keeps latest object' do
+        expect(subject.to_a).to eq([object2])
+      end
+    end
+
+    context 'in chonological add order' do
+      before(:each) { subject.add_each([object2, object1]) }
+
+      it 'keeps latest object' do
+        expect(subject.to_a).to eq([object2])
+      end
+    end
+  end
+end

data/spec/fresh_objects/lookup_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe FreshObjects::Lookup do
+  let(:rizzo_stamp) { '1950-01-03 12:00:00 UTC' }
+
+  let(:later_stamp) { '1950-01-03 12:00:01 UTC' }
+
+  let(:timestamps_by_id) do
+    {
+      rizzo: rizzo_stamp
+    }
+  end
+
+  subject { described_class.new(timestamps_by_id) }
+
+  describe 'class methods' do
+    describe '#make' do
+      it 'returns argument if argument is a Lookup instance' do
+        subject2 = described_class.make(subject)
+
+        # #be for object equality
+        expect(subject2).to be(subject)
+      end
+
+      it 'delegates to initializer if argument is not a Lookup instance' do
+        expect(described_class).to receive(:new).with(timestamps_by_id)
+
+        described_class.make(timestamps_by_id)
+      end
+    end
+  end
+
+  # This implicitly will test #fresh?, #stale?, #get, and #set.
+  describe '#fresh_set?' do
+    it 'is true for ids not present' do
+      expect(subject.fresh_set?(:marsha, '2000-04-05 02:03:04 UTC')).to be true
+    end
+
+    it 'returns is false for ids already present that have equal timestamps' do
+      expect(subject.fresh_set?(:rizzo, rizzo_stamp)).to be false
+    end
+
+    it 'returns false for ids already present that have earlier timestamps' do
+      expect(subject.fresh_set?(:rizzo, '1950-01-03 11:59:59 UTC')).to be false
+    end
+
+    it 'returns true and updates timestamp for ids already present that have later timestamps' do
+      expect(subject.fresh_set?(:rizzo, later_stamp)).to be true
+      expect(subject.timestamps_by_id['rizzo']).to eq(Time.parse(later_stamp).utc)
+    end
+  end
+
+  describe 'equality' do
+    let(:subject2) { described_class.new(timestamps_by_id) }
+
+    specify '#eql? compares class type and underlying hash' do
+      expect(subject).to eql(subject2)
+    end
+
+    specify '#== compares class type and underlying hash' do
+      expect(subject).to eq(subject2)
+    end
+  end
+end

data/spec/fresh_objects_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+RSpec.describe FreshObjects do
+  describe 'class methods' do
+    let(:arguments) do
+      {
+        lookup: { a: :b },
+        id_key: :id_key,
+        timestamp_key: :timestamp_key,
+        resolver: Objectable.resolver
+      }
+    end
+
+    specify '#filter delegates to Filter#new' do
+      expect(described_class::Filter).to receive(:new).with(arguments)
+
+      described_class.filter(arguments)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'pry'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
+
+require './lib/fresh_objects'

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: fresh_objects
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: objectable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: |2
+      This library provides a simple algorithm for object filtering based on an object's timestamp.
+      A master list of object ID's and timestamps are managed by this library and can be persisted
+      (outside of this library) for picking up where you last left off.
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- fresh_objects.gemspec
+- lib/fresh_objects.rb
+- lib/fresh_objects/filter.rb
+- lib/fresh_objects/lookup.rb
+- lib/fresh_objects/version.rb
+- spec/fresh_objects/filter_spec.rb
+- spec/fresh_objects/lookup_spec.rb
+- spec/fresh_objects_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluemarblepayroll/fresh_objects
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Filtering algorithm that keeps track of object timestamps and only keeps
+  the freshest version of each object.
+test_files:
+- spec/fresh_objects/filter_spec.rb
+- spec/fresh_objects/lookup_spec.rb
+- spec/fresh_objects_spec.rb
+- spec/spec_helper.rb