rack-gen 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd67a8559e48425c20af6f84b8d0a30b20ced7c3
+  data.tar.gz: e4ce370582105c3aee51f38e2392d4d6dfc144be
+SHA512:
+  metadata.gz: 6524d6dba54c49c530dc5cfe8c4b44405f20480d42f12b4ed5bd68c0420531c8bdad835ac4a4273885aaeb2f86ddb8fbb064464d5e58e981eda740c544206122
+  data.tar.gz: c88e9120ff5249eec27bf39768dd995e1692bc11c8838791cb517c7e21231f2a17e3ef24d92cd8e19bd302161da0242f9b241b51b2218ace3bfcb827363651e5

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 rack-generator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Zeiler
+
+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,71 @@
+# Rack::Generator
+
+Rack Generator is used to create the most basic ruby web application using the rack framework.
+
+Rack is the underlying technology behind popular web ruby frameworks like sinatra and rails. The gem was designed to be the perfect tool for introducing students to ruby on the web and get them started with basic html, css, and javascript
+
+## INSTALLATION
+
+    git clone https://github.com/stevenzeiler/rack-generator.git
+    gem build rack-generator.gemspec
+    gem install rack-generator-0.2.0.gem
+
+## USAGE
+
+Generate a new rack application, which consists of three files.
+
+	  rack new myappname --heroku
+  
+You will see output from several operations, which will are explained below
+
+    Initialized empty Git repository in /Users/stevenzeiler/Desktop/szrack/.git/
+    Fetching gem metadata from https://rubygems.org/..........
+    Resolving dependencies...
+    Using rack (1.5.2) 
+    Using bundler (1.3.5) 
+    Your bundle is complete!
+    Use `bundle show [gemname]` to see where a bundled gem is installed.
+    [master (root-commit) 09f1907] add most basic rack app
+     4 files changed, 46 insertions(+), 0 deletions(-)
+     create mode 100644 Gemfile
+     create mode 100644 Gemfile.lock
+     create mode 100644 config.ru
+     create mode 100644 index.html
+    Creating evening-brushlands-9923... done, region is us
+    http://evening-brushlands-9923.herokuapp.com/ | git@heroku.com:evening-brushlands-9923.git
+    Git remote heroku added
+
+1. A directory is created given the name you specify in the create command. In this case it is `myappname`.
+
+2. A git repository is created in the project directory.
+
+3. Three files are copied into the project directory. These files are the mininum needed to serve a web page with ruby:
+
+  - Gemfile - bundler uses this file to download the right gems. Our rack app requires only the `rack` gem.
+  - config.ru - runs two commands to set up the rack server and configure public file access.
+  - index.html - the 'single-page' application file that represents the visual user interface.
+
+4. A /public directory is created from where files can be downloaded over the web.
+
+5. The `bundle` command is run, which downloads the required gems and creates a Gemfile.lock. The lock file is required by Heroku in order to download the proper gems.
+
+6. The four files and one directory are copied into the git repository.
+
+7. A heroku application is created and the `heroku` remote is added to git. You can now push to heroku, which happens next automatically.
+
+8. The rack app is pushed to heroku, where a virutal linux machine is provisioned. When the build process is finished the rack app will open in your system's default browser.
+
+
+## Running Locally
+
+To run the application locally start a web server with rack's startup mechanism. Navigate to the project directory and run:
+
+    rackup
+
+`Rackup` will look for a file named `config.ru` ("ru" stands for "rackup") and run its contents in hopes of finding a rack-compatible object to execute.
+
+    
+## Motivation
+
+My motivation for creating this gem was to uncomplicate the process of learning to deploy a web site using ruby and heroku. When I try to teach rails to people there is usually too much information for them to handle all at once, especially from the beginning. Rails generates so many files for you and then you must ask the students to not worry about what is going on with the majority of the files. One solution to this problem is to have the students begin with the sinatra framework, which strips out almost everything rails offers by default and makes it possible to run simple static ruby server applications. Both rails and sinatra are based on a lower-level framework that is directly responsible for handling http requests and responses. Since it is inherently valuable to start from the most fundamental principles and build increasingly complex abractions on top I like to start students off with the most basic rack server application that can be deployed to heroku. 
+

data/Rakefile

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

data/bin/rack

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'trollop'
+
+opts = Trollop::options do
+  opt :heroku, "Create heroku app" # flag --heroku, default false
+end
+
+root = File.dirname(__FILE__)
+
+
+if ARGV[0] == "new"
+	directory = ARGV[1]
+	if system "mkdir -p #{directory}/public"
+    system "cp #{root}/../lib/templates/config.ru #{directory}/config.ru"
+    system "cp #{root}/../lib/templates/index.html #{directory}/index.html"
+    system "cp #{root}/../lib/templates/Gemfile #{directory}/Gemfile"
+	  system "cd #{directory} && git init && bundle install"
+    system "cd #{directory} && git add . && git commit -m 'add most basic rack app'"
+
+    if opts[:heroku]
+      system "cd #{directory} && heroku create && git push heroku master && heroku open"
+    end 
+	else
+		puts "A directory called #{directory} already exists."
+	end 
+end 

data/lib/templates/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rack'
+

data/lib/templates/config.ru

@@ -0,0 +1,6 @@
+use Rack::Static, :root => "#{File.dirname(__FILE__)}/", 
+                  :index => "index.html"
+
+run lambda { |env|  
+  Rack::Directory.new( "#{File.dirname(__FILE__)}/public" ).call(env) 
+}

data/lib/templates/index.html

@@ -0,0 +1,27 @@
+<html>
+	<head>
+    <style>
+      body {
+        background-color: #aaa;
+        font-size: 200%;     
+        padding:0.3em;
+      }
+      section {    
+        background-color: #eee;
+        padding:2em;
+        margin:auto;
+        text-align:center;
+      } 
+    </style>
+  </head>
+
+	<body>
+    <section>
+		  <h1>Running on Rack!!</h1>
+    </section>
+	</body>
+
+	<script type="text/javascript">
+      console.log(document.getElementsByTagName("section")[0]);
+  </script>
+</html>

data/rack-generator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-gen"
+  spec.version       = "0.3.0"
+  spec.authors       = ["Steven Zeiler"]
+  spec.email         = ["zeiler.steven@gmail.com"]
+  spec.description   = %q{A gem to generate the most basic static web server}
+  spec.summary       = %q{A basic rack server app generator}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib/templates"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.executables << 'rack'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: rack-gen
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Steven Zeiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: A gem to generate the most basic static web server
+email:
+- zeiler.steven@gmail.com
+executables:
+- rack
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rack
+- lib/templates/Gemfile
+- lib/templates/config.ru
+- lib/templates/index.html
+- rack-generator.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/templates
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A basic rack server app generator
+test_files: []