interest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc82c4e1059269fa9b2883ec3e3b44a5abeb3b13
+  data.tar.gz: 3261ddd2763d276aeb65f99d2aed75385a0870a8
+SHA512:
+  metadata.gz: d0d24030c45c3fa07c7cecf3936324f7b24215bb55485982582568856fa4253d9602fe454cfa8fdb05bc0935923e0069acf6a586d97c9800dbc773fce7825385
+  data.tar.gz: f0de0016b106f52a0baa34f6d78ae2e115d4f84d3cdb83c1de75427a90c84288e097e7f715a3ea2612f99582af6497db3c60fb0347debfa08d13d6a3047f19f9

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+vendor/bundle
+spec/database.yml
+spec/*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tatat
+
+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,329 @@
+# Interest
+
+a gem to follow, follow request and block between any ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'interest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interest
+
+### Post installation
+
+#### Install migrations and models
+
+```
+bin/rails generate interest
+```
+
+#### Migrate
+
+```
+bin/rake db:migrate
+```
+
+## Usage
+
+### Setup
+
+Create User and Blog model as one example.
+
+```ruby
+class User < ActiveRecord::Base
+  interest
+end
+
+class Blog < ActiveRecord::Base
+  interest
+end
+
+user = User.create!
+blog = Blog.create!
+```
+
+### Follow
+
+To follow,
+
+```ruby
+following = user.follow!(blog)
+```
+
+returns `Following` or raises `Interest::Followable::Rejected`.
+
+Otherwise,
+
+```ruby
+following = user.follow(blog)
+```
+
+returns `Following` or `nil`.
+
+Returned `Following` is the following.
+
+```ruby
+following.follower == user # => true
+following.followee == blog # => true
+following.status # => "accepted"
+```
+
+To unfollow,
+
+```ruby
+user.unfollow(blog)
+```
+
+To check whether the user is following the blog or not,
+
+```ruby
+user.following?(blog)
+```
+
+or
+
+```ruby
+blog.followed_by?(user)
+```
+
+#### Associations
+
+```ruby
+user.following_relationships.of(Blog)
+```
+
+and
+
+```ruby
+blog.follower_relationships.of(User)
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Following` belongs to `User` and `Blog`.
+
+```ruby
+user.following_blogs
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Blog`.
+
+```ruby
+blog.follower_users
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `User`.
+
+"blogs" and "users" part of the above are conditional on a class.
+
+e.g.
+
+```ruby
+other_user = OtherUser.create!
+user.follow(other_user) # follows OtherUser
+```
+
+then
+
+```ruby
+user.following_other_users
+```
+
+(It's just like `"ClassName".underscore.pluralize`)
+
+### Follow request
+
+To request to follow,
+
+```ruby
+following = user.request_to_follow!(blog)
+```
+
+returns `Following` or raises `Interest::FollowRequestable::Rejected`.
+
+Otherwise,
+
+```ruby
+following = user.request_to_follow!(blog)
+```
+
+returns `Following` or `nil`.
+
+Returned `Following` is the following.
+
+```ruby
+following.status # => "pending"
+```
+
+To cancel request to follow,
+
+```ruby
+user.cancel_request_to_follow(blog)
+```
+
+To check whether the user has requested to follow the blog or not,
+
+```ruby
+user.has_requested_to_follow?(blog)
+```
+
+or
+
+```ruby
+blog.has_been_requested_to_follow?(user)
+```
+
+To accept request to follow, call `accept!` of `Following`
+
+```ruby
+following = blog.incoming_follow_requests.of(User).find(id) # `Following.find(id)' is more simply.
+following.accept!
+```
+
+#### Associations
+
+```ruby
+user.outgoing_follow_requests.of(Blog)
+```
+
+and
+
+```ruby
+blog.incoming_follow_requests.of(User)
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Following` belongs to `User` and `Blog`
+
+```ruby
+user.follow_requestee_blogs
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Blog`
+
+```ruby
+blog.follow_requester_users
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `User`
+
+#### Note
+
+`follow!` and `follow` methods don't check whether the user is required to request to follow the blog, so you should check it yourself.
+
+In this case, you need to define (override) `requires_request_to_follow?` on `Blog` first.
+
+```ruby
+class Blog < ActiveRecord::Base
+  # ...
+
+  def requires_request_to_follow?(follower)
+    true # or something
+  end
+end
+```
+
+Then, like the following
+
+```ruby
+if user.required_request_to_follow?(blog)
+  user.request_to_follow(blog)
+else
+  user.follow(blog)
+end
+```
+
+or
+
+```ruby
+result = user.follow_or_request_to_follow!(blog)
+
+if result.followed?
+  # when the user followed the blog
+elsif result.requested_to_follow?
+  # when the user requested to follow the blog
+end
+```
+
+### Block
+
+To block,
+
+```ruby
+blocking = blog.block!(user)
+```
+
+returns `Blocking` or raises `Interest::Blockable::Rejected`.
+
+Otherwise,
+
+```ruby
+blocking = blog.block!(user)
+```
+
+returns `Blocking` or `nil`
+
+Returned `Blocking` is the following
+
+```ruby
+blocking.blocker == blog # => true
+blocking.blockee == user # => true
+```
+
+Blocking destroys their folow and follow request relationships if they have.
+
+To unblock,
+
+```ruby
+blog.unblock(user)
+```
+
+To check whether the blog is blocking the user or not,
+
+```ruby
+blog.blocking?(user)
+```
+
+or
+
+```ruby
+user.blocked_by?(blog)
+```
+
+#### Associations
+
+```ruby
+blog.blocking_relationships.of(User)
+```
+
+and
+
+```ruby
+user.blocker_relationships.of(Blog)
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Blocking` belongs to `Blog` and `User`
+
+```ruby
+blog.blocking_users
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `User`
+
+```ruby
+user.blocker_blogs
+```
+
+returns `ActiveRecord::Associations::CollectionProxy` for `Blog`
+
+## Contributing
+
+1. Fork it ( https://github.com/conol/interest/fork )
+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 a new Pull Request

data/Rakefile

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

data/interest.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interest"
+  spec.version       = Interest::VERSION
+  spec.authors       = ["tatat"]
+  spec.email         = ["ioiioioloo@gmail.com"]
+  spec.summary       = %q{Follow, follow request and block with ActiveRecord.}
+  spec.description   = %q{A gem to follow, follow request and block between any ActiveRecord models.}
+  spec.homepage      = "https://github.com/conol/interest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "activerecord", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1"
+end

data/lib/generators/interest_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+class InterestGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+
+  source_root File.expand_path("templates", File.dirname(__FILE__))
+
+  def create_migration_file
+    migration_template "migrations/followings.rb", "db/migrate/interest_followings_migration.rb"
+    migration_template "migrations/blockings.rb", "db/migrate/interest_blockings_migration.rb"
+  end
+
+  def create_model
+    copy_file "models/following.rb", "app/models/following.rb"
+    copy_file "models/blocking.rb", "app/models/blocking.rb"
+  end
+end