redmine_acts_as_taggable_on 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e7906b676412d6701a0571b01f4d24d11e09a87
+  data.tar.gz: e2dc4f0179c28dad2125a7f7c7b97cc730399517
+SHA512:
+  metadata.gz: 91dc58aa65759906381c28f8460a72aadac61f50eca5244f257d0646096ce19e211af798fffc08df4860fd2a29bc3f46d7258b00fca9ec0d8657a4f7ac767203
+  data.tar.gz: e15b4738667b7f367e024e28fa368e62dcfd2cbb775fd026a49a16935162ba57ca2d102532682caeb9a24446935c991798d5a8a31a3aa582efca72112b7f4277

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redmine_acts_as_taggable_on.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Harry Garrood
+
+MIT License
+
+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/README.md

@@ -0,0 +1,64 @@
+# redmine_acts_as_taggable_on
+
+`redmine_acts_as_taggable_on` is a gem which allows multiple Redmine plugins to
+use the tables provided by `acts_as_taggable_on` without stepping on each
+others' toes.
+
+## How it works
+
+The problem we ran into when we discovered that both `redmine_tags` and
+`redmine_knowledgebase` want to use the `acts_as_taggable_on` gem is that after
+either is installed, the migration for the other fails, since the database
+tables already exist.
+
+Additionally, the plugins must choose between two less than ideal options when
+uninstalling:
+
+* Drop the tables, destroying data which may still be in use by another plugin
+* Leave the tables there, violating the user's expectation that the database
+  should be back to how it was before the plugin was installed
+
+`redmine_acts_as_taggable_on` solves this issue by giving Redmine plugins a
+mechanism to declare that they require these tables, and providing intelligent
+migrations which only drop the tables when no other plugins are using them.
+
+`redmine_acts_as_taggable_on` also provides a limited defence against plugins
+which directly depend on `acts-as-taggable-on` by grepping through their
+Gemfiles for the string `acts-as-taggable-on`, and treating them the same way
+as plugins which use this gem, together with a gentle(-ish) suggestion to
+use this gem instead.
+
+## Status
+
+**Believed to be stable; not extensively tested in the wild.**
+
+## Limitations
+
+This plugin cannot currently protect against situations where a plugin directly
+using `acts-as-taggable-on` has put the generated migration into its
+db/migrate, and the Redmine admin tries to uninstall it.
+
+I'm in two minds about whether to fix this: one the one hand, it would require
+some nasty hackery, and it's no worse than the current situation. On the other, 
+losing one's data is not fun.
+
+## Setup
+
+Add it to your plugin's Gemfile:
+
+    gem 'redmine_acts_as_taggable_on', '~> 0.1'
+
+Add the migration:
+
+    echo 'class AddTagsAndTaggings < RedmineActsAsTaggableOn::Migration; end' \
+        > db/migrate/001_add_tags_and_taggings.rb
+
+Declare that your plugin needs `redmine_acts_as_taggable_on` inside init.rb:
+
+    require 'redmine_acts_as_taggable_on/initialize'
+
+    Redmine::Plugin.register :my_plugin do
+      requires_acts_as_taggable_on
+      ...
+
+That's it. Your plugin should now migrate up and down intelligently.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redmine_acts_as_taggable_on/initialize.rb

@@ -0,0 +1,16 @@
+require 'redmine'
+require 'acts-as-taggable-on'
+require 'redmine_acts_as_taggable_on/migration'
+require 'redmine_acts_as_taggable_on/redmine_plugin_patch'
+
+module RedmineActsAsTaggableOn
+  def self.initialize
+    unless @initialized
+      Redmine::Plugin.send(:include,
+                           RedmineActsAsTaggableOn::RedminePluginPatch)
+    end
+    @initialized = true
+  end
+end
+
+RedmineActsAsTaggableOn.initialize

data/lib/redmine_acts_as_taggable_on/migration.rb

@@ -0,0 +1,63 @@
+require 'generators/acts_as_taggable_on/migration/templates/active_record/migration'
+
+class RedmineActsAsTaggableOn::Migration < ActsAsTaggableOnMigration
+  def up
+    enforce_declarations!
+
+    if performed?
+      say 'Not creating "tags" and "taggings" because they already exist'
+    else
+      super
+    end
+  end
+
+  def down
+    enforce_declarations!
+
+    if ok_to_go_down?
+      super
+    else
+      say 'Not dropping "tags" and "taggings" because they\'re still needed by'
+      say 'the following plugins:'
+      requiring_plugins.each { |p| say p.id, true }
+    end
+  end
+
+  private
+  def performed?
+    ['tags', 'taggings'].any? do |table|
+      ActiveRecord::Base.connection.table_exists? table
+    end
+  end
+
+  # A list of plugins which require redmine_acts_as_taggable_on.
+  #
+  # We reject the current one because we don't want to say
+  #
+  #   refusing to migrate redmine_foo down: tags and taggings tables are still
+  #   required by redmine_foo
+  #
+  # That would be silly.
+  def requiring_plugins
+    Redmine::Plugin.all.
+      select(&:requires_acts_as_taggable_on?).
+      reject {|p| p == Redmine::Plugin::Migrator.current_plugin }
+  end
+
+  def ok_to_go_down?
+    requiring_plugins.empty?
+  end
+
+  def enforce_declarations!
+    unless current_plugin_declaration_made?
+      msg = "You have to declare that you need redmine_acts_as_taggable_on inside\n"
+      msg << "init.rb. See https://github.com/hdgarrood/redmine_acts_as_taggable_on\n"
+      msg << "for more details.\n\n"
+      fail msg
+    end
+  end
+
+  def current_plugin_declaration_made?
+    Redmine::Plugin::Migrator.current_plugin.requires_acts_as_taggable_on?
+  end
+end

data/lib/redmine_acts_as_taggable_on/redmine_plugin_patch.rb

@@ -0,0 +1,36 @@
+module RedmineActsAsTaggableOn::RedminePluginPatch
+  def requires_acts_as_taggable_on
+    @requires_acts_as_taggable_on = true
+  end
+
+  def requires_acts_as_taggable_on?
+    return true if @requires_acts_as_taggable_on
+
+    # Safety net: If the plugin uses the acts-as-taggable-on gem the old way,
+    # assume that it requires the tables.
+    if File.exist?(gemfile_path)
+      if File.read(gemfile_path).include? 'acts-as-taggable-on'
+        warn_about_acts_as_taggable_on
+        return true
+      end
+    end
+
+    false
+  end
+
+  private
+  def gemfile_path
+    File.join(self.directory, 'Gemfile')
+  end
+
+  def warn_about_acts_as_taggable_on
+    unless @already_warned_about_acts_as_taggable_on
+      msg = "\nWARNING: The plugin #{self.id} is using 'acts-as-taggable-on',\n"
+      msg << "which means that it might accidentally delete some of your data\n"
+      msg << "when you uninstall it. You should badger its maintainer to switch\n"
+      msg << "to https://github.com/hdgarrood/redmine_acts_as_taggable_on.\n\n"
+      $stderr.write msg
+    end
+    @already_warned_about_acts_as_taggable_on = true
+  end
+end

data/lib/redmine_acts_as_taggable_on/version.rb

@@ -0,0 +1,3 @@
+module RedmineActsAsTaggableOn
+  VERSION = "0.1.0"
+end

data/lib/redmine_acts_as_taggable_on.rb

@@ -0,0 +1 @@
+require "redmine_acts_as_taggable_on/version"

data/redmine_acts_as_taggable_on.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redmine_acts_as_taggable_on/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine_acts_as_taggable_on"
+  spec.version       = RedmineActsAsTaggableOn::VERSION
+  spec.authors       = ["Harry Garrood"]
+  spec.email         = ["hdgarrood@gmail.com"]
+  spec.description   = %q{Allows multiple Redmine plugins to use tags safely}
+  spec.summary       = %q{Allows multiple Redmine plugins to use the acts_as_taggable_on gem without stepping on each others' toes.}
+  spec.homepage      = "https://github.com/hdgarrood/redmine_acts_as_taggable_on"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "acts-as-taggable-on", "~> 2.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: redmine_acts_as_taggable_on
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry Garrood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: acts-as-taggable-on
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows multiple Redmine plugins to use tags safely
+email:
+- hdgarrood@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redmine_acts_as_taggable_on.rb
+- lib/redmine_acts_as_taggable_on/initialize.rb
+- lib/redmine_acts_as_taggable_on/migration.rb
+- lib/redmine_acts_as_taggable_on/redmine_plugin_patch.rb
+- lib/redmine_acts_as_taggable_on/version.rb
+- redmine_acts_as_taggable_on.gemspec
+homepage: https://github.com/hdgarrood/redmine_acts_as_taggable_on
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Allows multiple Redmine plugins to use the acts_as_taggable_on gem without
+  stepping on each others' toes.
+test_files: []
+has_rdoc: