twrk-socialization 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2150673a506b6d721aa076183f7ef5808857e8f5
+  data.tar.gz: f0b8e740ab91b10561b5a9a589675f742f09d8d9
+SHA512:
+  metadata.gz: cbcda82d06d64f3b5bb7c3b7a963ebc3cf59d963bcbb181f18108f6619b6763b76fb09463515be583cb98b2c3c5e676423e3c9af2e701e8c7c610517832c8d4e
+  data.tar.gz: fce34142970e4e1510e9906175cb0c7e6aa3d513230d2f43876ed09ca4ed71e9ce48e03a1da05658985dd3b904e5d1166f85752a3cfcb97417d4a2acef50b5ba

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+test/debug.log
+coverage
+rdoc
+memory
+*.gem
+.rvmrc
+Gemfile.lock
+log
+doc
+.yardoc
+.rbenv-version
+gemfiles

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+
+script: bundle exec rake spec

data/Appraisals

@@ -0,0 +1,23 @@
+appraise "activerecord30" do
+  gem "activerecord", "~> 3.0.10"
+end
+
+appraise "activerecord31" do
+  gem "activerecord", "~> 3.1.1"
+end
+
+appraise "activerecord32" do
+  gem "activerecord", "~> 3.2.1"
+end
+
+appraise "activerecord40" do
+  gem "activerecord", "~> 4.0.13"
+end
+
+appraise "activerecord41" do
+  gem "activerecord", "~> 4.1.12"
+end
+
+appraise "activerecord42" do
+  gem "activerecord", "~> 4.2.3"
+end

data/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+
+## 1.2 (August 8, 2015)
+
+* Support for ActiveRecord counter caches (thanks @samnang)
+* Moved entire test suite to RSpec
+
+
+## 1.0.1 (January 8, 2014)
+
+* Supports Rails 4 (thanks @thomas88)
+* Dropping official support for Ruby 1.8.x, 1.9.2.
+
+
+## 1.0.0 (May 29, 2013)
+
+* Same as 0.5.0.beta4. Been using it in a very high traffic production environment for over a year and it works.
+
+
+## 0.5.0.beta (June 6, 2012)
+
+* **IMPORTANT:** This release includes many changes, some breaking. Make sure to test your code carefully after upgrading.
+* **BREAKING CHANGE:** Your Like, Follow and Mention models should now inherit the Socialization store base class instead of using the acts_as helper. (e.g.: class Follow < Socialization::ActiveRecordStores::Follow). See demo app for an example.
+* **BREAKING CHANGE:** the `followers`, `followables` etc methods now return an array of objects. Use methods such as `followers_relation` for an ActiveRecord::Relation.
+* Changed: The persistence logic has now been moved to the Socialization::ActiveRecordStores namespace. More stores can be easily added.
+* Changed: `like!`, `follow!`, and `mention!` now return a boolean. True when the action was successful, false when it wasn't (e.g.: the relationship already exists).
+* Changed: `unlike!`, `unfollow!` and `unmention!` will now return false if there is no record to destroy rather than raising `ActiveRecord::RecordNotFound`.
+* Changed: Records can now like, follow or mention themselves. If you want to prevent this, it should be enforced directly in your application.
+* Added: Data can now be stored in Redis.
+* Added: `toggle_like!`, `toggle_follow!` and `toggle_mention!` methods. Thanks to [@balvig](https://github.com/balvig).
+* Added: support for single table inheritance. Thanks to [@balvig](https://github.com/balvig).
+* Changed: raises Socialization::ArgumentError instead of ::ArgumentError
+
+
+## v0.4.0 (February 25, 2012)
+
+* **BREAKING CHANGE:** Renamed `mentionner` to `mentioner`. This is proper English.
+* Added: `followees`, `likees` and `mentionees` methods to `Follower`, `Liker` and `Mentioner`. Thanks to [@ihara2525](https://github.com/ihara2525).
+
+
+## v0.3.0 (February 22, 2012)
+
+* **BREAKING CHANGE:** `likers`, `followers` now return a scope instead of an array. They also require to have the class of the desired scope as an argument. For example: `Movie.find(1).followers(User)`.
+* Added: Mention support.
+* Some refactoring and clean up. Thanks to [@tilsammans](https://github.com/tilsammans)
+
+
+## 0.2.2 (January 15, 2012)
+
+* Improved tests.
+* Changed: Can no longer like or follow yourself.
+
+
+## 0.2.1 (January 15, 2012)
+
+* Bug fixes
+
+
+## 0.2.0 (January 15, 2012)
+
+* Bug fixes
+* Made Ruby 1.8.7 compatible
+
+
+## 0.1.0 (January 14, 2012)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(%r{^spec/.+_spec\.rb$})
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Carl Mercier
+
+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,298 @@
+# Socialization
+
+Socialization is a Ruby Gem that allows any ActiveRecord model to `Follow`, `Like` and/or `Mention` any other model. ActiveRecord or Redis can be used as a data store.
+
+The Follow feature is similar to Twitter's follow. For example, John follows Jane. Unlike Facebook's "friendship", Follow is a one-way concept. The fact that John follows Jane doesn't mean that Jane follows John.
+
+The Like feature works just like a Facebook Like. For example, John likes Pulp Fiction.
+
+The Mention feature was written with Facebook mentions in mind. For example, John mentions Jane in a comment. Typically, Jane would be highlighted in the comment user interface and possibly notified that John mentioned her. This Facebook feature is occasionally called Tagging, although tagging is generally something [entirely different](http://en.wikipedia.org/wiki/Tag_(metadata).
+
+[![Build Status](https://secure.travis-ci.org/cmer/socialization.png?branch=master)](http://travis-ci.org/cmer/socialization)
+
+## Installation
+
+### Rails 3/4
+
+Add the gem to the gemfile:
+`gem "socialization"`
+
+Run the generator:
+`rails generate socialization -s`
+
+Or if you want to use Redis as your data store:
+`rails generate socialization -s --store=redis`
+
+This will generate three migration files (when using ActiveRecord) and three models named Follow, Like and Mention. You may delete any of the Follow, Like or Mention models and migrations if you don't need that functionality in your application.
+
+### Rails 2.3.x Support
+
+This gem requires Rails 3 or better. Sorry!
+
+## Usage
+
+### Setup
+
+Allow a model to be followed:
+
+    class Celebrity < ActiveRecord::Base
+      ...
+      acts_as_followable
+      ...
+    end
+
+Allow a model to be a follower:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_follower
+      ...
+    end
+
+
+Allow a model to be liked:
+
+    class Movie < ActiveRecord::Base
+      ...
+      acts_as_likeable
+      ...
+    end
+
+Allow a model to like:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_liker
+      ...
+    end
+
+Allow a model to be mentioned:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_mentionable
+      ...
+    end
+
+Allow a model to mention:
+
+    class Comment < ActiveRecord::Base
+      ...
+      acts_as_mentioner
+      ...
+    end
+
+Or a more complex case where users can like and follow each other:
+
+    class User < ActiveRecord::Base
+      ...
+      acts_as_follower
+      acts_as_followable
+      acts_as_liker
+      acts_as_likeable
+      acts_as_mentionable
+      ...
+    end
+
+***
+
+
+### acts_as_follower Methods
+
+Follow something
+
+    user.follow!(celebrity)
+
+Stop following
+
+    user.unfollow!(celebrity)
+
+Toggle
+
+    user.toggle_follow!(celebrity)
+
+Is following?
+
+    user.follows?(celebrity)
+
+What items are you following (given that an Item model is followed)?
+
+    user.followees(Item)
+
+Number of followees (Requires followees_count column in db)
+
+    def change
+      add_column :#{Table_name}, :followees_count, :integer, :default => 0
+    end
+
+    user.followees_count
+
+***
+
+
+### acts_as_followable Methods
+
+Find out if an objects follows
+
+    celebrity.followed_by?(user)
+
+All followers
+
+    celebrity.followers(User)
+
+Number of followers (Requires followers_count column in db)
+
+    def change
+      add_column :#{Table_name}, :followers_count, :integer, :default => 0
+    end
+
+    celebrity.followers_count
+
+***
+
+
+### acts_as_liker Methods
+
+Like something
+
+    user.like!(movie)
+
+Stop liking
+
+    user.unlike!(movie)
+
+Toggle
+
+    user.toggle_like!(celebrity)
+
+Likes?
+
+    user.likes?(movie)
+
+Number of likees (Requires likees_count column in db)
+
+    def change
+      add_column :#{Table_name}, :likees_count, :integer, :default => 0
+    end
+
+    user.likees_count
+
+***
+
+
+### acts_as_likeable Methods
+
+Find out if an objects likes
+
+    movie.liked_by?(user)
+
+All likers
+
+    movie.likers(User)
+
+Number of likers (Requires likers_count column in db)
+
+    def change
+      add_column :#{Table_name}, :likers_count, :integer, :default => 0
+    end
+
+    movie.likers_count
+
+***
+
+
+### acts_as_mentioner Methods
+
+**Note that a "mentioner" is the object containing the mention and not necessarily the actor. For example, John mentions Jane in a comment. The mentioner is the comment object, NOT John.**
+
+Mention something
+
+    comment.mention!(user)
+
+Remove mention
+
+    comment.unmention!(user)
+
+Toggle
+
+    user.toggle_mention!(celebrity)
+
+Mentions?
+
+    comment.mentions?(user)
+
+All mentionees
+
+    comment.mentionees(User)
+
+Number of mentionees (Requires mentionees column in db)
+
+    def change
+      add_column :#{Table_name}, : mentionees, :integer, :default => 0
+    end
+
+    user. mentionees_count
+
+***
+
+
+### acts_as_mentionable Methods
+
+Find out if an objects mentions
+
+    user.mentioned_by?(comment)
+
+All mentioners
+
+    user.mentioners(Comment)
+
+Number of mentioners (Requires mentioners_count column in db)
+
+    def change
+      add_column :#{Table_name}, :mentioners_count, :integer, :default => 0
+    end
+
+    movie.mentioners_count
+
+***
+
+
+## Documentation
+
+You can find the compiled YARD documentation at http://rubydoc.info/github/cmer/socialization/frames. Documentation for methods inside `include` blocks is not currently generated although it exists in the code. A custom YARD filter needs to be written for YARD to pick those up.
+
+
+***
+
+## Changelog
+
+Here it is: https://github.com/cmer/socialization/blob/master/CHANGELOG.md
+
+## Demo App
+
+For your convenience, I have added a demo app in demo/demo_app. It does not have a web UI, but you can play with Socialization in the Rails console. It should also help you figure out hown to use Socialization in the Real World.
+
+To use the demo app:
+
+    $ cd demo/demo_app
+    $ bundle
+    $ rake db:migrate
+    $ rake db:seed
+    $ rails console
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Send me a pull request. Bonus points for topic branches.
+
+## Similar Projects
+
+[acts_as_follower](https://github.com/tcocca/acts_as_follower) is a similar project that I only discovered when I was 95% finished writing the first version of Socialization. I initially intended to name this project acts_as_follower only to find out the name was taken. You might want to check it out as well so see which one suits your needs better. Socialization is simpler, supports "Likes" and "Mentions" and easilly extendable; acts_as_follower has more "Follow" features, however.
+
+
+## Copyright
+
+Copyright (c) 2012-2015 Carl Mercier --  Released under the MIT license.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  desc 'Default: run unit tests against all supported versions of ActiveRecord'
+  task :default => ["appraisal:install"] do |t|
+    exec("rake appraisal spec")
+  end
+rescue LoadError
+end

data/demo/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/demo/Gemfile

@@ -0,0 +1,35 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.1'
+gem 'socialization', :path => '../'
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.0'
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'