sharpie 0.0.1

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 sharpie.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan deLevie
+
+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,104 @@
+# Sharpie
+
+Quick and easy static site generation with a familiar API.
+
+## Usage
+
+```ruby
+class App < Sharpie::Base
+  
+  get "/" do
+    "Hello, world."
+  end
+
+  # get posts from ActiveRecord or elsewhere
+  def self.posts
+    Post.all
+  end
+
+  posts.each do |post|
+    get "/posts/#{post.id}" do
+      erb :post
+    end
+
+    get "/posts/#{post.id}.json" do
+      post.to_json
+    end
+  end
+
+end
+
+
+App.build!("_site")
+```
+
+Or use with an existing Sinatra application:
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::AdvancedRoutes # this is required
+
+  def self.posts
+    Post.all
+  end
+
+  posts.each do |post|
+    get "/posts/#{post['id']}.json" do
+      post.to_json
+    end
+  end
+
+  get "/" do
+    erb :index
+  end
+end
+
+builder = Sharpie::Builder.new(App)
+builder.build!("_site")
+```
+
+`Sharpie::Base` subclasses from `Sinatra::Base`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sharpie'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install sharpie
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Why 
+
+Sinatra routes make web app and API creation dead-simple. The syntax is straightforward and allows for your site to feel more like Ruby and less like a bloated framework. And there's also no reason why this powerful API should be limited to dynamic web applications. Sinatra routes simply describe a path and a response. Whether the response is evaluated ahead of time or on fly should not matter.
+
+### Why not Jekyll?
+
+Jekyll is great for blogs and other types of sites where content is "hand created." That is, a human creates a file in a folder and writes some Markdown. Sharpie is more geared towards use-cases where the original content is already in a machine-readable format. For example, if you have a set of 1000s of JSON files that you want to expose via REST API. With Sharpie, you can write such an API with very few (yet straightfoward) lines of code.
+
+### Fork
+
+This software is mostly a fork of the [sinatra-static](https://github.com/paulasmuth/sinatra-static) gem by [Paul Asmuth](https://twitter.com/paulasmuth). Paul's code is very well-written. I'd rather copy and attribute it than re-invent a well-made wheel, and instead focus on building an interface that suits my needs. More specifically, I want Sharpie to be part of a toolchain for rapidly developing static file-backed REST APIs.
+
+# License
+
+This software, which is a fork of MIT-licensed software, is also MIT-licensed. See `LICENSE.txt`.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+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

data/lib/sharpie/sinatra_static.rb

@@ -0,0 +1,86 @@
+class SinatraStatic
+
+  @@file_extensions = %w(css js xml json html csv)
+
+  attr_accessor :app
+
+  include Rack::Test::Methods
+
+  require 'term/ansicolor'
+  class ColorString < String
+    include Term::ANSIColor
+  end  
+  
+  def initialize(app)    
+    @app = app    
+  end
+
+  def build!(dir)
+    handle_error_no_each_route! unless @app.respond_to?(:each_route)
+    handle_error_dir_not_found!(dir) unless dir_exists?(dir)     
+    build_routes(dir)
+  end
+
+private
+
+  def build_routes(dir)
+    @app.each_route do |route|     
+      next unless route.verb == 'GET'      
+      build_path(route.path, dir)
+    end    
+  end 
+
+  def build_path(path, dir)                 
+    ::FileUtils.mkdir_p(dir_for_path(path, dir))
+    ::File.open(file_for_path(path, dir), 'w+') do |f| 
+      f.write(get_path(path).body) 
+    end    
+  end
+
+  def get_path(path)
+    self.get(path).tap do |resp|      
+      handle_error_non_200!(path) unless resp.status == 200           
+    end
+  end
+
+  def file_for_path(path, dir)
+    if path.match(/[^\/\.]+.(#{file_extensions.join("|")})$/)
+      ::File.join(dir, path)
+    else
+      ::File.join(dir, path, 'index.html')
+    end
+  end
+
+  def dir_exists?(dir)
+    ::File.exists?(dir) && ::File.directory?(dir)
+  end
+
+  def dir_for_path(path, dir)   
+    file_for_path(path, dir).match(/(.*)\/[^\/]+$/)[1]  
+  end
+
+  def file_extensions
+    @@file_extensions
+  end
+
+  def env
+    ENV['RACK_ENV']
+  end  
+
+  def handle_error_no_each_route!
+    handle_error!("can't call app.each_route, did you include sinatra-advanced-routes?")
+  end
+
+  def handle_error_dir_not_found!(dir)  
+    handle_error!("can't find output directory: #{dir}")
+  end
+
+  def handle_error_non_200!(path)
+    handle_error!("GET #{path} returned non-200 status code...")
+  end
+
+  def handle_error!(desc)    
+    puts ColorString.new("failed: #{desc}").red; exit!
+  end
+
+end

data/lib/sharpie/version.rb

@@ -0,0 +1,3 @@
+module Sharpie
+  VERSION = "0.0.1"
+end

data/lib/sharpie.rb

@@ -0,0 +1,96 @@
+require "sharpie/version"
+require "bundler/setup"
+require "sinatra"
+require "sinatra/advanced_routes"
+require "rack/test"
+
+module Sharpie
+
+  class Base < Sinatra::Base
+    register Sinatra::AdvancedRoutes
+
+    def self.build!(path)
+      builder = Sharpie::Builder.new(self)
+      builder.build!(path)
+    end
+  end
+
+  class ColorString < String
+    include Term::ANSIColor
+  end
+
+  class Builder
+    attr_accessor :app
+    include Rack::Test::Methods
+
+    @@file_extensions = %w(css js xml json html csv)
+
+    def initialize(sinatra_application)
+      @app = sinatra_application
+    end
+
+    def build!(dir)
+      handle_error_no_each_route! unless @app.respond_to?(:each_route)
+      #handle_error_dir_not_found!(dir) unless dir_exists?(dir)
+      build_routes(dir)
+    end
+
+    private
+
+    def build_routes(dir)
+      @app.each_route do |route|     
+        next unless route.verb == "GET"     
+        build_path(route.path, dir)
+      end 
+    end
+
+    def build_path(path, dir)
+      FileUtils.mkdir_p(dir_for_path(path, dir))
+      File.open(file_for_path(path, dir), "w+") do |f|
+        f.write(get_path(path).body)
+      end
+    end
+
+    def get_path(path)
+      self.get(path).tap do |resp|      
+        unless resp.status == 200
+          binding.pry
+          handle_error_non_200!(path)
+        end        
+      end
+    end
+
+    def file_extensions
+      @@file_extensions
+    end
+
+    def file_for_path(path, dir)
+      if path.match(/[^\/\.]+.(#{file_extensions.join("|")})$/)
+        File.join(dir, path)
+      else
+        File.join(dir, path, "index.html")
+      end
+    end
+
+    def dir_for_path(path, dir)
+      file_for_path(path, dir).match(/(.*)\/[^\/]+$/)[1]  
+    end
+
+    def dir_exists?(dir)
+      File.exists?(dir) && ::File.directory?(dir)
+    end
+
+    def handle_error_non_200!(path)
+      handle_error!("GET #{path} returned non-200 status code...")
+    end
+
+    def handle_error_no_each_route!
+      handle_error!("can't call app.each_route, did you include sinatra-advanced-routes?")
+    end
+
+    def handle_error!(desc)    
+      raise "Sharpie error: #{desc}"
+    end
+  end
+
+end

data/sharpie.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sharpie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sharpie"
+  spec.version       = Sharpie::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["adelevie@gmail.com"]
+  spec.description   = %q{Static site generation with a familiar API.}
+  spec.summary       = %q{Converts Sinatra apps into static sites.}
+  spec.homepage      = "http://github.com/adelevie/sharpie"
+  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"]
+
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-advanced-routes"
+  spec.add_dependency "rack-test"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-rescue"
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+require "pry-rescue/minitest"
+require "sharpie"
+require "fileutils"
+require "json"
+require_relative "test_app"
+require_relative "test_sharpie_app"

data/test/test_app.rb

@@ -0,0 +1,33 @@
+require "bundler/setup"
+require "sinatra/base"
+require "sinatra/advanced_routes"
+require "json"
+
+class TestApp < Sinatra::Base
+  register Sinatra::AdvancedRoutes
+
+  def self.posts
+    [
+      {
+        "id" => 1,
+        "title" => "Hello, world",
+        "body" => "Sinatra routes + static html = win"
+      },
+      {
+        "id" => 2,
+        "title" => "Second Post",
+        "body" => "Why not?"
+      }
+    ]
+  end
+
+  posts.each do |post|
+    get "/posts/#{post['id']}.json" do
+      post.to_json
+    end
+  end
+
+  get "/" do
+    erb :index
+  end
+end

data/test/test_build.rb

@@ -0,0 +1,56 @@
+require "helper"
+
+class TestBuild < MiniTest::Unit::TestCase
+
+  def setup
+    FileUtils.rm_rf("test/sites/test_app")
+    FileUtils.rm_rf("test/sites/test_sharpie_app")
+  end
+
+  def teardown
+    FileUtils.rm_rf("test/sites/test_app")
+    FileUtils.rm_rf("test/sites/test_sharpie_app")
+  end
+
+  def test_build
+    path = "test/sites/test_app"
+    sharpie = Sharpie::Builder.new(TestApp)
+    sharpie.build!(path)
+
+    contents = []
+    Dir.foreach(path) do |item|
+      next if item == "." or item == ".."
+      contents << item
+    end
+
+    assert_equal true, contents.include?("posts")
+    assert_equal true, contents.include?("index.html")
+
+    first_post = File.open("#{path}/posts/1.json").read
+    assert_equal String, first_post.class
+
+    parsed_first_post = JSON.parse(first_post)
+    assert_equal String, parsed_first_post["title"].class
+    assert_equal String, parsed_first_post["body"].class
+  end
+
+  def test_build_sharpie_app
+    path = "test/sites/test_sharpie_app"
+    TestSharpieApp.build!(path)
+
+    contents = []
+    Dir.foreach(path) do |item|
+      next if item == "." or item == ".."
+      contents << item
+    end
+
+    assert_equal true, contents.include?("numbers")
+    assert_equal true, contents.include?("index.html")
+
+    10.times do |i|
+      parsed_page = JSON.parse(File.open("#{path}/numbers/#{i}.json").read)
+      assert_equal i, parsed_page["number"]
+    end
+  end
+
+end

data/test/test_sharpie_app.rb

@@ -0,0 +1,17 @@
+require "bundler/setup"
+require "sharpie"
+require "json"
+
+class TestSharpieApp < Sharpie::Base
+  get "/" do
+    "<html><body><p>Welcome to the index.</p></body></html>"
+  end
+
+  10.times do |i|
+    get "/numbers/#{i}.json" do
+      {
+        "number" => i
+      }.to_json
+    end
+  end
+end

data/test/views/index.erb

@@ -0,0 +1,6 @@
+<html>
+  <title>Home</title>
+  <body>
+    <p>Welcome to the index.</p>
+  </body>
+</html>

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: sharpie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alan deLevie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-advanced-routes
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Static site generation with a familiar API.
+email:
+- adelevie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sharpie.rb
+- lib/sharpie/sinatra_static.rb
+- lib/sharpie/version.rb
+- sharpie.gemspec
+- test/helper.rb
+- test/test_app.rb
+- test/test_build.rb
+- test/test_sharpie_app.rb
+- test/views/index.erb
+homepage: http://github.com/adelevie/sharpie
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 642336815966126004
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 642336815966126004
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Converts Sinatra apps into static sites.
+test_files:
+- test/helper.rb
+- test/test_app.rb
+- test/test_build.rb
+- test/test_sharpie_app.rb
+- test/views/index.erb