gutentag-multitenancy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 189f617a953d1d1ceaacd4bc7de82b3e8d54cd71
+  data.tar.gz: b51023d31ed942fdc6c611e35be263ce5fcb50e0
+SHA512:
+  metadata.gz: e0f8260ef48289d684a9411f20efd0e9d80a82cdd50264e745de80f4b481f390f0736768d93b41baf64f732a82537614b441ff9ad83c893583b7e701464b306a
+  data.tar.gz: 84fa5812352a81daf6b877e7c0c760682eebb845907349d5f9629200e1bc70f9348fe5708c87900b23667c364f930f2461df7f2c4fa0fd9f4082a028a7d6263a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andy Stewart
+
+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,68 @@
+# Gutentag::Multitenancy
+
+This gem extends [Gutentag](https://github.com/pat/gutentag) with multitenancy support.
+
+Gutentag's tags are available to every user of your application; this gem scopes the tags by tenant.
+
+
+## Installation
+
+If you haven't installed Gutentag yet, [install](https://github.com/pat/gutentag#installation) it now.  You'll need to modify your Gemfile to install the latest version from HEAD:
+
+```ruby
+gem 'gutentag', github: 'pat/gutentag', ref: '51bd8f2f37f21dc4ef84a87889db4f28aa3573e2'
+```
+
+Now run the following migration (TODO: make a generator for this!):
+
+```ruby
+add_column :gutentag_tags, :tenant_id, :integer, null: false
+
+remove_index :gutentag_tags, :name
+add_index :gutentag_tags, [:name, :tenant_id], unique: true
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gutentag-multitenancy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gutentag-multitenancy
+
+
+## Usage
+
+Define a `tenant_id` method in each model which can have tags.  In the following example each author has their own set of tags for articles:
+
+```ruby
+class Article < ActiveRecord::Base
+  belongs_to :author
+
+  has_many_tags  # from Gutentag
+
+  def tenant_id
+    author.id
+  end
+end
+```
+
+To retrieve all the tags for a tenant, use the `by_tenant_id` scope:
+
+```ruby
+Gutentag::Tag.by_tenant_id 42
+```
+
+
+## License
+
+Copyright 2015 Andrew Stewart.
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/gutentag-multitenancy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gutentag/multitenancy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gutentag-multitenancy"
+  spec.version       = Gutentag::Multitenancy::VERSION
+  spec.authors       = ["Andy Stewart"]
+  spec.email         = ["boss@airbladesoftware.com"]
+
+  spec.summary       = %q{Extends Gutentag with support for multitenancy.}
+  spec.description   = %q{Extends Gutentag with support for multitenancy.}
+  spec.homepage      = "https://github.com/airblade/gutentag-multitenancy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  # NOTE: requires gutentag @ 51bd8f2 or later (not yet released).
+  spec.add_dependency 'gutentag', '>= 0.7.0'
+end

data/lib/gutentag/multitenancy/engine.rb

@@ -0,0 +1,29 @@
+require "#{Gutentag::Engine.root}/app/models/gutentag/tag.rb"
+
+module Gutentag
+  module Multitenancy
+
+    class Engine < ::Rails::Engine
+      engine_name :gutentag_multitenancy
+
+      ActiveSupport.on_load :active_record do
+        Gutentag::Tag.class_eval do
+          attr_accessible :tenant_id if ::ActiveRecord::VERSION::MAJOR == 3
+
+          scope :by_tenant_id, ->(tenant_id) { where tenant_id: tenant_id }
+
+          def self.find_by_name_and_tenant_id(name, tenant_id)
+            where(tenant_id: tenant_id).find_by_name(name)
+          end
+
+          def self.find_or_create_by_name_and_tenant_id(name, tenant_id)
+            find_by_name_and_tenant_id(name, tenant_id) || create(name: name, tenant_id: tenant_id)
+          end
+        end
+
+        include Taggable
+      end
+    end
+
+  end
+end

data/lib/gutentag/multitenancy/taggable.rb

@@ -0,0 +1,32 @@
+module Gutentag
+  module Multitenancy
+
+    module Taggable
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def has_many_tags
+          super
+          include InstanceMethodsOnActivation
+        end
+      end
+
+      module InstanceMethodsOnActivation
+        def tenant_id
+          raise NotImplementedError, 'taggable must implement'
+        end
+
+        private
+
+        def persist_tags
+          persister = Gutentag::Persistence.new(self)
+          persister.tagger = TenantTagger.new(tenant_id)
+          persister.persist
+        end
+      end
+    end
+
+  end
+end

data/lib/gutentag/multitenancy/tenant_tagger.rb

@@ -0,0 +1,23 @@
+module Gutentag
+  module Multitenancy
+
+    class TenantTagger
+      def initialize(tenant_id)
+        @tenant_id = tenant_id
+      end
+
+      def find_by_name(name)
+        Gutentag::Tag.find_by_name_and_tenant_id(name, tenant_id)
+      end
+
+      def find_or_create(name)
+        Gutentag::Tag.find_or_create_by_name_and_tenant_id(name, tenant_id)
+      end
+
+      private
+
+      attr_reader :tenant_id
+    end
+
+  end
+end

data/lib/gutentag/multitenancy/version.rb

@@ -0,0 +1,5 @@
+module Gutentag
+  module Multitenancy
+    VERSION = "0.1.0"
+  end
+end

data/lib/gutentag/multitenancy.rb

@@ -0,0 +1,11 @@
+Gutentag.tag_validations = lambda { |klass|
+  klass.validates :name,
+    presence: true,
+    uniqueness: {case_sensitive: false, scope: :tenant_id}
+}
+
+require "gutentag/multitenancy/version"
+require "gutentag/multitenancy/tenant_tagger"
+require "gutentag/multitenancy/taggable"
+require "gutentag/multitenancy/engine"
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gutentag-multitenancy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Stewart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: gutentag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Extends Gutentag with support for multitenancy.
+email:
+- boss@airbladesoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gutentag-multitenancy.gemspec
+- lib/gutentag/multitenancy.rb
+- lib/gutentag/multitenancy/engine.rb
+- lib/gutentag/multitenancy/taggable.rb
+- lib/gutentag/multitenancy/tenant_tagger.rb
+- lib/gutentag/multitenancy/version.rb
+homepage: https://github.com/airblade/gutentag-multitenancy
+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: Extends Gutentag with support for multitenancy.
+test_files: []