react-rails-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8e040cc4f348c9b64edcdc489d99f33ec3a6a86ada5d03fda56dd1f166d17b7
-  data.tar.gz: 339ea45fa23108317cf96be0d3158cd5cbf6882bfbe560c5bf82ce326c7b9f0b
+  metadata.gz: 7963e08485a82f7460f4919020848425e5f18884037db56d0915f678bc414b5e
+  data.tar.gz: cbfa97efba5b75f73487e25188627ccd0ae807649c0db1a86db49bfd92ded5ef
 SHA512:
-  metadata.gz: ba8f977ef5d5abe841a7bdc9740f14aea92647cc94e9be1cf265e0e455ab14b52df2afd7184700549f1d37f96bf88dc8e7fca0d7a82b4ca0adaacd355de297b4
-  data.tar.gz: b22775270e2e52638178ed3b6d62beca19ecb0dc33f212ce93b4906e80c1f2f9212302267f80347b3af0061c5e8400c189a221c85dfda6dc04ea3ce26f44a5ff
+  metadata.gz: e10164463b98a983115614244f8660b64fb58b600c696dd23f2ac5e4386fe141cafddcbb81234f1eb445671ffcaea1839f73e30103bcbf5cfe0052b31965df43
+  data.tar.gz: 6dae3bc0c8ef08f6646e86f7c2f2e2ef2c50376deb5ec222f2f77a030c021d56074fc25b87c3b6552533a6e9e28144ab1e73a624f6d90c5f8da33e568e10343a

data/README.md

@@ -1,4 +1,4 @@
-[![Ruby Version](https://img.shields.io/badge/ruby-~%3E%202.5-red.svg)]()
+[![Ruby Version](https://img.shields.io/badge/ruby-~%3E%202.5-red.svg)](https://github.com/eonu/react-rails-api/blob/38f50a1d30f33cf7b818a5c939fe5d99c1a758a2/react-rails-api.gemspec#L20)
 [![Gem](https://img.shields.io/gem/v/react-rails-api.svg)](https://rubygems.org/gems/react-rails-api)
 [![License](https://img.shields.io/github/license/eonu/react-rails-api.svg)](https://github.com/eonu/react-rails-api/blob/master/LICENSE)
 
@@ -6,14 +6,12 @@
 
 All-in-one application generator enabling the integration of a React front-end and a Ruby-on-Rails API back-end with a CMS via ActiveAdmin.
 
----
-
 <p align="center">
-    <img width="600px" src="https://i.ibb.co/9y3jyBK/react-rails-api.png">
+    <img width="500px" src="https://i.ibb.co/9y3jyBK/react-rails-api.png">
     <p align="center"><em>Image courtesy of <a href="https://heroku.com">Heroku</a>.</em></p>
 </p>
 
-This is an easy-to-use generator to implement the modern web application stack described [here](https://blog.heroku.com/a-rock-solid-modern-web-stack), by Heroku designer Charlie Gleason.
+This is an easy-to-use generator to implement the modern web application stack described [here](https://blog.heroku.com/a-rock-solid-modern-web-stack) by Heroku designer Charlie Gleason.
 
 ## Requirements
 
@@ -32,13 +30,40 @@ $ gem install react-rails-api
 
 ```bash
 $ react-rails
-
-Commands:
-  react-rails new [PATH]  # Initialise a React/Rails API application.
+Usage:
+  react-rails new [PATH]
 
 Options:
   [--database], [--no-database]  # Integrate ActiveRecord (and Postgres).
                                  # Default: true
+
+Initialise a React/Rails API application.
 ```
 
-If the `--database` flag is set to true (which is the default), a prompt will also ask if you'd like to integrate [ActiveAdmin](https://activeadmin.info/) into the application.
+### Creating an application
+
+```bash
+$ react-rails new demo-app
+```
+
+If the `--database` flag is set to true (which is the default), a prompt will also ask if you'd like to integrate [ActiveAdmin](https://activeadmin.info/) into the application.
+
+If you would not like to integrate ActiveRecord (and a Postgres database), make sure to use the `--no-database` flag:
+
+```bash
+$ react-rails new demo-app --no-database
+```
+
+### Running an application
+
+There are two `rake` tasks that allow you to run development and production builds of an application (using [Foreman](https://github.com/ddollar/foreman)):
+
+- `start:development` - Starts a development build of the application (running `Procfile.dev`).
+- `start:production` - Starts a production build of the application (running `Procfile`).
+
+## More information
+
+For more information about how to use this stack, please read the following blog posts by Charlie Gleason:
+
+- https://blog.heroku.com/a-rock-solid-modern-web-stack
+- https://medium.com/superhighfives/a-top-shelf-web-stack-rails-5-api-activeadmin-create-react-app-de5481b7ec0b

data/bin/react-rails

@@ -1,3 +1,8 @@
 #!/usr/bin/env ruby
 require 'react-rails-api'
-ReactRailsAPI::CLI.start
+
+if ARGV.empty? || (ARGV.size == 1 && ARGV.first == '-h')
+  ReactRailsAPI::CLI.start %w[-h new]
+else
+  ReactRailsAPI::CLI.start
+end

data/lib/react-rails-api/cli.rb

@@ -4,9 +4,8 @@ require_relative 'version'
 class ReactRailsAPI::CLI < Thor
   TEMPLATE = File.join __dir__, 'template.rb'
 
-  class_option :database, type: :boolean, :desc => "Integrate ActiveRecord (and Postgres).", default: true
-
-  desc 'new [PATH]', "\e[90mInitialise a React/Rails API application.\e[0m"
+  method_option :database, type: :boolean, desc: 'Integrate ActiveRecord (and Postgres).', default: true
+  desc "new [\e[1mPATH\e[0m]", "\e[90mInitialise a React/Rails API application.\e[0m"
   def new(path)
     opts = default_options
     opts << '--database=postgresql' if options[:database]
@@ -16,31 +15,11 @@ class ReactRailsAPI::CLI < Thor
   end
 
   map %w[--version -v] => :version
-  desc 'version, -v', "\e[90mDisplay installed react-rails version.\e[0m"
+  desc '-v', "\e[90mDisplay installed React/Rails API gem version.\e[0m"
   def version
     puts ReactRailsAPI::VERSION
   end
 
-  def self.help(shell, subcommand = false)
-    list = printable_commands(true, subcommand)
-    Thor::Util.thor_classes_in(self).each do |klass|
-      list += klass.printable_commands(false)
-    end
-    list.sort! { |a, b| a[0] <=> b[0] }
-    list.reject! { |e| /.*help.*/.match? e.first }
-    list.map! {|c| c.map {|s| s.gsub('decrypt', ?d).gsub('encrypt', ?e)} }
-
-    if defined?(@package_name) && @package_name
-      shell.say "#{@package_name} commands:"
-    else
-      shell.say "Commands:"
-    end
-
-    shell.print_table(list, :indent => 2, :truncate => true)
-    shell.say
-    class_options_help(shell)
-  end
-
   no_tasks do
     def default_options
       %w[

data/lib/react-rails-api/template.rb

@@ -10,6 +10,7 @@ puts if database
 gem_group :development, :test do
   gem 'rspec-rails'
   gem 'sqlite3', '~> 1.3.6'
+  gem 'foreman', '~> 0.85.0'
 end
 
 gem_group :production do
@@ -105,9 +106,11 @@ after_bundle do
   inside 'client' do
     # Add a proxy for the Rails API server (on the client)
     inject_into_file 'package.json', "  \"proxy\": \"http://localhost:3001\",\n", after: "\"version\": \"0.1.0\",\n"
+    # Add environment variable for skipping preflight checks (client-level)
+    file '.env', template('.env.tt')
   end
 
-  # Add environment variable for skipping preflight checks
+  # Add environment variable for skipping preflight checks (top-level)
   file '.env', template('.env.tt')
 
   # Prevent out-of-date yarn package errors

data/lib/react-rails-api/templates/package.json.tt

@@ -8,6 +8,6 @@
   "scripts": {
     "build": "yarn --cwd client install && yarn --cwd client build",
     "deploy": "cp -a client/build/. public/",
-    "heroku-postbuild": "yarn build && yarn deploy"
+    "postinstall": "yarn build && yarn deploy"
   }
 }

data/lib/react-rails-api/templates/routes.rb.tt

@@ -1,5 +1,5 @@
 
-  scope '/api' do
+  scope :api do
     # Register your API resources here after scaffolding them e.g.
     # resources :products
     # resources :customers

data/lib/react-rails-api/templates/start.rake.tt

@@ -1,8 +1,13 @@
 namespace :start do
+  desc 'Start development server'
   task :development do
-    exec 'heroku local -f Procfile.dev'
+    exec 'foreman start -f Procfile.dev'
+  end
+
+  desc 'Start production server'
+  task :production do
+    exec 'NPM_CONFIG_PRODUCTION=true npm run postinstall && foreman start'
   end
 end
 
-desc 'Start development server'
 task :start => 'start:development'

data/lib/react-rails-api/version.rb

@@ -2,7 +2,7 @@ module ReactRailsAPI
   VERSION = {
     major: 0,
     minor: 1,
-    patch: 0,
+    patch: 1,
     meta: nil
   }.values.reject(&:nil?).map(&:to_s)*?.
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Edwin Onuonga
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor