secretary-rails 1.0.0 → 1.1.0

data/README.md

@@ -162,6 +162,8 @@ class ArticlesController < ApplicationControler
 end
 ```
 
+**Protip**: Using `outpost-secretary`? This is taken care of for you. Just be sure to add the `logged_user_id` to your Strong Parameters.
+
 ### Viewing Diffs
 The `Secretary::Version` model allows you to see unix-style diffs of the
 changes, using the [`diffy`](http://rubygems.org/gems/diffy) gem. The diffs
@@ -196,15 +198,7 @@ Diffy also provides several other output formats. See
 [diffy's README](https://github.com/samg/diffy/tree/master) for more options.
 
 ### Configuration
-In an initializer (may we suggest `secretary.rb`?), add:
-
-```ruby
-# This is a list of all the possible configurations and their defaults.
-Secretary.configure do |config|
-  config.user_class         = "::User"
-  config.ignored_attributes = ["id", "created_at", "updated_at"]
-end
-```
+The install task will create an initializer for you with the following options:
 
 * **user_class** - The class for your user model.
 * **ignored_attributes** - The attributes which should always be ignored
@@ -249,7 +243,7 @@ class Article < ActiveRecord::Base
 end
 
 Article.versioned_attributes # => ["headline", "images"]
-``` 
+```
 
 #### Changes vs. Versions
 There is one aspect that may seem a bit confusing. The behavior of

data/app/models/concerns/secretary/user_activity_association.rb

@@ -0,0 +1,11 @@
+module Secretary
+  module UserActivityAssociation
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :activities,
+        :class_name     => "Secretary::Version",
+        :foreign_key    => "user_id"
+    end
+  end
+end

data/app/models/secretary/version.rb

@@ -33,11 +33,13 @@ module Secretary
       private
 
       def generate_description(object, attributes)
+        changed_attributes = attributes.map(&:humanize).to_sentence
+
         if was_created?(object)
           "Created #{object.class.name.titleize} ##{object.id}"
 
         elsif was_updated?(object)
-          "Changed #{attributes.to_sentence}"
+          "Changed #{changed_attributes}"
 
         else
           "Generated Version"

data/lib/generators/secretary/install_generator.rb

@@ -17,7 +17,11 @@ module Secretary
     source_root File.expand_path("../templates", __FILE__)
 
     def copy_migration
-      migration_template "versions_migration.rb", "db/migrate/create_versions"
+      migration_template "versions_migration.rb", "db/migrate/secretary_create_versions"
+    end
+
+    def copy_config
+      template "secretary_config.rb", "config/initializers/secretary.rb"
     end
   end
 end

data/lib/generators/secretary/templates/secretary_config.rb

@@ -0,0 +1,4 @@
+Secretary.configure do |config|
+  # config.user_class = "::User"
+  # config.ignored_attributes = ["id", "created_at", "updated_at"]
+end

data/lib/generators/secretary/templates/versions_migration.rb

@@ -4,7 +4,7 @@ class SecretaryCreateVersions < ActiveRecord::Migration
       t.integer  "version_number"
       t.string   "versioned_type"
       t.integer  "versioned_id"
-      t.string   "user_id"
+      t.integer  "user_id"
       t.text     "description"
       t.text     "object_changes"
       t.datetime "created_at"

data/lib/secretary/engine.rb

@@ -1,4 +1,14 @@
 module Secretary
   class Engine < ::Rails::Engine
+    # This is necessary to support rails 3, which doesn't autoload
+    # the concerns directory
+    config.autoload_paths << File.expand_path(
+      "../../../app/models/concerns", __FILE__)
+
+    config.to_prepare do
+      Secretary.config.user_class.constantize.instance_eval do
+        include Secretary::UserActivityAssociation
+      end
+    end
   end
 end

data/lib/secretary/gem_version.rb

@@ -1,3 +1,3 @@
 module Secretary
-  GEM_VERSION = "1.0.0"
+  GEM_VERSION = "1.1.0"
 end

data/lib/secretary/has_secretary.rb

@@ -3,19 +3,33 @@ module Secretary
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # (Boolean) Check if a class is versioned
-      # Story.has_secretary? # => true or false
+      # Check if a class is versioned
+      #
+      # Example
+      #
+      #   Story.has_secretary? # => true or false
+      #
+      # Returns boolean
       def has_secretary?
         !!@_has_secretary
       end
 
-      # Declare that this class shoudl be versioned.
-      # 
-      # Options:
-      # * `on` : Array of Strings which specifies which attributes should be
-      #   versioned.
-      # * `except` : Array of Strings which specifies which attributes should
-      #   NOT be versioned.
+      # Declare that this class should be versioned.
+      #
+      # Arguments
+      #
+      # * options (Hash) -
+      #   * `on` (Array)      - Array of Strings which specifies which
+      #                         attributes should be versioned.
+      #   * `except` (Array)  - Array of Strings which specifies which
+      #                         attributes should NOT be versioned.
+      #
+      # Examples
+      #
+      #   has_secretary on: ["published_at", "user_id"]
+      #   has_secretary except: ["id", "created_at"]
+      #
+      # Returns nothing
       def has_secretary(options={})
         @_has_secretary = true
         Secretary.versioned_models.push self.name
@@ -42,6 +56,8 @@ module Secretary
 
     module InstanceMethodsOnActivation
       # Generate a version for this object.
+      #
+      # Returns nothing
       def generate_version
         Version.generate(self)
       end

data/lib/secretary/tracks_association.rb

@@ -8,7 +8,12 @@ module Secretary
       # the saved record will get a new version, with association
       # diffs and everything.
       #
-      # Example:
+      # Arguments
+      #
+      # associations - (Symbols) A variable number of association
+      #                names to track
+      #
+      # Example
       #
       #   has_secretary
       #
@@ -25,7 +30,7 @@ module Secretary
       # in, for example, form params). This also lets you easily share this
       # method with `accepts_nested_attributes_for`.
       #
-      # Example:
+      # Example
       #
       #   class Person < ActiveRecord::Base
       #     has_secretary
@@ -41,6 +46,8 @@ module Secretary
       #       attributes['name'].blank?
       #     end
       #   end
+      #
+      # Returns nothing
       def tracks_association(*associations)
         if !self.has_secretary?
           raise NotVersionedError, self.name
@@ -56,8 +63,9 @@ module Secretary
           end
 
           # If the environment is loaded, the following line will be
-          # evaluated for any `tracks_association` calls. `versioned_attributes`
-          # calls `self.column_names`, which requires the table to exist.
+          # evaluated for any `tracks_association` calls.
+          # `versioned_attributes` calls `self.column_names`,
+          # which requires the table to exist.
           #
           # So the problem is that if our database or table doesn't exist,
           # we can't load the environment, and the environment needs to be
@@ -66,8 +74,14 @@ module Secretary
           # So, we rescue! And warn.
           begin
             self.versioned_attributes << name.to_s
+
+            if reflection.macro == :belongs_to
+              self.versioned_attributes << reflection.foreign_key
+            end
+
           rescue => e
-            warn  "Caught an error while updating versioned attributes. #{e}"
+            warn  "[secretary-rails] Caught an error while loading " \
+                  "#{self.name}. #{e}"
           end
 
           define_dirty_association_methods(name, reflection)

data/lib/secretary/versioned_attributes.rb

@@ -6,7 +6,11 @@ module Secretary
       class << self
         # Set the attributes which Secretary should keep track of.
         #
-        # Example:
+        # Arguments
+        #
+        # * attributes - (Hash) The attributes that should be versioned.
+        #
+        # Example
         #
         #   class Article < ActiveRecord::Base
         #     self.versioned_attributes = [:id, :created_at]
@@ -17,14 +21,21 @@ module Secretary
         # which attributes to ignore.
         #
         # Each takes an array of column names *as strings*.
+        #
+        # Returns Hash
         def versioned_attributes=(attributes)
           verify_strings!(attributes)
           @versioned_attributes = attributes
         end
 
+
+        # We need to rescue here because this method might be called when
+        # running a database task, before the table has been created.
+        # Since we're calling `column_names`, which checks the database
+        # directly, it will throw an error if the table doesn't exist.
         def versioned_attributes
           @versioned_attributes ||=
-            self.column_names -
+            __safe_column_names -
             Secretary.config.ignored_attributes -
             unversioned_attributes
         end
@@ -34,6 +45,7 @@ module Secretary
           self.versioned_attributes -= attributes
         end
 
+
         private
 
         def unversioned_attributes
@@ -46,6 +58,15 @@ module Secretary
               "Versioned attributes must be declared as strings."
           end
         end
+
+        def __safe_column_names
+          begin
+            self.column_names
+          rescue ActiveRecord::StatementInvalid => e
+            warn "Caught an error when loading #{self.name}: #{e}\n"
+            return []
+          end
+        end
       end
     end
 

data/spec/internal/app/models/user.rb

@@ -1,6 +1,4 @@
 class User < ActiveRecord::Base
-  has_many :activities, :class_name => "Secretary::Version"
-
   has_many :story_users
   has_many :stories, :through => :story_users
 end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: postgresql
+  database: combustion_test