groupify 0.1.0

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/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Butler
+
+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,54 @@
+# Groupify [![Build Status](https://secure.travis-ci.org/dwbutler/groupify.png)](http://travis-ci.org/dwbutler/groupify)
+Adds group and membership functionality to Rails models.
+
+Currently only Mongoid is supported. Tested in Ruby 1.8.7 and 1.9.3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'groupify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install groupify
+
+## Getting Started
+In your group model:
+
+	class Group
+		include Mongoid::Document
+		
+		acts_as_group
+	end
+
+In your user model:
+
+	class User
+		include Mongoid::Document
+		
+		acts_as_group_member
+	end
+
+Create groups and add members:
+
+	group = Group.new
+	user = User.new
+	
+	user.groups << group
+	or
+	group.add user
+
+Check the specs for more details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec

data/groupify.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/groupify/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["dwbutler"]
+  gem.email         = ["dwbutler@ucla.edu"]
+  gem.description   = %q{Adds group and membership functionality to Rails models}
+  gem.summary       = %q{Group functionality for Rails}
+  gem.homepage      = "https://github.com/dwbutler/groupify"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "groupify"
+  gem.require_paths = ["lib"]
+  gem.version       = Groupify::VERSION
+  
+  gem.add_development_dependency "rails", "~> 3.2"
+  gem.add_development_dependency "rspec"
+  
+  if RUBY_VERSION < '1.9'
+    gem.add_development_dependency "mongoid", "~> 2.0"
+    gem.add_development_dependency 'mongoid-rspec', '1.4.5'
+  else
+    gem.add_development_dependency "mongoid", "~> 3.0"
+    gem.add_development_dependency 'mongoid-rspec', '~> 1.5.1'
+  end
+end

data/lib/groupify.rb

@@ -0,0 +1,100 @@
+require "groupify/version"
+require 'active_support'
+require 'mongoid'
+
+# Groups and members
+module Groupify
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    def acts_as_group(opts = {})
+      include Groupify::Group
+      
+      if (member_klass = opts.delete :default_members)
+        default_member_class = member_klass.to_s.classify.constantize
+      end
+      
+      if (member_klasses = opts.delete :members)
+        member_klasses.each do |member_klass|
+          has_members(member_klass)
+        end
+      end
+    end
+    
+    def acts_as_group_member(opts = {})
+      class_eval { @group_class_name = opts[:class_name] || 'Group' }
+      include Groupify::GroupMember
+    end
+  end
+
+  # Functionality related to groups.
+  # Usage:
+  #    class Group
+  #        acts_as_group, :members => [:users]
+  #        ...
+  #    end
+  #
+  module Group
+    extend ActiveSupport::Concern
+    
+    included do
+      @default_member_class = nil
+    end
+    
+    def members
+      self.class.default_member_class.any_in(:group_ids => [self.id])
+    end
+    
+    def add(member)
+      member.groups << self
+    end
+    
+    module ClassMethods
+      def default_member_class; @default_member_class || User; end
+      def default_member_class=(klass); @default_member_class = klass; end
+      
+      def has_members(name)
+        klass = name.to_s.classify.constantize
+        define_method name.to_s.pluralize.underscore do
+          klass.any_in(:group_ids => [self.id])
+        end
+      end
+    end
+  end
+  
+  # Functionality related to group members.
+  # Usage:
+  #    class User
+  #        acts_as_group_member
+  #        ...
+  #    end
+  #
+  module GroupMember
+    extend ActiveSupport::Concern
+    
+    included do
+      group_class_name='Group' unless defined?(@group_class_name)
+      has_and_belongs_to_many :groups, :autosave => true, :inverse_of => nil, :class_name => @group_class_name
+    end
+    
+    def in_group?(group); self.groups.include? group; end
+    def in_any_group?(*groups); (self.groups & groups.flatten).present?; end
+    def in_all_groups?(*groups); self.groups == groups.flatten; end
+    def shares_any_group?(other)
+      in_any_group?(other.groups)
+    end
+    
+    module ClassMethods
+      def group_class_name; @group_class_name || 'Group'; end
+      def group_class_name=(klass);  @group_class_name = klass; end
+      
+      def none; where(:id => nil); end
+      def in_group(group); group.present? ? where(:group_ids.in => [group.id]) : none; end
+      def in_any_group(*groups); groups.present? ? where(:group_ids.in => groups.flatten.map{|g|g.id}) : none; end
+      def in_all_groups(*groups); groups.present? ? where(:group_ids => groups.flatten.map{|g|g.id}) : none; end
+      def shares_any_group(other); in_any_group(other.groups); end
+    end
+  end
+end
+
+Mongoid::Document.send :include, Groupify

data/lib/groupify/version.rb

@@ -0,0 +1,3 @@
+module Groupify
+  VERSION = "0.1.0"
+end

data/spec/groupify/mongoid_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'mongoid'
+require 'mongoid-rspec'
+include Mongoid::Matchers
+
+class MongoidUser
+  include Mongoid::Document
+  
+  acts_as_group_member :class_name => 'MongoidGroup'
+end
+
+class MongoidTask
+  include Mongoid::Document
+  
+  acts_as_group_member :class_name => 'MongoidGroup'
+end
+
+class MongoidGroup
+  include Mongoid::Document
+  
+  acts_as_group :members => [:mongoid_users, :mongoid_tasks], :default_members => :mongoid_users
+  
+end
+
+describe MongoidGroup do
+  it { should respond_to :members}
+  it { should respond_to :add }
+end
+
+describe MongoidUser do
+  it { should respond_to :groups}
+  it { should respond_to :in_group?}
+  it { should respond_to :in_any_group?}
+  it { should respond_to :in_all_groups?}
+  it { should respond_to :shares_any_group?}
+  
+  # Mongoid specific
+  it { should have_and_belong_to_many(:groups).of_type(MongoidGroup) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require 'active_support'
+require 'active_support/all'
+require 'rails'
+require 'active_record'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: groupify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- dwbutler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Adds group and membership functionality to Rails models
+email:
+- dwbutler@ucla.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- groupify.gemspec
+- lib/groupify.rb
+- lib/groupify/version.rb
+- spec/groupify/mongoid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dwbutler/groupify
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Group functionality for Rails
+test_files:
+- spec/groupify/mongoid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: