sequel-annotate 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb5fcadf130d2d23412b4597e7e0b1fa4c2ef7c0
-  data.tar.gz: efa509bb8630ad280e036c47105d4f3fd84a8a54
+  metadata.gz: 2f316737efff6528dad01a3dd9a142299d89430a
+  data.tar.gz: 1cd80a2169fd571993dceac826153c71fcf9e70f
 SHA512:
-  metadata.gz: 9ea01f3487452deeb82a3b34b5c2469c47d7e10e843dc66d60b68e4a762e841d21cbe73611ff3f400006dc5acbbc57db1a47598082200f5a132b1c2abd103e42
-  data.tar.gz: 945371efe3340ddd3a41f887572d6214b6940659a16cb9602cce9cec9cfd0f1ec104ef077a87b4658dff725bbd709cc131d09fda282e655cd441b794b948dffc
+  metadata.gz: 3a5d46059231408e13f9fe1752a164a038dfead63b28601184552410982eb04532a8f4083355ac42cf51adab9dfdb4ca95d3c3bed28b0fbf2b45f69a0e9a3dec
+  data.tar.gz: 36855434041c486606a055cd42029dec03a8613a62aaeefd4ce8431fce89cd28f8e07398b2d395d5b2ecec0d9a8edad85abae1556f76c0f6e572077285ff8b37

data/CHANGELOG

@@ -1,3 +1,7 @@
-=== 1.0.0 (2014-09-15)
+=== 1.1.0 (2017-09-06)
+
+* Support :position=>:before option to annotate to put annotation at the beginning of the file (a0s) (#4)
+
+=== 1.0.0 (2015-09-14)
 
 * Initial Public Release

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Jeremy Evans
+Copyright (c) 2015-2017 Jeremy Evans
 Copyright (c) 2013-2015 Kenny Meyer
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.rdoc

@@ -10,7 +10,7 @@ tables that reference the current table.
 
 == Example
 
-The schema comments are kept at the end of the file, using a format similar to:
+The schema comments are kept at the end of the file by default, using a format similar to:
 
   class Item < Sequel::Model
   end
@@ -62,6 +62,26 @@ a file:
 
   sa.schema_comment
 
+If you want to put the schema comment at the beginning of the file you can use
+the :position option:
+
+  Sequel::Annotate.annotate(Dir['models/*.rb'], position: :before)
+
+or
+
+  sa = Sequel::Annotate.new(Item)
+  sa.annotate('models/item.rb', position: :before)
+
+=== Rake Task
+
+Here's an example rake task for sequel-annotate:
+
+  desc "Update model annotations"
+  task :annotate do
+    require 'sequel/annotate'
+    Sequel::Annotate.annotate(Dir['models/*.rb'])
+  end
+
 == License
 
 MIT

data/lib/sequel/annotate.rb

@@ -8,11 +8,11 @@ module Sequel
     # an instance manually and pass in the model and path. Example:
     # 
     #   Sequel::Annotate.annotate(Dir['models/*.rb'])
-    def self.annotate(paths)
+    def self.annotate(paths, options = {})
       Sequel.extension :inflector
       paths.each do |path|
         if match = File.read(path).match(/class (\S+)\s*<\s*Sequel::Model/)
-          new(match[1].constantize).annotate(path)
+          new(match[1].constantize).annotate(path, options)
         end
       end
     end
@@ -22,26 +22,30 @@ module Sequel
 
     # Store the model to annotate
     def initialize(model)
-      @model = model 
+      @model = model
     end
 
     # Append the schema comment (or replace it if one already exists) to
     # the file at the given path.
-    def annotate(path)
+    def annotate(path, options = {})
       orig = current = File.read(path).rstrip
 
-      if m = current.reverse.match(/#{"#{$/}# Table: ".reverse}/m)
-        offset = current.length - m.end(0) + 1
-        unless current[offset..-1].match(/^[^#]/)
-          # If Table: comment exists, and there are no
-          # uncommented lines between it and the end of the file
-          # then replace current comment instead of appending it
-          current = current[0...offset].rstrip
+      if options[:position] == :before
+        current = current.gsub(/\A#\sTable[^\n\r]+\r?\n(?:#[^\n\r]*\r?\n)*/m, '').lstrip
+        current = "#{schema_comment}#{$/}#{$/}#{current}"
+      else
+        if m = current.reverse.match(/#{"#{$/}# Table: ".reverse}/m)
+          offset = current.length - m.end(0) + 1
+          unless current[offset..-1].match(/^[^#]/)
+            # If Table: comment exists, and there are no
+            # uncommented lines between it and the end of the file
+            # then replace current comment instead of appending it
+            current = current[0...offset].rstrip
+          end
         end
+        current += "#{$/}#{$/}#{schema_comment}"
       end
 
-      current += "#{$/}#{$/}#{schema_comment}"
-
       if orig != current
         File.open(path, "wb") do |f|
           f.puts current

data/spec/{annotated → annotated_after}/scategory.rb

@@ -5,3 +5,5 @@ end
 # Columns:
 #  id   | integer      | PRIMARY KEY AUTOINCREMENT
 #  name | varchar(255) | NOT NULL
+# Indexes:
+#  categories_name_key | UNIQUE (name)

data/spec/annotated_before/category.rb

@@ -0,0 +1,12 @@
+# Table: categories
+# Columns:
+#  id   | integer | PRIMARY KEY DEFAULT nextval('categories_id_seq'::regclass)
+#  name | text    | NOT NULL
+# Indexes:
+#  categories_pkey     | PRIMARY KEY btree (id)
+#  categories_name_key | UNIQUE btree (name)
+# Referenced By:
+#  items | items_category_id_fkey | (category_id) REFERENCES categories(id)
+
+class Category < Sequel::Model
+end

data/spec/annotated_before/item.rb

@@ -0,0 +1,23 @@
+# 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()
+
+class Item < Sequel::Model
+end

data/spec/annotated_before/manufacturer.rb

@@ -0,0 +1,12 @@
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | text |
+#  location | text |
+# Indexes:
+#  manufacturers_pkey | PRIMARY KEY btree (name, location)
+# Referenced By:
+#  items | items_manufacturer_name_fkey | (manufacturer_name, manufacturer_location) REFERENCES manufacturers(name, location)
+
+class Manufacturer < Sequel::Model
+end

data/spec/annotated_before/scategory.rb

@@ -0,0 +1,9 @@
+# Table: categories
+# Columns:
+#  id   | integer      | PRIMARY KEY AUTOINCREMENT
+#  name | varchar(255) | NOT NULL
+# Indexes:
+#  categories_name_key | UNIQUE (name)
+
+class SCategory < Sequel::Model(SDB[:categories])
+end

data/spec/annotated_before/sitem.rb

@@ -0,0 +1,18 @@
+# Table: items
+# Columns:
+#  id                    | integer          | PRIMARY KEY AUTOINCREMENT
+#  category_id           | integer          | NOT NULL
+#  manufacturer_name     | varchar(50)      |
+#  manufacturer_location | varchar(255)     |
+#  in_stock              | boolean          | DEFAULT 0
+#  name                  | varchar(255)     | DEFAULT 'John'
+#  price                 | double precision | DEFAULT 0
+# Indexes:
+#  manufacturer_name | (manufacturer_name)
+#  name              | UNIQUE (manufacturer_name, manufacturer_location)
+# Foreign key constraints:
+#  (category_id) REFERENCES categories
+#  (manufacturer_name, manufacturer_location) REFERENCES manufacturers
+
+class SItem < Sequel::Model(SDB[:items])
+end

data/spec/annotated_before/smanufacturer.rb

@@ -0,0 +1,8 @@
+# Table: manufacturers
+# Primary Key: (name, location)
+# Columns:
+#  name     | varchar(255) |
+#  location | varchar(255) |
+
+class SManufacturer < Sequel::Model(SDB[:manufacturers])
+end

data/spec/sequel-annotate_spec.rb

@@ -13,7 +13,7 @@ SDB = Sequel.sqlite
 [DB, SDB].each do |db|
   db.create_table :categories do
     primary_key :id
-    String :name, :unique=>true, :null=>false
+    String :name, :index=>{:unique=>true, :name=>'categories_name_key'}, :null=>false
   end
 
   db.create_table :manufacturers do
@@ -67,7 +67,7 @@ class ::SManufacturer < Sequel::Model(SDB[:manufacturers]); end
 
 describe Sequel::Annotate do
   before do
-    File.mkdir('spec/tmp') unless File.directory?('spec/tmp')
+    Dir.mkdir('spec/tmp') unless File.directory?('spec/tmp')
   end
   after do
     Dir['spec/tmp/*.rb'].each{|f| File.delete(f)}
@@ -144,6 +144,8 @@ OUTPUT
 # Columns:
 #  id   | integer      | PRIMARY KEY AUTOINCREMENT
 #  name | varchar(255) | NOT NULL
+# Indexes:
+#  categories_name_key | UNIQUE (name)
 OUTPUT
 
     Sequel::Annotate.new(SManufacturer).schema_comment.must_equal((<<OUTPUT).chomp)
@@ -154,27 +156,29 @@ OUTPUT
 #  location | varchar(255) |
 OUTPUT
   end
+  
+  [['without options', 'after', []], ['with :position=>:before option', 'before', [{:position=>:before}]]].each do |desc, pos, args|
+    it "#annotate #{desc} should annotate the file comment" do
+      FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
 
-  it "#annotate should annotate the file comment" do
-    FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
-
-    [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
-      filename = model.name.downcase
-      2.times do
-        Sequel::Annotate.new(model).annotate("spec/tmp/#{filename}.rb")
-        File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated/#{filename}.rb")
+      [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
+        filename = model.name.downcase
+        2.times do
+          Sequel::Annotate.new(model).annotate("spec/tmp/#{filename}.rb", *args)
+          File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated_#{pos}/#{filename}.rb")
+        end
       end
     end
-  end
 
-  it ".annotate should annotate all files given" do
-    FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
+    it ".annotate #{desc} should annotate all files given" do
+      FileUtils.cp(Dir['spec/unannotated/*.rb'], 'spec/tmp')
 
-    2.times do
-      Sequel::Annotate.annotate(Dir["spec/tmp/*.rb"])
-      [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
-        filename = model.name.downcase
-        File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated/#{filename}.rb")
+      2.times do
+        Sequel::Annotate.annotate(Dir["spec/tmp/*.rb"], *args)
+        [Item, Category, Manufacturer, SItem, SCategory, SManufacturer].each do |model|
+          filename = model.name.downcase
+          File.read("spec/tmp/#{filename}.rb").must_equal File.read("spec/annotated_#{pos}/#{filename}.rb")
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-annotate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -87,12 +87,18 @@ files:
 - README.rdoc
 - Rakefile
 - lib/sequel/annotate.rb
-- spec/annotated/category.rb
-- spec/annotated/item.rb
-- spec/annotated/manufacturer.rb
-- spec/annotated/scategory.rb
-- spec/annotated/sitem.rb
-- spec/annotated/smanufacturer.rb
+- spec/annotated_after/category.rb
+- spec/annotated_after/item.rb
+- spec/annotated_after/manufacturer.rb
+- spec/annotated_after/scategory.rb
+- spec/annotated_after/sitem.rb
+- spec/annotated_after/smanufacturer.rb
+- spec/annotated_before/category.rb
+- spec/annotated_before/item.rb
+- spec/annotated_before/manufacturer.rb
+- spec/annotated_before/scategory.rb
+- spec/annotated_before/sitem.rb
+- spec/annotated_before/smanufacturer.rb
 - spec/sequel-annotate_spec.rb
 - spec/unannotated/category.rb
 - spec/unannotated/item.rb
@@ -127,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Annotate Sequel models with schema information