kelredd-sinatra-helpers 0.1.1 → 0.1.2

data/README.rdoc

@@ -4,6 +4,29 @@
 
 This is a ruby gem with a bunch of helpers to make Sinatra more useful.
 
+=== A Generator
+
+I've written a generator for new Sinatra apps.  Please note: I've written this generator suited for my needs and paradigms in writing Sinatra apps.  It is written for me and comes AS IS.  Use if you wish, but know that it conforms to what I like using in Sinatra apps, including:
+
+ * Most, if not all, of the helpers in this gem
+ * Gem configuration (via gemsconfig: http://github.com/kelredd/gemsconfig)
+ * Sprockets (via sprockets-sinatra: http://github.com/kelredd/sprockets-sinatra)
+ * Less (coming)
+ * Capistrano deployment scheme
+ * Source control with Git
+ * Erb (with generators from useful: http://github.com/kelredd/useful/tree/master/lib/useful/erb_helpers/)
+ * an App directory structure similar to Rails'
+ * Default layout that I like
+ * Rack::Cache using my configuration (see admin/production.ru)
+ * Rack::Flash
+ * Unit testing with Test::Unit (coming)
+ * BDD using Cucumber (coming)
+ 
+If you don't like/want to use something that this generates, don't use the generator, or back out some generated code manually.  Ok, enough about that.  On to usage:
+
+    $ sinatra path/to/app
+    # will create the app structure in path/to/app
+
 === Environment Tests
 
 Have environment tests like development? and production? available in your app code

data/Rakefile

@@ -14,8 +14,8 @@ spec = Gem::Specification.new do |s|
   s.author           = 'Kelly Redding'
   s.email            = 'kelly@kelredd.com'
   s.homepage         = 'http://github.com/kelredd/sinatra-helpers'
-  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
-  # s.executables    = ['sinatra-helpers']
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{bin,lib}/**/*")
+  s.executables    = ['sinatra']
   
   s.add_dependency('kelredd-useful', '>= 0.2.0')
 end

data/bin/sinatra

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'sinatra_helpers/generator'
+
+if ARGV[0]
+  app_path = ARGV[0].slice(0,1) == File::Separator ? ARGV[0] : File.join(%x{pwd}.strip, ARGV[0])
+  app = SinatraHelpers::Generator::App.new(app_path)
+  app.generate
+else
+  puts "Please specify a name for your gem"
+end

data/lib/sinatra_helpers.rb

@@ -1,2 +1,3 @@
 require 'sinatra_helpers/environment_tests'
 require 'sinatra_helpers/erb'
+require 'sinatra_helpers/generator'

data/lib/sinatra_helpers/generator.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), "generator" ,"*.rb")].each do |file|
+  require "sinatra_helpers/generator/#{File.basename(file, ".rb")}"
+end

data/lib/sinatra_helpers/generator/app.rb

@@ -0,0 +1,53 @@
+require 'erb'
+
+module SinatraHelpers; end
+
+module SinatraHelpers::Generator
+
+  class App
+    
+    attr_reader :root_path, :name
+    
+    def initialize(path)
+      @root_path = File.dirname(path)
+      self.name = File.basename(path)
+    end
+    
+    def name=(name)
+      @name = name.gsub(/([A-Z])([a-z])/, '-\1\2').sub(/^-/, '').downcase
+    end
+    
+    def generate
+      build_template(File.join(self.root_path, self.name), SinatraHelpers::Generator::TEMPLATE)
+    end
+    
+    private
+    
+    def build_template(root_path, dir_hash)
+      FileUtils.mkdir_p(root_path)
+      dir_hash.each do |k, v|
+        if v.kind_of?(::Hash)
+          build_template(File.join(root_path,k.to_s), v)
+        elsif v.kind_of?(::String)
+          build_template_file(root_path, k.to_s, v.to_s)
+        end
+      end
+    end
+    
+    def build_template_file(root_path, erb_name, file_name)
+      source_file = File.join(File.dirname(__FILE__), "file_templates", erb_name)
+      output_file = File.join(root_path, file_name)
+
+      unless File.exists?(output_file)      
+        if ['.erb'].include?(File.extname(source_file))
+          erb = ERB.new(File.read(source_file))
+          File.open(output_file, 'w') {|f| f << erb.result(binding) }
+        else
+          FileUtils.cp(source_file, output_file)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/sinatra_helpers/generator/file_templates/Capfile.erb

@@ -0,0 +1,2 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+load 'config/deploy'

data/lib/sinatra_helpers/generator/file_templates/Rakefile.erb

@@ -0,0 +1,4 @@
+require 'rubygems'
+
+require 'config/gems.rb'
+require 'gemsconfig/tasks/rake'

data/lib/sinatra_helpers/generator/file_templates/app.js.erb

@@ -0,0 +1 @@
+// TODO: put any application javascript code here

data/lib/sinatra_helpers/generator/file_templates/app.rb.erb

@@ -0,0 +1,27 @@
+%w(yaml erb rubygems sinatra config/gems).each do |lib|
+  require lib
+end
+
+Gemsconfig::load if defined?(Gemsconfig)
+require 'config/initializers'
+
+# TODO: set your session cookie name here
+use Rack::Session::Cookie, :key => '_sess'
+use Rack::Flash
+
+# Load in helpers
+Dir[File.join(File.dirname(__FILE__), "app/helpers" ,"*.rb")].each do |file|
+  require "app/helpers/#{File.basename(file, ".rb")}"
+end
+
+# Load in models
+Dir[File.join(File.dirname(__FILE__), "app/models" ,"*.rb")].each do |file|
+  require "app/models/#{File.basename(file, ".rb")}"
+end
+
+# Load in controllers
+Dir[File.join(File.dirname(__FILE__), "app/controllers" ,"*.rb")].each do |file|
+  load File.join(File.dirname(__FILE__), 'app/controllers', File.basename(file))
+end
+
+set :views, File.join(File.dirname(__FILE__), 'app', 'views')

data/lib/sinatra_helpers/generator/file_templates/app_controller.rb.erb

@@ -0,0 +1,5 @@
+get %r{/($|index($|.html|.htm))} do
+  headers['Cache-Control'] = 'public, max-age=7200' if production? # rack::cache for 2 hours
+  erb 'app/index.html'.to_sym
+end
+

data/lib/sinatra_helpers/generator/file_templates/app_helpers.rb.erb

@@ -0,0 +1,11 @@
+require 'sinatra/base'
+
+module Sinatra
+  module AppHelpers
+
+    # TODO: put any application helpers here
+    
+  end
+
+  helpers AppHelpers
+end

data/lib/sinatra_helpers/generator/file_templates/app_initializer.rb.erb

@@ -0,0 +1,16 @@
+module Config; end
+module Config::Initializers; end
+
+module Config::Initializers::App
+  def self.registered(app)
+    
+    app.configure do
+
+      # TODO: put some initializer code in here
+      
+    end
+    
+  end
+end
+
+Sinatra::Application.register Config::Initializers::App

data/lib/sinatra_helpers/generator/file_templates/deploy.rb.erb

@@ -0,0 +1,4 @@
+require 'capistrano/ext/multistage'
+require 'useful/cap_tasks'
+
+set :stages, %w(live staging)

data/lib/sinatra_helpers/generator/file_templates/gems.rb.erb

@@ -0,0 +1,19 @@
+begin
+  require 'gemsconfig'
+rescue LoadError => err
+  p " ** can't load gemsconfig.  gem install kelredd-gemsconfig --source http://gems.github.com **"
+end
+
+Gemsconfig::init do |config|
+  
+  config.gem 'kelredd-useful', :lib => 'useful/ruby_extensions', :source => 'http://gemcutter.org'
+
+  config.gem 'rack-flash', :lib => 'rack-flash', :source => 'http://gemcutter.org'
+  config.gem 'rack-cache', :lib => false, :source => 'http://gemcutter.org'
+    
+  config.gem 'kelredd-sinatra-helpers', :lib => 'sinatra_helpers', :source => 'http://gemcutter.org'
+
+  config.gem 'sprockets'
+  config.gem 'kelredd-sprockets-sinatra', :lib => 'sprockets_sinatra', :source => 'http://gems.github.com'
+
+end if defined?(Gemsconfig)

data/lib/sinatra_helpers/generator/file_templates/gitignore.erb

@@ -0,0 +1 @@
+/log/*.log

data/lib/sinatra_helpers/generator/file_templates/initializers.rb.erb

@@ -0,0 +1,6 @@
+module Config; end
+module Config::Initializers; end
+
+Dir["config/initializers/*.rb"].each do |file|
+  require "config/initializers/#{File.basename(file, ".rb")}"
+end

data/lib/sinatra_helpers/generator/file_templates/layout

@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title><%= @page_title %></title>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <% if @meta_description %>
+    <meta name="description" content="<%= @meta_description %>" />
+  <% end %>
+  <% if @meta_norobots %>
+    <meta name="robots" content="noindex,nofollow" />
+  <% end %>
+  <link rel="icon" type="image/png" href="/favicon.png"></link>
+  <%= stylesheet_link_tag :web, :media => "all" %>
+	<% unless @noscript %>
+	  <%= sprockets_include_tag %>
+  <% end %>
+</head>
+<body class="body">
+  <%= yield %>
+  <% if production? %>
+  <% end %>
+</body>
+</html>

data/lib/sinatra_helpers/generator/file_templates/production.ru.erb

@@ -0,0 +1,24 @@
+FileUtils.mkdir_p 'log' unless File.exists?('log')
+log = File.new("log/production.log", "a+")
+$stdout.reopen(log)
+$stderr.reopen(log)
+
+require 'rubygems'
+require 'sinatra'
+require 'app'
+ 
+root_dir = File.dirname(__FILE__)
+
+set :root, root_dir
+set :app_file, File.join(root_dir, 'app.rb')
+set :environment, :production
+disable :run
+
+require 'rack/cache'
+
+use Rack::Cache,
+  :verbose     => true,
+  :metastore   => "file:#{File.join(root_dir, 'cache-rack', 'meta')}",
+  :entitystore => "file:#{File.join(root_dir, 'cache-rack', 'body')}"
+
+run Sinatra::Application

data/lib/sinatra_helpers/generator/file_templates/sprockets.yml.erb

@@ -0,0 +1,7 @@
+:file_name: app
+:asset_root: public
+:load_path:
+  - app/javascripts
+  - vendor/javascripts/*/src
+:source_files:
+  - app/app.js

data/lib/sinatra_helpers/generator/file_templates/web.css.erb

@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+/* some base styles */
+UL {
+  margin: 0;
+  padding: 0;
+  list-style-image: none;
+  list-style-position: inside;
+  list-style-type:none;
+}
+UL.bulleted {
+  list-style-type: disc !important;
+}
+OL {
+  display: block;
+  list-style-type: decimal;
+  margin: 1em 0;
+}
+
+HTML {
+  font-size:10pt;
+}
+BODY {
+  width: 100%;
+	font-family: "Lucida Grande", Verdana, sans-serif;
+	font-size: 1em;
+	font-size-adjust:none;
+	font-variant: normal;
+}
+A, IMG, FORM, FIELDSET {
+  border: 0px none;
+  padding: 0;
+  margin: 0;
+}
+INPUT, SELECT, TEXTAREA, BUTTON {
+  margin: 0;
+  padding: .2em .3em;
+	font-family : 'Lucida Grande', sans-serif;
+	font-size: 9px;
+	font-size-adjust: none;
+	font-variant: normal;
+}
+INPUT[type="submit"],
+INPUT[type="checkbox"], DIV.checkbox LABEL,
+INPUT[type="radiobutton"] {
+  cursor: pointer;
+  vertical-align: middle;
+}
+INPUT[type="checkbox"] {
+  margin-right: .2em;
+}
+SELECT {
+  padding: 0;
+}
+
+/* IE fixes */
+HTML, BODY {
+  height:100%;
+}
+
+/* Add the style below to a container element that contains floats - will cause the container 
+   to expand to the height of the floats */
+.clearfix:after {
+    content: "."; 
+    display: block; 
+    height: 0; 
+    clear: both; 
+    visibility: hidden;
+}
+/* Hides from IE-mac \*/
+* html .clearfix {height: 1%;}

data/lib/sinatra_helpers/generator/template.rb

@@ -0,0 +1,64 @@
+module SinatraHelpers; end
+
+module SinatraHelpers::Generator
+
+  TEMPLATE = {
+    'app.rb.erb' => 'app.rb',
+    'Capfile.erb' => 'Capfile',
+    'Rakefile.erb' => 'Rakefile',
+    'gitignore.erb' => '.gitignore',
+    
+    :admin => {
+      'production.ru.erb' => 'production.ru'
+    },
+    
+    :app => {
+      :controllers => {
+        'app_controller.rb.erb' => 'app.rb'
+      },
+      :helpers => {
+        'app_helpers.rb.erb' => 'app_helpers.rb'
+      },
+      :javascripts => {
+        'app.js.erb' => 'app.js'
+      },
+      :models => {},
+      :stylesheets => {},
+      :views => {
+        'layout' => 'layout.erb',
+        :app => {
+          'index.html.erb' => 'index.html.erb'
+        }
+      }
+    },
+    
+    :config => {
+      :deploy => {
+        'deploy_live.rb.erb' => 'live.rb',
+        'deploy_staging.rb.erb' => 'staging.rb'
+      },
+      'deploy.rb.erb' => 'deploy.rb',
+      'gems.rb.erb' => 'gems.rb',
+      :initializers => {
+        'app_initializer.rb.erb' => 'app.rb'
+      },
+      'initializers.rb.erb' => 'initializers.rb',
+      'sprockets.yml.erb' => 'sprockets.yml'
+    },
+    
+    :log => {},
+    
+    :public => {
+      :images => {},
+      :javascripts => {},
+      :stylesheets => {
+        'web.css.erb' => 'web.css'
+      }
+    },
+    
+    :vendor => {
+      :javascripts => {}
+    }
+  }
+
+end

data/lib/sinatra_helpers/version.rb

@@ -3,7 +3,7 @@ module SinatraHelpers
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 1
+    TINY  = 2
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kelredd-sinatra-helpers
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kelly Redding
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 -06:00
+date: 2009-11-11 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,8 +24,8 @@ dependencies:
     version: 
 description: 
 email: kelly@kelredd.com
-executables: []
-
+executables: 
+- sinatra
 extensions: []
 
 extra_rdoc_files: 
@@ -33,9 +33,31 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- bin/sinatra
 - lib/sinatra_helpers/environment_tests.rb
 - lib/sinatra_helpers/erb/partials.rb
 - lib/sinatra_helpers/erb.rb
+- lib/sinatra_helpers/generator/app.rb
+- lib/sinatra_helpers/generator/file_templates/app.js.erb
+- lib/sinatra_helpers/generator/file_templates/app.rb.erb
+- lib/sinatra_helpers/generator/file_templates/app_controller.rb.erb
+- lib/sinatra_helpers/generator/file_templates/app_helpers.rb.erb
+- lib/sinatra_helpers/generator/file_templates/app_initializer.rb.erb
+- lib/sinatra_helpers/generator/file_templates/Capfile.erb
+- lib/sinatra_helpers/generator/file_templates/deploy.rb.erb
+- lib/sinatra_helpers/generator/file_templates/deploy_live.rb.erb
+- lib/sinatra_helpers/generator/file_templates/deploy_staging.rb.erb
+- lib/sinatra_helpers/generator/file_templates/gems.rb.erb
+- lib/sinatra_helpers/generator/file_templates/gitignore.erb
+- lib/sinatra_helpers/generator/file_templates/index.html.erb
+- lib/sinatra_helpers/generator/file_templates/initializers.rb.erb
+- lib/sinatra_helpers/generator/file_templates/layout
+- lib/sinatra_helpers/generator/file_templates/production.ru.erb
+- lib/sinatra_helpers/generator/file_templates/Rakefile.erb
+- lib/sinatra_helpers/generator/file_templates/sprockets.yml.erb
+- lib/sinatra_helpers/generator/file_templates/web.css.erb
+- lib/sinatra_helpers/generator/template.rb
+- lib/sinatra_helpers/generator.rb
 - lib/sinatra_helpers/version.rb
 - lib/sinatra_helpers.rb
 has_rdoc: true