sinatra-export 0.9.5 → 1.0.1

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    sinatra-export (0.9.5)
+    sinatra-export (1.0.1)
       rack
+      rack-test
+      rake
       sinatra
       sinatra-advanced-routes
       term-ansicolor
@@ -13,25 +15,24 @@ GEM
     awesome_print (1.1.0)
     backports (3.1.1)
     columnize (0.3.6)
-    debugger (1.4.0)
+    debugger (1.5.0)
       columnize (>= 0.3.1)
-      debugger-linecache (~> 1.1.1)
+      debugger-linecache (~> 1.2.0)
       debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.1.2)
-      debugger-ruby_core_source (>= 1.1.1)
+    debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.0)
     monkey-lib (0.5.4)
       backports
     rack (1.5.2)
-    rack-protection (1.4.0)
+    rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.0.3)
-    sinatra (1.3.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
+    sinatra (1.4.1)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
     sinatra-advanced-routes (0.5.2)
       monkey-lib (~> 0.5.0)
       sinatra (~> 1.0)
@@ -41,7 +42,7 @@ GEM
       sinatra (~> 1.0)
     term-ansicolor (1.1.1)
     test-unit (2.5.4)
-    tilt (1.3.5)
+    tilt (1.3.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,7 @@
 
 > Exports all your Sinatra application routes to static files in your public folder.
 
-[![Build Status](https://travis-ci.org/hooktstudios/sinatra-export.png)](https://travis-ci.org/hooktstudios/sinatra-export)
+[![Build Status](https://travis-ci.org/hooktstudios/sinatra-export.png?branch=master)](https://travis-ci.org/hooktstudios/sinatra-export)
 [![Dependency Status](https://gemnasium.com/hooktstudios/sinatra-export.png)](https://gemnasium.com/hooktstudios/sinatra-export)
 [![Code Climate](https://codeclimate.com/github/hooktstudios/sinatra-export.png)](https://codeclimate.com/github/hooktstudios/sinatra-export)
 [![Gem Version](https://badge.fury.io/rb/sinatra-export.png)](https://rubygems.org/gems/sinatra-export)
@@ -15,17 +15,11 @@ Add to your `Gemfile` :
 gem 'sinatra-export'
 ```
 
-Setup your application with [sinatra-advanced-routes](https://github.com/hooktstudios/sinatra-advanced-routes) :
-
-```ruby
-register Sinatra::AdvancedRoutes
-```
-
 Setup your `Rakefile` :
 
 ```ruby
 APP_FILE  = 'app.rb'
-APP_CLASS = 'App'
+APP_CLASS = 'Sinatra::Application'
 
 require 'sinatra/export/rake'
 ```
@@ -36,25 +30,18 @@ Sample Sinatra application building static pages :
 
 ```ruby
 require 'sinatra'
-require 'sinatra/advanced_routes'
 require 'sinatra/export'
 
-class App < Sinatra::Base
-
-    register Sinatra::AdvancedRoutes
-
-    get '/' do    
-        "<h1>My homepage</h1>"
-    end
-
-    get '/contact' do
-        "<h1>My contact page<h1>"
-    end
+get '/' do
+  "<h1>My homepage</h1>"
+end
 
-    get '/data.json' do
-      "{test: 'ok'}"
-    end
+get '/contact' do
+  "<h1>My contact page<h1>"
+end
 
+get '/data.json' do
+  "{test: 'ok'}"
 end
 ```
 
@@ -71,7 +58,7 @@ Running your app ex. `rake sinatra:export` will automatically generate theses fi
 Or invoke it manually within ruby code :
 
 ````ruby
-Sinatra::Export.new(App).build!
+App.export!
 ```
 
 ## Other resources
@@ -88,4 +75,4 @@ See [CONTRIBUTING.md](https://github.com/hooktstudios/sinatra-export/blob/master
 
 ![hooktstudios](http://hooktstudios.com/logo.png)
 
-[sinatra-export](https://rubygems.org/gems/sinatra-export) is maintained and funded by [hooktstudios](https://github.com/hooktstudios)
+[sinatra-export](https://rubygems.org/gems/sinatra-export) is maintained and funded by [hooktstudios](https://github.com/hooktstudios)

data/UPGRADING

@@ -0,0 +1,14 @@
+##################################################
+#  NOTE FOR UPGRADING FROM PRE-1.0 VERSION       #
+##################################################
+
+Sinatra::Export is now a Sinatra extension
+and advanced routes are auto-loaded.
+
+To upgrade, replace in your application :
+
+  register Sinatra::AdvancedRoutes
+
+with :
+
+  register Sinatra::Export

data/lib/sinatra/export.rb

@@ -1,100 +1,101 @@
+require 'sinatra/base'
+require 'sinatra/advanced_routes'
 require 'rack/test'
 require 'term/ansicolor'
 
 module Sinatra
-  class Export
+  module Export
 
-    @@file_extensions = %w(css js xml json html csv)
-
-    attr_accessor :app
-
-    include Rack::Test::Methods
-
-
-    class ColorString < String
-      include Term::ANSIColor
-    end
-
-    def initialize(app)
-      @app = app
+    def self.registered(app)
+      if app.extensions.nil? or !app.extensions.include?(Sinatra::AdvancedRoutes)
+        app.register Sinatra::AdvancedRoutes
+      end
+      app.set :export_extensions, %w(css js xml json html csv)
+      app.extend ClassMethods
     end
 
-    def build!
-      dir = @app.public_folder
-      handle_error_no_each_route! unless @app.respond_to?(:each_route)
-      handle_error_dir_not_found!(dir) unless dir_exists?(dir)
-      build_routes(dir)
+    module ClassMethods
+      def export!
+        Builder.new(self).build!
+      end
     end
 
-  private
+    class Builder
+      include Rack::Test::Methods
 
-    def build_routes(dir)
-      @app.each_route do |route|
-        next if route.verb != 'GET' or not route.path.is_a? String
-        build_path(route.path, dir)
+      class ColorString < String
+        include Term::ANSIColor
       end
-    end
 
-    def build_path(path, dir)
-      response = get_path(path)
-      body = response.body
-      mtime = response.headers.key?("Last-Modified") ?
-        Time.httpdate(response.headers["Last-Modified"]) : Time.now
-      file_path = file_for_path(path, dir)
-      dir_path = dir_for_path(path, dir)
-
-      ::FileUtils.mkdir_p(dir_path)
-      ::File.open(file_path, 'w+') do |f|
-        f.write(body)
+      def initialize(app)
+        @app = app
       end
-      ::FileUtils.touch(file_path, :mtime => mtime)
-    end
 
-    def get_path(path)
-      self.get(path).tap do |resp|
-        handle_error_non_200!(path) unless resp.status == 200
+      def app
+        @app
       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')
+      def build!
+        dir = app.public_folder
+        handle_error_dir_not_found!(dir) unless dir_exists?(dir)
+        app.each_route do |route|
+          next if route.verb != 'GET' or not route.path.is_a? String
+          build_path(route.path, dir)
+        end
       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]
+      private
+
+        def build_path(path, dir)
+          response = get_path(path)
+          body = response.body
+          mtime = response.headers.key?("Last-Modified") ?
+            Time.httpdate(response.headers["Last-Modified"]) : Time.now
+          file_path = file_for_path(path, dir)
+          dir_path = dir_for_path(path, dir)
+
+          ::FileUtils.mkdir_p(dir_path)
+          ::File.open(file_path, 'w+') do |f|
+            f.write(body)
+          end
+          ::FileUtils.touch(file_path, :mtime => mtime)
+        end
+
+        def get_path( path)
+          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(/[^\/\.]+.(#{app.settings.export_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 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
-
-    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
+
+  register Sinatra::Export
 end

data/lib/sinatra/export/rake.rb

@@ -27,7 +27,6 @@ end
 namespace :sinatra do
   desc "Export static application"
   task :export do
-    require 'sinatra/export'
-    Sinatra::Export.new(app).build!
+    app.export!
   end
 end

data/sinatra-export.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'sinatra-export'
-  s.version = '0.9.5'
+  s.version = '1.0.1'
   
   s.authors = ['Jean-Philippe Doyle', 'Paul Asmuth']
   s.description = 'Exports all your Sinatra application routes to static files in your public folder'
@@ -15,15 +15,22 @@ Gem::Specification.new do |s|
     'lib/sinatra/export.rb',
     'lib/sinatra/export/rake.rb',
     'README.md',
-    'LICENSE'
+    'LICENSE',
+    'UPGRADING'
   ]
   s.homepage = 'http://github.com/hooktstudios/sinatra-export'
   s.license = 'MIT'
   s.required_ruby_version = '>= 1.8.7'
 
+  if File.exists?('UPGRADING')
+    s.post_install_message = File.read("UPGRADING")
+  end
+
   s.add_runtime_dependency 'term-ansicolor'
   s.add_runtime_dependency 'sinatra'
   s.add_runtime_dependency 'sinatra-advanced-routes'
   s.add_runtime_dependency 'rack'
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'rack-test'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-export
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -38,7 +38,7 @@ cert_chain:
   MjN3ZTRFMUx2ZlJuNWdWNzdEaWo2czlWNEhIek1CdUx3bk5iOFQrNmxPblVX
   YnRpSWRkRAplOGM4aTdQbHJ6aFZKLzhzWFVKc0NreUU4ZDJNeVJ5amx4TT0K
   LS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -104,6 +104,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 description: Exports all your Sinatra application routes to static files in your public
   folder
 email: jeanphilippe.doyle@hooktstudios.com
@@ -118,10 +150,15 @@ files:
 - lib/sinatra/export/rake.rb
 - README.md
 - LICENSE
+- UPGRADING
 homepage: http://github.com/hooktstudios/sinatra-export
 licenses:
 - MIT
-post_install_message: 
+post_install_message: ! "##################################################\n#  NOTE
+  FOR UPGRADING FROM PRE-1.0 VERSION       #\n##################################################\n\nSinatra::Export
+  is now a Sinatra extension\nand advanced routes are auto-loaded.\n\nTo upgrade,
+  replace in your application :\n\n  register Sinatra::AdvancedRoutes\n\nwith :\n\n
+  \ register Sinatra::Export"
 rdoc_options: []
 require_paths:
 - lib