chr 0.3.5 → 0.4.9

data/lib/chr/generators/app_generator.rb

@@ -0,0 +1,213 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Chr
+  class AppGenerator < Rails::Generators::AppGenerator
+
+
+    class_option :skip_active_record, type: :boolean, aliases: "-O", default: true,
+      desc: "Skip Active Record files"
+
+    class_option :skip_test_unit, type: :boolean, aliases: "-T", default: true,
+      desc: "Skip Test::Unit files"
+
+    class_option :skip_turbolinks, type: :boolean, default: true,
+      desc: "Skip turbolinks gem"
+
+    class_option :skip_bundle, type: :boolean, aliases: "-B", default: true,
+      desc: "Don't run bundle install"
+
+
+    def finish_template
+      invoke :chr_customization
+      super
+    end
+
+
+    def chr_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_secret_token
+      invoke :create_application_views
+      invoke :configure_app
+      invoke :create_application_assets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :setup_devise
+      invoke :setup_character
+      invoke :setup_database
+      invoke :setup_git
+      # invoke :create_heroku_apps
+      # invoke :create_github_repo
+      invoke :setup_bundler_audit
+      #invoke :setup_spring
+      invoke :outro
+    end
+
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      bundle_command 'install'
+    end
+
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+    end
+
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      # @todo
+    end
+
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_newrelic
+      build :configure_smtp
+      build :configure_rack_timeout
+      build :enable_rack_canonical_host
+      build :enable_rack_deflater
+      build :setup_asset_host
+      build :setup_asset_sync
+    end
+
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+
+    def create_application_views
+      say 'Creating application views'
+      build :create_partials_directory
+      build :create_shared_analytics
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_application_layout
+      build :create_body_class_helper
+    end
+
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_puma
+      build :setup_foreman
+    end
+
+
+    def create_application_assets
+      say 'Create application stylesheets and javascripts'
+      build :setup_stylesheets
+      build :setup_javascripts
+    end
+
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+
+    def setup_devise
+      say "Setup devise"
+      build :setup_devise
+    end
+
+
+    def setup_character
+      say "Setup character"
+      build :setup_character_routes
+      build :setup_character_base_controller
+      build :configure_devise_for_character
+      build :setup_character_views
+      build :setup_character_stylesheets
+      build :setup_character_javascripts
+      build :setup_character_assets
+      build :setup_carrierwave
+    end
+
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+
+    def init_git
+      build :init_git
+    end
+
+
+    def setup_database
+      say 'Setting up database'
+      build :initialize_mongoid
+    end
+
+
+    def setup_bundler_audit
+      say "Setting up bundler-audit"
+      build :setup_bundler_audit
+    end
+
+
+    def setup_spring
+      say "Springifying binstubs"
+      build :setup_spring
+    end
+
+
+    def outro
+      say 'Congratulations! You just created a new Character.'
+    end
+
+
+    protected
+
+      def get_builder_class
+        Chr::AppBuilder
+      end
+
+
+      def using_active_record?
+        !options[:skip_active_record]
+      end
+
+  end
+end
+
+
+

data/lib/chr/version.rb

@@ -1,3 +1,5 @@
 module Chr
-  VERSION = "0.3.5"
+  RAILS_VERSION = "~> 4.2.3"
+  RUBY_VERSION  = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION       = "0.4.9"
 end

data/lib/generators/chr/controller_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+
+module Chr
+  module Generators
+    class ControllerGenerator < Rails::Generators::Base
+      def create_controller
+        generate "controller", "admin/#{ARGV[0]} --skip-template-engine"
+
+        inject_into_file(
+          "config/routes.rb",
+          "\n\t\tresources :#{ARGV[0]}",
+          after: "namespace :admin do",
+        )
+
+      end
+    end
+  end
+end

data/templates/Gemfile.erb

@@ -0,0 +1,38 @@
+source 'https://rubygems.org'
+ruby '<%= Chr::RUBY_VERSION %>'
+
+gem 'rails', '<%= Chr::RAILS_VERSION %>'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier'
+gem 'coffee-rails', '~> 4.1.0'
+gem 'jquery-rails'
+gem 'puma'
+gem 'recipient_interceptor'
+gem 'rack-canonical-host'
+gem 'meta-tags'
+gem 'asset_sync'
+gem 'awesome_print'
+gem 'mongoid'
+gem 'mongosteen'
+gem 'chr'
+gem 'ants'
+gem 'loft'
+
+group :development do
+  gem 'spring'
+  gem 'web-console'
+end
+
+group :development, :test do
+  gem 'figaro'
+  gem 'byebug'
+  gem 'quiet_assets'
+  gem 'bundler-audit', require: false
+  gem 'factory_girl_rails'
+  gem 'dotenv-rails'
+end
+
+group :staging, :production do
+  gem 'rack-timeout'
+  gem 'rails_12factor'
+end

data/templates/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -p $PORT -C ./config/puma.rb

data/templates/README.md.erb

@@ -0,0 +1,45 @@
+# <%= app_name.humanize %>
+
+
+## Getting Started
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
+your machine with [this script].
+
+[this script]: https://github.com/thoughtbot/laptop
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+If you don't have `foreman`, see [Foreman's install instructions][foreman]. It
+is [purposefully excluded from the project's `Gemfile`][exclude].
+
+[foreman]: https://github.com/ddollar/foreman
+[exclude]: https://github.com/ddollar/foreman/pull/437#issuecomment-41110407
+
+
+## Deploying to Heroku
+
+This project is ready to deploy to [Heroku](https://heroku.com), still before that
+please install plugins for mongodb, email & make sure these variables are set
+in your app ENV:
+
+    MONGODB_URI
+    ASSET_HOST
+    AWS_ACCESS_KEY_ID
+    AWS_SECRET_ACCESS_KEY
+    FOG_DIRECTORY
+    HOST
+    SMTP_ADDRESS
+    SMTP_DOMAIN
+    SMTP_PASSWORD
+    SMTP_USERNAME
+
+
+Good luck, have fun, program well and program in style!

data/templates/_analytics.html.erb

@@ -0,0 +1,9 @@
+<% if ENV["SEGMENT_IO_KEY"] %>
+  <script type="text/javascript">
+    window.analytics=window.analytics||[],window.analytics.methods=["identify","group","track","page","pageview","alias","ready","on","once","off","trackLink","trackForm","trackClick","trackSubmit"],window.analytics.factory=function(t){return function(){var a=Array.prototype.slice.call(arguments);return a.unshift(t),window.analytics.push(a),window.analytics}};for(var i=0;i<window.analytics.methods.length;i++){var key=window.analytics.methods[i];window.analytics[key]=window.analytics.factory(key)}window.analytics.load=function(t){if(!document.getElementById("analytics-js")){var a=document.createElement("script");a.type="text/javascript",a.id="analytics-js",a.async=!0,a.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.io/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n)}},window.analytics.SNIPPET_VERSION="2.0.9",
+    window.analytics.load("<%= ENV["SEGMENT_IO_KEY"] %>");
+    window.analytics.page();
+  </script>
+<% end %>
+
+<% # @todo: add google analytics %>

data/templates/_flashes.html.erb

@@ -0,0 +1,7 @@
+<% if flash.any? %>
+  <div id="flash">
+    <% flash.each do |key, value| -%>
+      <div class="flash-<%= key %>"><%= value %></div>
+    <% end -%>
+  </div>
+<% end %>

data/templates/_javascript.html.erb

@@ -0,0 +1,12 @@
+<%= javascript_include_tag :application %>
+
+<%= yield :javascript %>
+
+<%= render "analytics" %>
+
+<% if Rails.env.test? %>
+  <%= javascript_tag do %>
+    $.fx.off = true;
+    $.ajaxSetup({ async: false });
+  <% end %>
+<% end %>

data/templates/application.coffee

@@ -0,0 +1,2 @@
+#= require jquery
+#= require jquery_ujs

data/templates/application.scss

@@ -0,0 +1 @@
+@import "normalize-rails";

data/templates/application.yml

@@ -0,0 +1,6 @@
+# http://ddollar.github.com/foreman/
+ASSET_HOST:       localhost:3000
+APPLICATION_HOST: localhost:3000
+RACK_ENV:         development
+SECRET_KEY_BASE:  development_secret
+EXECJS_RUNTIME:   Node

data/templates/application_gitignore

@@ -0,0 +1,14 @@
+!.keep
+*.DS_Store
+*.swo
+*.swp
+/.bundle
+/.env
+/.foreman
+/coverage/*
+/db/*.sqlite3
+/log/*
+/public/system
+/public/assets
+/tags
+/tmp/*

data/templates/application_layout.html.erb.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+
+  <%%#
+    Configure default meta tags values, for more details see:
+    https://github.com/kpumuk/meta-tags
+  %>
+  <%%= display_meta_tags site:        '<%= app_name %>',
+                        description: '',
+                        og: { site_name:   '<%= app_name %>',
+                              url:         '',
+                              title:       '',
+                              description: '',
+                              type:        'website',
+                              image:       '' } %>
+
+  <%%= stylesheet_link_tag :application, media: "all" %>
+  <%%= csrf_meta_tags %>
+</head>
+<body class="<%%= body_class %>">
+  <%%= render "flashes" -%>
+  <%%= yield %>
+  <%%= render "javascript" %>
+</body>
+</html>

data/templates/asset_sync.rb

@@ -0,0 +1,28 @@
+AssetSync.configure do |config|
+  config.fog_provider          = 'AWS'
+  config.aws_access_key_id     = ENV['AWS_ACCESS_KEY_ID']
+  config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  config.fog_directory         = ENV['FOG_DIRECTORY']
+  # To use AWS reduced redundancy storage.
+  # config.aws_reduced_redundancy = true
+
+  # Invalidate a file on a cdn after uploading files
+  # config.cdn_distribution_id = "12345"
+  # config.invalidate = ['file1.js']
+
+  # Increase upload performance by configuring your region
+  # config.fog_region = 'eu-west-1'
+  #
+  # Don't delete files from the store
+  # config.existing_remote_files = "keep"
+  #
+  # Automatically replace files with their equivalent gzip compressed version
+  # config.gzip_compression = true
+  #
+  # Use the Rails generated 'manifest.yml' file to produce the list of files to
+  # upload instead of searching the assets directory.
+  # config.manifest = true
+  #
+  # Fail silently. Useful for environments such as Heroku
+  # config.fail_silently = true
+end