pedanco-diffr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab7434a821dc08fd4cbaf49a4b1802182b755bed
+  data.tar.gz: 06219e44cfbf45f8ff8a867a2058ff8db8dc5e78
+SHA512:
+  metadata.gz: c54abecceac0488bc88d4f1069bab65a62d4b20ecd55594e33ec0fbd8bc299941aac5a252c5ad22fc1ae4f9a4cc00f27846b1ae2eea8d9ff328c1b749af26087
+  data.tar.gz: 22b9b82fb4856c4957437ce5666494bec1f6f51de3e62b8f75ef21999e1e1343be8208fa0d3900ec5b221474c2ef668a51d56bf33a4cea8b3b0b521b062363d1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.0 (2015-03-10)
+
+Authors: James Polanco
+
+* Initial release of Pedanco::Diffr
+* Some changes to API from internal version
+* Added documentation and code comments

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pedanco-diffr.gemspec
+gemspec
+
+gem 'coveralls', require: false
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    pedanco-diffr (1.0.0)
+      activesupport (>= 3.2, <= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coveralls (0.7.11)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    mime-types (2.4.3)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter
+  coveralls
+  pedanco-diffr!
+  rake (~> 10.0)
+  rspec (~> 3.2)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 DevelopmentArc
+
+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,184 @@
+# pedanco-diffr
+
+[![Codeship Status for DevelopmentArc/pedanco-diffr](https://codeship.com/projects/2ca2cec0-a9a6-0132-8917-427bb4181a39/status?branch=master)](https://codeship.com/projects/67769)
+[![Code Climate](https://codeclimate.com/github/DevelopmentArc/pedanco-diffr/badges/gpa.svg)](https://codeclimate.com/github/DevelopmentArc/pedanco-diffr)
+[![Coverage Status](https://coveralls.io/repos/DevelopmentArc/pedanco-diffr/badge.svg?branch=master)](https://coveralls.io/r/DevelopmentArc/pedanco-diffr?branch=master)
+
+A change set library for managing how data is evolved overtime. `Pedanco::Diffr` allows you to track changes in a `ChangeSet` and then query the `ChangeSet` to determine if the data has changed, what the current value is and what the previous value was. This was inspired by the [ActiveModel::Dirty](http://api.rubyonrails.org/classes/ActiveModel/Dirty.html) class, but has been isolated so that it can be used to track any kind of data change without the ActiveModel/ActiveRecord inclusions.
+
+# Installation
+```bash
+gem install pedanco-diffr
+```
+
+Or add it to your Gemfile:
+
+```bash
+gem 'pedanco-diffr'
+```
+
+# Usage
+
+```ruby
+# Create a new ChangeSet
+change_set = Pedanco::Diffr::ChangeSet.new(name: ['Tim', 'Tom'])
+
+# Add another change and query the ChangeSet
+change_set.add_change(:age, 21, 23)
+change_set.name_changed? # => true
+change_set.changed(:age) # => true
+
+# Remove a change and query the ChangeSet
+change_set.remove_change(:age) # => true
+change_set.age_changed? # => false
+change_set.changed?(:age) # => false
+
+# Extract a change
+name_change = change_set.get_change(:name) # => Pedanco::Diffr::Change
+name_change.current # => 'Tim'
+name_change.previous # => 'Tom'
+```
+
+# Creating a ChangeSet
+When creating a new ChangeSet you can pass in a `Hash` of named `Arrays`. The key of the hash will be used to generate the change name, and the `Array` defines the current and previous values.
+
+```ruby
+data_set   = { city: ['San Diego', 'Denver'], state: ['CA', nil] }
+change_set = Pedanco::Diffr::ChangeSet.new(data_set)
+change_set.state_changed? #=> true
+```
+
+You can also directly add changes using the `add_change` method.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:state, 'CA')
+
+change_set.city_changed? #=> true
+change_set.state_changed? #=> true
+```
+
+If you want to import `ActiveModel::Dirty` changes into a `ChangeSet` you can call the `parse_changes()` method passing in the data.
+
+```ruby
+# We have updated an Address Model (ActiveRecord::Base) and want to store the changes
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.parse_changes(address.changes)
+```
+
+# Quering the ChangeSet
+
+Once a change has been added you can query the ChangeSet to see if the set contains a change you are looking for. You can do this by using the `_changed?` convinence method, which prepends the name of the change, such as `city_changed?`. You can can also call the `changed?` method passing in the name of the change you want to verify.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+
+# Using _changed?
+change_set.city_changed? #=> true
+change_set.address_changed? #=> false
+
+# Using changed?()
+change_set.changed?(:city) # => true
+change_set.changed?(:address) # => false
+```
+
+The `changed?` method also allows you to pass in an array of names to query by. By default, if the `ChangeSet` has any of the changes requested, it will return `true`.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+
+# Pass an Array of names to query
+change_set.changed?([:city, :address]) # => true
+```
+
+If you need to make sure that all the key names passed have changed, then you can pass the `:all` flag to `changed?` method.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.changed?([:city, :address], :all) # => false
+```
+
+# Using Changes
+Once you have created a change set you can access the current and previous value of the change by calling `get_change`
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:state, 'CA')
+
+change_set.get_change(:city).current # => 'San Diego'
+change_set.get_change(:city).previous # => 'Denver'
+```
+
+When calling `get_change` the ChangeSet will return a `Pedanco::Diffr::Change` instance. This instance allows you to get the name, current and previous value. If the change request can not be found then an empty `Change` will be returned.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change = change_set.get_change(:age)
+change.name # => :age
+change.current # => nil
+change.previous # => nil
+```
+
+# Change values
+A `Pedanco::Diffr::Change` instance's current or previous values can be any kind of data. By default both the current and previous are `nil`. This allows for empty changes, a change from empty to something or something to empty. Only the name of the change is required. The name can be a `String` or `Symbol`. By defailt we convert the name to a `Symbol` for lookup purposes.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change('name', nil, nil) # => Empty change
+change_set.add_change('field', 'Bar') # => Empty to something change
+change_set.add_change(:money, nil, 'Something') # => Soemthing to empty change
+```
+
+When calling `add_change` only a current value must be passed to the method (including `nil`). By default the previous value will be set to `nil`.
+
+# Updating changes
+When working with a ChangeSet you can remove an existing change or overwrite it. To remove a change you can call the `remove_change` method. To override a change, just call `add_change` with the same name.
+
+```ruby
+change_set = Pedanco::Diffr::ChangeSet.new
+change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:state, 'CA')
+
+# overriding a change
+change_set.add_change(:state, 'CA', 'CO')
+change_set.get_change(:state).previous # => 'CO'
+
+# removing a change
+change_set.remove_change(:city)
+change_set.city_changed? # => false
+```
+
+# Why Pedanco::Diffr?
+At [Pedanco](https://pedanco.com) we use [Wisper](https://github.com/krisleech/wisper) to handle global events. When these events are dispatched, they trigger cache invalidation, system wide updates, and other complex tasks that usually run in an async worker. The challenge we had was that some changes in the system trigger different actions.
+
+For example, when a user changes their Role or name, we need to run a lot of cache updates to change access rights and views. But, if they just change their signature then we don't need to trigger these system updates.
+
+`Pedanco::Diffr` allows us to build a `ChangeSet` that is then passed along with the Wisper event. Our global subscribers can then process the changes and trigger different actions based on what changed. We use a combination of custom change tracking in [Mutations](https://github.com/cypriss/mutations) and `ActiveRecord` changes to build out our `ChangeSet` and then dispatch them once the process of creation/updating is complete.
+
+# Liscence
+The MIT License (MIT)
+
+Copyright (c) 2015 DevelopmentArc
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/pedanco/diffr.rb

@@ -0,0 +1,33 @@
+#--
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 DevelopmentArc
+#
+# 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.
+#++
+
+# 3rd Party Gem Dependencies
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/wrap'
+
+# Gem Dependencies
+require 'pedanco/diffr/version'
+require 'pedanco/diffr/change'
+require 'pedanco/diffr/change_set'

data/lib/pedanco/diffr/change.rb

@@ -0,0 +1,50 @@
+module Pedanco
+  module Diffr
+    #
+    # A Change represents a current and previous state for specifc piece of
+    # data. These states can represent any kind of information and are linked
+    # by the name of the data they represent.
+    #
+    #   Pedanco::Diffr::Change.new(:first_name, 'Jim', 'James')
+    #
+    # @!attribute [rw] name
+    #   @return [String,Symbol] the name identifier for the change set
+    # @!attribute [rw] current
+    #   @return [Any] the current state of the change
+    # @!attribute [rw] previous
+    #   @return [Any] the previous state of the change
+    #
+    # @author [jpolanco]
+    #
+    class Change
+      attr_accessor :name, :current, :previous
+
+      #
+      # Initializes the data when passed via new().
+      #
+      # @param name [String/Symbol] (required) The name of the data
+      # @param current [Any] (optional) The current value for the
+      #   change, defaults to nil.
+      # @param previous [Any] (optional) The previous value for the
+      #   change, defaults to nil.
+      #
+      # @raise [RuntimeError] if name is nil or ''
+      def initialize(name, current = nil, previous = nil)
+        fail 'Name is required for a Change.' if name.blank?
+        @name     = name
+        @current  = current
+        @previous = previous
+      end
+
+      #
+      # Converts the Change into an array, following the ActiveRecord
+      # changes syntax. The first position is the previous value, the
+      # second is the current value.
+      #
+      # @return [Array] The array version of the Change
+      def to_a
+        [@previous, @current]
+      end
+    end
+  end
+end

data/lib/pedanco/diffr/change_set.rb

@@ -0,0 +1,209 @@
+module Pedanco
+  module Diffr
+    #
+    # A ChangeSet contains a one or more changes. Change data can be
+    # passed during `new()` or can be added/removed directly from the
+    # change instance.
+    #
+    # When a change is added, the ChangeSet provides both a direct method
+    # to look up a change or a convience method with a `_changed?` prefix.
+    #
+    #   inst = Pedanco::Diffr::ChangeSet.new
+    #   inst.add_change(:age, 40, 39)
+    #
+    #   inst.age_changed? # true
+    #   inst.changed?(:age) # true
+    #
+    # When creating a ChangeSet you can also pass in ActiveModel::Dirty syntax
+    # to the `parse_changes()` method to convert the data into a ChangeSet.
+    #
+    # @author [jpolanco]
+    #
+    class ChangeSet
+      #
+      # Initializes the Change instance. Allows for a hash of array pairs, ex:
+      #
+      #   { name: ['Bob', 'Tom'], age: [33, 32] }
+      #
+      # which represents a change set to be parsed in on creation.
+      #
+      # @param change_hash [Hash]
+      #   (optional) hash to be converted into a ChangeSet.
+      #
+      def initialize(change_hash = {})
+        @changes = parse_change_hash(change_hash)
+      end
+
+      #
+      # Override to catch `_changed?` postfix convenience calls to
+      # determine if a property has changed.
+      #
+      def method_missing(name, *args, &block)
+        if name.to_s =~ /_changed\?/
+          @changes.key?(name.to_s.gsub(/_changed\?/, '').to_sym)
+        else
+          super
+        end
+      end
+
+      #
+      # Implementation to support respond_to? lookup for
+      # `_changed?` postfix convenience calls.
+      #
+      # @return [Boolean] true if class responds to the requested
+      #   method name
+      def respond_to?(name, include_private = false)
+        if name.to_s =~ /_changed\?/
+          true
+        else
+          super
+        end
+      end
+
+      #
+      # Adds a change to the change set. This method converts the arguments
+      # into a Change object internally.
+      #
+      #   inst = Pedanco::Diffr::ChangeSet.new
+      #   inst.add_change(:age, 40, 39)
+      #
+      #   inst.age_changed? # true
+      #
+      # @param name [String,Symbol] The name of the value that has changed
+      # @param current_value [anything] The current value
+      # @param previous_value [anything] (optional) The previous value,
+      #   the default is nil
+      #
+      # @return [Change] Returns the generated change
+      def add_change(name, current_value, previous_value = nil)
+        sym = name.to_sym
+        @changes[sym] =
+          Change.new(sym, current_value, previous_value)
+        @changes[sym]
+      end
+
+      #
+      # Removes an existing change by the name of the change. This method
+      # is safe to call if a change is not found.
+      #
+      #   inst = Pedanco::Diffr::ChangeSet.new
+      #   inst.add_change(:age, 40, 39)
+      #   inst.age_changed? # true
+      #
+      #   inst.remove_change(:age) # true
+      #
+      # @param name [String,Symbol] The name of the change to remove.
+      #
+      # @return [Change] The removed change,
+      #   nil if no change by that name was found
+      def remove_change(name)
+        @changes.delete(name.to_sym)
+      end
+
+      #
+      # Determines if the provided change(s) exist in the change set.
+      # When the match type is set to `:any`, if any key matches at least
+      # one change the method returns false.
+      #
+      #   inst = Pedanco::Diffr::ChangeSet.new
+      #   inst.add_change(:age, 40, 39)
+      #   inst.add_change(:name, 'George', 'Frank')
+      #
+      #   inst.changed?([:foo, :age]) # true
+      #
+      # If the match type is :all, all matches must exist.
+      #
+      #   inst = Pedanco::Diffr::ChangeSet.new
+      #   inst.add_change(:age, 40, 39)
+      #   inst.add_change(:name, 'George', 'Frank')
+      #
+      #   inst.changed?([:foo, :age], :all) # false
+      #
+      # @param keys [String,Symbol,Array] Defines a single or list
+      #   of names to validate existence of.
+      # @param match_type [Symbol] (optional) Defines how a check is
+      #   made, default is :any also accepts :all
+      #
+      # @return [Boolean] True if matches found, false if not.
+      def changed?(keys, match_type = :any)
+        keys = Array.wrap(keys).map(&:to_sym)
+        if match_type == :all
+          (keys & @changes.keys).length == keys.length
+        else
+          (keys & @changes.keys).present?
+        end
+      end
+
+      #
+      # Looks up a change by name and returns it if found. If the
+      # change is not found an empty Change instance is returned. This
+      # prevents having to check for nil.
+      #
+      #   inst = Pedanco::Diffr::ChangeSet.new
+      #   inst.add_change(:age, 40, 39)
+      #
+      #   # returns Pedanco::Diffr::Change(:age, current: 40, previous: 39)
+      #   inst.get_change(:age)
+      #
+      # @param name [String,Symbol] The name of the change to lookup.
+      #
+      # @return [Change] The Change object by name,
+      #   an empty change is returned if not found.
+      def get_change(name)
+        @changes.fetch(name.to_sym, Change.new(name.to_sym))
+      end
+
+      #
+      # Finds and returns a ChangeSet as an array, used for legacy rendering
+      # that expects changes to be in [current, previous] format.
+      #
+      # @param name [String,Symbol] (optional) The name of the change
+      #
+      # @return [Array] The Change as an array or empty if no change is found.
+      def to_a(name = nil)
+        if name.present?
+          change = @changes[name.to_sym]
+          change.present? ? change.to_a : []
+        else
+          @changes.map { |k, v| [k, v.to_a] }
+        end
+      end
+
+      #
+      # Converts the Change Set into an Hash.
+      #
+      #   {
+      #     name: [current, previous]
+      #   }
+      #
+      #
+      # @return [Hash] The Change Set as an hash.
+      def to_hash
+        Hash[@changes.map { |k, v| [k, v.to_a] }]
+      end
+
+      #
+      # Parses the ActiveModel::Dirty syntax to build a changeset.
+      # The Dirty syntax is:
+      #
+      #   { 'property_name' => [old_value, new_value] }
+      #
+      # @param changes [Hash] An ActiveModel::Dirty changes hash
+      #
+      def parse_changes(changes)
+        changes.each { |name, change| add_change(name, change[1], change[0]) }
+      end
+
+      private
+
+      def parse_change_hash(hash)
+        hash_array = hash.map do |k, v|
+          name  = k.to_sym
+          value = Array.wrap(v)
+          [name, Change.new(name, value[0], value[1])]
+        end
+        Hash[hash_array]
+      end
+    end
+  end
+end

data/lib/pedanco/diffr/version.rb

@@ -0,0 +1,5 @@
+module Pedanco
+  module Diffr
+    VERSION = '1.0.0'
+  end
+end

data/pedanco-diffr.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pedanco/diffr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pedanco-diffr'
+  spec.version       = Pedanco::Diffr::VERSION
+  spec.authors       = ['James Polanco']
+  spec.email         = ['james@developmentarc.com']
+  spec.summary       = 'Provides a change library for managing system changes.'
+  spec.description   = <<-EOM
+    Pedanco::Diffr provides a change set management system for tracking changes
+    anywhere in the system. Diffr works with both ActiveRecord style changes and
+    provides a custom system so that it kind be used in a wider syntax without
+    requiring ActiveRecord or ActiveModel.
+  EOM
+
+  spec.homepage      = 'https://github.com/DevelopmentArc/pedanco-diffr'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = `git ls-files test`.split("\x0")
+  spec.require_path  = 'lib'
+
+  ### Gem Dependencies
+  spec.add_runtime_dependency 'activesupport', '<= 4.2', '>= 3.2'
+
+  ### Development Dependencies
+  spec.add_development_dependency 'bundler',  '~> 1.7'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rspec',    '~> 3.2'
+end

data/spec/lib/pedanco/diffr/change_set_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe Pedanco::Diffr::ChangeSet do
+
+  let(:change_set) { Pedanco::Diffr::ChangeSet.new }
+
+  describe '#initialize' do
+    it 'parses change hash' do
+      set = described_class.new(foo: %w(bar baz), biff: [nil, 'hello'])
+      expect(set.changed?([:foo, 'biff'])).to be_truthy
+      expect(set.get_change(:foo).current).to eq 'bar'
+    end
+  end
+
+  describe '#method_missing' do
+    it 'returns true for _changed? postfix' do
+      change_set.add_change(:name, nil, 'bar')
+      expect(change_set.name_changed?).to eq true
+    end
+
+    it 'calls super for non-matched calls' do
+      expect { change_set.foobar }.to raise_error
+    end
+  end
+
+  describe '#respond_to?' do
+    it 'returns true for _changed? postfix' do
+      expect(change_set.respond_to?(:name_changed?)).to eq true
+    end
+
+    it 'calls super for non-matched calls' do
+      expect(change_set.respond_to?(:foobar)).to eq false
+    end
+  end
+
+  describe '#add_change' do
+    it 'adds a new change' do
+      change_set.add_change(:name, 'foo', 'bar')
+      expect(change_set.get_change(:name)).to_not be_nil
+      expect(change_set.get_change(:name).current).to eq 'foo'
+      expect(change_set.get_change(:name).previous).to eq 'bar'
+    end
+
+    it 'allows nil for current' do
+      change_set.add_change(:name, nil, 'bar')
+      expect(change_set.get_change(:name)).to_not be_nil
+    end
+
+    it 'allows nil for previous' do
+      change_set.add_change(:name, 'foo', nil)
+      expect(change_set.get_change(:name)).to_not be_nil
+    end
+
+    it 'defaults previous to nil' do
+      change_set.add_change(:name, 'foo')
+      expect(change_set.get_change(:name)).to_not be_nil
+    end
+
+    it 'requires a name' do
+      expect do
+        change_set.add_change(nil, 'foo', 'bar')
+      end.to raise_error
+    end
+
+    it 'requires current as an argument' do
+      expect do
+        change_set.add_change(:name)
+      end.to raise_error
+    end
+
+    it 'overrides a change' do
+      change_set.add_change(:name, 'foo', 'bar')
+      change_set.add_change(:name, 'bar', 'baz')
+      expect(change_set.get_change(:name).current).to eq 'bar'
+    end
+  end
+
+  describe '#remove_change' do
+    before(:each) { change_set.add_change(:name, 'foo') }
+
+    it 'deletes an existing change' do
+      change_set.remove_change(:name)
+      expect(change_set.changed?(:name)).to be_falsey
+    end
+
+    it 'returns truthy when removing an existing change' do
+      expect(change_set.remove_change(:name)).to be_truthy
+    end
+
+    it 'returns falsey when removing an non-existing change' do
+      expect(change_set.remove_change(:foo)).to be_falsey
+    end
+  end
+
+  describe '#changed?' do
+    before(:each) do
+      change_set.add_change(:name, 'foo')
+      change_set.add_change(:age, 12)
+      change_set.add_change(:email, 'bar@biz.com')
+    end
+
+    it 'finds a single change' do
+      expect(change_set.changed?(:name)).to eq true
+    end
+
+    it 'matches mutliple changes' do
+      expect(change_set.changed?([:name, :age])).to eq true
+    end
+
+    it 'requires one change to match' do
+      expect(change_set.changed?([:age, :phone])).to eq true
+    end
+
+    it 'requires all changes to match' do
+      expect(change_set.changed?([:name, :age, :phone], :all)).to eq false
+    end
+  end
+
+  describe '#get_change' do
+    before(:each) { change_set.add_change(:name, 'foo') }
+
+    it 'returns the change when found' do
+      expect(change_set.get_change(:name).current).to eq 'foo'
+    end
+
+    it 'returns the Diffr::Change object' do
+      expect(change_set.get_change(:name)).to be_instance_of(Pedanco::Diffr::Change)
+    end
+
+    it 'returns empty Diffr::Change if not found' do
+      expect(change_set.get_change(:foo).current).to be_nil
+      expect(change_set.get_change(:foo).previous).to be_nil
+    end
+  end
+
+  describe '_changed? matchers' do
+    before(:each) { change_set.add_change(:name, 'foo') }
+
+    it 'returns true for changes that match' do
+      expect(change_set.name_changed?).to be_truthy
+    end
+
+    it 'returns false for changes that do not exists' do
+      expect(change_set.foo_changed?).to be_falsey
+    end
+  end
+
+  describe '#to_a' do
+    before(:each) do
+      change_set.add_change(:name, 'foo')
+      change_set.add_change(:age, 33, 32)
+    end
+
+    it 'returns the change when found' do
+      expect(change_set.to_a(:name)).to eq [nil, 'foo']
+    end
+
+    it 'returns nil if not found' do
+      expect(change_set.to_a(:foo)).to eq []
+    end
+
+    it 'maps out all the changes with no arguments' do
+      expect(change_set.to_a).to eq [[:name, [nil, "foo"]], [:age, [32, 33]]]
+    end
+  end
+
+  describe '#to_hash' do
+    before(:each) { change_set.add_change(:name, 'foo') }
+
+    it 'returns the change when found' do
+      expect(change_set.to_hash).to include(name: [nil, 'foo'])
+    end
+
+  end
+
+  describe '#parse_changes' do
+    before(:each) { change_set.parse_changes('foo' => %w(baz bar), 'biff' => [10, 1]) }
+
+    it 'extracts the changes' do
+      expect(change_set.get_change(:foo).current).to eq 'bar'
+      expect(change_set.get_change('biff').previous).to eq 10
+    end
+  end
+end

data/spec/lib/pedanco/diffr/change_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Pedanco::Diffr::Change do
+  context '#initialize' do
+    it 'requires a name' do
+      expect { Pedanco::Diffr::Change.new }.to raise_error
+    end
+
+    context 'default values' do
+      subject { Pedanco::Diffr::Change.new(:foo) }
+
+      it 'defaults current to nil' do
+        expect(subject.current).to be_nil
+      end
+
+      it 'defaults previous to nil' do
+        expect(subject.previous).to be_nil
+      end
+    end
+
+    context 'passing values' do
+      subject { Pedanco::Diffr::Change.new(:bar, 'baz', 'biff') }
+
+      it 'sets the name' do
+        expect(subject.name).to eq :bar
+      end
+
+      it 'sets the current' do
+        expect(subject.current).to eq 'baz'
+      end
+
+      it 'sets the previous' do
+        expect(subject.previous).to eq 'biff'
+      end
+    end
+  end
+
+  context '#to_a' do
+    subject { Pedanco::Diffr::Change.new(:bar, 'baz', 'biff') }
+
+    it 'orders the array correctly' do
+      expect(subject.to_a).to eq %w(biff baz)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'pedanco/diffr' # and any other gems you need
+
+RSpec.configure do |_config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: pedanco-diffr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Polanco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+      Pedanco::Diffr provides a change set management system for tracking changes
+      anywhere in the system. Diffr works with both ActiveRecord style changes and
+      provides a custom system so that it kind be used in a wider syntax without
+      requiring ActiveRecord or ActiveModel.
+email:
+- james@developmentarc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pedanco/diffr.rb
+- lib/pedanco/diffr/change.rb
+- lib/pedanco/diffr/change_set.rb
+- lib/pedanco/diffr/version.rb
+- pedanco-diffr.gemspec
+- spec/lib/pedanco/diffr/change_set_spec.rb
+- spec/lib/pedanco/diffr/change_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DevelopmentArc/pedanco-diffr
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Provides a change library for managing system changes.
+test_files: []