schemadoc 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8be2a5b6a3d0335eb86a1abd2093775456b169da
-  data.tar.gz: 9ba48b2c07fff20c4656cba60ff81110e5e6d298
+  metadata.gz: f06e6c98d47ee913781b80f3c648d29fbb5a773b
+  data.tar.gz: 491654a1965027fbb7505b76156c51cb32943e66
 SHA512:
-  metadata.gz: 026db4ef5fe8f33185e224e54e3a965ed9d9a36ff5ffe6b1a872c7f61b458169d2f4a2850aef79e886970b9d5e97c1d528b4cd3cebdefd3c5c569c4d1b3badf4
-  data.tar.gz: 39f6197348498ed3a7128570b2fd4c9637b1eab005058204df47e8e1d26dcd1f12197f92056beb415bb9f92e8f65420e0c701b836a9a5572e0beeaf8bea5fa27
+  metadata.gz: 2620d6fff436224317dbd625c80780236dac30e5a9a451ba05d536687716e267d5aad198a18272189a01e32cee553fa1eb2afaf7fa52fe92a9f8ef39e0f12bea
+  data.tar.gz: ff27127fa5f0e0f7347ce9da1f292db9fbc146b337f6ab57de7d4011ae46156bd0b312a5a68a81d1a59cbd15ad611b9b4175a97b1417b3191d0b0a2a30418803

data/Manifest.txt

@@ -2,5 +2,10 @@ HISTORY.md
 Manifest.txt
 README.md
 Rakefile
+bin/schemadoc
 lib/schemadoc.rb
+lib/schemadoc/cli/opts.rb
+lib/schemadoc/cli/runner.rb
 lib/schemadoc/version.rb
+lib/schemadoc/worker.rb
+test/config/football.yml

data/Rakefile

@@ -17,6 +17,11 @@ Hoe.spec 'schemadoc' do
   self.readme_file  = 'README.md'
   self.history_file = 'HISTORY.md'
 
+  self.extra_deps = [
+    ['logutils'],
+    ['fetcher']
+  ]
+
   self.licenses = ['Public Domain']
 
   self.spec_extras = {

data/bin/schemadoc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/schemadoc
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/schemadoc
+#
+
+require 'schemadoc'
+
+SchemaDoc.main
+

data/lib/schemadoc/cli/opts.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+
+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
+
+    def output_path
+      @output_path || '.'
+    end
+
+  end # class Opts
+
+end  # module SchemaDoc

data/lib/schemadoc/cli/runner.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+
+# more core and stlibs
+
+require 'optparse'
+
+# our own code (for command line interface/cli)
+
+require 'schemadoc/cli/opts'
+
+
+module SchemaDoc
+
+  class Runner
+
+    include LogUtils::Logging
+
+    attr_reader :opts
+        
+    def initialize
+      @opts = Opts.new
+    end
+    
+    def run( args )
+      opt=OptionParser.new do |cmd|
+
+        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
+
+        # todo: find different letter for debug trace switch (use v for version?)
+        cmd.on( '-v', '--verbose', 'Show debug trace' )  do
+           logger = LogUtils::Logger.root
+           logger.level = :debug
+        end
+
+      usage =<<EOS
+ 
+schemadoc #{VERSION} - Lets you document your database tables, columns, etc.
+
+#{cmd.help}
+
+Examples:
+  schemadoc
+  schemadoc -f football.yml
+
+Further information:
+  https://github.com/rubylibs/schemadoc
+
+EOS
+
+        ## todo: also add -?  if possible as alternative
+        cmd.on_tail( '-h', '--help', 'Show this message' ) do
+           puts usage
+           exit
+        end
+      end
+
+      opt.parse!( args )
+  
+      puts SchemaDoc.banner
+
+      config = YAML.load_file( "#{opts.config_path}/#{opts.config_name}" )
+      pp config 
+
+      worker = Worker.new( config ).run()
+
+      puts 'Done.'
+
+    end   # method run
+    
+  end # class Runner
+
+end  # module SchemaDoc
+

data/lib/schemadoc/version.rb

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

data/lib/schemadoc/worker.rb

@@ -0,0 +1,180 @@
+# encoding: utf-8
+
+###
+# generate
+#  json
+#   for schema doc
+#  (see simple datasets package schema from okfn ???)
+
+
+module SchemaDoc
+
+class Worker
+
+  def initialize( config )
+    ## split into db config (for connection) and
+    ## schemadoc config
+    
+    @config    = {}
+    @db_config = {}
+
+    config.each do |k,v|
+      if k == 'database'
+        @db_config = v   # note: discard key; use hash as connection spec
+      else
+        @config[ k ] = v
+      end
+    end
+
+    puts "database connection spec:"
+    pp @db_config
+  end
+
+
+  def connect
+    @con = AbstractModel.connection_for( @db_config )
+  end
+
+  def dump_schema
+    @con.tables.sort.map do |name|
+       puts "#{name} : #{name.class.name}"
+    end
+    puts ''
+
+    @con.tables.sort.each do |name|
+      puts "#{name}"
+      puts "-" * name.size
+
+      @con.columns( name ).each do |col|
+        puts "  #{col.name} #{col.sql_type}, #{col.default}, #{col.null} : #{col.class.name}"
+      end
+      puts ''
+    end
+  end
+
+  def build_schema
+    ####
+    # build schema hash
+
+    schemas = {}
+
+    @con.tables.sort.each do |name|
+
+      t = { name: name,
+            columns: []
+          }
+      @con.columns( name ).each do |col|
+        t[:columns] << {
+           name:    col.name,
+           type:    col.sql_type,
+           default: col.default,
+           null:    col.null
+        }
+      end
+
+      schema_name = find_schema_for_table(name)
+      puts "add '#{name}' to schema '#{schema_name}'"
+
+      schema = schemas[schema_name]
+      if schema.nil?
+        # note: use schema_name from config (do NOT use key - might be different)
+        schema = { name: schema_name, tables: [] }
+        schemas[schema_name] = schema
+      end
+      schema[:tables] << t
+    end
+
+    data = { schemas: [] }
+    schemas.each do |k,v|
+      data[:schemas] << v   ## turn schemas into an array w/ name, tables, etc.
+    end
+    
+    data
+  end
+
+
+  def build_index
+    ####
+    # build symbol index hash
+
+    symbols = {}
+
+    letters = %w(A B C D E F G H I J K L M N O P Q R S T U V W X Y Z)
+
+    ## add a to z [26 entries]
+
+    letters.each do |letter|
+      symbols[letter] = {
+         name:   letter,
+         tables: [],
+         columns: []
+      }
+    end
+
+    @con.tables.sort.each do |name|
+
+      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}"
+      end
+    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.)
+    end
+
+    data
+  end
+
+
+  def run( opts={} )
+    connect()
+    dump_schema()
+
+    schema = build_schema()
+    index  = build_index()
+
+    ## pp schema
+
+    File.open( 'database.json', 'w') do |f|
+      f.write JSON.pretty_generate( schema )
+    end
+
+    File.open( 'symbols.json', 'w') do |f|
+      f.write JSON.pretty_generate( index )
+    end
+  end
+
+
+private
+
+  class AbstractModel < ActiveRecord::Base
+    self.abstract_class = true   # no table; class just used for getting db connection
+
+    def self.connection_for( key_or_spec )
+      establish_connection( key_or_spec )
+      connection
+    end
+  end  # class AbstractModel
+
+
+  def find_schema_for_table( name )
+
+    @config.each do |k,h|
+      tables = h['tables'] || []
+      if tables.include?( name )
+        return k
+      end
+    end
+
+    ## no entry found; assume default schema (e.g. first schema listed in config)
+    @config.keys.first
+  end
+
+end
+
+end # module SchemaDoc

data/lib/schemadoc.rb

@@ -1,9 +1,32 @@
 # encoding: utf-8
 
+# stdlibs
+
+require 'pp'
+require 'yaml'
+require 'json'
+
+# 3rd party gems/libs
+require 'logutils'
+require 'active_record'
+
+
 # our own code
 
 require 'schemadoc/version'  # let it always go first
+require 'schemadoc/worker'
+
+
+module SchemaDoc
+
+  def self.main
+    ## NB: only load (require) cli code if called
+    require 'schemadoc/cli/runner'
+
+    Runner.new.run( ARGV )
+  end
 
+end  # module SchemaDoc
 
 
 

data/test/config/football.yml

@@ -0,0 +1,42 @@
+###################
+# 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
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schemadoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fetcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -40,19 +68,26 @@ dependencies:
         version: '3.13'
 description: schemadoc - document your database schemas (tables, columns, etc.)
 email: opensport@googlegroups.com
-executables: []
+executables:
+- schemadoc
 extensions: []
 extra_rdoc_files:
 - HISTORY.md
 - Manifest.txt
 - README.md
 files:
+- ".gemtest"
 - HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/schemadoc
 - lib/schemadoc.rb
+- lib/schemadoc/cli/opts.rb
+- lib/schemadoc/cli/runner.rb
 - lib/schemadoc/version.rb
+- lib/schemadoc/worker.rb
+- test/config/football.yml
 homepage: https://github.com/rubylibs/schemadoc
 licenses:
 - Public Domain