acts_as_subscribable 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,88 @@
+# acts_as_subscribable
+
+acts_as_subscribable is a small Rubygem that provides a high-level wrapper around `ActiveRecord::Base` to allow a model to 'subscribe' to another given model. This could be a `User` subscribing to a `Task` for example, or a `Member` subscribing to a `Thread` or even a `Watcher` subscribing to a `Channel`.
+
+It's essentially a glorified version of a `has_many :through` association, but it adds a few methods to make the lookups and searching a little easier and more readable.
+
+This is my first proper Rubygem so you'll have to bear with me on this one. If you've any suggestions of ways to improve the code, please feel free to contribute.
+
+**[acts_as_subscribable was kindly funded by the marvellous Mission Control task management.](http://missioncontrolhq.com)**
+
+## Synopsis
+
+```ruby
+class Todo < ActiveRecord::Base
+  acts_as_subscribable
+end
+```
+
+## Setup
+
+Add it to your Gemfile:
+
+```ruby
+gem 'acts_as_subscribable'
+```
+
+..and then `bundle install`. Once that's installed, we can run the built-in generator to generate our `Subscription` model, with an optional model name, subscribed foreign key and subscriber foreign key as parameters:
+
+```bash
+$ rails g acts_as_subscribable Subscription
+```
+
+This will generate our Subscription model with the appropriate migration. Run your migrations and add the `acts_as_subscribable` call to your model that you wish to be subscribable:
+
+```ruby
+class Todo < ActiveRecord::Base
+  acts_as_subscribable
+end
+```
+
+## Usage
+
+We now have our wrapper in place. We use a bunch of sane defaults; the subscriber model defaults to `User`, so we'll be subscribing `User`s to `Todo`s.
+
+```ruby
+ > t = Todo.first
+ > u = User.first
+ 
+ > t.subscribe u
+ 
+ > t.subscribed? u
+=> true
+ 
+ > t.subscribers
+=> [ #<User id: 1 ...> ]
+ 
+ > t.unsubscribe u
+ 
+ > t.subscribed? u
+=> false
+```
+
+## Where are the specs?
+
+I started writing a test suite, I promise! Just got too busy, and the metaprogramming stuff was too fiddly to test.
+
+## License
+
+Copyright (c) 2011 Jamie Rumbelow, http://jamierumbelow.net
+
+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/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/acts_as_subscribable.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_subscribable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_subscribable"
+  s.version     = ActsAsSubscribable::VERSION
+  s.authors     = ["Jamie Rumbelow"]
+  s.email       = ["jamie@jamierumbelow.net"]
+  s.homepage    = "https://github.com/jamierumbelow/acts_as_subscribable"
+  s.summary     = "Simplify adding user subscriptions to models"
+  s.description = <<-desc
+                    acts_as_subscribable is a loose wrapper around ActiveRecord to allow a basic user subscription model.
+                    acts_as_subscribable exposes a high-level set of methods that allow you to easily subscribe, unsubscribe
+                    and view subscribers to a model.
+                  desc
+
+  s.rubyforge_project = "acts_as_subscribable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_development_dependency "mocha"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/acts_as_subscribable.rb

@@ -0,0 +1,6 @@
+require "acts_as_subscribable/version"
+require "acts_as_subscribable/subscribable_methods"
+require "acts_as_subscribable/railtie"
+
+module ActsAsSubscribable
+end

data/lib/acts_as_subscribable/railtie.rb

@@ -0,0 +1,9 @@
+module ActsAsSubscribable
+  class Railtie < Rails::Railtie
+    initializer 'acts_as_subscribable.subscribable_methods' do
+      ActiveSupport.on_load :active_record do
+        extend SubscribableMethods
+      end
+    end
+  end
+end

data/lib/acts_as_subscribable/subscribable_methods.rb

@@ -0,0 +1,29 @@
+require "acts_as_subscribable/subscribable_methods/instance_methods"
+
+module ActsAsSubscribable
+  module SubscribableMethods
+    def acts_as_subscribable(options = {})
+      options.reverse_merge! :subscriber => "User", :subscription => "Subscription", :subscriber_id => :subscriber_id, :subscribed_id => :subscribed_id
+      
+      options[:subscription] = options[:subscription].to_s
+      options[:subscriber] = options[:subscriber].to_s
+      
+      subscriber_const = options[:subscriber].constantize
+      subscriber_table = options[:subscriber].tableize
+      subscription_const = options[:subscription].constantize
+      
+      has_many :subscriptions, :class_name => options[:subscription], :dependent => :destroy
+      has_many subscriber_table, :class_name => options[:subscriber], :through => :subscriptions, :foreign_key => options[:subscriber_id]
+      
+      subscriber_const.has_many :subscriptions, :class_name => options[:subscription], :dependent => :destroy
+      # subscriber_const.has_many self.name.tableize.to_sym, :class_name => self.name, :through => :subscriptions, :foreign_key => options[:subscribed_id]
+      
+      subscription_const.belongs_to options[:subscriber].downcase.to_sym
+      subscription_const.belongs_to self.name.downcase.to_sym
+      
+      send(:include, ActsAsSubscribable::SubscribableMethods::InstanceMethods)
+      
+      class_eval "def acts_as_subscribable_options; { :subscriber => '#{options[:subscriber]}', :subscription => '#{options[:subscription]}' }; end"
+    end
+  end
+end

data/lib/acts_as_subscribable/subscribable_methods/instance_methods.rb

@@ -0,0 +1,21 @@
+module ActsAsSubscribable
+  module SubscribableMethods
+    module InstanceMethods
+      def subscribers
+        send acts_as_subscribable_options[:subscriber].tableize
+      end
+
+      def subscribe(subscriber)
+        send(acts_as_subscribable_options[:subscriber].tableize).send(:<<, subscriber) unless subscribed?(subscriber)
+      end
+
+      def unsubscribe(subscriber)
+        subscriber.subscriptions.where(:"#{acts_as_subscribable_options[:subscribed_id]}" => id).delete_all
+      end
+
+      def subscribed?(subscriber)
+        !subscriptions.where(:"#{acts_as_subscribable_options[:subscriber_id]}" => subscriber.id).empty?
+      end
+    end
+  end
+end

data/lib/acts_as_subscribable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsSubscribable
+  VERSION = "0.1.0"
+end

data/lib/generators/acts_as_subscribable/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate a model and migration to store subscriptions
+
+Example:
+    rails generate acts_as_subscribable Subscription
+
+    This will create:
+        app/models/subscription.rb
+        db/migrations/00000000_create_subscriptions.rb

data/lib/generators/acts_as_subscribable/acts_as_subscribable_generator.rb

@@ -0,0 +1,9 @@
+class ActsAsSubscribableGenerator < Rails::Generators::Base
+  argument :subscription_name, :type => :string, :default => "Subscription"
+  argument :subscriber_id, :type => :string, :default => "subscriber_id"
+  argument :subscribed_id, :type => :string, :default => "subscribed_id"
+  
+  def generate_subscriptions
+    generate "model #{subscription_name} #{subscriber_id}:integer #{subscribed_id}:integer"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_subscribable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Rumbelow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000Z
+dependencies: []
+description: ! "                    acts_as_subscribable is a loose wrapper around
+  ActiveRecord to allow a basic user subscription model.\n                    acts_as_subscribable
+  exposes a high-level set of methods that allow you to easily subscribe, unsubscribe\n
+  \                   and view subscribers to a model.\n"
+email:
+- jamie@jamierumbelow.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- acts_as_subscribable.gemspec
+- lib/.DS_Store
+- lib/acts_as_subscribable.rb
+- lib/acts_as_subscribable/railtie.rb
+- lib/acts_as_subscribable/subscribable_methods.rb
+- lib/acts_as_subscribable/subscribable_methods/instance_methods.rb
+- lib/acts_as_subscribable/version.rb
+- lib/generators/.DS_Store
+- lib/generators/acts_as_subscribable/.DS_Store
+- lib/generators/acts_as_subscribable/USAGE
+- lib/generators/acts_as_subscribable/acts_as_subscribable_generator.rb
+homepage: https://github.com/jamierumbelow/acts_as_subscribable
+licenses: []
+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: acts_as_subscribable
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Simplify adding user subscriptions to models
+test_files: []