sequel-annotate 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 112ffb3483f88eacd72945f7890fac2d21b8cfa8f4559b13210eb76d80e36e53
-  data.tar.gz: b2a580e9ddc239a8d2fb948ac5c571733915d9badf2c84385f3d21aaede7ab71
+  metadata.gz: 024d60493f6cff6f11e88759519c7bea3527e085d0bd888f8cc84ed74dba112c
+  data.tar.gz: 722da23fe55ebe66b84377ff62ac851d20417950173bb977f21bd7678710f279
 SHA512:
-  metadata.gz: edcaf9424b611f0ec0b08fb511ef2f7f9d245756040e8adf829101264846c0768f24e4d52d143d64fed4e8a05d58aa820758023e6f1d49e83ed0b87e64c0aa70
-  data.tar.gz: 267dbf8b5693e541abbe3d97154adddfd839d2ea0e3e88475146c0d4739b6f1b42cfd2d01959984d8d7a68851375875a0e11ec28fbf1d5ab8b5c942f2d9f9efd
+  metadata.gz: 1340b7bc98e1650fc91075a5cdd34d4e5f56c21a6c58b8b9c460b68d0bb8fb0997b82f7294d04d9f90b377b2b236057901f711c16a0233ff951948f1f48f39da
+  data.tar.gz: e64ebdcbe577333c76b94fbd45ea795eb918193e46493dd8dba76789214250faba6ab97b5c765d4143be68ecf28d7f29cc7bc76b52750b0ad1ff96e445b4a211

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 1.3.0 (2018-07-17)
+
+* Support :namespace option to specify namespace to add for models nested in namespaces (jeremyevans)
+
+* Make Sequel::Annotate.annotate support STI classes and custom abstract base classes (a0s) (#7)
+
 === 1.2.0 (2018-04-02)
 
 * Handle PostgreSQL 10+ identity columns when running on Sequel 5.7+ (jeremyevans)

data/README.rdoc

@@ -72,16 +72,39 @@ or
   sa = Sequel::Annotate.new(Item)
   sa.annotate('models/item.rb', position: :before)
 
+If your models are nested in a namespace:
+
+  module ModelNamespace
+    class Item < Sequel::Model
+    end
+  end
+
+Then you can use the +:namespace+ option to set the namespace to use:
+
+  Sequel::Annotate.annotate(Dir['models/*.rb'], namespace: 'ModelNamespace')
+
 === Rake Task
 
 Here's an example rake task for sequel-annotate:
 
   desc "Update model annotations"
   task :annotate do
+    # Load the models first
+    Dir['models/*.rb'].each{|f| require_relative f}
+
     require 'sequel/annotate'
     Sequel::Annotate.annotate(Dir['models/*.rb'])
   end
 
+== Running Tests
+
+Tests of sequel-annotate itself can be run with rake:
+
+  rake
+
+Set the SEQUEL_ANNOTATE_SPEC_POSTGRES_URL environment variable or appropriate
+libpq environment variables to specify which PostgreSQL database to connect to.
+
 == License
 
 MIT

data/lib/sequel/annotate.rb

@@ -10,9 +10,18 @@ module Sequel
     #   Sequel::Annotate.annotate(Dir['models/*.rb'])
     def self.annotate(paths, options = {})
       Sequel.extension :inflector
+      namespace = options[:namespace]
+
       paths.each do |path|
-        if match = File.read(path).match(/class (\S+)\s*<\s*Sequel::Model/)
-          new(match[1].constantize).annotate(path, options)
+        if match = File.read(path).match(/class (\S+)\s*</)
+          name = match[1]
+          if namespace
+            name = "#{namespace}::#{name}"
+          end
+          klass = name.constantize
+          if klass.ancestors.include?(Sequel::Model)
+            new(klass).annotate(path, options)
+          end
         end
       end
     end

data/spec/annotated_after/manufacturer.rb

@@ -1,4 +1,4 @@
-class Manufacturer < Sequel::Model
+class Manufacturer < ABC
 end
 
 # Table: manufacturers

data/spec/annotated_before/manufacturer.rb

@@ -8,5 +8,5 @@
 # Referenced By:
 #  items | items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
 
-class Manufacturer < Sequel::Model
+class Manufacturer < ABC
 end

data/spec/namespaced/itm_annotated.rb

@@ -0,0 +1,24 @@
+module ModelNamespace
+  class Itms < Model(:items); end
+end
+
+# Table: items
+# Columns:
+#  id                    | integer               | PRIMARY KEY DEFAULT nextval('items_id_seq'::regclass)
+#  category_id           | integer               | NOT NULL
+#  manufacturer_name     | character varying(50) |
+#  manufacturer_location | text                  |
+#  in_stock              | boolean               | DEFAULT false
+#  name                  | text                  | DEFAULT 'John'::text
+#  price                 | double precision      | DEFAULT 0
+# Indexes:
+#  items_pkey        | PRIMARY KEY btree (id)
+#  name              | UNIQUE btree (manufacturer_name, manufacturer_location)
+#  manufacturer_name | btree (manufacturer_name)
+# Check constraints:
+#  pos_id | (id > 0)
+# Foreign key constraints:
+#  items_category_id_fkey       | (category_id) REFERENCES categories(id)
+#  items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+# Triggers:
+#  valid_price | BEFORE INSERT OR UPDATE ON items FOR EACH ROW EXECUTE PROCEDURE valid_price()

data/spec/namespaced/itm_unannotated.rb

@@ -0,0 +1,3 @@
+module ModelNamespace
+  class Itms < Model(:items); end
+end

data/spec/sequel-annotate_spec.rb

@@ -1,16 +1,23 @@
 require 'rubygems'
 require 'fileutils'
 require File.join(File.dirname(File.expand_path(__FILE__)), '../lib/sequel/annotate')
+
+ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
+gem 'minitest'
 require 'minitest/autorun'
 
-pg_user = ENV['PGUSER'] || 'postgres'
-db_name = ENV['SEQUEL_ANNOTATE_DB'] || 'sequel-annotate_spec'
-system("dropdb", "-U", pg_user, db_name)
-system("createdb", "-U", pg_user, db_name)
-DB = Sequel.postgres(db_name, :user=>pg_user)
-SDB = Sequel.sqlite
+DB = Sequel.connect(ENV['SEQUEL_ANNOTATE_SPEC_POSTGRES_URL'] || 'postgres:///sequel_annotate_test?user=sequel_annotate&password=sequel_annotate')
+raise "test database name doesn't end with test" unless DB.get{current_database.function} =~ /test\z/
+if defined?(JRUBY_VERSION)
+  SDB = Sequel.connect('jdbc:sqlite::memory:')
+else
+  SDB = Sequel.sqlite
+end
 
+DB.drop_function(:valid_price) rescue nil
 [DB, SDB].each do |db|
+  db.drop_table?(:items, :manufacturers, :categories)
+
   db.create_table :categories do
     primary_key :id
     String :name, :index=>{:unique=>true, :name=>'categories_name_key'}, :null=>false
@@ -57,6 +64,11 @@ CREATE TRIGGER valid_price BEFORE INSERT OR UPDATE ON items
     FOR EACH ROW EXECUTE PROCEDURE valid_price();
 SQL
 
+Minitest.after_run do
+  DB.drop_table(:items, :manufacturers, :categories)
+  DB.drop_function(:valid_price)
+end
+
 class ::Item < Sequel::Model; end
 class ::Category < Sequel::Model; end
 class ::Manufacturer < Sequel::Model; end
@@ -64,6 +76,14 @@ class ::SItem < Sequel::Model(SDB[:items]); end
 class ::SCategory < Sequel::Model(SDB[:categories]); end
 class ::SManufacturer < Sequel::Model(SDB[:manufacturers]); end
 
+# Abstract Base Class
+ABC = Class.new(Sequel::Model)
+
+module ModelNamespace
+  Model = Class.new(Sequel::Model)
+  Model.def_Model(self)
+  class Itms < Model(:items); end
+end
 
 describe Sequel::Annotate do
   def fix_pg_comment(comment)
@@ -193,4 +213,10 @@ OUTPUT
       end
     end
   end
+
+  it ".annotate #{desc} should handle :namespace option" do
+    FileUtils.cp('spec/namespaced/itm_unannotated.rb', 'spec/tmp/')
+    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
 end

data/spec/unannotated/manufacturer.rb

@@ -1,2 +1,2 @@
-class Manufacturer < Sequel::Model
+class Manufacturer < ABC
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-annotate
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -99,6 +99,8 @@ files:
 - spec/annotated_before/scategory.rb
 - spec/annotated_before/sitem.rb
 - spec/annotated_before/smanufacturer.rb
+- spec/namespaced/itm_annotated.rb
+- spec/namespaced/itm_unannotated.rb
 - spec/sequel-annotate_spec.rb
 - spec/unannotated/category.rb
 - spec/unannotated/item.rb