pedanco-diffr 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab7434a821dc08fd4cbaf49a4b1802182b755bed
-  data.tar.gz: 06219e44cfbf45f8ff8a867a2058ff8db8dc5e78
+  metadata.gz: afebc269b72459f2a062b9ceac8fd1af0d0c7421
+  data.tar.gz: 6037b5ccddbc9818b539be90e5e5c658f1d8e2de
 SHA512:
-  metadata.gz: c54abecceac0488bc88d4f1069bab65a62d4b20ecd55594e33ec0fbd8bc299941aac5a252c5ad22fc1ae4f9a4cc00f27846b1ae2eea8d9ff328c1b749af26087
-  data.tar.gz: 22b9b82fb4856c4957437ce5666494bec1f6f51de3e62b8f75ef21999e1e1343be8208fa0d3900ec5b221474c2ef668a51d56bf33a4cea8b3b0b521b062363d1
+  metadata.gz: ea63ca1610c1e5c10abe9c347292b3a63fa238496c2d7cc21306013ee1222941946bf9f2ce27fa7dc5dbbd58a2c5280c68d89d035d7755723fc05d37d49cd7c3
+  data.tar.gz: a89a35626a3511cd0f72cc4052ad9eb27ebec7e662d04cb233d2cb3a40722f4e077ab0f6aa51e441476394f60df7dac9a0cbf3a9ebc9f581c969410e26116fa8

data/CHANGELOG.md

@@ -1,7 +1,14 @@
+## 1.0.1 (2015-10-22)
+
+Authors: James Polanco
+
+### Fixes
+- Updated gemspec to properly support all versions of Rails 4.x
+
 ## 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
+- Initial release of Pedanco::Diffr
+- Some changes to API from internal version
+- Added documentation and code comments

data/README.md

@@ -1,5 +1,6 @@
 # pedanco-diffr
 
+[![Gem Version](https://badge.fury.io/rb/pedanco-diffr.svg)](http://badge.fury.io/rb/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)
@@ -24,12 +25,12 @@ gem 'pedanco-diffr'
 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.add_change(:age, 21, 23) # => Pedanco::Diffr::Change
 change_set.name_changed? # => true
-change_set.changed(:age) # => true
+change_set.changed?(:age) # => true
 
 # Remove a change and query the ChangeSet
-change_set.remove_change(:age) # => true
+change_set.remove_change(:age) # => Pedanco::Diffr::Change
 change_set.age_changed? # => false
 change_set.changed?(:age) # => false
 
@@ -43,6 +44,7 @@ name_change.previous # => 'Tom'
 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
+# Create the ChangeSet with Hash data
 data_set   = { city: ['San Diego', 'Denver'], state: ['CA', nil] }
 change_set = Pedanco::Diffr::ChangeSet.new(data_set)
 change_set.state_changed? #=> true
@@ -51,9 +53,10 @@ change_set.state_changed? #=> true
 You can also directly add changes using the `add_change` method.
 
 ```ruby
+# Create ChangeSet and add changes directly
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
-change_set.add_change(:state, 'CA')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
+change_set.add_change(:state, 'CA') # => Pedanco::Diffr::Change
 
 change_set.city_changed? #=> true
 change_set.state_changed? #=> true
@@ -67,13 +70,14 @@ change_set = Pedanco::Diffr::ChangeSet.new
 change_set.parse_changes(address.changes)
 ```
 
-# Quering the ChangeSet
+# Querying 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.
+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?` convenience 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
+# Create a new ChangeSet and add a change
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
 
 # Using _changed?
 change_set.city_changed? #=> true
@@ -87,8 +91,9 @@ 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
+# Create a new ChangeSet and add a change
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
 
 # Pass an Array of names to query
 change_set.changed?([:city, :address]) # => true
@@ -97,8 +102,9 @@ 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
+# Verify all changes exists in the ChangeSet
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
 change_set.changed?([:city, :address], :all) # => false
 ```
 
@@ -106,10 +112,12 @@ change_set.changed?([:city, :address], :all) # => false
 Once you have created a change set you can access the current and previous value of the change by calling `get_change`
 
 ```ruby
+# Build a ChangeSet
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
-change_set.add_change(:state, 'CA')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
+change_set.add_change(:state, 'CA') # => Pedanco::Diffr::Change
 
+# Extract the current and previous values for a change
 change_set.get_change(:city).current # => 'San Diego'
 change_set.get_change(:city).previous # => 'Denver'
 ```
@@ -117,21 +125,23 @@ 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
+# Requesting a non-existent change returns an empty Change
 change_set = Pedanco::Diffr::ChangeSet.new
-change = change_set.get_change(:age)
+change = change_set.get_change(:age) # => Pedanco::Diffr::Change
 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.
+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 default we convert the name to a `Symbol` for lookup purposes.
 
 ```ruby
+# Multiple ways to add a change
 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
+change_set.add_change(:money, nil, 'Something') # => Something 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`.
@@ -140,16 +150,17 @@ When calling `add_change` only a current value must be passed to the method (inc
 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
+# Create a ChangeSet with some changes
 change_set = Pedanco::Diffr::ChangeSet.new
-change_set.add_change(:city, 'San Diego', 'Denver')
-change_set.add_change(:state, 'CA')
+change_set.add_change(:city, 'San Diego', 'Denver') # => Pedanco::Diffr::Change
+change_set.add_change(:state, 'CA') # => Pedanco::Diffr::Change
 
 # overriding a change
-change_set.add_change(:state, 'CA', 'CO')
+change_set.add_change(:state, 'CA', 'CO') # => Pedanco::Diffr::Change
 change_set.get_change(:state).previous # => 'CO'
 
 # removing a change
-change_set.remove_change(:city)
+change_set.remove_change(:city) # => Pedanco::Diffr::Change
 change_set.city_changed? # => false
 ```
 
@@ -160,7 +171,7 @@ For example, when a user changes their Role or name, we need to run a lot of cac
 
 `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
+# License
 The MIT License (MIT)
 
 Copyright (c) 2015 DevelopmentArc

data/lib/pedanco/diffr/version.rb

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

data/pedanco-diffr.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_path  = 'lib'
 
   ### Gem Dependencies
-  spec.add_runtime_dependency 'activesupport', '<= 4.2', '>= 3.2'
+  spec.add_runtime_dependency 'activesupport', '< 5', '>= 3.2'
 
   ### Development Dependencies
   spec.add_development_dependency 'bundler',  '~> 1.7'

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: pedanco-diffr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - James Polanco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-10-22 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'
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
@@ -24,9 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'