schemard 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c5211b57dd34605e75aade506df6064eb7eed9a
-  data.tar.gz: 331ec3318e0616d80d448c69df11d2611a77dba4
+  metadata.gz: ce4c14510a96e6b9ecbeb11c07c791f6dac2d397
+  data.tar.gz: c1b1e3e296f590e8f1ad905ea5896856d3b1e210
 SHA512:
-  metadata.gz: a58160c570e363447459e1d883edd5999bf0568748ec771ea1b8d7298d3f59e96437573f161e9785799d6b1d980e1b68f07ee14fdf4e169475a6e564f20dae09
-  data.tar.gz: 384b99ab3d408844a9a73a0710d769f2dcb3014b8305cb90e1e1d471743d4ac62a95654b4245601bd9e9b1283c15bcad167bde5f56cd6149099d3761b32d9d81
+  metadata.gz: a771fa891f159f992c3076ec2424c83ac077633812b303a3dac12daf65edb928fc2960ffcdfe3ff26af04e348f6f128245e2e12dbf98b8a25733ccbbbf864217
+  data.tar.gz: 9af6e49421c170b3e1c4745347b90ce26f1e86c89b12cc02a6504ed43eff1e451ef0cee4ee25c89fc952fffd4ee5ada134606757db1bc1d01a1362364316376d

data/README.ja.md

@@ -3,7 +3,7 @@
 ## 概要
 
 SchemaRD は、Railsアプリケーションで利用する schema.rb を元にER図を生成するツールです。  
-生成されたER図は、Webブラウザで閲覧およびレイアウト調整することができます。
+生成されたER図は、Webブラウザで閲覧することができます。
 
 ## 使い方
 
@@ -28,15 +28,16 @@ Webブラウザで`http://localhost:10080`にアクセスすると生成され
 
 <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図にリレーションを追加するには、別途リレーション情報を与える必要があります。  
+ER図にリレーションを追加するには、schema.rb とは別にリレーション情報を与える必要があります。  
 
 リレーション情報を与える方法はいくつかありますが、ここではRailsアプリケーションのモデル情報を元にリレーション情報を追加する手順を説明します。先程と同様に、RubyOnRailsチュートリアルのソースコードを用いて説明します。
 
@@ -64,22 +65,22 @@ tables:
     - users
 ```
 
-3. 抽出したリレーション情報を読み込ませるには以下のようにオプションを指定して実行します。
+3. 抽出したリレーション情報を読み込ませるには以下のように -f オプションを指定して実行します。
 ```
  $ schemard -f db/relation.metadata
 ```
 
-4. Webブラウザで`http://localhost:10080`にアクセスするとER図にリレーションが追加されて表示されます。
+4. 抽出したリレーションがER図に反映されています。Webブラウザで`http://localhost:10080`にアクセスすることで確認できます。
 
 <img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/relation_added.png" width="700px" >
 
 ### 日本語化
 
 デフォルトで生成されるER図では、テーブル名・カラム名は物理名で表示されます。  
-テーブル名・カラム名を物理名以外の別名（論理名や日本語名）で表示する方法はいくつかありますが、  
-ここでは、ActiveRecordのモデル名・属性名の辞書ファイルを利用する手順を説明します。
+テーブル名・カラム名を物理名以外の別名（論理名・日本語名）で表示する方法はいくつかありますが、  
+ここでは、ActiveRecordのモデル名・属性名の翻訳辞書ファイルを利用する手順を説明します。
 
-1. 以下の形式の辞書ファイルが`config/locale/ja.yml`に存在するものとします。
+1. 以下の形式の翻訳辞書ファイルが`config/locale/ja.yml`に存在するものとします。
 ```
 ja:
   activerecord:
@@ -93,22 +94,30 @@ ja:
         <column_name>: <column_name>
 ```
 
-2. 以下のようにオプションで辞書ファイルを指定して実行します。
+2. 以下のようにオプションで翻訳辞書ファイルを指定して実行します。
 ```
  $ schemard -f db/relation.metadata -f config/locale/ja.yml
 ```
 
-3. Webブラウザで `http://localhost:10080` にアクセスするとテーブル名・カラム名が辞書ファイルに記述された表示名で表示されます。
+3. Webブラウザで `http://localhost:10080` にアクセスするとテーブル名・カラム名が翻訳辞書ファイルに記述された表示名で表示されます。
 
 ## オプション
 
 以下のコマンドラインオプションが指定可能です。
 
- * TODO
+ * -i, --input-file ... `schema.rb`ファイルを指定します。デフォルトは`db/schema.rb`です。
+ * -o, --output-file ... レイアウト情報を出力するファイルを指定します。デフォルトは`schema.metadata`です。
+ * -f, -m, --metadata-file ... リレーション情報ファイル、翻訳辞書ファイルを指定します。デフォルトは`指定なし`です。
+ * --rdoc, --rdoc-enabled ... `schema.rb`に記述しているrdocコメントからメタ情報を取得する場合に指定します。デフォルトは`指定なし`です。
+ * --parse-db-comment-as ... マイグレーション情報のcommentオプションをどのように解釈するかを指定します。`name`,`ignore`が指定できます。`name`を指定するとcommentオプションで指定された値を論理名として解釈します。`ignore`を指定するとcommentオプションの値を無視します。デフォルトは`ignore`です。
+ * -l, --log-output ... ログ出力先を指定します。`stdout`, `stderr`, `任意のファイル名`が指定できます。デフォルトは`stdout`です。
+ * -s --silent --no-log-output ... ログ出力をしたくない場合に指定します。
+ * -h, -host ... WebServerがListenするホスト名を指定します。デフォルトは`127.0.0.1`です。
+ * -p, --port ... WebServerがListenするポートを指定します。デフォルトは`10080`です。
 
 ### サブコマンド
 
-TODO
+ * generate-relations ... Railsアプリケーションのモデル情報よりリレーション情報を抽出し、YAML形式で標準出力に出力します。`-d`オプションでRails.rootディレクトリを指定することができます(デフォルトはカレントディレクトリ)。
 
 ## 設定
 
@@ -116,6 +125,13 @@ TODO
 設定ファイルは`schemard`コマンド実行ディレクトリに`.schemard.config`という名前で作成します。  
 以下のエントリを指定することができます。
 
-* TODO
+ * input_file
+ * output_file
+ * metadata_files
+ * rdoc_enabled
+ * parse_db_comment_as
+ * log_output
+ * webserver_host
+ * webserver_port
 
 なお、設定ファイルとコマンドラインオプションの両方に指定がある場合、コマンドラインオプションが優先されます。

data/README.md

@@ -28,16 +28,18 @@ The figure below is the table schema which has generated from schema.rb of the R
 
 <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,  
+To layout tables in desired position, 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" >
 
+To finish layout for tables, you check to off "Edit table position".
+
 ### 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.
+To add a relation to the ERD, You need to create relation information separately from "schema.rb",  
+and load it. 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.
@@ -66,27 +68,73 @@ tables:
     - users
 ```
 
-3. To load the extracted relationship information, execute with the following command option.
+3. To load the extracted relationship information, execute with the following `-f` command option.
 ```
  $ schemard -f db/relation.metadata
 ```
 
-4. When accessing `http://localhost:10080` in the Web browser, relations are added to the ERD.
+4. The extracted relationship information have been added to the ERD, when accessing `http://localhost:10080` in the Web browser.
 
 <img src="https://raw.githubusercontent.com/wiki/xketanaka/schemard/images/relation_added.png" width="700px" >
 
 
 ### Localization
 
+In the ERD generated by default, physical names are displayed as the table name and column name.  
+There are several ways to display aliases other than physical names as table names and column names,
+This section explains the procedure to use the translation file for ActiveRecord.
+
+1. There is a translation file placed to `config/locale/ja.yml`, and it have contents below
+```
+ja:
+  activerecord:
+    models:
+      <model_name>: <モデル名>
+
+ja:
+  activerecord:
+    attributes:
+      <model_name>:
+        <column_name>: <column_name>
+```
+
+2. Specify the translation file with the -f option and execute it as follows
+```
+ $ schemard -f db/relation.metadata -f config/locale/ja.yml
+```
+
 ## Options
 
 The following command line options can be specified.
 
+* -i, --input-file ... Specify the `schema.rb` file. The default is `db/schema.rb`.
+* -o, --output-file ... Specify the file to output layout information. The default is `schema.metadata`.
+* -f, -m, --metadata-file ... Specify the file of Relation information file, or translation file. The default is no specification.
+* --rdoc, --rdoc-enabled ... It is specified when acquiring meta-information from rdoc-format comment described in `schema.rb`. The default is no specification.
+* --parse-db-comment-as ... Specify how to interpret the comment option in the migration information. `name`,`ignore` can be specified. When `name` is specified, the value specified by the comment option is interpreted as a logical name. `ignore` ignores the value of the comment option. The default is `ignore`.
+* -l, --log-output ... Specify the log output destination. `stdout`,`stderr`, `<file name>` can be specified. The default is `stdout`.
+* -s --silent --no-log-output ... Specify this when you do not want log output.
+* -h, -host ... Specify the host name that WebServer listens on. The default is `127.0.0.1`.
+* -p, --port ... Specify the port that WebServer listens on. The default is `10080`.
+
 ### Sub Command
 
 The following sub-commands can be specified.
 
+* generate-relations ... Extract relation information from model information of Rails application and output it to standard output in YAML format. You can specify the Rails.root directory with the `-d` option (the default is the current directory).
+
 ## 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.
+
+ * input_file
+ * output_file
+ * metadata_files
+ * rdoc_enabled
+ * parse_db_comment_as
+ * log_output
+ * webserver_host
+ * webserver_port
+
+If both the setting file and the command line option are specified, the command line option takes precedence.

data/lib/schemard/relation_generator.rb

@@ -15,18 +15,24 @@ module SchemaRD
         puts "<#{rails_root}> is not Rails.root Directory, Abort!"
         puts "Usage: schemard -d <Rails.root.dir>"
       else
+        ENV["RAILS_ENV"] = "production"
         Dir.chdir(rails_root) do
           require require_path.to_s
         end
       end
     end
     def ready?
-      defined?(Rails)
+      unless defined?(Rails)
+        puts "Rails application not found."
+        return false
+      end
+      unless Rails.application.config.eager_load
+        puts "Rails.application.eager_load was set to false, abort!"
+        return false
+      end
+      true
     end
     def run
-      Dir.glob(Rails.root + "app/models/**/*")
-      .reject{|path| Dir.exist?(path) }.each{|filepath| require filepath }
-
       hash = ObjectSpace.each_object(Class)
       .select{|o| o.ancestors.include?(ActiveRecord::Base) && o != ActiveRecord::Base }
       .select{|o| o.table_name }
@@ -57,17 +63,21 @@ module SchemaRD
         has_many_rels = relation_selector.call(:has_many)
         belongs_to_rels = relation_selector.call(:belongs_to)
 
+        relations_to_table_names = ->(relations){
+          relations.map{|r| begin r.klass.table_name; rescue => e; nil; end }.compact
+        }
+
         if has_one_rels.present?
-          hash[model.table_name]["has_one"] = has_one_rels.map{|r| r.klass.table_name }
+          hash[model.table_name]["has_one"] = relations_to_table_names.call(has_one_rels)
         end
         if has_many_rels.present?
-          hash[model.table_name]["has_many"] = has_many_rels.map{|r| r.klass.table_name }
+          hash[model.table_name]["has_many"] = relations_to_table_names.call(has_many_rels)
         end
         if belongs_to_rels.present?
-          hash[model.table_name]["belongs_to"] = belongs_to_rels.map{|r| r.klass.table_name }
+          hash[model.table_name]["belongs_to"] = relations_to_table_names.call(belongs_to_rels)
         end
       end
-      puts YAML.dump({ "tables" => hash })
+      puts YAML.dump({ "tables" => hash.reject{|key,val| val.empty? } })
     end
   end
 end

data/lib/schemard.rb

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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: schemard
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ken TANAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-09-12 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: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: SchemaRD is a ERD Viewer for schema.rb.