schemadoc 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f06e6c98d47ee913781b80f3c648d29fbb5a773b
-  data.tar.gz: 491654a1965027fbb7505b76156c51cb32943e66
+  metadata.gz: 13f07f4218221279bd1bba7f357b5b98f2424e8a
+  data.tar.gz: 203e0161acb77b78e3e7a48b1b76397fd4d2f4d0
 SHA512:
-  metadata.gz: 2620d6fff436224317dbd625c80780236dac30e5a9a451ba05d536687716e267d5aad198a18272189a01e32cee553fa1eb2afaf7fa52fe92a9f8ef39e0f12bea
-  data.tar.gz: ff27127fa5f0e0f7347ce9da1f292db9fbc146b337f6ab57de7d4011ae46156bd0b312a5a68a81d1a59cbd15ad611b9b4175a97b1417b3191d0b0a2a30418803
+  metadata.gz: b5e50bf3b061b3a9c6914076328e660a3ab60e41c691c9e57f479bb6a44c1b09908b9d94da7858b2f03f98be82015359753a607c03f21ee2fccd4fef863953cc
+  data.tar.gz: aeee53a2ac4e8a0f8ea9d9bc624bef5bc6e1e6afa267b5b2b2385169f5bf3d084aafd64eb04ebd0efb2c6819631f332e2e3c7ae4502d9085c84349e0307b1d67

data/Manifest.txt

@@ -8,4 +8,5 @@ lib/schemadoc/cli/opts.rb
 lib/schemadoc/cli/runner.rb
 lib/schemadoc/version.rb
 lib/schemadoc/worker.rb
+test/config/beer.yml
 test/config/football.yml

data/README.md

@@ -8,9 +8,127 @@ schemadoc gem - document your database schemas (tables, columns, etc.)
 * rdoc  :: [rubydoc.info/gems/schemadoc](http://rubydoc.info/gems/schemadoc)
 
 
-## Usage
+## Usage Command Line
 
-To be done
+The `schemadoc` gem includes a command line tool
+named - surprise, surprise - `schemadoc`. Try:
+
+~~~
+$ schemadoc --help
+~~~
+
+resulting in:
+
+~~~
+schemadoc 1.0.0 - Lets you document your database tables, columns, etc.
+
+Usage: schemadoc [options]
+    -o, --output PATH            Output path (default is '.')
+    -v, --verbose                Show debug trace
+
+Examples:
+  schemadoc                # defaults to ./schemadoc.yml
+  schemadoc football.yml
+~~~
+
+
+## Configuration
+
+The `schemadoc` command line tool
+requires a configuration file (defaults to `./schemadoc.yml` if not
+passed along).
+
+**Database Connection Settings - `database` Section**
+
+Use the `database` section to configure you database connection settings.
+Example:
+
+~~~
+database:
+  adapter:  sqlite3
+  database: ./football.db
+~~~
+
+**Schema Sections**
+
+All other sections are interpreted as database schemas.
+The first section is the "default" schema,
+that is, all tables not listed in other schemas will get auto-added
+to the "default" schema.
+
+
+**Example - `schemadoc.yml`**
+
+~~~
+## connection spec
+
+database:
+  adapter:  sqlite3
+  database: ./football.db
+
+
+## main tables
+
+football:
+  name: Football
+
+
+## world tables
+
+world:
+  name: World
+  tables:
+    - continents
+    - countries
+    - regions
+    - cities
+    - places
+    - names
+    - langs
+    - usages
+
+## support tables
+
+support:
+  name: Support
+  tables:
+    - logs
+    - props
+    - tags
+    - taggings
+~~~
+
+
+
+## Outputs
+
+The `schemadoc` tool writes out two json files:
+
+- `database.json`  - includes all schemas, tables, columns, etc.
+- `symbols.json`   - includes all symbols from a to z
+
+
+## Reports 'n' Templates
+
+To generate web pages from you json files use a static site generator and
+a template pack (theme). For example, to use the `book-templates/schema` theme
+copy your json files in the `_data/` folder and rebuild the site (e.g. $ `jekyll build`).
+That's it. Enjoy your database schema docu. 
+
+
+
+## Install
+
+Just install the gem:
+
+~~~
+$ gem install schemadoc
+~~~
+
+
+## Free Schemadoc Template Packs / Themes
+
+- [`book-templates/schema`](https://github.com/book-templates/schema) - free schemadoc theme; works w/ Jekyll (and GitHub Pages) static site generator
 
 
 ## License

data/lib/schemadoc/cli/opts.rb

@@ -5,23 +5,6 @@ module SchemaDoc
 
   class Opts
 
-    def config_name=(value)
-      @config_name = value
-    end
-
-    def config_name
-      @config_name || 'schemadoc.yml'
-    end
-
-    def config_path=(value)
-      @config_path = value
-    end
-
-    def config_path
-      @config_path || '.'
-    end
-
-
     def output_path=( value )
       @output_path = value
     end
@@ -33,3 +16,4 @@ module SchemaDoc
   end # class Opts
 
 end  # module SchemaDoc
+

data/lib/schemadoc/cli/runner.rb

@@ -27,16 +27,6 @@ module SchemaDoc
 
         cmd.banner = "Usage: schemadoc [options]"
 
-        ### use -c and --config / why? why not??
-        ### use -n and --name   / why? why not??
-
-        cmd.on( '-f', '--file NAME', "Configuration name (default is '#{opts.config_name}')" ) do |s|
-          opts.config_name = s
-        end
-        cmd.on( '-d', '--dir PATH', "Configuration path (default is '#{opts.config_path}')" ) do |s|
-          opts.config_path = s
-        end
-
         cmd.on( '-o', '--output PATH', "Output path (default is '#{opts.output_path}')" ) do |s|
           opts.output_path = s
         end
@@ -73,10 +63,11 @@ EOS
   
       puts SchemaDoc.banner
 
-      config = YAML.load_file( "#{opts.config_path}/#{opts.config_name}" )
+      arg = args[0] || './schemadoc.yml'
+      config = YAML.load_file( arg )
       pp config 
 
-      worker = Worker.new( config ).run()
+      worker = Worker.new( config ).run
 
       puts 'Done.'
 

data/lib/schemadoc/version.rb

@@ -2,8 +2,8 @@
 
 module SchemaDoc
 
-  MAJOR = 0
-  MINOR = 1
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -23,4 +23,3 @@ end  # module SchemaDoc
 
 Schemadoc = SchemaDoc  # add alias for all lower-case
 
-

data/lib/schemadoc/worker.rb

@@ -66,7 +66,7 @@ class Worker
       @con.columns( name ).each do |col|
         t[:columns] << {
            name:    col.name,
-           type:    col.sql_type,
+           type:    col.sql_type.downcase,   # note: use integer (instead of INTEGER)
            default: col.default,
            null:    col.null
         }
@@ -115,13 +115,30 @@ class Worker
 
       table_key  = name[0].upcase
       symbols[table_key][:tables] << name
-  
+
       @con.columns( name ).each do |col|
         col_key = col.name[0].upcase
-        symbols[col_key][:columns] << "#{col.name} in #{name}"
+        cols_ary = symbols[col_key][:columns]
+
+        ## search for column name
+        col_hash = cols_ary.find { |item| item[:name] == col.name }
+        if col_hash.nil?
+          col_hash = { name: col.name, tables: [] }
+          cols_ary << col_hash
+        end
+
+        col_hash[:tables] << name  
       end
     end
 
+    ## sort tables, cols and (in tables)
+    symbols.each do |k,h|
+      h[:tables] = h[:tables].sort
+
+      h[:columns] = h[:columns].sort { |l,r| l[:name] <=> r[:name] }
+      h[:columns].each { |col| col[:tables] = col[:tables].sort }
+    end
+
     data = []
     symbols.each do |k,v|
       data << v     # turn data json into an array of letters (ever letter is a hash w/ name,tables,columns,etc.)

data/test/config/beer.yml

@@ -0,0 +1,43 @@
+###################
+# connection spec
+
+database:
+  adapter:  sqlite3
+  database: ./beer.db
+
+
+###############
+# main tables
+
+beer:
+  name: Beer
+
+
+############
+# world tables
+
+world:
+  name: World
+  tables:
+    - continents
+    - countries
+    - regions
+    - cities
+    - places
+    - names
+    - langs
+    - usages
+    - country_codes
+
+##########
+# support tables
+
+support:
+  name: Support
+  tables:
+    - logs
+    - props
+    - tags
+    - taggings
+
+

data/test/config/football.yml

@@ -27,6 +27,7 @@ world:
     - names
     - langs
     - usages
+    - country_codes
 
 ##########
 # support tables

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemadoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -87,6 +87,7 @@ files:
 - lib/schemadoc/cli/runner.rb
 - lib/schemadoc/version.rb
 - lib/schemadoc/worker.rb
+- test/config/beer.yml
 - test/config/football.yml
 homepage: https://github.com/rubylibs/schemadoc
 licenses: