mongoid_taggable_with_context-meta 0.0.3 → 0.0.4

data/README.md

@@ -22,42 +22,35 @@ or in Gemfile:
 gem 'mongoid_taggable_with_context-meta'
 ```
 
-TODO from here
-
 Basic Usage
 -----------
 
-To make a document taggable you need to include Mongoid::TaggableOnContext into your document and call the *taggable* macro with optional arguments:
+To make a document taggable with meta information you need to include Mongoid::TaggableOnContext and Mongoid::TaggableOnContext::Meta into your document and call the *taggable* macro with the argument 'enable_meta' set to true:
 
 ```ruby
 class Post
   include Mongoid::Document
   include Mongoid::TaggableWithContext
-
-  field :title
-  field :content
+  include Mongoid::TaggableWithContext::Meta
 
   # default context is 'tags'.
   # This creates #tags, #tags=, #tags_array, #tags_array= instance methods
-  # separator is " " by default
-  # #tags method returns space separated string
-  # #tags= methods accepts space separated string
-  # #tags_array method returns an array of tags
-  # #tags_array= method accepts an array of tags
-  # #tags and #tags_array are automatically synched.
-  taggable
+  taggable :enable_meta => true
 
   # tagging for 'interests' context.
   # This creates #interests, #interests=, #interests_array, #interests_array= instance methods
-  taggable :interests
+  taggable :interests, :enable_meta => true
 
-  # tagging for 'skills' context.
-  # This creates #skills, #skills=, #skills_array, #skills_array= instance methods
-  # changing tag separator to "," (Default is " ")
-  taggable :skills, :separator => ','
 end
 ```
 
+Please refer to https://github.com/aq1018/mongoid_taggable_with_context for information on how to use Mongoid::TaggableOnContext
+
+TODO: add dynamic setter for use with form fields, rest ...
+-----------------------------------------------------------
+
+-No Support as for now-
+
 Then in your form, for example:
 
 ```rhtml
@@ -88,67 +81,18 @@ Then in your form, for example:
 <% end %>
 ```
 
-Aggregation Strategies
-----------------------
-
-By including an aggregation strategy in your document, tag aggregations will be automatically available to you.
-This lib presents the following aggregation strategies:
-
-* MapReduce
-* RealTime
-
-The following document will automatically aggregate counts on all tag contexts.
-
-```ruby
-class Post
-  include Mongoid::Document
-  include Mongoid::TaggableWithContext
-
-  # automatically adds real time aggregations to all tag contexts
-  include Mongoid::TaggableWithContext::AggregationStrategy::RealTime
-
-  # alternatively for map-reduce
-  # include Mongoid::TaggableWithContext::AggregationStrategy::MapReduce
-
-  field :title
-  field :content
-
-  taggable
-  taggable :interests
-  taggable :skills, :separator => ','
-end
-```
-
-When you include an aggregation strategy, your document also gains a few extra methods to retrieve aggregation data.
-In the case of previous example the following methods are included:
-
-```ruby
-Post.tags
-Post.tags_with_weight
-Post.interests
-Post.interests_with_weight
-Post.skills
-Post.skills_with_weight
-```
-
-Here is how to use these methods in more detail:
+Here is an overview ofthe provided methods:
 
 ```ruby
-Post.create!(:tags => "food,ant,bee")
-Post.create!(:tags => "juice,food,bee,zip")
-Post.create!(:tags => "honey,strip,food")
-
-Post.tags # will retrieve ["ant", "bee", "food", "honey", "juice", "strip", "zip"]
-Post.tags_with_weight # will retrieve:
-# [
-#   ['ant', 1],
-#   ['bee', 2],
-#   ['food', 3],
-#   ['honey', 1],
-#   ['juice', 1],
-#   ['strip', 1],
-#   ['zip', 1]
-# ]
+p = Post.create!(:tags => "food ant bee")
+p.add_tag_with_meta('metatag', {:something => 'Foo', :another => 'Bar'})
+p.add_tag_with_meta('metatag2', {:something => 'Foo2', :another => 'Bar2'})
+
+p.tags                      # => "food ant bee metatag metatag2"
+p.tags_array                # => ["food", "ant", "bee", "metatag", "metatag2"]
+p.tags_having_meta          # => "metatag, metatag2"
+p.tags_having_meta_array    # => ["metatag", "metatag2"]
+p.tags_including_meta       # =>[ ["food", {}], ["ant", {}], ["bee", {}], ["metatag", {:something => 'Foo', :another => 'Bar'}], ["metatag2", {:something => 'Foo2', :another => 'Bar2'}] ]
 ```
 
 Contributing to mongoid_taggable_with_context-meta

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/mongoid_taggable_with_context-meta.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_taggable_with_context-meta"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Maik Vlcek"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_taggable_with_context-meta
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
-  requirement: &6843960 !ruby/object:Gem::Requirement
+  requirement: &9377260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *6843960
+  version_requirements: *9377260
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &6842420 !ruby/object:Gem::Requirement
+  requirement: &9376640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 2.4.4
   type: :development
   prerelease: false
-  version_requirements: *6842420
+  version_requirements: *9376640
 - !ruby/object:Gem::Dependency
   name: mongoid_taggable_with_context
-  requirement: &6839920 !ruby/object:Gem::Requirement
+  requirement: &9376080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6839920
+  version_requirements: *9376080
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &6839000 !ruby/object:Gem::Requirement
+  requirement: &9375480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6839000
+  version_requirements: *9375480
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &6838360 !ruby/object:Gem::Requirement
+  requirement: &9374860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *6838360
+  version_requirements: *9374860
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &6837520 !ruby/object:Gem::Requirement
+  requirement: &9374160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *6837520
+  version_requirements: *9374160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &6768340 !ruby/object:Gem::Requirement
+  requirement: &9373420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6768340
+  version_requirements: *9373420
 - !ruby/object:Gem::Dependency
   name: mongoid-rspec
-  requirement: &6767260 !ruby/object:Gem::Requirement
+  requirement: &9372900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6767260
+  version_requirements: *9372900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &6764940 !ruby/object:Gem::Requirement
+  requirement: &9372280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6764940
+  version_requirements: *9372280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &6764020 !ruby/object:Gem::Requirement
+  requirement: &9371680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *6764020
+  version_requirements: *9371680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &6762660 !ruby/object:Gem::Requirement
+  requirement: &9371020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6762660
+  version_requirements: *9371020
 - !ruby/object:Gem::Dependency
   name: mongoid_taggable_with_context
-  requirement: &6685220 !ruby/object:Gem::Requirement
+  requirement: &9302920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *6685220
+  version_requirements: *9302920
 description: It provides methods to enhance tags with meta data. Extension for gem
   mongoid_taggable_with_context
 email: maik@mediavrog.net