model_schema 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f90013060ee4c6589d5da0f52a6d43d122f1098
-  data.tar.gz: e6a196f114bfdfb96f360404cdb7e3b318f43545
+  metadata.gz: ce3974d23c633c3c0b29f1d6021698608f864181
+  data.tar.gz: 8cdf340a4c88a594b67c50bd8a54086ae73ea97b
 SHA512:
-  metadata.gz: 40b269d838239123dad028eb77512fac7299ed248b249daa567243a38c99e64e13d9b465b5eaf97ea8b7f02d8820be1b52b388b48ea0e5de2834ebac6d9d9148
-  data.tar.gz: e2d6ffe9929ea0940a7c2e94a29fa47747feb8c03749c8ac49c1385d6f66ffd00044f510d2e98fda5072e5d3d4758c42a8ebfb93abd019f9b4bfaf5e54e7891a
+  metadata.gz: 820a8b272b36b86dade6aa32423b8b1842478e34ec63cfd43b4c97a507cd3ca8e0cbb3d3a276e04607c3792692c42894bf9084f11865207980173b186f1e1e96
+  data.tar.gz: e77ba585c336618e522a56159b7da45d03b69877b63a5b9ce61037e595f664040e7d7e0f03eeef72873a472029e4033b95dbce4972e89087581e186fff19b370

data/README.md

@@ -1,7 +1,7 @@
 # ModelSchema [![Build Status](https://travis-ci.org/karthikv/model_schema.svg?branch=master)](https://travis-ci.org/karthikv/model_schema)
 ModelSchema lets you annotate a [Sequel](https://github.com/jeremyevans/sequel/)
-Model with its expected schema (columns and indexes). Instead of seeing
-a Sequel Model file that looks like this:
+Model with its expected schema and immediately identify inconsistencies.
+Instead of seeing a Sequel Model file that looks like this:
 
 ```rb
 class User < Sequel::Model(:users)

data/Rakefile

@@ -1,9 +1,9 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 

data/bin/dump_model_schema

@@ -1,121 +1,5 @@
 #!/usr/bin/env ruby
 require 'bundler/setup'
 require 'model_schema'
-require 'slop'
 
-SEQUEL_MODEL_REGEX = /class\s+.*?<\s+Sequel::Model\((.*?)\)/
-LEADING_WHITESPACE_REGEX = /^\s*/
-
-# Parses options and then dumps the model schema.
-def main(args)
-  opts = {}
-  opts[:tabbing] = 2
-
-  parser = OptionParser.new do |p|
-    p.banner = "Usage: dump_model_schema [options]"
-
-    p.on('-m', '--model MODEL', 'Model file to dump schema in') do |model|
-      opts[:model] = model
-    end
-
-    p.on('-c', '--connection CONNECTION',
-         'Connection string for database') do |connection|
-      opts[:connection] = connection
-    end
-
-    p.on('-t', '--tabbing TABBING', Integer,
-              'Number of spaces for tabbing, or 0 for hard tabs') do |tabbing|
-      opts[:tabbing] = tabbing
-    end
-
-    p.on('-v', '--version', 'Print version') do
-      puts ModelSchema::VERSION
-      exit
-    end
-
-    p.on('-h', '--help', 'Print help') do
-      puts parser
-      exit
-    end
-  end
-
-  parser.parse(args)
-
-  # model and connection are required
-  abort 'Must provide a model file with -m or --model.' if !opts[:model]
-  abort 'Must provide a connection string with -c or --connection.' if !opts[:connection]
-
-  dump_model_schema(opts)
-end
-
-# Dumps the model schema based on the given options (see option parsing above).
-def dump_model_schema(opts)
-  model_info = parse_model_file(opts[:model])
-  abort "Couldn't find class that extends Sequel::Model" if !model_info
-
-  db = Sequel.connect(opts[:connection])
-  db.extension(:schema_dumper)
-
-  klass = Class.new(Sequel::Model(model_info[:table_name]))
-  klass.db = db
-
-  # dump table generator given by model_schema
-  generator = klass.send(:table_generator)
-  commands = [generator.dump_columns, generator.dump_constraints,
-              generator.dump_indexes].reject{|s| s == ''}.join("\n\n")
-
-  # account for indentation
-  tab = opts[:tabbing] == 0 ? "\t" : ' ' * opts[:tabbing]
-  schema_indentation = model_info[:indentation] + tab
-  command_indentation = schema_indentation + tab
-
-  commands = commands.lines.map {|l| l == "\n" ? l : command_indentation + l}.join
-  commands = commands.gsub('=>', ' => ')
-
-  dump_lines = ["#{schema_indentation}model_schema do\n",
-                "#{commands}\n",
-                "#{schema_indentation}end\n"]
-
-  lines = model_info[:lines_before] + dump_lines + model_info[:lines_after]
-  File.write(opts[:model], lines.join)
-end
-
-# Parses the model file at the given path, returning a hash of the form:
-#
-# :table_name => the model table name
-# :lines_before => an array of lines before the expected model schema dump
-# :lines_after => an array of lines after the expected model schema dump
-# :indentation => the indentation (leading whitespace) of the model class
-#
-# Returns nil if the file couldn't be parsed.
-def parse_model_file(path)
-  lines = File.read(path).lines
-
-  lines.each_with_index do |line, index|
-    match = SEQUEL_MODEL_REGEX.match(line)
-
-    if match
-      # extract table name as symbol
-      table_name = match[1]
-      if table_name[0] == ':'
-        table_name = table_name[1..-1].to_sym
-      else
-        abort "Can't find a symbol table name on line: #{line}"
-      end
-
-      # indentation for model_schema block
-      indentation = LEADING_WHITESPACE_REGEX.match(line)[0]
-
-      return {
-        :table_name => table_name.to_sym,
-        :lines_before => lines[0..index],
-        :lines_after => lines[(index + 1)..-1],
-        :indentation => indentation,
-      }
-    end
-  end
-
-  nil
-end
-
-main(ARGV) if $PROGRAM_NAME == __FILE__
+ModelSchema::Dumper.run(ARGV)

data/lib/model_schema.rb

@@ -4,3 +4,4 @@ require 'model_schema/version'
 require 'model_schema/constants'
 require 'model_schema/schema_error'
 require 'model_schema/plugin'
+require 'model_schema/dumper'

data/lib/model_schema/dumper.rb

@@ -0,0 +1,120 @@
+require 'optparse'
+
+SEQUEL_MODEL_REGEX = /class\s+.*?<\s+Sequel::Model\((.*?)\)/
+LEADING_WHITESPACE_REGEX = /^\s*/
+
+module ModelSchema
+  module Dumper
+    # Parses options and then dumps the model schema.
+    def self.run(args)
+      opts = {}
+      opts[:tabbing] = 2
+
+      parser = OptionParser.new do |p|
+        p.banner = "Usage: dump_model_schema [options]"
+
+        p.on('-m', '--model MODEL', 'Model file to dump schema in') do |model|
+          opts[:model] = model
+        end
+
+        p.on('-c', '--connection CONNECTION',
+             'Connection string for database') do |connection|
+          opts[:connection] = connection
+        end
+
+        p.on('-t', '--tabbing TABBING', Integer,
+                  'Number of spaces for tabbing, or 0 for hard tabs') do |tabbing|
+          opts[:tabbing] = tabbing
+        end
+
+        p.on('-v', '--version', 'Print version') do
+          puts ModelSchema::VERSION
+          exit
+        end
+
+        p.on('-h', '--help', 'Print help') do
+          puts parser
+          exit
+        end
+      end
+
+      parser.parse(args)
+
+      # model and connection are required
+      abort 'Must provide a model file with -m or --model.' if !opts[:model]
+      abort 'Must provide a connection string with -c or --connection.' if !opts[:connection]
+
+      dump_model_schema(opts)
+    end
+
+    # Dumps the model schema based on the given options (see option parsing above).
+    def self.dump_model_schema(opts)
+      model_info = parse_model_file(opts[:model])
+      abort "Couldn't find class that extends Sequel::Model" if !model_info
+
+      db = Sequel.connect(opts[:connection])
+      db.extension(:schema_dumper)
+
+      klass = Class.new(Sequel::Model(model_info[:table_name]))
+      klass.db = db
+
+      # dump table generator given by model_schema
+      generator = klass.send(:table_generator)
+      commands = [generator.dump_columns, generator.dump_constraints,
+                  generator.dump_indexes].reject{|s| s == ''}.join("\n\n")
+
+      # account for indentation
+      tab = opts[:tabbing] == 0 ? "\t" : ' ' * opts[:tabbing]
+      schema_indentation = model_info[:indentation] + tab
+      command_indentation = schema_indentation + tab
+
+      commands = commands.lines.map {|l| l == "\n" ? l : command_indentation + l}.join
+      commands = commands.gsub('=>', ' => ')
+
+      dump_lines = ["#{schema_indentation}model_schema do\n",
+                    "#{commands}\n",
+                    "#{schema_indentation}end\n"]
+
+      lines = model_info[:lines_before] + dump_lines + model_info[:lines_after]
+      File.write(opts[:model], lines.join)
+    end
+
+    # Parses the model file at the given path, returning a hash of the form:
+    #
+    # :table_name => the model table name
+    # :lines_before => an array of lines before the expected model schema dump
+    # :lines_after => an array of lines after the expected model schema dump
+    # :indentation => the indentation (leading whitespace) of the model class
+    #
+    # Returns nil if the file couldn't be parsed.
+    def self.parse_model_file(path)
+      lines = File.read(path).lines
+
+      lines.each_with_index do |line, index|
+        match = SEQUEL_MODEL_REGEX.match(line)
+
+        if match
+          # extract table name as symbol
+          table_name = match[1]
+          if table_name[0] == ':'
+            table_name = table_name[1..-1].to_sym
+          else
+            abort "Can't find a symbol table name on line: #{line}"
+          end
+
+          # indentation for model_schema block
+          indentation = LEADING_WHITESPACE_REGEX.match(line)[0]
+
+          return {
+            :table_name => table_name.to_sym,
+            :lines_before => lines[0..index],
+            :lines_after => lines[(index + 1)..-1],
+            :indentation => indentation,
+          }
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/model_schema/version.rb

@@ -1,3 +1,3 @@
 module ModelSchema
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Karthik Viswanathan
@@ -155,6 +155,7 @@ files:
 - bin/repl
 - lib/model_schema.rb
 - lib/model_schema/constants.rb
+- lib/model_schema/dumper.rb
 - lib/model_schema/plugin.rb
 - lib/model_schema/schema_error.rb
 - lib/model_schema/version.rb