thredded_create_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e789f57ed0bc72c875265424613423e3e5555f42
+  data.tar.gz: 4be5310ad208c0b2811e165759be33c79603baee
+SHA512:
+  metadata.gz: 786d97598b36481726f233146c2394a6dd819cb5e408322a4dc40b1dbd34bba68d3263b3599d4d0d28dff150f908fc7629bb7f7f6c89a767c93992d25e78b6f1
+  data.tar.gz: e72055793bcf3eddc38e1937be2cd20fd0c45d7756065ea410ce7dc4262812a36d30b9640a534cdb22c7747ebe0723d7d76d15e6d32300436547964a57a92ce0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gleb Mazovetskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# ThreddedCreateApp [![Build Status](https://travis-ci.org/thredded/thredded_create_app.svg?branch=master)](https://travis-ci.org/thredded/thredded_create_app) [![Test Coverage](https://codeclimate.com/github/thredded/thredded_create_app/badges/coverage.svg)](https://codeclimate.com/github/thredded/thredded_create_app/coverage)
+
+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:
+
+<table>
+  <tr>
+    <td><img alt="Home" src="https://cloud.githubusercontent.com/assets/216339/19858280/23072dd8-9f3e-11e6-8d71-e977a4a67f0f.png"></td>
+    <td><img alt="Sign Up" src="https://cloud.githubusercontent.com/assets/216339/19858282/231bb06e-9f3e-11e6-8e51-a293523b7034.png"></td>
+  </tr>
+  <tr>
+    <td><img alt="Messageboard" src="https://cloud.githubusercontent.com/assets/216339/19858469/c592413c-9f3e-11e6-827d-b530f3ee2850.png"></td>
+    <td><img alt="Topic" src="https://cloud.githubusercontent.com/assets/216339/19858284/232107e4-9f3e-11e6-8c5f-8a8f927f2922.png"></td>
+  </tr>
+</table>
+
+## Pre-requisites
+
+1. Git.
+2. PostgreSQL.
+3. Ruby 2.3+.
+
+## Usage
+
+Install the gem and create your app:
+
+```bash
+gem install thredded_create_app
+thredded_create_app myapp
+```
+
+Run `thredded_create_app --help` for more information about the available
+options.
+
+### RVM
+
+If you're using [RVM](https://rvm.io/), you probably want to create a
+gemset before creating your app:
+
+ ```bash
+ RUBY_VERSION=2.3.1 APP=myapp
+ rvm use --create "${RUBY_VERSION}@${APP}"
+ gem install thredded_create_app
+ thredded_create_app "$APP"
+ ```
+   
+Then, generate the `.ruby-version` and `.ruby-gemset` files so that the gemset
+is used automatically whenever you `cd` into the project directory:
+ 
+ ```bash
+ cd "$APP"
+ rvm use --ruby-version "${RUBY_VERSION}@${APP}"
+ printf '.ruby-version\n.ruby-gemset\n' >> .git/info/exclude
+ ```
+
+### App generation
+
+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 [git] repository is initialized in the app directory. From here onwards,
+the app generator will commit the changes at each step.
+
+[RSpec] is used as the testing framework, and some basic acceptance tests
+using [capybara] are added.
+
+[Devise] is used as the authentication framework. Its default views are
+customized to add a user name field (`display_name`) to the registration form.
+The [simple_form] gem is used for the customized Devise views by default.
+
+A basic responsive app layout with top bar navigation is added.
+A user profile page that displays some basic information about the user and
+their recent forum posts is also added.
+
+The app comes with basic styles (~10KiB gzipped, including Thredded styles)
+that are written using [Sass].
+
+The app's JavaScript code is loaded asynchronously in production mode via the
+[`async`] attribute on the script tag. In development, the individual script
+files are not concatenated. With `async` they would load out-of-order, so
+[`defer`] is used instead.
+
+**NB:** While loading scripts via `async` provides the best possible speed,
+a lot of JavaScript libraries do not support it.
+**If** you plan on adding JavaScript code, you might want to
+**remove the `async` attribute** from the `javascript_include_tag` in
+`app/views/layouts/application.html.erb`.
+
+A [Dockerfile] and [docker-compose.yml] is generated for development.
+This is so that other engineers can spin up a development environment with
+a single command.
+
+A production configuration file for the [puma] Ruby web server is created.
+A `Procfile` process description file that can be used by that can be used by
+the [Heroku] hosting platform or the [foreman] app runner is also be created.
+
+Lastly, the `$APP` database user is created and given rights to the app's
+development and test databases. Then, the database is created, the migrations
+are run, and the database is seeded with an admin user and a messageboard.
+
+Finally, the tests are run, and the development web server is started at
+<http://localhost:3000>.
+
+[`async`]: https://developer.mozilla.org/en/docs/Web/HTML/Element/script
+[`defer`]: https://developer.mozilla.org/en/docs/Web/HTML/Element/script
+[Bundler]: http://bundler.io/
+[capybara]: https://github.com/jnicklas/capybara
+[Devise]: https://github.com/plataformatec/devise
+[docker-compose.yml]: https://docs.docker.com/compose/
+[Dockerfile]: https://docs.docker.com/engine/reference/builder/
+[foreman]: https://ddollar.github.io/foreman/
+[git]: https://git-scm.com/
+[Heroku]: https://www.heroku.com/
+[puma]: https://github.com/puma/puma
+[Rails]: http://rubyonrails.org/
+[RSpec]: http://rspec.info/
+[Sass]: http://sass-lang.com/
+[simple_form]: https://github.com/plataformatec/simple_form
+
+### Next steps
+
+To learn about customizing the forums, see the [Thredded Readme].
+
+To learn about customizing the authentication system, e.g. to require email
+confirmation or to add an OAuth login, see the [Devise Readme].
+
+To change the homepage, edit the view file at `app/views/home/show.html.erb`.
+
+To change the app's styles, see the files in `app/assets/stylesheets`.
+The app is generated with a randomly selected primary theme color that you may
+want to change. You can find it in `app/assets/stylesheets/_variables.scss`.
+
+You can contact the Thredded team via the [Thredded chat room].
+Once you've deployed your app, please let us know that you are using Thredded
+by tweeting [@thredded]!
+
+[@thredded]: https://twitter.com/thredded
+[Devise Readme]: https://github.com/plataformatec/devise/blob/master/README.md
+[Thredded chat room]: https://gitter.im/thredded/thredded
+[Thredded Readme]: https://github.com/thredded/thredded/blob/master/README.md
+
+## Development
+
+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.
+
+To generate an app with `thredded_create_app` at `tmp/myapp`, run:
+
+```sh
+bundle exec bin/create-tmp-myapp
+```
+
+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
+[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
+[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).
+

data/exe/thredded_create_app

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+if ENV['THREDDED_CREATE_APP_BIN_SIMPLECOV_COVERAGE']
+  require_relative '../spec/simplecov_bin_helper'
+end
+
+require 'thredded_create_app/cli'
+ThreddedCreateApp::CLI.start(ARGV)

data/lib/thredded_create_app.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'thredded_create_app/version'
+
+module ThreddedCreateApp
+end

data/lib/thredded_create_app/cli.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+require 'thredded_create_app/command_error'
+require 'thredded_create_app/generator'
+require 'thredded_create_app/logging'
+
+require 'highline'
+module ThreddedCreateApp
+  class CLI
+    include ThreddedCreateApp::Logging
+
+    DEFAULTS = {
+      auto_confirm: false,
+      verbose: false,
+      install_gem_bundler_rails: true,
+      start_server: true,
+      simple_form: true
+    }.freeze
+
+    def self.start(argv)
+      new(argv).start
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def start
+      auto_output_coloring do
+        begin
+          run
+        rescue OptionParser::ParseError, ArgvError => e
+          error e.message, 64
+        rescue ThreddedCreateApp::CommandError => e
+          begin
+            error e.message, 78
+          ensure
+            log_verbose e.backtrace * "\n"
+          end
+        rescue Errno::EPIPE
+          exit 1
+        end
+      end
+    rescue ExecutionError => e
+      exit e.exit_code
+    end
+
+    private
+
+    def run # rubocop:disable Metrics/AbcSize
+      options = optparse
+      generator = ThreddedCreateApp::Generator.new(options)
+      log_info 'Will do the following:'
+      log_info generator.summary
+      exit unless options[:auto_confirm] || agree?
+      generator.generate
+      log_stderr Term::ANSIColor.bold Term::ANSIColor.bright_green <<~TEXT
+        All done! 🌟
+      TEXT
+      generator.run_tests!
+      start_app_server!(options[:app_path]) if options[:start_server]
+    end
+
+    def start_app_server!(app_path)
+      log_info 'Changing directory and starting the app server'
+      command = "cd #{Shellwords.escape(app_path)} && " \
+        'bundle exec rails s'
+      log_command command
+      if defined?(Bundler)
+        Bundler.with_clean_env { exec command }
+      else
+        exec command
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    def optparse
+      argv = @argv.dup
+      argv << '--help' if argv.empty?
+      options = DEFAULTS.dup
+      positional_args = OptionParser.new(
+        "Usage: #{program_name} #{Term::ANSIColor.bold 'APP_PATH'}", 37
+      ) do |op|
+        flags = Flags.new(op, options)
+
+        flags.bool :auto_confirm, '-y', 'Auto-confirm all prompts'
+        op.on '-v', '--version', 'Print the version' do
+          puts ThreddedCreateApp::VERSION
+          exit
+        end
+        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
+        end
+        op.separator Term::ANSIColor.bright_blue <<-TEXT
+
+For more information, see the readme at:
+    #{File.expand_path('../../README.md', File.dirname(__FILE__))}
+    https://github.com/thredded/thredded_create_app
+TEXT
+      end.parse!(argv)
+      if positional_args.length != 1
+        raise ArgvError, 'Expected 1 positional argument, ' \
+                        "got #{positional_args.length}."
+      end
+      options.update(app_path: argv[0])
+      options
+    end
+    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength,Metrics/BlockLength
+
+    class Flags
+      def initialize(op, options)
+        @op      = op
+        @options = options
+      end
+
+      # rubocop:disable Style/OptionalArguments
+      def bool(as, short = nil, long, desc)
+        flag_args = [short, long].compact
+        if long.start_with?('--[no-]')
+          desc += " (default: #{DEFAULTS[as]})" if DEFAULTS[as]
+          @op.on(*flag_args, desc) do |v|
+            @options[as] = v
+            yield v if block_given?
+          end
+        else
+          @op.on(*flag_args, desc) do
+            @options[as] = !long.start_with?('--no-')
+            yield @options[as] if block_given?
+          end
+        end
+      end
+      # rubocop:enable Style/OptionalArguments
+    end
+
+    def error(message, exit_code)
+      log_error message
+      raise ExecutionError.new(message, exit_code)
+    end
+
+    def auto_output_coloring(coloring = STDOUT.isatty)
+      coloring_was             = Term::ANSIColor.coloring?
+      Term::ANSIColor.coloring = coloring
+      HighLine.use_color       = coloring
+      yield
+    ensure
+      HighLine.use_color       = coloring_was
+      Term::ANSIColor.coloring = coloring_was
+    end
+
+    def agree?
+      ::HighLine.new.agree(
+        Term::ANSIColor.bold(Term::ANSIColor.bright_yellow('Proceed? [y/n]')),
+        true
+      )
+    end
+
+    def verbose?
+      @verbose
+    end
+
+    class ArgvError < StandardError
+    end
+
+    class ExecutionError < RuntimeError
+      attr_reader :exit_code
+
+      def initialize(message, exit_code)
+        super(message)
+        @exit_code = exit_code
+      end
+    end
+  end
+end

data/lib/thredded_create_app/command_error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ThreddedCreateApp
+  # When this type of error is caught:
+  # 1. show error message of the backtrace
+  # 2. exit with non-zero exit code
+  class CommandError < StandardError
+    # rubocop:disable Style/OptionalArguments
+    def initialize(error = nil, message)
+      super(message)
+      set_backtrace error.backtrace if error
+    end
+    # rubocop:enable Style/OptionalArguments
+  end
+end

data/lib/thredded_create_app/generator.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'shellwords'
+require 'thredded_create_app/tasks/base'
+require 'thredded_create_app/tasks/create_rails_app'
+require 'thredded_create_app/tasks/add_simple_form'
+require 'thredded_create_app/tasks/add_devise'
+require 'thredded_create_app/tasks/add_thredded'
+require 'thredded_create_app/tasks/add_display_name_to_users'
+require 'thredded_create_app/tasks/setup_database'
+require 'thredded_create_app/tasks/setup_app_skeleton'
+require 'thredded_create_app/tasks/production_configs'
+require 'thredded_create_app/tasks/docker'
+module ThreddedCreateApp
+  class Generator < Tasks::Base
+    def initialize(**options)
+      super
+      @options = options
+    end
+
+    def summary
+      tasks.map { |t| "* #{t.summary}" }.join("\n")
+    end
+
+    def generate
+      log_verbose "Started: #{inspect}"
+      FileUtils.mkdir_p(app_path)
+      in_app_env do
+        run 'git init .'
+        @tasks.each(&:before_bundle)
+        bundle
+        @tasks.each(&:after_bundle)
+      end
+    end
+
+    def run_tests!
+      log_info 'Running tests'
+      in_app_env do
+        run 'bundle exec rspec -fd'
+      end
+    end
+
+    private
+
+    def in_app_env
+      if defined?(Bundler)
+        Bundler.with_clean_env do
+          Dir.chdir app_path do
+            yield
+          end
+        end
+      else
+        Dir.chdir app_path do
+          yield
+        end
+      end
+    end
+
+    def tasks
+      @tasks ||= [
+        Tasks::CreateRailsApp,
+        (Tasks::AddSimpleForm if @options[:simple_form]),
+        Tasks::AddDevise,
+        Tasks::AddThredded,
+        Tasks::AddDisplayNameToUsers,
+        Tasks::SetupAppSkeleton,
+        Tasks::ProductionConfigs,
+        Tasks::Docker,
+        Tasks::SetupDatabase
+      ].compact.map { |task_class| task_class.new(@options) }
+    end
+
+    def gems
+      tasks.flat_map(&:gems)
+    end
+
+    # @final
+    def bundle
+      File.open('Gemfile', 'a') do |f|
+        log_info 'Writing gems to Gemfile'
+        gems.each do |(name, version, groups)|
+          f.puts ["gem '#{name}'",
+                  (version if version),
+                  ("groups: %i(#{groups * ' '})" if groups)].compact.join(', ')
+        end
+      end
+      run "bundle install#{' --quiet' unless verbose?}"
+      git_commit "Add gems: #{gems.map { |(name, *)| name } * ', '}"
+    end
+  end
+end