schema_to_scaffold 0.1.1 → 0.2.0

data/README.md

@@ -1,41 +1,34 @@
-Schema to Scaffold
-==================
+# Schema to Scaffold #
 
-After I cross with rake db:schema:dump I felt that it could do a litle more in my case. So here it is.
+Generate rails scaffold pages based on a rails database schema you already have.
 
-Usage
--------
+Use your schema.rb file from `<rails_app>/db` or generated with `rake db:schema:dump`
 
-The code is very simple and the usage is not friendly but almost.
 
-1. download the zip (or copy paste de code) 
-2. extract to folder
-3. cd folder
-4. if your projects are outside your user folder: edit the main.rb and change the path to point to your schema.rb  (generated with the rake db:schema:dump)
-5. ruby main.rb 
-6. chose the path to your schema.rb
-7. chose your table
-8. copy the rails generate scaffold command
+SchemaToScaffold will generate rails scaffolding scripts by table like this:
 
-* Eight quick steps that will save you a lot of time
-* It will give some alerts if your names are not following the rails convention.
+    rails g scaffold users fname:string lname:string bdate:date email:string encrypted_password:string
 
-read a litle about [rails convention](http://itsignals.cascadia.com.au/?p=7) 
 
-Contributing
-------------
+## Installation ##
 
-Want to contribute? Great!
+We assume you have rubygems-bundler installed, just type:
 
-1. Fork it.
-2. Create a branch (`git checkout -b my_schema_to_scafold`)
-3. Commit your changes (`git commit -am "Added great stuff"`)
-4. Push to the branch (`git push origin my_schema_to_scafold`)
-5. Open a [Pull Request][1]
-6. That's all!! 
+    gem install schema_to_scaffold
 
-[1]: http://github.com/frenesim/schema_to_scaffold/pulls
 
-Colaborate
-------------
-if you want to colaborate send me an email please. 
+## Usage ##
+
+Just type:
+
+    scaffold [options]
+    
+	[options]
+    -h				Displays help.
+	-p <path>		It specifies a file ex: -p /path/to/your/schema.rb
+	-c				Works only on linux. Will copy the script copied to your clipboard.
+					You will need to have xclip installed(see below).
+
+### To install xclip ###
+
+    sudo apt-get install xclip

data/bin/scaffold

@@ -1,19 +1,28 @@
 #!/usr/bin/env ruby
 $:.unshift File.expand_path('../lib', File.dirname(__FILE__))
 require 'schema_to_scaffold'
+require 'find'
 
 ## Argument conditions
 
 opts = SchemaToScaffold.parse_arguments(ARGV)
-ARGV.shift until ARGV.empty?
+ARGV.clear
 
-if opts[:help] or opts[:path].nil?
+if opts[:help]
   puts SchemaToScaffold.help_msg
   exit 0
 end
 
+## looking for schema.rb in user directory
+if opts[:path].nil?
+  paths = SchemaToScaffold::Path.new
+  paths.search
+end
+
+## Opening file
 begin
-  data = File.open(opts[:path], 'r') {|f| f.read }
+  path = opts[:path] || paths.choose
+  data = File.open(path, 'r') {|f| f.read }
 rescue
   puts "Unable to open file '#{path}'"
   exit 1
@@ -23,11 +32,16 @@ end
 
 schema = SchemaToScaffold::Schema.new(data)
 
-puts "\nLoaded tables:"
-schema.table_names.each_with_index {|name,i|  puts "#{i}. #{name}" }
-
 begin
+  if schema.table_names.empty? then 
+  	raise "Could not find tables in '#{path}'" 
+  end
+  puts "\nLoaded tables:"
+  schema.table_names.each_with_index {|name,i|  puts "#{i}. #{name}" }
   print "\nSelect a table: "
+rescue
+  puts "Could not find tables in '#{path}'"
+  exit 1
 end while schema.table_names[(table_id = gets.to_i)].nil?
 
 script = SchemaToScaffold.generate_script(schema, table_id)

data/lib/CommandLineHelpers.rb

@@ -0,0 +1,24 @@
+require 'active_support/inflector'
+
+module CommandLineHelpers
+  extend self
+
+  class NotFollowingConventionsError < StandardError ; end
+  
+  class HelpMessages
+  
+    def help
+     print "Usage: schemafold [OPTION] PATH
+            Generate a rails scaffold script for the given schema.rb file
+            PATH is the path to the schema.rb file.
+
+            OPTIONS:
+              -x     put the rails scaffold script in your clipboard using xclip, type:
+                       sudo apt-get install xclip
+                     if you don't have it
+            "
+    end
+    
+  end
+  
+end

data/lib/schema_to_scaffold.rb

@@ -2,6 +2,7 @@ require 'schema_to_scaffold/version'
 require 'schema_to_scaffold/schema'
 require 'schema_to_scaffold/table'
 require 'schema_to_scaffold/attribute'
+require 'schema_to_scaffold/path'
 
 module SchemaToScaffold
   extend self
@@ -9,9 +10,11 @@ module SchemaToScaffold
   ## Usage help text to print in all platforms
 
   GENERIC_HELP = <<-END_OF_HELP
-Usage: scaffold [OPTION] PATH
-Generate a rails scaffold script for the given schema.rb file
-PATH is the path to the schema.rb file.
+  
+Usage: scaffold [options] 
+Generate a rails scaffold script for a given schema.rb
+ -h             Displays help.
+ -p <path>      It specifies a path to a file
 
 END_OF_HELP
 
@@ -19,24 +22,27 @@ END_OF_HELP
   ## Windows specific usage help text
 
   WINDOWS_HELP = <<-WINDOWS_SAMPLE
-Example: scaffold C:\Users\John\ Doe\Documents\schema.rb
-
+Examples:
+scaffold 
+or
+scaffold -p C:\\Users\\JohnDoe\\Documents\\schema.rb
 WINDOWS_SAMPLE
 
   ## Linux specific usage help text
 
   LINUX_HELP = <<-LINUX_SAMPLE
-    OPTIONS:
-      -x     put the rails scaffold script in your clipboard using xclip which should be installed
-
-Example: scaffold ~/work/rails/my_app/db/schema.rb
-
+     -c             Works only on linux. Will copy the script copied to your clipboard. You will need to have xclip installed(see below).
+Examples:
+scaffold
+or 
+scaffold -x -p ~/work/rails/my_app/db/schema.rb
 LINUX_SAMPLE
 
   def help_msg
     return GENERIC_HELP +
     case RUBY_PLATFORM
     when /win/i   then WINDOWS_HELP
+    when /mingw/i then WINDOWS_HELP
     when /linux/i then LINUX_HELP
     end
   end
@@ -45,10 +51,11 @@ LINUX_SAMPLE
   # Parses ARGV and returns a hash of options.
 
   def parse_arguments(argv)
+    argv.index("-p") ? path = argv[argv.index("-p")+1] : nil
     {
-      xclip: argv.delete('-c'),                                # check for xclip flag
-      help: argv.delete('-h'),                                 # check for help flag
-      path: argv[0],                                           # get path to file, must be the last for argv[0] to work
+      xclip: argv.delete('-c'),        # check for xclip flag
+      help:  argv.delete('-h'),        # check for help flag
+      path:  path         # get path to file(s)
     }
   end
 

data/lib/schema_to_scaffold/path.rb

@@ -0,0 +1,35 @@
+require 'find'
+module SchemaToScaffold
+  
+  PATH_NAMES = ["HOME", "HOMEPATH", "USERPROFILE"]
+  
+  class Path
+    
+    def initialize
+      @paths = PATH_NAMES.detect {|h| ENV[h] != nil}
+    end
+    
+    ##
+    # Will search for schema.rb in the user directory
+    def search
+      puts 'looking for schema.rb in '+ ENV[@paths]
+      @schema_paths =  Array.new
+      Find.find(ENV[@paths]) do |path|
+        @schema_paths<<path if path[/schema\.rb$/]
+      end
+    end
+    
+    ##
+    # Return the chosen path
+    def choose
+      @schema_paths.each_with_index {|path,i|  puts "#{i}. #{path}" }
+      begin
+          print "\nSelect a path to the target schema: "
+      end while (id = gets.chomp.to_i).nil?
+      @schema_paths[id]
+    end
+    
+    
+  end
+  
+end

data/lib/schema_to_scaffold/table.rb

@@ -12,7 +12,8 @@ module SchemaToScaffold
     end
 
     def self.parse(table_data)
-      name = table_data.match(/table "(.+)"/).captures.first; 
+      return unless name = table_data[/table "(.+)"/]
+      name = $1
       atts = table_data.lines.to_a.select {|line| line =~ /t\.\w+/ }.map {|att| Attribute.parse att }
       Table.new(name, atts)
     end

data/lib/schema_to_scaffold/version.rb

@@ -1,3 +1,3 @@
 module SchemaToScaffold
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies: []
 description: ! '  Command line app which parses a schema.rb file obtained from your
   rails repo or by running rake:schema:dump
@@ -30,8 +30,10 @@ files:
 - README.md
 - Rakefile
 - bin/scaffold
+- lib/CommandLineHelpers.rb
 - lib/schema_to_scaffold.rb
 - lib/schema_to_scaffold/attribute.rb
+- lib/schema_to_scaffold/path.rb
 - lib/schema_to_scaffold/schema.rb
 - lib/schema_to_scaffold/table.rb
 - lib/schema_to_scaffold/version.rb
@@ -56,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Generate rails scaffold script from a schema.rb file.