schema_to_scaffold 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de36372e8689f2dde99b643b28c3a716db14e70
-  data.tar.gz: dfa57a6943cd21193c7c25fd2bc68b24211a5821
+  metadata.gz: b7d161bb74f929c36273c630bbb0aee8e2bc88f0
+  data.tar.gz: c7094d6063f157b02b866c345ca2d69c3c7b8a4d
 SHA512:
-  metadata.gz: dd9f750ec2ef14231d6ca6c3aec459f0e52fb90717d1872a93d9b3ac56c25d0ca4728f4c2e0618fb9af1a8d30475cc60d301ad976cd18a3b7a734f5a39b4348f
-  data.tar.gz: 47faed47d547fe093e0113418ac0bd2f9ef1543f0de9259629d4bab33fef9770ac97f10487e227c593f35e2dfd3585f40fdcab808fd03a6edb5c569739214d56
+  metadata.gz: cca1fb55d406a0e04f794ee9914d5e75a2b78cd033db3424f550acee5daf06cc0c726c427c74634aa17663117b7c2f5a3c4057360634fcead6e665984472bb66
+  data.tar.gz: 9e7759ac83755b438f47e21e9d512a51843a8704f5b2521f2dc65516039849445dcbc50585db43467d64ac3a8e53d2dc46dc593b400fa7431ce0910f62b8a55f

data/README.md

@@ -2,22 +2,21 @@
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/frenesim/schema_to_scaffold)
 
-This Gem shall generate rails commands strings based on a rails database schema you already have.<br>
-Generated string commands available are:<br>
-`rails generate scaffold <model_name> <field[:type]>`<br>
-`rails generate factory_girl:model <ModelName> <field[:type]>`
+This Gem generates Rails command strings based on a Rails database schema you already have. Unlike traditional migrations, which modify the database as they generate Rails scaffolding code, this Gem reads the database and generates the Rails code which matches your database's existing columns.
 
-Important:
-This gem will not run code for you. It will only generate a string for you to copy and paste
+This Gem does not modify anything; it simply prints a string which will then invoke the Rails generators, and optionally copies the string to your clipboard. Generated string commands available are:
+```bash
+rails generate scaffold <model_name> <field[:type]>
+rails generate factory_girl:model <ModelName> <field[:type]>
+```
 
-Use your schema.rb file from `<rails_app>/db` or generated with `rake db:schema:dump`
-You can rename schema.rb to schema_your_fav_name.rb that I will find it to. This will prevent schema.rb from being
-overwritten when one run rake db:migrate.
+Use your schema.rb file from `<rails_app>/db` or generated with `rake db:schema:dump`. You can optionally rename schema.rb to `schema_your_fav_name.rb` and it will still be found. Unique schema file names will prevent schema.rb from being overwritten when you run `rake db:migrate`.
 
-SchemaToScaffold will generate rails scaffolding scripts by table like this:
+Schema to Scaffold will generate rails scaffolding scripts by table like this:
 
-    rails g scaffold users fname:string lname:string bdate:date email:string encrypted_password:string
+    rails generate scaffold users fname:string lname:string bdate:date email:string encrypted_password:string
 
+It's possible to generate scripts for all your tables at once. Just choose `*` when choosing the table.
 
 ## Installation
 
@@ -25,25 +24,50 @@ Assuming that you have rubygems-bundler installed, just type:
 
     gem install schema_to_scaffold
 
-
 ## Usage
 
-Just type:
-
-    scaffold [options]
-    
-	[options]
-    -h				Displays help.
-	-p <path>		It specifies a search path or a path to a file 
-					ex: -p /user/path  or  /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
+```
+Usage: scaffold [options] 
+Generate a rails scaffold script for a given schema.rb
+ -h             Displays help.
+ -p <path>      It specifies a path to a folder or to a file.
+ -c             Will copy the script to your clipboard. Requires xclip be installed on Linux.
+ -f             Generates a factory_girl:model rather than a full scaffold.
+
+Examples:
+scaffold
+scaffold -c -p ~/work/rails/my_app
+scaffold -c -p ~/work/rails/my_app/db/schema.rb
+```
+## Generators
+
+Since this gem will let you invoke Rails generators for your scaffolding, make sure you've configured your generators with your preferred settings before start. There's a good [Rails Guide](http://guides.rubyonrails.org/generators.html) and you can invoke `rails g scaffold -h` to see options.
+
+Generator options are configured in `config/application.rb`. Here is an example setting:
+
+```ruby
+module YourApplication
+  class Application < Rails::Application
+    config.generators do |g|
+      g.hidden_namespaces << :test_unit << :erb # Hide unwanted generators
+      g.template_engine :slim # Select template engine
+      g.test_framework  :rspec, :view_specs => false
+      g.integration_tool :rspec
+      g.fixture_replacement :factory_girl # Choose between fixtures and factories
+      g.factory_girl dir: 'spec/factories'
+      g.javascript_engine :js # Disable coffeescript
+      g.scaffold_controller "responders_controller" # from responders gem
+    end
+  end
+end
+```
+If you configure factory_girl as your fixture_replacement here, there is no need to invoke factory_girl separately with the `scaffold -f` command.
+
+## To install xclip on Linux
 
     sudo apt-get install xclip
-    
-### Contributing
+
+## Contributing
 
 	Want to contribute? Great!
 
@@ -56,6 +80,6 @@ Just type:
 
 [1]: http://github.com/frenesim/schema_to_scaffold/pulls
 
-### Collaborate
+## Collaborate
 
 	If you want to collaborate send me an email please. 

data/bin/scaffold

@@ -51,21 +51,24 @@ else
   tables = [result.to_i]
 end
 
-script_scaffold = []
-script_factory_girl = []
-tables.each do |table_id|
-  script_scaffold << SchemaToScaffold.generate_script(schema, table_id,"scaffold")
-  script_factory_girl << SchemaToScaffold.generate_script(schema, table_id,"factory_girl:model")
-end
-
-puts "\nScript for rails scaffold"
-puts script_scaffold.join("\n")
-
-puts "\nScript for factory girl"
-puts script_factory_girl.join("\n")
+script = []
 
+if opts[:factory_girl]
+  tables.each { |table_id| script << SchemaToScaffold.generate_script(schema, table_id, "factory_girl:model") }
+  puts "\nScript for factory girl:\n\n"
+  puts script.join("")
+else
+  tables.each { |table_id| script << SchemaToScaffold.generate_script(schema, table_id, "scaffold") }
+  puts "\nScript for rails scaffold:\n\n"
+  puts script.join("")
+end
 
-if opts[:xclip]
+if opts[:clipboard]
   puts("\n(copied to your clipboard)")
-  exec("echo '#{script}' | xclip -selection c")
+  case RUBY_PLATFORM
+    when /darwin/i then exec("echo '#{script.join("")}' | tr -d '\n' | pbcopy")
+    when /linux/i  then exec("echo '#{script.join("")}' | tr -d '\n' | xclip -selection c")
+    when /mingw/i  then exec("echo '#{script.join("")}' | clip")
+    when /win/i    then exec("echo '#{script.join("")}' | clip")
+  end
 end

data/lib/schema_to_scaffold.rb

@@ -14,7 +14,9 @@ module SchemaToScaffold
 Usage: scaffold [options] 
 Generate a rails scaffold script for a given schema.rb
  -h             Displays help.
- -p <path>      It specifies a path to a folder or to a file
+ -p <path>      It specifies a path to a folder or to a file.
+ -c             Will copy the script to your clipboard. Requires xclip be installed on Linux.
+ -f             Generates a factory_girl:model rather than a full scaffold.
 
 END_OF_HELP
 
@@ -25,13 +27,12 @@ END_OF_HELP
 Examples:
 scaffold 
 scaffold -p C:\\Users\\JohnDoe
-scaffold -p C:\\Users\\JohnDoe\\Documents\\schema.rb
+scaffold -c -p C:\\Users\\JohnDoe\\Documents\\schema.rb
 WINDOWS_SAMPLE
 
   ## Linux specific usage help text
 
   LINUX_HELP = <<-LINUX_SAMPLE
-     -c             Works only on linux. Will copy the script copied to your clipboard. You will need to have xclip installed(see below).
 Examples:
 scaffold
 scaffold -c -p ~/work/rails/my_app
@@ -41,9 +42,10 @@ 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
+    when /darwin/i then LINUX_HELP
+    when /linux/i  then LINUX_HELP
+    when /mingw/i  then WINDOWS_HELP
+    when /win/i    then WINDOWS_HELP
     end
   end
 
@@ -56,7 +58,8 @@ LINUX_SAMPLE
       argv.delete('-p')
     end
     args = {
-      :xclip => argv.delete('-c'),        # check for xclip flag
+      :clipboard => argv.delete('-c'),        # check for clipboard flag
+      :factory_girl => argv.delete('-f'), # factory_girl instead of scaffold
       :help =>  argv.delete('-h'),        # check for help flag
       :path =>  path                      # get path to file(s)
     }

data/lib/schema_to_scaffold/table.rb

@@ -12,12 +12,12 @@ module SchemaToScaffold
     end
 
     def to_script(target)
-      return "rails generate #{target} #{modelize name} #{attributes.map(&:to_script).reject{|x| x.nil? || x.empty?}.join(' ')}" if target == "scaffold"
+      return "rails generate #{target} #{modelize name} #{attributes.map(&:to_script).reject{|x| x.nil? || x.empty?}.join(' ')} --no-migration" if target == "scaffold"
       return "rails generate #{target} #{modelize name} #{attributes.map(&:to_script).reject{|x| x.nil? || x.empty?}.join(' ')}" if target == "factory_girl:model"
     end
 
     def self.parse(table_data)
-      return unless name = table_data[/table "(.+)"/]
+      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)

data/lib/schema_to_scaffold/version.rb

@@ -1,6 +1,6 @@
 module SchemaToScaffold
   MAJOR = 0
   MINOR = 5
-  REVISION = 0
+  REVISION = 1
   VERSION = [MAJOR, MINOR, REVISION].join('.')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - João Soares
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport