schemadoc 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cb6784e134252acacb2dd68891aca5dba7edcaf
-  data.tar.gz: c8ff27fa4cae9bd3bcf56f6630ff8a6c2ff0ce72
+  metadata.gz: 4cacde4f0b3b4f232bd4f0550af241286b658e89
+  data.tar.gz: 22f4a46c61f170f65bbc34caf94c825f3018c5d7
 SHA512:
-  metadata.gz: 5c5b67fc7dc6e00ce69ecda54fe0a0619ebd0274fd8b16a3fdfc5c8abbfa737ad3a300086d3deba9eacc3bfd4b8a68fe5162457332a6748c6d70208564adc3c3
-  data.tar.gz: 9b4b0d83a6ea9fe82a5cbe2d37d187509d6a31c186b0038433657560c16342c169102f7cdfa3c5655a91648bdbfa23cdb729bcc30af19018cf45a4d1181f18ed
+  metadata.gz: 933310973794c021b4351996d879e37b599991dbf510124102fe0cf745fd91eddd0673d4ea1af270e8da706676f98a4f791aac9ec4375a2979c47656322ca7db
+  data.tar.gz: a33e66989fc88c0d4e17e6cb8e500b96c850e882fe951aff1d77bf4fa3952e0d203f15449506425f8fdabbadb715559684545cb80c0637f011377bf3d76df65f

data/Manifest.txt

@@ -8,5 +8,11 @@ lib/schemadoc/cli/opts.rb
 lib/schemadoc/cli/runner.rb
 lib/schemadoc/version.rb
 lib/schemadoc/worker.rb
+test/config/beer.rb
 test/config/beer.yml
+test/config/beer.yuml
+test/config/feed.yuml
 test/config/football.yml
+test/config/football.yuml
+test/config/pluto.yuml
+test/config/world.yuml

data/lib/schemadoc/cli/runner.rb

@@ -65,9 +65,30 @@ EOS
 
       arg = args[0] || './schemadoc.yml'
       config = YAML.load_file( arg )
-      pp config 
+      pp config
+
+      ## check for .rb file w/ same name but .rb extension
+      ##  require/load if present
+      boot_path = arg.sub( '.yml', '.rb' )
+      if File.exists?( boot_path )
+        puts "try to boot (load) '#{boot_path}'..."
+
+        ## note: for now always add ./ current workdir
+        ##   fix - check if path is absolute; if not only add ./ current if not absolute
+        require "./#{boot_path}"
+        puts 'ok'
+      end
+
+      if defined?(MODELS)
+        models = MODELS
+        models.each do |model|         # double check model classes if present (loaded)
+          puts "#{model.name}... ok"
+        end
+      else
+        models = []
+      end
 
-      worker = Worker.new( config ).run
+      worker = Worker.new( config, models ).run
 
       puts 'Done.'
 

data/lib/schemadoc/version.rb

@@ -3,8 +3,8 @@
 module SchemaDoc
 
   MAJOR = 1
-  MINOR = 0
-  PATCH = 2
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/schemadoc/worker.rb

@@ -11,10 +11,10 @@ module SchemaDoc
 
 class Worker
 
-  def initialize( config )
+  def initialize( config, models=[] )
     ## split into db config (for connection) and
     ## schemadoc config
-    
+
     @config    = {}
     @db_config = {}
 
@@ -28,11 +28,16 @@ class Worker
 
     puts "database connection spec:"
     pp @db_config
+    
+    @models = models
   end
 
 
   def connect
-    @con = AbstractModel.connection_for( @db_config )
+    ##@con = AbstractModel.connection_for( @db_config )
+
+    ActiveRecord::Base.establish_connection( @db_config )
+    @con = ActiveRecord::Base.connection
   end
 
   def dump_schema
@@ -52,6 +57,7 @@ class Worker
     end
   end
 
+
   def build_schema
     ####
     # build schema hash
@@ -93,6 +99,73 @@ class Worker
   end
 
 
+  def dump_models
+    @models.each do |model|
+      ## pp model
+
+      puts model.name
+      puts "=" * model.name.size
+      puts "  table_name: #{model.table_name}"
+      pp model.columns
+
+      ## check assocs
+      assocs = model.reflections.values
+      ## pp assocs
+      assocs.each do |assoc|
+        puts "#{assoc.macro} #{assoc.name}"
+        puts "options:"
+        pp assoc.options
+      end
+    end
+  end
+
+
+  def build_models
+    #########################
+    # build models hash
+    
+    models = []
+
+    @models.each do |model|
+
+      puts model.name
+      puts "=" * model.name.size
+
+      m = {
+        name: model.name,     ## todo: split into name and module/package name ?? 
+        table_name: model.table_name,
+        columns: [],
+        assocs: [],
+      }
+
+      model.columns.each do |column|
+        c = {
+          name:     column.name,
+          null:     column.null,
+          default:  column.default,
+          sql_type: column.sql_type,
+          cast_type: column.cast_type.class.name,
+        }
+        m[:columns] << c
+      end
+
+      ## check assocs
+      assocs = model.reflections.values
+      assocs.each do |assoc|
+        a = {
+          macro:   assoc.macro,     ## rename to rel or something - why, why not??
+          name:    assoc.name,
+          options: assoc.options    ## filter options - why, why not??
+        }
+        m[:assocs] << a
+      end
+
+      models << m
+    end # each model
+    models
+  end  # method build_models
+
+
   def build_index
     ####
     # build symbol index hash
@@ -148,9 +221,47 @@ class Worker
   end
 
 
+  def models_to_yuml( models )
+
+    ## todo: move to script !!!
+    ##   check
+    ##   how to deal w/ singular,plural,
+    ##   add to model
+    ##    singular,plural  - to keep it simple???
+    ##   use name and full_name and module ??
+    ##  e.g. BeerDb::Model::Brewery ???
+
+    buf = ''
+    models.each do |model|
+
+      assocs = model[:assocs]
+      if assocs.empty?
+        buf << "// skipping #{model[:name]}; no assocs found/n"
+        next
+      end
+
+      assocs.each do |assoc|
+        ## skip assocs w/ option through for now
+        if assoc[:options][:through]
+          buf << "// skipping assoc #{assoc[:macro]} #{assoc[:name]} w/ option through\n"
+          next
+        end
+
+        buf << "[#{model[:name]}] - [#{assoc[:name]}]\n"
+      end
+    end
+
+    buf
+  end
+
+
   def run( opts={} )
     connect()
     dump_schema()
+    dump_models()
+
+    models = build_models()
+    pp models
 
     schema = build_schema()
     index  = build_index()
@@ -161,6 +272,15 @@ class Worker
       f.write JSON.pretty_generate( schema )
     end
 
+    File.open( 'models.json', 'w') do |f|
+      f.write JSON.pretty_generate( models )
+    end
+    
+    ### fix: move to script !!!
+    File.open( 'models.yuml', 'w' ) do |f|
+      f.write models_to_yuml( models )
+    end
+
     File.open( 'symbols.json', 'w') do |f|
       f.write JSON.pretty_generate( index )
     end
@@ -169,6 +289,10 @@ class Worker
 
 private
 
+  ###
+  ## fix: not really needed - remove ???
+  ##   just use ActiveRecord::Base.establish_connection() directly ??
+
   class AbstractModel < ActiveRecord::Base
     self.abstract_class = true   # no table; class just used for getting db connection
 

data/test/config/beer.rb

@@ -0,0 +1,28 @@
+
+
+puts '[boot] hello from beer.rb'
+
+## get all beer.db models
+require 'beerdb'
+
+
+### use Schemadoc::MODELS ???
+
+## configure all models to document
+
+MODELS = [
+  BeerDb::Model::Beer,
+  BeerDb::Model::Brand,
+  BeerDb::Model::Brewery,
+
+  WorldDb::Model::Continent,
+  WorldDb::Model::Country,
+  WorldDb::Model::Region,
+  WorldDb::Model::City,
+
+  TagDb::Model::Tag,    ### check - is TaxoDb ??
+  TagDb::Model::Tagging,
+]
+
+### needs an established connection
+# pp MODELS

data/test/config/beer.yuml

@@ -0,0 +1,10 @@
+////////
+// yuml.me  model class diagram  (yuml.me/diagram/scruffy/class/draw)
+
+
+[Brewery|key;name;address;web] -> [Brand|key;name]
+[Brand]   -> [Beer|key;name;abv;og]
+[Brewery] -> [Beer]
+
+[Beer] - [note: Use tags for styles e.g. ale lager stout lambic and more {bg:wheat}]
+

data/test/config/feed.yuml

@@ -0,0 +1,6 @@
+////////
+// yuml.me  model class diagram  (yuml.me/diagram/scruffy/class/draw)
+
+
+[Feed|format;title;url;summary;updated;published;generator] -> [Item|guid;title;url;summary;content;updated;published]
+

data/test/config/football.yml

@@ -12,6 +12,7 @@ database:
 football:
   name: Football
 
+### add football stats section!!!!
 
 ############
 # world tables

data/test/config/football.yuml

@@ -0,0 +1,30 @@
+////////
+// yuml.me  model class diagram  (yuml.me/diagram/scruffy/class/draw)
+
+// note: use small size
+
+
+[Season|key;title] -> [Competition|key;title;start_at;end_at;num]
+
+[League|key;title] -> [Competition]
+
+[Competition] -> [Team|key;title;code;address;web]
+
+[Competition] -> [Round|title;start_at;end_at;num]
+
+[Competition] -> [Group|title;num]
+
+[Round] -> [Match|num;play_at;knockout;home;score1;score2;score1et;score2et;score1p;score2p;winner]
+
+[Group] -> [Match]
+
+[Team]  -> [Match]
+
+[Match] -> [Goal|minute;offset;penalty;owngoal]
+
+[Goal] <- [Player|name]
+
+[Team] -> [Squad|num;pos]
+
+[Squad] <- [Player]
+

data/test/config/pluto.yuml

@@ -0,0 +1,8 @@
+////////
+// yuml.me  model class diagram  (yuml.me/diagram/scruffy/class/draw)
+
+
+[Site|key;title;author;updated;url;fetched;]  -> [Subscription]
+[Subscription]  <-  [Feed|key;encoding;format;title;url;feed_url;generator;summary;updated;published;author;fetched]  
+[Feed] -> [Item|guid;url;title;summary;content;updated;published;fetched]
+

data/test/config/world.yuml

@@ -0,0 +1,25 @@
+
+////////
+// yuml.me  model class diagram  (yuml.me/diagram/scruffy/class/draw)
+
+////
+// Everything is a place. use inheritance w/ ^
+
+[Place|name;lat;lng;type] ^ [City Town Village]
+[Place] ^ [State Province]
+[Place] ^ [Country Territory]
+[Place] ^ [Continent]
+
+////
+// [Place] -> [Name|name;lang]
+
+///////
+
+[Continent|key;name;area;pop] -> [Country|key;name;area;pop]
+[Country] -> [State|key;name;area;pop]
+[State]   -> [City|key;name;area;pop]
+
+////
+//[Country] -> [Country Codes|name;type]
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemadoc
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -87,8 +87,14 @@ files:
 - lib/schemadoc/cli/runner.rb
 - lib/schemadoc/version.rb
 - lib/schemadoc/worker.rb
+- test/config/beer.rb
 - test/config/beer.yml
+- test/config/beer.yuml
+- test/config/feed.yuml
 - test/config/football.yml
+- test/config/football.yuml
+- test/config/pluto.yuml
+- test/config/world.yuml
 homepage: https://github.com/rubylibs/schemadoc
 licenses:
 - Public Domain