revelry_generate 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2175dd3295ef8e46be5edcdd8595204baed2c49
-  data.tar.gz: 9b3032177a17281d325bd13ce867d31d846a2778
+  metadata.gz: bd699664d6b70a221289915581113375d5c8741c
+  data.tar.gz: 9e64fa55eb9d21bbb73f203c20a916665d29c865
 SHA512:
-  metadata.gz: 31ad4577be6817968f9cc34ca2d2cfcc65e0290bdaca858cb62a5e762473fe65325a61db6a0b8348040cce01ea79d20420a2af772f7e83473eae775c967df86a
-  data.tar.gz: e00dc9b3d13ed19947ed5505f323a780460d2d8991913b3f52b6621fa0f23563882825ba0dd8d5f56f4cbb15ba8a81485b4291ef645143c6dd60be96629f2f24
+  metadata.gz: e346dd7faee1294ab76584277a45e0aaab68813fc854e6dc1d8b532ef3327be87eccf91eb89376dbaa5ce50767e55050f03bd2509b4344e7cadb5d6e3c2e134a
+  data.tar.gz: 6a6836f6a7a00f26f3358958cea0d602c4200e908c840b8c490a823efa28691b56fff57d8ab48e405af2620e7036bef1e9a16d57db5e8f89a8f8132d12951f0c

data/README.md

@@ -1,41 +1,51 @@
-# generate
+# revelry_generate
 
-Packages containing the application templates, scaffolds, and generators for the
-Revelry 2016 Name TBD stack.
+Generate a Rails project with a React-based view engine.
 
-## Using
+## Generated App Features
 
-```
-rails new app_name -m template.rb -T -d postgresql
-```
+### Node.js render service
 
-or
+* Full-fledged Express app with Webpack, Babel, React, Redux, and more
+* Domain-centric module structure for better code organization
+* Receives POSTed JSON payloads, uses them as React props, and responds with HTML
 
-```
-bin/rake rails:template LOCATION=template.rb
-```
+### Rails glue
 
-This will generate an app using the default skeleton. The skeleton will give you
-further instructions from there.
+* `jbuilder` templates define React props
+* Controller concern connects view rendering to the Node service
+* Generator hooks cause JavaScript modules to be generated in the render service as well
 
-## slush (default) skeleton
+## Usage
 
-This provides a skeleton for rails with rails_render_service and the
-revelry framework. After creating a new app with the template (see above), you
-can:
+### Install
 
-### Start the servers
+```
+gem install revelry_generate
+```
+
+### Create a new app
 
 ```
-npm run dev
+revelry_generate new my_app && cd my_app
 ```
 
 ### Scaffold a new resource
 
-Just do:
-
+Same as a normal Rails app:
 ```
 rails g scaffold Article
 ```
 
-like a normal rails app.
+### Run local servers
+
+```
+npm run dev
+```
+
+### Applying the template to an existing app
+
+From the app's directory, run:
+```
+revelry_generate install
+```

data/bin/after_bundle

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+system 'bin/rails g rspec:install'
+system 'bin/rails g revelry_generate:skeleton'

data/bin/revelry_generate

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'thor'
+
+class RevelryGenerateCLI < Thor
+  desc 'new [NAME]', 'Create a new Rails app from the revelry_generate template'
+  def new(name)
+    system "rails new #{name} -m #{template_path} --skip-spring -T -d postgresql"
+  end
+
+  desc 'install', 'Apply the revelry_generate template to an existing Rails app'
+  def install
+    system "rails app:template LOCATION=#{template_path} && #{after_bundle_path}"
+  end
+
+  private
+
+  def template_path
+    @template_path ||= File.expand_path('../../template.rb', __FILE__)
+  end
+
+  def after_bundle_path
+    @after_bundle_path ||= File.expand_path('../after_bundle', __FILE__)
+  end
+end
+
+RevelryGenerateCLI.start ARGV

data/template.rb

@@ -0,0 +1,107 @@
+gem 'rails_render_service'
+gem 'foreman'
+gem 'dotenv'
+
+# Add our default server config
+gem 'puma'
+gem 'rails_12factor'
+
+gem_group :development do
+  gem 'revelry_generate'
+end
+
+# Add our testing config
+gem_group :development, :test do
+  gem "rspec-rails"
+end
+
+comment_lines 'Gemfile', 'turbolinks'
+gsub_file('app/assets/javascripts/application.js', '//= require turbolinks', '')
+comment_lines 'Gemfile', 'spring'
+
+application 'Dotenv.load'
+application <<-RB
+    config.generators do |g|
+      g.jbuilder = :jbuilder_props
+      g.assets = false
+    end
+RB
+
+file File.join('app', 'controllers', 'concerns', 'rejax.rb'), <<-RUBY
+  module Rejax
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :redirect_to_without_default_303, :redirect_to
+      alias_method :redirect_to, :redirect_to_with_default_303
+
+      alias_method :url_for_without_include_json_format_ext, :url_for
+      alias_method :url_for, :url_for_with_include_json_format_ext
+    end
+
+    def redirect_to_with_default_303(options = {}, response_status = {})
+      response_status.reverse_merge! status: 303
+      redirect_to_without_default_303 options, response_status
+    end
+
+    def url_for_with_include_json_format_ext(record_or_hash_or_array, options = {})
+      options.reverse_merge! format: :json if request.format == :json
+      url_for_without_include_json_format_ext options
+    end
+  end
+RUBY
+
+file File.join('app', 'helpers', 'json_helper.rb'), <<-RUBY
+  module JsonHelper
+    # E.g., json_form(@article, nest: [:author, :comments])
+    def json_form(model, opts = {})
+      # return unless model
+      Jbuilder.new do |json|
+        _json_form_json(json, model, opts)
+      end
+    end
+
+    private
+
+    def _json_form_json(json, model, opts={})
+      return unless model
+      json.merge! model.attributes
+      json.errors model.errors.any? ? model.errors.to_hash : nil
+
+      # Requested inclusion of nested attributes
+      if opts[:nest]
+        opts[:nest].each do |relationship_sym|
+          nested_model = model.send(relationship_sym)
+          # Relationship is a collection we need to map
+          if nested_model.respond_to? :map
+            json.set! relationship_sym, nested_model do |model|
+              _json_form_json(json, model)
+            end
+          # Singular relationship to set
+          else
+            json.set! relationship_sym, json_form(nested_model)
+          end
+        end
+      end
+    end
+  end
+RUBY
+
+inside(File.join('app', 'controllers')) do
+  inject_into_file 'application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do
+    "  include RailsRenderService::Concern\n  include Rejax\n"
+  end
+end
+
+initializer 'rails_render_service.rb', <<-ruby
+  Rails.application.config.rails_render_service.get_uri = lambda do
+    "unix://\#{Rails.root.join ENV['RENDER_SERVICE_SOCKET']}"
+  end
+ruby
+
+remove_file 'README.rdoc'
+
+after_bundle do
+  run File.expand_path('../bin/after_bundle', __FILE__)
+  git :init
+end

metadata

@@ -1,24 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: revelry_generate
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Robert Prehn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
-dependencies: []
+date: 2017-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1'
 description: ''
 email:
 - robert@revelry.co
-executables: []
+executables:
+- revelry_generate
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/after_bundle
+- bin/revelry_generate
 - lib/rails/generators/jbuilder_props/jbuilder_props_generator.rb
 - lib/rails/generators/jbuilder_props/templates/edit.json.jbuilder
 - lib/rails/generators/jbuilder_props/templates/index.json.jbuilder
@@ -59,6 +102,7 @@ files:
 - skeletons/slush/app.json
 - skeletons/slush/config/initializers/scaffold.rb
 - skeletons/slush/package.json
+- template.rb
 homepage: https://github.com/revelrylabs/generate.git
 licenses:
 - MIT
@@ -79,8 +123,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: ''
 test_files: []
+has_rdoc: