impressionist 1.0.1 → 1.1.0

data/app/models/impressionist/impressionable.rb

@@ -1,20 +1,11 @@
 module Impressionist
   module Impressionable
-
-    def self.included(base)
-      base.extend ClassMethods
-      base.send(:include, InstanceMethods)
-    end
+    extend ActiveSupport::Concern
 
     module ClassMethods
       attr_accessor :cache_options
       @cache_options = nil
 
-      def is_impressionable(options={})
-        has_many :impressions, :as=>:impressionable
-        @cache_options = options[:counter_cache]
-      end
-
       def counter_cache_options
         if @cache_options
           options = { :column_name => :impressions_count, :unique => false }
@@ -28,44 +19,41 @@ module Impressionist
       end
     end
 
-    module InstanceMethods
-      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.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
-      end
+    def impressionable?
+      true
+    end
 
-      def update_counter_cache
-        cache_options = self.class.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)
+    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
+    end
 
-      # OLD METHODS - DEPRECATE IN V0.5
-      def impression_count(start_date=nil,end_date=Time.now)
-        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=>:all})
-      end
+    def update_counter_cache
+      cache_options = self.class.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)
+    end
 
-      def unique_impression_count(start_date=nil,end_date=Time.now)
-        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :request_hash})
-      end
+    # OLD METHODS - DEPRECATE IN V0.5
+    def impression_count(start_date=nil,end_date=Time.now)
+      impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=>:all})
+    end
 
-      def unique_impression_count_ip(start_date=nil,end_date=Time.now)
-        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :ip_address})
-      end
+    def unique_impression_count(start_date=nil,end_date=Time.now)
+      impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :request_hash})
+    end
 
-      def unique_impression_count_session(start_date=nil,end_date=Time.now)
-        impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :session_hash})
-      end
+    def unique_impression_count_ip(start_date=nil,end_date=Time.now)
+      impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :ip_address})
     end
 
+    def unique_impression_count_session(start_date=nil,end_date=Time.now)
+      impressionist_count({:start_date=>start_date, :end_date=>end_date, :filter=> :session_hash})
+    end
   end
 end

data/impressionist.gemspec

@@ -1,70 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+require File.expand_path('../lib/impressionist/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{impressionist}
-  s.version = "1.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["cowboycoded"]
-  s.date = %q{2011-11-30}
-  s.description = %q{Log impressions from controller actions or from a model}
-  s.email = %q{john.mcaliley@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    "CHANGELOG.rdoc",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "app/controllers/impressionist_controller.rb",
-    "app/models/impression.rb",
-    "app/models/impressionist/bots.rb",
-    "app/models/impressionist/impressionable.rb",
-    "config/routes.rb",
-    "impressionist.gemspec",
-    "lib/generators/impressionist/impressionist_generator.rb",
-    "lib/generators/impressionist/templates/create_impressions_table.rb",
-    "lib/impressionist.rb",
-    "lib/impressionist/bots.rb",
-    "lib/impressionist/engine.rb",
-    "lib/impressionist/railties/tasks.rake",
-    "logo.png",
-    "upgrade_migrations/version_0_3_0.rb",
-    "upgrade_migrations/version_0_4_0.rb"
-  ]
-  s.homepage = %q{http://github.com/cowboycoded/impressionist}
+  s.add_dependency 'httpclient', '~> 2.2'
+  s.add_dependency 'nokogiri', '~> 1.5'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'rake', '>= 0.9'
+  s.add_development_dependency 'rails', '~>3.1'
+  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.authors = ["johnmcaliley"]
+  s.description = "Log impressions from controller actions or from a model"
+  s.email = "john.mcaliley@gmail.com"
+  s.files = `git ls-files`.split("\n")
+  s.homepage = "https://github.com/charlotte-ruby/impressionist"
   s.licenses = ["MIT"]
+  s.name = "impressionist"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Easy way to log impressions}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.summary = "Easy way to log impressions"
+  s.test_files = `git ls-files -- test_app/*`.split("\n")
+  s.version = Impressionist::VERSION
 end
-

data/lib/generators/active_record/impressionist_generator.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module Generators
+    class ImpressionistGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def self.next_migration_number(dirname)
+        sleep 1
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'create_impressions_table.rb', 'db/migrate/create_impressions_table.rb'
+      end
+    end
+  end
+end

data/lib/generators/{impressionist → active_record}/templates/create_impressions_table.rb

@@ -24,14 +24,6 @@ class CreateImpressionsTable < ActiveRecord::Migration
   end
 
   def self.down
-    remove_index :impressions, :name => :poly_request_index
-    remove_index :impressions, :name => :poly_ip_index
-    remove_index :impressions, :name => :poly_session_index
-    remove_index :impressions, :name => :controlleraction_request_index
-    remove_index :impressions, :name => :controlleraction_ip_index
-    remove_index :impressions, :name => :controlleraction_session_index
-    remove_index :impressions, :user_id
-
     drop_table :impressions
   end
-end
+end

data/lib/generators/impressionist_generator.rb

@@ -0,0 +1,12 @@
+module Impressionist
+  module Generators
+    class ImpressionistGenerator < Rails::Generators::Base
+      hook_for :orm
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config_file
+        template 'impression.rb', 'config/initializers/impression.rb'
+      end
+    end
+  end
+end

data/lib/generators/mongo_mapper/impressionist_generator.rb

@@ -0,0 +1,8 @@
+module MongoMapper
+  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

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

data/lib/impressionist.rb

@@ -1,5 +1,12 @@
-IMPRESSIONIST_PATH = File.dirname(__FILE__) + "/impressionist"
-require "#{IMPRESSIONIST_PATH}/engine.rb"
+require "impressionist/engine.rb"
 
 module Impressionist
-end
+  # Define ORM
+  mattr_accessor :orm
+  @@orm = :active_record
+
+  # Load configuration from initializer
+  def self.setup
+    yield self
+  end
+end

data/lib/impressionist/bots.rb

@@ -15,4 +15,4 @@ module Impressionist
       list
     end
   end
-end
+end

data/lib/impressionist/engine.rb

@@ -3,8 +3,16 @@ require "rails"
 
 module Impressionist
   class Engine < Rails::Engine
-    initializer 'impressionist.extend_ar' do |app|
-      ActiveRecord::Base.send(:include, Impressionist::Impressionable)
+    initializer 'impressionist.model' do |app|
+      if Impressionist.orm == :active_record
+        require "impressionist/models/active_record/impression.rb"
+        require "impressionist/models/active_record/impressionist/impressionable.rb"
+        ActiveRecord::Base.send(:include, Impressionist::Impressionable)
+      elsif Impressionist.orm == :mongo_mapper
+        require "impressionist/models/mongo_mapper/impression.rb"
+        require "impressionist/models/mongo_mapper/impressionist/impressionable.rb"
+        MongoMapper::Document.plugin Impressionist::Impressionable
+      end
     end
 
     initializer 'impressionist.controller' do
@@ -14,4 +22,4 @@ module Impressionist
       end
     end
   end
-end
+end

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

@@ -0,0 +1,18 @@
+class Impression < ActiveRecord::Base
+  attr_accessible :impressionable_type, :impressionable_id, :user_id,
+  :controller_name, :action_name, :view_name, :request_hash, :ip_address,
+  :session_hash, :message, :referrer
+
+  after_save :update_impressions_counter_cache
+
+  private
+
+  def update_impressions_counter_cache
+    impressionable_class = self.impressionable_type.constantize
+
+    if impressionable_class.counter_cache_options
+      resouce = impressionable_class.find(self.impressionable_id)
+      resouce.try(:update_counter_cache)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Impressionist
+  module Impressionable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def is_impressionable(options={})
+        has_many :impressions, :as => :impressionable, :dependent => :destroy
+        @cache_options = options[:counter_cache]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+class Impression
+  include MongoMapper::Document
+
+  key :impressionable_type, String
+  key :impressionable_id, String
+  key :user_id, String
+  key :controller_name, String
+  key :action_name, String
+  key :view_name, String
+  key :request_hash, String
+  key :ip_address, String
+  key :session_hash, String
+  key :message, String
+  key :referrer, String
+
+  timestamps!
+end

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

@@ -0,0 +1,12 @@
+module Impressionist
+  module Impressionable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def is_impressionable(options={})
+        many :impressions, :as => :impressionable, :dependent => :destroy
+        @cache_options = options[:counter_cache]
+      end
+    end
+  end
+end

data/lib/impressionist/version.rb

@@ -0,0 +1,3 @@
+module Impressionist
+  VERSION = "1.1.0"
+end

data/test_app/.gitignore

@@ -0,0 +1,17 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+/Gemfile.lock
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/coverage
+/log/*.log
+/tmp

data/test_app/.rspec

@@ -0,0 +1 @@
+--color

data/test_app/Gemfile

@@ -0,0 +1,58 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.2'
+
+gem 'impressionist', :path => '../'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+  gem 'jruby-openssl'
+end
+
+platforms :ruby, :mswin, :mingw do
+  gem 'sqlite3'
+end
+
+gem 'json'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+group :development, :test do
+  gem 'autotest-notification'
+  gem 'rspec-rails'
+  gem 'spork'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'simplecov'
+  gem 'systemu'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'