schemard 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa4682e866d21da24cbf43fcd1c94c74dffa6df2
-  data.tar.gz: e247941daad0c893a2c5563add42b628b6e6ac29
+  metadata.gz: f93b6db46593a9933c132850585b4a7e03f55de2
+  data.tar.gz: 1b7fab78d73c880a2779ff067e1207f167db3ead
 SHA512:
-  metadata.gz: '09dddcaf34c338f18c492946289f86e0c49160e1261fd5f25a2377fe4b38baffa5da676b7c72899b077ed6ccbad48bb1fd49eb61da9e8a562038a93d343a9fc1'
-  data.tar.gz: 576637694d7428d3719b4004aa02b9e273b681f0a8b2086bded99c5a4848f58e345d1fe13312c9f84a0da2acdcc2b50127f9ac1b6ee71f4ca3a07ac294e65a7e
+  metadata.gz: 0f68a074626339cb2f12d3c570fb137cab5a5812bedf176b09393eedcdd9d7dc22cd05143fd4f5c4acb841cb4f26f117bbcf118e3ea9da84b12532cfbb173d1b
+  data.tar.gz: 7277d6c3a2242440ec52e0c7601edddcc8b2db6bb59e07bac25b816b8f9c992203c662f74054d03d5145b43600ea8b97e649c6777ecff76719b498876b54bcd2

data/README.ja.md

@@ -14,7 +14,7 @@ SchemaRD は、Railsアプリケーションで利用する schema.rb を元にE
 
 実行:
 ```
- $ schemard -i <path/to/schema.rb>
+ $ schemard
 ```
 
 Webブラウザで`http://localhost:10080`にアクセスすると生成されたER図を参照できます。
@@ -24,13 +24,21 @@ Webブラウザで`http://localhost:10080`にアクセスすると生成され
 ### レイアウト調整
 
 デフォルトで生成されるER図では、テーブルは無作為にレイアウトされています。  
-図の左上の「テーブルの位置を編集」をチェックし、テーブルをドラッグすることで位置を調整することができます。
+例として、RubyOnRailsチュートリアル( https://railstutorial.jp/ )のschema.rbより生成したER図を示します。
+
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/init_layout_ja.png" width="700px" >
+
+図の左上の「テーブルの位置を編集」をチェックし、テーブルをドラッグすることでテーブルの配置場所を調整することができます。
+
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/edit_layout_ja.png" width="700px" >
+
 
 ### リレーション追加
 
 デフォルトで生成されるER図には、テーブル同士のリレーション情報がありません。  
 ER図にリレーションを追加するには、別途リレーション情報を与える必要があります。  
-リレーション情報を与える方法はいくつかありますが、ここではRailsアプリケーションのモデル情報を元にリレーション情報を追加する手順を説明します。
+
+リレーション情報を与える方法はいくつかありますが、ここではRailsアプリケーションのモデル情報を元にリレーション情報を追加する手順を説明します。先程と同様に、RubyOnRailsチュートリアルのソースコードを用いて説明します。
 
 1. 以下のコマンドでリレーション情報を抽出します。ここでは`db/relatoin.metadata`に出力します。
 ```
@@ -38,12 +46,32 @@ ER図にリレーションを追加するには、別途リレーション情報
  $ schemard gen-relation > db/relation.metadata
 ```
 
-2. 抽出したリレーション情報を読み込ませるには以下のようにオプションを指定して実行します。
+2. `db/relatoin.metadata`には以下の内容が出力されます。
 ```
- $ schemard -i <path/to/schema.rb> -f db/relation.metadata
+---
+tables:
+  users:
+    has_many:
+    - microposts
+    - relationships
+    - relationships
+  relationships:
+    belongs_to:
+    - users
+    - users
+  microposts:
+    belongs_to:
+    - users
 ```
 
-3. Webブラウザで`http://localhost:10080`にアクセスするとER図にリレーションが追加されて表示されます。
+3. 抽出したリレーション情報を読み込ませるには以下のようにオプションを指定して実行します。
+```
+ $ schemard -f db/relation.metadata
+```
+
+4. Webブラウザで`http://localhost:10080`にアクセスするとER図にリレーションが追加されて表示されます。
+
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/relation_added.png" width="700px" >
 
 ### 日本語化
 
@@ -67,10 +95,10 @@ ja:
 
 2. 以下のようにオプションで辞書ファイルを指定して実行します。
 ```
- $ schemard -i <path/to/schema.rb> -f db/relation.metadata -f config/locale/ja.yml
+ $ schemard -f db/relation.metadata -f config/locale/ja.yml
 ```
 
-3. Webブラウザで `http://localhost:10080` にアクセスするとテーブル名・カラム名が辞書に従って変換されて表示されます。
+3. Webブラウザで `http://localhost:10080` にアクセスするとテーブル名・カラム名が辞書ファイルに記述された表示名で表示されます。
 
 ## オプション
 

data/README.md

@@ -24,15 +24,23 @@ And browse `http://localhost:10080`
 ### Edit Layout
 
 In the ERD generated by default, the tables are laid out at random.  
+The figure below is the table schema which has generated from schema.rb of the Ruby On Rails Tutorial( https://www.railstutorial.org/ ).
+
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/init_layout.png" width="700px" >
+
 You can adjust the position by checking "Edit table position" at the top left of the figure,  
 And dragging the table.
 
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/edit_layout.png" width="700px" >
+
 ### Add Relation
 
 In the ERD generated by default, there is no relation information between tables.  
 To add a relation to the ERD, You need to create relation information and load it.  
-There are several ways to give a relation information.  
+There are several ways to give a relation information.
+
 This section explains how to add relation information based on model information of Rails application.
+Just as before, we will explain the procedure with the source code of Ruby On Rails Tutorial.
 
 1. Extract relation information with the following command. In this example, it outputs to `db/relatoin.metadata`.
 ```
@@ -40,17 +48,45 @@ This section explains how to add relation information based on model information
  $ schemard gen-relation > db/relation.metadata
 ```
 
-2. To load the extracted relationship information, execute with the following command option.
+2. The following contents are output to `db/relatoin.metadata`.
+```
+---
+tables:
+  users:
+    has_many:
+    - microposts
+    - relationships
+    - relationships
+  relationships:
+    belongs_to:
+    - users
+    - users
+  microposts:
+    belongs_to:
+    - users
+```
+
+3. To load the extracted relationship information, execute with the following command option.
 ```
- $ schemard -i <path/to/schema.rb> -f db/relation.metadata
+ $ schemard -f db/relation.metadata
 ```
 
-3. When accessing `http://localhost:10080` in the Web browser, relations are added to the ERD.
+4. When accessing `http://localhost:10080` in the Web browser, relations are added to the ERD.
+
+<img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/relation_added.png" width="700px" >
+
 
 ### Localization
 
 ## Options
 
+The following command line options can be specified.
+
 ### Sub Command
 
+The following sub-commands can be specified.
+
 ## Configuration
+
+Instead of specifying it with command line options, you can specify options in the configuration file.  
+Place the configuration file as `.schemard.config` in the` schemard` command execution directory. The following entries can be specified.

data/lib/schemard/metadata.rb

@@ -4,7 +4,8 @@ require_relative 'rdoc_parser'
 
 module SchemaRD
   module Metadata
-    def self.load(config:, lang:, schema:)
+    # "config", "lang", "schema" must be assigned, but ruby2.0 needs default value.
+    def self.load(config: nil, lang: "ja", schema: nil)
       metadata = Parser.new(config.output_file, *config.metadata_files).parse()
       localizer = SchemaRD::Utils::SchemaLocalizer.new(lang, metadata)
       # localized_name を設定

data/lib/schemard/schema_parser.rb

@@ -26,7 +26,8 @@ module SchemaRD
           CODE
         end
         alias_method :numeric, :decimal
-        def initialize(table, with_comment:)
+        # "with_comment" must be assigned, but ruby2.0 needs default value.
+        def initialize(table, with_comment: false)
           @table = table
           @parse_db_comment = with_comment
         end
@@ -48,7 +49,8 @@ module SchemaRD
           @table.indexes << SchemaRD::TableIndex.new(options.merge({ columns: column_name }))
         end
       end
-      def initialize(schema, with_comment:)
+      # "with_comment" must be assigned, but ruby2.0 needs default value.
+      def initialize(schema, with_comment: false)
         @schema = schema
         @parse_db_comment = with_comment
       end

data/lib/schemard.rb

@@ -2,5 +2,5 @@ require_relative 'schemard/web_server'
 require_relative 'schemard/controller'
 
 module SchemaRD
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/schemard.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   end
   spec.executables   = ["schemard"]
   spec.require_paths = ["lib"]
+  # This gem will work with 2.0 or greater...
+  spec.required_ruby_version = '>= 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.0"
   spec.add_development_dependency "rake", "~> 0.9"

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: schemard
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - ken TANAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 description: |2
@@ -48,7 +48,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.ja.md
@@ -84,17 +84,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: SchemaRD is a ERD Viewer for schema.rb.