redis_tags 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Elad Meidar
+
+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,71 @@
+# RedisTags
+
+RedisTags is a simple graph based implementation of a tagging system.
+Instead of using complex relational structure, this implementation consists of using Redis sets for reference and aggregation.
+
+## Example:
+
+Say we tag a `User` instance with a tag named `tzetzi`:
+
+    @user = User.new
+    @user.tags_collection << `tzetzi`
+    @user.save                        # => <User: id:1> 
+
+Now in Redis, we will have these keys:
+
+1. A set that holds the ids of the users tagged by "tzetzi"
+
+    user:tagged_with:tzetzi => [1]
+
+2. A set that holds all the tags for a specific user instance
+
+    user:1:tag_list => ["tzetzi"]
+
+3. A complete breakdown of each tag per char, to allow simple autocomplete interface
+
+    tag:all:t                     # => ["tzetzi"]
+    tag:all:tz                    # => ["tzetzi"]
+    tag:all:tze                   # => ["tzetzi"]
+    tag:all:tzet                  # => ["tzetzi"]
+    tag:all:tzetz                 # => ["tzetzi"]
+    tag:all:tzetzi                # => ["tzetzi"]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_tags'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_tags
+
+## Usage
+
+    class User
+
+        include RedisTags
+
+        uses_redis_tags :engine => Redis.new
+    end
+
+    @user = User.new
+    @user.tag_collection                  # => []
+    @user.tag_collection << "elad"        # => ["elad"]
+    @user.tag_collection = ["beata"]      # => ["beata"]
+    @user.save
+
+    User.tagged_with(:tags => ["elad"])   # => [@user.id]
+    User.tagged_with_prefix("el")         # => ["elad"]
+
+## 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/lib/redis_tags/tag.rb

@@ -0,0 +1,68 @@
+class Tag
+  attr_accessor :name
+  attr_reader :owner_class
+
+  attr_reader :owner
+
+  def initialize(owner, name)
+    @owner_class = owner.class.to_s.downcase
+    @name = name.downcase.strip
+    @owner = owner
+  end
+
+  def Tag.starts_with?(use_engine, partial_tag_name)
+    use_engine.smembers "tags:all:#{partial_tag_name}"
+  end
+
+  def Tag.register_tag_for_autocomplete(use_engine, tag_name)
+    partial_tag_name = ""
+    tag_name.each_char do |char|
+      partial_tag_name += char
+      use_engine.sadd "tags:all:#{partial_tag_name}", tag_name
+    end
+  end
+
+  def count
+    engine.scard redis_key
+  end
+
+  def Tag.tagged_with(klass, options = {})
+#debugger
+    key_array = []
+    if options[:tags].to_a.size == 1
+      if options[:random].to_i > 0
+        klass.redis_tags_engine.srandmember Tag.tagged_with_key_for(klass, options[:tags]), options[:random].to_i
+      else
+        klass.redis_tags_engine.smembers Tag.tagged_with_key_for(klass, options[:tags])
+      end
+    else
+      options[:tags].to_a.each do |tag_name|
+        key_array << Tag.tagged_with_key_for(klass, tag_name)
+      end
+      klass.redis_tags_engine.sinterstore Tag.intersect_key_for(klass, options[:tags]), *key_array
+      if options[:random].to_i > 0
+        klass.redis_tags_engine.srandmember Tag.intersect_key_for(klass, options[:tags]), options[:random].to_i
+      else
+        klass.redis_tags_engine.smembers Tag.intersect_key_for(klass, options[:tags])
+      end
+    end
+  end
+
+  protected
+
+  def Tag.intersect_key_for(klass, tags)
+    "#{klass.to_s.downcase}:inter:#{tags.sort.collect{ |tag_name| tag_name.downcase.strip.gsub(" ", '-') }.join(":")}"
+  end
+
+  def Tag.tagged_with_key_for(klass, tag_name)
+    "#{klass.to_s.downcase}:tagged_with:#{tag_name.to_s.downcase.strip.gsub(" ", '-')}"
+  end
+
+  def engine
+    self.owner.class.redis_tags_engine
+  end
+
+  def redis_key
+    "#{self.owner_class}:tagged_with:#{self.name.downcase.gsub(" ", '-')}"
+  end
+end

data/lib/redis_tags/tag_list.rb

@@ -0,0 +1,78 @@
+module RedisTags
+  class TagList < Array
+
+    attr_reader :owner, :owner_class, :owner_id, :tags
+    
+    def initialize(owner)
+      @owner = owner
+      @owner_class = owner.class.to_s.downcase
+      @owner_id = owner.id
+      super(engine.smembers(self.redis_key))
+      self
+    end
+
+    def <<(tag_name)
+      tag_name = tag_name.downcase.strip
+      if !(self.owner_id.nil?)
+        engine.multi do
+          engine.sadd self.redis_key, tag_name
+          engine.sadd "#{self.owner_class}:tagged_with:#{tag_name.gsub(" ", '-')}", self.owner_id
+        end
+        engine.multi do
+          Tag.register_tag_for_autocomplete(engine, tag_name)
+        end
+      end
+      super(tag_name)
+    end
+
+    def delete(tag_name)
+      tag_name = tag_name.downcase.strip
+      if !(self.owner_id.nil?)
+        engine.multi do
+          engine.srem self.redis_key, tag_name
+          engine.srem "#{self.owner_class}:tagged_with:#{tag_name.gsub(" ", '-')}", self.owner_id
+        end
+      end
+      super(tag_name)
+    end
+
+    def delete_all
+      if !(self.owner_id.nil?)
+        engine.multi do
+          engine.del self.redis_key
+          self.each do |tag_name|
+            engine.srem "#{self.owner_class}:tagged_with:#{tag_name.gsub(" ", '-')}", self.owner_id
+          end
+        end
+      end
+      self.each do |tag_name|
+        self.delete(tag_name)
+      end
+      self
+    end
+
+    def append_multi(tags)
+      if tags.is_a?(String)
+        tags = tags.split(",").collect {|tag| tag.strip.downcase}
+      end
+      tags.each do |tag|
+        self << tag
+      end
+      self
+    end
+
+    def save
+      my_tags = self.dup
+      delete_all
+      self.append_multi(my_tags)
+    end
+
+    def engine
+      self.owner.class.redis_tags_engine
+    end
+
+    def redis_key
+      "#{self.owner_class}:#{self.owner_id}:tag_list"
+    end
+  end
+end

data/lib/redis_tags/version.rb

@@ -0,0 +1,3 @@
+module RedisTags
+  VERSION = "0.0.1"
+end

data/lib/redis_tags.rb

@@ -0,0 +1,81 @@
+require "redis_tags/version"
+require "redis_tags/tag"
+require "redis_tags/tag_list"
+
+module RedisTags
+  
+  def self.included(base)
+    base.class_eval do
+
+      extend ClassMethods
+      include InstanceMethods
+
+      #after_save :update_tags_to_redis
+
+      @@redis_tags_engine = nil
+      @@acts_as_taggable_on_steroids_legacy = false
+    end
+  end
+
+  module ClassMethods
+
+    def uses_redis_tags(options = {})
+      options = {:engine => Redis.new, :acts_as_taggable_on_steroids_legacy_mode => false}.merge!(options)
+      @@redis_tags_engine = options[:engine]
+      @@acts_as_taggable_on_steroids_legacy = options[:acts_as_taggable_on_steroids_legacy_mode]
+    end
+
+    def redis_tags_engine=(redis_instance)
+      @@redis_tags_engine = redis_instance
+    end
+
+    def acts_as_taggable_on_steroids_legacy_mode?
+      @@acts_as_taggable_on_steroids_legacy == true
+    end
+
+    def redis_tags_engine
+      @@redis_tags_engine
+    end
+
+    def tagged_with(options = {})
+      Tag.tagged_with(self, options)
+    end
+
+    def tagged_with_prefix(partial_tag_name)
+      Tag.starts_with?(self.redis_tags_engine, partial_tag_name)
+    end
+  end
+
+  module InstanceMethods
+
+    def tag_list
+      if self.class.acts_as_taggable_on_steroids_legacy_mode?
+        legacy_tag_list = super()
+        tags_collection = legacy_tag_list
+        legacy_tag_list
+      else
+        tags_collection
+      end
+    end
+
+    def tags_collection
+      @tag_list ||= RedisTags::TagList.new(self)
+    end
+
+    def tag_with(tag)
+      tags_collection << tag
+    end
+
+    def tags_collection=(new_tag_list)
+      tags_collection.delete_all
+      @tag_list = RedisTags::TagList.new(self).append_multi(new_tag_list)
+    end
+
+    private
+
+    # After save callback, confirms that redis is saved after object exists.
+    def update_tags_to_redis
+      tags_collection = @tag_list
+    end
+  end
+end

data/redis_tags.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_tags/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis_tags"
+  gem.version       = RedisTags::VERSION
+  gem.authors       = ["Elad Meidar"]
+  gem.email         = ["elad@eizesus.com"]
+  gem.description   = "A tagging system implemented in Redis graph"
+  gem.summary       = "This implementation consists over 3 basic rules. keep who is tagged, keep what is tagged and keep all tags."
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "redis", "2.2.2"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "ruby-debug"
+end

data/spec/models/book.rb

@@ -0,0 +1,18 @@
+class Book
+  include RedisTags
+
+  uses_redis_tags
+
+  def new
+    @id = nil
+  end
+
+  def id
+    @id
+  end
+
+  def save
+    @id = rand(1000)
+    self.tags_collection = RedisTags::TagList.new(self).append_multi(@tag_list)
+  end
+end

data/spec/spec/redis_tags_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe RedisTags do
+  describe "#tags_list" do
+    it "should return a empty array for a new object" do
+      Book.new.tags_collection.should eql([])
+    end
+
+    it "should create multiple tags" do
+      @book = Book.new
+      @book.tags_collection = "elad, koko, loko"
+      @book.tags_collection.should  eql(["elad", "koko", "loko"])
+    end
+
+    it "should save a new tag using <<" do
+      @book = Book.new
+      @book.tag_with "elad"
+      @book.tags_collection.should eql(["elad"])
+    end
+
+    it "should save a new tag downcased" do
+      @book = Book.new
+      @book.tag_with "ELAD"
+      @book.tags_collection.should eql(["elad"])
+    end
+
+    it "should support backward compatibility for acts_as_taggable_on_steroids (#tag_list)" do
+      Book.class_eval do
+        uses_redis_tags :acts_as_taggable_on_steroids_legacy_mode => true
+      end
+
+      @book = Book.new
+      lambda {
+        @book.tag_list
+      }.should raise_error(NoMethodError)
+    end
+
+    it "should update Redis tags collection with backward compatibility for acts_as_taggable_on_steroids (#tag_list)" do
+      Book.class_eval do
+        uses_redis_tags :acts_as_taggable_on_steroids_legacy_mode => true
+      end
+
+      @book = Book.new
+      lambda {
+        @book.tag_list
+      }.should raise_error(NoMethodError)
+
+      @book.tags_collection.should eql([])
+    end
+  end
+end

data/spec/spec/tag_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Tag do
+
+  before(:each) do
+      Book.redis_tags_engine.flushdb
+  end
+
+  it "should initialize a new Tag instance" do
+    @b = Book.new
+    @t = Tag.new(@b, "koksi")
+    @t.name.should == "koksi"
+    @t.owner_class.should == "book"
+    
+    @t.count.should be_zero
+  end
+
+  it "should intersect more than 1 tag" do
+    @book1 = Book.new
+    @book2 = Book.new
+#debugger
+    @book1.tags_collection = "elad, deddy, erez"
+
+    @book1.save
+    @book2.tags_collection = "elad, deddy"
+    @book2.save
+
+    [@book1.id, @book2.id].should =~ Tag.tagged_with(Book, {:tags => ["elad", "deddy"]}).collect(&:to_i)
+  end
+
+  it "should intersect 1 tag" do
+    @book1 = Book.new
+    @book2 = Book.new
+
+    @book1.tags_collection = "elad, deddy, erez"
+    @book1.save
+    @book2.tags_collection = "elad, deddy"
+    @book2.save
+
+    [@book1.id, @book2.id].should =~ Tag.tagged_with(Book, {:tags => ["elad"]}).collect(&:to_i)
+  end
+
+  it "should log autocomplete options for each tag" do
+    @book = Book.new
+    @book.tags_collection = "elad", "eli", "eliran hamelech shel ramle"
+    @book.save
+    Book.tagged_with_prefix("el").should =~ ["elad", "eli", "eliran hamelech shel ramle"]
+    Book.tagged_with_prefix("ela").should =~ ["elad"]
+    Book.tagged_with_prefix("eli").should =~ ["eli", "eliran hamelech shel ramle"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'redis'
+require 'ruby-debug'
+
+require 'redis_tags' # and any other gems you need
+require 'models/book'
+
+Redis.new.flushdb
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: redis_tags
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Elad Meidar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A tagging system implemented in Redis graph
+email: 
+- elad@eizesus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_tags.rb
+- lib/redis_tags/tag.rb
+- lib/redis_tags/tag_list.rb
+- lib/redis_tags/version.rb
+- redis_tags.gemspec
+- spec/models/book.rb
+- spec/spec/redis_tags_spec.rb
+- spec/spec/tag_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This implementation consists over 3 basic rules. keep who is tagged, keep what is tagged and keep all tags.
+test_files: 
+- spec/models/book.rb
+- spec/spec/redis_tags_spec.rb
+- spec/spec/tag_spec.rb
+- spec/spec_helper.rb