hyperloop 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 535e10622d43abc48b580faae7406dd583de7088
-  data.tar.gz: f7a0bf12b3c795f531534dea263a6ab0bea2d752
+  metadata.gz: 2dfb955d1503bb9133c9c4f83c7813a1a65a1f41
+  data.tar.gz: 9321f9d51755fbeef6ef2bd694c3a129d273cbe4
 SHA512:
-  metadata.gz: 06e67575817dae6fb4d83458255ac4abf763ccf6d577c273b5a9b48db4e86bde746274cd64b6c91a1486f29a83bccca4a56ac36255fe961a49a6029cfddee66c
-  data.tar.gz: 1fa91fce8a2fc81f8d8de9a464216ab689723ce7723f030279b24153215f26ccdea1a58e2253d5b687777a6fe15a76ccac4475152001f8e3638a866a12f2f251
+  metadata.gz: 9c03dd0d3a042535c644e6db73be972d79783f92ed9a1231889050f3e086693aadb59d0b25716289646ba982737c2d0684c9dd1549993ca27edf4c42c10e9e94
+  data.tar.gz: f97317e18c1b3aa65243650b00d18fd235252799d6b740c5af0f409168e7f12e0bc98683f7424f9cd73bf76f2d0abb02dcb0081bc0b3cea2af64a26cf1e53d5c

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

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

data/README.md

@@ -1,24 +1,102 @@
-# Hyperloop
+# Hyperloop [![Build Status](https://travis-ci.org/jakeboxer/hyperloop.png?branch=master)](https://travis-ci.org/jakeboxer/hyperloop)
 
-Make simple websites with a technology stack familiar to Rails programmers.
+Hyperloop is a framework that lets you make static websites with a technology stack familiar to Rails programmers.
 
-## Installation
+Before you keep reading, let's get one thing out of the way:
 
-Add this line to your application's Gemfile:
+### If you think your website might need a database, do not use Hyperloop.
 
-    gem 'hyperloop'
+I came up with the idea for Hyperloop after hearing one too many experienced web developers say "I don't even know how
+to set up a regular website anymore."
 
-And then execute:
+With Hyperloop, you can create a new site just like you would with Rails. You can write ERB and Sass and CoffeeScript
+and all that other good stuff. You can use layouts and partials and deploy to Heroku.
 
-    $ bundle
+Basically, you can do all the stuff you're used to with Rails. On top of that, you don't have to type any of the magic
+incantations that just aren't necessary in a static site. You don't have to set up routes. You don't have to make
+controllers with a method for every view. You don't have to think about environments or tests or schemas or helpers or
+any of the other boilerplate directories/files that would clutter up a static site being shoehorned into a Rails app.
 
-Or install it yourself as:
+## Getting Started
 
-    $ gem install hyperloop
+1. Install Hyperloop and Thin at the command prompt if you haven't yet:
 
-## Usage
+        gem install hyperloop
+        gem install thin
 
-TODO: Write usage instructions here
+2. At the command prompt, create a new Hyperloop site:
+
+        hyperloop new mysite
+
+   where "mysite" is the site name.
+
+3. Change directory to `mysite` and start the web server:
+
+        cd mysite
+        thin start
+
+4. Go to [http://localhost:3000/](http://localhost:3000/) and you'll see your brand new website!
+
+## Structure
+
+### Layout
+
+Your layout is in `app/views/layouts/application.html.erb`.
+
+### Views
+
+Your site root is in `app/views/index.html.erb`.
+
+If you create `app/views/hello.html.erb`, you'll be able to get to it by going to
+[http://localhost:3000/hello/](http://localhost:3000/hello/).
+
+### Subdirectories
+
+You can nest views in subdirectories. If you create the following files, the following URLs will work:
+
+- `app/views/people/ted_nyman.html.erb` will make [http://localhost:3000/people/ted_nyman/](http://localhost:3000/people/ted_nyman/) work.
+- `app/views/people/index.html.erb` will make [http://localhost:3000/people/](http://localhost:3000/people/) work.
+- `app/views/projects/2013/yeezus.html.erb` will make [http://localhost:3000/projects/2013/yeezus/](http://localhost:3000/projects/2013/yeezus/) work.
+
+### Partials
+
+If you create `app/views/_some_section.html.erb`, you'll be able to load it as a partial almost like you would in Rails:
+
+``` ruby
+<%= render "some_section" %>
+```
+
+Note: In Rails, it's `<%= render :partial => "some_section" %>`, since there are other things you could want to render
+besides a partial. In Hyperloop, there aren't, so the options hash isn't necessary.
+
+### CSS, SCSS, Sass, JavaScript, and CoffeeScript
+
+If you create some files like:
+
+```
+app/assets/stylesheets/bootstrap.css
+app/assets/stylesheets/stylez1.css
+app/assets/stylesheets/stylez2.scss
+app/assets/javascripts/jquery.js
+app/assets/javascripts/scriptz1.js
+app/assets/javascripts/scriptz2.coffee
+```
+
+They'll be included in all your views, so long as you have these two tags:
+
+``` html
+<!-- I suggest putting this in between <head> and </head> -->
+<link href="/assets/stylesheets/app.css" media="all" rel="stylesheet" type="text/css">
+
+<!-- I suggest putting this at the end of the document body (as in, right before </body>) -->
+<script src="/assets/javascripts/app.js" type="text/javascript"></script>
+```
+
+somewhere in your layout. All your CSS and JS assets belong in these folders, including vendored ones like jQuery and Bootstrap.
+
+### Images
+
+If you create `app/assets/images/photo.jpg`, you'll be able to show it in a view with `<img src="/assets/images/photo.jpg">`.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/hyperloop

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require "hyperloop/cli"
+
+Hyperloop::CLI.start

data/hyperloop.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hyperloop/version'
+require "hyperloop/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "hyperloop"
@@ -18,9 +18,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rack', '~> 1.5'
+  spec.add_dependency "coffee-script", "~> 2.2.0"
+  spec.add_dependency "rack", "~> 1.5"
+  spec.add_dependency "sass", "~> 3.2.12"
+  spec.add_dependency "sprockets", "~> 2.10.0"
+  spec.add_dependency "thor", "~> 0.18.1"
+  spec.add_dependency "tilt", "~> 1.4.1"
+  spec.add_dependency "yui-compressor", "~> 0.12.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "nokogiri", "~> 1.6.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.14"
 end

data/lib/hyperloop/application.rb

@@ -1,26 +1,32 @@
-require 'rack'
+require "rack"
+require "sprockets"
+require "yui/compressor"
 
 module Hyperloop
   class Application
     include Rack::Utils
 
     def initialize(root=nil)
-      @root       = root
-      @views_path = File.join([@root, 'app/views'].compact)
+      @root          = root
+      @view_registry = View::Registry.new(@root)
     end
 
     # Rack call interface.
     def call(env)
       request  = Rack::Request.new(env)
       response = Response.new
-      path     = view_path(request)
 
-      if File.exist?(path)
-        # If there's a file at the view path, use its data as the response body.
-        data = File.read(path)
+      if self.class.asset_path?(request.path) && asset = assets[normalized_asset_path(request.path)]
+        # If the path is for an asset, find the specified asset and use its data
+        # as the response body.
+        response["Content-Type"] = asset.content_type
+        response.write(asset.source)
+      elsif view = @view_registry.find_template_view(normalized_request_path(request.path))
+        # If there's a view at the path, use its data as the response body.
+        data = view.render(request)
         response.write(data)
       else
-        # If there's no file at the view path, 404.
+        # If there's no view at the path, 404.
         response.status = 404
       end
 
@@ -29,17 +35,51 @@ module Hyperloop
 
     private
 
-    # Internal: Get the view path for the specified request.
+    # Internal: Is the specified path for assets?
     #
-    # request - Rack::Request to get the view path for.
+    # path - Path to check.
     #
-    # Returns a String.
-    def view_path(request)
-      path = File.join(@views_path, request.path).chomp('/')
+    # Returns a boolean.
+    def self.asset_path?(path)
+      path =~ /^\/assets\/(images|javascripts|stylesheets)\//
+    end
+
+    # Internal: The sprockets environment for the app.
+    #
+    # Returns a Sprockets::Environment.
+    def assets
+      @assets ||= Sprockets::Environment.new do |env|
+        env.append_path(File.join(@root, "app", "assets"))
+        env.append_path(File.join(@root, "vendor", "assets"))
+
+        # compress everything in production
+        if ENV["RACK_ENV"] == "production"
+          env.js_compressor  = YUI::JavaScriptCompressor.new(:munge => true)
+          env.css_compressor = YUI::CssCompressor.new
+        end
+      end
+    end
+
+    # Internal: Get a normalized version of the specified asset path.
+    #
+    # path - Asset path to normalize
+    #
+    # Returns a string.
+    def normalized_asset_path(path)
+      path.sub(/^\/assets\//, "")
+    end
 
-      # If we're currently pointing to a directory, get index in it.
-      path = File.join(path, 'index') if Dir.exist?(path)
-      path + '.html'
+    # Internal: Get a normalized version of the specified request path.
+    #
+    # path - Request path to normalize
+    #
+    # Returns a string.
+    def normalized_request_path(path)
+      if path == "/"
+        path
+      else
+        path.chomp("/")
+      end
     end
   end
 end

data/lib/hyperloop/cli.rb

@@ -0,0 +1,11 @@
+require "hyperloop/generators/site"
+require "thor"
+
+module Hyperloop
+  class CLI < Thor
+    desc "new SITENAME", "Create a new Hyperloop site. \"hyperloop new my_site\" creates a new site called MySite in \"./my_site\""
+    def new(name)
+      Hyperloop::Generators::Site.start([name])
+    end
+  end
+end

data/lib/hyperloop/generators/site/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "hyperloop", "<%= Hyperloop::VERSION %>"

data/lib/hyperloop/generators/site/_partial.html.erb

@@ -0,0 +1 @@
+<p>Here's a partial! You know it's a partial because the filename starts with an underscore.</p>

data/lib/hyperloop/generators/site/about.html.erb

@@ -0,0 +1,3 @@
+<h2>About</h2>
+
+<p>This page is accessible by making a request to /about from your browser.</p>

data/lib/hyperloop/generators/site/app.css

@@ -0,0 +1,2 @@
+//= require_tree ../../../vendor/assets/stylesheets
+//= require_tree .

data/lib/hyperloop/generators/site/app.js

@@ -0,0 +1,2 @@
+//= require_tree ../../../vendor/assets/javascripts
+//= require_tree .

data/lib/hyperloop/generators/site/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= name.capitalize %></title>
+
+    <link href="/assets/stylesheets/app.css" media="all" rel="stylesheet" type="text/css">
+  </head>
+
+  <body>
+    <h1>Welcome to <%= name.capitalize %>!</h1>
+
+    <nav>
+      <ul>
+        <li><a href="/">Home</a></li>
+        <li><a href="/about">About</a></li>
+      </ul>
+    </nav>
+
+    <%%= yield %>
+
+    <script src="/assets/javascripts/app.js" type="text/javascript"></script>
+  </body>
+</html>