subscribable 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord',       '3.2.12'
+gem 'rspec',              '~> 2.13.0'
+gem 'sqlite3'
+gem 'pry-debugger'
+gem 'activesupport'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marius Pop
+
+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,66 @@
+# Subscribable
+
+  This is a basic gem that allows different models to
+  subscribe/follow each other.
+
+  This gem is supported by American Honors. (http://americanhonor.org)
+
+## Example: A model instance can subscribe to another model instance
+
+      person = Person.new
+      group = Group.new
+
+      person.subscribe_to!(group)
+
+  Now your person has a collection of subscriptions that includes
+  a group.
+
+      person.subscriptions #=> [group]
+
+  What you do with this is up to you. You could create some sort
+  of activity feed based on subscriptions.
+
+##  Some additional helper methods:
+
+      person.subscribed_to?(group) #=> true
+
+      group.person_subscribers #=> [group]
+
+      person.delete_subscription_to!(group)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'subscribable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subscribable
+
+In your terminal run:
+
+    rails g subscribable:sub_relation
+
+Then make sure you run your migration:
+
+    rake db:migrate
+
+In order to make a model subscribable you need
+this code in your model:
+
+    include Subscribable::RelationAssigner
+
+    subscribable
+
+## 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/generators/subscribable/sub_relation_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+
+module Subscribable
+  module Generators
+    class SubRelationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_migration
+        migration_template 'sub_relation_migration.rb', 'db/migrate/create_sub_relation.rb'
+      end
+
+      def self.next_migration_number(path)
+        @migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i.to_s
+      end
+    end
+  end
+end

data/lib/generators/subscribable/templates/sub_relation_migration.rb

@@ -0,0 +1,15 @@
+class CreateSubRelation < ActiveRecord::Migration
+  def change
+    create_table :sub_relations do |t|
+      t.references :subscription, polymorphic: true
+      t.references :subscriber, polymorphic: true
+      t.string     :status
+      t.timestamps
+    end
+
+    add_index :sub_relations,
+      [:subscriber_id, :subscriber_type, :subscription_id, :subscription_type],
+      unique: true,
+      name: 'composite_subscribable_index'
+  end
+end

data/lib/subscribable/relation_assigner.rb

@@ -0,0 +1,94 @@
+require 'active_support/concern'
+require 'active_support'
+
+module Subscribable
+  module RelationAssigner
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def subscribable
+        has_many :subscribers, class_name: 'Subscribable::SubRelation', as: :subscription
+        has_many :subscriptions, class_name: 'Subscribable::SubRelation', as: :subscriber
+      end
+
+      def subscribable?
+        true
+      end
+    end
+
+    def subscribe_to!(actor)
+      sub = subscriptions.new
+      sub.subscription = actor
+      sub.save
+    end
+
+    def delete_subscription_to!(actor)
+      subscription = subscription_with(actor)
+      subscription.delete
+    end
+
+    def subscription_status_with(actor)
+      subscription = subscription_with(actor)
+      subscription.nil? ? 'no relationship' : subscription.status
+    end
+
+    def update_subscription_status!(actor, status)
+      subscription = subscription_with(actor)
+      subscription.status = status
+      subscription.save
+    end
+
+    def subscribed_to?(actor)
+      query = actor.subscribers.where(subscriber_id: id, subscriber_type: self.class.name)
+      query.empty? ? false : true
+    end
+
+    def respond_to?(method_name, include_all=false)
+      class_name = klass_name(method_name)
+      method_name.to_s.match('_subscri') ? class_name.constantize.respond_to?(:subscribable?) : super
+    end
+
+    def method_missing(method_name, *args, &block)
+      class_name = klass_name(method_name)
+      case method_name.to_s
+      when /_subscribers/
+        subscribers_query(method_name, class_name)
+      when /_subscriptions/
+        subscriptions_query(method_name, class_name)
+      else
+        super
+      end
+    end
+
+    private
+    def klass_name(value)
+      value = value.to_s.split('_')
+      value.pop
+      value.map{|name| name.capitalize}.join
+    end
+
+    def subscriptions_query(method_name, class_name)
+      self.class.define_method(method_name) do
+        Subscribable::SubRelation.where(
+          subscriber_id:      self.id,
+          subscriber_type:    self.class.name,
+          subscription_type:  class_name )
+      end
+      self.send(method_name)
+    end
+
+    def subscribers_query(method_name, class_name)
+      self.class.define_method(method_name) do
+        Subscribable::SubRelation.where(
+          subscription_type:  self.class.name,
+          subscription_id:    self.id,
+          subscriber_type:    class_name )
+      end
+      self.send(method_name)
+    end
+
+    def subscription_with(actor)
+      subscriptions.where(subscription_id: actor.id, subscription_type: actor.class.name).first
+    end
+  end
+end

data/lib/subscribable/sub_relation.rb

@@ -0,0 +1,6 @@
+module Subscribable
+  class SubRelation < ActiveRecord::Base
+    belongs_to :subscriber, polymorphic: true
+    belongs_to :subscription, polymorphic: true
+  end
+end

data/lib/subscribable/version.rb

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

data/lib/subscribable.rb

@@ -0,0 +1,2 @@
+require 'subscribable/relation_assigner'
+require 'subscribable/sub_relation'

data/spec/actor_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'fake_models/actor'
+
+describe 'Actor' do
+  let(:actor) { Actor.create!(name: 'George') }
+  let(:star) { Actor.create!(name: 'Mike') }
+
+  it 'responds to actor_subscribers' do
+    expect( actor.respond_to?(:actor_subscribers) ).to be_true
+  end
+
+  it 'responds to actor_subscriptions' do
+    expect( actor.respond_to?(:actor_subscriptions) ).to be_true
+  end
+
+  it 'has subscriptions' do
+    expect{ actor.subscriptions }.to_not raise_error(NoMethodError)
+  end
+
+  it 'has subscribers' do
+    expect{ actor.subscribers }.to_not raise_error(NoMethodError)
+  end
+
+  it 'is subscribable' do
+    expect( Actor.subscribable? ).to be_true
+  end
+
+  it 'subscribe(actor) subscribes to an actor' do
+    star.subscribe_to!(actor)
+    expect(actor.subscribers.size).to eq(1)
+  end
+
+  context 'existance of relationship' do
+    it 'subscribed_to?(actor) returns true' do
+      sub = star.subscriptions.new
+      sub.subscription = actor
+      sub.save
+      expect(star.subscribed_to?(actor)).to be_true
+    end
+
+    it 'subscribed_to?(actor) returns false' do
+      expect(star.subscribed_to?(actor)).to be_false
+    end
+ end
+
+  context 'without sub_relations' do
+    it 'can query subscribers from subscribable models' do
+      expect( actor.actor_subscribers ).to eq([])
+    end
+
+    it 'can query subscriptions from subscribable models' do
+      expect( actor.actor_subscriptions ).to eq([])
+    end
+  end
+
+  context 'with sub_relations' do
+    before do
+      sub = actor.subscriptions.new
+      sub.subscription = star
+      sub.save
+    end
+    it 'can query subscriptions from subscribable models' do
+      expect( actor.actor_subscriptions.size ).to eq(1)
+    end
+
+    it 'can query subscribers from subscribable models' do
+      expect( star.actor_subscribers.size ).to eq(1)
+    end
+  end
+
+  context 'relationship status' do
+    it 'has no relationship' do
+      expect( star.subscription_status_with(actor) ).to eq('no relationship')
+    end
+
+    it 'has friendship relationship' do
+      sub = star.subscriptions.new
+      sub.subscription = actor
+      sub.status = 'friendship'
+      sub.save
+      expect( star.subscription_status_with(actor) ).to eq('friendship')
+    end
+  end
+
+  it 'updates subscription status' do
+    sub = star.subscriptions.new
+    sub.subscription = actor
+    sub.status = 'pending'
+    sub.save
+    star.update_subscription_status!(actor, 'friendship')
+    sub = star.subscriptions.where(subscription_id: actor.id, subscription_type: actor.class.name).first
+    expect(sub.status).to eq('friendship')
+  end
+
+  it 'delete subscription to actor' do
+    star.subscribe_to!(actor)
+    star.delete_subscription_to!(actor)
+    expect(star.subscribed_to?(actor)).to be_false
+  end
+end

data/spec/fake_models/actor.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+require 'subscribable'
+
+class Actor < ActiveRecord::Base
+  include Subscribable::RelationAssigner
+  subscribable
+end

data/spec/relation_assigner_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'fake_models/actor'
+
+describe 'Relation Assigner' do
+
+  let(:actor) { Actor.create(name: 'Marius') }
+  let(:actor2) { Actor.create(name: 'Quad') }
+
+  it 'allows saving subscribable models' do
+    sub = actor.subscriptions.new
+    sub.subscriber = actor2
+    expect{ sub.save}.to_not raise_error
+  end
+
+  it 'allows saving unique subscribable models only' do
+    sub = actor.subscriptions.new
+    sub.subscription = actor2
+    sub.save
+
+    sub2 = actor.subscriptions.new
+    sub2.subscription = actor2
+    expect{ sub2.save }.to raise_error(ActiveRecord::RecordNotUnique)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+
+RSpec.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+class CreateActors < ActiveRecord::Migration
+  def self.up
+    create_table :actors do |t|
+      t.string :name
+    end
+
+    create_table :sub_relations do |t|
+      t.references :subscription, polymorphic: true
+      t.references :subscriber, polymorphic: true
+      t.string     :status
+      t.timestamps
+    end
+
+    add_index :sub_relations,
+      [:subscriber_id, :subscriber_type, :subscription_id, :subscription_type],
+      unique: true,
+      name: 'composite_subscribable_index'
+  end
+end
+
+catch_output = CreateActors.up

data/subscribable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subscribable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "subscribable"
+  spec.version       = Subscribable::VERSION
+  spec.authors       = ["Marius Pop"]
+  spec.email         = ["marius@mlpinit.com"]
+  spec.description   = %q{ Groups, Users, or other models can subscribe to each other.}
+  spec.summary       = %q{ A way models can subscribe to each other.}
+  spec.homepage      = ""
+  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"
+
+  spec.add_dependency 'activerecord'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: subscribable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marius Pop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Groups, Users, or other models can subscribe to each other.'
+email:
+- marius@mlpinit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/subscribable/sub_relation_generator.rb
+- lib/generators/subscribable/templates/sub_relation_migration.rb
+- lib/subscribable.rb
+- lib/subscribable/relation_assigner.rb
+- lib/subscribable/sub_relation.rb
+- lib/subscribable/version.rb
+- spec/actor_spec.rb
+- spec/fake_models/actor.rb
+- spec/relation_assigner_spec.rb
+- spec/spec_helper.rb
+- subscribable.gemspec
+homepage: ''
+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: A way models can subscribe to each other.
+test_files:
+- spec/actor_spec.rb
+- spec/fake_models/actor.rb
+- spec/relation_assigner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: