dm-taggings 0.11.0

data/.gitignore

@@ -0,0 +1,9 @@
+doc
+.yardoc
+pkg/*
+coverage
+.bundle
+Gemfile.lock
+Gemfile.local
+Gemfile.local.lock
+

data/Gemfile

@@ -0,0 +1,142 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can use
+# the same environment variables, like ADAPTER(S) or PLUGIN(S) when running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need to
+# worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones of
+# the various datamapper gems. It's assumed that all datamapper repo clones
+# reside in the same directory. You can use the Gemfile.local like so for
+# running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by setting
+# an environment variable. This of course also works when using the Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter and dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the Gemfile.local
+# and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's recommended
+# that you first install all adapters that you are planning to use or work on
+# by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to bundler.
+# Once you have them installed you can easily switch between adapters for the
+# various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will be used
+# when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by setting
+# an environment variable. This also works when using the Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#   PLUGINS=dm-validations bundle foo          # dm-migrations and dm-validations
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations, dm-validations and dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run specs
+# for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make 'bundle exec' run
+# a lot faster compared to the unlocked version. With an unlocked bundle you would
+# typically just run 'bundle install' from time to time to fetch the latest sources from
+# upstream. When you locked your bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again. Gemfile.lock
+# is added to the .gitignore file, so you don't need to worry about accidentally checking
+# it into version control.
+
+source 'http://rubygems.org'
+
+DATAMAPPER = 'git://github.com/datamapper'
+DM_VERSION = '~> 1.0.2'
+
+group :runtime do # Runtime dependencies (as in the gemspec)
+
+  if ENV['EXTLIB']
+    gem 'extlib',        '~> 0.9.15', :git => "#{DATAMAPPER}/extlib.git"
+  else
+    gem 'activesupport', '~> 3.0.0',  :git => 'git://github.com/rails/rails.git', :branch => '3-0-stable', :require => nil
+  end
+
+  gem 'dm-core',         DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+  gem 'dm-constraints',  DM_VERSION, :git => "#{DATAMAPPER}/dm-constraints.git"
+  gem 'dm-is-remixable', DM_VERSION, :git => "#{DATAMAPPER}/dm-is-remixable.git"
+
+end
+
+group(:development) do # Development dependencies (as in the gemspec)
+
+  gem 'rake',           '~> 0.8.7'
+  gem 'rspec',          '~> 1.3', :git => 'git://github.com/snusnu/rspec', :branch => 'heckle_fix_plus_gemfile'
+  gem 'jeweler',        '~> 1.4'
+
+end
+
+group :quality do # These gems contain rake tasks that check the quality of the source code
+
+  gem 'metric_fu',      '~> 1.3'
+  gem 'rcov',           '~> 0.9.8'
+  gem 'reek',           '~> 1.2.8'
+  gem 'roodi',          '~> 2.1'
+  gem 'yard',           '~> 0.5'
+  gem 'yardstick',      '~> 0.1'
+
+end
+
+group :datamapper do # We need this because we want to pin these dependencies to their git master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  DO_VERSION     = '~> 0.10.2'
+  DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    options = {}
+    options[:git] = "#{DATAMAPPER}/do.git" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects',  DO_VERSION, options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+  end
+
+  adapters.each do |adapter|
+    gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+
+end

data/History.txt

@@ -0,0 +1 @@
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Piotr Solnica
+
+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/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-taggings.rb
+lib/dm-taggings/is/tag.rb
+lib/dm-taggings/is/taggable.rb
+lib/dm-taggings/is/tagger.rb
+lib/dm-taggings/is/tagging.rb
+lib/dm-taggings/is/version.rb
+spec/classes.rb
+spec/integration/tag_spec.rb
+spec/integration/taggable_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/hoe.rb

data/README.rdoc

@@ -0,0 +1,155 @@
+= dm-taggings
+
+Tagging support for DataMapper
+
+== Where to find help
+
+* http://groups.google.com/group/datamapper
+* #datamapper channel on IRC
+
+== Dependencies
+
+* dm-core
+* dm-is-remixable
+* dm-constraints
+
+== Installation
+
+System-wide:
+
+  gem install dm-taggings
+
+Bundler:
+
+  gem "dm-taggings", "~> 0.11"
+
+== Schema
+
+The plugin differs from other typical implementations as it doesn't use 
+polymorphic associations, instead it creates explicit join models on-the-fly 
+via dm-is-remixable. For instance a <tt>Post</tt> model will have a 
+corresponding tagging model called <tt>PostTag</tt>, <tt>Book</tt> will have 
+<tt>BookTag</tt> etc. 
+
+<b>Important</b>: constraints are set to delete taggings of a corresponding 
+taggable resource when it gets deleted.
+
+== Adapters support
+
+Because of the usage of dm-constraints the pluging supports only the following 
+DataObject adapters:
+
+* mysql
+* oracle
+* postgres
+* sqlite
+* sqlserver
+
+== Basic usage
+
+  #############################################################################
+  # Taggings
+  #
+
+  class Post
+    include DataMapper::Resource
+
+    property :id,      Serial
+    property :title,   String
+    property :content, Text
+
+    is :taggable
+  end
+
+  # Create a post with tags
+  post = Post.create(
+    :title    => "Hello World", 
+    :content  => "Lorem ipsum ...", 
+    :tag_list => "foo, bar")
+
+  p post.tags
+  # => [#<Tag @id=1 @name="foo">, #<Tag @id=2 @name="bar">]
+
+  # Untag a post
+  post.untag!
+
+  p post.tags
+  # => []
+
+  # Tag a post again
+  post.tag! ["red", "green"]
+
+  p post.tags
+  # => [#<Tag @id=3 @name="red">, #<Tag @id=4 @name="green">]
+
+  # Find posts tagged with "green"
+  green_posts = Post.tagged_with("green")
+
+  p green_posts
+  # => [#<Post @id=1 @title="Hello World", @content => "Lorem ipsum ..."]
+
+  # tagged_with is chainable so you can combine it with other conditions
+  Post.tagged_with("green").all(:content => "foo")
+
+  #############################################################################
+  # Taggers
+  #
+
+  class User
+    include DataMapper::Resource
+
+    property :id,   Serial
+    property :name, String
+  end
+
+  class Song
+    include DataMapper::Resource
+
+    property :id,    Serial
+    property :title, String
+
+    is :taggable, :by => [ User ]
+  end
+
+  song = Song.create(:title => "Show must go on")
+  user = User.create(:name => "John")
+
+  # tagging via user
+  user.tag!(song, :with => "awesome, favourite")
+
+  p song.tags
+  # => [#<Tag @id=1 @name="awesome">, #<Tag @id=2 @name="favourite">]
+
+  p user.songs
+  # => [#<Song @id=1 @title="Show must go on">]
+
+For detailed docs see project's RDoc[http://rdoc.info/github/solnic/dm-taggings/master/frames]
+
+== Authors and contributors
+
+* Martin Gamsjaeger (snusnu[http://github.com/snusnu])
+* Maxime Guilbot (maxime[http://github.com/maxime]) (original author of dm-is-taggable)
+* Piotr Solnica (solnic[http://github.com/solnic])
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a 
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== TODO
+
+* Support for custom tag_list separators and grouping, ie tag_list = '"a tag with spaces"; "another one"'
+* Support for custom validation of Tag model
+* Caching tag_list (custom TagList < String property would be nice probably)
+* Support for more adapters!
+
+== Copyright
+
+Copyright (c) 2010 Piotr Solnica. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+begin
+  # Just in case the bundle was locked
+  # This shouldn't happen in a dev environment but lets be safe
+  require File.expand_path('../../.bundle/environment', __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+
+Bundler.require(:default, :development)
+
+
+begin
+
+  require 'rake'
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+
+    gem.name        = 'dm-taggings'
+    gem.summary     = 'Tagging plugin for DataMapper'
+    gem.description = 'DataMapper plugin that adds the possibility to tag models'
+    gem.email       = 'piotr.solnica@gmail.com'
+    gem.homepage    = 'http://github.com/solnic/dm-taggings'
+    gem.authors     = [ 'Piotr Solnica' ]
+
+    gem.add_dependency 'dm-core',           '~> 1.0.2'
+    gem.add_dependency 'dm-constraints',    '~> 1.0.2'
+    gem.add_dependency 'dm-is-remixable',   '~> 1.0.2'
+
+    gem.add_development_dependency 'rspec', '~> 1.3'
+    gem.add_development_dependency 'yard',  '~> 0.5'
+
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  FileList['tasks/**/*.rake'].each { |task| import task }
+
+rescue LoadError => e
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+  puts e.message
+  puts e.backtrace
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO
+====
+
+- specs to be finished
+- tagger support

data/VERSION

@@ -0,0 +1 @@
+0.11.0

data/dm-taggings.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-taggings}
+  s.version = "0.11.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Piotr Solnica"]
+  s.date = %q{2010-10-14}
+  s.description = %q{DataMapper plugin that adds the possibility to tag models}
+  s.email = %q{piotr.solnica@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "History.txt",
+     "LICENSE",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "dm-taggings.gemspec",
+     "lib/dm-taggings.rb",
+     "lib/dm-taggings/is/tag.rb",
+     "lib/dm-taggings/is/taggable.rb",
+     "lib/dm-taggings/is/tagger.rb",
+     "lib/dm-taggings/is/tagging.rb",
+     "lib/dm-taggings/is/version.rb",
+     "lib/dm-taggings/spec/taggable_shared_spec.rb",
+     "lib/dm-taggings/spec/tagger_shared_spec.rb",
+     "spec/fixtures/models.rb",
+     "spec/integration/post_spec.rb",
+     "spec/integration/tag_spec.rb",
+     "spec/integration/taggable_spec.rb",
+     "spec/integration/user_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/hoe.rb",
+     "tasks/yard.rake",
+     "tasks/yardstick.rake"
+  ]
+  s.homepage = %q{http://github.com/solnic/dm-taggings}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Tagging plugin for DataMapper}
+  s.test_files = [
+    "spec/integration/taggable_spec.rb",
+     "spec/integration/post_spec.rb",
+     "spec/integration/tag_spec.rb",
+     "spec/integration/user_spec.rb",
+     "spec/fixtures/models.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.0.2"])
+      s.add_runtime_dependency(%q<dm-constraints>, ["~> 1.0.2"])
+      s.add_runtime_dependency(%q<dm-is-remixable>, ["~> 1.0.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_development_dependency(%q<yard>, ["~> 0.5"])
+    else
+      s.add_dependency(%q<dm-core>, ["~> 1.0.2"])
+      s.add_dependency(%q<dm-constraints>, ["~> 1.0.2"])
+      s.add_dependency(%q<dm-is-remixable>, ["~> 1.0.2"])
+      s.add_dependency(%q<rspec>, ["~> 1.3"])
+      s.add_dependency(%q<yard>, ["~> 0.5"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, ["~> 1.0.2"])
+    s.add_dependency(%q<dm-constraints>, ["~> 1.0.2"])
+    s.add_dependency(%q<dm-is-remixable>, ["~> 1.0.2"])
+    s.add_dependency(%q<rspec>, ["~> 1.3"])
+    s.add_dependency(%q<yard>, ["~> 0.5"])
+  end
+end
+