santey_view 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alexander Shamne
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= Rails santey_view plugin based on acts_as_viewed
+
+rails generate santey_view
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Alexander Shamne. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "santey_view"
+    gem.summary = %Q{Views count gem}
+    gem.description = %Q{longer description of your gem}
+    gem.email = "alexander.shamne@gmail.com"
+    gem.homepage = "http://github.com/shamne/santey_view"
+    gem.authors = ["Alexander Shamne"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "santey_view #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/generators/santey_view_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+
+class SanteyViewGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+  end
+  
+  def self.next_migration_number(dirname)
+    Time.now.strftime("%Y%m%d%H%M%S")
+  end
+  
+  # copy migrations to db/migrate
+  def install_migrations
+    migration_template "migrations/viewings.rb", File.join('db/migrate', "viewings.rb")
+  end
+  
+end

data/lib/generators/templates/migrations/viewings.rb

@@ -0,0 +1,18 @@
+class Viewings < ActiveRecord::Migration
+  def self.up
+    create_table :viewings do |t|
+      t.column :viewer_id,   :integer
+      t.column :viewed_id,   :integer
+      t.column :viewed_type, :string
+      t.column :ip, :string, :limit => '24'
+      t.column :created_at, :datetime
+    end
+    
+    add_index :viewings, [:viewer_id], :name => "index_viewings"
+    add_index :viewings, [:viewed_type, :viewed_id], :name => "index_viewings_viewed"
+  end
+
+  def self.down
+    drop_table :viewings
+  end
+end

data/lib/santey_view.rb

@@ -0,0 +1,7 @@
+module SanteyView
+
+  autoload :Viewable, 'santey_view/viewable'
+
+end
+
+require 'santey_view/engine'

data/lib/santey_view/engine.rb

@@ -0,0 +1,20 @@
+require "active_record"
+
+require "santey_view"
+require "rails"
+
+
+module SanteyView
+  class Engine < Rails::Engine
+    
+    #config.after_initialize do
+    #  ActiveRecord::Base.send :include, SanteyView::Viewable
+    #end
+    
+  end
+end
+
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, SanteyView::Viewable
+end

data/lib/santey_view/viewable.rb

@@ -0,0 +1,165 @@
+module SanteyView
+  module Viewable
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+
+        def santey_view(options = {})
+          # don't allow multiple calls
+          return if self.included_modules.include?(SanteyView::Viewable::ViewMethods)
+          include SanteyView::Viewable::ViewMethods
+          
+          viewing_class = options[:viewing_class] || 'Viewing'
+          viewer_class  = options[:viewer_class]  || 'User'
+
+          unless Object.const_defined?(viewing_class)
+            Object.class_eval <<-EOV
+              class #{viewing_class} < ActiveRecord::Base
+                belongs_to :viewed, :polymorphic => true
+              end
+            EOV
+            if Object.const_defined?(viewer_class)
+              Object.class_eval <<-EOV
+                class #{viewing_class} < ActiveRecord::Base
+                  belongs_to :viewer, :class_name => #{viewer_class}, :foreign_key => :viewer_id
+                end
+              EOV
+            end
+          end
+          
+          write_inheritable_attribute( :santey_view_options , 
+                                         { :viewing_class => viewing_class,
+                                           :viewer_class => viewer_class } )
+          class_inheritable_reader :santey_view_options
+          
+          class_eval do
+            has_many :viewings, :as => :viewed, :dependent => :delete_all, :class_name => viewing_class.to_s
+            if Object.const_defined?(viewer_class)
+              has_many(:viewers, :through => :viewings, :class_name => viewer_class.to_s)
+            end
+            before_create :init_viewing_fields
+          end
+
+          # Add to the Viewer a has_many viewings
+          if Object.const_defined?(viewer_class)
+            viewer_as_class = viewer_class.constantize
+            return if viewer_as_class.instance_methods.include?('find_in_viewings')
+            viewer_as_class.class_eval <<-EOS
+              has_many :viewings, :foreign_key => :viewer_id, :class_name => #{viewing_class.to_s}
+            EOS
+          end
+        end
+        
+        
+        
+        
+        def generate_viewings_columns table
+          table.column :views, :integer
+        end
+
+        # Create the needed columns for santey_view. 
+        # To be used during migration, but can also be used in other places.
+        def add_viewings_columns
+          if !self.content_columns.find { |c| 'views' == c.name }
+            self.connection.add_column table_name, :views, :integer, :default => '0'
+            self.reset_column_information
+          end            
+        end
+
+        # Remove the santey_view specific columns added with add_viewings_columns
+        # To be used during migration, but can also be used in other places
+        def remove_viewings_columns
+          if self.content_columns.find { |c| 'views' == c.name }
+            self.connection.remove_column table_name, :views
+            self.reset_column_information
+          end            
+        end
+
+        # Find all viewings for a specific viewer.
+        def find_viewed_by viewer        
+          viewing_class = santey_view_options[:viewing_class].constantize
+          if !(santey_view_options[:viewer_class].constantize === viewer)
+             raise ViewedError, "The viewer object must be the one used when defining santey_view (or a descendent of it). other objects are not acceptable" 
+          end
+          raise ViewedError, "Viewer must be a valid and existing object" if viewer.nil? || viewer.id.nil?
+          raise ViewedError, 'Viewer must be a valid viewer' if !viewing_class.column_names.include? "viewer_id"  
+          viewed_class = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+          conds = [ 'viewed_type = ? AND viewer_id = ?', viewed_class, viewer.id ]
+          santey_view_options[:viewing_class].constantize.find(:all, :conditions => conds).collect {|r| r.viewed_type.constantize.find_by_id r.viewed.id }
+        end
+      end
+
+      module ViewMethods
+      
+        def self.included(base) #:nodoc:
+          base.extend ClassMethods
+        end
+
+        # Is this object viewed already?
+        def viewed?
+          return (!self.views.nil? && self.views > 0) if attributes.has_key? 'views'
+          !viewings.find(:first).nil? 
+        end
+        
+        # Get the number of viewings for this object based on the views field, 
+        # or with a SQL query if the viewed objects doesn't have the views field
+        def view_count
+          return self.views || 0 if attributes.has_key? 'views'
+          viewings.count 
+        end
+            
+        # View the object with or without a viewer - create new or update as needed
+        #
+        # * <tt>ip</tt> - the viewer ip
+        # * <tt>viewer</tt> - an object of the viewer class. Must be valid and with an id to be used. Or nil
+        def view ip, viewer = nil
+          # Sanity checks for the parameters
+          viewing_class = santey_view_options[:viewing_class].constantize
+          if viewer && !(santey_view_options[:viewer_class].constantize === viewer) 
+            raise ViewedError, "the viewer object must be the one used when defining santey_view (or a descendent of it). other objects are not acceptable"
+          end
+        
+          viewing_class.transaction do
+            if !viewed_by? ip, viewer
+              view = viewing_class.new              
+              view.viewer_id = viewer.id if viewer && !viewer.id.nil?
+              view.ip = ip
+              viewings << view
+              target = self if attributes.has_key? 'views'
+              target.views = ( (target.views || 0) + 1 ) if target 
+              view.save
+              target.save_without_validation if target
+              return true
+            else
+              return false
+            end
+          end
+        end
+
+        # Check if an item was already viewed by the given viewer
+        def viewed_by? ip, viewer = nil
+          if viewer && !viewer.nil? && !(santey_view_options[:viewer_class].constantize === viewer) 
+            raise ViewedError, "the viewer object must be the one used when defining santey_view (or a descendent of it). other objects are not acceptable"
+          end
+          if viewer && !viewer.id.nil? 
+            return viewings.count(:conditions => ["viewer_id = '#{viewer.id}' or ip = '#{ip}'"]) > 0
+          else
+            return viewings.count(:conditions => ["ip = '#{ip}'"]) > 0
+          end
+        end
+            
+        private
+
+        def init_viewing_fields #:nodoc:
+          if attributes.has_key? 'views'
+            self.views ||= 0 
+          end
+        end
+
+      end
+      
+  end
+end

data/santey_view.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{santey_view}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Shamne"]
+  s.date = %q{2010-06-20}
+  s.description = %q{longer description of your gem}
+  s.email = %q{alexander.shamne@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/santey_view_generator.rb",
+     "lib/generators/templates/migrations/viewings.rb",
+     "lib/santey_view.rb",
+     "lib/santey_view/engine.rb",
+     "lib/santey_view/viewable.rb",
+     "santey_view.gemspec",
+     "test/santey_view_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/shamne/santey_view}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Views count gem}
+  s.test_files = [
+    "test/santey_view_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/santey_view_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SanteyViewTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'santey_view'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: santey_view
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alexander Shamne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: longer description of your gem
+email: alexander.shamne@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/santey_view_generator.rb
+- lib/generators/templates/migrations/viewings.rb
+- lib/santey_view.rb
+- lib/santey_view/engine.rb
+- lib/santey_view/viewable.rb
+- santey_view.gemspec
+- test/santey_view_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/shamne/santey_view
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Views count gem
+test_files: 
+- test/santey_view_test.rb
+- test/test_helper.rb