tagtical 1.2.0 → 1.3.0

data/README.rdoc

@@ -35,7 +35,8 @@ parsed.
     # would give you a tag of "red, blue" instead of "red" and "blue".
     tag_list.add("red, blue", :parse => false)
 
-7. Custom contexts are *not* supported since we use STI.
+7. Custom contexts are *not* supported since we use STI. That is, you must define a set of tag types
+ahead of time.
 
 Additions include:
 1. Scopes are created on Tag so you can do photo.tags.color and grab all the tags of type Tag::Color, for example.
@@ -108,10 +109,12 @@ rake spec:plugins
       end
     end
 
+    # Basic TagList Functionality
     @user = User.new(:name => "Bobby")
     @user.tag_list = "awesome, slick, hefty" # this should be familiar
-    @user.activity_list = "joking, clowning, boxing" # but you can do it for any context!
-    @user.activity_list                      # => ["joking","clowning","boxing"] as TagList
+    @user.activity_list = "joking, clowning, boxing" 
+    @user.activity_list        # => ["joking","clowning","boxing"] as TagList
+    @user.activity_list.to_s   # => "joking, clowning, boxing"
     @user.save
 
     # Cascade tag_list setters =)
@@ -122,7 +125,6 @@ rake spec:plugins
 
     @user.tags # => [<Tag value:"awesome">,<Tag value:"slick">,<Tag value:"hefty">]
     @user.activities # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">,<Tag::Activity value:"boxing">]
-    @user.activities.first.athletic? # => false
 
     @frankie = User.create(:name => "Frankie", :activity_list => "joking, flying, eating")
     User.activity_counts # => [<Tag::Activity value="joking" count=2>,<Tag::Activity value="clowning" count=1>...]
@@ -132,20 +134,39 @@ rake spec:plugins
                                          # from Activity to Sport and give it a relevance of 4.5.
     @user.save
 
+    # Possible Values Checking
     @user.sport_list = {"chess"}
-    @user.save! # <=== will throw an error, chess is not a sport!
+    @user.save! # <=== will throw an error, chess is not in possible_values from Tag::Sport
 
+    # Tagging Scopes
     @user.activities # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">,<Tag::Sport value:"boxing">]
     @user.activities(:scope => :children) # => [<Tag::Sport value:"boxing">] - look at only the STI subclasses
-    @user.tags(:scope => :children, :except => :sports) # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">] - filter list
-    @user.tags(:scope => :children, :only => :sports) # => [<Tag::Sport value:"boxing">] - filter list
-    @user.activities(:scope => :<) # => [<Tag::Sport value:"boxing">] - look at only the STI subclasses
+    @user.activities(:children)           # => shorthand for above
+    @user.tags(:scope => :children, :except => :sports) # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">]
+                                                        #  - filter list by excluding
+    @user.tags(:scope => :children, :only => :sports)   # => [<Tag::Sport value:"boxing">]
+                                                        #  - filter list by including
+
+    @user.activities(:scope => )         # => [<Tag::Sport value:"boxing">] - look at only the STI subclasses
     @user.activities(:scope => :current) # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">] - look at only the current STI class
-    @user.activities(:scope => :==) # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">] - look at only the current STI class
+    @user.activities(:scope => :==)      # => [<Tag::Activity value:"joking">,<Tag::Activity value:"clowning">] - look at only the current STI class
 
+    # Questioner Methods
     @user.activities.first.athletic? # => false
     @user.sports.all(&:ball?) # => true
 
+    # Database Access Optimizations
+    ** Sequence 1
+    @user.tags.to_a # load in the tags
+    @user.sports.to_a     # will not trigger a database hit, instead will get the sports tags off tags
+    @user.activities.to_a # same as above
+
+    ** Sequence 2
+    @user.activities.to_a # load in the tags
+    @user.sports.to_a     # will not trigger a database hit, instead will get the sports tags off activities, since it inherits from activities
+    @user.sports(:conditions => "value='Soccer'") # will actually hit the database if arguments are passed in.
+
+
 
 --- Defining Subclasses
 
@@ -196,8 +217,8 @@ compatibility with the will_paginate gem:
       named_scope :by_join_date, :order => "created_at DESC"
     end
 
-    User.tagged_with("awesome").by_date
-    User.tagged_with("awesome").by_date.paginate(:page => params[:page], :per_page => 20)
+    User.tagged_with("awesome").by_join_date
+    User.tagged_with("awesome").by_join_date.paginate(:page => params[:page], :per_page => 20)
 
     # Find a user with matching all tags, not just one
     User.tagged_with(["awesome", "cool"], :match_all => :true)

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/tagtical/tag.rb

@@ -232,17 +232,17 @@ module Tagtical
       #   <tt>only</tt> - An array of the following: :parents, :current, :children. Will construct conditions to query the current, parent, and/or children STI classes.
       #
       def finder_type_condition(*args)
-        scopes, options = convert_finder_type_arguments(*args)
+        sql = args[-1].is_a?(Hash) && args[-1].delete(:sql)
 
         sti_column = Tagtical::Tag.arel_table[Tagtical::Tag.inheritance_column]
-        condition = expand_tag_types(scopes, options).map { |x| x.klass.sti_name }.inject(nil) do |conds, sti_name|
+        condition = expand_tag_types(*args).map { |x| x.klass.sti_name }.inject(nil) do |conds, sti_name|
           cond = sti_column.eq(sti_name)
           conds.nil? ? cond : conds.or(cond)
         end
 
-        if condition && options[:sql]
+        if condition && sql
           condition = condition.to_sql
-          condition.insert(0, " AND ") if options[:sql]==:append
+          condition.insert(0, " AND ") if sql==:append
         end
         condition
       end
@@ -301,6 +301,38 @@ module Tagtical
         end
       end
 
+      def expand_tag_types(*args)
+        scopes, options = convert_finder_type_arguments(*args)
+        classes, types = [], []
+
+        types.concat(Array(options[:types]).map { |t| taggable_class.find_tag_type!(t) }) if options[:types]
+
+        if scopes.include?(:current)
+          classes << klass
+        end
+        if scopes.include?(:children)
+          classes.concat(klass.descendants)
+        end
+        if scopes.include?(:parents) # include searches up the STI chain
+          parent_class = klass.superclass
+          while parent_class <= Tagtical::Tag
+            classes << parent_class
+            parent_class = parent_class.superclass
+          end
+        end
+
+        if options[:only]
+          classes &= find_tag_classes_for(options[:only])
+        elsif options[:except]
+          except = find_tag_classes_for(options[:except])
+          classes.reject! { |t| except.any? { |e| t <= e }}
+        end
+        tag_types_by_classes = taggable_class.tag_types.index_by(&:klass)
+        types.concat(classes.map { |k| tag_types_by_classes[k] }.uniq.compact)
+
+        types # for clarity
+      end
+
       private
 
       # Returns an array of potential class names for this specific type.
@@ -358,37 +390,7 @@ module Tagtical
         [scopes, options]
       end
 
-      def expand_tag_types(scopes, options)
-        classes, types = [], []
-        types.concat(Array(options[:types]).map { |t| taggable_class.find_tag_type!(t) }) if options[:types]
-
-        if scopes.include?(:current)
-          classes << klass
-        end
-        if scopes.include?(:children)
-          classes.concat(klass.descendants)
-        end
-        if scopes.include?(:parents) # include searches up the STI chain
-          parent_class = klass.superclass
-          while parent_class <= Tagtical::Tag
-            classes << parent_class
-            parent_class = parent_class.superclass
-          end
-        end
-
-        if options[:only]
-          classes &= find_tag_types(options[:only])
-        elsif options[:except]
-          except = find_tag_types(options[:except])
-          classes.reject! { |t| except.any? { |e| t <= e }}
-        end
-        tag_types_by_classes = taggable_class.tag_types.index_by(&:klass)
-        types.concat(classes.map { |k| tag_types_by_classes[k] }.uniq.compact)
-
-        types # for clarity
-      end
-
-      def find_tag_types(input)
+      def find_tag_classes_for(input)
         Array(input).map { |o| taggable_class.find_tag_type!(o).klass }
       end
 

data/lib/tagtical/taggable/core.rb

@@ -72,7 +72,14 @@ module Tagtical::Taggable
           alias_method_chain :tags, :finder_type_options
         else
           define_method(tag_type.has_many_name) do |*args|
-            tags.scoped.merge(tag_type.scoping(*args))
+            tags.scoped.merge(tag_type.scoping(*args)).tap do |scope|
+              if args.empty? &&
+                (loaded_parent_scope = tag_type.expand_tag_types(:parents).map { |t| send(t.has_many_name) }.detect(&:loaded?))
+
+                scope.instance_variable_set(:@loaded, true)
+                scope.instance_variable_set(:@records, loaded_parent_scope.select { |t| t.class <= tag_type.klass })
+              end
+            end
           end
         end
       end
@@ -321,15 +328,8 @@ module Tagtical::Taggable
         self.class.find_tag_type!(input)
       end
 
-      def finder_type_arguments_for_tag_list(input, *args)
-        find_tag_type!(input).send(:convert_finder_type_arguments, *args)
-      end
-
       def expand_tag_types(input, *args)
-        (@expand_tag_types ||= {})[[input, args]] ||= begin
-          scopes, options = finder_type_arguments_for_tag_list(input, *args)
-          find_tag_type!(input).send(:expand_tag_types, scopes, options)
-        end
+        (@expand_tag_types ||= {})[[input, args]] ||= find_tag_type!(input).expand_tag_types(*args)
       end
 
       # Lets say tag class A inherits from B and B has a tag with value "foo". If we tag A with value "foo",
@@ -341,26 +341,6 @@ module Tagtical::Taggable
         end
       end
 
-      # Extracts the valid tag types for the cascade option.
-      def extract_tag_types_from_cascade(input, base_tag_type)
-        case input
-        when Hash
-          if except = input[:except]
-            except = extract_tag_types_from_cascade(except, base_tag_type)
-            tag_types.reject { |t| except.any? { |e| t.klass <= e.klass }} # remove children as well.
-          elsif only = input[:only]
-            extract_tag_types_from_cascade(only, base_tag_type)
-          else raise("Please provide :except or :only")
-          end
-        when true
-          tag_types
-        else
-          Array(input).map { |c| find_tag_type!(c) }
-        end.select do |tag_type|
-          tag_type.klass <= base_tag_type.klass && tag_type.klass.possible_values
-        end
-      end
-
       # If cascade tag types are specified, it will attempt to look at Tag subclasses with
       # possible_values and try to set those tag_lists with values from the possible_values list.
       def cascade_set_tag_list!(tag_list, context, *args)

data/spec/tagtical/taggable_spec.rb

@@ -53,6 +53,36 @@ describe Tagtical::Taggable do
     @taggable.should have(2).skills
   end
 
+  describe "Tag Type Scopes" do
+    before do
+      @taggable.update_attributes!(:tag_list => "tree, train", :skill_list => "basketball", :craft_list => "pottery")
+      @taggable.reload
+    end
+
+    describe "inherited tags scope optimizations" do
+      before do
+        @taggable.tags.to_a # load the target
+      end
+
+      it "should not access the database when top level tags are already loaded" do
+        ActiveRecord::Base.connection.expects(:execute).never
+        @taggable.skills.to_a
+        @taggable.crafts.to_a
+      end
+
+      it "should select the correct tags" do
+        @taggable.skills.each { |tag| tag.should be_skill }
+        @taggable.crafts.each { |tag| tag.should be_craft }
+      end
+
+      it "should access the database when args are passed in" do
+        ActiveRecord::Base.connection.expects(:execute).once.returns([])
+        @taggable.skills(:conditions => "value='Foo'").to_a
+      end
+
+    end
+  end
+
   when_possible_values_specified(:values => %w{Knitting Ruby Pottery}) do
     
     before do
@@ -67,7 +97,7 @@ describe Tagtical::Taggable do
       @taggable.craft_list.add("ruby", "pottery")
       @taggable.save!
       @taggable.reload
-      should have_only_tag_values %w{Knitting Ruby Pottery}
+      @taggable.should have_only_tag_values %w{Knitting Ruby Pottery}
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagtical
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-07-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2156407420 !ruby/object:Gem::Requirement
+  requirement: &2152023000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <=
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2156407420
+  version_requirements: *2152023000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156406940 !ruby/object:Gem::Requirement
+  requirement: &2152022520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <=
@@ -32,10 +32,10 @@ dependencies:
         version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156406940
+  version_requirements: *2152022520
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &2156406460 !ruby/object:Gem::Requirement
+  requirement: &2152022040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156406460
+  version_requirements: *2152022040
 - !ruby/object:Gem::Dependency
   name: mysql
-  requirement: &2156405980 !ruby/object:Gem::Requirement
+  requirement: &2152021560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156405980
+  version_requirements: *2152021560
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156405500 !ruby/object:Gem::Requirement
+  requirement: &2152021080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156405500
+  version_requirements: *2152021080
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2156405020 !ruby/object:Gem::Requirement
+  requirement: &2152020600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156405020
+  version_requirements: *2152020600
 description: Tagtical allows you do create subclasses for Tag and add additional functionality
   in an STI fashion. For example. You could do Tag::Color.find_by_name('blue').to_rgb.
   It also supports storing weights or relevance on the taggings.