directory_diff 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46f328ebf0259a3a6ebaddab6158960443e81f87
+  data.tar.gz: 1e36f33e7de50e12e1a542ddea964329cf3eaae8
+SHA512:
+  metadata.gz: 003bfc813540d9defb4a14745b4969bcb986e52809c552beabce57faeed97a089cd7537efb38e93692ac7d465947abb93aa042d444549f7eb5da263e1876af38
+  data.tar.gz: c3c69802ed023e524255a215c468773e0e08242974edd79275931c8976214fa07987dc3a8bcc66cf1e2d886412aa761f61c3e8086f8f63659868c3f3b4f625ea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kamal.fariz@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in directory_diff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kamal Mahyuddin
+
+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,60 @@
+# DirectoryDiff
+
+This microlibrary implements employee directory diffing between two versions. It generates a list of operations that need to be performed to transform the directory in version 1 to version 2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'directory_diff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install directory_diff
+
+## Usage
+
+```ruby
+# Extract out current directory from the database into memory
+# into a format that's similar to the incoming CSV, i.e.
+# full name, email, phone number, assistant email
+existing_directory = [
+  ["Kamal Mahyuddin", "kamal@envoy.com", "415-555-1234", "adolfo@envoy.com"],
+  ["Adolfo Builes", "adolfo@envoy.com", "415-666-9999", nil]
+]
+
+csv_data = [
+  ["Kamal Mahyuddin", "kamal@envoy.com", "415-555-1234", "adolfo@envoy.com"],
+  ["Adolfo Builes-Ramirez", "adolfo@envoy.com", "415-666-9999", "matthew@envoy.com"],
+  ["Matthew Johnston", "matthew@envoy.com", "415-777-8888", nil]
+]
+
+operations = DirectoryDiff.transform(existing_directory).into(csv_data)
+# => [
+#      [:insert, "Matthew Johnston", "matthew@envoy.com", "415-777-8888", nil],
+#      [:update, "Adolfo Builes-Ramirez", "adolfo@envoy.com", "415-666-9999", "matthew@envoy.com"],
+#      [:noop, "Kamal Mahyuddin", "kamal@envoy.com", "415-555-1234", "adolfo@envoy.com"]
+#    ]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/envoy/directory_diff. 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](http://opensource.org/licenses/MIT).
+

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 "directory_diff"
+
+# 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

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/directory_diff.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'directory_diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "directory_diff"
+  spec.version       = DirectoryDiff::VERSION
+  spec.authors       = ["Kamal Mahyuddin"]
+  spec.email         = ["kamal@envoy.com"]
+
+  spec.summary       = %q{Envoy employee directory diffing.}
+  spec.description   = %q{This microlibrary implements employee directory diffing between two versions.}
+  spec.homepage      = "https://github.com/envoy/directory_diff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/directory_diff.rb

@@ -0,0 +1,9 @@
+require "directory_diff/version"
+require "directory_diff/transform"
+
+module DirectoryDiff
+  def self.transform(current_directory)
+    raise ArgumentError unless current_directory.respond_to?(:each)
+    Transform.new(current_directory)
+  end
+end

data/lib/directory_diff/transform.rb

@@ -0,0 +1,130 @@
+module DirectoryDiff
+  class Transform
+    attr_reader :current_directory, :new_directory
+    attr_reader :transforms, :transforms_index
+    attr_reader :options
+
+    def initialize(current_directory)
+      @current_directory = current_directory
+      @transforms = []
+      @transforms_index = {}
+    end
+
+    def into(new_directory, options={})
+      raise ArgumentError unless new_directory.respond_to?(:each)
+      @new_directory = new_directory
+      @options = options || {}
+
+      current_employees.each do |email, employee|
+        process_employee(email, employee)
+      end
+
+      unseen_employees.each do |email, employee|
+        process_employee(email, employee)
+      end
+
+      transforms
+    end
+
+    protected
+
+    def process_employee(email, assistant_owner)
+      new_employee = find_new_employee(email)
+      old_employee = find_current_employee(email)
+
+      # cycle detection
+      if transforms_index.has_key?(email)
+        return
+      end
+      transforms_index[email] = nil
+
+      if new_employee.nil?
+        add_transform(:delete, old_employee)
+        assistant_owner[3] = nil
+      else
+        own_email = new_employee[1]
+        assistant_emails = new_employee[3].to_s.split(",")
+        assistant_emails.delete(own_email)
+
+        if assistant_emails.empty?
+          assistant_emails = new_employee[3] = nil
+        end
+
+        if assistant_emails
+          assistant_emails.each do |assistant_email|
+            process_employee(assistant_email, new_employee)
+          end
+        else
+          # assistant_emails may be nil. we only use the
+          # csv to *set* assistants. if it was nil, we
+          # backfill from current employee so that the
+          # new record appears to be the same as the
+          # current record
+          previous_assistants = old_employee&.fetch(3).to_s.split(",")
+          previous_assistants.select! do |previous_assistant|
+            find_new_employee(previous_assistant)
+          end
+
+          if previous_assistants.empty?
+            new_employee[3] = nil
+          else
+            new_employee[3] = previous_assistants.join(",")
+          end
+        end
+
+        if old_employee.nil?
+          add_transform(:insert, new_employee)
+        elsif new_employee == old_employee
+          add_transform(:noop, old_employee) unless options[:skip_noop]
+        else
+          add_transform(:update, new_employee)
+        end
+      end
+    end
+
+    def add_transform(op, employee)
+      return if employee.nil?
+      email = employee[1]
+      existing_operation = transforms_index[email]
+      if existing_operation.nil?
+        operation = [op, *employee]
+        transforms_index[email] = operation
+        transforms << operation
+      end
+    end
+
+    def find_new_employee(email)
+      new_employees[email]
+    end
+
+    def find_current_employee(email)
+      current_employees[email]
+    end
+
+    def new_employees
+      @new_employees ||= build_index(new_directory)
+    end
+
+    def current_employees
+      @current_employees ||= build_index(current_directory)
+    end
+
+    def unseen_employees
+      emails = new_employees.keys - current_employees.keys
+      accum = []
+      emails.each do |email|
+        accum << [email, new_employees[email]]
+      end
+      accum
+    end
+
+    def build_index(directory)
+      accum = {}
+      directory.each do |employee|
+        email = employee[1]
+        accum[email] = employee
+      end
+      accum
+    end
+  end
+end

data/lib/directory_diff/version.rb

@@ -0,0 +1,3 @@
+module DirectoryDiff
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: directory_diff
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kamal Mahyuddin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: This microlibrary implements employee directory diffing between two versions.
+email:
+- kamal@envoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- directory_diff.gemspec
+- lib/directory_diff.rb
+- lib/directory_diff/transform.rb
+- lib/directory_diff/version.rb
+homepage: https://github.com/envoy/directory_diff
+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: Envoy employee directory diffing.
+test_files: []
+has_rdoc: