thredded_create_app 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e789f57ed0bc72c875265424613423e3e5555f42
-  data.tar.gz: 4be5310ad208c0b2811e165759be33c79603baee
+  metadata.gz: 0a440b54c995a4acc228ea80bc49543584a7ace8
+  data.tar.gz: 783a3ef4755e06a4e49d99ce951a56c96c247195
 SHA512:
-  metadata.gz: 786d97598b36481726f233146c2394a6dd819cb5e408322a4dc40b1dbd34bba68d3263b3599d4d0d28dff150f908fc7629bb7f7f6c89a767c93992d25e78b6f1
-  data.tar.gz: e72055793bcf3eddc38e1937be2cd20fd0c45d7756065ea410ce7dc4262812a36d30b9640a534cdb22c7747ebe0723d7d76d15e6d32300436547964a57a92ce0
+  metadata.gz: 9c531f266980d0071259f18c46093356931dd95da360a5f33a64106955789a46acba83d028d26568a74ece981f4d78115a26f0644e8eff4e778cdda963c4c52e
+  data.tar.gz: 7879d3b6eece4346ea7cc797950f56006cc4f6ff2d39a89a7307c727491dd45f696796cf5afeee34c68c5cf66636eb3cf59d1f94207f68b1ed010026c104800d

data/README.md

@@ -2,11 +2,6 @@
 
 Generates a Rails app with the [Thredded](https://github.com/thredded/thredded) forums engine installed.
 
-This generator will create a new Rails app with the following configuration:
-
-* Database: PostgreSQL.
-* Auth: Devise.
-
 See below for more information on the generated app.
 
 Example screenshots of the generated app:
@@ -25,7 +20,7 @@ Example screenshots of the generated app:
 ## Pre-requisites
 
 1. Git.
-2. PostgreSQL.
+2. A supported database: PostgreSQL (recommended), MySQL v5.6.4+, or SQLite.
 3. Ruby 2.3+.
 
 ## Usage
@@ -37,6 +32,10 @@ gem install thredded_create_app
 thredded_create_app myapp
 ```
 
+By default, PostgreSQL will be used as the database.
+Alternatively, you can pass `--database sqlite3` for SQLite,
+or `--datase mysql2` for MySQL.
+
 Run `thredded_create_app --help` for more information about the available
 options.
 
@@ -68,7 +67,7 @@ The app generator will do the steps below for you.
 First, the rubygems package is updated and the latest versions of
 [Rails] and [Bundler] are installed.
 
-Then, a Rails app is generated for use with the PostgreSQL database.
+Then, a Rails app is generated for use with the selected database.
 
 Then, a [git] repository is initialized in the app directory. From here onwards,
 the app generator will commit the changes at each step.
@@ -156,8 +155,10 @@ by tweeting [@thredded]!
 The instructions below are for developing and contributing to
 the Thredded app generator itself, not for using it.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you
+to experiment.
 
 To generate an app with `thredded_create_app` at `tmp/myapp`, run:
 
@@ -165,21 +166,26 @@ To generate an app with `thredded_create_app` at `tmp/myapp`, run:
 bundle exec bin/create-tmp-myapp
 ```
 
-This command will clean up the previously generated app before creating a new one.
+This command will clean up the previously generated app before creating
+a new one.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
-which will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/thredded/thredded_create_app.
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/thredded/thredded_create_app.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
 [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
 

data/lib/thredded_create_app/cli.rb

@@ -5,7 +5,7 @@ require 'thredded_create_app/logging'
 
 require 'highline'
 module ThreddedCreateApp
-  class CLI
+  class CLI # rubocop:disable Metrics/ClassLength
     include ThreddedCreateApp::Logging
 
     DEFAULTS = {
@@ -13,7 +13,8 @@ module ThreddedCreateApp
       verbose: false,
       install_gem_bundler_rails: true,
       start_server: true,
-      simple_form: true
+      simple_form: true,
+      database: :postgresql
     }.freeze
 
     def self.start(argv)
@@ -83,6 +84,21 @@ module ThreddedCreateApp
         flags = Flags.new(op, options)
 
         flags.bool :auto_confirm, '-y', 'Auto-confirm all prompts'
+        flags.bool :simple_form, '--[no-]simple-form', 'Use simple_form'
+
+        db_adapters = %i(postgresql mysql2 sqlite3)
+        op.on '--database DATABASE', db_adapters,
+              "The database adapter, one of: #{db_adapters.join(', ')} " \
+              "(default: #{DEFAULTS[:database]})" do |v|
+          options[:database] = v.to_sym
+        end
+
+        flags.bool :start_server, '--[no-]start-server', 'Start the app server'
+
+        flags.bool :install_gem_bundler_rails,
+                   '--[no-]install-gem-bundler-rails',
+                   'Run `gem update --system and `gem install bundler rails`'
+
         op.on '-v', '--version', 'Print the version' do
           puts ThreddedCreateApp::VERSION
           exit
@@ -90,12 +106,6 @@ module ThreddedCreateApp
         flags.bool :verbose, '--verbose', 'Verbose output' do
           @verbose = true
         end
-        flags.bool :simple_form, '--[no-]simple-form', 'Use simple_form'
-        flags.bool :install_gem_bundler_rails,
-                   '--[no-]install-gem-bundler-rails',
-                   'Run `gem update --system and `gem install bundler rails`'
-        flags.bool :start_server, '--[no-]start-server', 'Start the app server'
-
         op.on '-h', '--help', 'Show this message' do
           STDERR.puts op
           exit

data/lib/thredded_create_app/generator.rb

@@ -65,7 +65,7 @@ module ThreddedCreateApp
         Tasks::AddDisplayNameToUsers,
         Tasks::SetupAppSkeleton,
         Tasks::ProductionConfigs,
-        Tasks::Docker,
+        (Tasks::Docker if @options[:database] == :postgresql),
         Tasks::SetupDatabase
       ].compact.map { |task_class| task_class.new(@options) }
     end

data/lib/thredded_create_app/tasks/add_display_name_to_users/add_display_name_to_users.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 class AddDisplayNameToUsers < ActiveRecord::Migration[5.0]
   def up
-    add_column :users, :display_name, :text, null: false
+    case connection.adapter_name.to_s
+    when /mysql/i
+      add_column :users, :display_name, :string, limit: 191
+    when /sqlite/i
+      add_column :users, :display_name, :text
+      change_column_null :users, :display_name, false
+    else
+      add_column :users, :display_name, :text, null: false
+    end
+
     DbTextSearch::CaseInsensitive.add_index connection, :users, :display_name,
                                             unique: true
   end

data/lib/thredded_create_app/tasks/base.rb

@@ -49,7 +49,7 @@ module ThreddedCreateApp
 
       def copy_template(src_path, target_path, process_erb: true, mode: 'w')
         src = File.read(File.expand_path(src_path, File.dirname(__FILE__)))
-        src = ERB.new(src).result(binding) if process_erb
+        src = ERB.new(src, nil, '-').result(binding) if process_erb
         FileUtils.mkdir_p(File.dirname(target_path))
         File.write target_path, src, mode: mode
       end

data/lib/thredded_create_app/tasks/create_rails_app.rb

@@ -3,9 +3,10 @@ require 'thredded_create_app/tasks/base'
 module ThreddedCreateApp
   module Tasks
     class CreateRailsApp < Base
-      def initialize(install_gem_bundler_rails: false, **args)
+      def initialize(install_gem_bundler_rails:, database:, **args)
         super
         @install_gem_bundler_rails = install_gem_bundler_rails
+        @database = database
       end
 
       def summary
@@ -17,9 +18,10 @@ module ThreddedCreateApp
           run 'gem update --system --no-document --quiet'
           run 'gem install bundler rails --no-document'
         end
+        rails_database_arg = { mysql2: :mysql }.fetch(@database, @database)
         # I have no idea why this bundle exec is necessary on Travis.
         run "#{'bundle exec ' if ENV['TRAVIS']}" \
-           'rails new . --skip-bundle --database=postgresql ' \
+           "rails new . --skip-bundle --database=#{rails_database_arg} " \
            "--skip-test#{verbose? ? ' --verbose' : ' --quiet'}"
         replace 'Gemfile', /gem 'sass-rails'.*$/, "gem 'sassc-rails'"
         add_gem 'rspec-rails', groups: %i(test)

data/lib/thredded_create_app/tasks/docker.rb

@@ -2,6 +2,7 @@
 require 'thredded_create_app/tasks/base'
 module ThreddedCreateApp
   module Tasks
+    # Currently only implemented for the postgresql database.
     class Docker < Base
       def summary
         'Add Docker configuration files for development'

data/lib/thredded_create_app/tasks/setup_app_skeleton/home_show.html.erb.erb

@@ -24,6 +24,7 @@
   <hr>
   <p>Your app uses:</p>
   <ul>
+    <li><%%= ActiveRecord::Base.connection.adapter_name %> database.</li>
     <li>
       <a href="http://rubyonrails.org/">Ruby on Rails</a>
       v<%%= Rails::VERSION::STRING %>.

data/lib/thredded_create_app/tasks/setup_database.rb

@@ -3,6 +3,12 @@ require 'thredded_create_app/tasks/base'
 module ThreddedCreateApp
   module Tasks
     class SetupDatabase < Base
+      # @param [:postgresql, :mysql2, :sqlite3] database the DB db_adapter name.
+      def initialize(database:, **_args)
+        super
+        @db_adapter = database
+      end
+
       def summary
         'Create the database user, configure database.yml, and run migrations'
       end
@@ -19,15 +25,22 @@ module ThreddedCreateApp
       private
 
       def create_db_user
+        return if @db_adapter == :sqlite3
         log_info "Creating #{dev_user} local database user"
         run 'bash',
             File.join(File.dirname(__FILE__), 'setup_database',
-                      'create_postgresql_user.sh'),
+                      'create_database_user.sh'),
+            @db_adapter.to_s,
+            app_name,
             dev_user,
             dev_user_password,
+            ENV['TRAVIS'] || '',
             log: false
       end
 
+      # @return [Symbol]
+      attr_reader :db_adapter
+
       def dev_user
         "#{app_name}_dev"
       end

data/lib/thredded_create_app/tasks/setup_database/create_database_user.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+DB="$1"
+APP_NAME="$2"
+USER="$3"
+PASS="$4"
+TRAVIS="$5"
+
+BLUE='\033[1;34m'
+RESET_COLOR='\033[0m'
+log() { if [ -t 1 ]; then echo -e >&2 "${BLUE} $@${RESET_COLOR}"; else echo >&2 "$@"; fi }
+
+set -e
+
+create_postgresql_user() {
+  if PGPASSWORD="$PASS" psql -h 127.0.0.1 postgres -U $USER -c '' 2>/dev/null; then return; fi
+  log "Creating Postgres '$USER' user."
+  local cmd='psql postgres'
+  if ! $cmd -c '' 2>/dev/null; then
+    log 'Using sudo'
+    cmd="sudo -u ${PG_DAEMON_USER:-postgres} psql postgres"
+  fi
+  $cmd --quiet <<SQL
+CREATE ROLE $USER LOGIN PASSWORD '$PASS';
+ALTER ROLE $USER CREATEDB;
+SQL
+}
+
+create_mysql_user() {
+  if mysql -s -u"$USER" -p"$PASS" -e '' 2>/dev/null ; then return; fi
+  log "Creating MySQL '$USER' user. MySQL root password required."
+  local mysql_flags='-p'
+  if [ -n "$TRAVIS" ]; then
+    mysql_flags=''
+  fi
+  mysql --verbose -uroot $mysql_flags <<SQL
+GRANT ALL PRIVILEGES ON \`${APP_NAME}_dev\`.* TO '$USER'@'localhost' IDENTIFIED BY '$PASS';
+GRANT ALL PRIVILEGES ON \`${APP_NAME}_test\`.* TO '$USER'@'localhost';
+SQL
+}
+
+if [ "$DB" = 'mysql2' ]; then
+ create_mysql_user || echo 'Error'
+elif [ "$DB" = 'postgresql' ]; then
+  create_postgresql_user || echo 'Error'
+fi

data/lib/thredded_create_app/tasks/setup_database/database.yml.erb

@@ -1,6 +1,8 @@
 <%%
+<% if db_adapter != :sqlite3 -%>
 db_host    = ENV.fetch('DB_HOST', ENV.fetch('<%= app_name.upcase %>_DB_1_PORT_5432_TCP_ADDR', 'localhost'))
-db_port    = ENV['<%= app_name.upcase %>_DB_1_PORT_5432_TCP_PORT'] || ENV['DB_PORT'] || 5432
+db_port    = ENV['<%= app_name.upcase %>_DB_1_PORT_5432_TCP_PORT'] || ENV['DB_PORT'] || <%= {postgresql: 5432, mysql2: 3306}[db_adapter] %>
+<% end -%>
 require 'etc'
 pool_size =
   # Web: max workers * max threads
@@ -11,26 +13,37 @@ ERB
 %>
 
 defaults: &defaults
-  host: <%%= db_host %>
-  port: <%%= db_port %>
-  adapter: postgresql
-  encoding: utf8
+  adapter: <%= db_adapter %>
   min_messages: WARNING
   pool: <%%= pool_size %>
+<% if db_adapter == :sqlite3 -%>
+  timeout: 5000
+<% else -%>
+  host: <%%= db_host %>
+  port: <%%= db_port %>
   username: <%%= ENV.fetch('DB_USERNAME', '<%= dev_user %>').inspect %>
   password: <%%= ENV.fetch('DB_PASSWORD', <%= dev_user_password.inspect %>).inspect %>
+<% end -%>
+<% if db_adapter == :mysql2 -%>
+  encoding: utf8mb4
+  charset: utf8mb4
+  collation: utf8mb4_unicode_ci
+<% else -%>
+  encoding: utf8
+<% end -%>
 
 development:
   <<: *defaults
-  database: <%= "#{app_name}_dev" %>
+  database: <%= db_adapter == :sqlite3 ? 'db/development.sqlite3' : "#{app_name}_dev" %>
 
 test:
   <<: *defaults
-  database: <%= "#{app_name}_test" %>
+  database: <%= db_adapter == :sqlite3 ? 'db/test.sqlite3' : "#{app_name}_test" %>
+
 
 production:
   <<: *defaults
   encoding: utf8
   min_messages: WARNING
   url: <%%= ENV['DATABASE_URL'].inspect if ENV['DATABASE_URL'] %>
-  database: <%%= '<%= "#{app_name}_prod" %>' unless ENV['DATABASE_URL'] %>
+  database: <%%= '<%= (db_adapter == :sqlite3 ? 'db/production.sqlite3' : "#{app_name}_prod") %>' unless ENV['DATABASE_URL'] %>

data/lib/thredded_create_app/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThreddedCreateApp
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thredded_create_app
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -145,7 +145,7 @@ files:
 - lib/thredded_create_app/tasks/setup_app_skeleton/spec/features/homepage_spec.rb
 - lib/thredded_create_app/tasks/setup_app_skeleton/users_show.html.erb
 - lib/thredded_create_app/tasks/setup_database.rb
-- lib/thredded_create_app/tasks/setup_database/create_postgresql_user.sh
+- lib/thredded_create_app/tasks/setup_database/create_database_user.sh
 - lib/thredded_create_app/tasks/setup_database/database.yml.erb
 - lib/thredded_create_app/version.rb
 homepage: https://github.com/thredded/thredded_create_app

data/lib/thredded_create_app/tasks/setup_database/create_postgresql_user.sh

@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-USER="$1"
-PASS="$2"
-
-BLUE='\033[1;34m'
-RESET_COLOR='\033[0m'
-log() { if [ -t 1 ]; then echo -e >&2 "${BLUE} $@${RESET_COLOR}"; else echo >&2 "$@"; fi }
-
-set -e
-
-create_postgresql_user() {
-  if PGPASSWORD="$PASS" psql -h 127.0.0.1 postgres -U $USER -c '' 2>/dev/null; then return; fi
-  log "Creating Postgres '$USER' user."
-  local cmd='psql postgres'
-  if ! $cmd -c '' 2>/dev/null; then
-    log 'Using sudo'
-    cmd="sudo -u ${PG_DAEMON_USER:-postgres} psql postgres"
-  fi
-  $cmd --quiet <<SQL
-CREATE ROLE $USER LOGIN PASSWORD '$PASS';
-ALTER ROLE $USER CREATEDB;
-SQL
-}
-
-create_postgresql_user