impressionist 1.1.1 → 1.2.0

data/.gitignore

@@ -1,5 +1,4 @@
 *~
-*.DS_Store
 /coverage
 /pkg
 /rdoc

data/.travis.yml

@@ -2,10 +2,10 @@ before_install: gem install bundler
 before_script: "cd test_app && bundle install && ./script/rails generate impressionist && bundle exec rake db:migrate && cd .."
 language: ruby
 rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - ruby-head

data/README.md

@@ -57,7 +57,7 @@ The following fields are provided in the migration:
     t.string   "referrer"             # request.referer
     t.string   "message"              # custom message you can add
     t.datetime "created_at"           # I am not sure what this is.... Any clue?
-    t.datetime "updated_at"           # never seen this one before either....  Your guess is as good as mine??
+    t.datetime "updated_at"           # never seen this one before either....  Your guess is as good as mine?? ;-)
 
 Usage
 -----

data/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env rake
-
 require 'bundler/setup'
 require 'rspec/core/rake_task'
 

data/app/controllers/impressionist_controller.rb

@@ -41,10 +41,7 @@ module ImpressionistController
     private
 
     def bypass
-      Impressionist::Bots::WILD_CARDS.each do |wild_card|
-        return true if request.user_agent and request.user_agent.downcase.include? wild_card
-      end
-      Impressionist::Bots::LIST.include? request.user_agent
+      Impressionist::Bots.bot?(request.user_agent)
     end
 
     def unique_instance?(impressionable, unique_opts)

data/app/models/impression.rb

@@ -1,3 +1,2 @@
 class Impression
-  belongs_to :impressionable, :polymorphic=>true
 end

data/app/models/impressionist/bots.rb

@@ -1,5 +1,11 @@
 module Impressionist
   module Bots
+
+    def self.bot?(user_agent = nil)
+      return false if user_agent.nil?
+      WILD_CARDS.any? { |wc| user_agent.downcase.include?(wc) } || LIST.include?(user_agent)
+    end
+
     WILD_CARDS = ["bot","yahoo","slurp","google","msn","crawler"]
 
     LIST = ["<a href='http://www.unchaos.com/'> UnChaos </a> From Chaos To Order Hybrid Web Search Engine.(vadim_gonchar@unchaos.com)",

data/app/models/impressionist/impressionable.rb

@@ -3,19 +3,24 @@ module Impressionist
     extend ActiveSupport::Concern
 
     module ClassMethods
-      attr_accessor :cache_options
-      @cache_options = nil
+      attr_accessor :impressionist_cache_options
+      @impressionist_cache_options = nil
 
-      def counter_cache_options
-        if @cache_options
+      def impressionist_counter_cache_options
+        if @impressionist_cache_options
           options = { :column_name => :impressions_count, :unique => false }
-          options.merge!(@cache_options) if @cache_options.is_a?(Hash)
+          options.merge!(@impressionist_cache_options) if @impressionist_cache_options.is_a?(Hash)
           options
         end
       end
 
+      def impressionist_counter_caching?
+        impressionist_counter_cache_options.present?
+      end
+
       def counter_caching?
-        counter_cache_options.present?
+        ::ActiveSupport::Deprecation.warn("#counter_caching? is deprecated; please use #impressionist_counter_caching? instead")
+        impressionist_counter_caching?
       end
     end
 
@@ -26,17 +31,15 @@ module Impressionist
     def impressionist_count(options={})
       options.reverse_merge!(:filter=>:request_hash, :start_date=>nil, :end_date=>Time.now)
       imps = options[:start_date].blank? ? impressions : impressions.where("created_at>=? and created_at<=?",options[:start_date],options[:end_date])
-      if options[:filter]!=:all
-        imps = imps.select(options[:filter]).group(options[:filter])
-      end
-      imps.all.size
+      options[:filter] == :all ? imps.count : imps.count(options[:filter], :distinct => true)
     end
 
-    def update_counter_cache
-      cache_options = self.class.counter_cache_options
+    def update_impressionist_counter_cache
+      cache_options = self.class.impressionist_counter_cache_options
       column_name = cache_options[:column_name].to_sym
       count = cache_options[:unique] ? impressionist_count(:filter => :ip_address) : impressionist_count
-      update_attribute(column_name, count)
+      old_count = send(column_name) || 0
+      self.class.update_counters(id, column_name => (count - old_count))
     end
 
     # OLD METHODS - DEPRECATE IN V0.5

data/lib/generators/active_record/templates/create_impressions_table.rb

@@ -14,6 +14,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
       t.text :referrer
       t.timestamps
     end
+    add_index :impressions, [:impressionable_type, :message, :impressionable_id], :name => "impressionable_type_message_index", :unique => false
     add_index :impressions, [:impressionable_type, :impressionable_id, :request_hash], :name => "poly_request_index", :unique => false
     add_index :impressions, [:impressionable_type, :impressionable_id, :ip_address], :name => "poly_ip_index", :unique => false
     add_index :impressions, [:impressionable_type, :impressionable_id, :session_hash], :name => "poly_session_index", :unique => false

data/lib/generators/impressionist_generator.rb

@@ -7,6 +7,7 @@ module Impressionist
       def copy_config_file
         template 'impression.rb', 'config/initializers/impression.rb'
       end
+
     end
   end
 end

data/lib/generators/mongoid/impressionist_generator.rb

@@ -0,0 +1,8 @@
+module Mongoid
+  module Generators
+    class ImpressionistGenerator < Rails::Generators::Base
+      # Empty for now, need it for generating the config file without
+      # triggering other ORM's generators.
+    end
+  end
+end

data/lib/generators/templates/impression.rb

@@ -1,5 +1,5 @@
 # Use this hook to configure impressionist parameters
 Impressionist.setup do |config|
-  # Define ORM. Could be :active_record (default) and :mongo_mapper
+  # Define ORM. Could be :active_record (default), :mongo_mapper or :mongoid
   # config.orm = :active_record
 end

data/lib/impressionist/controllers/mongoid/impressionist_controller.rb

@@ -0,0 +1,10 @@
+ImpressionistController::InstanceMethods.send(:define_method, :direct_create_statement) do |query_params={}|
+	# creates a statment hash that contains default values for creating an impression.
+	# if :impressionable_id is a valid ObjectId then convert it into one
+	base = (defined? Moped) ? Moped::BSON : BSON
+	query_params.reverse_merge!(
+		:impressionable_type => controller_name.singularize.camelize,
+		:impressionable_id=> !base::ObjectId.legal?(params[:id]) ? params[:id] : base::ObjectId.from_string(params[:id])
+	)
+	associative_create_statement(query_params)
+end

data/lib/impressionist/engine.rb

@@ -5,7 +5,7 @@ module Impressionist
   class Engine < Rails::Engine
     initializer 'impressionist.model' do |app|
       require "#{root}/app/models/impressionist/impressionable.rb"
-      if Impressionist.orm == :active_record
+      if Impressionist.orm == :active_record && defined? ActiveRecord
         require "impressionist/models/active_record/impression.rb"
         require "impressionist/models/active_record/impressionist/impressionable.rb"
         ActiveRecord::Base.send(:include, Impressionist::Impressionable)
@@ -13,10 +13,17 @@ module Impressionist
         require "impressionist/models/mongo_mapper/impression.rb"
         require "impressionist/models/mongo_mapper/impressionist/impressionable.rb"
         MongoMapper::Document.plugin Impressionist::Impressionable
+      elsif Impressionist.orm == :mongoid
+        require 'impressionist/models/mongoid/impression.rb'
+        require 'impressionist/models/mongoid/impressionist/impressionable.rb'
+        Mongoid::Document.send(:include, Impressionist::Impressionable)
       end
     end
 
     initializer 'impressionist.controller' do
+      if Impressionist.orm == :mongoid
+          require 'impressionist/controllers/mongoid/impressionist_controller.rb'
+      end
       ActiveSupport.on_load(:action_controller) do
         include ImpressionistController::InstanceMethods
         extend ImpressionistController::ClassMethods

data/lib/impressionist/models/active_record/impression.rb

@@ -3,6 +3,8 @@ class Impression < ActiveRecord::Base
   :controller_name, :action_name, :view_name, :request_hash, :ip_address,
   :session_hash, :message, :referrer
 
+  belongs_to :impressionable, :polymorphic=>true
+
   after_save :update_impressions_counter_cache
 
   private
@@ -10,9 +12,9 @@ class Impression < ActiveRecord::Base
   def update_impressions_counter_cache
     impressionable_class = self.impressionable_type.constantize
 
-    if impressionable_class.counter_cache_options
+    if impressionable_class.impressionist_counter_cache_options
       resouce = impressionable_class.find(self.impressionable_id)
-      resouce.try(:update_counter_cache)
+      resouce.try(:update_impressionist_counter_cache)
     end
   end
 end

data/lib/impressionist/models/active_record/impressionist/impressionable.rb

@@ -5,7 +5,7 @@ module Impressionist
     module ClassMethods
       def is_impressionable(options={})
         has_many :impressions, :as => :impressionable, :dependent => :destroy
-        @cache_options = options[:counter_cache]
+        @impressionist_cache_options = options[:counter_cache]
       end
     end
   end

data/lib/impressionist/models/mongo_mapper/impression.rb

@@ -13,4 +13,6 @@ class Impression
   key :message, String
   key :referrer, String
   timestamps!
+
+  belongs_to :impressionable, :polymorphic=>true
 end

data/lib/impressionist/models/mongoid/impression.rb

@@ -0,0 +1,32 @@
+class Impression
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  attr_accessible :impressionable_type, :impressionable_field, :impressionable_id, :user_id,
+  :controller_name, :action_name, :view_name, :request_hash, :ip_address,
+  :session_hash, :message, :referrer
+
+  belongs_to :impressionable, polymorphic: true
+
+  field :user_id
+  field :controller_name
+  field :action_name
+  field :view_name
+  field :request_hash
+  field :ip_address
+  field :session_hash
+  field :message
+  field :referrer
+
+  set_callback(:create, :after) do |doc|
+    unless impressionable_id.nil?
+      impressionable_class = doc.impressionable_type.constantize
+
+      if impressionable_class.impressionist_counter_cache_options
+        resource = impressionable_class.find(doc.impressionable_id)
+        resource.try(:update_impressionist_counter_cache)
+      end
+    end
+  end
+  
+end

data/lib/impressionist/models/mongoid/impressionist/impressionable.rb

@@ -0,0 +1,52 @@
+module Impressionist
+  module Impressionable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def is_impressionable(options={})
+      	has_many :impressions, as: :impressionable, dependent: :destroy
+        	@impressionist_cache_options = options[:counter_cache]
+        	if !@impressionist_cache_options.nil?
+        		opts = impressionist_counter_cache_options
+        		field opts[:column_name], type: Integer
+        	end
+      end
+
+      def impressionist_counter_cache_options
+        if @impressionist_cache_options
+          options = { :column_name => :impressions_count, :unique => false }
+          options.merge!(@impressionist_cache_options) if @impressionist_cache_options.is_a?(Hash)
+          options
+        end
+      end
+
+      def impressionist_counter_caching?
+        impressionist_counter_cache_options.present?
+      end
+
+      def counter_caching?
+        ::ActiveSupport::Deprecation.warn("#counter_caching? is deprecated; please use #impressionist_counter_caching? instead")
+        impressionist_counter_caching?
+      end
+    end
+
+    def impressionable?
+      true
+    end
+
+    def impressionist_count(options={})
+      options.reverse_merge!(:filter=>:request_hash, :start_date=>nil, :end_date=>Time.now)
+      imps = options[:start_date].blank? ? impressions : impressions.between(created_at: options[:start_date]..options[:end_date])
+      options[:filter] == :all ? imps.count : imps.where(options[:filter].ne => nil).count
+    end
+
+    def update_impressionist_counter_cache
+      cache_options = self.class.impressionist_counter_cache_options
+      column_name = cache_options[:column_name].to_sym
+      count = cache_options[:unique] ? impressionist_count(:filter => :ip_address) : impressionist_count
+      old_count = send(column_name) || 0
+      self.inc(column_name, (count - old_count))
+    end
+
+  end
+end

data/lib/impressionist/version.rb

@@ -1,3 +1,3 @@
 module Impressionist
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/test_app/spec/models/bots_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Impressionist::Bots do
+
+  describe "self.bot?" do
+    it "is true if user_agent is matches wild card" do
+      Impressionist::Bots.bot?("google.com bot").should be_true
+    end
+
+    it "is true if user_agent is on bot list" do
+      Impressionist::Bots.bot?("A-Online Search").should be_true
+    end
+
+    it "is false if user_agent is blank" do
+      Impressionist::Bots.bot?("").should be_false
+      Impressionist::Bots.bot?(nil).should be_false
+    end
+
+    it "is false if user_agent is safe" do
+      Impressionist::Bots.bot?('127.0.0.1').should be_false
+    end
+
+    it "is false if user_agent not given" do
+      Impressionist::Bots.bot?.should be_false
+    end
+  end
+end

data/test_app/spec/models/counter_caching_spec.rb

@@ -8,23 +8,43 @@ describe Impression do
     Impression.destroy_all
   end
 
+  describe "self#impressionist_counter_caching?" do
+    it "should know when counter caching is enabled" do
+      Widget.should be_impressionist_counter_caching
+    end
+
+    it "should know when counter caching is disabled" do
+      Article.should_not be_impressionist_counter_caching
+    end
+  end
+
   describe "self#counter_caching?" do
     it "should know when counter caching is enabled" do
+      ActiveSupport::Deprecation.should_receive(:warn)
       Widget.should be_counter_caching
     end
 
     it "should know when counter caching is disabled" do
+      ActiveSupport::Deprecation.should_receive(:warn)
       Article.should_not be_counter_caching
     end
+
   end
 
-  describe "#update_counter_cache" do
+  describe "#update_impressionist_counter_cache" do
     it "should update the counter cache column to reflect the correct number of impressions" do
       lambda {
-         Impression.create(:impressionable_type => @widget.class.name, :impressionable_id => @widget.id)
+         @widget.impressions.create(:request_hash => 'abcd1234')
          @widget.reload
        }.should change(@widget, :impressions_count).from(0).to(1)
     end
+
+    it "should not update the timestamp on the impressable" do
+      lambda {
+         @widget.impressions.create(:request_hash => 'abcd1234')
+         @widget.reload
+       }.should_not change(@widget, :updated_at)
+    end
   end
 
 end

data/upgrade_migrations/version_1_1_2.rb

@@ -0,0 +1,9 @@
+class Version04UpdateImpressionsTable < ActiveRecord::Migration
+  def self.up
+    add_index :impressions, [:impressionable_type, :message, :impressionable_id], :name => "impressionable_type_message_index", :unique => false
+  end
+
+  def self.down
+    remove_index :impressions, :impressionable_type_message_index
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: impressionist
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70331801224520 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70331801224520
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70331801251100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70331801251100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70331801250700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331801250700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70331801250120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70331801250120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70331801249480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70331801249480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70331801248900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: 2.4.2
   type: :development
   prerelease: false
-  version_requirements: *70331801248900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70331801248260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331801248260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70331801247420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331801247420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70331801246980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331801246980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: systemu
-  requirement: &70331801246480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +165,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70331801246480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Log impressions from controller actions or from a model
 email: john.mcaliley@gmail.com
 executables: []
@@ -144,14 +194,18 @@ files:
 - lib/generators/active_record/templates/create_impressions_table.rb
 - lib/generators/impressionist_generator.rb
 - lib/generators/mongo_mapper/impressionist_generator.rb
+- lib/generators/mongoid/impressionist_generator.rb
 - lib/generators/templates/impression.rb
 - lib/impressionist.rb
 - lib/impressionist/bots.rb
+- lib/impressionist/controllers/mongoid/impressionist_controller.rb
 - lib/impressionist/engine.rb
 - lib/impressionist/models/active_record/impression.rb
 - lib/impressionist/models/active_record/impressionist/impressionable.rb
 - lib/impressionist/models/mongo_mapper/impression.rb
 - lib/impressionist/models/mongo_mapper/impressionist/impressionable.rb
+- lib/impressionist/models/mongoid/impression.rb
+- lib/impressionist/models/mongoid/impressionist/impressionable.rb
 - lib/impressionist/version.rb
 - logo.png
 - test_app/.gitignore
@@ -234,13 +288,15 @@ files:
 - test_app/spec/fixtures/impressions.yml
 - test_app/spec/fixtures/posts.yml
 - test_app/spec/fixtures/widgets.yml
-- test_app/spec/intializers/initializers_spec.rb
+- test_app/spec/initializers/initializers_spec.rb
+- test_app/spec/models/bots_spec.rb
 - test_app/spec/models/counter_caching_spec.rb
 - test_app/spec/models/model_spec.rb
 - test_app/spec/rails_generators/rails_generators_spec.rb
 - test_app/spec/spec_helper.rb
 - upgrade_migrations/version_0_3_0.rb
 - upgrade_migrations/version_0_4_0.rb
+- upgrade_migrations/version_1_1_2.rb
 homepage: https://github.com/charlotte-ruby/impressionist
 licenses:
 - MIT
@@ -256,7 +312,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4375478924992886523
+      hash: 2760039112118904693
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -265,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easy way to log impressions
@@ -348,7 +404,8 @@ test_files:
 - test_app/spec/fixtures/impressions.yml
 - test_app/spec/fixtures/posts.yml
 - test_app/spec/fixtures/widgets.yml
-- test_app/spec/intializers/initializers_spec.rb
+- test_app/spec/initializers/initializers_spec.rb
+- test_app/spec/models/bots_spec.rb
 - test_app/spec/models/counter_caching_spec.rb
 - test_app/spec/models/model_spec.rb
 - test_app/spec/rails_generators/rails_generators_spec.rb