schema_to_scaffold 0.7.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88d13a7ac7e248b01bf4f47fe37656accfcf0a49
-  data.tar.gz: 992dcc7e74ac24461f3e863424d5286a7eed3e97
+SHA256:
+  metadata.gz: 229ebc7daea413c98b93c50601c9849af0e827f2fbb2d338b09872b54470a46d
+  data.tar.gz: 0c514edaa979279a1a2a8f764c198618c07040662f830c1c4fb133ec7b0ce23e
 SHA512:
-  metadata.gz: 107e2ad6462e047b9961f8df3f326c320f3e356498d2e1594f1ad9f68f5c5d8f129cd78f850a9f96540685e3fd6b1306a27409f2eee970848b4b5a744d9cee17
-  data.tar.gz: 5b8439e9a1006827a3132dbac38b05bc6b042bd6f4e89e5b872ed7895656103ced35b103acb915820cfefc7d8d7996577c14eed3596a2c8629f35519151e9689
+  metadata.gz: faf0fa5ce0d3c2a3c773c2840bb5a8fac8507d722e3a1f681a65f71aaea31db204f7a22d95dc68bd9f99bc30ecc01f5ed392eb5df171ea96d897dd1f4867dd36
+  data.tar.gz: 2c85e8f978b9e831671a9ae1512a9c6103f3f9a12bd59e8d27e395dac5848766f38ab04229561e70910b00448e41cdf157f175fa750992e619d63f90ddd149d5

data/.gitignore

@@ -17,4 +17,6 @@ test/version_tmp
 tmp
 .project
 /schema.rb
-.idea
+.idea
+spec/examples.txt
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+schema-to-scaffold

data/.ruby-version

@@ -1 +1 @@
-2.1.1@schema-to-scaffold 
+2.7.4

data/README.md

@@ -7,7 +7,7 @@ This Gem generates Rails command strings based on a Rails database schema you al
 This Gem does not modify anything; it simply prints a string which you can then use to 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]>
+rails generate factory_bot:model <ModelName> <field[:type]>
 ```
 
 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 if you use migrations and run `rake db:migrate`.
@@ -26,24 +26,28 @@ Assuming that you have rubygems-bundler installed, just type:
 
 ## Usage
 
+```bash
+$ scaffold [options]
 ```
-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.
+ -f             Generates a factory_bot:model rather than a full scaffold.
  -m             Add migration (use if your schema comes from a different database)
-
+```
 Examples:
-scaffold
-scaffold -c -p ~/work/rails/my_app
-scaffold -c -p ~/work/rails/my_app/db/schema.rb
-
+```bash
+$ scaffold
+$ scaffold -c -p ~/work/rails/my_app
+$ scaffold -c -p ~/work/rails/my_app/db/schema.rb
 ```
+
 ## Generators
 
-Since this gem assists you in invoking Rails generators for your scaffolding, make sure you've configured your generators with your preferred settings before you start. There's a good [Rails Guide](http://guides.rubyonrails.org/generators.html) and you can invoke `rails g scaffold -h` to see options.
+Since this gem assists you in invoking Rails generators for your scaffolding, make sure you've configured your generators with your preferred settings before you 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:
 
@@ -56,15 +60,15 @@ module YourApplication
       g.helper false # Don't create view helpers
       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.fixture_replacement :factory_bot # Choose between fixtures and factories
+      g.factory_bot 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.
+If you configure factory_bot as your fixture_replacement here, there is no need to invoke factory_bot separately with the `scaffold -f` command.
 
 ## Migrations
 
@@ -72,7 +76,7 @@ Schema to Scaffold is set up by default to support creating scaffolds for your e
 
 ## To install xclip on Linux
 
-    sudo apt-get install xclip
+    `apt-get install xclip`
 
 ## Contributing
 
@@ -83,10 +87,10 @@ Schema to Scaffold is set up by default to support creating scaffolds for your e
 3. Commit your changes (`git commit -am "Added great stuff"`)
 4. Push to the branch (`git push origin my_schema_to_scaffold`)
 5. Open a [Pull Request][1]
-6. That's all!! 
+6. That's all!!
 
 [1]: http://github.com/frenesim/schema_to_scaffold/pulls
 
 ## Collaborate
 
-	If you want to collaborate, please send me an email, or just create an issue or pull request. 
+	If you want to collaborate, please send me an email, or just create an issue or pull request.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/scaffold

@@ -1,78 +1,12 @@
 #!/usr/bin/env ruby
-$:.unshift File.expand_path('../lib', File.dirname(__FILE__))
-require 'schema_to_scaffold'
-require 'pry'
-## Argument conditions
+# encoding: UTF-8
 
-opts = SchemaToScaffold.parse_arguments(ARGV)
-ARGV.clear
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
 
-if opts[:help]
-  puts SchemaToScaffold.help_msg
-  exit 0
-end
+require 'schema_to_scaffold/cli'
 
-## looking for /schema\S*.rb$/ in user directory
-paths = SchemaToScaffold::Path.new(opts[:path])
-path = paths.choose unless opts[:path].to_s.match(/\.rb$/)
-
-## Opening file
-path||=opts[:path]
-begin
-  data = File.open(path, 'r') {|f| f.read }
-rescue
-  puts "\nUnable to open file '#{path}'"
-  exit 1
-end
-
-## Generate scripts from schema
-
-schema = SchemaToScaffold::Schema.new(data)
-
-begin
-  raise if schema.table_names.empty?
-  puts "\nLoaded tables:"
-  schema.table_names.each_with_index {|name,i|  puts "#{i}. #{name}" }
-
-  puts "\nOptions are:\n4 for table 4; (4..6) for table 4 to 6; [4,6] for tables 4 and 6; * for all Tables"
-
-  print "\nSelect a table: "
-
-rescue
-  puts "Could not find tables in '#{path}'"
-  exit 1
-end
-
-result = gets.strip
-begin
-  case result
-    when "*"
-      tables = (0..schema.table_names.count-1).map{|i|i}
-    when /^\d/
-      tables = [result.to_i]
-    else
-      tables = eval(result).to_a.map{|i|i}
-  end
-  raise if tables.empty?
-rescue Exception => e
-  puts "Not a valid input, \nOptions are:\n4 for table 4; (4..6) for table 4 to 6; [4,6] for tables 4 and 6; * for all Tables"
-  exit 1
-end
-
-script = []
-target = opts[:factory_girl] ? "factory_girl:model" : "scaffold"
-migragion_flag = opts[:migration] || opts[:factory_girl]
-tables.each { |table_id| script << SchemaToScaffold.generate_script(schema, table_id, target, migragion_flag) }
-output = script.join("")
-puts "\nScript for #{target}:\n\n"
-puts output
-
-if opts[:clipboard]
-  puts("\n(copied to your clipboard)")
-  case RUBY_PLATFORM
-    when /darwin/i then exec("echo '#{output}' | tr -d '\n' | pbcopy")
-    when /linux/i  then exec("echo '#{output}' | tr -d '\n' | xclip -selection c")
-    when /mingw/i  then exec("echo '#{output}' | clip")
-    when /win/i    then exec("echo '#{output}' | clip")
-  end
-end
+SchemaToScaffold::CLI.start(*ARGV)

data/lib/schema_to_scaffold/attribute.rb

@@ -8,18 +8,17 @@ module SchemaToScaffold
     end
 
     def to_script
-      "#{name}:#{type}" unless ["created_at","updated_at"].include? name
+      "#{name}:#{type}" unless ["created_at","updated_at"].include?(name)
     end
 
     def self.parse(attribute)
       match = attribute.match(/t\.(\w+)\s+"(\w+)"/)
       if match
-        name = match.captures[1].sub(/_id$/,'')
+        name = match.captures[1].sub(/_id$/, "")
         type = $&.nil? ? match.captures[0] : "references"
-        Attribute.new(name,type)
+        Attribute.new(name, type)
       end
     end
 
-
   end
 end

data/lib/schema_to_scaffold/cli.rb

@@ -0,0 +1,107 @@
+require "schema_to_scaffold"
+module SchemaToScaffold
+  class CLI
+
+    TABLE_OPTIONS = "\nOptions are:\n4 for table 4; (4..6) for table 4 to 6; [4,6] for tables 4 and 6; * for all Tables"
+
+    def self.start(*args)
+      ## Argument conditions
+      opts = parse_arguments(args)
+
+      if opts[:help]
+        puts Help.message
+        exit 0
+      end
+
+      ## looking for /schema\S*.rb$/ in user directory
+      paths = Path.new(opts[:path])
+      path = paths.choose unless opts[:path].to_s.match(/\.rb$/)
+
+      ## Opening file
+      path ||= opts[:path]
+      begin
+        data = File.open(path, 'r') { |f| f.read }
+      rescue
+        puts "\nUnable to open file '#{path}'"
+        exit 1
+      rescue Interrupt => e
+        exit 1
+      end
+
+      ## Generate scripts from schema
+      schema = Schema.new(data)
+
+      begin
+        raise if schema.table_names.empty?
+        puts "\nLoaded tables:"
+        schema.print_table_names
+        puts TABLE_OPTIONS
+        print "\nSelect a table: "
+      rescue
+        puts "Could not find tables in '#{path}'"
+        exit 1
+      end
+
+      input = STDIN.gets.strip
+      begin
+        tables = schema.select_tables(input)
+        raise if tables.empty?
+      rescue
+        puts "Not a valid input. #{TABLE_OPTIONS}"
+        exit 1
+      rescue Interrupt => e
+        exit 1
+      end
+
+      script = []
+      target = opts[:factory_bot] ? "factory_bot:model" : "scaffold"
+      migration_flag = opts[:migration] ? true : false
+
+      tables.each do |table_id|
+        script << generate_script(schema, table_id, target, migration_flag)
+      end
+      output = script.join("")
+      puts "\nScript for #{target}:\n\n"
+      puts output
+
+      if opts[:clipboard]
+        puts("\n(copied to your clipboard)")
+        Clipboard.new(output).command
+      end
+    end
+
+    ##
+    # Parses ARGV and returns a hash of options.
+    def self.parse_arguments(argv)
+      if argv_index = argv.index("-p")
+        path = argv.delete_at(argv_index + 1)
+        argv.delete('-p')
+      end
+
+      args = {
+        clipboard: argv.delete('-c'),    # check for clipboard flag
+        factory_bot: argv.delete('-f'), # factory_bot instead of scaffold
+        migration: argv.delete('-m'),   # generate migrations
+        help: argv.delete('-h'),        # check for help flag
+        path: path                      # get path to file(s)
+      }
+
+      if argv.empty?
+        args
+      else
+        puts "\n------\nWrong set of arguments.\n------\n"
+        puts Help.message
+        exit
+      end
+    end
+
+    ##
+    # Generates the rails scaffold script
+    def self.generate_script(schema, table=nil, target, migration_flag)
+      schema = Schema.new(schema) unless schema.is_a?(Schema)
+      return schema.to_script if table.nil?
+      schema.table(table).to_script(target, migration_flag)
+    end
+
+  end
+end

data/lib/schema_to_scaffold/clipboard.rb

@@ -0,0 +1,36 @@
+module SchemaToScaffold
+  class Clipboard
+    attr_reader :output
+
+    def initialize(output)
+      @output = output
+    end
+
+    def command
+      case platform
+        when /darwin/i then darwin_command
+        when /linux/i  then linux_command
+        when /mingw/i  then win_command
+        when /win/i    then win_command
+      end
+    end
+
+    private
+
+    def darwin_command
+      exec("echo '#{output}' | tr -d '\n' | pbcopy")
+    end
+
+    def linux_command
+      exec("echo '#{output}' | tr -d '\n' | xclip -selection c")
+    end
+
+    def win_command
+      exec("echo '#{output}' | clip")
+    end
+
+    def platform
+      RUBY_PLATFORM
+    end
+  end
+end

data/lib/schema_to_scaffold/help.rb

@@ -0,0 +1,46 @@
+module SchemaToScaffold
+  class Help
+    ## Usage help text to print in all platforms
+    GENERIC_HELP = <<-END_OF_HELP
+
+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_bot:model rather than a full scaffold.
+ -m             Add migration (use if your schema comes from a different database)
+
+END_OF_HELP
+
+    ## Windows specific usage help text
+    WINDOWS_HELP = <<-WINDOWS_SAMPLE
+Examples:
+scaffold
+scaffold -p C:\\Users\\JohnDoe
+scaffold -c -p C:\\Users\\JohnDoe\\Documents\\schema.rb
+WINDOWS_SAMPLE
+
+    ## Linux specific usage help text
+    LINUX_HELP = <<-LINUX_SAMPLE
+Examples:
+scaffold
+scaffold -c -p ~/work/rails/my_app
+scaffold -c -p ~/work/rails/my_app/db/schema.rb
+LINUX_SAMPLE
+
+    def self.message
+      return GENERIC_HELP +
+      case platform
+      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
+
+    def self.platform
+      RUBY_PLATFORM
+    end
+  end
+end

data/lib/schema_to_scaffold/path.rb

@@ -1,54 +1,58 @@
 require 'find'
 module SchemaToScaffold
-  
   ##
   # Deal with the path argument
 
   class Path
-    
+
     def initialize(path)
-      @search_path = Dir.pwd
-      @path = path
+      @path = path || Dir.pwd
     end
 
     ##
-    # Validate if a given path leads to a directory
-    def check_directory
-      unless File.directory?(@search_path)
-        puts "\nSorry #{@search_path} is not a valid directory!\nHere is an example:\nscaffold -p /home/foo/bar"
+    # Return the chosen path
+    def choose
+      validate_path
+      search_paths_list = search_paths
+      if search_paths_list.empty?
+        puts "\nThere is no /schema[^\/]*.rb$/ in the directory #{@path}"
         exit
       end
-      puts "\nLooking for schema.rb in #{@search_path}"
+
+      search_paths_list.each_with_index {|path,indx|  puts "#{indx}. #{path}" }
+
+      begin
+        print "\nSelect a path to the target schema: "
+        while search_paths_list[(id = STDIN.gets.to_i)].nil?; end
+      rescue Interrupt => e
+        exit 1
+      end 
+
+
+      search_paths_list[id]
     end
-    
 
+    private
     ##
-    # Return the chosen path
-    def choose
-      search_rb
-      if @schema_paths.empty?
-        puts "\nSorry there is none /schema[^\/]*.rb$/ in the directory #{@search_path}"
+    # Validate if a given path leads to a directory
+    def validate_path
+      if File.directory?(@path.to_s)
+        puts "\nLooking for schema.rb in #{@path}"
+      else
+        puts "\nSorry #{@path} is not a valid directory!\nHere is an example:\nscaffold -p /home/foo/bar"
         exit
       end
-      @schema_paths.each_with_index {|path,indx|  puts "#{indx}. #{path}" }
-      begin
-          print "\nSelect a path to the target schema: "
-      end while @schema_paths[(id = gets.to_i)].nil?
-      @schema_paths[id]
     end
 
-    private
     ##
     # Will search for /schema[^\/]*.rb$/ in the current directory
-    def search_rb
-      @search_path = @path.to_s unless @path.nil?
-      check_directory
-      @schema_paths = Array.new
-      Find.find(@search_path) do |s_p|
-        @schema_paths<<s_p if s_p[/schema[^\/]*.rb$/]
+    def search_paths
+      result = []
+      Find.find(@path) do |s_p|
+        result << s_p if s_p[/schema[^\/]*.rb$/]
       end
+      result
     end
 
   end
-  
 end

data/lib/schema_to_scaffold/schema.rb

@@ -11,11 +11,24 @@ module SchemaToScaffold
       tables.map(&:name)
     end
 
+    def print_table_names
+      table_names.each_with_index { |name, i|  puts "#{i}. #{name}" }
+    end
+
+    def select_tables(input)
+      case input
+      when "*"
+        table_range.to_a
+      when /^\d/
+        table_range.include?(input.to_i) ? [input.to_i] : []
+      end
+    end
+
     def table(id)
       case id
       when Symbol then table(id.to_s)
       when String then tables[table_names.index(id)]
-      when Fixnum then tables[id]
+      when Integer then tables[id]
       else nil
       end
     end
@@ -25,7 +38,13 @@ module SchemaToScaffold
     end
 
     def self.parse(data)
-      data.split(/^\s*create_/)[1..-1].map {|table_data| Table.parse table_data }
+      data.split(/^\s*create_/)[1..-1].map {|table_data| Table.parse(table_data) }.reject{ |e| e.nil? }
+    end
+
+    private
+
+    def table_range
+      0...table_names.count
     end
   end
 end

data/lib/schema_to_scaffold/table.rb

@@ -11,31 +11,37 @@ module SchemaToScaffold
       @name, @attributes = name, attributes
     end
 
-    def to_script(target, migragion_flag)
+    def to_script(target, migration_flag)
       begin
         attributes_list = attributes.map(&:to_script).reject { |x| x.nil? || x.empty? }.join(' ')
-      rescue Exception => e
+      rescue => e
         puts "\n ---------------------------------------------"
         puts e.message
         puts "Table \n\n\n #{self.inspect} \n\n\n"
         puts "\n ---------------------------------------------"
       end
       script = []
-      script << "rails generate #{target} #{modelize name} #{attributes_list}"
-      script << " --no-migration" unless migragion_flag
+      script << "rails generate #{target} #{modelize(name)} #{attributes_list}"
+      script << " --no-migration" unless migration_flag
       script << "\n\n"
-      return script
+      script
     end
 
     def self.parse(table_data)
       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)
+      table_fields = table_fields_of(table_data)
+      Table.new(name, table_fields)
     end
 
     private
-    def modelize (string)
+    def self.table_fields_of(table_data)
+      table_data.lines.to_a.select { |line| line =~ /t\.(?!index)\w+/ }.map { |att| Attribute.parse(att) }
+    end
+
+    private
+
+    def modelize(string)
       string.camelize.singularize
     end
 

data/lib/schema_to_scaffold/version.rb

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