schema_to_scaffold 0.7.1 → 0.8.2

data/lib/schema_to_scaffold.rb

@@ -3,84 +3,9 @@ require 'schema_to_scaffold/schema'
 require 'schema_to_scaffold/table'
 require 'schema_to_scaffold/attribute'
 require 'schema_to_scaffold/path'
+require 'schema_to_scaffold/cli'
+require 'schema_to_scaffold/help'
+require 'schema_to_scaffold/clipboard'
 
 module SchemaToScaffold
-  extend self
-
-  ## 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_girl: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 help_msg
-    return GENERIC_HELP +
-    case RUBY_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
-
-  ##
-  # Parses ARGV and returns a hash of options.
-
-  def 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_girl => argv.delete('-f'), # factory_girl instead of scaffold
-      :migration => argv.delete('-m'),   # generate migrations
-      :help =>  argv.delete('-h'),        # check for help flag
-      :path =>  path                      # get path to file(s)
-    }
-    unless argv.empty?
-      puts "\n------\nWrong set of arguments.\n------\n" 
-      puts help_msg
-      exit
-    else
-      args
-    end
-
-  end
-
-  ##
-  # Generates the rails scaffold script
-
-  def self.generate_script(schema, table=nil,target,migragion_flag)
-    schema = Schema.new(schema) unless schema.is_a? Schema
-    return schema.to_script if table.nil?
-    schema.table(table).to_script target, migragion_flag
-  end
 end

data/schema_to_scaffold.gemspec

@@ -17,10 +17,11 @@ EOD
   gem.files                 = `git ls-files`.split($/)
   gem.executables           = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.require_paths         = ["lib"]
-  gem.post_install_message  = "Thanks for installing!"
   gem.licenses              = ['MIT']
   gem.required_ruby_version = '>= 1.9.3'
 
-  gem.add_dependency('activesupport', '>= 3.2.1')
-  gem.add_development_dependency('pry', '~> 0.10', '>= 0.10.0')
+  gem.add_runtime_dependency('activesupport', '~> 7')
+  gem.add_development_dependency('byebug', '~> 11')
+  gem.add_development_dependency('rspec', '~> 3')
+  gem.add_development_dependency('simplecov', '~> 0.21')
 end

data/spec/attribute_spec.rb

@@ -0,0 +1,70 @@
+module SchemaToScaffold
+  RSpec.describe Attribute do
+
+    describe ".parse" do
+      it "parses _id attribute to references" do
+        attribute = Attribute.parse('t.integer  "user_id"')
+        expect(attribute.type).to eq("references")
+        expect(attribute.name).to eq("user")
+      end
+
+      it "parses string attributes" do
+        attribute = Attribute.parse('t.string   "filename"')
+        expect(attribute.type).to eq("string")
+        expect(attribute.name).to eq("filename")
+      end
+
+      it "parses datetime attributes" do
+        attribute = Attribute.parse('t.datetime "created_at", null: false')
+        expect(attribute.type).to eq("datetime")
+        expect(attribute.name).to eq("created_at")
+      end
+
+      it "parses limit value" do
+        pending
+        attribute = Attribute.parse('t.integer  "quota",  limit: 8')
+        expect(attribute.type).to eq("integer")
+        expect(attribute.name).to eq("quota")
+        expect(attribute.limit).to eq("8")
+      end
+
+      it "parses decimals precision and scale values" do
+        pending
+        attribute = Attribute.parse('t.decimal  "price", precision: 20, scale: 2, default: 0.0')
+        expect(attribute.type).to eq("decimal")
+        expect(attribute.name).to eq("price")
+        expect(attribute.precision).to eq("20")
+        expect(attribute.scale).to eq("2")
+      end
+    end
+
+    describe "#to_script" do
+      it "returns name and type" do
+        attribute = Attribute.parse('t.string   "filename"')
+        expect(attribute.to_script).to eq("filename:string")
+      end
+
+      it "ignores updated_at" do
+        attribute = Attribute.parse('t.datetime "updated_at", null: false')
+        expect(attribute.to_script).to be_nil
+      end
+
+      it "ignores created_at" do
+        attribute = Attribute.parse('t.datetime "created_at", null: false')
+        expect(attribute.to_script).to be_nil
+      end
+
+      it "adds limit value to integer" do
+        pending
+        attribute = Attribute.parse('t.integer  "quota",  limit: 8')
+        expect(attribute.to_script).to eq("quota:integer{8}")
+      end
+
+      it "adds precision and scale value to decimal" do
+        pending
+        attribute = Attribute.parse('t.decimal  "price", precision: 20, scale: 2, default: 0.0')
+        expect(attribute.to_script).to eq("price:decimal{20,2}")
+      end
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,116 @@
+module SchemaToScaffold
+  RSpec.describe CLI do
+
+    let(:empty_schema_file) { File.expand_path(File.dirname(__FILE__)) + '/support/empty_schema.rb' }
+    let(:schema_file) { File.expand_path(File.dirname(__FILE__)) + '/support/schema.rb' }
+
+    describe ".start" do
+      it "prints help message" do
+        expect {
+          begin
+            SchemaToScaffold::CLI.start("-h")
+          rescue SystemExit
+          end
+        }.to output(/Usage:/).to_stdout
+      end
+
+      it "prints file not found message" do
+        expect {
+          begin
+            SchemaToScaffold::CLI.start("-p", "/support/schema.rb")
+          rescue SystemExit
+          end
+        }.to output(/Unable to open file /).to_stdout
+      end
+
+      it "prints could not find tables message" do
+        expect {
+          begin
+            SchemaToScaffold::CLI.start("-p", empty_schema_file)
+          rescue SystemExit
+          end
+        }.to output(/Could not find tables /).to_stdout
+      end
+
+      context "choose table" do
+        before do
+          allow(STDIN).to receive(:gets) { "" }
+        end
+
+        it "prints Not a valid input message" do
+          expect {
+            begin
+              SchemaToScaffold::CLI.start("-p", schema_file)
+            rescue SystemExit
+            end
+          }.to output(/Not a valid input/).to_stdout
+        end
+      end
+
+      context "choose all tables" do
+        before do
+          allow(STDIN).to receive(:gets).once { "*" }
+        end
+
+        it "prints scaffold lines message" do
+          expect {
+            begin
+              SchemaToScaffold::CLI.start("-p", schema_file)
+            rescue SystemExit
+            end
+          }.to output(/Script for/).to_stdout
+        end
+      end
+
+      context "copies first table to clipboard" do
+        before do
+          allow(STDIN).to receive(:gets).once { "0" }
+          expect_any_instance_of(Kernel).to receive(:exec).with("echo 'rails generate scaffold User email:string encrypted_password:string reset_password_token:string reset_password_sent_at:datetime remember_created_at:datetime sign_in_count:integer current_sign_in_at:datetime last_sign_in_at:datetime current_sign_in_ip:string last_sign_in_ip:string name:string role:integer --no-migration\n\n' | tr -d '\n' | pbcopy")
+          expect_any_instance_of(Clipboard).to receive(:platform).and_return("/darwin/i")
+        end
+
+        it "prints copied to your clipboard message" do
+          expect {
+            begin
+              SchemaToScaffold::CLI.start("-c", "-p", schema_file)
+            rescue SystemExit
+            end
+          }.to output(/copied to your clipboard/).to_stdout
+        end
+      end
+    end
+
+    describe ".parse_arguments" do
+      it "handles wrong arguments" do
+        expect {
+          begin
+            SchemaToScaffold::CLI.parse_arguments(["--help"])
+          rescue SystemExit
+          end
+        }.to output(/Wrong set of arguments/).to_stdout
+      end
+
+      context "handles arguments" do
+        it "help argument" do
+          expect(CLI.parse_arguments(["-h"])).to eq({clipboard: nil, factory_bot: nil, migration: nil, help: "-h", path: nil})
+        end
+
+        it "path argument" do
+          expect(CLI.parse_arguments(["-p", "/some/path"])).to eq({clipboard: nil, factory_bot: nil, migration: nil, help: nil, path: "/some/path"})
+        end
+
+        it "clipboard argument" do
+          expect(CLI.parse_arguments(["-c"])).to eq({clipboard: "-c", factory_bot: nil, migration: nil, help: nil, path: nil})
+        end
+
+        it "factory girl argument" do
+          expect(CLI.parse_arguments(["-f"])).to eq({clipboard: nil, factory_bot: "-f", migration: nil, help: nil, path: nil})
+        end
+
+        it "migration argument" do
+          expect(CLI.parse_arguments(["-m"])).to eq({clipboard: nil, factory_bot: nil, migration: "-m", help: nil, path: nil})
+        end
+      end
+    end
+  end
+end

data/spec/clipboard_spec.rb

@@ -0,0 +1,52 @@
+module SchemaToScaffold
+  RSpec.describe Clipboard do
+    let(:output) { "rails g model ....." }
+    let(:clipboard) { Clipboard.new(output) }
+
+    describe "#command" do
+      context "darwin" do
+        before do
+          allow(clipboard).to receive(:platform).and_return("darwin")
+          expect_any_instance_of(Kernel).to receive(:exec).with("echo 'rails g model .....' | tr -d '\n' | pbcopy")
+        end
+
+        it "executes darwin command" do
+          clipboard.command
+        end
+      end
+
+      context "linux" do
+        before do
+          allow(clipboard).to receive(:platform).and_return("linux")
+          expect_any_instance_of(Kernel).to receive(:exec).with("echo 'rails g model .....' | tr -d '\n' | xclip -selection c")
+        end
+
+        it "executes linux command" do
+          clipboard.command
+        end
+      end
+
+      context "windows (win)" do
+        before do
+          allow(clipboard).to receive(:platform).and_return("win")
+          expect_any_instance_of(Kernel).to receive(:exec).with("echo 'rails g model .....' | clip")
+        end
+
+        it "executes windows command" do
+          clipboard.command
+        end
+      end
+
+      context "windows (mingw)" do
+        before do
+          allow(clipboard).to receive(:platform).and_return("mingw")
+          expect_any_instance_of(Kernel).to receive(:exec).with("echo 'rails g model .....' | clip")
+        end
+
+        it "executes windows command" do
+          clipboard.command
+        end
+      end
+    end
+  end
+end

data/spec/help_spec.rb

@@ -0,0 +1,25 @@
+module SchemaToScaffold
+  RSpec.describe Help do
+    describe ".message" do
+      it "returns message for darwin platform" do
+        allow(Help).to receive(:platform).and_return("darwin")
+        expect(Help.message).to include("work/rails/my_app/")
+      end
+
+      it "returns message for linux platform" do
+        allow(Help).to receive(:platform).and_return("linux")
+        expect(Help.message).to include("work/rails/my_app/")
+      end
+
+      it "returns message for windows(win) platform" do
+        allow(Help).to receive(:platform).and_return("win")
+        expect(Help.message).to include("JohnDoe\\Documents")
+      end
+
+      it "returns message for windows (mingw) platform" do
+        allow(Help).to receive(:platform).and_return("mingw")
+        expect(Help.message).to include("JohnDoe\\Documents")
+      end
+    end
+  end
+end

data/spec/path_spec.rb

@@ -0,0 +1,41 @@
+module SchemaToScaffold
+  RSpec.describe Path do
+
+    describe "#choose" do
+      it "prints error when given path is not an directory" do
+        path = Path.new("path_spec.rb")
+        expect {
+          begin
+            path.choose
+          rescue SystemExit
+          end
+        }.to output(/Sorry path_spec\.rb is not a valid directory!/).to_stdout
+      end
+
+      it "prints message when given path is a directory but no schema is found" do
+        path = Path.new(File.expand_path(File.dirname(__FILE__)) + '/support/no_schema')
+        expect {
+          begin
+            path.choose
+          rescue SystemExit
+          end
+        }.to output(/There is no/).to_stdout
+      end
+
+      context "needs user input" do
+        let(:path) { Path.new(File.expand_path(File.dirname(__FILE__)) + '/support') }
+        before do
+          allow(STDIN).to receive(:gets) { "0" }
+        end
+
+        it "prints message when given path is a directory" do
+          expect {
+            path.choose
+          }.to output(/Select a path to the target schema/).to_stdout
+        end
+      end
+
+
+    end
+  end
+end

data/spec/schema_spec.rb

@@ -0,0 +1,45 @@
+module SchemaToScaffold
+  RSpec.describe Schema do
+
+    let(:schema_data) { File.read(File.expand_path(File.dirname(__FILE__)) + '/support/schema.rb') }
+    let(:schema) { Schema.new(schema_data) }
+
+    describe ".parse" do
+      it "parses given schema file" do
+        expect(Schema.parse(schema_data)).to be_kind_of(Array)
+      end
+    end
+
+    describe "#table_names" do
+      it "returns table names" do
+        expect(schema.table_names).to eq(["users"])
+      end
+    end
+
+    describe "#to_script" do
+      it "is broken" do
+        pending
+        expect(schema.to_script).to eq("users")
+      end
+    end
+
+    describe "#table" do
+      it "returns parsed table by given table name as symbol" do
+        expect(schema.table(:users)).to be_kind_of(SchemaToScaffold::Table)
+      end
+
+      it "returns parsed table by given table index" do
+        expect(schema.table(0)).to be_kind_of(SchemaToScaffold::Table)
+      end
+
+      it "returns nil" do
+        expect(schema.table([])).to be_nil
+      end
+
+      it "returns nil" do
+        pending
+        expect(schema.table("")).to be_nil
+      end
+    end
+  end
+end

data/spec/schema_to_scaffold_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe SchemaToScaffold do
+  it "has a version number" do
+    expect(SchemaToScaffold::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "simplecov"
+SimpleCov.start 'test_frameworks'
+
+require "schema_to_scaffold"
+require "byebug"
+
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

data/spec/support/empty_schema.rb

@@ -0,0 +1,7 @@
+# random schema https://github.com/RailsApps/rails-devise-roles/blob/master/db/schema.rb
+ActiveRecord::Schema.define(version: 20140828012915) do
+
+  create_table :users, force: :cascade do |t|
+  end
+
+end

data/spec/support/schema.rb

@@ -0,0 +1,24 @@
+# random schema https://github.com/RailsApps/rails-devise-roles/blob/master/db/schema.rb
+ActiveRecord::Schema.define(version: 20140828012915) do
+
+  create_table "users", force: :cascade do |t|
+    t.string   "email",                  default: "", null: false
+    t.string   "encrypted_password",     default: "", null: false
+    t.string   "reset_password_token"
+    t.datetime "reset_password_sent_at"
+    t.datetime "remember_created_at"
+    t.integer  "sign_in_count",          default: 0,  null: false
+    t.datetime "current_sign_in_at"
+    t.datetime "last_sign_in_at"
+    t.string   "current_sign_in_ip"
+    t.string   "last_sign_in_ip"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "name"
+    t.integer  "role"
+  end
+
+  add_index "users", ["email"], name: "index_users_on_email", unique: true
+  add_index "users", ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
+
+end

data/spec/support/table.rb

@@ -0,0 +1,17 @@
+create_table "users", force: :cascade do |t|
+  t.string   "email",                  default: "", null: false
+  t.string   "encrypted_password",     default: "", null: false
+  t.string   "reset_password_token"
+  t.datetime "reset_password_sent_at"
+  t.datetime "remember_created_at"
+  t.integer  "sign_in_count",          default: 0,  null: false
+  t.datetime "current_sign_in_at"
+  t.datetime "last_sign_in_at"
+  t.string   "current_sign_in_ip"
+  t.string   "last_sign_in_ip"
+  t.datetime "created_at"
+  t.datetime "updated_at"
+  t.string   "name"
+  t.integer  "role"
+  t.index ["basket_id"], name: "index_orders_on_basket_id", using: :btree
+end

data/spec/table_spec.rb

@@ -0,0 +1,33 @@
+module SchemaToScaffold
+  RSpec.describe Table do
+
+    let(:table_data) { File.read(File.expand_path(File.dirname(__FILE__)) + '/support/table.rb') }
+    let(:email_attribute) { Attribute.new("email", "string") }
+    let(:password_attribute) { Attribute.new("password", "string") }
+
+    describe "#to_script" do
+      let(:table) { Table.new("users", [email_attribute, password_attribute]) }
+
+      it "returns rails generate line" do
+        expect(table.to_script("model", true)).to eq(["rails generate model User email:string password:string", "\n\n"])
+      end
+
+      it "returns rails generate line without migrations" do
+        expect(table.to_script("model", false)).to eq(["rails generate model User email:string password:string", " --no-migration", "\n\n"])
+      end
+
+      it "raises an exception" do
+        allow(email_attribute).to receive(:to_script).and_raise(StandardError, "something went wrong")
+        expect { table.to_script("model", true) }.to output(/something went wrong/).to_stdout
+      end
+    end
+
+    describe ".parse" do
+      let(:table) { Table.parse(table_data) }
+      it "parses given table data" do
+        expect(table).to be_kind_of(SchemaToScaffold::Table)
+      end
+    end
+
+  end
+end