flatrack 1.0.0.alpha5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42119bb7fea0d768b2429a668f6813ab2f5e3fcc
-  data.tar.gz: 80d026fa6cc9481b2cbc11016736e64326c5581d
+  metadata.gz: 02f38974206178dab428bdc7d4b7a0c2aa92dc03
+  data.tar.gz: b6b70a1a6ea5ddd2a9a4c344c547228715d499c3
 SHA512:
-  metadata.gz: 69993fde0808453468c56ea5d8e65b017529c4afacda324d07a31eea32f9359f79d798edd08d3de3d22710c3ab81e56b433e70b5ac780415d7117cfe0ec30ff4
-  data.tar.gz: c3a3bc2fd839f04279ab32c3b318c8b8830ce2b054cf922f4f60dca97e13292eefd4f4fca5ea5f77d5caffd552a24c3eefd66e9546c7afe3d9511794597368b9
+  metadata.gz: 4a2cd97cdcdcd578d7a3af3278ef743c7fbd838eb1d195e7233e406c4cf9a74d0a26c932852fc4c04cf402cdb2a3f55af753911487325de9cfdf6d11c6e32888
+  data.tar.gz: 22a927232f2f038a3297ef20e78dd5a605950a032ec411b5cb8796720c461a7faefd9be9c152518f25f345c58c1c2c52d12c2ddda12bcbe9363213ff82f5d3f7

data/.gitignore

@@ -1,2 +1,5 @@
 Gemfile.lock
-pkg/*
+pkg/*
+*.gem
+tmp
+coverage

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Excludes:
+    - vendor/bundle/**
+
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+cache: bundler

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in flatrack-rack.gemspec
-gemspec
+gemspec unless ENV['RM_INFO']

data/Guardfile

@@ -0,0 +1,11 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^renderers/(.+)\.rb$}) { |m| "spec/renderers/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -1,24 +1,55 @@
-# Flat::Rack
+![Flatrack](https://raw.github.com/jwaldrip/flatrack/master/logo.png)
+--
 
-TODO: Write a gem description
+[![Version](http://allthebadges.io/jwaldrip/flatrack/badge_fury.png)](http://allthebadges.io/jwaldrip/flatrack/badge_fury)
+[![Dependencies](http://allthebadges.io/jwaldrip/flatrack/gemnasium.png)](http://allthebadges.io/jwaldrip/flatrack/gemnasium)
+[![Build Status](http://allthebadges.io/jwaldrip/flatrack/travis.png?1)](http://allthebadges.io/jwaldrip/flatrack/travis)
+[![Coverage](http://allthebadges.io/jwaldrip/flatrack/coveralls.png)](http://allthebadges.io/jwaldrip/flatrack/coveralls)
+[![Code Climate](http://allthebadges.io/jwaldrip/flatrack/code_climate.png)](http://allthebadges.io/jwaldrip/flatrack/code_climate)
+
+## About
+A simple rack web layer for delivering rendered static files.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install flatrack
+
+## Creating your Flatrack site
+
+    $ flatrack new my-website
+    
+### Structure
+
+You should have 3 directories:
 
-    gem 'flat-rack'
+    - assets
+    - layouts
+    - pages
+    
+#### Assets
+Location of sprockets assets, flatrack comes with Sass and Coffeescript out of the box.
 
-And then execute:
+    - images
+    - javascripte
+    - stylesheets
+    
+#### Pages
+Pages are the guts of your site, this is what your users will ultimately see. Basically put your content here.
 
-    $ bundle
+#### Layouts
+Layouts are the skin of your site, it's what takes all those guts that your users need and crave and puts them in a nice pretty layout for them to enjoy.
+    
+## Running your site
 
-Or install it yourself as:
+    $ flatrack start
+    
+## How it works
 
-    $ gem install flat-rack
+Anything in `/pages` maps to a URL at `/`, root of a directory will always map to the `index.html.*` file in it.
 
-## Usage
+**for example**
 
-TODO: Write usage instructions here
+`GET /foo.html` would map to `/pages/foo.html.erb`, the erb (or any other format) is optional if you wish to render your pages dynamically.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/bin/flatrack

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'flatrack'
-Flatrack::CLI.start
+Flatrack::CLI.start

data/flatrack.gemspec

@@ -6,34 +6,44 @@ require 'flatrack/version'
 Gem::Specification.new do |spec|
 
   # Information
-  spec.name          = "flatrack"
-  spec.version       = Flatrack::VERSION
-  spec.authors       = ["Jason Waldrip"]
-  spec.email         = ["jason@waldrip.net"]
-  spec.summary       = 'A template based flat rack site'
-  spec.homepage      = "https://github.com/jwaldrip/flatrack"
-  spec.license       = "MIT"
+  spec.name        = "flatrack"
+  spec.version     = Flatrack::VERSION
+  spec.authors     = ["Jason Waldrip"]
+  spec.email       = ["jason@waldrip.net"]
+  spec.summary     = 'Deliver static files with style.'
+  spec.description = <<-description
+A rack based static site builder with templates, layouts and project structure
+based routing.
+
+  description
+  spec.homepage              = "https://github.com/jwaldrip/flatrack"
+  spec.license               = "MIT"
 
   # Files
-  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"]
+  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"]
 
   # Ruby Version
   spec.required_ruby_version = '>= 1.9.3'
 
   # Dependencies
-  spec.add_dependency 'rack'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'sass'
-  spec.add_dependency 'sprockets'
-  spec.add_dependency 'sprockets-sass'
-  spec.add_dependency 'thor'
-  spec.add_dependency 'coffee-script'
-  spec.add_dependency 'rake'
+  spec.add_runtime_dependency 'rack', '~> 1.4'
+  spec.add_runtime_dependency 'activesupport', '~> 3.2'
+  spec.add_runtime_dependency 'sass', '~> 3.2'
+  spec.add_runtime_dependency 'sprockets-sass', '~> 1.0'
+  spec.add_runtime_dependency 'thor', '~> 0.18'
+  spec.add_runtime_dependency 'coffee-script', '~> 2.2'
+  spec.add_runtime_dependency 'rake', '~> 0.8'
 
   # Dev Dependencies
   spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.0.0.beta'
+  spec.add_development_dependency 'guard', '~> 2.5'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'guard-bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.9.12.6'
+  spec.add_development_dependency 'coveralls', '~> 0.7.0'
+  spec.add_development_dependency 'simplecov', '~> 0.8.2'
 end

data/lib/flatrack.rb

@@ -3,8 +3,9 @@ require 'active_support/all'
 require 'sprockets'
 require 'sprockets-sass'
 require 'sass'
+require 'rack'
 
-module Flatrack
+class Flatrack
   extend ActiveSupport::Autoload
 
   autoload :Renderer
@@ -19,15 +20,39 @@ module Flatrack
 
   FORMATS = {}
 
-  def self.root
+  delegate :gem_root, :site_root, to: self
+
+  def self.gem_root
     File.expand_path File.join __FILE__, '..'
   end
 
-  def self.register_format(ext, mime)
-    FORMATS[ext.to_s] = mime
+  def self.site_root
+    File.expand_path Dir.pwd
+  end
+
+  class << self
+
+    def delegate_instance
+      @delegate_instance ||= new
+    end
+
+    def reset!
+      @delegate_instance = nil
+    end
+
+    private
+
+    def method_missing(m, *args, &block)
+      delegate_instance.public_method(m).call(*args, &block)
+    end
+
   end
 
-  def self.assets
+  def config(&block)
+    yield self
+  end
+
+  def assets
     @assets ||= begin
       Sprockets::Environment.new.tap do |environment|
         environment.append_path 'assets/images'
@@ -38,8 +63,26 @@ module Flatrack
     end
   end
 
-  I18n.enforce_available_locales = false
+  def register_format(ext, mime)
+    FORMATS[ext.to_s] = mime
+  end
+
+  def middleware
+    @middleware ||= []
+  end
+
+  def use(*args)
+    middleware << args
+  end
 
-  Dir.glob(File.expand_path File.join __FILE__, '../../renderers/**/*.rb').each { |f| require f }
+  # By default we know how to render 'text/html'
+  register_format :html, 'text/html'
 
+  # Fix Locales issue
+  I18n.enforce_available_locales = false
+
+  # Load all renderers
+  Dir.glob(File.join gem_root, '../renderers/**/*.rb').each do |f|
+    require f
+  end
 end

data/lib/flatrack/asset_extensions.rb

@@ -1,9 +1,7 @@
-module Flatrack
+class Flatrack
   module AssetExtensions
-
-    def asset_path(path, options={})
+    def asset_path(path, options = {})
       File.join('/assets', path.to_s)
     end
-
   end
 end

data/lib/flatrack/cli.rb

@@ -1,32 +1,83 @@
 require 'thor'
+require 'flatrack'
 
-module Flatrack
+class Flatrack
   class CLI < Thor
     include FileUtils
     include Thor::Actions
 
+    source_root File.join Flatrack.gem_root, '..', 'templates'
+
+    method_option :verbose, type: :boolean, default: true, aliases: :v
+    method_option :bundle, type: :boolean, default: true, aliases: :b
+
     desc 'new NAME', 'create a new flatrack site with the given name'
 
-    source_root File.join Flatrack.root, '..', 'templates'
-
-    def new(name)
-      @name = name.titleize
-      mkdir_p name
-      path                  = File.expand_path name
-      self.destination_root = path
-      template '.gitignore', '.gitignore'
-      template 'boot.rb', 'boot.rb'
-      template 'Rakefile', 'Rakefile'
-      template 'Gemfile.erb', 'Gemfile'
-      template 'config.ru', 'config.ru'
-      template 'layout.html.erb', 'layouts/layout.html.erb'
-      template 'page.html.erb', 'pages/index.html.erb'
-      template 'stylesheet.css.scss', 'assets/stylesheet.css.scss'
-
-      Dir.chdir(path) do
-        system 'bundle install'
+    KEEP_DIRS = [
+      'assets/stylesheets',
+      'assets/javascripts',
+      'assets/images',
+      'pages',
+      'layouts'
+    ]
+
+    FILES = {
+      '.gitignore'           => '.gitignore',
+      'boot.rb'              => 'boot.rb',
+      'Rakefile'             => 'Rakefile',
+      'Gemfile.erb'          => 'Gemfile',
+      'config.ru'            => 'config.ru',
+      'layout.html.erb'      => 'layouts/layout.html.erb',
+      'page.html.erb'        => 'pages/index.html.erb',
+      'stylesheet.css.scss'  => 'assets/stylesheets/main.css.scss',
+      'javascript.js.coffee' => 'assets/javascripts/main.js.coffee'
+    }
+
+    def new(path)
+      mkdir_p path
+      full_path             = File.expand_path path
+      @name                 = File.basename(full_path).titleize
+      self.destination_root = full_path
+      write_keeps
+      write_files
+      bundle!
+    end
+
+    method_option :verbose, type: :boolean, default: true, aliases: :v
+    method_option :port, type: :numeric, default: 5959, aliases: :p
+
+    desc 'start PORT', 'run the site on the given port'
+
+    def start
+      require './boot'
+      run_opts             = {}
+      run_opts[:app]       = Flatrack::Site
+      run_opts[:Port]      = options[:port]
+      run_opts[:Logger]    = Logger.new('/dev/null') unless options[:verbose]
+      run_opts[:AccessLog] = Logger.new('/dev/null') unless options[:verbose]
+      Rack::Server.start run_opts
+    end
+
+    private
+
+    def bundle!
+      Dir.chdir(destination_root) do
+        cmd = 'bundle install'
+        cmd << ' --quiet' unless options[:verbose]
+        system cmd
+      end if options[:bundle]
+    end
+
+    def write_keeps
+      KEEP_DIRS.each do |dir|
+        template '.keep', File.join(dir, '.keep'), verbose: options[:verbose]
       end
     end
 
+    def write_files
+      FILES.each do |temp, dest|
+        template temp, dest, verbose: options[:verbose]
+      end
+    end
   end
-end
+end

data/lib/flatrack/renderer.rb

@@ -1,20 +1,31 @@
-module Flatrack
+class Flatrack
   module Renderer
-    extend self
     extend ActiveSupport::Autoload
 
     autoload :Base
 
     def find(file)
-      template = (Dir[File.join 'pages', "#{file}*"] + Dir[File.join 'layouts', "#{file}*"]).first
-      raise FileNotFound, "could not find #{file}" unless template
+      template = File.exists?(file) ? file : [*pages(file), *layouts(file)][0]
+      fail FileNotFound, "could not find #{file}" unless template
       ext = File.extname(template).sub(/\./, '')
 
-      renderer = Base.descendants.find { |descendant| descendant.renders?(ext)  } ||
-        raise(RendererNotFound, "could not find a renderer for #{file}")
+      renderer = Base.descendants.find do |descendant|
+        descendant.renders?(ext)
+      end || fail(RendererNotFound, "could not find a renderer for #{file}")
 
       renderer.new template
     end
 
+    private
+
+    def pages(file)
+      Dir[File.join 'pages', "#{file}*"]
+    end
+
+    def layouts(file)
+      Dir[File.join 'layouts', "#{file}*"]
+    end
+
+    module_function :find, :pages, :layouts
   end
-end
+end

data/lib/flatrack/renderer/base.rb

@@ -1,7 +1,6 @@
-module Flatrack
+class Flatrack
   module Renderer
     class Base
-
       attr_reader :contents
 
       def self.renders(ext = nil)
@@ -15,7 +14,6 @@ module Flatrack
       def initialize(file)
         @contents = File.read file
       end
-
     end
   end
-end
+end