annotate-sequel 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 763bf4cfb746754ac1779570f90a208dcd7fa85d
-  data.tar.gz: 4fef2f90136e7cff56650bc5cb3d000cf4eaa113
+  metadata.gz: 7adf0f0f1c3ded597dcbfcc5ed2ff4a7ff652825
+  data.tar.gz: 1a9fbb9511a13d59e8df47991e1110749271979d
 SHA512:
-  metadata.gz: 5958ddf5d37e57309c38a075e27b0249901c7d6bbae15cc5b869b317a3f7a25fd17ac3db48154604adcb0b3fd2ee657714f242285baf632d77e3b4238bbfd322
-  data.tar.gz: ef1887a9ca0d29849e42ac7c26c3862a6de941cb0068f2fa1f1de795bf013a34f29cda6de2b66271605306adc06f4c8c062d476841f0b1ca20a736c1de4be989
+  metadata.gz: 886ae43b3f88a8044e190abadc12ead0df6de569b204fc5a6c490f2dbe781003876b90e9fe8baceb32500d1ee4ffce82cf834122c21cf22b558741ec3ad77935
+  data.tar.gz: bee6d3d2e96c7ff5a53a456241947567e608b0494a1d0dcdc7fe9ea814f08125ffe52496a52358404d4ee4bdce58f0bb3bb89049c4666e8071b98f26f3400bf1

data/README.rdoc

@@ -1,5 +1,7 @@
 = annotate-sequel
 
+*DEPRECATED*: Please use the fork https://github.com/jeremyevans/sequel-annotate instead.
+
 A gem to annotate your Sequel models.
 
 Currently only tested for Rails 3 and only supports Sequel 3.x as of right now.
@@ -57,6 +59,6 @@ That's it.
 
 == Copyright
 
-Copyright (c) 2013 Kenny Meyer. See LICENSE.txt for
+Copyright (c) 2013-2016 Kenny Meyer. See LICENSE.txt for
 further details.
 

data/annotate-sequel.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: annotate-sequel 1.1.0 ruby lib
+# stub: annotate-sequel 1.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "annotate-sequel"
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kenny Meyer"]
-  s.date = "2014-11-24"
+  s.date = "2016-02-01"
   s.description = "Annotate Sequel models"
   s.email = "kenny@kennymeyer.net"
   s.executables = ["annotate"]
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/kennym/annotate-sequel"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.8"
   s.summary = "Annotate Sequel models"
 
   if s.respond_to? :specification_version then

data/lib/annotate_sequel/model.rb

@@ -25,7 +25,7 @@ class AnnotateSequel
           [ key,
             value[:type],
             value[:db_type],
-            value[:ruby_default] || '-',
+            value[:ruby_default].nil? ? '-' :  value[:ruby_default] , # old style fails for default: false
             value[:allow_null]  ? 'Y' : 'N',
             value[:primary_key] ? 'Y' : 'N',
             fks.include?(key)   ? 'Y' : 'N'
@@ -42,9 +42,37 @@ class AnnotateSequel
         output = String.new
         table.to_s.each_line { |line| output << "# #{line}" }
 
+        indexes = process_indexes(klass)
+
+        if indexes.any?
+          output << "\n"
+          index_tbl = Terminal::Table.new
+          index_tbl.title = "Indexes"
+          index_tbl.headings = ["Name", "Columns", "Unique?"]
+          index_tbl.rows = indexes
+          index_tbl.to_s.each_line { |line| output << "# #{line}" }
+        end
         output << "\n\n"
       end
 
+      def process_indexes(model)
+        model.db.indexes(model.table_name).map do |name, index|
+          [name, index[:columns].join(", "), index[:unique]]
+        end
+      end
+
+      # following this format from i think mysql
+      # UNIQUE KEY `country` (`country`,`tag`)
+      # KEY `index_histories_user` (`user_id`)
+      def process_index(name, index)
+
+        if index[:unique]
+          "UNIQUE INDEX '#{name}' ('#{index[:columns].join("', '")}')"
+        else
+          "INDEX '#{name}' ('#{index[:columns].join("', '")}')"
+        end
+      end
+
       def process_fks(model)
         model.db.foreign_key_list(model.table_name).map do |x|
           x[:columns]

data/lib/annotate_sequel/version.rb

@@ -2,7 +2,7 @@ class AnnotateSequel
   module Version
     MAJOR = 1
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     BUILD = 'final'
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/lib/tasks/annotate_sequel.rake

@@ -2,7 +2,7 @@ annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
 
 desc "Add schema information (as comments) to model files"
 task :annotate_models => :environment do
-  require "#{annotate_lib}/annotate/model"
+  require "#{annotate_lib}/annotate_sequel/model"
 
   AnnotateSequel::Model.do_annotations
 end

data/spec/annotate_sequel/model_spec.rb

@@ -11,8 +11,12 @@ describe AnnotateSequel::Model do
 
         String :manufacturer_name, size: 50
         String :manufacturer_location
+        Boolean :in_stock, default: false
         String :name, default: "John"
         Float  :price, default: 0
+
+        index [:manufacturer_name, :manufacturer_location], :name=>:name, :unique=>true
+        index [:manufacturer_name], :name=>:manufacturer_name
       end
     end
 
@@ -33,15 +37,25 @@ describe AnnotateSequel::Model do
       # | category_id           | integer   | integer          |    -    |   N   |  N  |  Y  |
       # | manufacturer_name     | string    | varchar(50)      |    -    |   Y   |  N  |  Y  |
       # | manufacturer_location | string    | varchar(255)     |    -    |   Y   |  N  |  Y  |
+      # | in_stock              | boolean   | Boolean          |  false  |   Y   |  N  |  N  |
       # | name                  | string    | varchar(255)     |  John   |   Y   |  N  |  N  |
       # | price                 | float     | double precision |   0.0   |   Y   |  N  |  N  |
       # +-----------------------+-----------+------------------+---------+-------+-----+-----+
+      # +-------------------+------------------------------------------+---------+
+      # |                                Indexes                                 |
+      # +-------------------+------------------------------------------+---------+
+      # | Name              | Columns                                  | Unique? |
+      # +-------------------+------------------------------------------+---------+
+      # | manufacturer_name | manufacturer_name                        | false   |
+      # | name              | manufacturer_name, manufacturer_location | true    |
+      # +-------------------+------------------------------------------+---------+
       OUTPUT
 
       AnnotateSequel::Model.schema_info(klass).should eq output
     end
 
     it "should support indexes" do
+      # currently adding tests to the main test itself..
       pending
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotate-sequel
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kenny Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Annotate Sequel models