sinatra-chassis 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.c9revisions

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Jarrod Taylor, LLP.
+
+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,19 @@
+## Chassis
+
+Chassis is a mutable framework extension for Sinatra that's designed not just to help you write less code, but to help you focus on less code.
+
+    gem install sinatra-chassis
+
+### Instructions
+
+http://jarrodtaylor.github.com/sinatra-chassis/
+
+### License
+
+Copyright (C) 2013 Screen Sized, LLP.
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/chassis

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'sinatra/chassis/file_manager'
+
+# Sets the default switches
+switches = {
+  git:     false,
+  heroku:  false,
+  bundler: true
+}
+
+# Internal: Parses command options and runs associated methods.
+#
+# Example
+#   ~: chassis -g -h ~/Projects/my_new_app
+#
+# Each command is self documenting.
+options = OptionParser.new do |opt|
+  opt.banner = 'Options:'
+
+  opt.on('-g', '--git', 'Init a git repo, add the first commit') { switches[:git] = true }
+
+  opt.on('-h', '--heroku', 'Create a Heroku app') { switches[:heroku] = true }
+
+  opt.on('--skip-bundle', 'Don\'t run bundle install') { switches[:bundler] = false }
+
+  opt.parse!
+end
+
+# If app name is given, create application.
+if ARGV[0]
+  app = ARGV[0]
+
+  unless File.exists? app
+    puts "  Creating #{app}:"
+    puts LABELS[:add] + app
+    create_directory app
+  else
+    puts "#{app} already exists."
+    exit
+  end
+
+  copy_directory "#{TEMPLATES}/chassis", app
+
+  if switches[:bundler]
+    puts LABELS[:run] + 'bundle'
+    system "cd #{app} && bundle install"
+  end
+
+  puts LABELS[:run] + 'chmod -r 0755'
+  FileUtils.chmod_R 0755, app
+
+  if switches[:git]
+    puts LABELS[:run] + 'git'
+    system "cd #{app} && git init && git add . && git commit -m 'First!'"
+  end
+
+  if switches[:heroku]
+    puts LABELS[:run] + 'heroku'
+    system "cd #{app} && heroku create && git push heroku master"
+  end
+
+  puts "\n  Next steps:\n    cd #{app}\n    ruby app.rb\n\n"
+  exit
+end
+
+# If script hasn't exited already, show help.
+puts "The chassis command creates a new chassis app.\n\n"
+puts "Usage:\n  chassis [options] app_path\n\n"
+puts "Example:\n  chassis -g -h ~/Projects/my_app\n\n"
+puts options
+puts ''

data/lib/sinatra/chassis.rb

@@ -0,0 +1,213 @@
+require 'sinatra/base'
+
+module Sinatra
+
+  # Public: Helpers used in the Chassis module.
+  # Can be overriden from an app.
+  module ChassisHelpers
+  
+    # Public: Compares the request user agent against
+    # the mobile_user_agents setting Array items (should contain regexes).
+    #
+    # Example 
+    #
+    #   mobile_request?
+    #   # => true
+    #
+    # Returns true/false.
+    def mobile_request?
+      settings.mobile_user_agents.any? { |agent| request.env['HTTP_USER_AGENT'] =~ agent }
+    end
+    
+    # Public: Checks to see if a view template exists.
+    # It will check through all registered view directories.
+    #
+    # template - String of view template filename to look for
+    #
+    # Example
+    #
+    #   view_template('show.haml')
+    #   # => true
+    #
+    # Returns true/false.
+    def view_exists? template
+      Array(settings.views).each { |v| return true if File.exists?("#{v}/#{template}") }
+      false
+    end
+    
+    # Public: Prepends the Sinatra find_template method to
+    # find .mobile templates if the mobile_views setting is true
+    # the request is from a mobile device.
+    #
+    # Example
+    #
+    #   erb :my_view
+    #
+    # Renders the my_view.mobile.erb instead of my_view.erb.
+    def find_template views, name, engine, &block
+      name = "#{name}.mobile"   if
+        (settings.mobile_views) &&
+        (mobile_request?)       &&
+        (view_exists?("#{name}.mobile.#{@preferred_extension}"))
+      Array(views).each { |v| super(v, name, engine, &block) }
+    end
+    
+  end
+
+  module Chassis
+    
+    # Public: Requires all .rb files in a given directory or directories.
+    #
+    # *args - String(s) or Array of String paths to require
+    #
+    # Exmaple
+    #
+    #   require_directory('routes', 'models')
+    #
+    # Returns nothing.
+    def require_directory *args
+      args = args.first if args.first.kind_of? Array
+      args.each do |directory|
+        Dir["./#{directory}/**/*.rb"].each { |file| require file }
+      end
+    end
+    
+    # Public: Additions to the Sinatra app.
+    def self.registered(app)
+
+      # Public: Defines the default load path to be used with require_directory.
+      #
+      # Example
+      #
+      #   require_directory(settings.load_path)
+      app.set :load_path, ['config', 'settings', 'helpers', 'libraries', 'models', 'controllers', 'routes']
+
+      # Public: Defines the default mobile user agents.
+      app.set :mobile_user_agents, [/iPhone/, /Android.*AppleWebKit/]
+      
+      # Public: Turns on .mobile view templates.
+      app.enable :mobile_views
+      
+      # Public: Determines where to load assets from.
+      app.set :assets_path, ['public']
+      
+      # Public: Compiles .scss file to .css on request.
+      #
+      # Example
+      #
+      #   <link rel="stylesheet" type="text/css" href="theme.css">
+      #
+      # Returns the compiled theme.scss, if it exists.
+      # Note that requests to public files bypass this handler.
+      app.get '*.css/?' do        
+        file = params[:splat].first
+  
+        found = false
+        type  = nil
+  
+        settings.assets_path.each do |path|
+          file.sub!("#{path}/", '') unless path == 'public'
+          if File.exists?("./#{path}#{file}.css")
+            found = "#{path}#{file}"
+            type  = 'css'
+            break
+          end
+          if File.exists?("./#{path}#{file}.scss")
+            found = "#{path}#{file}"
+            type  = 'scss'
+            break
+          end
+        end
+        
+        if found
+          content_type 'text/css'
+          if type == 'css'
+            File.read "#{found}.css"
+          elsif type == 'scss'
+            scss found.to_sym, views: './'
+          end
+        else
+          pass
+        end      
+      end
+
+      # Public: Compiles .coffee file to .js on request.
+      #
+      # Example
+      #
+      #   <script type="text/javascript" src"script.js"></script>
+      #
+      # Returns the compiled script.coffee, if it exists.
+      # Note that requests to public files bypass this handler.
+      app.get '*.js/?' do
+        file = params[:splat].first
+
+        found = false
+        type  = nil
+
+        settings.assets_path.each do |path|
+          file.sub!("#{path}/", '') unless path == 'public'
+          if File.exists?("./#{path}#{file}.js")
+            found = "#{path}#{file}"
+            type  = 'js'
+            break
+          end
+          if File.exists?("./#{path}#{file}.coffee")
+            found = "#{path}#{file}"
+            type  = 'coffee'
+            break
+          end
+        end
+        
+        if found
+          content_type 'text/javascript'
+          if type == 'js'
+            File.read "#{found}.js"
+          elsif type == 'coffee'
+            coffee found.to_sym, views: './'
+          end
+        else
+          pass
+        end        
+      end
+
+      # Public: Adds the internal Chassis views directory to the app.
+      # Used for finding the built in error template.
+      app.set :views, ['views', File.dirname(__FILE__) + '/views']
+
+      # Public: Turns on the catch all route in a not_found request.
+      app.enable :catch_all_route
+
+      # Public: Handles 404s.
+      #
+      # If there is no matching route handler, this will return a view template
+      # by matching the request path to a /views directory path and file. If
+      # no template is found, a 404 is called.
+      #
+      # In production, the 404 will render the production error template.
+      not_found do
+        if settings.catch_all_route?
+          view = request.path[1..-1]
+          Tilt.mappings.each do |m|
+            return send(m.first, view.to_sym) if view_exists?("#{view}.#{m.first}")
+          end
+        end
+        erb(:error, layout: false, locals: { code: '404', message: 'Not Found' }) if production?
+      end
+      
+      # Public: Makes production errors prettier by rendering a built in template.
+      configure :production do
+        error(400) { erb :error, layout: false, locals: { code: '400', message: 'Bad Request'           } }
+        error(401) { erb :error, layout: false, locals: { code: '401', message: 'Unauthorized'          } }
+        error(403) { erb :error, layout: false, locals: { code: '403', message: 'Forbidden'             } }
+        error(408) { erb :error, layout: false, locals: { code: '408', message: 'Request Timeout'       } }
+        error(500) { erb :error, layout: false, locals: { code: '500', message: 'Internal Server Error' } }
+        error(502) { erb :error, layout: false, locals: { code: '502', message: 'Bad Gateway'           } }
+      end
+    end
+    
+  end
+  
+  helpers  ChassisHelpers
+  register Chassis
+end

data/lib/sinatra/chassis/file_manager.rb

@@ -0,0 +1,151 @@
+require 'paint'
+require 'fileutils'
+require 'erb'
+
+# Public: Hash of colored and aligned Strings for displaying command actions.
+# If interpolated, don't use any surrounding spaces.
+LABELS = {
+  add:       Paint['        add  ', :green],
+  ignore:    Paint['     ignore  ', :blue],
+  overwrite: Paint['  overwrite  ', :yellow],
+  remove:    Paint['     remove  ', :red],
+  run:       Paint['        run  ', :magenta]
+}
+
+# Public: String path location of the templates directory.
+TEMPLATES = "#{File.dirname(__FILE__)}/../templates"
+
+# Public: Asks the user if a file should be overwritten.
+#
+# file - Sting path of file in question
+#
+# Example
+#
+#   overwritable? 'path/to/my/file.rb'
+#
+# Returns true or false based on user selection.
+def overwritable? path
+  puts "#{path} already exists. Replace? (yes or no)"
+  decision = gets.strip!.downcase!
+  return false unless (decision == 'yes') || (decision == 'y')
+  return true
+end
+
+# Public: Adds to the end of a file.
+#
+# file - String path of file to add to
+# text - text to add
+#
+# Example
+#
+#   appent_to_file 'path/to/file.rb', 'Hello, world!'
+#
+# Returns nothing.
+#
+# Todo
+#
+#   - Return true/false based on success.
+def append_to_file file, text
+  File.open(file, 'a') {|f| f.write(text) }
+end
+
+# Public: Copies a file from one location to another.
+# Asks the user of existing files should be overwritten.
+#
+# orignal_file - String path of the file to be copied
+#     new_file - Destination of the copied file
+#
+# Example
+#
+#   copy_file 'path/to/original_file.rb', 'path/to/new/location.rb'
+#
+# Returns true if the file was copied, false if not.
+def copy_file original_file, new_file
+  unless File.exists? new_file
+    puts LABELS[:add] + new_file
+    FileUtils.cp original_file, new_file
+    return true
+  else
+    if overwritable? new_file
+      puts LABELS[:overwrite] + new_file
+      FileUtils.cp original_file, new_file
+      return true
+    else
+      puts LABELS[:ignore] + new_file
+      return false
+    end
+  end
+end
+
+# Public: Copies a file using ERB to insert variables.
+#
+# template_file - String path of the template to be copied
+#      new_file - String path of the file to create from the template_file
+#        locals - Hash of variables to pass to the temlate_file
+#
+# Example
+#
+#   copy_template "#{TEMPLATES}/path/to/template.rb",
+#                 'path/to/new/file.rb',
+#                 { foo: 'bar' }
+#
+# Returns true if the template was copied, false if not.
+def copy_template template_file, new_file, locals = {}
+  unless File.exists? new_file
+    puts LABELS[:add] + new_file
+    File.open(new_file, 'w') { |f| f.write( ERB.new(File.read(template_file)).result(binding) ) }
+    return true
+  else
+    if overwritable? new_file
+      puts LABELS[:overwrite] + new_file
+      File.open(new_file, 'w') { |f| f.write( ERB.new(File.read(template_file)).result(binding) ) }
+      return true
+    else
+      puts LABELS[:ignore] + new_file
+      return false
+    end
+  end
+end
+
+# Public: Creates a directory if it doesn't already exist.
+#
+# *args - path(s) as a String, multiple Strings, or an Array of Strings
+#
+# Examples
+#
+#   create_directory 'path/to/directory'
+#   create_directory 'path/to/directory', 'path/to/other/directory
+#   create_directory ['path/to/directory', 'path/to/other/directory']
+#
+# Returns nothing.
+#
+# Todo
+#
+#   - Return true/false based on success.
+def create_directory *args
+  args = args.first if args.first.kind_of? Array
+  args.each { |dir| FileUtils.mkdir(dir) unless File.exists?(dir) }
+end
+
+# Public: Copies a directory (with contents) to another directory.
+# If the new directory doesn't exist, it will be created.
+#
+# original_dir - String path of the directory to be copied from
+#      new_dir - String path of directory to be copied to
+#
+# Example
+#
+#   copy_directory 'path/to/original/directory', 'path/to/new/directory'
+#
+# Returns nothing.
+#
+# Todo
+#
+#   - Return true/false based on success.
+def copy_directory original_dir, new_dir
+  create_directory new_dir
+  Dir.glob("#{original_dir}/**/{*,.gitignore}").each do |path|
+    new_path = path.sub original_dir, new_dir
+    File.directory?(path) ? create_directory(new_path) : copy_file(path, new_path)
+  end
+end