labelized 0.7.0 → 0.7.1

data/README.rdoc

@@ -1,24 +1,30 @@
 = labelized
-A simple Ruby library for labeling things. Similar to and inspired by acts_as_taggable_on.
+A simple Ruby library for labeling things. Similar to and inspired by acts_as_taggable_on but more flexible. Labelized allows you to control every aspect of label items, including the label to labeled relation. Labels can be organized into label sets. Labelized takes the approach of mixing in functionality with configuration, so you include just what you need. While labelized depends on ActiveRecord, it doesn't provide you with any models. You mixin labeleized concerns to your own models and have complete control over everything including the labels and how they get linked to your models. 
 
 == Usage
-Passing a term in the singular allows only a single label. Plural terms allow multiple labels.
-The optional scope allows for multiple instances of the same tag, isolated by the scope; i.e. different capitalizations
+Passing a term in the singular allows only a single label. Plural terms allow multiple labels. The optional scope allows for multiple instances of the same tag, isolated by the scope; i.e. different capitalizations. Labelized doesn't assume much about your model space. You mix in the appropriate labelized module and configure a few options. 
 
-  class Label
-    labelized :scope => :community_id
+== A Simple Example
+  
+  # Call labelized on a class you want to act as the label
+  class Label < ActiveRecord::Base
+    include Labelized::LabelConcern
+    
+    labelized
   end
-
-  class Thing
-    labelized [:kind, :keywords, :tracks]
+  
+  # Include the LabelizedConcern and call labelized on a class you want to  label
+  class Thing < ActiveRecord::Base
+    include Labelized::LabelizedConcern
+    
+    labelized :labels
   end
   
   thing = Thing.new
-  
-  thing.kind
-  thing.kind = ['this', 'that'] # throws Exeption
-  thing.kind = 'this' # OK!
-  
+  thing.labels # [] 
+  thing.label 'label one'
+  thing.labels_for 'round', :shape # 
+
   thing.kind # 'this'
   thing.kind_list # 'this'  
   

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/labelized.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{labelized}
-  s.version = "0.7.0"
+  s.name = "labelized"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter T. Brown"]
-  s.date = %q{2011-11-15}
-  s.description = %q{A better tag library}
-  s.email = %q{peter@pathable.com}
+  s.date = "2012-07-27"
+  s.description = "A better tag library"
+  s.email = "peter@pathable.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -41,11 +41,11 @@ Gem::Specification.new do |s|
     "spec/labelized/labelized_concern_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/flippyhead/labelized}
+  s.homepage = "http://github.com/flippyhead/labelized"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{A better tag library}
+  s.rubygems_version = "1.8.11"
+  s.summary = "A better tag library"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/labelized/label_concern.rb

@@ -15,7 +15,7 @@ module Labelized
       def labelized(params = {})
         setup_labelized params
         
-	def find_or_build_by_list(labels, labeled, label_set_name = nil)
+	      def find_or_build_by_list(labels, labeled, label_set_name = nil)
           label_set_class = (labelized_options[:label_set_class_name] || 'LabelSet').constantize
 
           unless label_set_name.blank?
@@ -24,10 +24,13 @@ module Labelized
           end
 
           LabelList.from(labels).map do |label|
-            self.label_scope(labeled).find_or_initialize_by_name(label.strip, :label_set => label_set)
+            self.label_scope(labeled).find_or_initialize_by_name_and_label_set_id(label.strip, label_set.id)
           end
-        end          
+        end
         
+        def to_s
+          name
+        end
       end
     end    
   end

data/lib/labelized/label_list.rb

@@ -12,11 +12,12 @@ module Labelized
     end
   
     ##
-    # Returns a new TagList using the given tag string.
+    # Returns a new LabelList using the given string.
+    #
+    # LabelList.delimiter can be used to customize how labels in the string are delimited
     #
     # Example:
-    #   tag_list = TagList.from("One , Two,  Three")
-    #   tag_list # ["One", "Two", "Three"]
+    #   LabelList.from("One , Two,  Three") # ["One", "Two", "Three"]
     def self.from(string)
       glue   = delimiter.ends_with?(" ") ? delimiter : "#{delimiter} "
       string = string.join(glue) if string.respond_to?(:join)
@@ -24,7 +25,7 @@ module Labelized
       new.tap do |tag_list|
         string = string.to_s.dup
 
-        # Parse the quoted tags
+        # Parse the quoted labels
         string.gsub!(/(\A|#{delimiter})\s*"(.*?)"\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
         string.gsub!(/(\A|#{delimiter})\s*'(.*?)'\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
 
@@ -33,12 +34,12 @@ module Labelized
     end
 
     ##
-    # Add tags to the tag_list. Duplicate or blank tags will be ignored.
-    # Use the <tt>:parse</tt> option to add an unparsed tag string.
+    # Add labels to the list. Duplicate or blank labels will be ignored.
+    # Use the <tt>:parse</tt> option to add an unparsed label string.
     #
     # Example:
-    #   tag_list.add("Fun", "Happy")
-    #   tag_list.add("Fun, Happy", :parse => true)
+    #   list.add("Fun", "Happy")
+    #   list.add("Fun, Happy", :parse => true)
     def add(*names)
       extract_and_apply_options!(names)
       concat(names)
@@ -47,12 +48,12 @@ module Labelized
     end
 
     ##
-    # Remove specific tags from the tag_list.
-    # Use the <tt>:parse</tt> option to add an unparsed tag string.
+    # Remove specific labels from the list.
+    # Use the <tt>:parse</tt> option to add an unparsed label string.
     #
     # Example:
-    #   tag_list.remove("Sad", "Lonely")
-    #   tag_list.remove("Sad, Lonely", :parse => true)
+    #   list.remove("Sad", "Lonely")
+    #   list.remove("Sad, Lonely", :parse => true)
     def remove(*names)
       extract_and_apply_options!(names)
       delete_if { |name| names.include?(name) }
@@ -60,12 +61,12 @@ module Labelized
     end
 
     ##
-    # Transform the tag_list into a tag string suitable for edting in a form.
-    # The tags are joined with <tt>TagList.delimiter</tt> and quoted if necessary.
+    # Transform the list into a label string suitable for edting in a form.
+    # The labels are joined with <tt>LabelList.delimiter</tt> and quoted if necessary.
     #
     # Example:
-    #   tag_list = TagList.new("Round", "Square,Cube")
-    #   tag_list.to_s # 'Round, "Square,Cube"'
+    #   list = LabelList.new("Round", "Square,Cube")
+    #   list.to_s # 'Round, "Square,Cube"'
     def to_s
       tags = frozen? ? self.dup : self
       tags.send(:clean!)

data/lib/labelized/labelized_concern.rb

@@ -54,6 +54,7 @@ module Labelized
             label_set = label_set_class.label_scope(self).find_or_initialize_by_name(label_set_name)
             cache_label_get(label_set_name) || self.labels.where(:label_set_id => label_set.id)
           end
+          alias_method :labels_for, :label_for
           
           # Convenience setter to the label_set name. Accepts a single item or an array.
           labelized_label_set_names.map(&:to_s).each do |label_set_name|
@@ -67,6 +68,10 @@ module Labelized
               labels = label_for label_set_name
               Labelized::Support.singular?(label_set_name) ? labels[0] : labels
             end
+
+            define_method "#{label_set_name.to_s.singularize}_list" do
+              label_for(label_set_name).map(&:to_s)
+            end
           end
         end
       end

data/lib/labelized/support.rb

@@ -22,6 +22,10 @@ module Labelized
       self.setup_label_scope(scopes)
     end
     
+    # Sets up scoping for labels and label sets
+    # Typically the labeled item is passed to the scope
+    # So label_set with a :community_id scope, will look for labels with a community_id
+    # that have the same value as the community_id on the thing being labled
     def setup_label_scope(scopes)
       return if scopes.blank?
       self.class_eval do

data/spec/labelized/labelized_concern_spec.rb

@@ -50,13 +50,16 @@ describe Labelized::LabelizedConcern do
   it{should_not be_nil}
   it{should respond_to(:tags)}
   it{should respond_to(:tags=)}
-  it{should have(1).tag}
-  
+  it{should respond_to(:tag_list)}
   it{should respond_to(:labels)}
   it{should respond_to(:labelings)}
   
-  its(:tags){should be_present}
-  
+  context 'with labels set' do
+    it{should have(1).tag}
+    its(:tags){should be_present}
+    its(:tag_list){should == ['tag one']}
+  end
+
   context 'the cached tags' do
     subject{thing.tags.first}
     
@@ -71,6 +74,7 @@ describe Labelized::LabelizedConcern do
     
     its(:tags){should be_present}
     specify{subject.label_for(:tags).should be_present}
+    specify{subject.labels_for(:tags).should be_present}    
   end
     
   context 'the result of setting one label' do
@@ -110,7 +114,6 @@ describe Labelized::LabelizedConcern do
 
   context 'when invalid' do
     let(:invalid_thing){InvalidThing.new()}
-    
-    specify{expect{invalid_thing.label'tag', :tags}.to raise_exception}
+    specify{expect{invalid_thing.label'tag', :tags}.to raise_exception(/must be labelized/)}
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: labelized
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-15 00:00:00.000000000 -08:00
-default_executable: 
+date: 2012-07-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2167182500 !ruby/object:Gem::Requirement
+  requirement: &2153532400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2167182500
+  version_requirements: *2153532400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2167181900 !ruby/object:Gem::Requirement
+  requirement: &2153531820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167181900
+  version_requirements: *2153531820
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2167181300 !ruby/object:Gem::Requirement
+  requirement: &2153531220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167181300
+  version_requirements: *2153531220
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2167180700 !ruby/object:Gem::Requirement
+  requirement: &2153527040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167180700
+  version_requirements: *2153527040
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &2167180100 !ruby/object:Gem::Requirement
+  requirement: &2153526540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167180100
+  version_requirements: *2153526540
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2167179500 !ruby/object:Gem::Requirement
+  requirement: &2153526040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167179500
+  version_requirements: *2153526040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2167174100 !ruby/object:Gem::Requirement
+  requirement: &2153525540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167174100
+  version_requirements: *2153525540
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2167173620 !ruby/object:Gem::Requirement
+  requirement: &2153525020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167173620
+  version_requirements: *2153525020
 description: A better tag library
 email: peter@pathable.com
 executables: []
@@ -131,7 +130,6 @@ files:
 - spec/labelized/label_concern_spec.rb
 - spec/labelized/labelized_concern_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/flippyhead/labelized
 licenses:
 - MIT
@@ -147,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2535347908215351964
+      hash: -4492055040287312457
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A better tag library