schema_to_scaffold 0.0.1 → 0.1.0

data/README.md

@@ -1,41 +1,34 @@
-Schema to Scaffold
-==================
+# Schema to Scaffold #
 
-After I cross with rake db:schema:dump I feel that it could do a litle more in my case. So there 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 /path/to/your/schema.rb
+
+or if you are using linux you can use -c
+
+    scaffold /path/to/your/schema.rb -c
+
+to have 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

@@ -2,46 +2,37 @@
 $:.unshift File.expand_path('../lib', File.dirname(__FILE__))
 require 'schema_to_scaffold'
 
-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.
-
-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_OF_HELP
-
-xclip = ARGV.delete('-x')
-if ARGV[0].nil? or ARGV.delete('-h')
-  puts HELP
-else
-  data = File.open(ARGV[0], 'r') {|f| f.read }
-  until ARGV.empty? do
-    ARGV.shift
-  end
-
-  schema = SchemaToScaffold::Schema.new(data)
-
-  begin
-    schema.check_rails_naming_conventions
-  rescue NotFollowingConventionsError => msg
-    puts msg
-  end
-
-  puts "\nLoaded tables:"
-  schema.table_names.each_with_index {|name,i|  puts "#{i}. #{name}" }
-
-  begin
-    print "\nSelect a table: "
-  end while schema.table_names[(table_id = gets.to_i)].nil?
-
-  script = SchemaToScaffold.generate_script(schema, table_id)
-  puts "\n#{script}"
-  if xclip
-    puts("\n(copied to your clipboard)")
-    exec("echo '#{script}' | xclip -selection c")
-  end
+## Argument conditions
+
+opts = SchemaToScaffold.parse_arguments(ARGV)
+ARGV.shift until ARGV.empty?
+
+if opts[:help] or opts[:path].nil?
+  puts SchemaToScaffold.help_msg
+  exit 0
+end
+
+begin
+  data = File.open(opts[:path], 'r') {|f| f.read }
+rescue
+  puts "Unable to open file '#{path}'"
+  exit 1
+end
+
+## Generate script from schema
+
+schema = SchemaToScaffold::Schema.new(data)
+
+puts "\nLoaded tables:"
+schema.table_names.each_with_index {|name,i|  puts "#{i}. #{name}" }
+
+begin
+  print "\nSelect a table: "
+end while schema.table_names[(table_id = gets.to_i)].nil?
+
+script = SchemaToScaffold.generate_script(schema, table_id)
+puts "\n#{script}"
+if opts[:xclip]
+  puts("\n(copied to your clipboard)")
+  exec("echo '#{script}' | xclip -selection c")
 end

data/lib/schema_to_scaffold.rb

@@ -1,4 +1,3 @@
-require 'active_support/inflector'
 require 'schema_to_scaffold/version'
 require 'schema_to_scaffold/schema'
 require 'schema_to_scaffold/table'
@@ -7,6 +6,55 @@ require 'schema_to_scaffold/attribute'
 module SchemaToScaffold
   extend self
 
+  ## 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.
+
+END_OF_HELP
+
+
+  ## Windows specific usage help text
+
+  WINDOWS_HELP = <<-WINDOWS_SAMPLE
+Example: scaffold C:\Users\John\ Doe\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
+
+LINUX_SAMPLE
+
+  def help_msg
+    return GENERIC_HELP +
+    case RUBY_PLATFORM
+    when /win/i   then WINDOWS_HELP
+    when /linux/i then LINUX_HELP
+    end
+  end
+
+  ##
+  # Parses ARGV and returns a hash of options.
+
+  def parse_arguments(argv)
+    {
+      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
+    }
+  end
+
+  ##
+  # Generates the rails scaffold script
+
   def self.generate_script(schema, table=nil)
     schema = Schema.new(schema) unless schema.is_a? Schema
     return schema.to_script if table.nil?

data/lib/schema_to_scaffold/schema.rb

@@ -3,8 +3,6 @@ module SchemaToScaffold
 
     attr_reader :data, :tables
 
-    ERROR_MSG = "Warning: You should change the table names according to rails conventions."
-
     def initialize(data)
       @data, @tables = data, Schema.parse(data)
     end
@@ -13,10 +11,6 @@ module SchemaToScaffold
       tables.map(&:name)
     end
 
-    def check_rails_naming_conventions
-      raise NotFollowingConventionsError, ERROR_MSG if table_names.any? {|n| n == n.singularize or n == n.camelcase }
-    end
-
     def table(id)
       case id
       when Symbol then table(id.to_s)

data/lib/schema_to_scaffold/version.rb

@@ -1,3 +1,3 @@
 module SchemaToScaffold
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/schema_to_scaffold.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Humberto Pinto", "João Soares"]
   gem.email         = ["h.lsp999@gmail.com", "jsoaresgeral@gmail.com"]
   gem.description   = <<-EOD
-  Command line app for windows and linux which parses a schema.rb file obtained from your rails repo or by running rake:schema:dump
+  Command line app which parses a schema.rb file obtained from your rails repo or by running rake:schema:dump
 EOD
   gem.summary       = %q{Generate rails scaffold script from a schema.rb file.}
   gem.homepage      = "http://github.com/frenesim/schema_to_scaffold"
@@ -17,6 +17,4 @@ EOD
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-  gem.add_runtime_dependency "active_support"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,25 +11,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-11-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: active_support
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! '  Command line app for windows and linux which parses a schema.rb
-  file obtained from your rails repo or by running rake:schema:dump
+dependencies: []
+description: ! '  Command line app which parses a schema.rb file obtained from your
+  rails repo or by running rake:schema:dump
 
 '
 email: