tag_bearer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c274ae2e03ea354c1015d765e2595f7098ce14d3
+  data.tar.gz: 9eacd3799ec06ad8624c38bac9b5bad2d160c1d5
+SHA512:
+  metadata.gz: ccb008993f158392321469c90bb0fe1e74cb2003bf45968980eb2a50e3088db9237c5e643eb27cc8060dc4edf4c13a473081de9ac573977c5115f5e2e012988f
+  data.tar.gz: d702feb3545219c8aa7caa9655a66005ba186be7b8e4f15e4d516473ad3efc78b96d56e6adf2306490b718db2e5b03ceb27abb30603c150755ae3e24ad5ba14e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 David Jellesma
+
+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/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TagBearer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/generators/tag_bearer/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module TagBearer
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Create migrations for TagBearer'
+
+      def copy_migrations
+        copy_migration 'create_tags'
+      end
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      protected
+
+      def copy_migration(filename)
+        if self.class.migration_exists?('db/migrate', "#{filename}")
+          say_status('skipped', "Migration #{filename}.rb already exists")
+        else
+          migration_template "#{filename}.rb", "db/migrate/#{filename}.rb"
+        end
+      end
+
+    end
+  end
+
+end

data/lib/generators/tag_bearer/templates/create_tags.rb

@@ -0,0 +1,10 @@
+class CreateTags < ActiveRecord::Migration
+  def change
+    create_table(:tags) do |t|
+      t.string :key, required: true
+      t.string :value
+      t.references :taggable, polymorphic: true, index: true
+      t.timestamps null: false
+    end
+  end
+end

data/lib/tag_bearer.rb

@@ -0,0 +1,5 @@
+module TagBearer
+  require 'tag_bearer/acts_as_tag_bearer'
+  require 'tag_bearer/engine' if defined?(Rails)
+  require 'tag_bearer/tag'
+end

data/lib/tag_bearer/acts_as_tag_bearer.rb

@@ -0,0 +1,64 @@
+require 'tag_bearer/acts_as_tag_bearer'
+require 'tag_bearer/tag'
+
+module TagBearer
+
+  def self.tag_table=(name)
+    TagBearer::Tag.table_name = name
+  end
+
+  module ActsAsTagBearer
+    extend ActiveSupport::Concern
+
+    included do; end
+
+    module ClassMethods
+      def acts_as_tag_bearer(options = {})
+        has_many :tags, as: :taggable, class_name: Tag
+        include TagBearer::ActsAsTagBearer::LocalInstanceMethods
+      end
+
+      def find_matches(conditions)
+        TagBearer::Tag.select(:taggable_id)
+          .where(taggable_type: name)
+          .where("(#{TagBearer::Tag.table_name}.key, #{TagBearer::Tag.table_name}.value) IN (#{conditions.join(',')})")
+          .group(:taggable_id, :taggable_type)
+          .having("COUNT(distinct #{TagBearer::Tag.table_name}.key)=#{conditions.size}").pluck(:taggable_id)
+      end
+
+      def with_tags(params)
+        conditions = params.map{ |condition| "('#{condition[0].to_s}', '#{condition[1].to_s}')" }
+        matches = find_matches conditions
+        matches.any? ? (name.constantize.find matches) : []
+      end
+    end
+
+    module LocalInstanceMethods
+      def assign_tag(params)
+        params.keys.each_with_index do |key, index|
+          tags.where(key: key).first_or_create.update(value: params.values[index])
+        end
+      end
+
+      def full_sync!(params)
+        params.each{ |t| tag(t) }
+        tags.where.not(key: params.map{|t| t[:key]}).destroy_all
+      end
+
+      def get_tag(tag)
+        tags.find_by(key: tag).try :value
+      end
+
+      def tag_list
+        tags.pluck(:key)
+      end
+
+      def tag(params)
+        tags.where(key: params[:key]).first_or_create.update(value: params[:value])
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, TagBearer::ActsAsTagBearer

data/lib/tag_bearer/engine.rb

@@ -0,0 +1,5 @@
+require 'rails'
+module TagBearer
+  class Engine < Rails::Engine
+  end
+end

data/lib/tag_bearer/tag.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+module TagBearer
+  class Tag < ActiveRecord::Base
+    belongs_to :taggable, polymorphic: true
+    validates_presence_of :key
+  end
+end

data/lib/tag_bearer/version.rb

@@ -0,0 +1,3 @@
+module TagBearer
+  VERSION = '0.0.2'
+end

data/spec/acts_as_tag_bearer/acts_as_tag_bearer_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe TagBearer::ActsAsTagBearer do
+
+  describe '#tag' do
+    let(:model) { TaggableModel.create }
+
+    it 'creates a single tag' do
+      model.tag key: 'Owner', value: 'someone'
+      expect(model.tags).to have(1).match
+    end
+
+    it 'requires a key' do
+      model.tag value: 'someone'
+      expect(model.tags).to have(0).matches
+    end
+
+    it 'does not require a value' do
+      model.tag key: 'someone'
+      expect(model.tags).to have(1).match
+    end
+
+    it 'overwrites a tag with an existing key' do
+      model.tag key: 'Owner', value: 'someone'
+      expect(model.get_tag('Owner')).to eq 'someone'
+
+      model.tag key: 'Owner', value: 'someone else'
+      expect(model.get_tag('Owner')).to eq 'someone else'
+
+      expect(model.tags).to have(1).match
+    end
+  end
+
+  describe 'get_tag' do
+    let(:model) { TaggableModel.create }
+
+    before(:each) do
+      model.tag key: 'env', value: 'test'
+    end
+
+    it 'returns a tag by name' do
+      expect(model.get_tag('env')).to eq 'test'
+    end
+
+    it 'returns nil if the tag does not exist' do
+      expect(model.get_tag('fake tag')).to be_nil
+    end
+  end
+
+  describe 'full_sync!' do
+    let(:model) { TaggableModel.create }
+
+    before(:each) do
+      model.tag key: 'first', value: 'first value'
+      model.tag key: 'second', value: 'original value'
+      model.tag key: 'third', value: 'on death row'
+
+      model.full_sync!([
+        {key: 'first', value: 'first value'},
+        {key: 'second', value: 'updated value'},
+      ])
+    end
+
+    it 'removes derelict keys' do
+      expect(model.tags.count).to eq 2
+    end
+
+    it 'updates tag values' do
+      expect(model.get_tag('second')).to eq 'updated value'
+    end
+
+    it 'ignores tags with no changes' do
+      expect(model.get_tag('first')).to eq 'first value'
+    end
+  end
+
+  describe 'tag_list' do
+    let(:model) { TaggableModel.create }
+
+    before(:each) do
+      model.tag key: 'env', value: 'production'
+      model.tag key: 'name', value: 'smithers'
+    end
+
+    it 'returns all tag keys' do
+      expect(model.tag_list).to include 'env', 'name'
+    end
+  end
+
+  describe '#with_tags' do
+    context 'using mysql' do
+      it_behaves_like 'a valid adapter'
+
+      before(:all) do
+        ActiveRecord::Base.establish_connection(adapter: 'mysql2', database: 'tag_bearer')
+      end
+    end
+
+    context 'using postgres' do
+      it_behaves_like 'a valid adapter'
+
+      before(:all) do
+        ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: 'tag_bearer')
+      end
+    end
+  end
+
+end

data/spec/acts_as_tag_bearer/tag_bearer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe TagBearer do
+  describe '#tag_table' do
+    let(:new_table_name) { 'taggable' }
+
+    it 'changes the table name' do
+      TagBearer.tag_table = new_table_name
+      expect(TagBearer::Tag.table_name).to eq new_table_name
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'codeclimate-test-reporter'
+require 'rspec/collection_matchers'
+
+CodeClimate::TestReporter.start
+
+$LOAD_PATH << '.' unless $LOAD_PATH.include?('.')
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require File.expand_path('../../lib/tag_bearer', __FILE__)
+
+require 'database_cleaner'
+
+postgres = {adapter: 'postgresql', database: 'tag_bearer', username: 'postgres'}
+mysql = {adapter: 'mysql2', database: 'tag_bearer'}
+
+[postgres, mysql].each do |connection_data|
+  ActiveRecord::Base.establish_connection(connection_data)
+  ActiveRecord::Schema.define do
+    self.verbose = false
+
+    create_table(:tags) do |t|
+      t.string :key
+      t.string :value
+      t.references :taggable, polymorphic: true, index: true
+      t.timestamps null: false
+    end unless table_exists?(:tags)
+
+    create_table :taggable_model, :force => true do |t|
+      t.timestamps null: false
+    end unless table_exists?(:taggable_model)
+  end
+end
+
+Dir['./spec/support/*.rb'].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
+
+
+

data/spec/support/taggable_model.rb

@@ -0,0 +1,4 @@
+class TaggableModel < ActiveRecord::Base
+  self.table_name = 'taggable_model'
+  acts_as_tag_bearer
+end

data/spec/support/with_tags_shared.rb

@@ -0,0 +1,33 @@
+RSpec.shared_examples 'a valid adapter' do
+  let(:collection) { described_class.new([7, 2, 4]) }
+
+  describe '#with_tags' do
+    let(:bran) { TaggableModel.create }
+    let(:jaime) { TaggableModel.create }
+    let(:sansa) { TaggableModel.create }
+    let(:theon) { TaggableModel.create }
+
+    before(:each) do
+      bran.assign_tag home: 'winterfell', family: 'stark', gender: 'male'
+      jaime.assign_tag home: 'casterly rock', family: 'lannister', gender: 'male'
+      sansa.assign_tag home: 'winterfell', family: 'stark', gender: 'female'
+      theon.assign_tag home: 'iron islands', family: 'greyjoy', gender: nil
+    end
+
+    it 'returns matches on a single parameter' do
+      expect(TaggableModel.with_tags(home: 'winterfell')).to have(2).matches
+    end
+
+    it 'returns matches on multiple parameters' do
+      expect(TaggableModel.with_tags(home: 'winterfell', family: 'stark')).to have(2).matches
+    end
+
+    it 'only returns matches on all parameters' do
+      expect(TaggableModel.with_tags(gender: 'male', family: 'stark')).to have(1).match
+    end
+
+    it 'does not consider nil a match' do
+      expect(TaggableModel.with_tags(gender: 'male', family: 'greyjoy')).to have(0).matches
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: tag_bearer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- David Jellesma
+- Dan Jellesma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Key value tagging gem for ActiveRecord models
+email:
+- davidjellesmas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/tag_bearer/install_generator.rb
+- lib/generators/tag_bearer/templates/create_tags.rb
+- lib/tag_bearer.rb
+- lib/tag_bearer/acts_as_tag_bearer.rb
+- lib/tag_bearer/engine.rb
+- lib/tag_bearer/tag.rb
+- lib/tag_bearer/version.rb
+- spec/acts_as_tag_bearer/acts_as_tag_bearer_spec.rb
+- spec/acts_as_tag_bearer/tag_bearer_spec.rb
+- spec/spec_helper.rb
+- spec/support/taggable_model.rb
+- spec/support/with_tags_shared.rb
+homepage: https://github.com/dsjellz/tag_bearer
+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: This gem implements key/value tagging for ActiveRecord models using either
+  mysql2 or postgres adapter
+test_files:
+- spec/acts_as_tag_bearer/acts_as_tag_bearer_spec.rb
+- spec/acts_as_tag_bearer/tag_bearer_spec.rb
+- spec/spec_helper.rb
+- spec/support/taggable_model.rb
+- spec/support/with_tags_shared.rb