popular 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTFlYzUwZDA3NTAxOGFiNzcxZmE1YWIyOGJlYzMzODZiNzBlNTU1ZA==
+  data.tar.gz: !binary |-
+    OWZmNDFlMjhjNTJiMzczMWFjZTExZTNhZDIzZjZiNTA2N2ZiOGUwYg==
+SHA512:
+  metadata.gz: !binary |-
+    ZmI5MGVhMDA1MmFhZmJlMjRiNDQxZjg2MGY2NTJlN2NjN2U0Nzg5NTEwODU4
+    MDFmMjI0ZTExY2U1NDZkNDRjYTJiMGYxMDAyYjU1ODE5ZTllMTQyN2E3NjI3
+    OWZmZDAwZTFjZjhiOWQwZWIzN2FlZDFlMjQxYTg1MzRiMmY1YWY=
+  data.tar.gz: !binary |-
+    NDFlNzU4YjY2NmM4YjAwNDRjYjFjZjIyMWExYzI0NWU4YWNiNjljNTkyNTg1
+    MWQ0MjEwYjRkZjFmNzJmOTNkYjBjNzQyOGEwNzBhMDI3ZDc2OWEwMzUzYjA2
+    MDk0MjcxMzQ2N2U5MGJkYjMyMmIzNjgwYWM0ZTliYmQ4N2FjNjk=

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 progress

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- 2.1.0
+addons:
+  code_climate:
+    repo_token: 961309bcd7fffdccfec595d69b0d054b56308dcc414edad136f2c153bba245f4
+deploy:
+  provider: rubygems
+  api_key:
+    secure: lxiDHlutKFERFmsSzhqoGtVGRk06wQIv3Gp7GnvaYdbZzC2tH35tvW4RFxdSWPU8Fp02M8Qc89gV+T0IbAigFZEVp3F7IN4DM09oJWGJ4G1XKykYV0c5aFrEfcPVs4rzxletQanObqbVZqBj/+pCaGA1WvwqojL9Jg6a/w/LhyE=
+  gem: friendly
+  on:
+    tags: true
+    repo: thejchap/friendly

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+rails = case rails_version
+        when 'master'
+            { github: 'rails/rails'}
+        when 'default'
+            '~> 4.0.4'
+        else
+            "~> #{rails_version}"
+        end
+
+gem 'rails', rails

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 thejchap
+
+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,33 @@
+# Popular
+[![Build Status](https://travis-ci.org/thejchap/popular.svg?branch=master)](https://travis-ci.org/thejchap/popular)
+[![Dependency Status](https://gemnasium.com/thejchap/popular.svg)](https://gemnasium.com/thejchap/popular)
+
+Popular is a friendship gem designed for Rails/ActiveRecord models.
+
+### THIS IS A VERY YOUNG GEM. YOU HAVE BEEN WARNED
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'popular'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install popular
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/popular/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 new Pull Request

data/Rakefile

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

data/lib/popular.rb

@@ -0,0 +1,18 @@
+require "active_record"
+
+# Namespace for classes and modules that handle friendship related tasks
+#
+# @author Justin Chapman
+#
+# @since 0.0.1
+module Popular
+
+  if defined? ActiveRecord::Base
+    require "popular/extenders/popular"
+    require "popular/friendship"
+
+    # Extend ActiveRecord with extenders
+    ActiveRecord::Base.extend Popular::Extenders::Popular
+  end
+
+end

data/lib/popular/extenders/popular.rb

@@ -0,0 +1,33 @@
+module Popular
+  # Namespace for classes and modules that handle including the library's modules
+  module Extenders
+
+    # Namespace for classes and modules that handle making a given model friendly
+    module Popular
+
+      # Helper method for determining whether or not a model has included
+      # the Popular module
+      #
+      # @return [Boolean] whether or not the including class has included the module
+      def popular?
+        false
+      end
+
+      # Includes the module in a given class
+      #
+      # @overload friendable *args
+      #   @param [Hash] options
+      def popular *args
+        require 'popular/popular'
+        include ::Popular::Popular
+        
+        class_eval do
+          def self.popular?
+            true
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/popular/friendship.rb

@@ -0,0 +1,10 @@
+module Popular
+
+  class Friendship < ::ActiveRecord::Base
+
+    belongs_to :popular_model, polymorphic: true
+    belongs_to :friend, polymorphic: true
+
+  end
+
+end

data/lib/popular/popular.rb

@@ -0,0 +1,41 @@
+module Popular
+
+  module Popular
+
+    def self.included base
+
+      base.class_eval do
+
+        has_many :friendships, class_name: 'Popular::Friendship', as: :popular_model, dependent: :destroy
+        has_many :friends, through: :friendships, source_type: base
+
+      end
+
+    end
+
+    # Adds a friend to an instance's friend's list
+    # 
+    # @param [PopularModel] a popular_model that the instance is not already friends with
+    def befriend new_friend
+      friendships.create friend: new_friend
+    end
+
+    # Removes a friend from an instance's friend's list
+    # 
+    # @param [PopularModel] a popular_model in this instance's friends list
+    def unfriend friend
+      friendships.where( friend: friend ).first.destroy
+    end
+
+    # Helper method for finding whether or not the instance is friends with 
+    # another given popular_model
+    # 
+    # @param [PopularModel] a popular_model
+    # @return [Boolean] if the instance has popular_model as a friend
+    def friends_with? popular_model
+      friendships.where( friend: popular_model ).any?
+    end
+
+  end
+
+end

data/lib/popular/version.rb

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

data/popular.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'popular/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "popular"
+  spec.version       = Popular::VERSION
+  spec.authors       = ["thejchap"]
+  spec.email         = ["commonmodestudio@gmail.com"]
+  spec.summary       = %q{Friendship gem for Rails/ActiveRecord}
+  spec.description   = %q{Friendship gem for Rails/ActiveRecord. Popular saves time when developing social apps}
+  spec.homepage      = "http://thejchap.github.io/popular"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.2"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.3"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "redcarpet", "~> 3.1"
+  spec.add_development_dependency "inch", "~> 0.3"
+end

data/spec/popular/popular_model_spec.rb

@@ -0,0 +1,32 @@
+shared_examples "a popular model" do
+
+  describe '.befriend' do
+    it 'creates a one way friendship' do
+      popular_model.befriend another_popular_model
+
+      expect( popular_model.friends ).to match_array [another_popular_model]
+    end
+  end
+
+  describe '#friends_with?' do
+    it 'returns true if a popular_model is friends with a given popular_model' do
+      expect( popular_model ).to_not be_friends_with another_popular_model
+    end
+    it 'returns true if a popular_model is friends with a given popular_model' do
+      popular_model.befriend another_popular_model
+
+      expect( popular_model ).to be_friends_with another_popular_model
+    end
+  end
+
+  describe '.unfriend' do
+    it 'destroys a friendship' do
+      [:befriend, :unfriend].each do |method|
+        popular_model.send method, another_popular_model
+      end
+
+      expect( popular_model.friends ).to be_empty
+    end
+  end
+
+end

data/spec/popular/popular_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Popular::Popular do
+
+  context 'popular user' do
+    it 'is popular' do
+      expect( PopularModel ).to be_popular
+    end
+  end
+
+  context 'un-popular user' do
+    it 'is not popular' do
+      expect( UnpopularModel ).to_not be_popular
+    end
+  end
+
+  it_behaves_like 'a popular model' do
+    let ( :popular_model ) { PopularModel.create }
+    let ( :another_popular_model ) { PopularModel.create }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require 'sqlite3'
+require 'popular'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Schema.define version: 1 do
+
+  create_table :friendships do |t|
+    t.references :popular_model, polymorphic: true,  null: false
+    t.references :friend, polymorphic: true, null: false
+  end
+
+  create_table :popular_models
+
+end
+
+UnpopularModel = Class.new ActiveRecord::Base
+
+class PopularModel < ActiveRecord::Base
+  popular
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+end
+
+def clean_database
+  [PopularModel, Popular::Friendship].each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: popular
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thejchap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Friendship gem for Rails/ActiveRecord. Popular saves time when developing
+  social apps
+email:
+- commonmodestudio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/popular.rb
+- lib/popular/extenders/popular.rb
+- lib/popular/friendship.rb
+- lib/popular/popular.rb
+- lib/popular/version.rb
+- popular.gemspec
+- spec/popular/popular_model_spec.rb
+- spec/popular/popular_spec.rb
+- spec/spec_helper.rb
+homepage: http://thejchap.github.io/popular
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Friendship gem for Rails/ActiveRecord
+test_files:
+- spec/popular/popular_model_spec.rb
+- spec/popular/popular_spec.rb
+- spec/spec_helper.rb
+has_rdoc: