Merge pull request #65 from dashofcode/dirty_tracking

Dirty tracking

.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

README.md

@@ -53,7 +53,7 @@ story.activity                                                            # Get
 
 story.name = 'Save the Ewoks'                                             # Update a single story attribute
 story.attributes = { name: 'Save the Ewoks', description: '...' }         # Update multiple story attributes
-story.labels << TrackerApi::Resources::Label.new(name: 'Endor')           # Add a new label to an existing story
+story.add_label('Endor')                                                  # Add a new label to an existing story
 story.save                                                                # Save changes made to a story
 
 story = TrackerApi::Resources::Story.new( client:     client,

lib/tracker_api.rb

@@ -1,17 +1,18 @@
 require 'tracker_api/version'
 
 # dependencies
-require 'virtus'
 require 'faraday'
 require 'faraday_middleware'
+
 if defined?(ActiveSupport)
   require 'active_support/core_ext/object/blank'
 else
   require 'core_ext/object/blank'
 end
 require 'equalizer'
-require 'representable/json'
+
 require 'multi_json'
+require 'representable/json'
 
 # stdlib
 require 'addressable/uri'
@@ -51,7 +52,8 @@ module Endpoints
 
   module Resources
     module Shared
-      autoload :HasId, 'tracker_api/resources/shared/has_id'
+      autoload :Base, 'tracker_api/resources/shared/base'
+      autoload :Collection, 'tracker_api/resources/shared/collection'
     end
     autoload :Activity, 'tracker_api/resources/activity'
     autoload :Account, 'tracker_api/resources/account'

lib/tracker_api/endpoints/epic.rb

@@ -31,6 +31,8 @@ def update(epic, params={})
         data = client.put("/projects/#{epic.project_id}/epics/#{epic.id}", params: params).body
 
         epic.attributes = data
+        epic.clean!
+        epic
       end
     end
   end

lib/tracker_api/endpoints/story.rb

@@ -31,6 +31,8 @@ def update(story, params={})
         data = client.put("/projects/#{story.project_id}/stories/#{story.id}", params: params).body
 
         story.attributes = data
+        story.clean!
+        story
       end
     end
   end

lib/tracker_api/resources/account.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Account
-      include Shared::HasId
+      include Shared::Base
 
       attribute :created_at, DateTime
       attribute :status, String

lib/tracker_api/resources/activity.rb

@@ -11,8 +11,8 @@ class Activity
       attribute :project_version, Integer
       attribute :message, String
       attribute :highlight, String
-      attribute :changes, Array[Change]
-      attribute :primary_resources, Array[PrimaryResource]
+      attribute :changes, Shared::Collection[Change]
+      attribute :primary_resources, Shared::Collection[PrimaryResource]
       attribute :project, Project
       attribute :performed_by, Person
       attribute :occurred_at, DateTime

lib/tracker_api/resources/change.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Change
-      include Shared::HasId
+      include Shared::Base
 
       attribute :change_type, String
       attribute :kind, String

lib/tracker_api/resources/comment.rb

@@ -1,19 +1,19 @@
 module TrackerApi
   module Resources
     class Comment
-      include Shared::HasId
+      include Shared::Base
 
       attribute :story_id, Integer
       attribute :epic_id, Integer
       attribute :text, String
       attribute :person_id, Integer
       attribute :created_at, DateTime
       attribute :updated_at, DateTime
-      attribute :file_attachment_ids, Array[Integer]
-      attribute :google_attachment_ids, Array[Integer]
+      attribute :file_attachment_ids, Shared::Collection[Integer]
+      attribute :google_attachment_ids, Shared::Collection[Integer]
       attribute :commit_identifier, String
       attribute :commit_type, String
       attribute :kind, String
     end
   end
-end
+end

lib/tracker_api/resources/epic.rb

@@ -1,16 +1,16 @@
 module TrackerApi
   module Resources
     class Epic
-      include Shared::HasId
+      include Shared::Base
 
       attribute :client
 
-      attribute :comment_ids, Array[Integer]
-      attribute :comments, Array[Comment]
+      attribute :comment_ids, Shared::Collection[Integer]
+      attribute :comments, Shared::Collection[Comment]
       attribute :created_at, DateTime
       attribute :description, String
-      attribute :follower_ids, Array[Integer]
-      attribute :followers, Array[Person]
+      attribute :follower_ids, Shared::Collection[Integer]
+      attribute :followers, Shared::Collection[Person]
       attribute :kind, String
       attribute :label, Label
       attribute :label_id, Integer

lib/tracker_api/resources/iteration.rb

@@ -13,8 +13,8 @@ class Iteration
       attribute :planned, Boolean
       attribute :project_id, Integer
       attribute :start, DateTime
-      attribute :stories, [Story]
-      attribute :story_ids, [Integer]
+      attribute :stories, Shared::Collection[Story]
+      attribute :story_ids, Shared::Collection[Integer]
       attribute :team_strength, Float
 
       def stories=(data)

lib/tracker_api/resources/label.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Label
-      include Shared::HasId
+      include Shared::Base
 
       attribute :created_at, DateTime
       attribute :kind, String

lib/tracker_api/resources/me.rb

@@ -1,17 +1,17 @@
 module TrackerApi
   module Resources
     class Me
-      include Shared::HasId
+      include Shared::Base
 
       attribute :name, String
       attribute :initials, String
       attribute :username, String
       attribute :time_zone, TimeZone
       attribute :api_token, String
       attribute :has_google_identity, Boolean
-      attribute :project_ids, Array[Integer]
-      attribute :projects, [MembershipSummary]
-      attribute :workspace_ids, Array[Integer]
+      attribute :project_ids, Shared::Collection[Integer]
+      attribute :projects, Shared::Collection[MembershipSummary]
+      attribute :workspace_ids, Shared::Collection[Integer]
       attribute :email, String
       attribute :receives_in_app_notifications, Boolean
       attribute :kind, String

lib/tracker_api/resources/membership_summary.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class MembershipSummary
-      include Shared::HasId
+      include Shared::Base
 
       attribute :kind, String
       attribute :last_viewed_at, DateTime

lib/tracker_api/resources/notification.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Notification
-      include Shared::HasId
+      include Shared::Base
 
       attribute :client
 

lib/tracker_api/resources/person.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Person
-      include Shared::HasId
+      include Shared::Base
 
       attribute :kind, String
       attribute :name, String

lib/tracker_api/resources/primary_resource.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class PrimaryResource
-      include Shared::HasId
+      include Shared::Base
 
       attribute :kind, String
       attribute :name, String

lib/tracker_api/resources/project.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class Project
-      include Shared::HasId
+      include Shared::Base
 
       attribute :client
 
@@ -17,14 +17,14 @@ class Project
       attribute :enable_incoming_emails, Boolean
       attribute :enable_planned_mode, Boolean
       attribute :enable_tasks, Boolean
-      attribute :epic_ids, Array[Integer]
-      attribute :epics, Array[Epic]
+      attribute :epic_ids, Shared::Collection[Integer]
+      attribute :epics, Shared::Collection[Epic]
       attribute :has_google_domain, Boolean
       attribute :initial_velocity, Integer
       attribute :iteration_length, Integer
       attribute :kind, String
-      attribute :label_ids, Array[Integer]
-      attribute :labels, Array[Label]
+      attribute :label_ids, Shared::Collection[Integer]
+      attribute :labels, Shared::Collection[Label]
       attribute :name, String
       attribute :number_of_done_iterations_to_show, Integer
       attribute :point_scale, String
@@ -54,7 +54,7 @@ def label_ids
       # @param [Hash] params
       # @return [Array[Label]] labels of this project
       def labels(params = {})
-        if @labels && @labels.any?
+        if @labels && @labels.present?
           @labels
         else
           @labels = Endpoints::Labels.new(client).get(id, params)
@@ -66,10 +66,11 @@ def labels(params = {})
       # @param [Hash] params
       # @return [Array[Epic]] epics associated with this project
       def epics(params={})
-        raise ArgumentError, 'Expected @epics to be an Array' unless @epics.is_a? Array
-        return @epics unless @epics.empty?
-
-        @epics = Endpoints::Epics.new(client).get(id, params)
+        if @epics && @epics.present?
+          @epics
+        else
+          @epics = Endpoints::Epics.new(client).get(id, params)
+        end
       end
 
       # Provides a list of all the iterations in the project.

lib/tracker_api/resources/project_membership.rb

@@ -1,7 +1,7 @@
 module TrackerApi
   module Resources
     class ProjectMembership
-      include Shared::HasId
+      include Shared::Base
 
       attribute :person_id, Integer
       attribute :project_id, Integer

lib/tracker_api/resources/shared/base.rb

@@ -0,0 +1,30 @@
+require 'virtus'
+if Virtus::Attribute::NullifyBlank.method_defined?(:coerce)
+  require 'virtus/attribute/nullify_blank'
+else
+  raise """
+  WARNING: The above monkey patch can't be applied as expected.
+  See discussion here: https://github.com/dashofcode/tracker_api/commit/27599e7e2169776c32bbff8c972a31b930452879
+  """
+end
+require 'virtus/dirty_attribute'
+
+module TrackerApi
+  module Resources
+    module Shared
+      module Base
+        def self.included(base)
+          base.class_eval do
+            include Virtus.model(nullify_blank: true)
+            include Virtus::DirtyAttribute
+            include Virtus::DirtyAttribute::InitiallyClean
+
+            include Equalizer.new(:id)
+
+            attribute :id, Integer
+          end
+        end
+      end
+    end
+  end
+end

lib/tracker_api/resources/shared/collection.rb

@@ -0,0 +1,17 @@
+module TrackerApi
+  module Resources
+    module Shared
+      class Collection < Array
+        def <<(item)
+          warn """
+            WARNING: Direct mutation of an attribute value skips coercion
+            and dirty tracking. Please use direct assignment or the
+            specialized add_* methods to get expected behavior.
+            https://github.com/solnic/virtus#important-note-about-member-coercions
+            """
+          super
+        end
+      end
+    end
+  end
+end