impressionist 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77fe32e3f3573eee145dbc117db77870636488db
-  data.tar.gz: 5653b56f9e30cc83ab460ce4ebe14581aea1f0a5
+  metadata.gz: 2ba9ef405e0268bd6e6c4f49f5af548c64b99489
+  data.tar.gz: b23558b98793b625a57c55b14cbcded8c681f136
 SHA512:
-  metadata.gz: f30282672dfe4b2d8a848f571b6926640433e6131cdc744cd4b73b9c5ff63fd273467b2c0660bf49cb8401ff3223bac7871fa72ce7ac1af46938a4ae2eb0b824
-  data.tar.gz: be7b5e08610b3def60b450177dd12aec65b65e1cb9357b062599d760a1c3d0693a09e497d5fec4f2007e8904dcdda55ee29510d1ef1e8cb670886d1b07ff34d1
+  metadata.gz: 20b79abe821d51b958b217d28b447476ccb0cf85bb7bf0edf8ede971f68981533c42469341507dd1131f5718ca7deb5239d4549ec0b372cf001605afe5ae1968
+  data.tar.gz: 2ecc6417699a4ad0059b15d685df29e9586ce8d6c5f158ccbaf770c84ceab5f06ac8bfb8b7e54ef02155f9a435e74db05e3189311cb95e335220a34cf0bfaff5

data/.travis.yml

@@ -1,12 +1,19 @@
 language: ruby
+before_install:
+  - gem install bundler
 before_script:
   - cd tests/test_app
   - bundle exec rails g impressionist -f
   - bundle exec rake db:create db:migrate RAILS_ENV=test
   - cd ..
+script:
+  - bundle exec rake
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
   - jruby-head
   - rbx
   - ruby-head

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 1.6.0 (2016-09-16)
+* Documentation example for counter_cache (#239, @fwolfst)
+* Green Travis CI builds (#238, @jgrau)
+* Rails 5.1 support (#241, @msimonborg)
+* Use `dependent: :delete_all` instead of `:destroy` for performance gains (#242, @midnightSuyama & @jgrau)
+* Fix counter cache not updating when no `unique` option is set (#243, @sachiotomita & @jgrau)
+
+== 1.5.2 (2016-09-16)
+
+== 1.5.1 (2013-12-31)
+
 == 1.5.0 (2013-12-30)
 * Added message filtering.
 * (@overovermind)

data/README.md

@@ -91,9 +91,10 @@ Usage
    controller if you are using this method.  If you add "impressionist" to the
    top of your controller and also use this method in your action, it will
    result in 2 impressions being logged (but associated with one request_hash).
-   If you're using [friendly_id](https://github.com/norman/friendly_id) be sure 
-   to log impressionist this way, as params[:id] will return a string(url slug) 
-   while impressionable_id is a Integer column in database.
+   If you're using [friendly_id](https://github.com/norman/friendly_id) be sure
+   to log impressionist this way, as params[:id] will return a string(url slug)
+   while impressionable_id is a Integer column in database. Also note that you
+   have to take step #3 for the Widget model for this to work.
 
         def show
           @widget = Widget.find
@@ -119,7 +120,7 @@ Usage
    in turn will give you impressions with unique params.
 
         @widget.impressionist_count(:filter => :params)
-        
+
 8. Get the unique impression count from a model filtered by session hash.  Same
    as #6 regarding request hash.  This may be more desirable than filtering by
    IP address depending on your situation, since filtering by IP may ignore
@@ -138,7 +139,7 @@ Usage
         @widget.impressionist_count(:message=>"pageview", :filter=>:all)
 
 Logging impressions for authenticated users happens automatically.  If you have
-a current_user helper or use @current_user in your before_filter to set your
+a current_user helper or use @current_user in your before_filter (or before_action in Rails >= 5.0) to set your
 authenticated user, current_user.id will be written to the user_id field in the
 impressions table.
 
@@ -174,6 +175,10 @@ It is as simple as this:
 
     t.integer :my_column_name, :default => 0
 
+If you want to use the typical Rails 4 migration generator, you can:
+
+    rails g migration AddImpressionsCountToBook impressions_count:int
+
 What if I only want to record unique impressions?
 -------------------------------------------------
 Maybe you only care about unique impressions and would like to avoid
@@ -188,7 +193,7 @@ impressions in your controller:
 
     # only record impression if session is unique
     impressionist :unique => [:session_hash]
-    
+
     # only record impression if param is unique
     impressionist :unique => [:params]
 

data/app/controllers/impressionist_controller.rb

@@ -3,13 +3,21 @@ require 'digest/sha2'
 module ImpressionistController
   module ClassMethods
     def impressionist(opts={})
-      before_filter { |c| c.impressionist_subapp_filter(opts) }
+      if Rails::VERSION::MAJOR >= 5
+        before_action { |c| c.impressionist_subapp_filter(opts) }
+      else
+        before_filter { |c| c.impressionist_subapp_filter(opts) }
+      end
     end
   end
 
   module InstanceMethods
     def self.included(base)
-      base.before_filter :impressionist_app_filter
+      if Rails::VERSION::MAJOR >= 5
+        base.before_action :impressionist_app_filter
+      else
+        base.before_filter :impressionist_app_filter
+      end
     end
 
     def impressionist(obj,message=nil,opts={})
@@ -103,7 +111,7 @@ module ImpressionistController
       request_param = params_hash
       impressions.detect{|impression| impression.params == request_param }.nil?
     end
-    
+
     # creates the query to check for uniqueness
     def unique_query(unique_opts,impressionable=nil)
       full_statement = direct_create_statement({},impressionable)

data/app/models/impressionist/impressionable.rb

@@ -8,7 +8,7 @@ module Impressionist
       DEFAULT_CACHE ||= {
         :counter_cache => false,
         :column_name => :impressions_count,
-        :unique => false
+        :unique => :all
       }
 
       def impressionist_counter_cache_options

data/gemfiles/rails32.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rake', '>= 0.9'
+gem 'rake', '>= 0.9', '< 11.0'
 gem 'rdoc', '>= 2.4.2'
 
 platforms :jruby do
@@ -14,6 +14,7 @@ platforms :ruby, :mswin, :mingw do
 end
 
 group :test do
+  gem 'public_suffix', '< 1.5.0'
   gem 'capybara', '>= 2.0.3'
   gem 'minitest'
   gem 'minitest-rails'

data/gemfiles/rails40.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rake', '>= 0.9'
+gem 'rake', '>= 0.9', '< 11.0'
 gem 'rdoc', '>= 2.4.2'
 
 platforms :jruby do
@@ -14,6 +14,7 @@ platforms :ruby, :mswin, :mingw do
 end
 
 group :test do
+  gem 'public_suffix', '< 1.5.0'
   gem 'capybara', '>= 2.0.3'
   gem 'minitest'
   gem 'minitest-rails'

data/impressionist.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.require_path  = 'lib'
   s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
 
-  s.add_dependency 'nokogiri', '~> 1.6'
+  s.add_dependency 'nokogiri', RUBY_VERSION < '2.1.0' ? '~> 1.6.0' : '~> 1'
   s.add_development_dependency 'bundler', '~> 1.0'
 end

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

@@ -22,7 +22,7 @@ class CreateImpressionsTable < ActiveRecord::Migration
     add_index :impressions, [:controller_name,:action_name,:request_hash], :name => "controlleraction_request_index", :unique => false
     add_index :impressions, [:controller_name,:action_name,:ip_address], :name => "controlleraction_ip_index", :unique => false
     add_index :impressions, [:controller_name,:action_name,:session_hash], :name => "controlleraction_session_index", :unique => false
-    add_index :impressions, [:impressionable_type, :impressionable_id, :params], :name => "poly_params_request_index", :unique => false
+    add_index :impressions, [:impressionable_type, :impressionable_id, :params], :name => "poly_params_request_index", :unique => false, :length => {:params => 255 }
     add_index :impressions, :user_id
   end
 

data/lib/impressionist/is_impressionable.rb

@@ -15,9 +15,9 @@ module Impressionist
       def define_association
         has_many(:impressions,
         :as => :impressionable,
-        :dependent => :destroy)
+        :dependent => :delete_all)
       end
     end
-  
+
   end
 end

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

@@ -9,7 +9,7 @@ module Impressionist
         def is_impressionable(options={})
           many(:impressions,
           :as => :impressionable,
-          :dependent => :destroy)
+          :dependent => :delete_all)
 
           @impressionist_cache_options = options
         end

data/lib/impressionist/update_counters.rb

@@ -42,9 +42,17 @@ module Impressionist
     # is_impressionable :counter_cache => true,
     # :unique => :any_other_filter
     def unique_filter
-      Symbol === unique ?
-      unique :
-      :ip_address
+      # Support `is_impressionable :counter_cache => true, :unique => true`
+      # defaulting to `:ip_address` for counting unique impressions.
+      return :ip_address if unique == true
+
+      # Should a user try `is_impressionable :counter_cache => true, :unique => false`
+      # then support that as well
+      return :all if unique == false
+
+      # Otherwise set the filter to either what the user supplied as the `unique` option
+      # or the default (`:all`)
+      unique
     end
 
     def unique

data/lib/impressionist/version.rb

@@ -1,3 +1,3 @@
 module Impressionist
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/tests/test_app/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 3.2'
+gem 'rake', '< 11.0'
+gem 'public_suffix', '< 1.5.0'
 
 gem 'impressionist', :path => '../../'
 

data/tests/test_app/app/controllers/application_controller.rb

@@ -1,8 +1,12 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
-  before_filter :secondary_before_filter
+  if Rails::VERSION::MAJOR >= 5
+    before_action :secondary_before_action
+  else
+    before_filter :secondary_before_action
+  end
 
-  def secondary_before_filter
-    @test_secondary_before_filter = "this is a test"
+  def secondary_before_action
+    @test_secondary_before_action = "this is a test"
   end
 end

data/tests/test_app/app/controllers/articles_controller.rb

@@ -1,5 +1,9 @@
 class ArticlesController < ApplicationController
-  before_filter :test_current_user_var
+  if Rails::VERSION::MAJOR >= 5
+    before_action :test_current_user_var
+  else
+    before_filter :test_current_user_var
+  end
 
   def test_current_user_var
     if session[:user_id]

data/tests/test_app/spec/controllers/articles_controller_spec.rb

@@ -26,7 +26,7 @@ describe ArticlesController do
     Article.first.impressions.last.action_name.should eq "show"
   end
 
-  it "should log the user_id if user is authenticated (@current_user before_filter method)" do
+  it "should log the user_id if user is authenticated (@current_user before_action method)" do
     session[:user_id] = 123
     get "show", :id=> 1
     Article.first.impressions.last.user_id.should eq 123
@@ -72,5 +72,3 @@ describe ArticlesController do
     Impression.last.referrer.should eq nil
   end
 end
-
-

data/tests/test_app/spec/initializers/initializers_spec.rb

@@ -13,7 +13,7 @@ describe Impressionist do
     expect(ApplicationController).to respond_to(method)
   end
 
-  it "should include the before_filter method in ApplicationController" do
+  it "should include the before_action method in ApplicationController" do
      filters = ApplicationController._process_action_callbacks.select { |c| c.kind == :before }
      filters.collect{|filter|filter.filter}.include?(:impressionist_app_filter).should be_true
   end

data/tests/test_app/spec/models/model_spec.rb

@@ -57,14 +57,14 @@ describe Impression do
     @article.impressionist_count(:filter=>:session_hash).should eq 7
   end
 
-  # tests :dependent => :destroy
+  # tests :dependent => :delete_all
   it "should delete impressions on deletion of impressionable" do
     #impressions_count = Impression.all.size
     a = Article.create
     i = a.impressions.create
     a.destroy
     a.destroyed?.should be_true
-    i.destroyed?.should be_true
+    Impression.exists?(i.id).should be_false
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: impressionist
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - johnmcaliley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Easy way to log impressions