impressionist 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1694b326962e72ed2f57841cb4bc799e1a8e4d
-  data.tar.gz: 35b5e4aa5feff7df8341022ec6b4195d35a7df18
+  metadata.gz: cac2802f1a96bf95bc358134f43a869aab3ba449
+  data.tar.gz: afab8713bbc4b91bcd84a57a3042cbfce578643e
 SHA512:
-  metadata.gz: af17886e092d7fd62bbf70c768cb4b804f3087559f12fa2d2d68ee12f3ca6d859bcf7954790957094310ff76ed7376ae25707638779cbe0d894fd00191a5532b
-  data.tar.gz: 828a4f2a95741643e28e1ba943515fa9e715cee6a907f62b1a93950630433f27602b208a49f4d0c597d39818a09db9f1fd041c751080f4546926c7f141141e17
+  metadata.gz: f92d2ef3618bce991811cb438751bc6e76497bcae951a8a42b1050133ed492c19e77b290f69a141d91087c91a40d851716e834e70645119675b7f5cea41b7229
+  data.tar.gz: 8425229ed14a35088bb82ac68c3d4b5b910c694175ae03f4bdef963106745e06fb9e5597f6423e3b5233368670a086a80d46b1a62ba7bbb5737206b4d9ed0cff

data/.travis.yml

@@ -2,7 +2,8 @@ language: ruby
 
 bundler_args: '--binstubs --without documentation'
 before_install: gem install bundler
-before_script: "cd test_app && bundle install && ./script/rails generate impressionist -f && rake db:migrate && cd .."
+
+before_script: "cd tests/test_app && bundle install && ./script/rails generate impressionist -f && rake db:migrate && cd .."
 
 rvm:
   - rbx-18mode

data/Rakefile

@@ -1,15 +1,17 @@
 require 'bundler/setup'
 require 'rspec/core/rake_task'
+require 'rake/testtask'
 
 Bundler::GemHelper.install_tasks
 
+# Impressionist will use MiniTest instead of RSpec
 RSpec::Core::RakeTask.new do |task|
-  task.rspec_opts = "-I ./test_app/spec"
-  task.pattern = "./test_app/spec/**/*_spec.rb"
+  task.rspec_opts = "-I ./tests/test_app/spec"
+  task.pattern = "./tests/test_app/spec/**/*_spec.rb"
 end
 
-task :test => :spec
-task :default => :spec
+task :test_app => :spec
+task :default => [:test, :test_app]
 
 namespace :impressionist do
   require File.dirname(__FILE__) + "/lib/impressionist/bots"
@@ -18,4 +20,15 @@ namespace :impressionist do
   task :bots do
     p Impressionist::Bots.consume
   end
+
+end
+
+# setup :test task to minitest
+# Rake libs default is lib
+# libs << path to load test_helper, etc..
+Rake::TestTask.new do |t|
+  t.libs << "tests/spec"
+  t.pattern     = "tests/spec/**/*_spec.rb"
+  t.test_files =  FileList["tests/spec/**/*_spec.rb"]
+  t.verbose     = true
 end

data/app/models/impressionist/impressionable.rb

@@ -32,10 +32,10 @@ module Impressionist
       options[:filter] == :all ? imps.count : imps.count(options[:filter], :distinct => true)
     end
 
-    def update_impressionist_counter_cache 
+    def update_impressionist_counter_cache
       slave = Impressionist::UpdateCounters.new(self)
       slave.update
-    end 
+    end
 
     def impressionable?
       true

data/impressionist.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.authors       = ['johnmcaliley']
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec,test_app/spec}/*`.split("\n")
+  s.test_files    = `git ls-files -- tests/**/*`.split("\n")
   s.require_path  = 'lib'
   s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
 
@@ -26,11 +26,12 @@ Gem::Specification.new do |s|
   # Capybara has dropped support for Ruby 1.8.7 onwards version 2.0.3
   s.add_development_dependency 'capybara', '>= 2.0.3'
   s.add_development_dependency 'rake', '>= 0.9'
-  s.add_development_dependency 'rails', '~> 3.1'
+  s.add_development_dependency 'rails', '3.2.12'
   s.add_development_dependency 'rdoc', '>= 2.4.2'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'systemu'
-
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-rails'
 end

data/lib/impressionist/engine.rb

@@ -1,17 +1,10 @@
-require "impressionist"
-require "rails"
-
 module Impressionist
-  class Engine < Rails::Engine
+  class Engine < ::Rails::Engine
     attr_accessor :orm
 
-  def initialize
-    define_orm_type(Impressionist.orm)
-  end
-
   initializer 'impressionist.model' do |app|
-    require_and_include_orm
-
+    @orm = Impressionist.orm
+    include_orm
   end
 
 
@@ -26,22 +19,12 @@ module Impressionist
 
 
  private
-  def require_and_include_orm
-    require "#{root}/app/models/impressionist/impressionable.rb"
-    require "impressionist/models/#{orm}/impression.rb"
-    require "impressionist/models/#{orm}/impressionist/impressionable.rb"
-
-  end
-
-  def define_orm_type(str)
-    @orm = matcher(str.to_s)
-  end
-
-  def matcher(str)
-    matched = str.match(/active_record|mongo_mapper|mongoid|/)
-    matched[0]
-  end
 
+    def include_orm
+      require "#{root}/app/models/impressionist/impressionable.rb"
+      require "impressionist/models/#{orm}/impression.rb"
+      require "impressionist/models/#{orm}/impressionist/impressionable.rb"
+    end
 
   end
 end

data/lib/impressionist/load.rb

@@ -1,7 +1,9 @@
-require "impressionist/engine"
+require 'impressionist/engine'
 
-require "impressionist/set_up_association"
+require 'impressionist/setup_association'
 
-require "impressionist/counter_cache"
+require 'impressionist/counter_cache'
 
-require "impressionist/update_counters"
+require 'impressionist/update_counters'
+
+require 'impressionist/rails_toggle'

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

@@ -1,12 +1,15 @@
 # Responsability
+## See CounterCache TODO: extract it into a class
 # * be able to update_counters
 # * log an error if imps_id and imps_type can not be found
-# asks updatable? whether it may or may not be updated
+# * asks updatable? whether it may or may not be updated
 # FIX exeception raising when no imps_id is found
 
 class Impression < ActiveRecord::Base
+
   include Impressionist::CounterCache
-  include Impressionist::SetUpAssociation
+  # sets belongs_to and attr_accessible
+  Impressionist::SetupAssociation.new(self).set
 
   after_save :impressionable_counter_cache_updatable?
 

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

@@ -1,13 +1,15 @@
+##
+# see active_record/impression.rb
+# same doc applies to here
 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
+  include Impressionist::CounterCache
+  Impressionist::SetupAssociation.new(self).set
 
+  field :impressionable_id
+  field :impressionable_type
   field :user_id
   field :controller_name
   field :action_name
@@ -18,15 +20,6 @@ class Impression
   field :message
   field :referrer
 
-  set_callback(:create, :after) do |doc|
-    unless impressionable_id.nil?
-      impressionable_class = doc.impressionable_type.constantize
+  after_save :impressionable_counter_cache_updatable?
 
-      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

@@ -7,37 +7,25 @@ module Impressionist
     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
+        define_association
+        @impressionist_cache_options = options
 
-      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
+        true
       end
 
-      def impressionist_counter_caching?
-        impressionist_counter_cache_options.present?
-      end
+        private
+          def define_association
+            has_many(:impressions,
+            :as => :impressionable,
+            :dependent => :destroy)
+          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
 
+    ##
+    # Overides active_record impressionist_count
     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])
@@ -45,13 +33,6 @@ module Impressionist
       filter == :all ? imps.count : imps.where(filter.ne => nil).distinct(filter).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/rails_toggle.rb

@@ -0,0 +1,22 @@
+module Impressionist
+  # Responsability
+  # Toggles between rails > 3.1 < 4
+  # In order to make attr_accessible available in a rails app < 4
+
+  class RailsToggle
+    # decides where or not to include attr_accessible
+    def should_include?
+      ask_rails || false
+    end
+
+    private
+
+      # returns false if rails >= 4
+      # true if rails < 4
+      def ask_rails
+        ::Rails::VERSION::MAJOR.to_i >= 4 ? false : true
+      end
+
+  end
+
+end

data/lib/impressionist/setup_association.rb

@@ -0,0 +1,48 @@
+module Impressionist
+  # Impressionist::SetupAssociation.new(entity).set
+  class SetupAssociation
+    def initialize(receiver)
+      @receiver = receiver
+    end
+
+    # True or False
+    # Note toggle returns false if rails >= 4
+    def include_attr_acc?
+      toggle && make_accessible
+    end
+
+    def define_belongs_to
+      receiver.belongs_to(:impressionable, :polymorphic => true)
+    end
+
+    # returns done if thruthy
+    def set
+      :done if (include_attr_acc? && define_belongs_to)
+    end
+
+    private
+      attr_reader :receiver, :toggle
+
+      def make_accessible
+       receiver.
+        attr_accessible(:impressionable_type,
+                        :impressionable_id,
+                        :controller_name,
+                        :request_hash,
+                        :session_hash,
+                        :action_name,
+                        :ip_address,
+                        :view_name,
+                        :referrer,
+                        :message,
+                        :user_id)
+      end
+
+      def toggle
+        t = RailsToggle.new
+        t.should_include?
+      end
+  end
+end
+
+

data/lib/impressionist/version.rb

@@ -1,3 +1,3 @@
 module Impressionist
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/tests/README

@@ -0,0 +1 @@
+Impressionist uses MiniTest

data/tests/spec/minitest_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname __FILE__)
+
+require "minitest/autorun"
+require "minitest/pride"

data/tests/spec/rails_toggle_spec.rb

@@ -0,0 +1,26 @@
+# Responsability
+  # Test whether rails version > 4
+  # includes attr_accessible if < 4
+require 'minitest_helper'
+require 'impressionist/rails_toggle'
+
+module Impressionist
+  describe RailsToggle do
+
+    before {
+      @toggle = RailsToggle.new
+    }
+
+    describe "Rails 4" do
+
+      # see your_minitest_path/lib/minitest/mock.rb
+      it "must not include attr_accessible" do
+        @toggle.stub :ask_rails, false do
+          refute @toggle.should_include?
+        end
+      end
+
+    end
+
+  end
+end

data/tests/spec/setup_association_spec.rb

@@ -0,0 +1,55 @@
+require 'minitest_helper'
+require 'impressionist/setup_association'
+
+module Impressionist
+  describe SetupAssociation do
+
+    let(:mock)  { Minitest::Mock.new }
+    let(:set_up) { SetupAssociation.new(mock) }
+
+    before do
+      # expects attr_accessible to return true
+      # and pass 11 arguments
+      mock.
+        expect(:attr_accessible, true) do |args|
+          args.size == 11
+        end
+
+    end
+
+    describe "attr_accessible" do
+
+      it "includes" do
+        set_up.stub :toggle, true do
+          set_up.include_attr_acc?.must_equal true
+
+          mock.verify
+        end
+      end
+
+    end
+
+    describe "belongs_to" do
+
+      it "active_record" do
+        mock.expect(:belongs_to, true, [Symbol, Hash])
+        set_up.define_belongs_to.must_equal true
+      end
+
+    end
+
+    describe "#set" do
+
+      it "sets an association" do
+        def set_up.include_attr_acc?; true; end
+
+        set_up.stub(:define_belongs_to, true) {
+          set_up.set.must_equal :done
+        }
+
+      end
+
+    end
+
+  end
+end