lean_tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5cf556a9c2a9df241b42def112546eae8296a4c
+  data.tar.gz: 7d543b45c7596ec547f85715f340a21da152d353
+SHA512:
+  metadata.gz: c357fffbd13651a7cde6121681f3a936faff15ac155a25e6522da539278c8908892208ceb32da8e78de6cf2d72a48706cacbe99852befdd7a73f6afeac9b5148
+  data.tar.gz: 7a2fed477fb443be8e657cb652c831487b5812034f086ddb79cdc2a66ce4e78198e547412337a08aa1e5c8fbd9112c3438e9ec9ce47075ef1121a351236e251a

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/db/migrate/1_create_tags.rb

@@ -0,0 +1,9 @@
+class CreateTags < ActiveRecord::Migration
+  def change
+    create_table :tags do |t|
+      t.string :name, null: false, index: true
+      t.integer :taggings_count, null: false, default: 0
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/2_create_taggings.rb

@@ -0,0 +1,10 @@
+class CreateTaggings < ActiveRecord::Migration
+  def change
+    create_table :taggings do |t|
+      t.references :tag, index: true
+      t.references :record, polymorphic: true, index: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/lean_tag/engine.rb

@@ -0,0 +1,13 @@
+require 'rails/engine'
+
+require 'lean_tag/tag'
+require 'lean_tag/taggable'
+require 'lean_tag/tagging'
+
+module LeanTag
+  class Engine < ::Rails::Engine
+
+    isolate_namespace LeanTag
+
+  end
+end

data/lib/lean_tag/tag.rb

@@ -0,0 +1,16 @@
+module LeanTag
+  class Tag < ActiveRecord::Base
+
+    has_many :records, through: :taggings
+    has_many :taggings, class_name: "LeanTag::Tagging", inverse_of: :tag, counter_cache: true
+
+    scope :ranked, -> { order("taggings_count DESC") }
+
+    validates :name, presence: true, uniqueness: true
+
+    def name=(value)
+      self[:name] = value.present? ? value.gsub(/[^0-9a-zA-Z]+/, "").downcase : nil
+    end
+
+  end
+end

data/lib/lean_tag/taggable.rb

@@ -0,0 +1,116 @@
+module LeanTag
+  module Taggable
+
+    def self.included(base)
+      base.class_eval do
+        has_many :taggings, class_name: "LeanTag::Tagging", as: :record, inverse_of: :record, dependent: :destroy
+        has_many :tags, through: :taggings
+
+        accepts_nested_attributes_for :taggings, allow_destroy: true
+
+        scope :with_tags, -> { includes(:tags) }
+      end
+    end
+
+    ##
+    # Adds a single tag on parent save
+    def add_tag(tag)
+      if tag.is_a?(String)
+        tag_name = tag
+        tag = Tag.find_by_name(tag_name)
+
+        if tag.nil?
+          self.tags.build(name: tag_name)
+        elsif !self.taggings.exists?(tag_id: tag.id)
+          self.taggings.build(tag_id: tag.id)
+        end
+      else
+        self.taggings.build(tag_id: tag.id)
+      end
+    end
+
+    ##
+    # Adds a single tag immediately
+    def add_tag!(tag)
+       if tag.is_a?(String)
+        tag_name = tag
+        tag = Tag.find_by_name(tag_name)
+
+        if tag.nil?
+          self.tags.create(name: tag_name)
+        elsif !self.taggings.exists?(tag_id: tag.id)
+          self.taggings.create(tag_id: tag.id)
+        end
+      else
+        self.taggings.create(tag_id: tag.id)
+      end
+    end
+
+    ##
+    # Destroy a tag if it's no longer in use
+    def destroy_if_unused(tag)
+      if tag.taggings_count && LeanTag.remove_unused
+        tag.destroy
+      end
+    end
+
+    ##
+    # Finds current tags on this record which aren't in the passed list
+    def excluded_tags(tag_names)
+      self.with_tags.tags.reject { |t| t.name.in?(tag_names) }
+    end
+
+    ##
+    # Finds a tag on this record by name
+    def find_tag(tag_name)
+      self.tags.find_by_name(tag_name)
+    end
+
+    ##
+    # Finds current tags on this record which are in the passed list
+    def included_tags(tag_names)
+      self.with_tags.tags.select { |t| t.name.in?(tag_names) }
+    end
+
+    ##
+    # Removes a single tag on parent save
+    def remove_tag(tag, method='mark_for_destruction')
+      tag = self.find_tag(tag) if tag.is_a?(String)
+
+      tagging = tagging.find_by_tag_id(tag.id)
+      tagging.send(method) unless tagging.nil?
+
+      destroy_if_unused(tag)
+    end
+
+    ##
+    # Removes a single tag immediately
+    def remove_tag!(tag)
+      tag = self.find_tag(tag) if tag.is_a?(String)
+
+      tagging = tagging.find_by_tag_id(tag.id)
+      tagging.destroy unless tagging.nil?
+
+      destroy_if_unused(tag)
+    end
+
+    ##
+    # Set a list of tags
+    def tag_list=(value)
+      tag_names = value.blank? ? [] : value.split(LeanTag.delimiter)
+
+      # Get rid of existing tags that aren't in the list
+      self.excluded_tags(tag_names).each { |t| self.remove_tag(t) }
+
+      # Add any new tags
+      tag_names.each { |t| self.add_tag(t) }
+    end
+
+    ##
+    # Returns a delimited list of tag names
+    def tag_list
+      self.tags.map(&:name).join(LeanTag.delimiter)
+    end
+
+  end
+end

data/lib/lean_tag/tagging.rb

@@ -0,0 +1,12 @@
+module LeanTag
+  class Tagging < ActiveRecord::Base
+
+    belongs_to :record, polymorphic: true, inverse_of: :taggings
+    belongs_to :tag, class_name: "LeanTag::Tag", inverse_of: :taggings
+
+    validates :record_id, presence: true
+    validates :record_type, presence: true
+    validates :tag, presence: true, uniqueness: { scope: [:record_type, :record_id] }
+
+  end
+end

data/lib/lean_tag/version.rb

@@ -0,0 +1,5 @@
+module LeanTag
+
+  VERSION = '0.1.0'
+
+end

data/lib/lean_tag.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'active_record/version'
+require 'active_support/core_ext/module'
+
+require_relative 'lean_tag/engine' if defined?(Rails)
+
+module LeanTag
+
+  def self.setup
+    @configuration ||= Configuration.new
+    yield @configuration if block_given?
+  end
+
+  class Configuration
+
+    attr_accessor :delimiter, :force_lowercase, :force_parameterize
+
+    def initialize
+      self.delimiter = ','
+      self.force_lowercase = true
+      self.remove_unused = true
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: lean_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Ellis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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-rails
+  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: 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: 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'
+description: And simple and clean implementation of content tagging for Rails 4 and
+  above
+email:
+- m.ellis27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- db/migrate/1_create_tags.rb
+- db/migrate/2_create_taggings.rb
+- lib/lean_tag.rb
+- lib/lean_tag/engine.rb
+- lib/lean_tag/tag.rb
+- lib/lean_tag/taggable.rb
+- lib/lean_tag/tagging.rb
+- lib/lean_tag/version.rb
+homepage: https://github.com/waffleau/lean_tag
+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.4
+signing_key: 
+specification_version: 4
+summary: A lightweight method for tagging content
+test_files: []