my_feeds 0.0.1 → 0.1.0

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
+gem 'rspec'
+gem 'sqlite3'
+
 # Specify your gem's dependencies in my_feeds.gemspec
 gemspec

data/README.md

@@ -1,11 +1,9 @@
 # MyFeeds
 
--------------------------------------
 Help you implement feeds / timeline in rails application.
 
 ## Installation
 
-------------------------------------
 Add this line to your application's Gemfile:
 
     gem 'my_feeds'
@@ -20,12 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-------------------------------------
 
 ####before usage
-my_feeds need three type model at least
-
-`feeder`, `eater` and associate model
+my_feeds need `feeder`, `eater` and associate model
 
 feeder publish feeds
 
@@ -50,12 +45,17 @@ just make sure your model have a polymorphic field for feeder.
 
 and
 ```
-class YourModel < ActiveRecord::Base
+class YourCustomModel < ActiveRecord::Base
   include MyFeeds::Identify #make sure include this module
-  self.feed_polymorphic_name = :xxx #and set this, in this case is xxx, same with polymorphic belongs_to
+  self.feed_polymorphic = :likeable #and set this, in this case is likeable, it should same as the polymorphic belongs_to
 
-  belongs_to :xxx, polymorphic: true
+  #same as self.feed_polymorphic
+  belongs_to :likeable, polymorphic: true
 end
+
+# you should create a migration like below
+# in this case, this column name is likeable_identify, it depends on feed_polymorphic
+#add_column :your_customs, :likeable_identify, :string, null: false
 ```
 
 ####feeder
@@ -165,7 +165,6 @@ end
 
 ## Contributing
 
--------------------
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/my_feeds/identify.rb

@@ -4,32 +4,39 @@ module MyFeeds
 
     included do
       before_save :save_feed_identify
-      class_attribute :feed_polymorphic_name
-      self.feed_polymorphic_name = self == Feed ? :source : default_feed_polymorphic_name
-      delegate :default_feed_polymorphic_name, :polymorphic_identify_column, :polymorphic_id_column, :polymorphic_type_column, to: :"self.class"
+      self.feed_polymorphic = self == Feed ? :source : default_feed_polymorphic
+      delegate :default_feed_polymorphic, :polymorphic_identify_column, :polymorphic_id_column, :polymorphic_type_column, to: :"self.class"
     end
 
-    protected
-    def save_feed_identify
-      instance_eval %Q{self.#{polymorphic_identify_column} = "#\{#{polymorphic_id_column}.to_s\}@#\{#{polymorphic_type_column}.to_s.underscore\}"}
-    end
-
-    private
     module ClassMethods
-      def default_feed_polymorphic_name
+      def feed_polymorphic
+        @_feed_polymorphic
+      end
+
+      def feed_polymorphic= polymorphic
+        @_feed_polymorphic = polymorphic
+        class_eval %Q{
+          def save_feed_identify
+            self.#{polymorphic_identify_column} = "#\{#{polymorphic_id_column}.to_s\}@#\{#{polymorphic_type_column}.to_s.underscore\}"
+          end
+          protected :save_feed_identify
+        }
+      end
+
+      def default_feed_polymorphic
         self.to_s.underscore
       end
 
       def polymorphic_identify_column
-        :"#{feed_polymorphic_name}_identify"
+        :"#{feed_polymorphic}_identify"
       end
 
       def polymorphic_id_column
-        :"#{feed_polymorphic_name}_id"
+        :"#{feed_polymorphic}_id"
       end
 
       def polymorphic_type_column
-        :"#{feed_polymorphic_name}_type"
+        :"#{feed_polymorphic}_type"
       end
     end
   end

data/lib/my_feeds/version.rb

@@ -1,3 +1,3 @@
 module MyFeeds
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/rails/generators/templates/like_model.rb

@@ -1,6 +1,6 @@
 class Like < ActiveRecord::Base
   include MyFeeds::Identify
-  self.feed_polymorphic_name = :likeable
+  self.feed_polymorphic = :likeable
   #attr_accessible
 
   belongs_to :likeable, polymorphic: true

data/spec/models/feed.rb

@@ -0,0 +1,10 @@
+class Feed < ActiveRecord::Base
+  include MyFeeds::Identify
+  attr_accessible :source_id, :source_type, :event, :target_id, :target_type
+
+  #verify event uniqueness
+  #validates :event, uniqueness: {scope: [:source_id, :source_type, :target_id, :target_type]}, :if => :target_id
+
+  belongs_to :source, polymorphic: true
+  belongs_to :target, polymorphic: true
+end

data/spec/models/like.rb

@@ -0,0 +1,7 @@
+class Like < ActiveRecord::Base
+  include MyFeeds::Identify
+  self.feed_polymorphic = :likeable
+  #attr_accessible
+
+  belongs_to :likeable, polymorphic: true
+end

data/spec/models/post.rb

@@ -0,0 +1,12 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+  attr_accessible :content, :title
+
+  include MyFeeds::Feeder
+
+  define_feed_event :content_update
+
+  before_update do
+    content_update
+  end
+end

data/spec/models/user.rb

@@ -0,0 +1,20 @@
+class User < ActiveRecord::Base
+  attr_accessible :name
+  has_many :posts
+  has_many :likes
+
+  include MyFeeds::Feeder
+  include MyFeeds::Eater
+
+  define_feed_event :write_post, target_type: Post.to_s
+  define_feed_event :write_some_code
+
+  def post title, content
+    post = self.posts.create title: title, content: content
+    write_post target_id: post.id
+  end
+
+  def feeds
+    feeds_for likes
+  end
+end

data/spec/my_feeds_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe MyFeeds do
+  before :all do
+    @user1 = User.create name: 'jjyr'
+    @user2 = User.create name: 'writer'
+  end
+
+  describe MyFeeds::Feeder do
+    before :all do
+      @user2.write_some_code
+      @user2.post "i write a gem", "content is not important"
+    end
+
+    it "when call feed_event should create feed" do
+      @user2.source_feeds.count.should == 2
+      @user2.source_feeds.count.should == Feed.count
+      @user2.source_feeds.first.event.should == 'write_some_code'
+      @user2.source_feeds.last.event.should == 'write_post'
+    end
+
+    it "scope version source_feeds should work" do
+      @user2.write_some_code_feeds.count.should == 1
+      @user2.write_some_code_feeds.first.event.should == 'write_some_code'
+      @user2.write_post_feeds.count.should == 1
+      @user2.write_post_feeds.first.event.should == 'write_post'
+      (@user2.write_post_feeds.count + @user2.write_some_code_feeds.count).should == @user2.source_feeds.count
+    end
+  end
+
+
+  describe MyFeeds::Eater do
+    before :all do
+      @user1.feeds.count.should == 0
+      like = @user1.likes.new
+      like.likeable = @user2
+      like.save!
+    end
+
+    it "should have some feeds" do
+      @user1.feeds.count.should == Feed.count
+    end
+
+    it "feeds should change" do
+      @user2.posts.first.update_attributes content: "update"
+      @user1.feeds.count.should == Feed.count - 1
+      like = @user1.likes.new
+      like.likeable = @user2.posts.first
+      like.save!
+      @user1.feeds.count.should == Feed.count
+    end
+
+    it "scope should work" do
+      @user1.feeds_for(@user1.likes.where likeable_type: Post.to_s).count.should == @user1.feeds.where(source_type: Post.to_s).count
+      @user1.feeds_for(@user1.likes.where likeable_type: User.to_s).count.should == @user1.feeds.where(source_type: User.to_s).count
+    end
+
+    it "eater's feeds should match feeder's write_post_feeds" do
+      post_feeds = @user2.write_post_feeds.to_a
+      user_post_feeds = @user1.feeds.where(target_type: Post.to_s).to_a
+      post_feeds.count.should == user_post_feeds.count
+      user_post_feeds.each do |post|
+        post_feeds.should include(post)
+      end
+    end
+    
+    it "eater's feeds should match feeder's write_some_code_feeds" do
+      code_feeds = @user2.write_some_code_feeds.to_a
+      user_feeds = @user1.feeds.where(event: 'write_some_code').to_a
+      code_feeds.count.should == user_feeds.count
+      user_feeds.each do |feed|
+        code_feeds.should include(feed)
+      end
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,41 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "feeds", :force => true do |t|
+    t.integer  "source_id",       :null => false
+    t.string   "source_type",     :null => false
+    t.string   "source_identify", :null => false
+    t.string   "event",           :null => false
+    t.integer  "target_id"
+    t.string   "target_type"
+    t.datetime "created_at",      :null => false
+    t.datetime "updated_at",      :null => false
+  end
+
+  add_index "feeds", ["source_identify"], :name => "index_feeds_on_source_identify"
+
+  create_table "likes", :force => true do |t|
+    t.string   "likeable_identify", :null => false
+    t.integer  "likeable_id",       :null => false
+    t.string   "likeable_type",     :null => false
+    t.integer  "user_id"
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.string   "content"
+    t.integer  "user_id"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  add_index "posts", ["user_id"], :name => "index_posts_on_user_id"
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'active_record'
+require 'my_feeds'
+
+require 'models/feed'
+require 'models/like'
+require 'models/post'
+require 'models/user'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Migration.verbose = false
+load(File.dirname(__FILE__) + '/schema.rb')

metadata

@@ -1,48 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: my_feeds
 version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.1
 platform: ruby
 authors:
 - jjy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-11 00:00:00.000000000 Z
+date: 2013-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  prerelease: false
-  type: :development
-  name: bundler
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
-  type: :development
-  name: rake
 description: Help you implement feeds / timeline in rails application.
 email:
 - jjyruby@gmail.com
@@ -67,6 +67,13 @@ files:
 - lib/rails/generators/templates/migration.rb
 - lib/rails/generators/templates/model.rb
 - my_feeds.gemspec
+- spec/models/feed.rb
+- spec/models/like.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/my_feeds_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jjyr/my_feeds
 licenses:
 - MIT
@@ -92,4 +99,11 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: my_feeds provide feed model and some helper methods, allow you to customize.
-test_files: []
+test_files:
+- spec/models/feed.rb
+- spec/models/like.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/my_feeds_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb