sequel-annotate 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe18cf12eced99b6453d25c4e7194e807ac4e9aad1e21d0371c72452dd6d2f4
-  data.tar.gz: 442da3e19cf3a387f0a73aede9f6c16219d7984338b777a85a2d4d04053a1f28
+  metadata.gz: 42122bfc730bb5345c90160c5a17b0861c3a5a8308dfc6a008c1fccc0b73fe3e
+  data.tar.gz: 7bbb33c84261d97a66c17b942c19fc0b432d4029b8e384f148ec79ddf96c196e
 SHA512:
-  metadata.gz: 2c01cfbc83195c28c29c458517ef9ea54ee9b40e5c3ac9faa70bb97db1c458a65e82496772d43faa89289da9f0f22ede013169a7a37da24721c1de4b82b046db
-  data.tar.gz: 566f31d7ebdc2e86dce167327c0ec4ead26d5755ff5621334421f6fef54eba16d6b84c1e7e6e5b44fe42f9bb29c78b2482cbba0eda38c730bc28574e08e731cd
+  metadata.gz: 4ee1e34b6317be4e57f113a33e47c83190157ee3cbbae9cfd209c8806895aacc5e44604bbf2f0cfcbee1114a8822ed0c36a9ccdad628cb66daab58873d9020b8
+  data.tar.gz: d27e5074fb1c7642993647185605d0d714482d1f9ce5bc9e7b58817872f69674d0e803fa68210d0d73b2c176a479a44224a3678c602b1681116acae8dbf16d8c

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 1.6.0 (2020-10-05)
+
+* Add support for :namespace=>true option to attempt to automatically determine namespace (adam12) (#20)
+
+* Skip models that select from a subquery (adam12, jeremyevans) (#17)
+
+* Allow files to be skipped with sequel-annotate: false magic comment (adam12) (#18)
+
+* Ignore opening of singleton classes with class << when looking for models (adam12) (#16)
+
 === 1.5.0 (2020-05-04)
 
 * Add support for magic comments in model files when using the :position=>:before option (qortex, jeremyevans) (#15)

data/README.rdoc

@@ -93,6 +93,11 @@ The columns section can have a border on the top and bottom for easier visual di
 
   Sequel::Annotate.annotate(Dir['models/*.rb'], border: true)
 
+Models that use datasets that select from subqueries are automatically skipped,
+as annotations don't really make sense for them since they are not backed by a
+table.  You can skip other models by using a <tt># sequel-annotate: false</tt>
+magic comment somewhere in the file.
+
 === Rake Task
 
 Here's an example rake task for sequel-annotate:

data/Rakefile

@@ -28,19 +28,11 @@ begin
 rescue Gem::LoadError
 end
 
-rdoc_task_class = begin
-  require "rdoc/task"
-  RDoc::Task
-rescue LoadError
-  require "rake/rdoctask"
-  Rake::RDocTask
-end
-
 RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
 
-rdoc_task_class.new do |rdoc|
+require "rdoc/task"
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
   rdoc.options += RDOC_OPTS
   rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
 end
-

data/lib/sequel/annotate.rb

@@ -13,11 +13,22 @@ module Sequel
       namespace = options[:namespace]
 
       paths.each do |path|
-        if match = File.read(path).match(/class (\S+)\s*</)
+        text = File.read(path)
+
+        next if text.match(/^#\s+sequel-annotate:\s+false$/i)
+
+        name = nil
+        if namespace == true
+          constants = text.scan(/\bmodule ([^\s]+)|class ([^\s<]+)\s*</).flatten.compact
+          name = constants.join("::") if constants.any?
+        elsif match = text.match(/class ([^\s<]+)\s*</)
           name = match[1]
           if namespace
             name = "#{namespace}::#{name}"
           end
+        end
+
+        if name
           klass = name.constantize
           if klass.ancestors.include?(Sequel::Model)
             new(klass).annotate(path, options)
@@ -37,6 +48,8 @@ module Sequel
     # Append the schema comment (or replace it if one already exists) to
     # the file at the given path.
     def annotate(path, options = {})
+      return if skip_model?
+
       orig = current = File.read(path).rstrip
 
       if options[:position] == :before
@@ -84,6 +97,8 @@ module Sequel
     #                this table if set to +false+.
     # :triggers :: Do not include triggers in annotation if set to +false+.
     def schema_comment(options = {})
+      return "" if skip_model?
+
       output = []
       output << "# Table: #{model.dataset.with_quote_identifiers(false).literal(model.table_name)}"
 
@@ -120,12 +135,12 @@ module Sequel
 
       cols.times do |i|
         rows.each do |r|
-          lengths[i] = r[i].length if r[i].length > lengths[i]
+          lengths[i] = r[i].length if r[i] && r[i].length > lengths[i]
         end
       end
 
       rows.map do |r|
-        "#  #{r.zip(lengths).map{|c, l| c.ljust(l).gsub("\n", "\n#    ")}.join(' | ')}".strip
+        "#  #{r.zip(lengths).map{|c, l| c.to_s.ljust(l).gsub("\n", "\n#    ")}.join(' | ')}".strip
       end
     end
 
@@ -277,5 +292,13 @@ SQL
         output.concat(align(rows).sort)
       end
     end
+
+    # Whether we should skip annotations for the model.
+    # True if the model selects from a dataset.
+    def skip_model?
+      model.dataset.joined_dataset? || model.dataset.first_source_table.is_a?(Dataset)
+    rescue Sequel::Error
+      true
+    end
   end
 end

data/spec/annotated_after/scomplexdataset.rb

@@ -0,0 +1,7 @@
+dataset =
+  SDB[:items]
+    .left_join(:categories, { id: :category_id })
+    .select { Sequel[:items][:name] }
+
+class SComplexDataset < Sequel::Model(dataset)
+end

data/spec/annotated_before/scomplexdataset.rb

@@ -0,0 +1,7 @@
+dataset =
+  SDB[:items]
+    .left_join(:categories, { id: :category_id })
+    .select { Sequel[:items][:name] }
+
+class SComplexDataset < Sequel::Model(dataset)
+end

data/spec/sequel-annotate_spec.rb

@@ -101,10 +101,12 @@ class ::SItemWithCoding < Sequel::Model(SDB[:items]); end
 class ::SItemWithEncoding < Sequel::Model(SDB[:items]); end
 class ::SItemWithWarnIndent < Sequel::Model(SDB[:items]); end
 class ::SItemWithWarnPastScope < Sequel::Model(SDB[:items]); end
+class ::SItemWithMagicComment < Sequel::Model(SDB[:items]); end
 class ::SCategory < Sequel::Model(SDB[:categories]); end
 class ::SManufacturer < Sequel::Model(SDB[:manufacturers]); end
 class ::NewlineTest < Sequel::Model; end
 class ::QualifiedTableNameTest < Sequel::Model(Sequel.qualify(:public, :categories)); end
+class SComplexDataset < Sequel::Model(SDB[:items].left_join(:categories, :id => :category_id).select{items[:name]}); end
 
 # Abstract Base Class
 ABC = Class.new(Sequel::Model)
@@ -133,6 +135,12 @@ describe Sequel::Annotate do
     Dir['spec/tmp/*.rb'].each{|f| File.delete(f)}
   end
 
+  it "skips files with the sequel-annotate magic comment set to false" do
+    FileUtils.cp('spec/unannotated/sitemwithmagiccomment.rb', 'spec/tmp/')
+    Sequel::Annotate.annotate(['spec/tmp/sitemwithmagiccomment.rb'])
+    File.read('spec/tmp/sitemwithmagiccomment.rb').must_equal File.read('spec/unannotated/sitemwithmagiccomment.rb')
+  end
+
   it "#schema_info should not return sections we set to false" do
     Sequel::Annotate.new(Item).schema_comment(:indexes => false, :constraints => false, :foreign_keys => false, :triggers => false).must_equal(fix_pg_comment((<<OUTPUT).chomp))
 # Table: items
@@ -197,6 +205,7 @@ OUTPUT
 #  valid_price | BEFORE INSERT OR UPDATE ON items FOR EACH ROW EXECUTE PROCEDURE valid_price()
 OUTPUT
 
+    Sequel::Annotate.new(SComplexDataset).schema_comment.must_equal("")
     Sequel::Annotate.new(Category).schema_comment.must_equal(fix_pg_comment((<<OUTPUT).chomp))
 # Table: categories
 # Columns:
@@ -304,7 +313,7 @@ OUTPUT
     it "#annotate #{desc} should annotate the file comment" do
       FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
 
-      [Item, Category, Manufacturer, SItem, SCategory, SManufacturer, SItemWithFrozenLiteral, SItemWithCoding, SItemWithEncoding, SItemWithWarnIndent, SItemWithWarnPastScope].each do |model|
+      [Item, Category, Manufacturer, SItem, SCategory, SManufacturer, SItemWithFrozenLiteral, SItemWithCoding, SItemWithEncoding, SItemWithWarnIndent, SItemWithWarnPastScope, SComplexDataset].each do |model|
         filename = model.name.downcase
         2.times do
           Sequel::Annotate.new(model).annotate("spec/tmp/#{filename}.rb", *args)
@@ -320,7 +329,7 @@ OUTPUT
 
       2.times do
         Sequel::Annotate.annotate(Dir["spec/tmp/*.rb"], *args)
-        [Item, Category, Manufacturer, SItem, SCategory, SManufacturer, SItemWithFrozenLiteral, SItemWithCoding, SItemWithEncoding, SItemWithWarnIndent, SItemWithWarnPastScope].each do |model|
+        [Item, Category, Manufacturer, SItem, SCategory, SManufacturer, SItemWithFrozenLiteral, SItemWithCoding, SItemWithEncoding, SItemWithWarnIndent, SItemWithWarnPastScope, SComplexDataset].each do |model|
           filename = model.name.downcase
           expected = File.read("spec/annotated_#{pos}/#{filename}.rb")
           expected = fix_pg_comment(expected) if model.db == DB
@@ -338,4 +347,10 @@ OUTPUT
     Sequel::Annotate.annotate(["spec/tmp/itm_unannotated.rb"], :namespace=>'ModelNamespace')
     File.read("spec/tmp/itm_unannotated.rb").must_equal fix_pg_comment(File.read('spec/namespaced/itm_annotated.rb'))
   end
+
+  it ".annotate #{desc} should handle :namespace => true option" do
+    FileUtils.cp('spec/namespaced/itm_unannotated.rb', 'spec/tmp')
+    Sequel::Annotate.annotate(["spec/tmp/itm_unannotated.rb"], :namespace=>true)
+    File.read("spec/tmp/itm_unannotated.rb").must_equal fix_pg_comment(File.read('spec/namespaced/itm_annotated.rb'))
+  end
 end

data/spec/unannotated/not_model.rb

@@ -0,0 +1,4 @@
+class NotModel
+  class << self
+  end
+end

data/spec/unannotated/scomplexdataset.rb

@@ -0,0 +1,7 @@
+dataset =
+  SDB[:items]
+    .left_join(:categories, { id: :category_id })
+    .select { Sequel[:items][:name] }
+
+class SComplexDataset < Sequel::Model(dataset)
+end

data/spec/unannotated/sitemwithmagiccomment.rb

@@ -0,0 +1,4 @@
+# sequel-annotate: false
+
+class SItemWithMagicComment < Sequel::Model(SDB[:items])
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-annotate
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -105,6 +105,7 @@ files:
 - spec/annotated_after/item.rb
 - spec/annotated_after/manufacturer.rb
 - spec/annotated_after/scategory.rb
+- spec/annotated_after/scomplexdataset.rb
 - spec/annotated_after/sitem.rb
 - spec/annotated_after/sitemwithcoding.rb
 - spec/annotated_after/sitemwithencoding.rb
@@ -116,6 +117,7 @@ files:
 - spec/annotated_before/item.rb
 - spec/annotated_before/manufacturer.rb
 - spec/annotated_before/scategory.rb
+- spec/annotated_before/scomplexdataset.rb
 - spec/annotated_before/sitem.rb
 - spec/annotated_before/sitemwithcoding.rb
 - spec/annotated_before/sitemwithencoding.rb
@@ -129,11 +131,14 @@ files:
 - spec/unannotated/category.rb
 - spec/unannotated/item.rb
 - spec/unannotated/manufacturer.rb
+- spec/unannotated/not_model.rb
 - spec/unannotated/scategory.rb
+- spec/unannotated/scomplexdataset.rb
 - spec/unannotated/sitem.rb
 - spec/unannotated/sitemwithcoding.rb
 - spec/unannotated/sitemwithencoding.rb
 - spec/unannotated/sitemwithfrozenliteral.rb
+- spec/unannotated/sitemwithmagiccomment.rb
 - spec/unannotated/sitemwithwarnindent.rb
 - spec/unannotated/sitemwithwarnpastscope.rb
 - spec/unannotated/smanufacturer.rb
@@ -166,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Annotate Sequel models with schema information