my_feeds 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jjy
+
+MIT License
+
+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.md

@@ -0,0 +1,174 @@
+# MyFeeds
+
+-------------------------------------
+Help you implement feeds / timeline in rails application.
+
+## Installation
+
+------------------------------------
+Add this line to your application's Gemfile:
+
+    gem 'my_feeds'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install my_feeds
+
+## Usage
+
+------------------------------------
+
+####before usage
+my_feeds need three type model at least
+
+`feeder`, `eater` and associate model
+
+feeder publish feeds
+
+eater receive publish
+
+and associate model create a relation between feeder and eater
+
+yes, like subscribe and publish
+
+####feed model
+feed model is what feeder published and  eater subscribed, you can customize it.
+
+`rails generate my_feeds`
+
+####associate model
+
+`rails generate my_feeds:likes`
+#####use own associate model
+you can also use your own associate model.
+
+just make sure your model have a polymorphic field for feeder.
+
+and
+```
+class YourModel < 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
+
+  belongs_to :xxx, polymorphic: true
+end
+```
+
+####feeder
+
+include MyFeeds::Feeder in your model which will as feed source
+
+```ruby
+class User < ActiveRecord::Base
+  ...
+  include MyFeeds::Feeder
+  ...
+end
+```
+
+now `User` get a method `define_feed_event`
+
+use `define_feed_event` define your feed_event
+```ruby
+class User < ActiveRecord::Base
+  ...
+  include MyFeeds::Feeder
+
+  define_feed_event :hahahaha
+  define_feed_event :kakakaka
+  ...
+end
+
+#in you rails console
+user = User.create ...
+
+#user get a method hahahaha...
+#will create 3 feeds
+user.hahahaha
+user.hahahaha
+user.hahahaha
+
+#you can use source_feeds associate fetch your source feeds
+user.source_feeds.count  #=> 3
+
+#or scoped version
+user.hahahaha_feeds.count #=> 3
+user.kakakaka_feeds.count #=> 0
+
+#you can pass extra arguments to feed_event method, but must match feed model attributes
+user.hahahaha target_id: another_user.id, target_type: another_user.class
+
+user.source_feeds.last.target_id #=> another_user.id
+
+#you can also passed arguments with define_feed_event, then arguments will be default
+...
+  define_feed_event :hahahaha, target_type: User
+...
+
+user.hahahaha target_id: another_user.id
+user.source_feeds.last.target_type #=> User
+```
+
+####eater
+include MyFeeds::Eater in your model which will as feed receiver
+
+```ruby
+class User < ActiveRecord::Base
+  ...
+  include MyFeeds::Eater
+  has_many :likes #a eater must have associate with feeder
+
+  def feeds
+    #eater have method feeds_for, pass associate and return feeds
+    feeds_for likes
+  end
+  ...
+end
+
+##sample
+#create relation
+u = User.create
+like = u.likes.new
+like.likeable = another_user
+like.save
+like = u.likes.new
+like.likeable = Post.find ...
+like.save
+u.feeds #=> you get feeds
+
+
+##feeds with scope??
+class User < ActiveRecord::Base
+  ...
+  include MyFeeds::Eater
+  has_many :likes #a eater must have associate with feeder
+
+  def feeds
+    #eater have method feeds_for, pass associate and return feeds
+    feeds_for likes
+  end
+
+  def teams_feeds
+    feeds_for likes.where(likeable_type: Team)
+  end
+
+  def users_posts_feeds
+    feeds_for(likes.where likeable_type: User).where(target_type: Post)
+  end
+  ...
+end
+```
+
+## Contributing
+
+-------------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/my_feeds.rb

@@ -0,0 +1,7 @@
+require "my_feeds/version"
+
+module MyFeeds
+  autoload :Feeder, 'my_feeds/feeder'
+  autoload :Eater, 'my_feeds/eater'
+  autoload :Identify, 'my_feeds/identify'
+end

data/lib/my_feeds/eater.rb

@@ -0,0 +1,9 @@
+module MyFeeds
+  module Eater
+    extend ActiveSupport::Concern
+
+    def feeds_for scope
+      Feed.where source_identify: scope.select(scope.klass.polymorphic_identify_column)
+    end
+  end
+end

data/lib/my_feeds/feeder.rb

@@ -0,0 +1,23 @@
+module MyFeeds
+  module Feeder
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :source_feeds, class_name: Feed.to_s, as: :source, dependent: :destroy
+    end
+
+    module ClassMethods
+      def define_feed_event event, conditions = {}
+        conditions.freeze
+        define_method(event) do |options = {}|
+          attributes = {source_type: self.class.to_s, source_id: self.id, event: event}.merge!(conditions).merge! options
+          Feed.create attributes
+        end
+
+        define_method("#{event}_feeds") do
+          source_feeds.where({event: event}.merge! conditions)
+        end
+      end
+    end
+  end
+end

data/lib/my_feeds/identify.rb

@@ -0,0 +1,36 @@
+module MyFeeds
+  module Identify
+    extend ActiveSupport::Concern
+
+    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"
+    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
+        self.to_s.underscore
+      end
+
+      def polymorphic_identify_column
+        :"#{feed_polymorphic_name}_identify"
+      end
+
+      def polymorphic_id_column
+        :"#{feed_polymorphic_name}_id"
+      end
+
+      def polymorphic_type_column
+        :"#{feed_polymorphic_name}_type"
+      end
+    end
+  end
+end

data/lib/my_feeds/version.rb

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

data/lib/rails/generators/my_feeds/likes_generator.rb

@@ -0,0 +1,29 @@
+module MyFeeds
+  module Generators
+    class LikesGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), '../templates')
+      end
+
+      def create_migration_file
+        migration_template 'likes_migration.rb', 'db/migrate/likes_migration.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        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_model
+        template "like_model.rb", File.join('app/models', "like.rb")
+      end
+    end
+  end
+end
+

data/lib/rails/generators/my_feeds_generator.rb

@@ -0,0 +1,28 @@
+module MyFeeds
+  module Generators
+    class MyFeedsGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/my_feeds_migration.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        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_model
+        template "model.rb", File.join('app/models', "feed.rb")
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+class LikesMigration < ActiveRecord::Migration
+  def change
+    create_table :likes do |t|
+      #this table must have xxx_identify, xxx_id, xxx_type 3 columns
+      t.string :likeable_identify, null: false
+      t.references :likeable, :polymorphic => true, :null => false
+
+      #you maybe need change this column
+      t.references :user
+
+      t.timestamps
+    end
+
+    #indexes
+    #add_index :likes, [:user_id, :likeable_id, :likeable_type], :unique => true
+    #add_index :likes, :user_id
+  end
+end

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

@@ -0,0 +1,18 @@
+class MyFeedsMigration < ActiveRecord::Migration
+  def change
+    create_table :feeds do |t|
+      #necessarily
+      t.references :source, :polymorphic => true, :null => false
+      t.string :source_identify, null: false
+      t.string :event, null: false
+
+      #not necessarily, but maybe you need
+      #you can also customize your columns
+      t.references :target, :polymorphic => true
+
+      t.timestamps
+    end
+
+    add_index :feeds, :source_identify
+  end
+end

data/lib/rails/generators/templates/model.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/my_feeds.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'my_feeds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "my_feeds"
+  spec.version       = MyFeeds::VERSION
+  spec.authors       = ["jjy"]
+  spec.email         = ["jjyruby@gmail.com"]
+  spec.description   = %q{Help you implement feeds / timeline in rails application.}
+  spec.summary       = %q{my_feeds provide feed model and some helper methods, allow you to customize.}
+  spec.homepage      = "https://github.com/jjyr/my_feeds"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: my_feeds
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- jjy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  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
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/my_feeds.rb
+- lib/my_feeds/eater.rb
+- lib/my_feeds/feeder.rb
+- lib/my_feeds/identify.rb
+- lib/my_feeds/version.rb
+- lib/rails/generators/my_feeds/likes_generator.rb
+- lib/rails/generators/my_feeds_generator.rb
+- lib/rails/generators/templates/like_model.rb
+- lib/rails/generators/templates/likes_migration.rb
+- lib/rails/generators/templates/migration.rb
+- lib/rails/generators/templates/model.rb
+- my_feeds.gemspec
+homepage: https://github.com/jjyr/my_feeds
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+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: []