has_tags 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d073cf765ae66a310cbe1d9a2e8d26e965479374
+  data.tar.gz: 51c2a060063fb1f153796cc86b95f252390adeec
+SHA512:
+  metadata.gz: 176ad7c46525c301cc366d8ad8a0132bebfeb4799d152e7263eca976813e600e301c7e6ae2531599ad4aaa5d8de00c708ad1fe6c62c7ef872d2e6a6045291bf5
+  data.tar.gz: 704a4b62b72c1ca65da8e73659a0c49c2e1f31ca2e4803edf51b0a5e975e919002213662bc0d2720f03fcf483d4e869e19374cc653e07e4095d6a253ed713653

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_tags.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Garrett Martin
+
+MIT License
+
+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,88 @@
+# HasTags
+
+HasTags is a lightweight library for easily adding tags to your ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_tags'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_tags
+
+## Usage
+
+First, you must run <code>rails g has_tags:install</code> to install the tag migrations.
+
+Once the migrations are installed, run <code>rake db:migrate</code>.
+
+Now choose a model to add tags to. Let's use <code>Post</code> as an example. All you have to do is add <code>has_tags</code> to the model class definition:
+
+  ```ruby
+  class Post < ActiveRecord::Base
+    has_tags
+  end
+
+  ```
+
+Your post class can now have associated tags.
+
+To set tags on a <code>Post</code> instance, whitelist the <code>tag_list</code> parameter in your controller:
+
+```ruby
+class PostController < ActiveRecord::Base
+  # ...
+
+  private
+
+  def post_params
+    params.require(:post).permit(:param1, :param2, :tag_list)
+  end
+end
+```
+
+<code>tag_list</code> should be a string with tags separated by commas, or colons to make a context tag.
+
+### Examples
+
+For creating top-level tags, a user can type in tags only separated by commas:
+
+"Sports, Food"
+
+For creating tags within tags, where to top-level tag acts as the context or parent for the child tag, separate the tags by colons:
+
+"Sports:Hockey, Food"
+
+This creates three tags: Sports, Hockey and Food. Sports is now the context in which Hockey lives. Now we can call:
+
+```ruby
+context = Tag.find_by(name: "Sports")
+
+context.tags # => Hockey tag
+```
+
+The context tag syntax can be nested like so:
+
+"Sports:Hockey:Strategy"
+
+```ruby
+strategy = Tag.find_by(name: "Strategy")
+
+hockey = strategy.context # => Hockey tag
+
+hockey.context # => Sports tag
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/db/migrate/taggable_migration.rb

@@ -0,0 +1,13 @@
+class TaggableMigration < ActiveRecord::Migration
+  def change
+    create_table :tags do |t|
+      t.string :name
+      t.integer :context_id
+    end
+
+    create_table :taggings do |t|
+      t.references :tag
+      t.references :taggable, polymorphic: true
+    end 
+  end
+end

data/has_tags.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_tags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_tags"
+  spec.version       = HasTags::VERSION
+  spec.authors       = ["Garrett Martin"]
+  spec.email         = ["me@garrettqmartin.com"]
+  spec.description   = %q{Simple tagging with contexts.}
+  spec.summary       = %q{Simple tagging with contexts.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord'
+
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "shoulda-matchers"
+end

data/lib/generators/has_tags/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module HasTags
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("../../../../db/migrate", __FILE__)
+    
+    def create_migrations
+      migration_template "taggable_migration.rb", "db/migrate/taggable_migration.rb"
+    end
+
+    def self.next_migration_number(path)
+      @migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i.to_s
+    end
+  end
+end

data/lib/has_tags.rb

@@ -0,0 +1,10 @@
+require "has_tags/version"
+require "active_record" 
+
+module HasTags
+  require "has_tags/tag"
+  require "has_tags/tagging"
+  require "has_tags/taggable" 
+
+  ActiveRecord::Base.extend Taggable
+end

data/lib/has_tags/tag.rb

@@ -0,0 +1,10 @@
+module HasTags
+  class Tag < ::ActiveRecord::Base
+    belongs_to :context, class_name: "Tag"
+
+    has_many :tags, foreign_key: :context_id
+    has_many :taggings
+
+    validates :name, uniqueness: true, presence: true  
+  end
+end

data/lib/has_tags/taggable.rb

@@ -0,0 +1,46 @@
+module HasTags
+  module Taggable
+    # This implementation requires that the taggable module be 
+    # used like this: 
+    #
+    # include HasTags::Taggable
+    #
+    # in whatever model you wish to have tags.
+    #
+    #
+    # def self.included(base)
+    #   base.class_eval do
+    #     has_many :taggings, as: :taggable, class_name: "HasTags::Tagging"
+    #     has_many :tags, through: :taggings, class_name: "HasTags::Tag"
+    #   end
+    # end
+
+    def has_tags
+      has_many :taggings, as: :taggable, class_name: "HasTags::Tagging"
+      has_many :tags, through: :taggings, class_name: "HasTags::Tag"
+
+      include InstanceMethods
+    end
+
+    module InstanceMethods
+      def tag_list
+        tags.map(&:name).join(", ")
+      end
+
+      def tag_list=(tag_names)
+        tag_names.split(",").map do |tag_name|
+          names = tag_name.strip.split(":") 
+          names.each_with_index do |name, index|
+            if index < 1
+              tag = HasTags::Tag.where(name: name).first_or_create!
+            else
+              tag = HasTags::Tag.where(name: name, context_id: Tag.find_by(name: names[index-1]).id).first_or_create!
+            end
+            HasTags::Tagging.where(tag_id: tag.id, taggable: self).first_or_create!
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/has_tags/tagging.rb

@@ -0,0 +1,8 @@
+module HasTags
+  class Tagging < ::ActiveRecord::Base
+    validates :tag_id, presence: true
+
+    belongs_to :tag
+    belongs_to :taggable, polymorphic: true
+  end
+end

data/lib/has_tags/version.rb

@@ -0,0 +1,3 @@
+module HasTags
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'has_tags'
+require 'support/database_cleaner'
+require 'support/taggable_model'
+require 'database_cleaner'
+require 'shoulda/matchers'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", 
+                                       :database => ":memory:")
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :tags, force: true do |t|
+    t.string :name
+    t.integer :context_id
+  end
+
+  create_table :taggings, force: true do |t|
+    t.references :tag
+    t.references :taggable, polymorphic: true
+  end
+
+  create_table :taggable_models, force: true do |t|
+    t.string :name
+  end
+  
+end
+

data/spec/support/database_cleaner.rb

@@ -0,0 +1,23 @@
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

data/spec/support/taggable_model.rb

@@ -0,0 +1,3 @@
+class TaggableModel < ActiveRecord::Base
+  has_tags
+end

data/spec/tag_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe HasTags::Tag do
+  it "should create tag with valid name" do
+    HasTags::Tag.create(name: "Sports")
+    expect(HasTags::Tag.all.count).to eq(1)
+  end
+
+  it "should fail without a name" do
+    HasTags::Tag.create(name: nil) 
+    expect(HasTags::Tag.all.count).to eq(0) 
+  end
+
+  it "should fail if a tag with that name already exists" do
+    HasTags::Tag.create(name: "Sports")
+    HasTags::Tag.create(name: "Sports") 
+    expect(HasTags::Tag.all.count).to eq(1)
+  end
+end

data/spec/taggable_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe TaggableModel do
+  let (:model) { TaggableModel.create(name: "post") }
+ 
+  it { should have_many(:taggings) }
+  it { should have_many(:tags) } 
+ 
+  context "setting tag list" do
+    it "should be able to use two separate tags" do
+      tag_names = "Sports, Food"
+      model.tag_list = tag_names
+
+      expect(model.tags.count).to eq(2)
+    end 
+
+    it "should create a context tag with colon" do
+      tag_names = "Sports:Lacrosse"
+      model.tag_list = tag_names
+
+      expect(HasTags::Tag.last.context.name).to eq("Sports")
+    end
+    
+    it "should support multiple nested contexts" do
+      tag_names = "Sports:Lacrosse:Plays"
+      model.tag_list = tag_names
+
+      expect(HasTags::Tag.last.context.name).to eq("Lacrosse")
+    end
+  end
+
+  it "should retrieve tag list" do
+    tag_names = "Sports:Lacrosse"
+    model.tag_list = tag_names
+
+    expect(model.tag_list).to eq("Sports, Lacrosse")
+  end
+end

data/spec/tagging_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe HasTags::Tagging do
+  let(:tag) { HasTags::Tag.create(name: "Sports") }
+  let(:model) { TaggableModel.create(name: "Post") }
+
+  it "should create a tagging" do
+    HasTags::Tagging.create(tag_id: tag.id, taggable_id: model.id, taggable_type: model.class.to_s)   
+    expect(HasTags::Tagging.count).to eq(1)
+  end
+
+  it "should fail without tag_id" do
+    HasTags::Tagging.create(taggable_id: model.id, taggable_type: model.class.to_s)
+    expect(HasTags::Tagging.count).to eq(0) 
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: has_tags
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Garrett Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: shoulda-matchers
+  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'
+description: Simple tagging with contexts.
+email:
+- me@garrettqmartin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/migrate/taggable_migration.rb
+- has_tags.gemspec
+- lib/generators/has_tags/install_generator.rb
+- lib/has_tags.rb
+- lib/has_tags/tag.rb
+- lib/has_tags/taggable.rb
+- lib/has_tags/tagging.rb
+- lib/has_tags/version.rb
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/taggable_model.rb
+- spec/tag_spec.rb
+- spec/taggable_spec.rb
+- spec/tagging_spec.rb
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Simple tagging with contexts.
+test_files:
+- spec/spec_helper.rb
+- spec/support/database_cleaner.rb
+- spec/support/taggable_model.rb
+- spec/tag_spec.rb
+- spec/taggable_spec.rb
+- spec/tagging_spec.rb
+has_rdoc: