schema_doc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2df6422967bcdbc49244c380b605a7b76abd6b6
-  data.tar.gz: aba70068fb2ae205f52eff346ef19744c168642b
+  metadata.gz: 945b668542d7ca6ce2747238aab184eebf785ef3
+  data.tar.gz: cba9b8b01be7cd9f11791d29cf22c6a2a7d23713
 SHA512:
-  metadata.gz: 47fc05bed1551769753e6ef047e11ff28f3b4d978fc296aebc8c086f9cb420c1b37c215b53f0124d3aeba2853a776179c30eb05df92a16e1c1976ca424c22043
-  data.tar.gz: dee20aafd3d1ce069fdbdc1ef97d4863216dbdfab36b768cc40ea3b34d26c89774480526f3d1ce7be12dbad8640858696545fea7e58c38834f87aaffb6612b97
+  metadata.gz: 2ac791f0e09c56b5d0274d33cc16874958b1c98c1ef7f207896580986e7234e3af19cf9bb3e6012f5af679d703fe19e0773c1b4d941605bae5ee6ad1a2cd7544
+  data.tar.gz: fb4883567774acb4311d06190e7415905c94eda1a8fa3f91743a7a604d80cad544ec0df7fd6369aa60a4d698052cd4115774f8e761ff41c2dc51d5015ff1de8b

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+  - ruby-head
+
+gemfile:
+  - Gemfile
+
+script: bundle exec rspec spec

data/README.md

@@ -1,4 +1,4 @@
-# SchemaDoc
+# SchemaDoc [![Build Status](https://secure.travis-ci.org/mizoR/schema_doc.png)](https://travis-ci.org/mizoR/schema_doc) 
 
 SchemaDoc outputs database schema for your Rails applications in markdown style
 
@@ -6,7 +6,7 @@ SchemaDoc outputs database schema for your Rails applications in markdown style
 
 Add this line to your application's Gemfile:
 
-    gem 'schema_doc', :github => 'mizoR/schema_doc'
+    gem 'schema_doc'
 
 And then execute:
 

data/example/sample_output.md

@@ -1,4 +1,3 @@
-
 # blogs
 
 ## Blog
@@ -6,9 +5,10 @@
 | name | human name | sql type | primary | default | limit |
 | ---- | ---------- | -------- | ------- | ------- | ----- |
 | id | Id | INTEGER | true |  |  |
-| name | Name | varchar(255) | false |  | 255 |
+| name | Blog Name | varchar(255) | false |  | 255 |
 | owner_id | Owner | integer | false |  |  |
 
+
 # entries
 
 ## Entry
@@ -16,8 +16,9 @@
 | name | human name | sql type | primary | default | limit |
 | ---- | ---------- | -------- | ------- | ------- | ----- |
 | id | Id | INTEGER | true |  |  |
-| title | Title | varchar(255) | false |  | 255 |
-| body | Body | varchar(255) | false |  | 255 |
+| title | Entry Title | varchar(255) | false |  | 255 |
+| body | Entry Body | varchar(255) | false |  | 255 |
+
 
 # users
 
@@ -26,5 +27,4 @@
 | name | human name | sql type | primary | default | limit |
 | ---- | ---------- | -------- | ------- | ------- | ----- |
 | id | Id | INTEGER | true |  |  |
-| nick | Nick | varchar(255) | false |  | 255 |
-
+| nick | Nickname | varchar(255) | false |  | 255 |

data/lib/schema_doc/document.rb

@@ -6,8 +6,8 @@ module SchemaDoc
       def read
         document = []
 
-        descendants_group_by_table_name.sort.each do |table_name, descendants|
-          document << template(table_name, descendants)
+        model_classes_group_by_table_name.sort.each do |table_name, model_classes|
+          document << table_document(table_name, model_classes)
         end
 
         document.join
@@ -15,30 +15,26 @@ module SchemaDoc
 
       private
 
-      def template(table_name, descendant)
-        case descendant
-        when Array
-          "# #{table_name}\n" + descendant.map {|d| template(table_name, d)}.join
-        else
-          ERB.new(<<MARKDOWN).result(binding)
-<%# coding: UTF-8 %>
-## <%= descendant %>
-
-| name | human name | sql type | primary | default | limit |
-| ---- | ---------- | -------- | ------- | ------- | ----- |
-<% descendant.columns.each do |column| %>| <%= column.name %> | <%= descendant.human_attribute_name(column.name) %> | <%= column.sql_type %> | <%= column.primary %> | <%= column.default %> | <%= column.limit %> |
-<% end %>
-MARKDOWN
-        end
+      def table_document(table_name, model_classes)
+        template_path = SchemaDoc.root + '/lib/schema_doc/templates/document_header.md.erb'
+        ERB.new(File.read(template_path)).result(binding)
+        "# #{table_name}\n" + model_classes.map { |model_class|
+          model_document(table_name, model_class)
+        }.join
+      end
+
+      def model_document(table_name, model_class)
+        template_path = SchemaDoc.root + '/lib/schema_doc/templates/document_body.md.erb'
+        ERB.new(File.read(template_path)).result(binding)
       end
 
-      def descendants
+      def model_classes
         ActiveRecord::Base.descendants
       end
 
-      def descendants_group_by_table_name
-        descendants.group_by {|descendant|
-          descendant.table_name
+      def model_classes_group_by_table_name
+        model_classes.select(&:table_exists?).group_by {|model_class|
+          model_class.table_name
         }
       end
     end

data/lib/schema_doc/tasks.rake

@@ -1,9 +1,7 @@
 namespace :schema_doc do
   task :out => :environment do
     require 'schema_doc'
-    Dir[Rails.root + 'app/models/**/*.rb'].each do |path|
-      require path
-    end
+    Rails.application.eager_load!
     puts SchemaDoc::Document.read if !Rake.application.options.silent
   end
 end

data/lib/schema_doc/templates/document_body.md.erb

@@ -0,0 +1,8 @@
+<%# coding: UTF-8 %>
+## <%= model_class %>
+
+| name | human name | sql type | primary | default | limit |
+| ---- | ---------- | -------- | ------- | ------- | ----- |
+<% model_class.columns.each do |column| %>| <%= column.name %> | <%= model_class.human_attribute_name(column.name) %> | <%= column.sql_type %> | <%= model_class.primary_key.eql?(column.name) %> | <%= column.default %> | <%= column.limit %> |
+<% end %>
+

data/lib/schema_doc/templates/document_header.md.erb

@@ -0,0 +1,2 @@
+# #{table}
+

data/lib/schema_doc/version.rb

@@ -1,3 +1,3 @@
 module SchemaDoc
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/helper.rb

@@ -2,11 +2,13 @@ require 'schema_doc'
 require 'active_record'
 
 dbfile = File.join(SchemaDoc.root, 'spec/db/test.sqlite3')
-
 if File.exist?(dbfile)
   File.delete(dbfile)
 end
 
+locales_dir = File.join(SchemaDoc.root, 'spec/locales')
+I18n.load_path << locales_dir + '/en.yml'
+
 ActiveRecord::Base.establish_connection(
   'adapter'  => 'sqlite3',
   'database' => dbfile
@@ -64,4 +66,3 @@ end
 class Entry < ActiveRecord::Base
   belongs_to :blog
 end
-

data/spec/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  activerecord:
+    attributes:
+      user:
+        nick: Nickname
+      entry:
+        title: Entry Title
+        body:  Entry Body
+      blog:
+        name: Blog Name
+

data/spec/schema_doc/document_spec.rb

@@ -1,12 +1,9 @@
 require 'helper'
 
 describe SchemaDoc::Document do
-  it do
-  puts SchemaDoc::Document.read
-  end
-  describe 'send(:template)' do
-    let :template do
-      SchemaDoc::Document.send(:template, *args)
+  describe 'send(:table_document)' do
+    let :document do
+      SchemaDoc::Document.send(:table_document, *args)
     end
 
     context 'When table is "users"' do
@@ -15,27 +12,27 @@ describe SchemaDoc::Document do
       end
 
       it 'matches table name' do
-        expect(template).to match(/^# #{args[0]}$/)
+        expect(document).to match(/^# #{args[0]}$/)
       end
 
       it 'matches model name' do
         args[1].each do |model|
-          expect(template).to match(/^## #{model.to_s}$/)
+          expect(document).to match(/^## #{model.to_s}$/)
         end
       end
 
       it 'matches header ' do
-        expect(template).to match(/^| name | human name | sql type | primary | default | limit |$/)
+        expect(document).to match(/^| name | human name | sql type | primary | default | limit |$/)
       end
 
       it 'matches separator ' do
-        expect(template).to match(/^| ---- | ---------- | -------- | ------- | ------- | ----- |$/)
+        expect(document).to match(/^| ---- | ---------- | -------- | ------- | ------- | ----- |$/)
       end
 
       it 'matches some columns ' do
         args[1].each do |model|
           model.columns.each do |column|
-            expect(template).to match(/^| #{column.name} | /)
+            expect(document).to match(/^| #{column.name} | /)
           end
         end
       end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: schema_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - mizokami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.16
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Output database schema in markdown style.
@@ -87,7 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,10 +98,13 @@ files:
 - lib/schema_doc/document.rb
 - lib/schema_doc/railtie.rb
 - lib/schema_doc/tasks.rake
+- lib/schema_doc/templates/document_body.md.erb
+- lib/schema_doc/templates/document_header.md.erb
 - lib/schema_doc/version.rb
 - schema_doc.gemspec
 - spec/db/.gitkeep
 - spec/helper.rb
+- spec/locales/en.yml
 - spec/schema_doc/document_spec.rb
 - spec/schema_doc_spec.rb
 homepage: ''
@@ -113,22 +117,23 @@ 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.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Output database schema in markdown style.
 test_files:
 - spec/db/.gitkeep
 - spec/helper.rb
+- spec/locales/en.yml
 - spec/schema_doc/document_spec.rb
 - spec/schema_doc_spec.rb