annotated_models 3.0.0

data/lib/annotated_models.rb

@@ -0,0 +1,357 @@
+module AnnotatedModels
+  # Annotate Models plugin use this header
+  COMPAT_PREFIX = "== Schema Info"
+  PREFIX        = "== Schema Information"
+  END_MARK      = "== Schema Information End"
+  PATTERN       = /^\n?# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/
+
+  # File.join for windows reverse bar compat?
+  # I dont use windows, can`t test
+  UNIT_TEST_DIR         = File.join("test", "unit"  )
+  SPEC_MODEL_DIR        = File.join("spec", "models")
+  FIXTURE_TEST_DIR      = File.join("test", "fixtures")
+  FIXTURE_SPEC_DIR      = File.join("spec", "fixtures")
+  # Object Daddy http://github.com/flogic/object_daddy/tree/master
+  EXEMPLARS_TEST_DIR    = File.join("test", "exemplars")
+  EXEMPLARS_SPEC_DIR    = File.join("spec", "exemplars")
+  # Machinist http://github.com/notahat/machinist
+  BLUEPRINTS_TEST_DIR   = File.join("test", "blueprints")
+  BLUEPRINTS_SPEC_DIR   = File.join("spec", "blueprints")
+  # Factory Girl http://github.com/thoughtbot/factory_girl
+  FACTORY_GIRL_TEST_DIR = File.join("test", "factories")
+  FACTORY_GIRL_SPEC_DIR = File.join("spec", "factories")
+
+  # Don't show limit (#) on these column types
+  # Example: show "integer" instead of "integer(4)"
+  NO_LIMIT_COL_TYPES = ["integer", "boolean"]
+
+  class << self
+    def model_dir
+      @model_dir || "app/models"
+    end
+
+    def model_dir=(dir)
+      @model_dir = dir
+    end
+
+    # Simple quoting for the default column value
+    def quote(value)
+      case value
+      when NilClass                 then "NULL"
+      when TrueClass                then "TRUE"
+      when FalseClass               then "FALSE"
+      when Float, Fixnum, Bignum    then value.to_s
+        # BigDecimals need to be output in a non-normalized form and quoted.
+      when BigDecimal               then value.to_s('F')
+      else
+        value.inspect
+      end
+    end
+
+    # Use the column information in an ActiveRecord class
+    # to create a comment block containing a line for
+    # each column. The line contains the column name,
+    # the type (and length), and any optional attributes
+    def get_schema_info(klass, header, options = {})
+      info = "# #{header}\n#\n"
+      info << "# Table name: #{klass.table_name}\n"
+      info << "# Human name: #{klass.model_name.human}\n" unless klass.model_name.human(:default => "").blank?
+      info << "#\n"
+
+      max_size = klass.column_names.map{|name| name.size}.max + (ENV['format_rdoc'] ? 5 : 1)
+      klass.columns.each do |col|
+        attrs = []
+        attrs << "'#{klass.human_attribute_name(col.name)}'" unless klass.human_attribute_name(col.name, :default => "").blank?
+        attrs << "default(#{quote(col.default)})" unless col.default.nil?
+        attrs << "not null" unless col.null
+        attrs << "primary key" if col.name.to_sym == klass.primary_key.to_sym
+
+        col_type = col.type.to_s
+        if col_type == "decimal"
+          col_type << "(#{col.precision}, #{col.scale})"
+        else
+          if (col.limit)
+            col_type << "(#{col.limit})" unless NO_LIMIT_COL_TYPES.include?(col_type)
+          end
+        end
+
+        # Check out if we got a geometric column
+        # and print the type and SRID
+        if col.respond_to?(:geometry_type)
+          attrs << "#{col.geometry_type}, #{col.srid}"
+        end
+
+        # Check if the column has indices and print "indexed" if true
+        # If the indice include another colum, print it too.
+        if options[:simple_indexes] # Check out if this column is indexed
+          indices = klass.connection.indexes(klass.table_name)
+          if indices = indices.select { |ind| ind.columns.include? col.name }
+            indices.each do |ind|
+              ind = ind.columns.reject! { |i| i == col.name }
+              attrs << (ind.length == 0 ? "indexed" : "indexed => [#{ind.join(", ")}]")
+            end
+          end
+        end
+
+        if ENV['format_rdoc']
+          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col.name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
+        else
+          info << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
+        end
+      end
+
+      if options[:show_indexes]
+        info << get_index_info(klass)
+      end
+
+      if ENV['format_rdoc']
+        info << "#--\n"
+        info << "# #{END_MARK}\n"
+        info << "#++\n\n"
+      else
+        info << "#\n\n"
+      end
+    end
+
+    def get_index_info(klass)
+      index_info = "#\n# Indexes\n#\n"
+
+      indexes = klass.connection.indexes(klass.table_name)
+      return "" if indexes.empty?
+
+      max_size = indexes.collect{|index| index.name.size}.max + 1
+      indexes.each do |index|
+        index_info << sprintf("#  %-#{max_size}.#{max_size}s %s %s", index.name, "(#{index.columns.join(",")})", index.unique ? "UNIQUE" : "").rstrip + "\n"
+      end
+      return index_info
+    end
+
+    # Add a schema block to a file. If the file already contains
+    # a schema info block (a comment starting with "== Schema Information"), check if it
+    # matches the block that is already there. If so, leave it be. If not, remove the old
+    # info block and write a new one.
+    # Returns true or false depending on whether the file was modified.
+    #
+    # === Options (opts)
+    #  :position<Symbol>:: where to place the annotated section in fixture or model file,
+    #                      "before" or "after". Default is "before".
+    #  :position_in_class<Symbol>:: where to place the annotated section in model file
+    #  :position_in_fixture<Symbol>:: where to place the annotated section in fixture file
+    #  :position_in_others<Symbol>:: where to place the annotated section in the rest of
+    #                      supported files
+    #
+    def annotate_one_file(file_name, info_block, options={})
+      if File.exist?(file_name)
+        old_content = File.read(file_name)
+
+        # Ignore the Schema version line because it changes with each migration
+        header = Regexp.new(/(^# Table name:.*?\n(#.*\n)*\n)/)
+        old_header = old_content.match(header).to_s
+        new_header = info_block.match(header).to_s
+
+        if old_header == new_header
+          false
+        else
+          # Remove old schema info
+          old_content.sub!(PATTERN, '')
+
+          # Write it back
+          new_content = options[:position].to_s == 'after' ? (old_content + "\n" + info_block) : (info_block + old_content)
+
+          File.open(file_name, "wb") { |f| f.puts new_content }
+          true
+        end
+      end
+    end
+
+    def remove_annotation_of_file(file_name)
+      if File.exist?(file_name)
+        content = File.read(file_name)
+
+        content.sub!(PATTERN, '')
+
+        File.open(file_name, "wb") { |f| f.puts content }
+      end
+    end
+
+    # Given the name of an ActiveRecord class, create a schema
+    # info block (basically a comment containing information
+    # on the columns and their types) and put it at the front
+    # of the model and fixture source files.
+    # Returns true or false depending on whether the source
+    # files were modified.
+    def annotate(klass, file, header,options={})
+      info = get_schema_info(klass, header, options)
+      annotated = false
+      model_name = klass.name.underscore
+      model_file_name = File.join(model_dir, file)
+
+      if annotate_one_file(model_file_name, info, options_with_position(options, :position_in_class))
+        annotated = true
+      end
+
+      unless options[:exclude_tests]
+        [
+         File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"), # test
+         File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"), # spec
+        ].each do |file|
+          # todo: add an option "position_in_test" -- or maybe just ask if anyone ever wants different positions for model vs. test vs. fixture
+          annotate_one_file(file, info, options_with_position(options, :position_in_fixture)) if File.exist?(file)
+        end
+      end
+
+      unless options[:exclude_fixtures]
+        [
+         File.join(FIXTURE_TEST_DIR,       "#{klass.table_name}.yml"),    # fixture
+         File.join(FIXTURE_SPEC_DIR,       "#{klass.table_name}.yml"),    # fixture
+         File.join(EXEMPLARS_TEST_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+         File.join(EXEMPLARS_SPEC_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+         File.join(BLUEPRINTS_TEST_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+         File.join(BLUEPRINTS_SPEC_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+         File.join(FACTORY_GIRL_TEST_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+         File.join(FACTORY_GIRL_SPEC_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+        ].each do |file|
+          annotate_one_file(file, info, options_with_position(options, :position_in_fixture)) if File.exist?(file)
+        end
+      end
+
+      annotated
+    end
+
+    # position = :position_in_fixture or :position_in_class
+    def options_with_position(options, position_in)
+      options.merge(:position=>(options[position_in] || options[:position]))
+    end
+
+    # Return a list of the model files to annotate. If we have
+    # command line arguments, they're assumed to be either
+    # the underscore or CamelCase versions of model names.
+    # Otherwise we take all the model files in the
+    # model_dir directory.
+    def get_model_files
+      models = ARGV.dup
+      models.shift
+      models.reject!{|m| m.match(/^(.*)=/)}
+      if models.empty?
+        begin
+          Dir.chdir(model_dir) do
+            models = Dir["**/*.rb"]
+          end
+        rescue SystemCallError
+          puts "No models found in directory '#{model_dir}'."
+          puts "Either specify models on the command line, or use the --model-dir option."
+          puts "Call 'annotate --help' for more info."
+          exit 1;
+        end
+      end
+      models
+    end
+
+    # Retrieve the classes belonging to the model names we're asked to process
+    # Check for namespaced models in subdirectories as well as models
+    # in subdirectories without namespacing.
+    def get_model_class(file)
+      require File.expand_path("#{model_dir}/#{file}") # this is for non-rails projects, which don't get Rails auto-require magic
+      model = file.gsub(/\.rb$/, '').camelize
+      parts = model.split('::')
+      begin
+        parts.inject(Object) {|klass, part| klass.const_get(part) }
+      rescue LoadError, NameError
+        Object.const_get(parts.last)
+      end
+    end
+
+    # We're passed a name of things that might be
+    # ActiveRecord models. If we can find the class, and
+    # if its a subclass of ActiveRecord::Base,
+    # then pass it to the associated block
+    def do_annotations(options={})
+      if options[:require]
+        options[:require].each do |path|
+          require path
+        end
+      end
+
+      header = PREFIX.dup
+
+      if options[:include_version]
+        version = ActiveRecord::Migrator.current_version rescue 0
+        if version > 0
+          header << "\n# Schema version: #{version}"
+        end
+      end
+
+      if options[:model_dir]
+        self.model_dir = options[:model_dir]
+      end
+
+      annotated = []
+      get_model_files.each do |file|
+        begin
+          klass = get_model_class(file)
+          if klass < ActiveRecord::Base && !klass.abstract_class?
+            if annotate(klass, file, header, options)
+              annotated << klass
+            end
+          end
+        rescue Exception => e
+          puts "Unable to annotate #{file}: #{e.message} (#{e.backtrace.first})"
+        end
+      end
+      if annotated.empty?
+        puts "Nothing annotated."
+      else
+        puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
+      end
+    end
+
+    def remove_annotations(options={})
+      if options[:model_dir]
+        puts "removing"
+        self.model_dir = options[:model_dir]
+      end
+      deannotated = []
+      get_model_files.each do |file|
+        begin
+          klass = get_model_class(file)
+          if klass < ActiveRecord::Base && !klass.abstract_class?
+            deannotated << klass
+
+            model_name = klass.name.underscore
+            model_file_name = File.join(model_dir, file)
+            remove_annotation_of_file(model_file_name)
+
+            [
+             File.join(UNIT_TEST_DIR,          "#{model_name}_test.rb"),
+             File.join(SPEC_MODEL_DIR,         "#{model_name}_spec.rb"),
+             File.join(FIXTURE_TEST_DIR,       "#{klass.table_name}.yml"),    # fixture
+             File.join(FIXTURE_SPEC_DIR,       "#{klass.table_name}.yml"),    # fixture
+             File.join(EXEMPLARS_TEST_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+             File.join(EXEMPLARS_SPEC_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+             File.join(BLUEPRINTS_TEST_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+             File.join(BLUEPRINTS_SPEC_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+             File.join(FACTORY_GIRL_TEST_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+             File.join(FACTORY_GIRL_SPEC_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+            ].each do |file|
+              remove_annotation_of_file(file) if File.exist?(file)
+            end
+
+          end
+        rescue Exception => e
+          puts "Unable to annotate #{file}: #{e.message}"
+        end
+      end
+      puts "Removed annotation from: #{deannotated.join(', ')}"
+    end
+  end
+end
+
+# monkey patches
+
+module ::ActiveRecord
+  class Base
+    def self.method_missing(name, *args)
+      # ignore this, so unknown/unloaded macros won't cause parsing to fail
+    end
+  end
+end

data/lib/tasks/annotate_models.rake

@@ -0,0 +1,24 @@
+desc "Add schema information (as comments) to model and fixture files"
+task :annotate_models => :environment do
+  require File.join(File.dirname(__FILE__), '..', 'annotate/annotate_models')
+  options={}
+  options[:position_in_class]   = ENV['position_in_class']   || ENV['position'] || :before
+  options[:position_in_factory] = ENV['position_in_factory'] || ENV['position'] || :before
+  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position'] || :before
+  options[:show_indexes]        = ENV['show_indexes']
+  options[:simple_indexes]      = ENV['simple_indexes']
+  options[:model_dir]           = ENV['model_dir']
+  options[:include_version]     = ENV['include_version']
+  options[:require]             = ENV['require'] ? ENV['require'].split(', ') : []
+  options[:exclude_tests]       = ENV['exclude_tests']
+  options[:exclude_fixtures]    = ENV['exclude_fixtures']
+  AnnotateModels.do_annotations(options)
+end
+
+desc "Remove schema information from model and fixture files"
+task :remove_annotation => :environment do
+  require File.join(File.dirname(__FILE__), '..', 'annotate/annotate_models')
+  options={}
+  options[:model_dir] = ENV['model_dir']
+  AnnotateModels.remove_annotations(options)
+end

data/lib/tasks/migrate.rake

@@ -0,0 +1,50 @@
+# These tasks are added to the project if you install annotate as a Rails plugin.
+# (They are not used to build annotate itself.)
+
+# Append annotations to Rake tasks for ActiveRecord, so annotate automatically gets
+# run after doing db:migrate. 
+# Unfortunately it relies on ENV for options; it'd be nice to be able to set options
+# in a per-project config file so this task can read them.
+
+def run_annotate_models?
+  update_on_migrate = true
+  (defined? ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE) && 
+    (!ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE.nil?) ? 
+      ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE : true
+end
+
+
+namespace :db do
+  task :migrate do
+    if run_annotate_models?
+      Annotate::Migration.update_annotations
+    end
+  end
+
+  task :update => [:migrate] do
+    Annotate::Migration.update_annotations
+  end
+
+  namespace :migrate do
+    [:up, :down, :reset, :redo].each do |t|
+      task t do
+        if run_annotate_models?
+          Annotate::Migration.update_annotations
+        end
+      end
+    end
+  end
+end
+
+module Annotate
+  class Migration
+    @@working = false
+
+    def self.update_annotations
+      unless @@working
+        @@working = true
+        Rake::Task['annotate_models'].invoke
+      end
+    end
+  end
+end

data/spec/annotate_models_spec.rb

@@ -0,0 +1,236 @@
+#encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'annotated_models'
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'fakefs/spec_helpers'
+require 'tmpdir'
+
+describe AnnotatedModels do
+  include FakeFS::SpecHelpers
+
+  def mock_class(table_name, primary_key, columns)
+    options = {
+      :connection   => mock("Conn", :indexes => []),
+      :table_name   => table_name,
+      :model_name   => mock("ModelName", :human => ""),
+      :primary_key  => primary_key.to_s,
+      :column_names => columns.map { |col| col.name.to_s },
+      :columns      => columns
+    }
+    klass = mock("An ActiveRecord class", options)
+    columns.reverse.each do | column |
+      klass.stub!(:human_attribute_name).with(column.name, {:default=>""}).and_return("")
+    end
+    klass
+  end
+
+  def mock_column(name, type, options={})
+    default_options = {
+      :limit   => nil,
+      :null    => false,
+      :default => nil
+    }
+
+    stubs = default_options.dup
+    stubs.merge!(options)
+    stubs.merge!(:name => name, :type => type, :humanize => name.to_s.humanize)
+
+    mock("Column", stubs)
+  end
+
+  it { AnnotatedModels.quote(nil).should eql("NULL") }
+  it { AnnotatedModels.quote(true).should eql("TRUE") }
+  it { AnnotatedModels.quote(false).should eql("FALSE") }
+  it { AnnotatedModels.quote(25).should eql("25") }
+  it { AnnotatedModels.quote(25.6).should eql("25.6") }
+  it { AnnotatedModels.quote(1e-20).should eql("1.0e-20") }
+
+  it "should get schema info" do
+    klass = mock_class(:users, :id, [
+                                     mock_column(:id, :integer),
+                                     mock_column(:name, :string, :limit => 50)
+                                    ])
+
+    AnnotatedModels.get_schema_info(klass, "Schema Info").should eql(<<-EOS)
+# Schema Info
+#
+# Table name: users
+#
+#  id   :integer         not null, primary key
+#  name :string(50)      not null
+#
+
+EOS
+  end
+
+  it "should get schema info as RDoc" do
+    klass = mock_class(:users, :id, [
+                                     mock_column(:id, :integer),
+                                     mock_column(:name, :string, :limit => 50)
+                                    ])
+    ENV.stub!(:[]).with('format_rdoc').and_return(true)
+    AnnotatedModels.get_schema_info(klass, AnnotatedModels::PREFIX).should eql(<<-EOS)
+# #{AnnotatedModels::PREFIX}
+#
+# Table name: users
+#
+# *id*::   <tt>integer, not null, primary key</tt>
+# *name*:: <tt>string(50), not null</tt>
+#--
+# #{AnnotatedModels::END_MARK}
+#++
+
+EOS
+  end
+
+  describe "#get_model_class" do
+
+    def create(file, body="hi")
+      path = @dir + '/' + file
+      File.open(path, "w") do |f|
+        f.puts(body)
+      end
+      path
+    end
+
+    before :all do
+      @dir = File.join Dir.tmpdir, "annotate_models"
+      FileUtils.mkdir_p(@dir)
+      AnnotatedModels.model_dir = @dir
+
+      create('foo.rb', <<-EOS)
+        class Foo < ActiveRecord::Base
+        end
+      EOS
+      create('foo_with_macro.rb', <<-EOS)
+        class FooWithMacro < ActiveRecord::Base
+          acts_as_awesome :yah
+        end
+      EOS
+      create('foo_with_utf8.rb', <<-EOS)
+        #encoding: utf-8
+        class FooWithUtf8 < ActiveRecord::Base
+          UTF8STRINGS = %w[résumé façon âge]
+        end
+      EOS
+    end
+
+    it "should work" do
+      klass = AnnotatedModels.get_model_class("foo.rb")
+      klass.name.should == "Foo"
+    end
+
+    it "should not care about unknown macros" do
+      klass = AnnotatedModels.get_model_class("foo_with_macro.rb")
+      klass.name.should == "FooWithMacro"
+    end
+
+    it "should not complain of invalid multibyte char (USASCII)" do
+      klass = AnnotatedModels.get_model_class("foo_with_utf8.rb")
+      klass.name.should == "FooWithUtf8"
+    end
+  end
+
+  describe "#remove_annotation_of_file" do
+    def create(file, body="hi")
+      File.open(file, "w") do |f|
+        f.puts(body)
+      end
+    end
+
+    def content(file)
+      File.read(file)
+    end
+
+    it "should remove before annotate" do
+      create("before.rb", <<-EOS)
+# == Schema Information
+#
+# Table name: foo
+#
+#  id                  :integer         not null, primary key
+#  created_at          :datetime
+#  updated_at          :datetime
+#
+
+class Foo < ActiveRecord::Base
+end
+      EOS
+
+      AnnotatedModels.remove_annotation_of_file("before.rb")
+
+      content("before.rb").should == <<-EOS
+class Foo < ActiveRecord::Base
+end
+      EOS
+    end
+
+    it "should remove after annotate" do
+      create("after.rb", <<-EOS)
+class Foo < ActiveRecord::Base
+end
+
+# == Schema Information
+#
+# Table name: foo
+#
+#  id                  :integer         not null, primary key
+#  created_at          :datetime
+#  updated_at          :datetime
+#
+
+      EOS
+
+      AnnotatedModels.remove_annotation_of_file("after.rb")
+
+      content("after.rb").should == <<-EOS
+class Foo < ActiveRecord::Base
+end
+      EOS
+    end
+  end
+
+  describe "annotating a file" do
+    before do
+      @file_name    = "user.rb"
+      @file_content = <<-EOS
+class User < ActiveRecord::Base
+end
+      EOS
+      File.open(@file_name, "wb") { |f| f.write @file_content }
+      @klass = mock_class(:users, :id, [
+                                        mock_column(:id, :integer),
+                                        mock_column(:name, :string, :limit => 50)
+                                       ])
+      @schema_info = AnnotatedModels.get_schema_info(@klass, "== Schema Info")
+    end
+
+    it "should annotate the file before the model if position == 'before'" do
+      AnnotatedModels.annotate_one_file(@file_name, @schema_info, :position => "before")
+      File.read(@file_name).should == "#{@schema_info}#{@file_content}"
+    end
+
+    it "should annotate before if given :position => :before" do
+      AnnotatedModels.annotate_one_file(@file_name, @schema_info, :position => :before)
+      File.read(@file_name).should == "#{@schema_info}#{@file_content}"
+    end
+
+    it "should annotate before if given :position => :after" do
+      AnnotatedModels.annotate_one_file(@file_name, @schema_info, :position => :after)
+      File.read(@file_name).should == "#{@file_content}\n#{@schema_info}"
+    end
+
+    it "should update annotate position" do
+      AnnotatedModels.annotate_one_file(@file_name, @schema_info, :position => :before)
+
+      another_schema_info = AnnotatedModels.get_schema_info(mock_class(:users, :id, [mock_column(:id, :integer),]),
+                                                           "== Schema Info")
+
+      AnnotatedModels.annotate_one_file(@file_name, another_schema_info, :position => :after)
+
+      File.read(@file_name).should == "#{@file_content}\n#{another_schema_info}"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'annotated_models'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/todo.txt

@@ -0,0 +1,4 @@
+TODO
+-----
+add "top" and "bottom" as synonyms for "before" and "after"
+change 'exclude' to 'only' (double negatives are not unconfusing)