acts_as_belongable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99724979e1ee56f88f57d31b9fccae9fc557d6f5c03f3e09feecbbbb58587122
+  data.tar.gz: 8ea8c8e9c2b4de93e9a2db1ad9e5a56cde09c6b9e2fc953a236aaecd422607ad
+SHA512:
+  metadata.gz: a135d7308b3fbaf37d83b639b9c2962180d6211a57ca904c22995e2b6264b1a4a0cf6028a6f8aedd5423e3446ea72eec78bfa73a54fa48b18d5e44e6ae10c781
+  data.tar.gz: 01f1e856c96e217f41d8c6973006d8c8e478158d5a830fb5d27cdf315fb598883d81279445888f177206bb0b07815f886c621d177224e58ee09625ba35c57b5a

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/20
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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,174 @@
+# acts_as_belongable
+
+[![Gem Version](https://badge.fury.io/rb/acts_as_belongable.svg)](https://badge.fury.io/rb/acts_as_belongable) <img src="https://travis-ci.org/jonhue/acts_as_belongable.svg?branch=master" />
+
+acts_as_belongable is a Rubygem that provides an associations engine for Rails apps. It's primary use case is to simplify `has_many through: ...` relations.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Associations](#associations)
+    * [acts_as_belonger](#acts_as_belonger)
+    * [acts_as_belongable](#acts_as_belongable)
+    * [acts_as_list](#acts_as_list)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+acts_as_belongable works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'acts_as_belongable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_belongable
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'acts_as_belongable', github: 'jonhue/acts_as_belongable'
+```
+
+Now run the generator:
+
+    $ rails g acts_as_belongable
+
+To wrap things up, migrate the changes into your database:
+
+    $ rails db:migrate
+
+---
+
+## Usage
+
+### Associations
+
+```ruby
+class User < ApplicationRecord
+    acts_as_belongable
+    belongable :attending, 'Event'
+end
+
+class Event < ApplicationRecord
+    acts_as_belonger
+    acts_as_belongable
+    belonger :attendees, 'User'
+    belongable :conferences, 'Conference'
+end
+
+class Conference < ApplicationRecord
+    acts_as_belonger
+    belonger :events, 'Event'
+end
+```
+
+### acts_as_belonger
+
+`acts_as_belonger` makes the following methods available:
+
+```ruby
+c = Conference.first
+
+# Returns all belongables associated with this record
+c.belongables
+
+# Adds a belongable to this record
+c.add_belongable Event.first
+# c.add_belongable! Event.first
+
+# Creates a belongable record and adds it to this record
+c.create_belongable 'Event', options
+# c.create_belongable! Event, options
+```
+
+### acts_as_belongable
+
+`acts_as_belongable` makes the following methods available:
+
+```ruby
+e = Event.first
+
+# Returns all belongers associated with this record
+e.belongers
+
+# Adds this record to a belonger
+c.add_to_belonger Conference.first
+# c.add_to_belonger! Conference.first
+
+# Adds this record to a newly created belonger
+c.create_belonger 'Conference', options
+# c.create_belonger! Conference, options
+```
+
+### acts_as_list
+
+acts_as_belongable integrates with [acts_as_list](). It adds a `position` column to `Belonging`:
+
+```ruby
+c.add_belongable Event.first, position: 1
+```
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/acts_as_belongable/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/acts_as_belongable/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to acts_as_belongable. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/acts_as_belongable/graphs/contributors
+
+### Semantic Versioning
+
+acts_as_belongable follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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/app/models/concerns/acts_as_belongable/belongable.rb

@@ -0,0 +1,36 @@
+module ActsAsBelongable
+    module Belongable
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+            def acts_as_belongable
+                has_many :belongers, through: :belongable_belongings, source: :belonger
+                has_many :belongable_belongings, as: :belongable, class_name: 'Belonging', dependent: :destroy
+            end
+
+            def belongable name, source_type
+                has_many name.to_sym, through: :belongable_belongings, source: :belonger, source_type: source_type.to_s
+            end
+        end
+
+        def add_to_belonger belonger, options = {}
+            options[:belonger] = belonger
+            self.belongable_belongings.create options
+        end
+        def add_to_belonger! belonger, options = {}
+            options[:belonger] = belonger
+            self.belongable_belongings.create! options
+        end
+
+        def create_belonger class_name, options = {}
+            object = class_name.constantize.create options
+            self.add_to_belonger object
+        end
+        def create_belonger! class_name, options = {}
+            object = class_name.constantize.create! options
+            self.add_to_belonger! object
+        end
+
+    end
+end

data/app/models/concerns/acts_as_belongable/belonger.rb

@@ -0,0 +1,36 @@
+module ActsAsBelongable
+    module Belonger
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+            def acts_as_belonger
+                has_many :belongables, through: :belonger_belongings, source: :belongable
+                has_many :belonger_belongings, as: :belonger, class_name: 'Belonging', dependent: :destroy
+            end
+
+            def belonger name, source_type
+                has_many name.to_sym, through: :belonger_belongings, source: :belongable, source_type: source_type.to_s
+            end
+        end
+
+        def add_belongable belongable, options = {}
+            options[:belongable] = belongable
+            self.belonger_belongings.create options
+        end
+        def add_belongable! belongable, options = {}
+            options[:belongable] = belongable
+            self.belonger_belongings.create! options
+        end
+
+        def create_belongable class_name, options = {}
+            object = class_name.constantize.create options
+            self.add_belongable object
+        end
+        def create_belongable! class_name, options = {}
+            object = class_name.constantize.create! options
+            self.add_belongable! object
+        end
+
+    end
+end

data/lib/acts_as_belongable.rb

@@ -0,0 +1,8 @@
+require 'acts_as_belongable/version'
+
+module ActsAsBelongable
+
+    require 'acts_as_belongable/railtie'
+    require 'acts_as_belongable/engine'
+
+end

data/lib/acts_as_belongable/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module ActsAsBelongable
+    class Engine < Rails::Engine
+    end
+end

data/lib/acts_as_belongable/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+
+module ActsAsBelongable
+    class Railtie < Rails::Railtie
+
+        initializer 'acts_as_belongable.active_record' do
+            ActiveSupport.on_load :active_record do
+                include ActsAsBelongable::Belonger
+                include ActsAsBelongable::Belongable
+            end
+        end
+
+    end
+end

data/lib/acts_as_belongable/version.rb

@@ -0,0 +1,5 @@
+module ActsAsBelongable
+
+    VERSION = '1.0.0'
+
+end

data/lib/generators/acts_as_belongable_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActsAsBelongableGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install acts_as_belongable'
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % (current_migration_number(dirname) + 1)
+        end
+    end
+
+    def create_migration_file
+        migration_template 'migration.rb.erb', 'db/migrate/acts_as_belongable_migration.rb', migration_version: migration_version
+    end
+
+    def create_model
+        template 'model.rb', 'app/models/belonging.rb'
+    end
+
+    def show_readme
+        readme 'README.md'
+    end
+
+    private
+
+    def migration_version
+        if Rails.version >= '5.0.0'
+            "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+    end
+
+end

data/lib/generators/templates/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add acts_as_favoritor to your database.

data/lib/generators/templates/migration.rb.erb

@@ -0,0 +1,14 @@
+class ActsAsBelongableMigration < ActiveRecord::Migration<%= migration_version %>
+    def change
+        create_table :belongings do |t|
+
+            t.references :belonger, polymorphic: true, index: true
+            t.references :belonging, polymorphic: true, index: true
+
+            t.integer :position
+
+            t.timestamps null: false
+
+        end
+    end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,8 @@
+class Belonging < ApplicationRecord
+
+    acts_as_list :belonger
+
+    belongs_to :belonger, polymorphic: true
+    belongs_to :belongable, polymorphic: true
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_belongable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: acts_as_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: 'acts_as_belongable is a Rubygem that provides an associations engine
+  for Rails apps. It''s primary use case is to simplify `has_many through: ...` relations.'
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/models/concerns/acts_as_belongable/belongable.rb
+- app/models/concerns/acts_as_belongable/belonger.rb
+- lib/acts_as_belongable.rb
+- lib/acts_as_belongable/engine.rb
+- lib/acts_as_belongable/railtie.rb
+- lib/acts_as_belongable/version.rb
+- lib/generators/acts_as_belongable_generator.rb
+- lib/generators/templates/README.md
+- lib/generators/templates/migration.rb.erb
+- lib/generators/templates/model.rb
+homepage: https://github.com/jonhue/acts_as_belongable
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  **Thank you for installing acts_as_belongable!**
+  Get started by running `rails g acts_as_belongable`.
+  Learn more at https://github.com/jonhue/acts_as_belongable.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Associations engine for Rails
+test_files: []