resonance 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1706b436453caa501e2d7970f4eea6d0f39dd2a6
+  data.tar.gz: ef87ae52d6523a1f13fff3b917de503e95f0de71
+SHA512:
+  metadata.gz: e3727b7ef17bb964c388afc8ef8075aefa07f0cd63c14564def3e69161d8e07a5aabc8d62ee4d0dcfca7f184e36aaed2a5d9220f42e5d420ff02dd229f035a8e
+  data.tar.gz: f448efaf6e41d23c696761a8fcf6af51ea882025d56ae9ca4c82b1479b09a6622ebceb13d62f982a43c55607c8bd7d66e111e6352f6f362e5deeb358756a935d

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+pkg/
+spec/dummy/db
+spec/dummy/log
+spec/dummy/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015-2016 kami
+
+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,159 @@
+# Resonance
+
+[![Build Status](https://travis-ci.org/kami-zh/resonance.svg)](https://travis-ci.org/kami-zh/resonance)
+[![Gem Version](https://badge.fury.io/rb/resonance.svg)](http://badge.fury.io/rb/resonance)
+
+Resonance provides a relational feature to your Rails application, such as follow, like, and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resonance'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+Resonance supports two way to add relational feature.
+
+1. Add a feature to itself
+2. Add features to two models
+
+Following example shows about User model, however, you can apply to any models.
+
+### 1. Add follow feature to User
+
+This case adds follow feature to User model.
+
+At first, generate User and Follow model:
+
+```
+$ bin/rails g model User
+$ bin/rails g model Follow user_id:integer target_user_id:integer
+```
+
+And migrate:
+
+```
+$ bin/rake db:migrate
+```
+
+Then, define `Resonatable` module to `app/models/concerns/resonatable.rb`:
+
+```ruby
+module Resonatable
+  include Resonance
+
+  resonate :user, with: :user, by: :follow
+end
+```
+
+At last, include this module from each models:
+
+```ruby
+class User < ActiveRecord::Base
+  include Resonatable
+end
+
+class Follow < ActiveRecord::Base
+  include Resonatable
+end
+```
+
+That's it.
+User instance has been added following methods:
+
+- user.follow(other_user)
+- user.unfollow(other_user)
+- user.following?(other_user)
+- user.following
+- other_user.followed_by?(user)
+- other_user.followers
+
+Example:
+
+```ruby
+user       = User.create
+other_user = User.create
+
+# Follow
+user.follow other_user
+user.following?(other_user)   #=> true
+user.following                #=> <ActiveRecord::Associations::CollectionProxy [#<User id: 2, created_at: "2015-01-10 01:57:52", updated_at: "2015-01-10 01:57:52">]>
+other_user.followed_by?(user) #=> true
+other_user.followers          #=> <ActiveRecord::Associations::CollectionProxy [#<User id: 1, created_at: "2015-01-10 01:57:42", updated_at: "2015-01-10 01:57:42">]>
+
+# Unfollow
+user.unfollow other_user
+user.following?(other_user)   #=> false
+user.following                #=> <ActiveRecord::Associations::CollectionProxy []>
+other_user.followed_by?(user) #=> false
+other_user.followers          #=> <ActiveRecord::Associations::CollectionProxy []>
+```
+
+### 2. Add like feature to User and Post
+
+This case adds like feature to User and Post model.
+
+```ruby
+module Resonatable
+  include Resonance
+
+  resonate :user, with: :post, by: :like
+end
+
+class User < ActiveRecord::Base
+  include Resonatable
+end
+
+class Post < ActiveRecord::Base
+  include Resonatable
+end
+
+class Like < ActiveRecord::Base
+  include Resonatable
+end
+```
+
+User and Post instance has been added following methods:
+
+- user.like(post)
+- user.unlike(post)
+- user.liking?(post)
+- user.liking
+- post.liked_by?(user)
+- post.likers
+
+At the same time, some `resonate` methods are able to be defined:
+
+```ruby
+module Resonatable
+  include Resonance
+
+  resonate :user, with: :user, by: :follow
+  resonate :user, with: :post, by: :like
+end
+```
+
+## Customization
+
+If you want to use other foreign key name, you can define it by `:foreign_key` option.
+
+```ruby
+resonate :user, with: :post, by: :like, foreign_key: :post_id # Default is `:target_post_id`
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kami-zh/resonance/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,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/resonance.rb

@@ -0,0 +1,94 @@
+require 'resonance/errors/argument_error'
+require 'resonance/supports/converter'
+
+module Resonance
+  class << self
+    def included(base)
+      base.extend(ClassMethods)
+    end
+  end
+
+  module ClassMethods
+    include Resonance::Supports::Converter
+
+    def resonate(subject, with: nil, by: nil, **options)
+      @roles = { source: subject, target: with, action: by }
+      @options = options
+
+      if @roles.values.any?(&:nil?)
+        raise Resonance::Errors::ArgumentError, 'Passed argument is not a valid'
+      end
+
+      classify(source).class_eval <<-EOS
+        has_many :#{pluralize(action)},
+          foreign_key: :#{source}_id,
+          dependent: :destroy
+
+        has_many :#{progressize(action)},
+          through: :#{pluralize(action)},
+          source: :target_#{target}
+
+        def #{action}(target)
+          if #{progressize(action)}?(target) || (self == target)
+            return
+          end
+
+          #{pluralize(action)}.create(#{foreign_key}: target.id)
+        end
+
+        def un#{action}(target)
+          unless #{progressize(action)}?(target)
+            return
+          end
+
+          #{pluralize(action)}.find_by(#{foreign_key}: target.id).destroy
+        end
+
+        def #{progressize(action)}?(target)
+          #{pluralize(action)}.exists?(#{foreign_key}: target.id)
+        end
+      EOS
+
+      classify(target).class_eval <<-EOS
+        has_many :#{pluralize(action)}_as_target,
+          foreign_key: :#{foreign_key},
+          class_name: '#{classify(action)}',
+          dependent: :destroy
+
+        has_many :#{peoplize(action)},
+          through: :#{pluralize(action)}_as_target,
+          source: :#{source}
+
+        def #{pastize(action)}_by?(source)
+          source.#{pluralize(action)}.exists?(#{foreign_key}: id)
+        end
+      EOS
+
+      classify(action).class_eval <<-EOS
+        belongs_to :#{source}
+
+        belongs_to :target_#{target},
+          class_name: '#{classify(target)}',
+          foreign_key: :#{foreign_key}
+      EOS
+    end
+
+    private
+
+    def source
+      @roles[:source].to_s
+    end
+
+    def target
+      @roles[:target].to_s
+    end
+
+    def action
+      @roles[:action].to_s
+    end
+
+    def foreign_key
+      @options[:foreign_key] || "target_#{target}_id"
+    end
+  end
+end

data/lib/resonance/errors/argument_error.rb

@@ -0,0 +1,5 @@
+module Resonance
+  module Errors
+    class ArgumentError < StandardError; end
+  end
+end

data/lib/resonance/supports/converter.rb

@@ -0,0 +1,42 @@
+require 'verbs'
+
+module Resonance
+  module Supports
+    module Converter
+      private
+
+      def classify(str)
+        str.capitalize.constantize
+      end
+
+      def pluralize(str)
+        str.pluralize
+      end
+
+      def progressize(str)
+        if patches['progressize'].key?(str)
+          return patches['progressize'][str]
+        end
+
+        str.verb.conjugate(aspect: :progressive).split(' ').last
+      end
+
+      def peoplize(str)
+        str = (str.last == 'e') ? str.chop : str
+        str + 'ers'
+      end
+
+      def pastize(str)
+        str.verb.conjugate(tense: :past).split(' ').last
+      end
+
+      def patches
+        @patches ||= YAML.load_file(patches_path)['patches']
+      end
+
+      def patches_path
+        File.expand_path('../patches.yml', __FILE__)
+      end
+    end
+  end
+end

data/lib/resonance/supports/patches.yml

@@ -0,0 +1,3 @@
+patches:
+  progressize:
+    follow: following

data/lib/resonance/version.rb

@@ -0,0 +1,3 @@
+module Resonance
+  VERSION = '0.3.2'
+end

data/resonance.gemspec

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'resonance/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'resonance'
+  s.version     = Resonance::VERSION
+  s.authors     = 'kami'
+  s.email       = 'hiroki.zenigami@gmail.com'
+
+  s.summary     = 'Provides a relational feature to your Rails application.'
+  s.description = 'Provides a relational feature to your Rails application.'
+  s.homepage    = 'https://github.com/kami-zh/resonance'
+  s.license     = 'MIT'
+
+  s.files = `git ls-files -z`.split("\x0")
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'verbs'
+
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'actionpack'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/dummy/application.rb

@@ -0,0 +1,97 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'action_controller/railtie'
+require 'active_record'
+require 'resonance'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_token = 'abcdefghijklmnopqrstuvwxyz0123456789'
+    config.session_store :cookie_store, key: '_dummy_session'
+    config.eager_load = false
+    config.active_support.deprecation = :log
+  end
+end
+
+Dummy::Application.initialize!
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+#
+# Models
+#
+
+class User   < ActiveRecord::Base; end
+class Post   < ActiveRecord::Base; end
+class Follow < ActiveRecord::Base; end
+class Like   < ActiveRecord::Base; end
+
+module Resonatable
+  include Resonance
+
+  resonate :user, with: :user, by: :follow
+  resonate :user, with: :post, by: :like, foreign_key: :post_id
+end
+
+class User
+  include Resonatable
+end
+
+class Post
+  include Resonatable
+end
+
+class Follow
+  include Resonatable
+end
+
+class Like
+  include Resonatable
+end
+
+#
+# Migrates
+#
+
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateFollows < ActiveRecord::Migration
+  def change
+    create_table :follows do |t|
+      t.integer :user_id
+      t.integer :target_user_id
+
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateLikes < ActiveRecord::Migration
+  def change
+    create_table :likes do |t|
+      t.integer :user_id
+      t.integer :post_id
+
+      t.timestamps null: false
+    end
+  end
+end
+
+CreateUsers.new.change
+CreatePosts.new.change
+CreateFollows.new.change
+CreateLikes.new.change

data/spec/dummy/bin/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+APP_PATH = File.expand_path('../../application', __FILE__)
+
+require 'rails/commands'

data/spec/dummy/config.ru

@@ -0,0 +1 @@
+run Rails.application

data/spec/models/post_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Post, type: :model do
+  let(:user) { User.create }
+  let(:post) { Post.create }
+
+  describe 'instance methods' do
+    it 'should be defined' do
+      # :user resonates with :post by :like
+      expect(post).not_to respond_to(:like)
+      expect(post).not_to respond_to(:unlike)
+      expect(post).not_to respond_to(:liking?)
+      expect(post).not_to respond_to(:liking)
+      expect(post).to respond_to(:liked_by?)
+      expect(post).to respond_to(:likers)
+    end
+  end
+
+  describe '#liked_by?' do
+    before { user.like post }
+
+    it 'should be liked by user' do
+      expect(post).to be_liked_by(user)
+    end
+  end
+
+  describe '#likers' do
+    before { user.like post }
+
+    it 'should be included user' do
+      expect(post.likers).to be_exists(id: user.id)
+    end
+  end
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe User, type: :model do
+  let(:user) { User.create }
+  let(:other_user) { User.create }
+
+  describe 'instance methods' do
+    it 'should be defined' do
+      # :user resonates with :user by :follow
+      expect(user).to respond_to(:follow)
+      expect(user).to respond_to(:unfollow)
+      expect(user).to respond_to(:following?)
+      expect(user).to respond_to(:following)
+      expect(user).to respond_to(:followed_by?)
+      expect(user).to respond_to(:followers)
+
+      # :user resonates with :post by :like
+      expect(user).to respond_to(:like)
+      expect(user).to respond_to(:unlike)
+      expect(user).to respond_to(:liking?)
+      expect(user).to respond_to(:liking)
+      expect(user).not_to respond_to(:liked_by?)
+      expect(user).not_to respond_to(:likers)
+    end
+  end
+
+  describe '#follow' do
+    context 'unfollow user' do
+      before { user.follow other_user }
+
+      it 'should be followed' do
+        expect(user.follows).to be_exists(target_user_id: other_user.id)
+      end
+    end
+
+    context 'following user' do
+      before do
+        user.follow other_user
+        user.follow other_user
+      end
+
+      it 'should be followed only once' do
+        expect(user.follows.count).to eq(1)
+      end
+    end
+
+    context 'user-self' do
+      before { user.follow user }
+
+      it 'should not be followed' do
+        expect(user.follows).not_to be_exists(target_user_id: user.id)
+      end
+    end
+  end
+
+  describe '#unfollow' do
+    context 'following user' do
+      before do
+        user.follow other_user
+        user.unfollow other_user
+      end
+
+      it 'should be unfollowed' do
+        expect(user.follows).not_to be_exists(target_user_id: other_user.id)
+      end
+    end
+
+    context 'unfollow user' do
+      it 'should not raise error' do
+        expect { user.unfollow other_user }.not_to raise_error
+      end
+    end
+  end
+
+  describe '#following?' do
+    before { user.follow other_user }
+
+    it 'should be followed' do
+      expect(user).to be_following(other_user)
+    end
+  end
+
+  describe '#following' do
+    before { user.follow other_user }
+
+    it 'should be included other user' do
+      expect(user.following).to be_exists(other_user.id)
+    end
+  end
+
+  describe '#followed_by?' do
+    before { other_user.follow user }
+
+    it 'should be followed by other user' do
+      expect(user).to be_followed_by(other_user)
+    end
+  end
+
+  describe '#followers' do
+    before { other_user.follow user }
+
+    it 'should be included other user' do
+      expect(user.followers).to be_exists(other_user.id)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'dummy/application'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: resonance
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- kami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: verbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a relational feature to your Rails application.
+email: hiroki.zenigami@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/resonance.rb
+- lib/resonance/errors/argument_error.rb
+- lib/resonance/supports/converter.rb
+- lib/resonance/supports/patches.yml
+- lib/resonance/version.rb
+- resonance.gemspec
+- spec/dummy/application.rb
+- spec/dummy/bin/rails
+- spec/dummy/config.ru
+- spec/models/post_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kami-zh/resonance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides a relational feature to your Rails application.
+test_files: []