generic_app 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2972e76351f3b8ab62fa84d526f3d7524f6bd5dc
-  data.tar.gz: 42782b747f14674f5e7ea58ee6ec5610724b8736
+  metadata.gz: c93913b447f4225b2cbb08783ed9f13377f41d66
+  data.tar.gz: 5f00d06f9db717dec4363e26dcb303bb5202cc51
 SHA512:
-  metadata.gz: fd40441c4160b26e517a4af156097f104a0d757a2876b9611a1199524a18a641b6b727e280d15f9784921aadb48bcb6a9aaf68962e1a8bfac2482fc45ea2f68b
-  data.tar.gz: 13a42da2ba24c30517269cac00b7475b75c7c7365ae8d24b7edc39e822d3b8030f3af4188bb622a934b5e2bbad3b6ae07083b43fb2fe5bd6349502e8af9bccf6
+  metadata.gz: 6f345adb80df2c600c3bca20b965f29732643d0fd7fbce1a751a4a46572f03061b86b8ffb6308594c25e35d444a226b4a9304ca5190c250e22c25d90a812b98f
+  data.tar.gz: b0e94ff588828906bfe7b7fb0f015f48df3c51e2f92db87ddb95653d0b4f4250c871e702fa5b2938c75742a4a2fc9914e55c315a0dabce9b5cd087a6a483e81c

data/.rubocop.yml

@@ -1,8 +1,18 @@
+AllCops:
+  Exclude:
+    - tmp/vulnerabilities/*
+    - tmp/vulnerabilities/lib/*
+    - tmp/vulnerabilities/spec/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/lib/generic_app_spec.rb
+
 Metrics/LineLength:
   Exclude:
     - generic_app.gemspec
     - lib/generic_app.rb
-    - spec/lib/1_sqlite_spec.rb
+    - spec/lib/generic_app_spec.rb
 
 Metrics/MethodLength:
   Exclude:
@@ -11,3 +21,6 @@ Metrics/MethodLength:
 Style/RedundantSelf:
   Exclude:
     - lib/generic_app.rb
+
+Style/VariableNumber:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+ - "2.4.0"
+ - "2.3.3"
  - "2.2"
  - "2.1"
  - "2.0"

data/all.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+mkdir -p log
+FILE_TEST_GEM='log/1-test-gem.log'
+FILE_TEST_CODE='log/2-test-code.log'
+FILE_INSTALL_GEM='log/3-install-gem.log'
+sh gem_test.sh 2>&1 | tee $FILE_TEST_GEM
+sh code_test.sh 2>&1 | tee $FILE_TEST_CODE
+sh gem_install.sh 2>&1 | tee $FILE_INSTALL_GEM
+
+echo 'Results are logged in:'
+echo $FILE_TEST_GEM
+echo $FILE_TEST_CODE
+echo $FILE_INSTALL_GEM
+echo
+echo 'Gemsurance Report: log/gemsurance_report.html'
+echo 'Gem dependency diagram: log/diagram-gems.svg'

data/bin/generic_app

@@ -30,13 +30,14 @@ email = get_input(default_email)
 
 GenericApp.create_new(subdir_name, email)
 
-puts '*********************************************'
-puts "BEGIN TESTING THE #{subdir_name} RAILS APP"
-system("cd #{subdir_name} && sh build_fast.sh")
-puts "FINISHED TESTING THE #{subdir_name} RAILS APP"
-puts '*********************************************'
-
-puts "Your new Rails app has been created at #{ENV['PWD']}/#{subdir_name} ."
+puts '******************************************************'
+puts "BEGIN TESTING AND SEEDING THE #{subdir_name} RAILS APP"
+system("cd #{subdir_name} && sh all.sh")
+puts "FINISHED TESTING AND SEEDING THE #{subdir_name} RAILS APP"
+puts '*********************************************************'
+
+puts 'Your new Rails app has been created, tested, outlined and seeded at'
+puts "#{ENV['PWD']}/#{subdir_name} ."
 puts 'It is currently configured to use the SQLite database in the'
 puts 'development environment.'
 puts 'To set up the PostgreSQL database, enter the'
@@ -44,3 +45,7 @@ puts "#{ENV['PWD']}/#{subdir_name} directory and enter the command"
 puts 'sh pg-setup.sh .'
 puts 'Please note that the rails, pg, and nokogiri gems may be outdated.'
 puts 'You should update these gem versions in the Gemfile.'
+puts
+puts 'There is a list of things to do at'
+puts "#{ENV['PWD']}/#{subdir_name}/README-to_do.txt"
+puts

data/code_test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+DIR_PARENT="${PWD%/*}"
+DIR_TMP="$DIR_PARENT/tmp"
+mkdir -p log
+rm -rf tmp
+
+echo '--------------'
+echo 'bundle install'
+bin/setup >/dev/null
+
+echo
+echo '----------'
+echo 'rubocop -D'
+rubocop -D
+
+echo
+echo '-----------'
+echo 'sandi_meter'
+sandi_meter
+
+echo
+echo '------------'
+echo 'bundle-audit'
+bundle-audit
+
+echo '----------------------------------------------'
+echo 'gemsurance --output log/gemsurance_report.html'
+gemsurance --output log/gemsurance_report.html
+echo 'Gemsurance Report: log/gemsurance_report.html'
+
+echo '------------------------------------------------------------------------'
+echo 'bundle viz --file=log/diagram-gems --format=svg --requirements --version'
+bundle viz --file=log/diagram-gems --format=svg --requirements --version
+echo 'Gem dependency diagram: log/diagram-gems.svg'

data/credentials.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+# This script provides one-stop shopping for entering your credentials.
+# Please run this script when you reset the Docker container.
+# The "git commit" command will not work without your Git credentials.
+
+# Output:
+# First argument if it is not blank
+# Second argument if first argument is blank
+anti_blank () {
+  if [ -z "$1" ]; then
+    echo "$2"
+  else
+    echo "$1"
+  fi
+}
+
+echo '***********************'
+echo 'SETTING GIT CREDENTIALS'
+EMAIL_DEF='you@example.com'
+
+echo
+echo "Default email address: ${EMAIL_DEF}"
+echo
+echo 'Enter your Git email address:'
+read EMAIL_SEL
+EMAIL=$(anti_blank $EMAIL_SEL $EMAIL_DEF)
+echo
+
+echo
+echo '------------------------------'
+echo "git config --global user.email"
+echo "$EMAIL"
+git config --global user.email "$EMAIL"
+
+NAME_DEF='Your Name'
+echo
+echo "Default name: ${NAME_DEF}"
+echo
+echo 'Enter your Git name:'
+read NAME_SEL
+
+# NOTE: The double quotes are needed to avoid truncating the string
+# at the space.
+NAME=$(anti_blank "$NAME_SEL" "$NAME_DEF")
+
+echo
+echo '-----------------------------'
+echo "git config --global user.name"
+echo "$NAME"
+git config --global user.name "$NAME"
+echo

data/gem_test.sh

@@ -5,61 +5,19 @@ DIR_GENERIC_APP=$PWD
 DIR_PARENT="${PWD%/*}" 
 mkdir -p log
 
-echo '**************'
+echo '=============='
 echo 'bundle install'
 bin/setup >/dev/null
 
-echo '*************************'
-echo 'BEGIN TESTING generic_app'
-rake 2>&1 | tee $DIR_GENERIC_APP/log/generic_app-rake_test.txt
-echo 'FINISHED TESTING generic_app'
-echo '****************************'
+echo '=================='
+echo 'BEGIN PART 1: rake'
+rake
+echo 'FINISHED PART 1: rake'
+echo '====================='
 echo 
-echo '****************************************'
-echo 'BEGIN TESTING generic_app - code quality'
-rubocop 2>&1 | tee $DIR_GENERIC_APP/log/generic_app-rubocop.txt
-echo 'FINISHED TESTING generic_app - code quality'
-echo '*******************************************'
-echo
-echo '************************************'
-echo 'BEGIN TEST 1A: SQLite, build_fast.sh'
-cd $DIR_PARENT/tmp1 && spring stop 
-cd $DIR_PARENT/tmp1 && sh build_fast.sh 2>&1 | tee $DIR_GENERIC_APP/log/tmp1A.txt 
-echo 'FINISHED TEST1A'
-echo '***************'
-echo ''
-echo '***********************************'
-echo 'BEGIN TEST 1B: SQLite, test_code.sh'
-printf 'y\n' | cd $DIR_PARENT/tmp1 && sh test_code.sh 2>&1 | tee $DIR_GENERIC_APP/log/tmp1B.txt 
-echo 'FINISHED TEST 1B'
-echo '****************'
-
-echo '*************************************'
-echo 'BEGIN TEST 2A: PostgreSQL, pg-test.sh'
-printf 'y\n' | cd $DIR_PARENT/tmp1 && sh pg-test.sh auto 2>&1 | tee $DIR_GENERIC_APP/log/tmp2A.txt
-echo 'FINISHED TEST 2A'
-echo '****************'
-
-echo '***************************************'
-echo 'BEGIN TEST 2B: PostgreSQL, test_code.sh'
-cd $DIR_PARENT/tmp1 && sh test_code.sh auto 2>&1 | tee $DIR_GENERIC_APP/log/tmp2B.txt
-echo "\n"
-echo 'FINISHED TEST 2B'
-echo '****************'
-
-echo
-echo '***********************************'
-echo 'The locations of the test logs are:'
-echo "GEM TEST: $DIR_GENERIC_APP/log/generic_app-rake_test.txt"
-echo "GEM TEST - code quality: $DIR_GENERIC_APP/log/generic_app-rubocop.txt"
-echo "TEST 1A (SQLite, build_fast.sh): $DIR_GENERIC_APP/log/tmp1A.txt"
-echo "TEST 1B (SQLite, test_code.sh): $DIR_GENERIC_APP/log/tmp1B.txt"
-echo "TEST 2A (PostgreSQL, pg-test.sh): $DIR_GENERIC_APP/log/tmp2A.txt"
-echo "TEST 2B (PostgreSQL, test_code.sh): $DIR_GENERIC_APP/log/tmp2B.txt"
-
-echo
-echo 'If all went well, the results at the end of tests 1A and 2A show 0 failures and 0 errors.'
-echo 'Please note that in tests 1B and 2B, bundle-audit will flag violations due to outdated'
-echo 'rails, pg, and nokogiri gems.'
-echo 'It is up to the user to update these gems upon creating a new Rails project.'
+echo '========================'
+echo 'BEGIN PART 2: rubocop -D'
+rubocop -D
+echo 'FINISHED PART 2: rubocop -D'
+echo '==========================='
 echo

data/generic_app.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'string_in_file'
   spec.add_runtime_dependency 'line_containing'
+  spec.add_runtime_dependency 'remove_double_blank'
 end

data/lib/generic_app/git_clone_url.txt

@@ -0,0 +1 @@
+https://github.com/jhsu802701/generic-rails-2017-01-10-2332.git

data/lib/generic_app/version.rb

@@ -1,3 +1,3 @@
 module GenericApp
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/generic_app.rb

@@ -3,9 +3,10 @@
 require 'generic_app/version'
 require 'string_in_file'
 require 'line_containing'
+require 'remove_double_blank'
 
-ENV['DIR_MAIN'] = File.expand_path('../../', __FILE__)
-ENV['DIR_PARENT'] = File.expand_path('../../../', __FILE__)
+DIR_MAIN = File.expand_path('../../', __FILE__)
+DIR_PARENT = File.expand_path('../../../', __FILE__)
 
 #
 module GenericApp
@@ -13,20 +14,41 @@ module GenericApp
   def self.create_new(subdir_name, email)
     t1 = Thread.new { self.git_clone(subdir_name) }
     t1.join
+    self.remove_heroku_name(subdir_name)
     self.email_update(subdir_name, email)
+    self.remove_badges(subdir_name)
     self.git_init(subdir_name)
   end
 
+  def self.remove_heroku_name(subdir_name)
+    File.delete("#{subdir_name}/config/heroku_name.txt")
+  end
+
   def self.git_clone(subdir_name)
     puts '------------------------------------'
     puts 'Downloading the Generic App Template'
-    system("git clone https://github.com/jhsu802701/generic_app_template.git #{subdir_name}")
+    url_template = StringInFile.read("#{DIR_MAIN}/lib/generic_app/git_clone_url.txt")
+    system("git clone #{url_template} #{subdir_name}")
   end
 
   def self.email_update(subdir_name, email)
-    email_orig = 'please-change-me-at-config-initializers-devise@example.com'
-    path_of_email = "#{subdir_name}/config/initializers/devise.rb"
-    StringInFile.replace(email_orig, email, path_of_email)
+    email_orig = 'somebody@rubyonracetracks.com'
+    path_of_email_1 = "#{subdir_name}/config/initializers/devise.rb"
+    path_of_email_2 = "#{subdir_name}/app/views/static_pages/contact.html.erb"
+    path_of_email_3 = "#{subdir_name}/test/integration/static_pages_test.rb"
+    StringInFile.replace(email_orig, email, path_of_email_1)
+    StringInFile.replace(email_orig, email, path_of_email_2)
+    StringInFile.replace(email_orig, email, path_of_email_3)
+  end
+
+  def self.remove_badges(subdir_name)
+    path_readme = "#{subdir_name}/README.md"
+    line1 = 'BEGIN: continuous integration badges'
+    line2 = 'END: continuous integration badges'
+    LineContaining.delete_between(line1, line2, path_readme)
+    LineContaining.delete(line1, path_readme)
+    LineContaining.delete(line2, path_readme)
+    RemoveDoubleBlank.update(path_readme)
   end
 
   def self.git_init(subdir_name)

data/spec/lib/generic_app_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'generic_app'
+require 'string_in_file'
+
+dir_parent = File.expand_path('../../../../', __FILE__)
+dir_app_1 = "#{dir_parent}/tmp1"
+
+describe GenericApp do
+  it 'New Rails app' do
+    puts
+    puts '**************'
+    puts 'CREATING APP 1'
+    puts 'New Rails app'
+    system("rm -rf #{dir_app_1}")
+    Dir.chdir(dir_parent) do
+      GenericApp.create_new('tmp1', '007@railstutorial.org')
+    end
+  end
+
+  it 'config/heroku_name.txt should be removed' do
+    expect(File.exist?("#{dir_app_1}/config/heroku_name.txt")).to eq(false)
+  end
+
+  it 'Email address should be updated' do
+    expect(StringInFile.present('007@railstutorial.org', "#{dir_app_1}/config/initializers/devise.rb")).to eq(true)
+    expect(StringInFile.present('007@railstutorial.org', "#{dir_app_1}/app/views/static_pages/contact.html.erb")).to eq(true)
+    expect(StringInFile.present('007@railstutorial.org', "#{dir_app_1}/test/integration/static_pages_test.rb")).to eq(true)
+  end
+
+  it 'Badges should be removed from README.md' do
+    expect(StringInFile.present('continuous integration badges', "#{dir_app_1}/README.md")).to eq(false)
+    expect(StringInFile.present('[CircleCI]', "#{dir_app_1}/README.md")).to eq(false)
+    expect(StringInFile.present('[Dependency Status]', "#{dir_app_1}/README.md")).to eq(false)
+    expect(StringInFile.present('[security]', "#{dir_app_1}/README.md")).to eq(false)
+    expect(StringInFile.present('[Code Climate]', "#{dir_app_1}/README.md")).to eq(false)
+  end
+
+  it 'New README.md file should be provided' do
+    expect(StringInFile.present('Generic App Template', "#{dir_app_1}/README.md")).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'spec_helper'
 
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+# require 'codeclimate-test-reporter'
+# CodeClimate::TestReporter.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_app
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Hsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: remove_double_blank
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Instead of creating your Rails app from scratch, start with a generic
   app.
 email:
@@ -98,14 +112,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- all.sh
 - bin/generic_app
 - bin/setup
+- code_test.sh
+- credentials.sh
 - gem_install.sh
 - gem_test.sh
 - generic_app.gemspec
 - lib/generic_app.rb
+- lib/generic_app/git_clone_url.txt
 - lib/generic_app/version.rb
-- spec/lib/1_sqlite_spec.rb
+- spec/lib/generic_app_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jhsu802701/generic_app
 licenses:
@@ -127,10 +145,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Save time by instantly create a generic Rails app.
 test_files:
-- spec/lib/1_sqlite_spec.rb
+- spec/lib/generic_app_spec.rb
 - spec/spec_helper.rb

data/spec/lib/1_sqlite_spec.rb

@@ -1,71 +0,0 @@
-require 'spec_helper'
-require 'generic_app'
-require 'string_in_file'
-
-dir_app_1 = "#{ENV['DIR_PARENT']}/tmp1"
-
-describe GenericApp do
-  it 'New Rails app' do
-    puts
-    puts '**************'
-    puts 'CREATING APP 1'
-    puts 'New Rails app'
-    system("rm -rf #{dir_app_1}")
-    Dir.chdir(ENV['DIR_PARENT']) do
-      GenericApp.create_new('tmp1', '007@railstutorial.org')
-    end
-  end
-
-  it 'Email address should be updated' do
-    expect(StringInFile.present('007@railstutorial.org', "#{dir_app_1}/config/initializers/devise.rb")).to eq(true)
-  end
-
-  it 'Bash scripts should be provided' do
-    expect(StringInFile.present('heroku run rake db:migrate', "#{dir_app_1}/heroku_upload.sh")).to eq(true)
-    expect(StringInFile.present('pkill', "#{dir_app_1}/kill_spring.sh")).to eq(true)
-    expect(StringInFile.present('tree app/controllers', "#{dir_app_1}/outline.sh")).to eq(true)
-    expect(StringInFile.present('rails console --sandbox', "#{dir_app_1}/sandbox.sh")).to eq(true)
-    expect(StringInFile.present('rake db:seed', "#{dir_app_1}/seed.sh")).to eq(true)
-    expect(StringInFile.present('rails server -b 0.0.0.0', "#{dir_app_1}/server.sh")).to eq(true)
-    expect(StringInFile.present('bundle install', "#{dir_app_1}/build_fast.sh")).to eq(true)
-  end
-
-  it 'New README.md file should be provided' do
-    expect(StringInFile.present('outline.sh', "#{dir_app_1}/README.md")).to eq(true)
-  end
-
-  it 'Guardfile should be set to automatically run tests upon startup' do
-    expect(StringInFile.present('all_on_start: true', "#{dir_app_1}/Guardfile")).to eq(true)
-  end
-
-  it 'The .gitignore file includes tmp, tmp*, and ,DS_Store' do
-    expect(StringInFile.present('tmp', "#{dir_app_1}/.gitignore")).to eq(true)
-    expect(StringInFile.present('tmp*', "#{dir_app_1}/.gitignore")).to eq(true)
-    expect(StringInFile.present('.DS_Store', "#{dir_app_1}/.gitignore")).to eq(true)
-    expect(StringInFile.present('notes/*.dot', "#{dir_app_1}/.gitignore")).to eq(true)
-    expect(StringInFile.present('notes/*.svg', "#{dir_app_1}/.gitignore")).to eq(true)
-    expect(StringInFile.present('gemsurance_report.html', "#{dir_app_1}/.gitignore")).to eq(true)
-  end
-
-  it 'The notes/1-file_list-controllers.txt file should be in place' do
-    expect(StringInFile.present('users_controller_test.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('users_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('confirmations_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('omniauth_callbacks_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('passwords_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('registrations_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('sessions_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-    expect(StringInFile.present('unlocks_controller.rb', "#{dir_app_1}/notes/1-file_list-controllers.txt")).to eq(true)
-  end
-
-  it 'The notes/1-file_list-misc.txt file should be in place' do
-    expect(StringInFile.present('application_helper.rb', "#{dir_app_1}/notes/1-file_list-helpers.txt")).to eq(true)
-  end
-
-  it 'The notes/1-file_list-models.txt file should be in place' do
-    expect(StringInFile.present('admin_test.rb', "#{dir_app_1}/notes/1-file_list-models.txt")).to eq(true)
-    expect(StringInFile.present('user_test.rb', "#{dir_app_1}/notes/1-file_list-models.txt")).to eq(true)
-    expect(StringInFile.present('admin.rb', "#{dir_app_1}/notes/1-file_list-models.txt")).to eq(true)
-    expect(StringInFile.present('user.rb', "#{dir_app_1}/notes/1-file_list-models.txt")).to eq(true)
-  end
-end