Extends mongoid_taggable_with_context by supporting to attach meta information to tags
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rvmrc
.travis.yml
Gemfile
Gemfile.lock
LICENSE.txt
README
README.md
Rakefile
VERSION
mongoid_taggable_with_context-meta.gemspec

README.md

mongoid_taggable_with_context-meta

NOTE: this is in IMPLEMENTAION PHASE: Not supposed to work right now

Build Status

Extends mongoid_taggable_with_context with support to attach meta information to tags.

Installation

You can simply install from rubygems:

gem install mongoid_taggable_with_context-meta

or in Gemfile:

gem 'mongoid_taggable_with_context-meta'

Basic Usage

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:

Note: Please refer to https://github.com/aq1018/mongoid_taggable_with_context for information on how to use Mongoid::TaggableOnContext

class Post
  include Mongoid::Document
  include Mongoid::TaggableWithContext
  include Mongoid::TaggableWithContext::Meta

  # default context is 'tags'.
  # enable_meta => true additionally creates #tags_having_meta, #tags_having_meta_array, #tags_including_meta, #add_tag_with_meta(tag, obj) instance methods
  taggable :enable_meta => true

  # tagging for 'interests' context.
  # enable_meta => true additionally creates #interests_having_meta, #interests_having_meta_array, #interests_including_meta, #add_interest_with_meta(tag, obj) instance methods
  taggable :interests, :enable_meta => true

end

Here is an overview ofthe provided methods:

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'}] ]

TODO: add dynamic setter for use with form fields, rest ...

-No Support as for now-

Then in your form, for example:

<% form_for @post do |f| %>
  <p>
    <%= f.label :title %><br />
    <%= f.text_field :title %>
  </p>
  <p>
    <%= f.label :content %><br />
    <%= f.text_area :content %>
  </p>
  <p>
    <%= f.label :tags %><br />
    <%= text_field_tag 'post[tags]' %>
  </p>
  <p>
    <%= f.label :interests %><br />
    <%= text_field_tag 'post[interests]' %>
  </p>
  <p>
    <%= f.label :skills %><br />
    <%= text_field_tag 'post[skills]' %>
  </p>
  <p>
    <button type="submit">Send</button>
  </p>
<% end %>

Contributing to mongoid_taggable_with_context-meta

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Maik Vlcek. See LICENSE.txt for further details.