wiser_trails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2E1MmRmZmNmYjVmZWU1MWY4MjNlNWI3MzlkOTk0MjcxYTFhNWZiZA==
+    MzZmZDkyMjc4NDdhYTJiMzMxY2IzOTliMDZjZTk1NzhjMTExODlkNA==
   data.tar.gz: !binary |-
-    MGVjZTU3ZWYxNTk3NjE2ODFiMzFkNDgxYjBmYjA2NmM4NGNkYTZmNw==
+    YjU2NTAwZGIwOGIzOGIxYWY0MzIyMDJlNzE2YWNjOWQ4Nzc1NmQ1OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZThiNWU0MGI3OGQ1NTM3M2JiYTk0NWY5OTJlNWY4NzgzMDQyOGIwMjNlZmQx
-    MmM4OTMxZGMwMzJkZTE5YWM0OTE4MWY0Njc2YjA1NjBkMzk2MDg1ZGYzZDZk
-    NWIyZTJhMmVhYWVkMGQ0YzZkMzMzZGM2Njk4YjJjZjFlNGVlZGM=
+    YWMyNzIxYzUyODRlYzY2NGRlYWM0ZDk5MjdmNTc0NTY5NWFhMDAxMThhOGJi
+    Y2QwM2E4NmFiMDEyNjhkYmM3OGE3M2RmNTc5MTA0YjZkNGVjZjY3NTFjODQ2
+    NDgxZmUyNTY1YjIwYzQzNjdkNjRiYTEyNWY2ODA2MWM4OTI4ZDM=
   data.tar.gz: !binary |-
-    ZGFjMTE4OTVhZTQ5ZTY3YTI4OWE1ZDQ5ZWJmOWJkN2I2ZDg3ZTU3ZDNjMjQ2
-    ZjIxMmQwN2FhNDBkMDhhNzFiYmU3MDI3NTg5MWIwYWIxNTViZDhkNGQ5ZTUy
-    ZGE5ODhkMmIxYTdiNWVmMjBlZTI0YjNmYTcyNmMwNWU0NjI1MjA=
+    MDYxMzgyNzg2ZDk1NDUzNThiZjE4NWUwOTBmNGFmNzdhYzkzNTVlNGY1N2I3
+    YjM0YmJmYjRiNTUwM2FiYzE3NjY5MGMxY2E5ZmIzODYyMmJiYzk5M2RhYmEw
+    ODQxODkxMDc0ZDRlYjY3NzlhMmVmZTNiZGU1ZGU4ZTFkMWY5Yjg=

data/README.md

@@ -17,7 +17,7 @@ You can do normal gem installation for `wiser_trails`:
 or in your Gemfile:
 
 ```ruby
-gem 'wiser_trails', ~> '2.0.0'
+gem 'wiser_trails', '~> 2.0.0'
 ```
 
 Then restart your application.
@@ -65,8 +65,8 @@ Or even the `account` if you're having a multi-account structure:
 class Notes < ActiveRecord::Base
   include WiserTrails::Model
   trail_it
-    owner: ->(controller, model) { controller && controller.current\_user },
-    account: ->(controller, model) { controller && controller.current\_account }
+    owner: ->(controller, model) { controller && controller.current_user },
+    account: ->(controller, model) { controller && controller.current_account }
 end
 ```
 

data/lib/wiser_trails/actions/update.rb

@@ -10,13 +10,22 @@ module WiserTrails
     private
       # Creates activity upon modification of the tracked model
       def initialize_activity
-        create_activity(:update) if self.changed_attributes.except("updated_at").count > 0
+        changed_attrs = strip_changed_attributes
+        create_activity(:update) if changed_attrs.count > 0
       end
       def activity_on_update
-        if self.changed_attributes.except("updated_at").count > 0
+        changed_attrs = strip_changed_attributes
+        if changed_attrs.count > 0
           activity = Activity.where(trackable_id: self.id, trackable_type: self.class, key: "#{self.class.to_s.downcase}.update").last
           activity.update_attribute(:new_value, activity.trackable.attributes.stringify_keys) if activity
         end
       end
+      def strip_changed_attributes
+        changed_attributes = self.changed_attributes
+        self.activity_skip_fields_global.each do |attr|
+          changed_attributes = changed_attributes.except(attr)
+        end
+        return changed_attributes
+      end
   end
 end

data/lib/wiser_trails/common.rb

@@ -23,8 +23,9 @@ module WiserTrails
 
     included do
       include Trackable
-      class_attribute :activity_owner_global, :activity_account_global,
-                      :activity_new_value_global, :activity_hooks, :activity_custom_fields_global
+      class_attribute :activity_owner_global, :activity_account_global, :activity_skip_fields_global,
+                      :activity_new_value_global, :activity_hooks, :activity_custom_fields_global,
+                      :activity_force_fields_global
       set_wiser_trails_class_defaults
     end
 
@@ -71,49 +72,18 @@ module WiserTrails
     # @return [Hash<Symbol, Object>]
     attr_accessor :activity_new_value
     @activity_new_value = {}
-    # Set or get owner object responsible for the {Activity}.
-    #
-    # == Usage:
-    #
-    #   # where current_user is an object of logged in user
-    #   @article.activity_owner = current_user
-    #   # OR: take @article.author association
-    #   @article.activity_owner = :author
-    #   # OR: provide a Proc with custom code
-    #   @article.activity_owner = proc {|controller, model| model.author }
-    #   @article.save
-    #   @article.activities.last.owner #=> Returns owner object
-    # @return [Model] Polymorphic model
-    # @see #activity_owner_global
     attr_accessor :activity_owner
     @activity_owner = nil
-
-    # Set or get recipient for activity.
-    #
-    # Association is polymorphic, thus allowing assignment of
-    # all types of models. This can be used for example in the case of sending
-    # private notifications for only a single user.
-    # @return (see #activity_owner)
     attr_accessor :activity_account
     @activity_account = nil
-    # Set or get custom i18n key passed to {Activity}, later used in {Renderable#text}
-    #
-    # == Usage:
-    #
-    #   @article = Article.new
-    #   @article.activity_key = "my.custom.article.key"
-    #   @article.save
-    #   @article.activities.last.key #=> "my.custom.article.key"
-    #
-    # @return [String]
     attr_accessor :activity_key
     @activity_key = nil
-
-    # Set or get custom fields for later processing
-    #
-    # @return [Hash]
     attr_accessor :activity_custom_fields
     @activity_custom_fields = {}
+    attr_accessor :activity_skip_fields_global
+    @activity_skip_fields_global = {}
+    attr_accessor :activity_force_fields_global
+    @activity_force_fields_global = {}
 
     # @!visibility private
     @@activity_hooks = {}
@@ -131,18 +101,10 @@ module WiserTrails
         self.activity_new_value_global         = {}
         self.activity_hooks                    = {}
         self.activity_custom_fields_global     = {}
+        self.activity_skip_fields_global       = {}
+        self.activity_force_fields_global      = {}
       end
 
-      # Extracts a hook from the _:on_ option provided in
-      # {Tracked::ClassMethods#tracked}. Returns nil when no hook exists for
-      # given action
-      # {Common#get_hook}
-      #
-      # @see Tracked#get_hook
-      # @param key [String, Symbol] action to retrieve a hook for
-      # @return [Proc, nil] callable hook or nil
-      # @since 0.4.0
-      # @api private
       def get_hook(key)
         key = key.to_sym
         if self.activity_hooks.has_key?(key) and self.activity_hooks[key].is_a? Proc
@@ -335,6 +297,8 @@ module WiserTrails
       @activity_owner = nil
       @activity_account = nil
       @activity_custom_fields = {}
+      @activity_skip_fields_global = {}
+      @activity_force_fields_global = {}
     end
   end
 end

data/lib/wiser_trails/renderable.rb

@@ -7,10 +7,10 @@ module WiserTrails
     def text(params = {})
       # TODO: some helper for key transformation for two supported formats
       k = key.split('.')
-      k.unshift('activity') if k.first != 'activity'
+      k.unshift('wiser_trails') if k.first != 'wiser_trails'
       k = k.join('.')
 
-      I18n.t(k, parameters.merge(params) || {})
+      I18n.t(k, params || {})
     end
 
     # Renders activity from views.
@@ -91,15 +91,14 @@ module WiserTrails
 
       locals = params.delete(:locals) || Hash.new
 
-      params_indifferent = self.parameters.with_indifferent_access
+      params_indifferent = self.new_value.with_indifferent_access
       params_indifferent.merge!(params)
 
       context.render params.merge(:partial => (partial_path || self.template_path(self.key)),
         :layout => layout,
         :locals => locals.merge(:a => self, :activity => self,
            :controller => controller,
-           :current_user => controller.respond_to?(:current_user) ?
-                controller.current_user : nil ,
+           :current_user => controller.respond_to?(:current_user) ? controller.current_user : nil,
            :p => params_indifferent, :params => params_indifferent))
     end
 

data/lib/wiser_trails/roles/trail_it.rb

@@ -2,31 +2,7 @@ module WiserTrails
   # Main module extending classes we want to keep track of.
   module TrailIt
     extend ActiveSupport::Concern
-    # A shortcut method for setting custom key, owner and parameters of {Activity}
-    # in one line. Accepts a hash with 3 keys:
-    # :key, :owner, :params. You can specify all of them or just the ones you want to overwrite.
-    #
-    # == Options
-    #
-    # [:key]
-    #   See {Common#activity_key}
-    # [:owner]
-    #   See {Common#activity_owner}
-    # [:params]
-    #   See {Common#activity_new_value}
-    # [:recipient]
-    #   Set the recipient for this activity. Useful for private notifications, which should only be visible to a certain user. See {Common#activity_account}.
-    # @example
-    #
-    #   @article = Article.new
-    #   @article.title = "New article"
-    #   @article.activity :key => "my.custom.article.key", :owner => @article.author, :params => {:title => @article.title}
-    #   @article.save
-    #   @article.activities.last.key #=> "my.custom.article.key"
-    #   @article.activities.last.parameters #=> {:title => "New article"}
-    #
-    # @param options [Hash] instance options to set on the tracked model
-    # @return [nil]
+
     def activity(options = {})
       rest = options.clone
       self.activity_key = rest.delete(:key) if rest[:key]
@@ -39,102 +15,21 @@ module WiserTrails
 
     # Module with basic +tracked+ method that enables tracking models.
     module ClassMethods
-      # Adds required callbacks for creating and updating
-      # tracked models and adds +activities+ relation for listing
-      # associated activities.
-      #
-      # == Parameters:
-      # [:owner]
-      #   Specify the owner of the {Activity} (person responsible for the action).
-      #   It can be a Proc, Symbol or an ActiveRecord object:
-      #   == Examples:
-      #
-      #    tracked :owner => :author
-      #    tracked :owner => proc {|o| o.author}
-      #
-      #   Keep in mind that owner relation is polymorphic, so you can't just
-      #   provide id number of the owner object.
-      # [:recipient]
-      #   Specify the recipient of the {Activity}
-      #   It can be a Proc, Symbol, or an ActiveRecord object
-      #   == Examples:
-      #
-      #    tracked :recipient => :author
-      #    tracked :recipient => proc {|o| o.author}
-      #
-      #   Keep in mind that recipient relation is polymorphic, so you can't just
-      #   provide id number of the owner object.
-      # [:params]
-      #   Accepts a Hash with custom parameters you want to pass to i18n.translate
-      #   method. It is later used in {Renderable#text} method.
-      #   == Example:
-      #    class Article < ActiveRecord::Base
-      #      include WiserTrails::Model
-      #      tracked :params => {
-      #          :title => :title,
-      #          :author_name => "Michael",
-      #          :category_name => proc {|controller, model_instance| model_instance.category.name},
-      #          :summary => proc {|controller, model_instance| truncate(model.text, :length => 30)}
-      #      }
-      #    end
-      #
-      #   Values in the :params hash can either be an *exact* *value*, a *Proc/Lambda* executed before saving the activity or a *Symbol*
-      #   which is a an attribute or a method name executed on the tracked model's instance.
-      #
-      #   Everything specified here has a lower priority than parameters
-      #   specified directly in {#activity} method.
-      #   So treat it as a place where you provide 'default' values or where you
-      #   specify what data should be gathered for every activity.
-      #   For more dynamic settings refer to {Activity} model documentation.
-      # [:skip_defaults]
-      #   Disables recording of activities on create/update/destroy leaving that to programmer's choice. Check {WiserTrails::Common#create_activity}
-      #   for a guide on how to manually record activities.
-      # [:only]
-      #   Accepts a symbol or an array of symbols, of which any combination of the three is accepted:
-      #   * _:create_
-      #   * _:update_
-      #   * _:destroy_
-      #   Selecting one or more of these will make WiserTrails create activities
-      #   automatically for the tracked model on selected actions.
-      #
-      #   Resulting activities will have have keys assigned to, respectively:
-      #   * _article.create_
-      #   * _article.update_
-      #   * _article.destroy_
-      #   Since only three options are valid,
-      #   see _:except_ option for a shorter version
-      # [:except]
-      #   Accepts a symbol or an array of symbols with values like in _:only_, above.
-      #   Values provided will be subtracted from all default actions:
-      #   (create, update, destroy).
-      #
-      #   So, passing _create_ would track and automatically create
-      #   activities on _update_ and _destroy_ actions,
-      #   but not on the _create_ action.
-      # [:on]
-      #   Accepts a Hash with key being the *action* on which to execute *value* (proc)
-      #   Currently supported only for CRUD actions which are enabled in _:only_
-      #   or _:except_ options on this method.
-      #
-      #   Key-value pairs in this option define callbacks that can decide
-      #   whether to create an activity or not. Procs have two attributes for
-      #   use: _model_ and _controller_. If the proc returns true, the activity
-      #   will be created, if not, then activity will not be saved.
-      #
-      #   == Example:
-      #     # app/models/article.rb
-      #     tracked :on => {:update => proc {|model, controller| model.published? }}
-      #
-      #   In the example above, given a model Article with boolean column _published_.
-      #   The activities with key _article.update_ will only be created
-      #   if the published status is set to true on that article.
-      # @param opts [Hash] options
-      # @return [nil] options
       def trail_it(opts = {})
         options = opts.clone
-
         all_options = [:create, :update, :destroy]
 
+        self.activity_skip_fields_global = ["updated_at", "created_at"]
+        if options[:skip_fields].present?
+          self.activity_skip_fields_global += options[:skip_fields]
+        end
+        options.delete(:skip_fields)
+
+        if options[:force_fields].present?
+          self.activity_force_fields_global = options[:skip_fields]
+        end
+        options.delete(:skip_fields)
+
         if !options.has_key?(:skip_defaults) && !options[:only] && !options[:except]
           include Creation
           include Destruction

data/lib/wiser_trails/version.rb

@@ -1,3 +1,3 @@
 module WiserTrails
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wiser_trails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kenneth John Balgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler