fingerprintable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a8d276e78f3b729a591c448b1e901639c0c21de05fa6e1090eb2c44e65c1686
+  data.tar.gz: 32b209a44af07d2f04164e3085a3a41a71ee9d7fe5dfb6092ef8211a38ecced4
+SHA512:
+  metadata.gz: eff34aeaa0d42acf25b9cbce80e413ed0024a11c525ab719a5c6c2a4797b813c664d7c860b6f2c3ad686140fafe431d78be7b58950717e9c12c257c05071cc88
+  data.tar.gz: 22872f8ccf70d43b2729a4e4ede25f66ae8e93eef8449464f46712861281876c0af35a00377d24c88dd4c582651bb61a6fab7052800be24fd629cce276ecb8ec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3
+before_install:
+  - gem update --system
+  - gem install bundler
+script:
+  - "bundle exec rspec"

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 ryanwjackson@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 [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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fingerprintable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    fingerprintable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (11.0.1)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 2.0)
+  byebug
+  colorize
+  fingerprintable!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Jackson
+
+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,66 @@
+# Fingerprintable
+
+Fingerprintable is an easy way to fingerprint any object in Ruby.  It handles cycles and allows you to override what attributes you want to include in the fingerprint.
+
+By default, Fingerprintable will use all instance variables of an object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fingerprintable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fingerprintable
+
+## Usage
+
+You can call `Fingerprintable::Fingerprinter` directly, or you can add `Fingerprintable::Mixin` to any class like so:
+
+```ruby
+module Fingerprintable
+  class MixinTestObject
+    include Fingerprintable::Mixin
+
+    attr_accessor :foo, :bar
+
+    fingerprint :baz,
+                ignore: :bar
+
+    fingerprint :asdf
+
+    def initialize(foo = nil)
+      self.foo = foo
+    end
+  end
+end
+```
+
+This results in a fingerprint being generated for these attributes: `[:@foo, :asdf, :baz]`
+
+To get a fingerprint of any instance, just call `.fingerprint`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanwjackson/fingerprintable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fingerprintable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryanwjackson/fingerprintable/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fingerprintable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fingerprintable'
+  spec.version       = Fingerprintable::VERSION
+  spec.authors       = ['Ryan Jackson']
+  spec.email         = ['ryanwjackson@gmail.com']
+
+  spec.summary       = 'Fingerprintable makes it easy to fingerprint an instance of any object.'
+  spec.description   = 'Fingerprintable adds a way to fingerprint an instance of any object, with ability to easily add or ignore attributes.'
+  spec.homepage      = 'https://www.github.com/ryanwjackson/fingerprintable'
+  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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'colorize'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/fingerprintable/debug.rb

@@ -0,0 +1,16 @@
+# TODO: Remove if we don't want this in production?
+def pdb(thing = nil, backtrace_offset: 0, **keywords)
+  backtrace_line = caller[backtrace_offset].split(':')[0..1].join(':')
+  thing = keywords if thing.eql?(nil) && keywords.any?
+  thing = thing.inspect unless thing.is_a?(String)
+
+  puts(
+    (
+      'PDB' + ': ' + thing
+    ).colorize(color: :black, background: :light_white) +
+      " @ #{backtrace_line}".colorize(color: :blue, background: :light_white)
+
+  )
+  puts "\n"
+  thing
+end

data/lib/fingerprintable/fingerprinter.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Fingerprintable
+  class Fingerprinter
+    attr_reader :attributes,
+                :cache,
+                :fallback_to_string,
+                :ignore,
+                :object
+
+    def initialize(
+      attributes: [],
+      cache: {},
+      fallback_to_string: false,
+      ignore: [],
+      object:
+    )
+      @fallback_to_string = fallback_to_string
+      @ignore = ignore | ignore.map { |e| "@#{e}".to_sym }
+      @object = object
+      @attributes = ((object.instance_variables | attributes) - ignore).map(&:to_sym).sort
+      @cache = cache || {}
+      @cache[object] = next_cache_id
+    end
+
+    def deep_convert_and_sort(obj)
+      case obj
+      when nil
+        ''
+      when String
+        obj.to_s
+      when FalseClass, Float, Integer, Symbol, TrueClass
+        obj.to_s
+      when Array
+        obj.map { |v| deep_convert_and_sort(v) }.sort.to_s
+      when Hash
+        Hash[obj.map { |k, v| [k, deep_convert_and_sort(v)] }].sort.to_s
+      when Module
+        obj.name
+      else
+        fingerprint_object(obj)
+      end
+    end
+
+    def fingerprint
+      @fingerprint ||= begin
+        Digest::MD5.hexdigest(to_s)
+      end
+    end
+
+    def to_s
+      @to_s ||= deep_convert_and_sort(object_value_hash).to_s
+    end
+
+    private
+
+    def fingerprint_object(use_object)
+      return cache[use_object] if cache.include?(use_object)
+
+      fingerprinter = if use_object.respond_to?(:fingerprint)
+                        use_object.fingerprinter(cache: @cache)
+                      elsif use_object.respond_to?(:instance_variables)
+                        Fingerprinter.new(cache: cache, object: use_object)
+                      end
+
+      if fingerprinter.nil?
+        raise "Do not know how to fingerprint #{use_object.class.name}.  Did you mean to add Fingerprintable to this object?" unless fallback_to_string
+        raise "#{use_object.class.name} does not respond to to_s.  Did you mean to add Fingerprintable to this object?" unless use_object.respond_to?(:to_s)
+
+        use_object.to_s
+      end
+
+      ret = fingerprinter.fingerprint
+      cache.merge!(fingerprinter.cache)
+      ret
+    end
+
+    def next_cache_id
+      # "#{SecureRandom.uuid}-#{@cache.count}"
+      @cache.count
+    end
+
+    def object_value_hash
+      Hash[attributes.map do |attr|
+        [attr, object.instance_variable_get(attr)]
+      end]
+    end
+  end
+end

data/lib/fingerprintable/mixin.rb

@@ -0,0 +1,43 @@
+module Fingerprintable
+  module Mixin
+    module ClassMethods
+      def inherited(subclass)
+        subclass.fingerprint(*fingerprintable_attributes)
+        super(subclass)
+      end
+
+      def fingerprint(*attrs, ignore: [])
+        @fingerprintable_attributes = fingerprintable_attributes | attrs
+        ignore = [ignore] if ignore.is_a?(String) || ignore.is_a?(Symbol)
+        fingerprintable_config[:ignore] |= ignore
+      end
+
+      def fingerprintable_attributes
+        @fingerprintable_attributes ||= []
+      end
+
+      def fingerprintable_config
+        @fingerprintable_config ||= {
+          ignore: []
+        }
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def fingerprint(*args)
+      fingerprinter.fingerprint(*args)
+    end
+
+    def fingerprinter(*attrs, cache: {})
+      Fingerprinter.new(
+        attributes: self.class.fingerprintable_attributes | attrs,
+        cache: cache,
+        object: self,
+        **self.class.fingerprintable_config
+      )
+    end
+  end
+end

data/lib/fingerprintable/version.rb

@@ -0,0 +1,3 @@
+module Fingerprintable
+  VERSION = "1.0.0"
+end

data/lib/fingerprintable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'digest'
+require 'securerandom'
+require 'colorize'
+
+require 'fingerprintable/version'
+
+require 'fingerprintable/fingerprinter'
+require 'fingerprintable/mixin'
+
+module Fingerprintable; end

data/release.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if output=$(git status --porcelain) && [ -z "$output" ]; then
+  bump $1 && git push && bundle exec rake build && bundle exec rake release
+else
+  echo 'PLEASE COMMIT ALL CHANGES BEFORE RELEASING.'
+  exit 1
+fi

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: fingerprintable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Jackson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: 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: colorize
+  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: '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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Fingerprintable adds a way to fingerprint an instance of any object,
+  with ability to easily add or ignore attributes.
+email:
+- ryanwjackson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fingerprintable.gemspec
+- lib/fingerprintable.rb
+- lib/fingerprintable/debug.rb
+- lib/fingerprintable/fingerprinter.rb
+- lib/fingerprintable/mixin.rb
+- lib/fingerprintable/version.rb
+- release.sh
+homepage: https://www.github.com/ryanwjackson/fingerprintable
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Fingerprintable makes it easy to fingerprint an instance of any object.
+test_files: []