jcnetdev-acts-as-readable 1.0.200807042

data/README

@@ -0,0 +1,54 @@
+ActsAsReadable
+==============
+
+ActsAsReadable allows you to create a generic relationship of items which can
+be marked as 'read' by users. This is useful for forums or any other kind of
+situation where you might need to know whether or not a user has seen a particular
+model.
+
+Installation
+============
+
+To install the plugin from git:
+
+script/plugin install git://github.com/jcnetdev/acts-as-readable.git
+
+To install the plugin from a gem, add this to our environment.rb:
+
+config.gem 'jcnetdev-acts-as-readable', :version => '>= 1.0',
+                                        :lib => 'acts_as_readable',
+                                        :source => 'http://gems.github.com'
+
+
+You will need the readings table to use this plugin. A generator has been included,
+simply type
+
+script/generate acts_as_readable_migration
+
+to get the standard migration created for you.
+
+Example
+=======
+
+class Post < ActiveRecord::Base
+  acts_as_readable
+end
+
+bob = User.find_by_name("bob")
+
+bob.readings                      # => []
+
+Post.find_unread_by(bob)          # => [<Post 1>,<Post 2>,<Post 3>...]
+Post.find_read_by(bob)            # => []
+
+Post.find(1).read_by?(bob)        # => false
+Post.find(1).read_by!(bob)        # => <Reading 1>
+Post.find(1).read_by?(bob)        # => true
+Post.find(1).users_who_read       # => [<User bob>]
+
+Post.find_unread_by(bob)          # => [<Post 2>,<Post 3>...]
+Post.find_read_by(bob)            # => [<Post 1>]
+
+bob.readings                      # => [<Reading 1>]
+
+Copyright (c) 2008 Michael Bleigh and Intridea, Inc. released under the MIT license

data/acts-as-readable.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = 'acts-as-readable'
+  s.version = '1.0.200807042'
+  s.date = '2008-07-04'
+  
+  s.summary = "Makes calling partials in views look better and more fun."
+  s.description = "Wrapper around render :partial that removes the need to use :locals, and allows blocks to be taken easily"
+  
+  s.authors = ['Michael Bleigh']
+  s.email = 'michael@intridea.com'
+  s.homepage = 'http://github.com/mbleigh/acts-as-readable'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+  
+  s.files = ["README",
+             "acts-as-readable.gemspec",
+             "generators/acts_as_readable_migration/acts_as_readable_migration_generator.rb",
+             "generators/acts_as_readable_migration/templates/migration.rb",
+             "init.rb",
+             "lib/acts-as-readable.rb",
+             "lib/reading.rb",
+             "lib/user_with_readings.rb",
+             "rails/init.rb"]
+
+end
+

data/generators/acts_as_readable_migration/acts_as_readable_migration_generator.rb

@@ -0,0 +1,11 @@
+class ActsAsReadableMigrationGenerator < Rails::Generator::Base 
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate' 
+    end 
+  end
+  
+  def file_name
+    "acts_as_readable_migration"
+  end
+end

data/generators/acts_as_readable_migration/templates/migration.rb

@@ -0,0 +1,14 @@
+class ActsAsReadableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :readings do |t|
+      t.string :readable_type
+      t.integer :readable_id
+      t.integer :user_id
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :readings
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/acts-as-readable.rb

@@ -0,0 +1,43 @@
+module ActiveRecord
+  module Acts
+    module Readable
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        def acts_as_readable
+          has_many :readings, :as => :readable
+          has_many :users_who_read, :through => :readings, :source => :user
+          
+          include ActiveRecord::Acts::Readable::InstanceMethods
+          extend  ActiveRecord::Acts::Readable::SingletonMethods
+        end
+      end
+      
+      module SingletonMethods
+        def find_unread_by(user)
+          find(:all) - find_read_by(user)
+        end
+        
+        def find_read_by(user)
+          find(:all, :conditions => ["readings.readable_id = #{table_name}.id AND readings.user_id=?", user.id], :include => :readings)
+        end
+      end
+      
+      module InstanceMethods
+        def read_by!(user)
+          readings << Reading.new(:user_id => user.id)
+        end
+        
+        def unread_by!(user)
+          readings.find(:first, :conditions => ["user_id = ?",user.id])
+        end
+        
+        def read_by?(user)
+          !!users_who_read.find(:first, :conditions => ["user_id = ?",user.id])
+        end
+      end
+    end
+  end
+end

data/lib/reading.rb

@@ -0,0 +1,7 @@
+class Reading < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :readable, :polymorphic => true
+  
+  validates_presence_of :user_id, :readable_id, :readable_type
+  validates_uniqueness_of :user_id, :scope => [:readable_id, :readable_type]
+end

data/lib/user_with_readings.rb

@@ -0,0 +1,3 @@
+User.class_eval do
+  has_many :readings
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'acts-as-readable'
+require 'reading'
+require 'user_with_readings'
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Readable

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: jcnetdev-acts-as-readable
+version: !ruby/object:Gem::Version 
+  version: 1.0.200807042
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+description: Wrapper around render :partial that removes the need to use :locals, and allows blocks to be taken easily
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- acts-as-readable.gemspec
+- generators/acts_as_readable_migration/acts_as_readable_migration_generator.rb
+- generators/acts_as_readable_migration/templates/migration.rb
+- init.rb
+- lib/acts-as-readable.rb
+- lib/reading.rb
+- lib/user_with_readings.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/acts-as-readable
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Makes calling partials in views look better and more fun.
+test_files: []
+