rails-embryo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3e95ed36619f324f4d2a2687983b012c5b2e303
+  data.tar.gz: 0068e1973549f5910562b6ae20484991a9a9adbb
+SHA512:
+  metadata.gz: e9f07b225afedc42452afe8c64a7535c944eb1585d2cf7e6f65a6f0cebaeee22146273109274192fb02c53a6f4e4d87aa540037bf9b689e6ff735b563477bb36
+  data.tar.gz: 1959432c41fa440bbd6d59f40edca46ecabe923b03fd1448caa38d4a5e7772c4d6114f1c30cd06b23e992c9167d28f2c57ef5cb40b849c53bcdfc30c79ab4601

data/History.md

@@ -0,0 +1,9 @@
+### Version 0.1.0
+2014-6-10
+
+* Templating enhancements with Haml and Bootstrap
+* Testing enhancements with RSpec, FactoryGirl, Capybara, and
+  Poltergeist
+* Ruby version and gemset configuration
+* "embryo" generator to enhance a stock Rails app
+* "rails-embryo" binary to generate a new Rails app with enhancements

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brian Auton
+
+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,106 @@
+# rails-embryo
+
+Rails-embryo is a Ruby gem that helps get a new Rails application up and
+running quickly. In just one step, it adds many of the the tweaks and
+best practices that I typically spend time tediously adding to any new
+Rails project.
+
+The features it adds are based on my personal
+preferences and development habits, and will probably be made more
+configurable in the future.
+
+### Requirements
+
+* Ruby 1.9.3 or newer
+* Rails 4.1.1 or newer
+
+### Getting Started
+
+Make sure the gem is installed in your current environment (this will
+also install Rails 4.1.1 if it's not already present).
+
+    gem install rails-embryo
+
+Once rails-embryo is installed, you can run "rails-embryo new" the
+same way you would normally run "rails new".
+
+    rails-embryo new my_project
+
+This will create a new application called "My Project" in a directory
+called my_project. It's the same skeleton Rails app you would get from
+"rails new", but with additional rails-embryo-specific enhancements
+(described below).
+
+The enhancements include .ruby-version and .ruby-gemset files, so if
+your system is configured with a Ruby version manager that looks for
+those files, you should be able to change into the project directory
+and then run Bundler to configure the gems for your new application.
+
+    cd my_project
+    bundle install
+
+Your new application will have a working test suite, and you can run
+it by invoking RSpec (or Rake, but RSpec is faster).
+
+    rspec
+
+It's also ready to run with the Rails server, so fire up the server
+and visit localhost:3000 to see your application's
+Bootstrap-enhanced landing page.
+
+    rails server
+
+### Running the Generators Directly
+
+You can also install the rails-embryo enhancements by adding the gem
+to an existing Rails application and running the "embryo" generator:
+
+    rails generate embryo
+
+### Enhancements Added
+
+All of the following enhancements are added by rails-embryo.
+
+#### Views and Templating
+
+[Haml](http://haml.info/) and [Bootstrap](http://getbootstrap.com/)
+are installed, along with a new application layout that replaces the
+default .erb layout and adds a Bootstrap menu bar to the top of the
+page.
+
+A basic "Dashboard" controller with index action is created, so unlike
+Rails' familiar "welcome aboard" page, you'll have a view that
+actually uses the application layout. The "Welcome" message on this
+page is served from a simple `render :text` call in the controller, so
+the application still won't have any views yet.
+
+#### Testing Tools
+
+The latest
+[RSpec](http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3)
+is installed, along with a working controller test for the
+`Welcome#index`
+action. [FactoryGirl](https://github.com/thoughtbot/factory_girl) is
+configured and ready for you to add your own factories.
+
+For acceptance testing,
+[Capybara](https://github.com/jnicklas/capybara) is installed, along
+with a simple end-to-end spec that uses it to test the `Welcome#index`
+action. [Poltergeist](https://github.com/teampoltergeist/poltergeist)
+is configured and ready for JavaScript-enabled testing; just add `js:
+true` to any RSpec `scenario` blocks that require JavaScript.
+
+#### Other Enhancements
+
+A .ruby-version file is created that specifies Ruby 2.1.2, and a
+.ruby-gemset file is created with a gemset that has the same name as
+your application directory. These can be safely ignored on systems
+that aren't automatically configured to switch Ruby versions and/or
+gemsets based on these files.
+
+Some files that normally have lots of documentation comments added
+when they are first generated (e.g. Gemfile, routes.rb, and others)
+will have all comments removed by rails-futurizer. These comments may
+be helpful for new users, but they may be more of a distraction for
+experienced developers, and they tend to get out of date as Rails and
+other gems are updated.

data/bin/rails-embryo

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require "rake"
+
+task "embryo_new", :path do |task, args|
+  verbose false
+  path = args[:path]
+  if File.exists?(path) && (Dir.entries(path) - [".", ".."]).any?
+    puts "Rerunning Rails app generator in existing application..."
+    sh "rails new #{path} --skip-bundle"
+    puts "Reapplying Embryo extensions to existing application..."
+    sh "cd #{path}; rails g embryo"
+  else
+    puts "Generating standard Rails application..."
+    sh "rails new #{path} --skip-bundle"
+    puts "Adding Embryo extensions to generated application..."
+    sh "cd #{path}; rails g embryo --force"
+  end
+end
+
+if ARGV[0] == "new"
+  if ARGV[1]
+    Rake.application["embryo_new"].invoke ARGV[1]
+  else
+    puts 'Missing required argument ("rails-embryo help" for info)'
+  end
+else
+  puts 'Usage: rails-embryo COMMAND [ARGS]
+
+Available commands:
+  help      Show this message
+  new PATH  Create a new Rails application in PATH with rails-embryo
+            enhancements. "rails-embryo new my_app" creates a new
+            application called MyApp in "./my_app"'
+end

data/lib/embryo/capybara.rb

@@ -0,0 +1,22 @@
+module Embryo
+  class Capybara
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.require_gem "capybara", "~> 2.0", group: :test
+      @filesystem.require_gem "launchy", "~> 2.0", group: :test
+      @filesystem.write "spec/support/capybara.rb", capybara_helper_data
+    end
+
+    def capybara_helper_data
+'require "capybara/rails"
+require "capybara/rspec"
+RSpec.configure do |config|
+  config.include Capybara::DSL, type: :feature
+end
+'
+    end
+  end
+end

data/lib/embryo/default_view.rb

@@ -0,0 +1,58 @@
+module Embryo
+  class DefaultView
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.write "config/routes.rb", routes_data
+      @filesystem.write "app/controllers/dashboard_controller.rb", controller_data
+      @filesystem.write "spec/controllers/dashboard_controller_spec.rb", controller_spec_data
+      @filesystem.write "spec/features/dashboard_spec.rb", feature_spec_data
+    end
+
+    private
+
+    def controller_data
+'class DashboardController < ApplicationController
+  def index
+    render text: "Welcome", layout: "application"
+  end
+end
+'
+    end
+
+    def routes_data
+'Rails.application.routes.draw do
+  root "dashboard#index"
+end
+'
+    end
+
+    def controller_spec_data
+'require "rails_helper.rb"
+
+describe DashboardController do
+  describe "#index" do
+    it "succeeds" do
+      get :index
+      expect(response).to be_success
+    end
+  end
+end
+'
+    end
+
+    def feature_spec_data
+'require "rails_helper.rb"
+
+feature "Dashboard" do
+  scenario "index view" do
+    visit "/"
+    expect(page).to have_content "Welcome"
+  end
+end
+'
+    end
+  end
+end

data/lib/embryo/factory_girl.rb

@@ -0,0 +1,19 @@
+module Embryo
+  class FactoryGirl
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.require_gem "factory_girl_rails", "~> 4.0", group: :test
+      @filesystem.write "spec/support/factory_girl.rb", factory_girl_helper_data
+    end
+
+    def factory_girl_helper_data
+'RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+'
+    end
+  end
+end

data/lib/embryo/filesystem.rb

@@ -0,0 +1,53 @@
+require "embryo/gemfile"
+require "tmpdir"
+require "active_support/inflector"
+
+module Embryo
+  class Filesystem
+    def initialize(generator, *write_options)
+      @generator = generator
+      @write_options = write_options
+      @write_cache = {}
+      @gemfile = nil
+    end
+
+    def commit_changes
+      @gemfile.write(*@write_options) if @gemfile
+      sorted_cache.each do |path, data|
+        if data
+          @generator.create_file path, data, *@write_options
+        else
+          @generator.remove_file path, *@write_options if File.exist? path
+        end
+      end
+    end
+
+    def sorted_cache
+      @write_cache.sort.to_h
+    end
+
+    def require_gem(*args)
+      gemfile.require_gem(*args)
+    end
+
+    def gemfile
+      @gemfile ||= Gemfile.current generator: @generator
+    end
+
+    def write(path, data)
+      @write_cache[path] = data
+    end
+
+    def delete(path)
+      @write_cache[path] = nil
+    end
+
+    def application_name
+      File.basename Dir.getwd
+    end
+
+    def application_human_name
+      application_name.titleize
+    end
+  end
+end

data/lib/embryo/gemfile.rb

@@ -0,0 +1,39 @@
+module Embryo
+  class Gemfile
+    attr_accessor :path, :data
+
+    def initialize(path, generator: nil)
+      @path = path
+      @generator = generator
+      @data = File.exist?(path) ? File.read(path) : ""
+    end
+
+    def remove_noise
+      @data = @data.each_line.select { |line| line[0] != "#" }.join
+      @data.gsub!(/\n\n+/, "\n\n")
+      @data.gsub!(/\n+$/, "\n")
+    end
+
+    def require_gem(name, version, options = {})
+      remove_gem name
+      @data << "\n" unless @data[-1] == "\n"
+      @data << "gem '#{name}', '#{version}'"
+      options.each { |key, value| @data << ", #{key}: #{value.inspect}" }
+      @data << "\n"
+    end
+
+    def remove_gem(name)
+      @data = @data.each_line.reject do |line|
+        line.match(/ *gem +'#{name}'/) or line.match(/ *gem +"#{name}"/)
+      end.join
+    end
+
+    def write(force: false)
+      @generator.create_file path, data, force: force
+    end
+
+    def self.current(generator: nil)
+      new "Gemfile", generator: generator
+    end
+  end
+end

data/lib/embryo/poltergeist.rb

@@ -0,0 +1,18 @@
+module Embryo
+  class Poltergeist
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.require_gem "poltergeist", "~> 1.0", group: :test
+      @filesystem.write "spec/support/poltergeist.rb", poltergeist_helper_data
+    end
+
+    def poltergeist_helper_data
+'require "capybara/poltergeist"
+Capybara.javascript_driver = :poltergeist
+'
+    end
+  end
+end

data/lib/embryo/rspec.rb

@@ -0,0 +1,40 @@
+module Embryo
+  class Rspec
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.require_gem "rspec-rails", "~> 3.0", group: :test
+      @filesystem.write "spec/spec_helper.rb", spec_helper_data
+      @filesystem.write "spec/rails_helper.rb", rails_helper_data
+    end
+
+    def spec_helper_data
+'RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+'
+    end
+
+    def rails_helper_data
+'ENV["RAILS_ENV"] ||= "test"
+require "spec_helper"
+require File.expand_path("../../config/environment", __FILE__)
+require "rspec/rails"
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+end
+'
+    end
+  end
+end

data/lib/embryo/ruby_version.rb

@@ -0,0 +1,12 @@
+module Embryo
+  class RubyVersion
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.write ".ruby-version", "2.1.2\n"
+      @filesystem.write ".ruby-gemset", "#{@filesystem.application_name}\n"
+    end
+  end
+end

data/lib/embryo/template_support.rb

@@ -0,0 +1,79 @@
+module Embryo
+  class TemplateSupport
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      @filesystem.require_gem "haml", "~> 4.0"
+      @filesystem.require_gem "haml-rails", ">= 0"
+      @filesystem.require_gem "bootstrap-sass", "~> 3.0"
+      @filesystem.write "app/views/layouts/application.html.haml", layout_data
+      @filesystem.write "app/views/layouts/_navigation.html.haml", navigation_data
+      @filesystem.write "app/views/layouts/_messages.html.haml", messages_data
+      @filesystem.write "app/assets/javascripts/application.js", javascript_data
+      @filesystem.write "app/assets/stylesheets/bootstrap-custom.css.scss", stylesheet_data
+      @filesystem.delete "app/views/layouts/application.html.erb"
+    end
+
+    def layout_data
+'!!! 5
+%html(lang="en")
+  %head
+    %meta(charset="utf-8")
+    %meta(http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1")
+    %meta(name="viewport" content="width=device-width, initial-scale=1.0")
+    %title ' + @filesystem.application_human_name + '
+    = stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true
+    = javascript_include_tag "application", "data_turbolinks_track" => true
+    = csrf_meta_tags
+  %body(role="document")
+    = render "layouts/navigation"
+    .container(role="main")
+      = render "layouts/messages"
+      = yield
+'
+    end
+
+    def navigation_data
+'.navbar.navbar-inverse.navbar-fixed-top(role="navigation")
+  .container
+    .navbar-header
+      %button.navbar-toggle(type="button" data-toggle="collapse" data-target=".navbar-collapse")
+        %span.sr-only Toggle navigation
+        %span.icon-bar
+        %span.icon-bar
+        %span.icon-bar
+      = link_to "' + @filesystem.application_human_name + '", root_path, class: "navbar-brand"
+    .navbar-collapse.collapse
+      %ul.nav.navbar-nav
+        %li= link_to "Home", root_path
+'
+    end
+
+    def messages_data
+'- {notice: "success", alert: "danger"}.each do |flash_key, alert_type|
+  - if flash[flash_key].present?
+    .alert(class="alert-#{alert_type}")
+      %button.close(type="button" data-dismiss="alert" aria-hidden="true") ×
+      = flash[flash_key]
+'
+    end
+
+    def javascript_data
+'//= require jquery
+//= require jquery_ujs
+//= require bootstrap
+//= require turbolinks
+//= require_tree .
+'
+    end
+
+    def stylesheet_data
+'@import "bootstrap";
+@import "bootstrap/theme";
+body { padding-top: 70px; }
+'
+    end
+  end
+end

data/lib/embryo/test_support.rb

@@ -0,0 +1,19 @@
+require "embryo/rspec"
+require "embryo/factory_girl"
+require "embryo/capybara"
+require "embryo/poltergeist"
+
+module Embryo
+  class TestSupport
+    def initialize(filesystem)
+      @filesystem = filesystem
+    end
+
+    def install
+      Rspec.new(@filesystem).install
+      FactoryGirl.new(@filesystem).install
+      Capybara.new(@filesystem).install
+      Poltergeist.new(@filesystem).install
+    end
+  end
+end

data/lib/rails-embryo/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Embryo
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails-embryo.rb

@@ -0,0 +1,49 @@
+require "rails/generators"
+require "rails/generators/app_base"
+require "embryo/filesystem"
+require "embryo/ruby_version"
+require "embryo/test_support"
+require "embryo/template_support"
+require "embryo/default_view"
+
+class EmbryoGenerator < Rails::Generators::Base
+  def install(force: false, bundle: false)
+    @force = force || options.force?
+    clean_files
+    add_embryo_gem
+    Embryo::RubyVersion.new(filesystem).install
+    Embryo::TestSupport.new(filesystem).install
+    Embryo::TemplateSupport.new(filesystem).install
+    Embryo::DefaultView.new(filesystem).install
+    filesystem.commit_changes
+    update_bundle if bundle
+  end
+
+  private
+
+  def clean_files
+    gemfile.remove_noise
+  end
+
+  def add_embryo_gem
+    filesystem.require_gem "rails-embryo", "~> #{Rails::Embryo::VERSION}"
+  end
+
+  def filesystem
+    @filesystem ||= Embryo::Filesystem.new self, force: @force
+  end
+
+  def gemfile
+    filesystem.gemfile
+  end
+
+  def update_bundle
+    command = "bundle install"
+    if `which bundle`.strip.present?
+      say_status :run, command
+      `#{command}`
+    else
+      say_status :skip, command, :yellow
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rails-embryo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Auton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brianauton@gmail.com
+executables:
+- rails-embryo
+extensions: []
+extra_rdoc_files: []
+files:
+- History.md
+- License.txt
+- README.md
+- bin/rails-embryo
+- lib/embryo/capybara.rb
+- lib/embryo/default_view.rb
+- lib/embryo/factory_girl.rb
+- lib/embryo/filesystem.rb
+- lib/embryo/gemfile.rb
+- lib/embryo/poltergeist.rb
+- lib/embryo/rspec.rb
+- lib/embryo/ruby_version.rb
+- lib/embryo/template_support.rb
+- lib/embryo/test_support.rb
+- lib/rails-embryo.rb
+- lib/rails-embryo/version.rb
+homepage: http://github.com/brianauton/rails-embryo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generators for quick setup of advanced Rails practices
+test_files: []