react-rails-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8e040cc4f348c9b64edcdc489d99f33ec3a6a86ada5d03fda56dd1f166d17b7
+  data.tar.gz: 339ea45fa23108317cf96be0d3158cd5cbf6882bfbe560c5bf82ce326c7b9f0b
+SHA512:
+  metadata.gz: ba8f977ef5d5abe841a7bdc9740f14aea92647cc94e9be1cf265e0e455ab14b52df2afd7184700549f1d37f96bf88dc8e7fca0d7a82b4ca0adaacd355de297b4
+  data.tar.gz: b22775270e2e52638178ed3b6d62beca19ecb0dc33f212ce93b4906e80c1f2f9212302267f80347b3af0061c5e8400c189a221c85dfda6dc04ea3ce26f44a5ff

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Edwin Onuonga
+
+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,44 @@
+[![Ruby Version](https://img.shields.io/badge/ruby-~%3E%202.5-red.svg)]()
+[![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)
+
+# React-Rails API
+
+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">
+    <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.
+
+## Requirements
+
+- [**Ruby**](https://www.ruby-lang.org/en/) `~> 2.5`
+- [**Rails**](https://rubyonrails.org/) `~> 5.2`
+- [**Node**](https://nodejs.org/en/) `11.11.0`: *Recommend installing this with [NVM](https://github.com/creationix/nvm).*
+- [**Yarn**](https://yarnpkg.com/en/) `1.13.0`: *Recommend installing Node separately from this, rather than as a dependency.*
+
+## Installation
+
+```
+$ gem install react-rails-api
+```
+
+## Usage
+
+```bash
+$ react-rails
+
+Commands:
+  react-rails new [PATH]  # Initialise a React/Rails API application.
+
+Options:
+  [--database], [--no-database]  # Integrate ActiveRecord (and Postgres).
+                                 # Default: true
+```
+
+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.

data/bin/react-rails

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'react-rails-api'
+ReactRailsAPI::CLI.start

data/lib/react-rails-api.rb

@@ -0,0 +1,2 @@
+require "react-rails-api/version"
+require 'react-rails-api/cli'

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

@@ -0,0 +1,59 @@
+require 'thor'
+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"
+  def new(path)
+    opts = default_options
+    opts << '--database=postgresql' if options[:database]
+    opts << '--skip-active-record' if !options[:database]
+    opts << "--template=#{TEMPLATE}"
+    exec "rails new #{path} #{opts.join ' '}"
+  end
+
+  map %w[--version -v] => :version
+  desc 'version, -v', "\e[90mDisplay installed react-rails 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[
+        --webpack=react
+        --api
+        --skip-coffee
+        --skip-action-cable
+        --skip-action-mailer
+        --skip-turbolinks
+        --skip-test
+        --skip-bootsnap
+        --no-bundle
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# Loads a template from ./templates
+def template(name)
+  File.open(File.join __dir__, 'templates', name).read
+end
+
+database = !ARGV.include?('--skip-active-record')
+active_admin = database ? yes?("\nUse ActiveAdmin? (Y/n):") : false
+puts if database
+
+gem_group :development, :test do
+  gem 'rspec-rails'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gem_group :production do
+  gem 'pg', '>= 0.18', '< 2.0'
+  gsub_file 'Gemfile', "# Use postgresql as the database for Active Record\ngem 'pg', '>= 0.18', '< 2.0'\n", ''
+end
+
+if active_admin
+  # Add Devise and ActiveAdmin gems to Gemfile
+  gem 'devise'
+  gem 'activeadmin'
+  inject_into_file 'Gemfile', "# ActiveAdmin\n", before: "gem 'devise'"
+end
+
+after_bundle do
+  # Stop spring from running
+  run 'spring stop'
+
+  # Integrate RSpec into the application
+  generate 'rspec:install'
+
+  # Add db/*.sqlite and db/*.sqlite-journal files to .gitignore
+  append_to_file '.gitignore', "\n# Ignore the default SQLite database.\n/db/*.sqlite\n/db/*.sqlite-journal\n"
+
+  inside File.join('app', 'controllers') do
+    # Make ApplicationController inherit from ActionController::Base
+    gsub_file 'application_controller.rb', 'ActionController::API', 'ActionController::Base'
+
+    # Add protect_from_forgery and inheritance comment
+    inject_into_file 'application_controller.rb', template('application_controller.rb.tt'), before: /^end/
+
+    # Generate the API base controller (ApiController)
+    generate :controller, 'API', *%w[
+      --skip-routes
+      --no-helper
+      --no-assets
+      --no-controller-specs
+      --no-view-specs
+      --no-helper-specs
+      --no-javascripts
+      --no-stylesheets
+    ]
+
+    # Make ApiController inherit from ActionController::API
+    gsub_file 'api_controller.rb', 'ApplicationController', 'ActionController::API'
+    inject_into_file 'api_controller.rb', "  # New controllers should inherit from this controller, not ApplicationController.\n", before: /^end/
+  end
+
+  inside 'config' do
+    # Include the railtie for sprockets
+    uncomment_lines 'application.rb', /require \"sprockets\/railtie\"/
+
+    # Add ActiveAdmin configuration on config/application.rb
+    inject_into_file 'application.rb', template('application.rb.tt'), before: /^  end/ if active_admin
+
+    # Write config/database.yml template
+    file 'database.yml', template('database.yml.tt'), force: true if database
+
+    # Add /api scope in config/routes.rb
+    inject_into_file 'routes.rb', template('routes.rb.tt'), before: /^end/
+  end
+
+  if database
+    if active_admin
+      # Integrate ActiveAdmin and Devise CMS into the application
+      generate 'active_admin:install'
+      generate 'devise:views'
+    end
+
+    # Run a database migration and seed the database
+    rails_command 'db:migrate'
+    rails_command 'db:seed'
+  end
+
+  # Create a development Procfile for running both processes
+  file 'Procfile.dev', template('Procfile.dev.tt')
+
+  # Create a production Procfile for running the application
+  file 'Procfile', template('Procfile.tt')
+  inject_into_file 'Procfile', 'release: bundle exec rake db:migrate', after: "\n" if database
+
+  # Create a rake task for starting the application in the development environment
+  inside File.join('lib', 'tasks') do
+    file 'start.rake', template('start.rake.tt')
+  end
+
+  # Create a top-level package.json that tells Heroku how to compile the Create React App
+  file 'package.json', template('package.json.tt')
+
+  # Create the React application (client)
+  run 'yarn create react-app client'
+
+  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"
+  end
+
+  # Add environment variable for skipping preflight checks
+  file '.env', template('.env.tt')
+
+  # Prevent out-of-date yarn package errors
+  run 'yarn install --check-files'
+end

data/lib/react-rails-api/templates/.env.tt

@@ -0,0 +1 @@
+SKIP_PREFLIGHT_CHECK=true

data/lib/react-rails-api/templates/Procfile.dev.tt

@@ -0,0 +1,2 @@
+web: PORT=3000 yarn --cwd client start
+api: PORT=3001 bundle exec rails s

data/lib/react-rails-api/templates/Procfile.tt

@@ -0,0 +1 @@
+web: bundle exec rails s

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

@@ -0,0 +1,9 @@
+
+    # Middleware for ActiveAdmin
+    config.middleware.use Rack::MethodOverride
+    config.middleware.use ActionDispatch::Flash
+    config.middleware.use ActionDispatch::Cookies
+    config.middleware.use ActionDispatch::Session::CookieStore
+
+    # Use regular scaffolding process
+    config.app_generators.scaffold_controller = :scaffold_controller

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

@@ -0,0 +1,2 @@
+  # New controllers should inherit from ApiController, not this controller.
+  protect_from_forgery with: :exception

data/lib/react-rails-api/templates/database.yml.tt

@@ -0,0 +1,17 @@
+default: &default
+  adapter: sqlite3
+  encoding: unicode
+  pool: <%= ENV.fetch('RAILS_MAX_THREADS') { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite
+
+test:
+  <<: *default
+  database: db/test.sqlite
+
+production:
+  adapter: postgresql
+  url: <%= ENV['DATABASE_URL'] %>

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

@@ -0,0 +1,13 @@
+{
+  "name": "api",
+  "license": "MIT",
+  "engines": {
+    "node": "11.11.0",
+    "yarn": "1.13.0"
+  },
+  "scripts": {
+    "build": "yarn --cwd client install && yarn --cwd client build",
+    "deploy": "cp -a client/build/. public/",
+    "heroku-postbuild": "yarn build && yarn deploy"
+  }
+}

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

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

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

@@ -0,0 +1,8 @@
+namespace :start do
+  task :development do
+    exec 'heroku local -f Procfile.dev'
+  end
+end
+
+desc 'Start development server'
+task :start => 'start:development'

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

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

data/react-rails-api.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'react-rails-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'react-rails-api'
+  spec.version       = ReactRailsAPI::VERSION
+  spec.authors       = ['Edwin Onuonga', 'Charlie Gleason']
+  spec.email         = ['edwinonuonga@gmail.com', 'hi@charliegleason.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{All-in-one application generator enabling the integration of a React front-end and a Ruby-on-Rails API back-end with ActiveAdmin CMS.}
+  spec.homepage      = 'https://github.com/eonu/react-rails-api'
+
+  spec.files         = Dir.glob('lib/**/*', File::FNM_DOTMATCH) + %w[Gemfile LICENSE README.md react-rails-api.gemspec bin/react-rails]
+  spec.bindir        = 'bin'
+  spec.executables   = 'react-rails'
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = "~> 2.5"
+
+  spec.add_runtime_dependency 'thor', '~> 0.20'
+  spec.add_runtime_dependency 'rails', '~> 5.2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+
+  spec.metadata = {'source_code_uri' => spec.homepage}
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: react-rails-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edwin Onuonga
+- Charlie Gleason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: 
+email:
+- edwinonuonga@gmail.com
+- hi@charliegleason.com
+executables:
+- react-rails
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- bin/react-rails
+- lib/react-rails-api.rb
+- lib/react-rails-api/cli.rb
+- lib/react-rails-api/template.rb
+- lib/react-rails-api/templates/.env.tt
+- lib/react-rails-api/templates/Procfile.dev.tt
+- lib/react-rails-api/templates/Procfile.tt
+- lib/react-rails-api/templates/application.rb.tt
+- lib/react-rails-api/templates/application_controller.rb.tt
+- lib/react-rails-api/templates/database.yml.tt
+- lib/react-rails-api/templates/package.json.tt
+- lib/react-rails-api/templates/routes.rb.tt
+- lib/react-rails-api/templates/start.rake.tt
+- lib/react-rails-api/version.rb
+- react-rails-api.gemspec
+homepage: https://github.com/eonu/react-rails-api
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/eonu/react-rails-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: All-in-one application generator enabling the integration of a React front-end
+  and a Ruby-on-Rails API back-end with ActiveAdmin CMS.
+test_files: []