trireme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9a8e50b134b60477af20a52ac807788e28701d1
+  data.tar.gz: 7c073f1152a8c2c4d66f27919d602256f045f4ba
+SHA512:
+  metadata.gz: b26baa4e8e6d349eccf0482d7b67d30599f039ea27c1a5acb1118bd048c3c80c23c6fc13d064c58e6b2c4d76c4c79f91ecd3714b6b0ad022e8e6159c88be3acf
+  data.tar.gz: 277fb0c6aefcff4e2eeb8a6aa25d78f9fbab19a64d7483bae6bef856d0e37952453452275185326dc0684b8db4d59c8b4f75d43237251c629950ba2aec8461e1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trireme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Sharpe
+
+MIT License
+
+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,29 @@
+# Trireme
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trireme'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trireme
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/trireme

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', 'lib', 'trireme', 'generators', 'app_generator'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'trireme', 'actions'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'trireme', 'app_builder'), File.dirname(__FILE__))
+require File.expand_path(File.join('..', 'lib', 'trireme'), File.dirname(__FILE__))
+
+templates_root = File.expand_path(File.join('..', 'lib', 'trireme', 'templates'), File.dirname(__FILE__))
+Trireme::AppGenerator.source_root templates_root
+Trireme::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Trireme::AppGenerator.start

data/lib/trireme/actions.rb

@@ -0,0 +1,20 @@
+module Trireme
+  module Actions
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+    
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+  end
+end

data/lib/trireme/app_builder.rb

@@ -0,0 +1,207 @@
+module Trireme
+  class AppBuilder < Rails::AppBuilder
+    attr_accessor :domain_base, :server_ip
+
+    include Trireme::Actions
+
+    def add_additional_gems
+      if yes? "Add carrierwave for file uploading?"
+        @generator.gem 'carrierwave'
+        @generator.gem 'mini_magick'
+      end
+    end
+
+    def add_bootstrap_and_overrides
+      copy_file "app/assets/stylesheets/_bootstrap_and_overrides.scss"
+    end
+
+    def add_custom_gems
+      gems_path = find_in_source_paths 'additional_gems'
+      new_gems = File.open(gems_path).read
+      append_file 'Gemfile', "\n#{new_gems}"
+    end
+
+    def add_to_gitignore
+      gitignore_file = find_in_source_paths('gitignore_additions')
+      gitignore = File.open(gitignore_file).read
+      append_file '.gitignore', gitignore
+    end
+
+    def configure_generators
+      generators_config = <<-RUBY.gsub(/^   {2}/, '')
+        config.generators do |generate|
+          generate.helper      false
+          generate.assets      false
+          generate.view_specs  false
+          generate.stylesheets false
+          generate.javascripts false
+        end\n
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', generators_config
+    end
+
+    def configure_rspec
+      generate 'rspec:install'
+      run 'rm test/ -Rf'
+    end
+
+    def copy_utility_helper
+      copy_file "app/helpers/utility_helper.rb", force: true
+    end
+
+    def copy_application_layout
+      copy_file "app/views/layouts/application.html.erb", force: true
+    end
+
+    def copy_bootstrap_scaffold_templates
+      directory 'lib/templates/erb/scaffold'
+    end
+
+    def create_flashes_partial
+      copy_file "app/views/shared/_flashes.html.erb"
+    end
+
+    def create_admin_actions_partial
+      copy_file "app/views/shared/_admin_actions.html.erb"
+    end
+
+    def create_form_errors_partial
+      copy_file "app/views/shared/_form_errors.html.erb"
+    end
+
+    def create_shared_views_directory
+      empty_directory 'app/views/shared'
+    end
+
+    def generate_home_controller
+      generate :controller, "home index"
+      route "root to: 'home\#index'"
+    end
+
+    def get_server_options
+      @domain_base ||= ask("Domain:")
+      if !@domain_base.blank? && config_settings.has_key?(:chef) && yes?("Get IP from Chef (#{config_settings[:chef][:url]})?")
+        require 'open-uri'
+        begin
+          @server_ip = open("#{config_settings[:chef][:url]}#{@domain_base}").base_uri.to_s.match(/http:\/\/([\d\.]+)/)[1]
+          puts "Setting server ip to #{@server_ip}"
+        rescue
+          puts "Failed to get ip"
+        end
+      end
+      @domain_base = "example.com" if @domain_base.blank?
+      @server_ip ||= ask("Server IP (if you have one):")
+    end
+
+    def initialize_git
+      git :init
+      git add: "."
+      git commit: "-m 'Inital commit'"
+    end
+
+    # Overrides generation of rails readme file
+    def readme
+      template "README.md.erb", "README.md"
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb', /Application\.routes\.draw do.*end/m, "Application.routes.draw do\nend"
+    end
+
+    def remove_sqlite_gem
+      gsub_file 'Gemfile', /^\s*gem .sqlite3.+$/, ''
+    end
+
+    def replace_application_css
+      remove_file 'app/assets/stylesheets/application.css'
+      copy_file 'app/assets/stylesheets/application.css.scss'
+    end
+
+    def set_sublime_text_as_editor
+      copy_file "config/initializers/better_errors.rb"
+    end
+
+    def setup_smtp
+      configure_environment "production",
+        "config.action_mailer_delivery_method = :smtp\n\tconfig.action_mailer.smtp_settings = #{format_config(config_settings[:action_mailer][:smtp_settings])}"
+    end
+
+    def setup_capistrano
+      if @domain_base && @server_ip
+        opts = { domain_base: @domain_base, server_ip: @server_ip, force: true }
+      else
+        opts[:domain_base] = ask("Domain:")
+        opts[:server_ip] = ask("Server IP:")
+        opts[:force] = true
+      end
+      template "config/deploy.rb.erb", "config/deploy.rb", opts
+      directory "config/deploy"
+      copy_file "Capfile", "Capfile"
+      directory "config/recipes"
+    end
+
+    def setup_console
+      copy_file "config/initializers/jazz_hands.rb"
+    end
+
+    def setup_devise
+      if config_settings[:devise][:include] || yes?("Add Devise?")
+        devise_model = ask("Devise model (default: #{config_settings[:devise][:model]}):").underscore
+        devise_model = config_settings[:devise][:model] if devise_model.blank?
+        @generator.gem 'devise'
+        run 'bundle install'
+        generate 'devise:install'
+        generate "devise #{devise_model}"
+        generate "devise:views"
+        bundle_command 'exec rake db:migrate'
+        if config_settings[:devise][:seed] || yes?("Seed database with #{devise_model}@example.com?")
+          append_file 'db/seeds.rb', "devise_user = #{devise_model.titleize}.create email: '#{devise_model}@example.com', password: 'password'"
+          bundle_command 'exec rake db:seed'
+        end
+      end
+    end
+
+    def setup_exception_notification
+      en_config = "config.middleware.insert_before Warden::Manager, ExceptionNotification::Rack,\n"
+      if config_settings[:exception_notification][:email]
+        config_settings[:exception_notification][:email][:email_prefix] = "[#{app_name.titleize} Exception]"
+        en_config << "\t\t:email => #{format_config(config_settings[:exception_notification][:email], 2)}"
+      end
+      if config_settings[:exception_notification][:irc]
+        config_settings[:exception_notification][:irc][:prefix] = "[#{app_name.titleize} Production]"
+        en_config << ",\n\t\t" if en_config[/}\Z/]
+        en_config << ":irc => #{format_config(config_settings[:exception_notification][:irc], 2)}"
+      end
+      configure_environment "production", en_config
+    end
+
+    def setup_guard
+      copy_file "Guardfile"
+    end
+
+    def setup_mailcatcher
+      configure_environment "development",
+        "config.action_mailer.delivery_method = :smtp\n  config.action_mailer.smtp_settings = { :address => \"localhost\", :port => 1025 }"
+    end
+
+    def setup_quiet_assets
+      configure_environment "development",
+        "config.quiet_assets = true"
+    end
+
+    def setup_staging_environment
+      run 'cp config/environments/production.rb config/environments/staging.rb'
+    end
+
+    # ----------
+
+    def config_settings
+      @config ||= Trireme::config
+    end
+
+    def format_config(yml, num_tabs = 1)
+      tabs = "\t" * (num_tabs + 1)
+      yml.to_s.gsub(/\A{/, "{\n#{tabs}").gsub(/, :/, ",\n#{tabs}:").gsub(/}\Z/, "\n#{"\t" * num_tabs}}").gsub("=>", " => ")
+    end
+  end
+end

data/lib/trireme/generators/app_generator.rb

@@ -0,0 +1,177 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Trireme
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, type: :string, aliases: '-d', default: 'sqlite3', desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+    class_option :config_file, type: :string, aliases: '-c', desc: "Include yaml configuration file"
+
+    def finish_template
+      invoke :trireme_customization
+      super
+    end
+
+    def trireme_customization
+      if options[:config_file]
+        say "Loading yaml configuration from #{options[:config_file]}"
+        Trireme::configure_with(options[:config_file])
+      end
+      invoke :configure_generators
+      invoke :add_gems
+      invoke :remove_routes_comment_lines
+      invoke :add_home_controller
+      invoke :setup_staging_environment
+      if config[:action_mailer] && config[:action_mailer][:smtp_settings]
+        invoke :configure_smtp
+      end
+      invoke :setup_console
+      invoke :setup_stylesheets
+      invoke :setup_gems
+      invoke :create_views_and_layouts
+      invoke :setup_deployment
+      invoke :setup_git
+    end
+
+    def configure_generators
+      say 'Configuring generators'
+
+      # Add generator configuration to config/application.rb
+      build :configure_generators
+    end
+
+    def add_gems
+      say 'Adding gems and installing'
+
+      # Remove sqlite gem from Gemfile (we'll add it back under development group)
+      build :remove_sqlite_gem
+
+      # Append 'templates/additional_gems' to Gemfile
+      build :add_custom_gems
+
+      # Confirm other gems before adding (e.g., Carrierwave)
+      build :add_additional_gems
+
+      bundle_command 'install'
+    end
+
+    def remove_routes_comment_lines
+      # Remove commented lines from config/routes.rb
+      # build :remove_routes_comment_lines
+    end
+
+    def add_home_controller
+      say 'Creating home controller with index'
+
+      build :generate_home_controller
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+
+      # Create config/environments/staging.rb based on production.rb
+      build :setup_staging_environment
+    end
+
+    def configure_smtp
+      say 'Configuring action mailer for production'
+
+      build :setup_smtp
+    end
+
+    def setup_console
+      say 'Configuring console (config/initializers/jazz_hands.rb)'
+
+      # Add jazz_hands configuration in config/initializers/jazz_hands.rb
+      build :setup_console
+    end
+
+    def setup_stylesheets
+      say 'Setting up stylesheets'
+
+      # Add boostrap_and_overrides to app/assets/stylesheets; it contains bootstrap variables and imports bootstrap
+      build :add_bootstrap_and_overrides
+
+      # Replaces application.css with application.css.scss that imports compass, bootstrap, font-awesome
+      build :replace_application_css
+
+      # build :add_foundation_scaffold_templates
+    end
+
+    def setup_gems
+      say 'Setting up gems...'
+      # Add quiet assets config to development (makes it easy to turn off)
+      build :setup_quiet_assets
+
+      # Add mailcatcher configuration for development
+      build :setup_mailcatcher
+
+      # Sets sublime text as editor for better_errors
+      build :set_sublime_text_as_editor
+
+      # Set up devise in accordance with preferences
+      build :setup_devise
+
+      # Setup rspec (rspec:install)
+      build :setup_rspec
+
+      # Setup guard by copying Guardfile
+      build :setup_guard
+
+      # Add configuration for exception notification if it is specified
+      if config.has_key? :exception_notification
+        build :setup_exception_notification
+      end
+    end
+
+    def create_views_and_layouts
+      say 'Creating partials and adding layouts'
+
+      # Create app/views/shared directory
+      build :create_shared_views_directory
+
+      # Copy partials to app/views/shared
+      build :create_flashes_partial
+      build :create_form_errors_partial
+      build :create_admin_actions_partial
+
+      # Add title, icon, placeholder helpers
+      build :copy_utility_helper
+
+      build :copy_application_layout
+
+      build :copy_bootstrap_scaffold_templates
+    end
+
+    def setup_deployment
+      # Get domain and server ip from input
+      build :get_server_options
+
+      # Add deploy configuration and recipes
+      build :setup_capistrano
+    end
+
+    def setup_git
+      say 'Setting up .gitignore and git repo'
+
+      # Add gitignore_additions to .gitignore
+      build :add_to_gitignore
+
+      # Initialize git repository and create first commit
+      build :initialize_git
+    end
+
+    def outro
+      say "Ready to set sail (and probably catch on fire, sink, and kill everyone on board)! Run 'cap deploy:setup' to finish preparing the server for deployment."
+    end
+
+    protected
+
+    def get_builder_class
+      Trireme::AppBuilder
+    end
+
+    def config
+      @config ||= Trireme::config
+    end
+  end
+end

data/lib/trireme/templates/.rspec

@@ -0,0 +1 @@
+--color

data/lib/trireme/templates/Capfile

@@ -0,0 +1,4 @@
+load 'deploy'
+# Uncomment if you are using Rails' asset pipeline
+load 'deploy/assets'
+load 'config/deploy' # remove this line to skip loading any of the default tasks

data/lib/trireme/templates/Guardfile

@@ -0,0 +1,32 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'livereload' do
+  watch(%r{app/views/.+\.(erb|haml|slim)$})
+  watch(%r{app/helpers/.+\.rb})
+  watch(%r{public/.+\.(css|js|html)})
+  watch(%r{config/locales/.+\.yml})
+  # Rails Assets Pipeline
+  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|js|html|png|jpg))).*}) { |m| "/assets/#{m[3]}" }
+end
+
+guard :rspec, cmd: 'spring rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/lib/trireme/templates/README.md.erb

@@ -0,0 +1,6 @@
+<%= app_name %>
+===============
+
+This application was set up by Trireme. If you have a problem, please file an issue on github. Thanks!
+
+More description coming soon. This is very much a work in progress.

data/lib/trireme/templates/additional_gems

@@ -0,0 +1,37 @@
+gem "pg"
+gem "carrier-pigeon"
+gem "exception_notification", :git => 'https://github.com/cliftonlabs/exception_notification.git', branch: 'irc-notifier'
+gem "compass-rails"
+gem "bootstrap-sass"
+gem "font-awesome-rails"
+
+group :development do
+  gem "annotate"
+  gem "better_errors"
+  gem "binding_of_caller"
+  gem "quiet_assets"
+  gem "mailcatcher"
+  gem "guard"
+  gem "guard-rspec", require: false
+  gem "guard-livereload", require: false
+end
+
+group :development, :test do
+  gem "sqlite3"
+  gem "rspec-rails", "~> 3.0.0.beta"
+  gem "factory_girl_rails"
+  gem "jazz_hands"
+end
+
+group :test do
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "capybara"
+  gem "poltergeist", "~> 1.5.0"
+  gem "vcr"
+  gem "webmock", "~> 1.8.0"
+  gem "simplecov", require: false
+end
+
+gem 'unicorn'
+gem 'capistrano', '2.15.5'