xrails 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Alessio Rocco
+
+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,67 @@
+xRails is a base Rails application that you can upgrade.
+
+Installation
+------------
+
+First install the xRails gem:
+
+    gem install xrails
+
+Then run:
+
+    xrails create projectname
+
+This will create a Rails 3 app in `projectname'. This script creates a
+new git repository. It is not meant to be used against an existing repo.
+
+Gemfile
+-------
+
+To see the latest and greatest gems, look at xRails'
+[template/files/xrails_Gemfile](https://github.com/AlessioRocco/xRails/template/files/xrail_Gemfile),
+which will be copied into your projectname/Gemfile.
+
+It includes application gems like:
+
+* [jQuery](https://github.com/jquery/jquery) for Javascript pleasantry
+* [Will Paginate](https://github.com/mislav/will_paginate) for pagination
+
+And testing gems like:
+
+* [Cucumber](https://github.com/aslakhellesoy/cucumber-rails) for integration testing
+* [Webrat](https://github.com/brynary/webrat) for acceptance tests
+* [Database Cleaner](https://github.com/bmabey/database_cleaner) for cleaning your database
+* [RSpec](https://github.com/rspec/rspec) for awesome, readable isolation testing
+* [Shoulda](http://github.com/thoughtbot/shoulda) for frequently needed Rails and RSpec matchers
+
+Other goodies
+-------------
+
+xRails also comes with:
+
+* Rails' flashes set up and in application layout.
+* A few nice time formats.
+
+See [template/files](https://github.com/AlessioRocco/xRails/template/files) to
+see what is generated one-time.
+
+Issues
+------
+
+If you have problems, please create a [Github issue](https://github.com/AlessioRocco/xRails/issues).
+
+Credits
+-------
+
+This gem is forked by Suspenders:
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+Suspenders is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+License
+-------
+
+xRails is Copyright © 2008-2011 Alessio Rocco. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'rake'
+require 'cucumber/rake/task'
+require 'date'
+
+XRAILS_GEM_VERSION = '0.1.0'
+
+#############################################################################
+#
+# Testing functions
+#
+#############################################################################
+
+Cucumber::Rake::Task.new
+
+namespace :test do
+  desc "A full xrails app's test suite"
+  task :full => ['cucumber']
+end
+
+desc 'Run the test suite'
+task :default => ['test:full']
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  XRAILS_GEM_VERSION
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/bin/xrails

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/create")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/errors")
+
+include XRails::Errors
+
+def usage
+  "Usage: #{File.basename(__FILE__)} create new_project_name"
+end
+
+case ARGV[0]
+when 'create', '--create'
+  begin
+    XRails::Create.run!(ARGV[1])
+  rescue XRails::InvalidInput => e
+    error_with_message(e.message)
+  end
+when 'help', '--help'
+  puts usage
+else
+  error_with_message "Unknown subcommand: #{ARGV[0]}\n#{usage}"
+end

data/features/rake_clean.feature

@@ -0,0 +1,15 @@
+Feature: Rake works in the suspended project
+
+  Scenario: Running rake in the suspended project
+    Given a new xrails project named "test_project"
+    When I create the required databases
+    And I run the rake task "cucumber"
+    Then I see a successful response in the shell
+
+  Scenario: Making a spec then running rake
+    Given a new xrails project named "test_project"
+    When I create the required databases
+    And I generate "model post title:string"
+    And I run the rake task "db:migrate"
+    And I run the rake task "spec"
+    Then I see a successful response in the shell

data/features/step_definitions/shell.rb

@@ -0,0 +1,28 @@
+Given 'a new xrails project named "$project_name"' do |project_name|
+  `rm -rf  ./#{project_name}`
+  `./bin/xrails create #{project_name}`
+end
+
+When 'I run the rake task "$task_name"' do |task_name|
+  Dir.chdir('test_project') do
+    system("rake #{task_name}")
+  end
+end
+
+When 'I generate "$generator_with_args"' do |generator_with_args|
+  Dir.chdir('test_project') do
+    system("rails generate #{generator_with_args}")
+  end
+end
+
+Then 'I see a successful response in the shell' do
+  $?.to_i.should == 0
+end
+
+When 'I create the required databases' do
+  Dir.chdir('test_project') do
+    system("rake db:create")
+    system("rake db:migrate")
+    system("rake db:test:prepare")
+  end
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+

data/lib/create.rb

@@ -0,0 +1,54 @@
+# Methods needed to create a project.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/errors")
+
+module XRails
+  class Create
+    attr_accessor :project_path
+
+    def self.run!(project_path)
+      creator = self.new(project_path)
+      creator.create_project!
+    end
+
+    def initialize(project_path)
+      self.project_path = project_path
+      validate_project_path
+      validate_project_name
+    end
+
+    def create_project!
+      exec(<<-COMMAND)
+        rails new #{project_path} \
+          --template=#{template} \
+          --skip-test-unit \
+          --skip-prototype
+      COMMAND
+    end
+
+    private
+
+    def validate_project_name
+      project_name = File.basename(project_path)
+      unless project_name =~ /^[a-z0-9_]+$/
+        raise InvalidInput.new("Project name must only contain [a-z0-9_]")
+      end
+    end
+
+    def validate_project_path
+      base_directory = Dir.pwd
+      full_path = File.join(base_directory, project_path)
+
+      # This is for the common case for the user's convenience; the race
+      # condition can still occur.
+      if File.exists?(full_path)
+        raise InvalidInput.new("Project directory (#{project_path}) already exists")
+      end
+    end
+
+    def template
+      File.expand_path(File.dirname(__FILE__) + "/../template/xrails.rb")
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,12 @@
+# User errors
+
+module XRails
+  class InvalidInput < Exception; end
+
+  module Errors
+    def error_with_message(msg)
+      STDERR.puts msg
+      exit 1
+    end
+  end
+end

data/template/files/_flashes.html.erb

@@ -0,0 +1,5 @@
+<div id="flash">
+  <% flash.each do |key, value| -%>
+    <div id="flash_<%= key %>"><%=h value %></div>
+  <% end -%>
+</div>

data/template/files/xrails_Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+
+gem "rails", ">= 3.0.7"
+gem "sqlite3"
+gem "rack"
+gem "will_paginate"
+gem "jquery-rails"
+
+# RSpec needs to be in :development group to expose generators
+# and rake tasks without having to type RAILS_ENV=test.
+group :development, :test do
+  gem "rspec-rails", "~> 2.4"
+  gem "cucumber-rails"
+  gem "webrat"
+  gem "database_cleaner"
+  gem "shoulda"
+end

data/template/files/xrails_gitignore

@@ -0,0 +1,11 @@
+db/schema.rb
+public/system
+*.DS_Store
+coverage/*
+*.swp
+rerun.txt
+tags
+!.keep
+vendor/bundler_gems
+.rvmrc
+.idea

data/template/files/xrails_layout.html.erb.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title><%= @title ||= "Title" %></title>
+    <meta name="description" content="<%= @description ||= "Description" %>" />
+    <meta name="keywords" content="<%= @keywords ||= "Keywords"%>" />
+
+    <link rel="shortcut icon" href="/favicon.ico" />
+
+    <%= stylesheet_link_tag "http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.9/themes/base/jquery-ui.css" %>
+    <%= stylesheet_link_tag :all %>
+    <%= javascript_include_tag 'jquery', 'jquery-ui', 'rails', 'application', :cache => true %>
+
+    <%= yield :head %>
+
+    <%= csrf_meta_tag %>
+  </head>
+  <body>
+    <%= render "shared/flashes" %>
+
+    <%= yield %>
+  </body>
+</html>

data/template/xrails.rb

@@ -0,0 +1,84 @@
+# xRails
+# =============
+# by Alessio Rocco
+
+require 'net/http'
+require 'net/https'
+
+template_root = File.expand_path(File.join(File.dirname(__FILE__)))
+source_paths << File.join(template_root, "files")
+
+# Helpers
+
+def concat_file(source, destination)
+  contents = IO.read(find_in_source_paths(source))
+  append_file destination, contents
+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
+
+def action_mailer_host(rails_env, host)
+  inject_into_file(
+    "config/environments/#{rails_env}.rb",
+    "\n\n  config.action_mailer.default_url_options = { :host => '#{host}' }",
+    :before => "\nend"
+  )
+end
+
+def download_file(uri_string, destination)
+  uri = URI.parse(uri_string)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true if uri_string =~ /^https/
+  request = Net::HTTP::Get.new(uri.path)
+  contents = http.request(request).body
+  path = File.join(destination_root, destination)
+  File.open(path, "w") { |file| file.write(contents) }
+end
+
+say "Getting rid of files we don't use"
+
+remove_file "README"
+remove_file "public/index.html"
+remove_file "public/images/rails.png"
+
+say "Setting up the staging environment"
+
+run "cp config/environments/production.rb config/environments/staging.rb"
+
+say "Creating xRails views"
+
+empty_directory "app/views/shared"
+copy_file "_flashes.html.erb", "app/views/shared/_flashes.html.erb"
+copy_file "xrails_layout.html.erb.erb",
+         "app/views/layouts/application.html.erb",
+         :force => true
+
+say "Get ready for bundler... (this will take a while)"
+
+copy_file 'xrails_Gemfile', 'Gemfile', :force => true
+run "bundle install"
+
+say "Setting up plugins"
+
+generate "jquery:install", "--ui"
+generate "rspec:install"
+generate "cucumber:install", "--rspec --webrat"
+
+say "Ignore the right files"
+
+concat_file "xrails_gitignore", ".gitignore"
+empty_directory_with_gitkeep "app/models"
+empty_directory_with_gitkeep "db/migrate"
+empty_directory_with_gitkeep "log"
+empty_directory_with_gitkeep "public/images"
+empty_directory_with_gitkeep "spec/support"
+
+say "Congratulations! You just pulled our xRails."
+

data/xrails.gemspec

@@ -0,0 +1,52 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.6.2'
+
+  s.name    = 'xrails'
+  s.version = '0.1.0'
+  s.date    = '2011-05-10'
+
+  s.summary     = "Generate a Rails app using Alessio Rocco's best practices."
+  s.description = <<-HERE
+xRails is a base Rails project that you can upgrade. It is used by
+Alessio Rocco to get a jump start on a working app. Use xRails if you're in a
+rush to build something amazing; don't use it if you like missing deadlines.
+  HERE
+
+  s.authors  = ["thoughtbot", "Alessio Rocco"]
+  s.email    = 'alessio.rocco.lt@gmail.com'
+  s.homepage = 'http://github.com/AlessioRocco/xRails'
+
+  s.executables = ["xrails"]
+  s.default_executable = 'xrails'
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('rails', '>= 3.0.3')
+  s.add_dependency('bundler', '>= 1.0.7')
+  s.add_dependency('trout', '>= 0.3.0')
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    bin/xrails
+    features/rake_clean.feature
+    features/step_definitions/shell.rb
+    features/support/env.rb
+    lib/create.rb
+    lib/errors.rb
+    template/files/_flashes.html.erb
+    template/files/xrails_Gemfile
+    template/files/xrails_gitignore
+    template/files/xrails_layout.html.erb.erb
+    template/xrails.rb
+    xrails.gemspec
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select {|path| path =~ /^features/ }
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: xrails
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- thoughtbot
+- Alessio Rocco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-10 00:00:00 +02:00
+default_executable: xrails
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: trout
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id003
+description: |
+  xRails is a base Rails project that you can upgrade. It is used by
+  Alessio Rocco to get a jump start on a working app. Use xRails if you're in a
+  rush to build something amazing; don't use it if you like missing deadlines.
+
+email: alessio.rocco.lt@gmail.com
+executables: 
+- xrails
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- bin/xrails
+- features/rake_clean.feature
+- features/step_definitions/shell.rb
+- features/support/env.rb
+- lib/create.rb
+- lib/errors.rb
+- template/files/_flashes.html.erb
+- template/files/xrails_Gemfile
+- template/files/xrails_gitignore
+- template/files/xrails_layout.html.erb.erb
+- template/xrails.rb
+- xrails.gemspec
+has_rdoc: true
+homepage: http://github.com/AlessioRocco/xRails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 2
+summary: Generate a Rails app using Alessio Rocco's best practices.
+test_files: 
+- features/rake_clean.feature
+- features/step_definitions/shell.rb
+- features/support/env.rb