snfn 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+#  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+#  gem "rcov", ">= 0"
+end
+
+gem "thor"

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  thor

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Zach Pendleton
+
+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.mdown

@@ -0,0 +1,80 @@
+# Snfn - A Sinatra application generator
+
+Snfn is an opinionated generator for Sinatra projects. It
+can be configured using the following options:
+
+*  -d : Database. Options are "postgres," "mysql," "sqlite",
+   and "mongo." Default is "sqlite."
+*  --redis : Include Redis configuration options.
+* --no-database : Don't include any database config options.
+* --no-heroku : Don't include Heroku config options.
+
+## Installation
+
+    gem install snfn
+
+## Example
+
+Standard Heroku app, using sqlite for local development and
+PostgreSQL for production.
+
+    snfn new my_app
+
+App without Heroku options and mysql config.
+
+    snfn new my_app -d mysql --no-heroku
+
+## Architecture
+
+The template autoloads files in config/initializers and
+/lib. Database configuration options are stored in `config/db.yml`
+and are loaded via `config/initializers/database.rb`.
+
+Right now Snfn only supports Unicorn as a server, with the config
+stored at config/unicorn.rb.
+
+## DB Setup
+
+Sequel is used as an ORM for relational databases,
+and migrations are stored in db/migrate. Migrations can be
+run using the rake command `rake migrate`.
+
+MongoMapper is used for Mongo apps, with the config options
+stored in the same files as relational databases (`config/db.yml`
+and `config/initializers/database.rb`).
+
+## Set up on Heroku
+
+By default, Snfn creates an app with the proper options for deployment
+on Heroku. To get Snfn up and running on Heroku:
+
+1.  Install your gems with `bundle install`
+2.  Create a new git repository: `git init .`
+3.  Make your first commit: `git add .; git commit -m "initial commit"`
+4.  Create a new heroku app: `bundle exec heroku create --stack cedar`
+5.  Deploy the app: `git push heroku master`
+
+### Heroku Add-Ons
+
+To use PostgreSQL, MongoDB, or Redis on Heroku, you'll need to add
+the proper Heroku add-ons. The commands to do this are, respectively:
+
+    heroku addons:add shared_database # PostgreSQL
+    heroku addons:add mongolab:starter: # MongoDB
+    heroku addons:add redistogo:nano # Redis
+
+## Contributing to snfn
+
+*  Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+*  Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+*  Fork the project
+*  Start a feature/bugfix branch
+*  Commit and push until you are happy with your contribution
+*  Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+*  Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Zach Pendleton. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "snfn"
+  gem.homepage = "http://github.com/zachpendleton/snfn"
+  gem.license = "MIT"
+  gem.summary = %Q{A Heroku-friendy Sinatra app generator}
+  gem.description = %Q{An app generator for Sinatra apps with an eye towards easy Heroku setup and deployment.}
+  gem.email = "zachpendleton@gmail.com"
+  gem.authors = ["Zach Pendleton"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "snfn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/snfn

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+%w{rubygems extensions/string thor}.each do |lib|
+  require lib
+end
+
+class SnfnGenerator < Thor
+  include Thor::Actions
+
+  desc "new NAME", "Creates new Snfn application"
+  method_option :database, :aliases => "-d", :default => "postgres", :desc => "The type of database to use. Values are \"sqlite\", \"postgres\", \"mysql\", and \"mongo\". Default is \"postgres\"."
+  method_option :no_heroku, :type => :boolean, :desc => "Include Heroku configuration options."
+  method_option :no_database, :type => :boolean, :desc => "Do not use any database."
+  method_option :redis, :type => :boolean, :desc => "Include Redis configuration options."
+  def new(name)
+    @name = @app_path = name.file_name
+    @database = options[:database]
+    @no_database = options[:no_database]
+    @redis = options[:redis]
+    @no_heroku = options[:no_heroku]
+
+    create_directories
+    add_templates
+  end
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "templates"))
+  end
+
+  protected
+  def create_directories
+    %w{config/initializers db/migrate lib log tmp}.each do |dir|
+      add_app_directory dir
+    end
+
+    %w{public/css public/js public/img views}.each do |dir|
+      directory dir, File.join(@app_path, dir)
+    end
+  end
+
+  def add_templates
+    copy_template "app.rb", "#{@name}.rb"
+    copy_template "config.ru"
+    copy_template "Gemfile"
+    copy_static "Procfile" unless @no_heroku
+    copy_static "Rakefile"
+    copy_static "README.mdown"
+    copy_template "config/unicorn.rb"
+
+    copy_static "config/redis.yml" if @redis
+    copy_template "config/db.yml" unless @no_database
+    copy_template "config/initializers/database.rb"
+  end
+
+  def add_app_directory(name)
+    empty_directory(File.join(@app_path, name))
+  end
+
+  def copy_template(name, new_name = nil)
+    new_name ||= name
+    template name, File.join(@app_path, new_name)
+  end
+
+  def copy_static(name)
+    copy_file name, File.join(@app_path, name)
+  end
+end
+
+SnfnGenerator.start
+

data/lib/extensions/string.rb

@@ -0,0 +1,35 @@
+module Snfn
+  module Extensions
+    module String
+      def camel_case
+        return self if !match(/_/)
+        altered_self = self.capitalize
+        altered_self.scan(/_[a-zA-Z]/).each do |match|
+          altered_self.gsub!(match, match[1].upcase)
+        end
+
+        altered_self
+      end
+
+      def camel_case!
+        self.replace camel_case
+      end
+
+      def file_name
+        return self if !match(/[A-Z]/)
+        altered_self = self.strip
+        altered_self.scan(/[A-Z]/).each do |match|
+          altered_self.gsub!(match, "_#{match.downcase}")
+        end
+
+        altered_self.sub(/^_/, "")
+      end
+
+      def file_name!
+        self.replace file_name
+      end
+    end
+  end
+end
+
+String.send(:include, Snfn::Extensions::String)

data/lib/snfn.rb

@@ -0,0 +1 @@
+

data/lib/templates/Gemfile

@@ -0,0 +1,48 @@
+source "http://rubygems.org"
+
+# App Stack
+<% if !@no_heroku -%>
+gem "foreman"
+gem "heroku"
+<% end -%>
+gem "sinatra"
+gem "unicorn"
+
+<% unless @no_database -%>
+# Database Stack
+<% unless @database == 'mongo' -%>
+gem "sequel"
+<% end -%>
+<% if @database == "sqlite" -%>
+<% if !@no_heroku -%>
+group :development, :test do
+  gem "sqlite3"
+end
+<% else -%>
+gem "sqlite3"
+<% end -%>
+<% elsif @database == "postgres" -%>
+gem "pg"
+<% elsif @database == "mysql" -%>
+<% if !@no_heroku -%>
+group :development, :test do
+  gem "mysql2"
+end
+<% else -%>
+gem "mysql2"
+<% end -%>
+<% elsif @database == "mongo" -%>
+gem "bson_ext"
+gem "mongo_mapper"
+<% end -%>
+<% if !@no_heroku && @database != "postgres" && @database != "mongo" -%>
+group :production do
+  gem "pg"
+end
+<% end -%>
+<% if @redis -%>
+# Redis
+gem "redis"
+<% end -%>
+<% end -%>
+

data/lib/templates/Procfile

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

data/lib/templates/README.mdown

@@ -0,0 +1,60 @@
+# Snfn - A Sinatra application generator
+
+Snfn is an opinionated generator for Sinatra projects. It
+can be configured using the following options:
+
+*  -d : Database. Options are "postgres," "mysql," "sqlite",
+   and "mongo." Default is "sqlite."
+*  --redis : Include Redis configuration options.
+* --no-database : Don't include any database config options.
+* --no-heroku : Don't include Heroku config options.
+
+## Example
+
+Standard Heroku app, using sqlite for local development and
+PostgreSQL for production.
+
+    snfn new my_app
+
+App without Heroku options and mysql config.
+
+    snfn new my_app -d mysql --no-heroku
+
+## Architecture
+
+The template autoloads files in config/initializers and
+/lib. Database configuration options are stored in `config/db.yml`
+and are loaded via `config/initializers/database.rb`.
+
+Right now Snfn only supports Unicorn as a server, with the config
+stored at config/unicorn.rb.
+
+## DB Setup
+
+Sequel is used as an ORM for relational databases,
+and migrations are stored in db/migrate. Migrations can be
+run using the rake command `rake migrate`.
+
+MongoMapper is used for Mongo apps, with the config options
+stored in the same files as relational databases (`config/db.yml`
+and `config/initializers/database.rb`).
+
+## Set up on Heroku
+
+By default, Snfn creates an app with the proper options for deployment
+on Heroku. To get Snfn up and running on Heroku:
+
+1.  Install your gems with `bundle install`
+2.  Create a new git repository: `git init .`
+3.  Make your first commit: `git add .; git commit -m "initial commit"`
+4.  Create a new heroku app: `bundle exec heroku create --stack cedar`
+5.  Deploy the app: `git push heroku master`
+
+### Heroku Add-Ons
+
+To use PostgreSQL, MongoDB, or Redis on Heroku, you'll need to add
+the proper Heroku add-ons. The commands to do this are, respectively:
+
+    heroku addons:add shared_database # PostgreSQL
+    heroku addons:add mongolab:starter: # MongoDB
+    heroku addons:add redistogo:nano # Redis

data/lib/templates/Rakefile

@@ -0,0 +1,20 @@
+%w{ rubygems bundler find}.each { |lib| require lib }
+
+namespace :db do
+  desc "Run all migrations in db/migrate"
+  task :migrate => :connect do
+    Sequel.extension(:migration)
+    Sequel::Migrator.apply(DB, "db/migrate")
+  end
+
+  task :connect => :environment do
+    require "./config/initializers/database"
+  end
+end
+
+task :environment, [:env] do |cmd, args|
+  Bundler.require
+  ENV['RACK_ENV'] = args[:env] || "development"
+  Find.find("lib") { |f| require f unless f.match(/\/\..+$/) || File.directory?(f) }
+end
+

data/lib/templates/app.rb

@@ -0,0 +1,11 @@
+class <%= @name.camel_case %> < Sinatra::Base
+
+  set :public => "public", :static => true
+
+  get "/" do
+    @version     = RUBY_VERSION
+    @environment = ENV['RACK_ENV']
+
+    erb :welcome
+  end
+end

data/lib/templates/config/db.yml

@@ -0,0 +1,35 @@
+# Sequel Database Configuration
+<% if @database == "sqlite" %>
+development: "sqlite://db/development.sqlite3"
+test: "sqlite://db/test.sqlite3"
+production: "sqlite://db/production.sqlite3"
+<% elsif @database == "postgres" %>
+development: "postgres://<%= `whoami`.chop %>@localhost/<%= @name %>_development"
+test: "postgres://<%= `whoami`.chop %>@localhost/<%= @name %>_test"
+production: "postgres://<%= `whoami`.chop %>@localhost/<%= @name %>_production"
+<% elsif @database == "mysql" %>
+development: "mysql2://<%= `whoami`.chop %>@localhost/<%= @name %>_development"
+test: "mysql2://<%= `whoami`.chop %>@localhost/<%= @name %>_test"
+production: "mysql2://<%= `whoami`.chop %>@localhost/<%= @name %>_production"
+<% elsif @database == "mongo" %>
+development:
+  host: localhost
+  port: 27017
+  database: <%= @name %>_development
+  username:
+  password:
+
+test:
+  host: localhost
+  port: 27017
+  database: <%= @name %>_test
+  username:
+  password:
+
+production:
+  host: localhost
+  port: 27017
+  database: <%= @name %>_production
+  username:
+  password:
+<% end %>

data/lib/templates/config/initializers/database.rb

@@ -0,0 +1,27 @@
+<% unless @no_database -%>
+settings = YAML::load_file("config/db.yml")
+<% if @database != 'mongo' -%>
+# Sequel Configuration
+DB = Sequel.connect(<% if !@no_heroku %>ENV['DATABASE_URL'] || <% end %>settings[ENV['RACK_ENV']])
+<% else -%>
+# MongoMapper Configuration
+<% if !@no_heroku -%>
+settings[ENV['RACK_ENV']]["uri"] = ENV['MONGOLAB_URI']
+<% end -%>
+MongoMapper.config = settings
+MongoMapper.connect(ENV['RACK_ENV'])
+<% end -%>
+
+<% end -%>
+<% if @redis -%>
+# Redis Configuration
+if ENV['REDISTOGO_URL']
+require "uri"
+uri = URI.parse(ENV['REDISTOGO_URL'])
+REDIS = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
+else
+redis_settings = YAML::load_file("config/redis.yml")
+REDIS = Redis.new(redis_settings[ENV['RACK_ENV']])
+end
+<% end -%>
+

data/lib/templates/config/redis.yml

@@ -0,0 +1,14 @@
+development:
+  host: localhost
+  port: 6387
+  password:
+
+test:
+  host: localhost
+  port: 6387
+  password:
+
+production:
+  host: localhost
+  port: 6387
+  password:

data/lib/templates/config/unicorn.rb

@@ -0,0 +1,12 @@
+worker_processes 3
+timeout 30
+
+<% if @noheroku -%>
+docroot = File.join(File.expand_path(File.dirname(__FILE__)), "..")
+
+listen "#{docroot}/tmp/sockets/unicorn.sock"
+pid "#{docroot}/tmp/pids/unicorn.pid"
+
+stderr_path "#{docroot}/log/stderr.log"
+stdout_path "#{docroot}/log/stdout.log"
+<% end -%>

data/lib/templates/config.ru

@@ -0,0 +1,15 @@
+# Load path and gems/bundler
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+require "rubygems"
+require "bundler"
+Bundler.require
+
+# Local config
+require "find"
+%w{config/initializers lib}.each do |load_path|
+  Find.find(load_path) { |f| require f unless f.match(/\/\..+$/) || File.directory?(f) }
+end
+
+# Load app
+require "<%= @name %>"
+run <%= @name.camel_case %>

data/lib/templates/public/css/main.css

@@ -0,0 +1,87 @@
+@media screen {
+  /* --- Reset Styles --- */
+  * {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+  }
+
+  html, body {
+    height: 100%;
+    width: 100%;
+  }
+
+  /* --- Welcome Page Styles --- */
+  body {
+    background: #eee;
+    color: #333;
+    font-family: Sans-Serif;
+    line-height: 18px;
+  }
+
+  .wrapper {
+    background: #fff;
+    -moz-box-shadow: 0 0 10px rgba(0,0,0,.3);
+    -webkit-box-shadow: 0 0 10px rgba(0,0,0,.3);
+    box-shadow: 0 0 10px rgba(0,0,0,.3);
+    margin: 20px auto;
+    padding: 18px;
+    width: 764px;
+  }
+
+  h1 {
+    font-size: 36px;
+    line-height: 54px;
+  }
+
+  h2 {
+    border-bottom: 2px solid #ccc;
+    font-size: 24px;
+    line-height: 36px;
+    margin-bottom: 16px;
+  }
+
+  h3 {
+    font-size: 18px;
+    line-height: 36px;
+  }
+
+  p {
+    margin-bottom: 18px;
+  }
+
+  .main {
+    overflow: hidden;
+  }
+
+  .content {
+    float: left;
+    width: 480px;
+  }
+
+  .sidebar {
+    background: #eee;
+    border: 1px solid #ccc;
+    float: right;
+    padding: 9px;
+    width: 240px;
+  }
+
+  .sidebar ul {
+    font-size: 14px;
+  }
+
+  .branding {
+    clear: both;
+  }
+
+  footer.branding {
+    border-top: 2px solid #ccc;
+    margin-top: 20px;
+    padding-top: 20px;
+  }
+}
+
+@media print {
+
+}

data/lib/templates/public/js/app.js

@@ -0,0 +1,4 @@
+/**
+ * Application-specific JavaScript goes here.
+ *
+ */