annotate-sequel 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28a0d6f43f03e5ebf5a94f6218dce32cefed5eda
-  data.tar.gz: 5bd108df8e52eeeba37b702fffbf349f8dceed3b
+  metadata.gz: 763bf4cfb746754ac1779570f90a208dcd7fa85d
+  data.tar.gz: 4fef2f90136e7cff56650bc5cb3d000cf4eaa113
 SHA512:
-  metadata.gz: a66da5880a893571ba4bb1a609207a8ef333779afb1feb4c8899f552474a0f71731e6d72f8b25b58fe6687a2c937b477d7fb21787b502dd1b921bbfcde2ac553
-  data.tar.gz: 7f58ddc159d9c072880098c044d6dbf3f5982b0f5c1589406a1b0ab777f36ae0ed24c0c114c72ff0a3ea4eb65f6026c781580f6594d6a98f0c8b70c8f1530a5c
+  metadata.gz: 5958ddf5d37e57309c38a075e27b0249901c7d6bbae15cc5b869b317a3f7a25fd17ac3db48154604adcb0b3fd2ee657714f242285baf632d77e3b4238bbfd322
+  data.tar.gz: ef1887a9ca0d29849e42ac7c26c3862a6de941cb0068f2fa1f1de795bf013a34f29cda6de2b66271605306adc06f4c8c062d476841f0b1ca20a736c1de4be989

data/Gemfile

@@ -1,13 +1,14 @@
 source "http://rubygems.org"
 
-gem 'sequel', '~> 3'
+gem 'sequel', '>= 3', '<=5'
+gem 'terminal-table', '~> 1.4'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8.7"
-  gem "simplecov", ">= 0"
+  gem "rspec", "~> 2.14"
+  gem "sqlite3", "~> 1.3"
+  gem "rdoc", "~> 4.1"
+  gem "bundler", "~> 1.5"
+  gem "jeweler", "~> 2.0"
 end

data/Gemfile.lock

@@ -3,68 +3,69 @@ GEM
   specs:
     addressable (2.3.5)
     builder (3.2.2)
-    diff-lcs (1.1.3)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
     git (1.2.6)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
       hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
       oauth2
     hashie (2.0.5)
-    highline (1.6.20)
-    httpauth (0.2.0)
-    jeweler (1.8.8)
+    highline (1.6.21)
+    jeweler (2.0.1)
       builder
-      bundler (~> 1.0)
+      bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api (= 0.10.1)
+      github_api
       highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
     json (1.8.1)
-    jwt (0.1.8)
+    jwt (0.1.11)
       multi_json (>= 1.5)
-    multi_json (1.8.2)
+    mini_portile (0.5.2)
+    multi_json (1.9.0)
     multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.10)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
-    rake (10.1.0)
-    rdoc (3.12.2)
+    rake (10.1.1)
+    rdoc (4.1.1)
       json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    sequel (3.48.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    sequel (4.8.0)
+    sqlite3 (1.3.9)
+    terminal-table (1.4.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0)
-  jeweler (~> 1.8.7)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
-  sequel (~> 3)
-  simplecov
+  bundler (~> 1.5)
+  jeweler (~> 2.0)
+  rdoc (~> 4.1)
+  rspec (~> 2.14)
+  sequel (>= 3, <= 5)
+  sqlite3 (~> 1.3)
+  terminal-table (~> 1.4)

data/annotate-sequel.gemspec

@@ -2,14 +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
 
 Gem::Specification.new do |s|
   s.name = "annotate-sequel"
-  s.version = "1.0.3"
+  s.version = "1.1.0"
 
   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 = "2013-11-15"
+  s.date = "2014-11-24"
   s.description = "Annotate Sequel models"
   s.email = "kenny@kennymeyer.net"
   s.executables = ["annotate"]
@@ -38,35 +40,37 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/kennym/annotate-sequel"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.6"
+  s.rubygems_version = "2.2.2"
   s.summary = "Annotate Sequel models"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sequel>, ["~> 3"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<sequel>, ["<= 5", ">= 3"])
+      s.add_runtime_dependency(%q<terminal-table>, ["~> 1.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
     else
-      s.add_dependency(%q<sequel>, ["~> 3"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<sequel>, ["<= 5", ">= 3"])
+      s.add_dependency(%q<terminal-table>, ["~> 1.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+      s.add_dependency(%q<rdoc>, ["~> 4.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.5"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
     end
   else
-    s.add_dependency(%q<sequel>, ["~> 3"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<sequel>, ["<= 5", ">= 3"])
+    s.add_dependency(%q<terminal-table>, ["~> 1.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3"])
+    s.add_dependency(%q<rdoc>, ["~> 4.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.5"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
   end
 end
 

data/lib/annotate_sequel/model.rb

@@ -1,6 +1,9 @@
+require 'sequel'
+require 'terminal-table'
+
+Sequel.extension :inflector
+
 class AnnotateSequel
-  COMPAT_PREFIX    = "== Schema Info"
-  PATTERN          = /^\n?# (?:#{COMPAT_PREFIX}).*?\n(#.*\n)*\n*/
   module Model
     class << self
       def model_dir
@@ -12,17 +15,40 @@ class AnnotateSequel
       end
 
       def schema_info(klass)
+        fks = process_fks(klass)
+
+        table = Terminal::Table.new
+        table.title = klass.table_name
+        table.headings = ["Column", "Ruby Type", "DB Type", "Default", "Null?", "PK?", "FK?"]
+
+        table.rows = klass.db_schema.map do |key, value|
+          [ key,
+            value[:type],
+            value[:db_type],
+            value[:ruby_default] || '-',
+            value[:allow_null]  ? 'Y' : 'N',
+            value[:primary_key] ? 'Y' : 'N',
+            fks.include?(key)   ? 'Y' : 'N'
+          ]
+        end
 
-        info = "# Schema Info\n"
-        info << "# \n"
-        info << "# Table name: #{klass.table_name}\n"
-        info << "# \n"
-
-        klass.db_schema.each do |key, value|
-          type = value.delete(:type)
-          info << "#  #{key} :#{type}, #{value}\n"
+        # Align to the center the columns:
+        # Default, Null?, PK? and FK?
+        for i in 3..6
+          table.align_column(i, :center)
         end
-        info << "# \n"
+
+        # Comment the table
+        output = String.new
+        table.to_s.each_line { |line| output << "# #{line}" }
+
+        output << "\n\n"
+      end
+
+      def process_fks(model)
+        model.db.foreign_key_list(model.table_name).map do |x|
+          x[:columns]
+        end.flatten
       end
 
       def get_model_files
@@ -51,16 +77,14 @@ class AnnotateSequel
             c.ancestors.respond_to?(:include?) and
             c.ancestors.include?(Sequel::Model)
           end.
-          detect { |c| underscore(c.name) == model_path }
+          detect { |c| c.name && c.name.demodulize.underscore == model_path }
       end
 
       def annotate_model_file(annotated, file)
         begin
           klass = get_model_class(file)
-          if klass && klass < Sequel::Model
-            if annotate(klass, file)
-              annotated << klass
-            end
+          if klass && annotate(klass, file)
+            annotated << klass.to_s.demodulize
           end
         rescue Exception => e
           puts "Unable to annotate #{file}: #{e.message}"
@@ -70,63 +94,41 @@ class AnnotateSequel
 
       def do_annotations
         annotated = []
+
         get_model_files.each do |file|
           annotate_model_file(annotated, file)
         end
-        if annotated.empty?
-          puts "Nothing annotated"
-        else
-          puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
-        end
+
+        puts annotated.empty? ?
+          "Nothing annotated" :
+          "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
 
       def annotate_one_file(file_name, info_block)
         if File.exist?(file_name)
-          old_content = File.read(file_name)
+          current = File.read(file_name)
+          pattern = /^#\s[\+\|].+[\+\|]\n*/
 
-          header_pattern = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?)/
-          old_header = old_content.match(header_pattern).to_s
-          new_header = info_block.match(header_pattern).to_s
+          return false if current.scan(pattern).join == info_block
 
-          column_pattern = /^#[\t ]+\w+[\t ]+.+$/
-          old_columns = old_header && old_header.scan(column_pattern).sort
-          new_columns = new_header && new_header.scan(column_pattern).sort
-          if old_columns == new_columns
-            return false
+          File.open(file_name, "wb") do |f|
+            f.puts info_block + current.gsub(pattern, '')
           end
 
-          old_content.sub!(PATTERN, '')
-          new_content = info_block + "\n" + old_content
-
-          File.open(file_name, "wb") { |f| f.puts new_content }
-          return true
+          true
         else
-          return false
+          false
         end
       end
 
       def annotate(klass, file)
         begin
-          info = schema_info(klass)
-          did_annotate = false
           model_file_name = File.join(model_dir, file)
-          
-          if annotate_one_file(model_file_name, info)
-            did_annotate = true
-          end
-
-          return did_annotate
+          annotate_one_file model_file_name, schema_info(klass)
         rescue Exception => e
           puts "Unable to annotate #{file}: #{e.message}"
         end
       end
-
-      private
-
-      def underscore(word)
-        word.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
-      end
     end
   end
 end

data/lib/annotate_sequel/version.rb

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

data/spec/annotate_sequel/model_spec.rb

@@ -2,12 +2,17 @@ require 'spec_helper'
 
 describe AnnotateSequel::Model do
   describe ".schema_info(klass)" do
-    before(:each) do
+    before(:all) do
       @DB = Sequel.sqlite
       @DB.create_table :items do
         primary_key :id
-        String :name
-        Float :price
+        foreign_key :category_id, :categories, null: false
+        foreign_key [:manufacturer_name, :manufacturer_location], :manufacturers
+
+        String :manufacturer_name, size: 50
+        String :manufacturer_location
+        String :name, default: "John"
+        Float  :price, default: 0
       end
     end
 
@@ -16,19 +21,28 @@ describe AnnotateSequel::Model do
       end
       Item
     }
+
     it "should return the model schema" do
-      AnnotateSequel::Model.schema_info(klass).should eql(<<-EOS)
-# Schema Info
-# 
-# Table name: items
-# 
-#  id :integer, {:allow_null=>false, :default=>nil, :primary_key=>true, :db_type=>"integer", :ruby_default=>nil}
-#  name :string, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"varchar(255)", :ruby_default=>nil}
-#  price :float, {:allow_null=>true, :default=>nil, :primary_key=>false, :db_type=>"double precision", :ruby_default=>nil}
-# 
-EOS
+      output = <<-OUTPUT.gsub(/^\s*/, '') << "\n"
+      # +-----------------------+-----------+------------------+---------+-------+-----+-----+
+      # |                                       items                                        |
+      # +-----------------------+-----------+------------------+---------+-------+-----+-----+
+      # | Column                | Ruby Type | DB Type          | Default | Null? | PK? | FK? |
+      # +-----------------------+-----------+------------------+---------+-------+-----+-----+
+      # | id                    | integer   | integer          |    -    |   N   |  Y  |  N  |
+      # | category_id           | integer   | integer          |    -    |   N   |  N  |  Y  |
+      # | manufacturer_name     | string    | varchar(50)      |    -    |   Y   |  N  |  Y  |
+      # | manufacturer_location | string    | varchar(255)     |    -    |   Y   |  N  |  Y  |
+      # | name                  | string    | varchar(255)     |  John   |   Y   |  N  |  N  |
+      # | price                 | float     | double precision |   0.0   |   Y   |  N  |  N  |
+      # +-----------------------+-----------+------------------+---------+-------+-----+-----+
+      OUTPUT
+
+      AnnotateSequel::Model.schema_info(klass).should eq output
     end
 
-    it "should support indexes"
+    it "should support indexes" do
+      pending
+    end
   end
 end

metadata

@@ -1,99 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: annotate-sequel
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Kenny Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Annotate Sequel models
 email: kenny@kennymeyer.net
 executables:
@@ -103,8 +123,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
-- .document
-- .rspec
+- ".document"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -130,17 +150,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Annotate Sequel models