schema_doc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2df6422967bcdbc49244c380b605a7b76abd6b6
+  data.tar.gz: aba70068fb2ae205f52eff346ef19744c168642b
+SHA512:
+  metadata.gz: 47fc05bed1551769753e6ef047e11ff28f3b4d978fc296aebc8c086f9cb420c1b37c215b53f0124d3aeba2853a776179c30eb05df92a16e1c1976ca424c22043
+  data.tar.gz: dee20aafd3d1ce069fdbdc1ef97d4863216dbdfab36b768cc40ea3b34d26c89774480526f3d1ce7be12dbad8640858696545fea7e58c38834f87aaffb6612b97

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+spec/db/*.sqlite3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schema_doc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mizokami
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# SchemaDoc
+
+SchemaDoc outputs database schema for your Rails applications in markdown style
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schema_doc', :github => 'mizoR/schema_doc'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```
+$ rake schema_doc:out
+```
+
+When your Rails application has following models:
+
+```ruby
+
+class User < ActiveRecord::Base
+  has_one :blog, :foreign_key => :owner_id
+end
+
+class Blog < ActiveRecord::Base
+  has_many   :entries
+  belongs_to :owner, :class_name => 'User'
+end
+
+class Entry < ActiveRecord::Base
+  belongs_to :blog
+end
+```
+
+SchemaDoc will output [THIS](https://github.com/mizoR/schema_doc/tree/master/example/sample_output.md).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/sample_output.md

@@ -0,0 +1,30 @@
+
+# blogs
+
+## Blog
+
+| name | human name | sql type | primary | default | limit |
+| ---- | ---------- | -------- | ------- | ------- | ----- |
+| id | Id | INTEGER | true |  |  |
+| name | Name | varchar(255) | false |  | 255 |
+| owner_id | Owner | integer | false |  |  |
+
+# entries
+
+## Entry
+
+| name | human name | sql type | primary | default | limit |
+| ---- | ---------- | -------- | ------- | ------- | ----- |
+| id | Id | INTEGER | true |  |  |
+| title | Title | varchar(255) | false |  | 255 |
+| body | Body | varchar(255) | false |  | 255 |
+
+# users
+
+## User
+
+| name | human name | sql type | primary | default | limit |
+| ---- | ---------- | -------- | ------- | ------- | ----- |
+| id | Id | INTEGER | true |  |  |
+| nick | Nick | varchar(255) | false |  | 255 |
+

data/lib/schema_doc/document.rb

@@ -0,0 +1,47 @@
+require 'erb'
+
+module SchemaDoc
+  class Document
+    class << self
+      def read
+        document = []
+
+        descendants_group_by_table_name.sort.each do |table_name, descendants|
+          document << template(table_name, descendants)
+        end
+
+        document.join
+      end
+
+      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
+      end
+
+      def descendants
+        ActiveRecord::Base.descendants
+      end
+
+      def descendants_group_by_table_name
+        descendants.group_by {|descendant|
+          descendant.table_name
+        }
+      end
+    end
+  end
+end
+

data/lib/schema_doc/railtie.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+module SchemaDoc
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'schema_doc/tasks.rake'
+    end
+  end
+end
+

data/lib/schema_doc/tasks.rake

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

data/lib/schema_doc/version.rb

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

data/lib/schema_doc.rb

@@ -0,0 +1,9 @@
+require "schema_doc/version"
+require "schema_doc/document"
+require "schema_doc/railtie" if defined?(Rails)
+
+module SchemaDoc
+  def self.root
+    File.expand_path('../..', __FILE__)
+  end
+end

data/schema_doc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schema_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_doc"
+  spec.version       = SchemaDoc::VERSION
+  spec.authors       = ["mizokami"]
+  spec.email         = ["suzunatsu@yahoo.com"]
+  spec.description   = %q{Output database schema in markdown style.}
+  spec.summary       = %q{Output database schema in markdown style.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", ">= 3.2.16"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/db/.gitkeep

@@ -0,0 +1 @@
+

data/spec/helper.rb

@@ -0,0 +1,67 @@
+require 'schema_doc'
+require 'active_record'
+
+dbfile = File.join(SchemaDoc.root, 'spec/db/test.sqlite3')
+
+if File.exist?(dbfile)
+  File.delete(dbfile)
+end
+
+ActiveRecord::Base.establish_connection(
+  'adapter'  => 'sqlite3',
+  'database' => dbfile
+)
+
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :nick
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+
+class CreateBlogs < ActiveRecord::Migration
+  def self.up
+    create_table :blogs do |t|
+      t.string  :name
+      t.integer :owner_id
+    end
+  end
+
+  def self.down
+    drop_table :blogs
+  end
+end
+
+class CreateEntries < ActiveRecord::Migration
+  def self.up
+    create_table :entries do|t|
+      t.string  :title
+      t.string  :body
+    end
+  end
+
+  def self.down
+    drop_table :entries
+  end
+end
+
+[CreateUsers, CreateBlogs, CreateEntries].map(&:new).each(&:up)
+
+class User < ActiveRecord::Base
+  has_one :blog, :foreign_key => :owner_id
+end
+
+class Blog < ActiveRecord::Base
+  has_many   :entries
+  belongs_to :owner, :class_name => 'User'
+end
+
+class Entry < ActiveRecord::Base
+  belongs_to :blog
+end
+

data/spec/schema_doc/document_spec.rb

@@ -0,0 +1,44 @@
+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)
+    end
+
+    context 'When table is "users"' do
+      let :args do
+        ['users', [User]]
+      end
+
+      it 'matches table name' do
+        expect(template).to match(/^# #{args[0]}$/)
+      end
+
+      it 'matches model name' do
+        args[1].each do |model|
+          expect(template).to match(/^## #{model.to_s}$/)
+        end
+      end
+
+      it 'matches header ' do
+        expect(template).to match(/^| name | human name | sql type | primary | default | limit |$/)
+      end
+
+      it 'matches separator ' do
+        expect(template).to match(/^| ---- | ---------- | -------- | ------- | ------- | ----- |$/)
+      end
+
+      it 'matches some columns ' do
+        args[1].each do |model|
+          model.columns.each do |column|
+            expect(template).to match(/^| #{column.name} | /)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/schema_doc_spec.rb

@@ -0,0 +1 @@
+require 'helper'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: schema_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mizokami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 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.
+email:
+- suzunatsu@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/sample_output.md
+- lib/schema_doc.rb
+- lib/schema_doc/document.rb
+- lib/schema_doc/railtie.rb
+- lib/schema_doc/tasks.rake
+- lib/schema_doc/version.rb
+- schema_doc.gemspec
+- spec/db/.gitkeep
+- spec/helper.rb
+- spec/schema_doc/document_spec.rb
+- spec/schema_doc_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Output database schema in markdown style.
+test_files:
+- spec/db/.gitkeep
+- spec/helper.rb
+- spec/schema_doc/document_spec.rb
+- spec/schema_doc_spec.rb