hyper 0.3.0beta1

data/README.md

@@ -0,0 +1,81 @@
+# Hyper
+
+Hyper is a dead simple, zero-config framework for static HTML websites. Use it to create small HTML sites with static content; host your site anywhere that supports Rack.
+
+## Quick Start
+
+Five steps from install to a functioning website:
+
+	$ gem install hyper
+	$ hyper new my_website
+	$ cd my_website
+	$ bundle install
+	$ bundle exec rackup
+
+Point your browser at <a href="http://0.0.0.0:9292/">0.0.0.0:9292</a> and you'll see your website's home page.
+
+## Adding Content
+
+To add content to your site, you just need to know two things:
+
+1. Shared content (stuff that goes on every page of your website) goes in <code>templates/layout.html.erb</code>
+2. Page-specific content goes in <code>templates/views/{page}.html.erb</code>
+
+Put your navigation and header in <code>layout.html.erb</code>. Put the content for your about page in <code>views/about.html.erb</code> (link to the page using <code>/about</code>). It's that simple.
+
+Also note: your home page content goes in <code>views/index.html.erb</code>; Hyper knows to map the root URL to that file.
+
+## Stylesheets, Images, Javascripts, Etc
+
+Put your stylesheets, images, javascripts, etc in <code>public</code>: Hyper will handle the rest. When referencing these files in your HTML, drop the "public" from the path &mdash; <code>public/images/logo.png</code> should become <code>&lt;img src="/images/logo.png" /&gt;</code>.
+
+## Deployment
+
+If you love Heroku, deployment is easy:
+
+	$ cd my_website
+	$ heroku create
+	$ git push heroku master
+
+Any other rack-compatible host should work too.
+	
+## In-Depth
+
+There's not a whole lot of depth to go into: hyper is intentionally simple. Once you've generated a new site, you'll get the following files and folders:
+
+<table>
+	<tr>
+		<th>File/Folder</th>
+		<th>Info</th>
+	</tr>
+	<tr>
+		<td><code>templates/layout.html.erb</code></td>
+		<td>The layout for your website. Stuff that's the same on every page (header, navigation, etc) should go here</td>
+	</tr>
+	<tr>
+		<td><code>templates/views</code></td>
+		<td>This is where your page-specific content lives. See "Adding Content for more details"</td>
+	</tr>	
+	<tr>
+		<td><code>public</code></td>
+		<td>Put your static assets here</td>
+	</tr>	
+	<tr>
+		<td><code>config.ru</code></td>
+		<td>Your site's rack config file. Customize your rack app here (if you don't know rack, just ignore this file)</td>
+	</tr>
+	<tr>
+		<td><code>Gemfile</code></td>
+		<td>For use with Bundler</td>
+	</tr>
+</table>
+
+Defaults are set so you don't have to worry about anything outside <code>templates</code> if you don't want to. If you understand rack and want to add middleware, do that in <code>config.ru</code> (but note that Hyper already knows to serve static content from <code>public</code>, so you don't need to use <code>Rack::Static</code>).
+
+## Author
+
+I'm <a href="http://www.jameswilding.net">James Wilding</a> and I make Ruby and Rails software.
+
+## License
+
+Hyper is released under <a href="http://www.opensource.org/licenses/mit-license.php">the MIT license</a>.

data/bin/hyper

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'hyper'
+require 'optparse'
+
+options = {}
+parser  = OptionParser.new do |opts|  
+  opts.banner = "Usage: hyper new NAME [options]"
+  
+  opts.on('-f', '--force', 'Overwrite existing files') do
+    options[:force] = true
+  end
+end
+
+case ARGV.first
+when 'new'
+  if name = ARGV[1]
+    parser.parse!
+    Hyper::Generator.new(name, options).generate
+  else
+    puts "Please provide a name"
+  end
+else
+  puts parser.help
+end

data/lib/hyper.rb

@@ -0,0 +1,40 @@
+require 'rack/builder'
+
+module Hyper
+  autoload :Generator, 'hyper/generator'
+  autoload :Response,  'hyper/response'
+  autoload :Static,    'hyper/static'
+  autoload :Utils,     'hyper/utils'
+  autoload :Version,   'hyper/version'
+    
+  extend self
+
+  # @api public  
+  def call(env)
+    builder = Rack::Builder.new do
+      use Hyper::Static
+      run Hyper::Response.new
+    end
+    
+    builder.to_app.call(env)
+  end
+
+  # @api public  
+  def root
+    Pathname.new(Dir.pwd)
+  end
+
+  # @api public  
+  def template_root=(path)
+    @template_root = Pathname.new(path)
+  end
+  
+  def view_root
+    @view_root ||= template_root.join('views')
+  end  
+  
+  # @api private
+  def template_root
+    @template_root ||= root.join('templates')
+  end  
+end

data/lib/hyper/generator.rb

@@ -0,0 +1,109 @@
+require 'term/ansicolor'
+
+module Hyper
+  # @api private
+  class Generator
+    include Term::ANSIColor
+    
+    def initialize(name, options = {})
+      @name    = name
+      @options = options
+    end
+    
+    def generate
+      if cannot_generate?
+        error "#{@name} exists (use --force to overwrite)"
+      else
+        create_destination_folder
+      
+        template_contents.each do |path|
+          generate_component(path)
+        end
+      end
+    end
+    
+    def cannot_generate?
+      File.directory?(destination_folder) && !@options[:force]
+    end
+        
+    private
+    # Paths
+    
+    # Returns a glob of paths for files and folders in Hyper's template directory.
+    def template_contents
+      Dir[File.join(template_path, '**/*')]      
+    end
+    
+    # Returns the path to Hyper's template directory.
+    def template_path
+      File.expand_path(File.dirname(__FILE__) + '/template')
+    end    
+    
+    # Returns a path to use for creating a new file inside the destination directory.
+    def destination_path(path)
+      File.join(destination_folder, common_component_path(path))
+    end
+    
+    # Returns the path for the new site directory the user wants to create.
+    def destination_folder
+      File.join(Dir.pwd, @name)
+    end
+    
+    # Returns the path component which is shared between template and destination.
+    #
+    # Example:
+    # 
+    #   path = /users/bob/code/hyper/lib/hyper/template/config.ru
+    #   common_component_path(path) # => '/config.ru'
+    #
+    # Used to build destination paths.
+    def common_component_path(path)
+      path.sub(template_path, '')
+    end
+
+    # Returns an easy to understand string representing and installation path.
+    #
+    # Example:
+    #
+    #   generator = Hyper::Generator.new('my_site')
+    #   path      = /users/bob/code/hyper/lib/hyper/template/config.ru
+    # 
+    #   human_component_path(path) # => 'my_site/config.ru'
+    #
+    # Used in CLI output.
+    def human_component_path(path)
+      File.join(@name, common_component_path(path))
+    end      
+    
+    # Actions
+    def create_destination_folder
+      unless File.directory?(destination_folder)
+        run "mkdir #{destination_folder}"
+        created @name
+      end
+    end
+    
+    # Copies a file or folder from Hyper's template to a new site folder.
+    def generate_component(path)
+      run "cp -r #{path} #{destination_path(path)}"
+      created human_component_path(path)      
+    end
+    
+    # Helpers
+    def created(path)
+      say :created, path, :green
+    end            
+    
+    def error(message)
+      say :error, message, :red
+    end 
+       
+    def say(status, message, color)
+      puts "#{send color}#{status} #{bold}#{message}#{reset}"
+    end
+    
+    def run(command)
+      system command
+    end    
+  end
+end

data/lib/hyper/response.rb

@@ -0,0 +1,34 @@
+require 'rack/request'
+require 'tilt'
+
+
+module Hyper
+  # @api private  
+  class Response
+    def call(env)
+      request  = Rack::Request.new(env)
+      headers  = {'Content-Type' => 'text/html'}
+      layout   = Utils.layout_path
+      view     = Utils.view_path(request.path)
+      
+      if File.file?(view)
+        status = 200
+        body   = render_templates(layout, view)
+      else
+        status = 404
+        body   = "404 Not Found: #{request.path}"
+      end
+      
+      [status, headers, StringIO.new(body)]
+    end
+    
+    private
+    def render_templates(layout, view)
+      render_erb(layout) { render_erb(view) }
+    end
+    
+    def render_erb(template, &block)
+      Tilt.new(template, :trim => '-').render(&block)
+    end
+  end  
+end

data/lib/hyper/static.rb

@@ -0,0 +1,25 @@
+require 'rack/builder'
+
+module Hyper
+  # @api private  
+  class Static
+    class << self
+      def urls
+        Dir[Hyper.root.join('public/**/*')].map do |file|
+          file.sub(Hyper.root.join('public'), '')
+        end      
+      end      
+    end
+    
+    def initialize(app)
+      @app = Rack::Builder.new do
+        use Rack::Static, :urls => Hyper::Static.urls, :root => 'public'
+        run app
+      end
+    end
+    
+    def call(env)
+      @app.call(env)
+    end    
+  end
+end

data/lib/hyper/template/Gemfile

@@ -0,0 +1 @@
+gem 'hyper'

data/lib/hyper/template/config.ru

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rack'
+require 'hyper'
+
+builder = Rack::Builder.new do
+  # Add middleware here
+  run Hyper
+end
+
+run builder.to_app

data/lib/hyper/template/templates/layout.html.erb

@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<title>Hyper Site</title>
+	</head>
+	<body>
+		<%= yield %>
+	</body>
+</html>

data/lib/hyper/template/templates/views/index.html.erb

@@ -0,0 +1 @@
+<p>Find me in <%= __FILE__ -%></p>

data/lib/hyper/utils.rb

@@ -0,0 +1,34 @@
+module Hyper
+  # @api private  
+  module Utils
+    extend self
+    
+    def layout_path
+      File.join(Hyper.template_root, 'layout.html.erb')      
+    end
+    
+    def view_path(url)
+      File.join(Hyper.template_root, 'views', normalize_url(url) + '.html.erb')
+    end
+    
+    private
+    # Attempts to standardize URLs by adding 'index' to URLs
+    # which end in "/". Also replaces an empty URL with 'index'.
+    #
+    #   normalize_url('')         # => '/index'
+    #   normalize_url('/')        # => '/index'
+    #   normalize_url('/folder/') # => '/folder/index'
+    #   normalize_url('/page')    # => '/page'
+    #    
+    # @return [String]
+    def normalize_url(url)
+      if ['', '/'].include?(url)  # Root URL
+        '/index'
+      elsif url =~ /.+\/$/        # Folder indexes
+        File.join(url, 'index')
+      else                        # Everything else
+        url                       
+      end
+    end
+  end
+end

data/lib/hyper/version.rb

@@ -0,0 +1,11 @@
+module Hyper
+  module Version
+    MAJOR = 0
+    MINOR = 3
+    TINY  = '0beta1'
+    
+    def self.to_s
+      [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: hyper
+version: !ruby/object:Gem::Version 
+  hash: 62196369
+  prerelease: 5
+  segments: 
+  - 0
+  - 3
+  - 0
+  - beta
+  - 1
+  version: 0.3.0beta1
+platform: ruby
+authors: 
+- James Wilding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 2
+        - 2
+        version: 1.2.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Hyper is a dead simple, zero-config, drop-in framework for static websites on ruby + rack
+email: office@jameswilding.net
+executables: 
+- hyper
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hyper/generator.rb
+- lib/hyper/response.rb
+- lib/hyper/static.rb
+- lib/hyper/template/config.ru
+- lib/hyper/template/Gemfile
+- lib/hyper/template/templates/layout.html.erb
+- lib/hyper/template/templates/views/index.html.erb
+- lib/hyper/utils.rb
+- lib/hyper/version.rb
+- lib/hyper.rb
+- README.md
+- bin/hyper
+has_rdoc: true
+homepage: http://github.com/jameswilding/hyper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Zero-config framework for static websites
+test_files: []
+