simple_group 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a58d32b879007dadd0d2faf8571a8fb5579d7d33
+  data.tar.gz: fb450d90ad37dc7f926e3f485c9d2d236ef86cf2
+SHA512:
+  metadata.gz: e065f746f3a84e17dd4694b67b63eeab9031b371d5105f8a32b2f30af41133a0957196e27c774953a6e23cd143b0489f9a1046112f6d262d9e3e30cf889a1cfc
+  data.tar.gz: 2b8df34c46ffc63db95fb469ad6baad21592366d24d9624fa4a53705d62f9fa1a7f6daec4cc03c0ba1dc0b2a12b2dc11c2ac8baab035f729ef2a64edc8ae19b3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/internal/logs/
+/tmp/
+*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.0
+  - 2.2.1
+env:
+  - RAILS_VERSION=4.2.1
+  - RAILS_VERSION=4.2.0
+  - RAILS_VERSION=4.1
+  - RAILS_VERSION=4.0
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 patorash
+
+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,102 @@
+# simple_group
+
+simple_group gem is able to add group function to ActiveRecord.
+
+[![Build Status](https://travis-ci.org/patorash/simple_group.svg?branch=master)](https://travis-ci.org/patorash/simple_group)
+
+## Installation
+
+### Rails 4.0+
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_group'
+```
+
+And then execute:
+
+    $ bundle install
+
+### Database Migrations
+
+simple_group uses a simple_group_combinations table to store all group information.
+To genarate and run the migration just use.
+
+    $ bin/rails g simple_group:migration
+    $ bin/rake db:migrate
+
+## Usage
+
+### Group item model
+
+Animal model
+
+```ruby
+class Animal < ActiveRecord::Base
+  groupable
+  validates :name, presence: true
+end
+```
+
+Fruit model
+
+```ruby
+class Fruit < ActiveRecord::Base
+  groupable
+  validates :name, presence: true
+end
+```
+
+
+### Group model
+
+```ruby
+class MyGroup < ActiveRecord::Base
+  add_group_function
+
+  validates :name, presence: true
+  validates :user, presence: true
+end
+```
+
+### Example
+
+```ruby
+user = User.create(name: 'Taro')
+group = MyGroup.create(name: 'Animals', user: user)
+
+# group add a dog
+dog = Animal.create(name: 'dog')
+group.add(dog)
+
+# cat add to group
+cat = Animal.create(name: 'cat')
+cat.add_to_group(group)
+
+# group remove a dog
+group.remove(dog)
+
+# item list in group
+group.group_items
+
+# Only animal
+group.for_type(Animal)
+
+# Only fruit
+group.for_type(Fruit)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/patorash/simple_group/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_group"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/simple_group/migration/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module SimpleGroup
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generators migration for simple_group(simple_groups table)"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)))
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/simple_group_migration'
+      end
+    end
+  end
+end

data/lib/generators/simple_group/migration/templates/active_record/migration.rb

@@ -0,0 +1,18 @@
+class SimpleGroupMigration < ActiveRecord::Migration
+  def self.up
+    create_table :simple_group_combinations do |t|
+      t.references :group_item, polymorphic: true
+      t.references :group, polymorphic: true
+      t.timestamp
+    end
+
+    if ActiveRecord::VERSION::MAJOR < 4
+      add_index :simple_groups, [:group_item_id, :group_item_type]
+      add_index :simple_groups, [:group_id, :group_type]
+    end
+  end
+
+  def self.down
+    drop_table :simple_group_combinations
+  end
+end

data/lib/simple_group/combination.rb

@@ -0,0 +1,22 @@
+module SimpleGroup
+  class Combination < ::ActiveRecord::Base
+    self.table_name = 'simple_group_combinations'
+
+    if ::ActiveRecord::VERSION::MAJOR < 4
+      attr_accessible :group_id, :group_type,
+                      :group_item_id, :group_item_type,
+                      :group, :group_item
+    end
+
+    belongs_to :group, polymorphic: true
+    belongs_to :group_item, polymorphic: true
+
+    scope :for_type, lambda { |klass| where(group_item_type: klass) }
+    scope :by_type,  lambda { |klass| where(group_type: klass) }
+
+    validates :group_item_id, presence: true
+    validates :group_id, presence: true
+  end
+
+  class GroupNotAllowError < Exception; end
+end

data/lib/simple_group/extenders/groop.rb

@@ -0,0 +1,20 @@
+module SimpleGroup
+  module Extenders
+    module Group
+      def added_group_function?
+        false
+      end
+
+      def add_group_function(*args)
+        require 'simple_group/group'
+        include SimpleGroup::Group
+
+        class_eval do
+          def self.added_group_function?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_group/extenders/group_item.rb

@@ -0,0 +1,20 @@
+module SimpleGroup
+  module Extenders
+    module GroupItem
+      def groupable?
+        false
+      end
+
+      def groupable
+        require 'simple_group/group_item'
+        include SimpleGroup::GroupItem
+
+        class_eval do
+          def self.groupable?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_group/group.rb

@@ -0,0 +1,41 @@
+module SimpleGroup
+  module Group
+    def self.included(base)
+      base.class_eval do
+        has_many :combinations, class_name: 'SimpleGroup::Combination', as: :group, dependent: :destroy do
+          def group_items
+            includes(:group_item).map(&:group_item)
+          end
+        end
+      end
+    end
+
+    def add(model)
+      raise SimpleGroup::GroupNotAllowError unless model.class.groupable?
+      SimpleGroup::Combination.create(group: self, group_item: model)
+    end
+
+    def remove(model)
+      raise_error unless model.class.groupable?
+      group = SimpleGroup::Combination.where(
+          group_type: self.class,
+          group_id: self,
+          group_item_type: model.class,
+          group_item_id: model
+      ).first
+      if group.present?
+        group.destroy
+      else
+        false
+      end
+    end
+
+    def for_type(klass)
+      self.combinations.for_type(klass)
+    end
+
+    def count
+      self.combinations.count
+    end
+  end
+end

data/lib/simple_group/group_item.rb

@@ -0,0 +1,18 @@
+module SimpleGroup
+  module GroupItem
+
+    def self.included(base)
+      base.class_eval do
+        has_many :combinations, :class_name => 'SimpleGroup::Combination', :as => :group_item, :dependent => :destroy do
+          def groups
+            includes(:group).map(&:group)
+          end
+        end
+      end
+    end
+
+    def add_to_group(group)
+      SimpleGroup::Combination.create(group_item: self, group: group)
+    end
+  end
+end

data/lib/simple_group/version.rb

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

data/lib/simple_group.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+require 'active_support/inflector'
+
+require "simple_group/version"
+
+module SimpleGroup
+  if defined?(ActiveRecord::Base)
+    require 'simple_group/extenders/groop'
+    require 'simple_group/extenders/group_item'
+    require "simple_group/group"
+    require "simple_group/group_item"
+    require 'simple_group/combination'
+    ActiveRecord::Base.extend SimpleGroup::Extenders::Group
+    ActiveRecord::Base.extend SimpleGroup::Extenders::GroupItem
+  end
+end

data/simple_group.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_group/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_group"
+  spec.version       = SimpleGroup::VERSION
+  spec.authors       = ["Toyoaki Oko"]
+  spec.email         = ["chariderpato@gmail.com"]
+
+  spec.summary       = %q{simple_group is able to add group function to ActiveRecord.}
+  spec.description   = %q{simple_group is able to add group function to ActiveRecord.}
+  spec.homepage      = "https://github.com/patorash/simple_group"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.7.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_rewinder", "~> 0.5.1"
+  spec.add_development_dependency 'combustion', '~> 0.5.3'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: simple_group
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toyoaki Oko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.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'
+- !ruby/object:Gem::Dependency
+  name: database_rewinder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: simple_group is able to add group function to ActiveRecord.
+email:
+- chariderpato@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/simple_group/migration/migration_generator.rb
+- lib/generators/simple_group/migration/templates/active_record/migration.rb
+- lib/simple_group.rb
+- lib/simple_group/combination.rb
+- lib/simple_group/extenders/groop.rb
+- lib/simple_group/extenders/group_item.rb
+- lib/simple_group/group.rb
+- lib/simple_group/group_item.rb
+- lib/simple_group/version.rb
+- simple_group.gemspec
+homepage: https://github.com/patorash/simple_group
+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.4.6
+signing_key: 
+specification_version: 4
+summary: simple_group is able to add group function to ActiveRecord.
+test_files: []