camaraderie 0.1.3 → 0.2

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-4.0
+  - gemfiles/Gemfile.activerecord-3.2.x
+
+script: "echo 'DO IT' && bundle exec rake spec"

data/README.md

@@ -1,6 +1,7 @@
 # Camaraderie
 
 [![Gem Version](https://badge.fury.io/rb/camaraderie.png)](https://rubygems.org/gems/camaraderie)
+[![Build Status](https://travis-ci.org/mirego/camaraderie.png?branch=master)](https://travis-ci.org/mirego/camaraderie)
 
 Camaraderie takes away the pain of managing membership stuff between users and organizations.
 
@@ -24,7 +25,14 @@ First, you have to configure which type of memberships you want. Usually, you’
 
 ```ruby
 Camaraderie.configure do |config|
+  # The different types of memberships (defaults to `['admin']`)
   config.membership_types = %w(admin moderator member)
+
+  # The class name of the organization model (defaults to `'Organization'`)
+  config.organization_class = 'Company'
+
+  # The class name of the user model (defaults to `'User'`)
+  config.user_class = 'Employee'
 end
 ```
 
@@ -59,6 +67,10 @@ organization.members.create(user: user)
 # Check whether the user is an admin
 user.admin_of?(organization)
 # => true
+
+# List all the admins for the organization
+organization.admin_users
+# => #<ActiveRecord::Relation [<User id=1>]>
 ```
 
 ## License

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/camaraderie.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
 
   spec.add_dependency 'activerecord', '>= 3.0.0'
   spec.add_dependency 'activesupport', '>= 3.0.0'

data/gemfiles/Gemfile.activerecord-3.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'

data/gemfiles/Gemfile.activerecord-4.0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'

data/lib/camaraderie/membership.rb

@@ -3,8 +3,8 @@ module Camaraderie
     extend ActiveSupport::Concern
     included do
       # Associations
-      belongs_to :user, validate: true
-      belongs_to :organization
+      belongs_to :user, validate: true, class_name: Camaraderie.user_class, inverse_of: :memberships
+      belongs_to :organization, class_name: Camaraderie.organization_class, inverse_of: :memberships
 
       # Validations
       validates :user, presence: true

data/lib/camaraderie/organization.rb

@@ -4,8 +4,8 @@ module Camaraderie
 
     included do
       # Associations
-      has_many :memberships, dependent: :destroy
-      has_many :users, through: :memberships
+      has_many :memberships, dependent: :destroy, foreign_key: :organization_id, class_name: 'Membership', inverse_of: :organization
+      has_many :users, through: :memberships, class_name: Camaraderie.user_class, inverse_of: :organizations
 
       # Define a method for each type of membership
       #
@@ -17,6 +17,10 @@ module Camaraderie
           def #{type.pluralize}
             memberships.#{type.pluralize}
           end
+
+          def #{type}_users
+            Camaraderie.user_class.constantize.where(id: #{type.pluralize}.pluck(:user_id))
+          end
         RUBY
       end
     end

data/lib/camaraderie/user.rb

@@ -4,13 +4,13 @@ module Camaraderie
 
     included do
       # Associations
-      has_many :memberships, dependent: :destroy
-      has_many :organizations, through: :memberships
+      has_many :memberships, dependent: :destroy, foreign_key: :user_id, class_name: 'Membership', inverse_of: :user
+      has_many :organizations, through: :memberships, class_name: Camaraderie.organization_class, inverse_of: :users
 
       Camaraderie.membership_types.each do |type|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{type}_of?(organization)
-            !!memberships.#{type.pluralize}.where(organization: organization).exists?
+            !!memberships.#{type.pluralize}.where(organization_id: organization.id).exists?
           end
         RUBY
       end

data/lib/camaraderie/version.rb

@@ -1,3 +1,3 @@
 module Camaraderie
-  VERSION = '0.1.3'
+  VERSION = '0.2'
 end

data/lib/camaraderie.rb

@@ -1,5 +1,9 @@
 require 'camaraderie/version'
 
+require 'active_support'
+require 'active_record'
+require 'ostruct'
+
 require 'camaraderie/user'
 require 'camaraderie/organization'
 require 'camaraderie/membership'
@@ -13,7 +17,17 @@ module Camaraderie
 
   # Return the allowed membership types
   def self.membership_types
-    @configuration.membership_types
+    @configuration.membership_types.try(:map, &:to_s) || %w(member)
+  end
+
+  # Return the class name to use for the organizations association
+  def self.organization_class
+    @configuration.organization_class.try(:to_s) || 'Organization'
+  end
+
+  # Return the class name to use for the users association
+  def self.user_class
+    @configuration.user_class.try(:to_s) || 'User'
   end
 
   # Return a block that can be injected into a class

data/spec/camaraderie/membership_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Camaraderie::Membership do
+  before do
+    Camaraderie.configure { |config| config.membership_types = %w(admin member) }
+    spawn_membership_model
+    spawn_organization_model
+    spawn_user_model
+
+    run_migration do
+      create_table(:users, force: true)
+      create_table(:organizations, force: true)
+    end
+  end
+
+  describe :Scopes do
+    let(:user1) { User.create }
+    let(:user2) { User.create }
+
+    let(:organization1) { Organization.create }
+    let(:organization2) { Organization.create }
+
+    before do
+      Membership.create(user: user1, organization: organization1, membership_type: 'admin')
+      Membership.create(user: user2, organization: organization2, membership_type: 'admin')
+      Membership.create(user: user1, organization: organization2, membership_type: 'member')
+    end
+
+    describe :admins do
+      subject { Membership.admins }
+
+      it { should be_an_instance_of(relation_class(Membership)) }
+      it { should have(2).items }
+    end
+
+    describe :members do
+      subject { Membership.members }
+
+      it { should be_an_instance_of(relation_class(Membership)) }
+      it { should have(1).item }
+    end
+  end
+
+  describe :Validations do
+    let(:membership) { Membership.create(attributes) }
+    subject { membership }
+
+    context 'with missing user' do
+      let(:attributes) { { organization: Organization.create, membership_type: 'admin' } }
+      it { should_not be_valid }
+
+      describe :errors do
+        subject { membership.errors }
+        it { should have(1).item }
+        its(:full_messages) { should include "User can't be blank" }
+      end
+    end
+
+    context 'with missing organization' do
+      let(:attributes) { { user: User.create, membership_type: 'admin' } }
+      it { should_not be_valid }
+
+      describe :errors do
+        subject { membership.errors }
+        it { should have(1).item }
+        its(:full_messages) { should include "Organization can't be blank" }
+      end
+    end
+
+    context 'with missing membership type' do
+      let(:attributes) { { user: User.create, organization: Organization.create } }
+      it { should_not be_valid }
+
+      describe :errors do
+        subject { membership.errors }
+        it { should have(2).item }
+        its(:full_messages) { should include "Membership type can't be blank" }
+        its(:full_messages) { should include "Membership type is not included in the list" }
+      end
+    end
+
+    context 'with wrong membership type' do
+      let(:attributes) { { membership_type: 'super_admin', user: User.create, organization: Organization.create } }
+      it { should_not be_valid }
+
+      describe :errors do
+        subject { membership.errors }
+        it { should have(1).item }
+        its(:full_messages) { should include "Membership type is not included in the list" }
+      end
+    end
+  end
+end

data/spec/camaraderie/organization_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Camaraderie::Organization do
+  before do
+    Camaraderie.configure { |config| config.membership_types = %w(admin member) }
+    spawn_membership_model
+    spawn_organization_model
+    spawn_user_model
+
+    run_migration do
+      create_table(:users, force: true)
+      create_table(:organizations, force: true)
+    end
+  end
+
+  describe :InstanceMethods do
+    let(:organization) { Organization.create }
+    let(:user1) { User.create }
+    let(:user2) { User.create }
+    let(:user3) { User.create }
+
+    before do
+      organization.admins.create(user: user1)
+      organization.members.create(user: user2)
+      organization.members.create(user: user3)
+    end
+
+    describe :admins do
+      subject { organization.admins }
+      it { should be_an_instance_of(relation_class(Membership)) }
+      it { should have(1).item }
+    end
+
+    describe :members do
+      subject { organization.members }
+      it { should be_an_instance_of(relation_class(Membership)) }
+      it { should have(2).items }
+    end
+
+    describe :admin_users do
+      subject { organization.admin_users }
+      it { should be_an_instance_of(relation_class(User)) }
+      it { should have(1).item }
+      it { should include user1 }
+    end
+
+    describe :member_users do
+      subject { organization.member_users }
+      it { should be_an_instance_of(relation_class(User)) }
+      it { should have(2).items }
+      it { should include user2, user3 }
+    end
+  end
+
+  describe :Associations do
+    let(:organization) { Organization.create }
+    let(:user1) { User.create }
+    let(:user2) { User.create }
+    let(:user3) { User.create }
+
+    before do
+      organization.admins.create(user: user1)
+      organization.members.create(user: user2)
+      organization.members.create(user: user3)
+    end
+
+    describe :users do
+      subject { organization.users }
+      it { should have(3).items }
+
+      describe :DestroyDependent do
+        specify do
+          expect { organization.destroy }.to change { Membership.count }.from(3).to(0)
+        end
+      end
+    end
+  end
+end

data/spec/camaraderie/user_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Camaraderie::User do
+  before do
+    Camaraderie.configure { |config| config.membership_types = %w(admin member) }
+    spawn_membership_model
+    spawn_organization_model
+    spawn_user_model
+
+    run_migration do
+      create_table(:users, force: true)
+      create_table(:organizations, force: true)
+    end
+  end
+
+  describe :InstanceMethods do
+    subject do
+      User.create.tap do |user|
+        organization1.admins.create(user: user)
+        organization2.members.create(user: user)
+      end
+    end
+
+    let(:organization1) { Organization.create }
+    let(:organization2) { Organization.create }
+    let(:organization3) { Organization.create }
+
+    describe :admin_of? do
+      it{ should be_admin_of(organization1) }
+      it{ should_not be_admin_of(organization2) }
+      it{ should_not be_admin_of(organization3) }
+    end
+
+    describe :member_of? do
+      it{ should be_member_of(organization2) }
+      it{ should_not be_member_of(organization1) }
+      it{ should_not be_member_of(organization3) }
+    end
+  end
+
+  describe :Associations do
+    subject { user }
+    let(:user) { User.create }
+
+    before do
+      Organization.create.admins.create(user: user)
+      Organization.create.members.create(user: user)
+    end
+
+    describe :organizations do
+      its(:organizations) { should have(2).items }
+
+      describe :DestroyDependent do
+        specify do
+          expect { user.destroy }.to change { Membership.count }.from(2).to(0)
+        end
+      end
+    end
+  end
+end

data/spec/camaraderie_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Camaraderie do
+  describe 'Custom model classes' do
+    before do
+      Camaraderie.configure do |config|
+        config.organization_class = 'Company'
+        config.user_class = 'Employee'
+        config.membership_types = %w(admin member)
+      end
+
+      spawn_organization_model 'Company'
+      spawn_user_model 'Employee'
+      spawn_membership_model
+
+      run_migration do
+        create_table(:employees, force: true)
+        create_table(:companies, force: true)
+      end
+    end
+
+    let(:user) { Employee.create }
+    let(:organization) { Company.create }
+
+    before do
+      # FIXME Why doesn't this work?
+      # It bypasses `class_name: 'Employee'` and tries to use 'User'
+      #
+      # organization.admins.create(user: user)
+
+      # We'll have to use this for now
+      Membership.create(membership_type: 'admin', user: user, organization: organization)
+    end
+
+    it { expect(user).to be_admin_of(organization) }
+    it { expect(organization.admin_users).to include(user) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+
+require 'camaraderie'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
+
+# Inject our methods into ActiveRecord (like our railtie does)
+ActiveRecord::Base.class_eval(&Camaraderie.inject_into_active_record)
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+  config.include RailsMacros
+
+  config.before(:each) do
+    # Create the SQLite database
+    setup_database
+
+    # Run our migration
+    run_default_migration
+
+    # Reset Camaraderie.configuration
+    Camaraderie.instance_variable_set(:@configuration, nil)
+
+    # Prepare our models array
+    @spawned_models = []
+  end
+
+  config.after(:each) do
+    # Make sure we remove our test database file
+    cleanup_database
+
+    # Remove our models
+    @spawned_models.each { |model| Object.instance_eval { remove_const model.name.to_sym } }
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,39 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def self.database_file
+    @database_file || File.expand_path('../test.db', __FILE__)
+  end
+
+  def setup_database
+    # Make sure the test database file is gone
+    cleanup_database
+
+    # Establish the connection
+    SQLite3::Database.new FileUtils.touch(DatabaseMacros.database_file).first
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: DatabaseMacros.database_file)
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+
+  def cleanup_database
+    FileUtils.rm(DatabaseMacros.database_file) if File.exists?(DatabaseMacros.database_file)
+  end
+
+  # Run the built-in migration
+  def run_default_migration
+    load File.expand_path('../../../../lib/generators/camaraderie/templates/migration.rb', __FILE__)
+    AddCamaraderie.new.up
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,33 @@
+module ModelMacros
+  # Create a new organization model
+  def spawn_organization_model(klass_name = 'Organization', &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      acts_as_organization
+      instance_exec(&block) if block
+    end
+  end
+
+  # Create a new user model
+  def spawn_user_model(klass_name = 'User', &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      acts_as_user
+      instance_exec(&block) if block
+    end
+  end
+
+  def spawn_membership_model(klass_name = 'Membership', &block)
+    spawn_model 'Membership', ActiveRecord::Base do
+      acts_as_membership
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    @spawned_models << Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+end

data/spec/support/macros/rails_macros.rb

@@ -0,0 +1,9 @@
+module RailsMacros
+  def relation_class(klass)
+    if ActiveRecord::VERSION::MAJOR == 3
+      ActiveRecord::Relation
+    else
+      "ActiveRecord::Relation::ActiveRecord_Relation_#{klass.name}".constantize
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camaraderie
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -84,11 +116,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - camaraderie.gemspec
+- gemfiles/Gemfile.activerecord-3.2.x
+- gemfiles/Gemfile.activerecord-4.0
 - lib/camaraderie.rb
 - lib/camaraderie/membership.rb
 - lib/camaraderie/organization.rb
@@ -99,6 +135,14 @@ files:
 - lib/generators/camaraderie/install_generator.rb
 - lib/generators/camaraderie/templates/migration.rb
 - lib/generators/camaraderie/templates/model.rb
+- spec/camaraderie/membership_spec.rb
+- spec/camaraderie/organization_spec.rb
+- spec/camaraderie/user_spec.rb
+- spec/camaraderie_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
+- spec/support/macros/rails_macros.rb
 homepage: https://github.com/mirego/camaraderie
 licenses:
 - BSD 3-Clause
@@ -114,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1376039277595789238
+      hash: -3093721818560586396
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1376039277595789238
+      hash: -3093721818560586396
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -131,4 +175,12 @@ signing_key:
 specification_version: 3
 summary: Camaraderie takes away the pain of managing membership stuff between users
   and organizations.
-test_files: []
+test_files:
+- spec/camaraderie/membership_spec.rb
+- spec/camaraderie/organization_spec.rb
+- spec/camaraderie/user_spec.rb
+- spec/camaraderie_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
+- spec/support/macros/rails_macros.rb