kelredd-sinatra-helpers 0.2.8 → 0.3.0

data/README.rdoc

@@ -4,12 +4,20 @@
 
 This is a ruby gem with a bunch of helpers to make Sinatra more useful.
 
+== Installation
+
+    gem install kelredd-sinatra-helpers
+
+== Usage
+
+    require 'sinatra_helpers'
+
 === 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)
+ * Bundler for gem configurations
  * Capistrano deployment scheme
  * Source control with Git
  * Erb (with generators from useful: http://github.com/kelredd/useful/tree/master/lib/useful/erb_helpers/)
@@ -20,7 +28,8 @@ I've written a generator for new Sinatra apps.  Please note: I've written this g
  * Rack::Less (http://github.com/kelredd/rack-less)
  * Rack::Sprockets (http://github.com/kelredd/rack-sprockets)
  * Unit testing with Test::Unit
- 
+ * Test suite using leftright, rack-test, webrat, etc...
+
 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
@@ -37,15 +46,21 @@ http://github.com/kelredd/useful/tree/master/lib/useful/erb_helpers/ for more in
 
 === ActiveRecord
 
-Coming.
+Provides a Rails like way for configuring an activerecord database.  Here's the steps to set it up:
 
-== Installation
+1. Configure this gem in your bundle
 
-    gem install kelredd-sinatra-helpers
+    gem 'kelredd-sinatra-helpers', :require => "sinatra_helpers"
 
-== Usage
+2. Configure active record in your bundle
 
-    require 'sinatra_helpers'
+    gem 'activerecord'
+
+3. Create your db config yaml file at 'config/database.yml'
+
+4. Somewhere in your app initialization script, do
+
+    require 'sinatra_helpers/active_record'
 
 == License
 

data/lib/sinatra_helpers/active_record.rb

@@ -0,0 +1,21 @@
+require 'sinatra/base'
+require 'active_record'
+
+module SinatraHelpers; end
+module SinatraHelpers::ActiveRecord
+
+  class << self
+
+    def registered(app)
+      db_config_file = File.join(Sinatra::Application.root,'config',"database.yml")
+      db_config = YAML.load(ERB.new(IO.read(db_config_file)).result)
+      db = (db_config[Sinatra::Application.environment.to_s]).symbolize_keys
+      ::ActiveRecord::Base.establish_connection(db)
+      ::ActiveRecord::Base.logger = Logger.new(STDOUT)
+    end
+
+  end
+
+end
+
+Sinatra::Application.register SinatraHelpers::ActiveRecord

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

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem 'sinatra'
+
+gem 'rack-flash'
+gem 'rack-cache',     :require => "rack/cache"
+gem 'rack-less',      :require => "rack/less"
+gem 'rack-sprockets', :require => "rack/sprockets"
+
+gem 'kelredd-useful',              :require => "useful/ruby_extensions"
+gem 'kelredd-sinatra-helpers',     :require => "sinatra_helpers"
+
+group :test do
+  gem 'rack-test', "~>0.5", :require => "rack/test"
+  gem 'shoulda', "~>2.11"
+  gem 'leftright'
+  gem 'webrat', "~>0.7"
+end

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

@@ -1,5 +1,10 @@
 require 'rubygems'
+require 'bundler'
+Bundler.setup
+
 require 'sinatra'
+Bundler.require(:default)
+
 require 'app/base'
 
 # define routes here or load in route definitions

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

@@ -1,10 +1,10 @@
 RACK_ENV = ENV["RACK_ENV"] ||= "development"
 ROOT_DIR = File.expand_path("#{File.dirname(__FILE__)}/..") unless defined? ROOT_DIR
- 
+
 def root_path(*args)
   File.join(ROOT_DIR, *args)
 end
- 
+
 def public_path(*args)
   root_path('public', *args)
 end
@@ -30,7 +30,7 @@ def load_lib(files_dir=[])
 end
 
 def load_libs
-  load_lib 
+  load_lib
 end
 
 require 'config/env'

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

@@ -1,11 +1,10 @@
 #!/usr/bin/env ruby
 
-ENV['RACK_ENV'] ||= (ARGV.first || 'development')
+RACK_ENV = ENV['RACK_ENV'] = (ARGV.first || 'development')
 platform_irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 
 require 'rubygems'
-require 'sinatra/base'
 libs =  " -r app"
 
-puts "Loading default environment (Sinatra #{Sinatra::VERSION})"
-exec "#{platform_irb} #{libs} --simple-prompt"
+puts "Loading #{RACK_ENV} environment (Sinatra)"
+exec "#{platform_irb} #{libs} --simple-prompt"

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

@@ -1,7 +1,9 @@
 require 'capistrano/ext/multistage'
 require 'useful/cap_tasks'
+require 'bundler/capistrano'
 
 set :stages, %w(live staging)
+set :application, "<%= @name %>"
 
 require 'useful/cap_tasks/git_query_revision_remote'
 require 'useful/cap_tasks/passenger_deploy'
@@ -9,7 +11,7 @@ require 'useful/cap_tasks/disable_with_down_html'
 require 'useful/cap_tasks/rack_cache'
 
 namespace :deploy do
-  
+
   after 'deploy:update_code', 'deploy:setup_stage_environment'
 
   desc "_: (#{application}) Setup production environment (files, symlinks, etc...)."
@@ -17,5 +19,5 @@ namespace :deploy do
     config = "#{release_path}/admin/#{rack_env}.ru"
     run "cp #{config} #{release_path}/config.ru"
   end
-  
+
 end

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

@@ -1,8 +1,5 @@
 require 'logger'
 LOGGER = Logger.new(root_path('log', "#{RACK_ENV}.log"))
- 
-require 'config/gems'
-Gemsconfig::load if defined?(Gemsconfig)
 
 # basic app configurations
 set :root, root_path
@@ -10,43 +7,4 @@ set :views, root_path("app", "views")
 set :images_path, public_path("images")
 set :environment, RACK_ENV.to_sym if defined?(RACK_ENV)
 
-# Load environment
-begin
-  require "config/envs/#{RACK_ENV.downcase}"
-rescue LoadError => err
-  puts "no environment config set up for '#{RACK_ENV.downcase}', ignoring..."
-end
-
-# load app files
-load_app 'helpers'
-load_app 'models'
-
-# Load initializers
-Dir[root_path('config', 'initializers', '*.rb')].each do |file|
-  require file
-end
-
-# load middlewares
-# TODO: set your session cookie name here
-use Rack::Session::Cookie, :key => '_sess'
-use Rack::Flash
-
-use Rack::Less
-Rack::Less.configure do |config|
-  config.combinations = {
-    'web' => ['reset', 'app']
-  }
-  config.combination_timestamp = if !development?
-    File.mtime(Sinatra::Application.root).to_i
-  else
-    true
-  end
-  if config.cache = !development?
-    config.compress = :whitespace
-  end
-end
-
-use Rack::Sprockets
-Rack::Sprockets.configure do |config|
-  config.cache = production? 
-end
+require 'config/init'

data/lib/sinatra_helpers/generator/file_templates/environment.rake.erb

@@ -5,4 +5,3 @@ task :environment do
   set :app_file, File.join(root_path, 'app.rb')
   disable :run
 end
-

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

@@ -0,0 +1,28 @@
+# load app files
+load_app 'helpers'
+load_app 'models'
+
+# load middlewares
+# TODO: set your session cookie name here
+use Rack::Session::Cookie, :key => '_sess'
+use Rack::Flash
+
+use Rack::Less
+Rack::Less.configure do |config|
+  config.combinations = {
+    'web' => ['reset', 'app']
+  }
+  if config.cache = production?
+    # only cache if in production
+    # compress by removing whitespace if in production
+    config.compress = :whitespace
+  else
+    # always cache_bust if not in production
+    config.cache_bust = true
+  end
+end
+
+use Rack::Sprockets
+Rack::Sprockets.configure do |config|
+  config.cache = production?
+end

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

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test/helper'
 
 class LayoutTest < Test::Unit::TestCase
 
@@ -7,19 +7,19 @@ class LayoutTest < Test::Unit::TestCase
   end
 
   context "The app's layout" do
-  
-    before do
+
+    setup do
       visit '/'
     end
 
 
     # TODO: write better tests...
     # => this is just for show :)
-    
+
     should "say hello" do
       assert_contain "Hello from <%= @class_name %>!"
     end
-    
+
   end
 
 end

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

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'test/helper'
 
 class UnitTest < Test::Unit::TestCase
 
@@ -7,7 +7,7 @@ class UnitTest < Test::Unit::TestCase
     should "flunk" do
       flunk "This is just an example from a template.  Please provide some tests"
     end
-    
+
   end
 
 end

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

@@ -1,10 +1,3 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda/test_unit'
-require 'useful/shoulda_macros/test_unit'
-require 'rack/test'
-require 'webrat'
-
 ENV["RACK_ENV"] = "test"
 ROOT_DIR = File.expand_path("#{File.dirname(__FILE__)}/..")
 
@@ -13,13 +6,17 @@ $LOAD_PATH.unshift(File.join(ROOT_DIR, 'test'))
 
 require 'app'
 
+require 'test/unit'
+require 'useful/shoulda_macros/test_unit'
+Bundler.require(:test)
+
 class Test::Unit::TestCase
   include Rack::Test::Methods
   include Webrat::Methods
   include Webrat::Matchers
- 
+
   Webrat.configure do |config|
     config.mode = :rack
   end
-  
+
 end

data/lib/sinatra_helpers/generator/template.rb

@@ -8,12 +8,12 @@ module SinatraHelpers::Generator
     'Capfile.erb' => 'Capfile',
     'Rakefile.erb' => 'Rakefile',
     'gitignore.erb' => '.gitignore',
-    
+
     :admin => {
       'production.ru.erb' => 'production.ru',
       'staging.ru.erb' => 'staging.ru'
     },
-    
+
     :app => {
       'base.rb.erb' => 'base.rb',
       :helpers => {},
@@ -31,7 +31,7 @@ module SinatraHelpers::Generator
         'app.less.erb' => 'app.less'
       }
     },
-    
+
     :config => {
       'deploy.rb.erb' => 'deploy.rb',
       :deploy => {
@@ -39,36 +39,29 @@ module SinatraHelpers::Generator
         'deploy_staging.rb.erb' => 'staging.rb'
       },
       'env.rb.erb' => 'env.rb',
-      :envs => {
-        'env_development.rb.erb' => 'development.rb',
-        'env_production.rb.erb' => 'production.rb',
-        'env_staging.rb.erb' => 'staging.rb',
-        'env_test.rb.erb' => 'test.rb'
-      },
-      'gems.rb.erb' => 'gems.rb',
-      :initializers => {
-        'init.rb.erb' => 'init.rb'
-      }
+      'init.rb.erb' => 'init.rb'
     },
-    
+
+    'Gemfile.erb' => 'Gemfile',
+
     :lib => {
       :tasks => {
         'environment.rake.erb' => 'environment.rake'
       }
     },
-    
+
     :log => {},
-    
+
     :public => {
       :images => {},
     },
-    
+
     :script => {
       'console.erb' => 'console'
     },
-    
+
     :test => {
-      'test_helper.rb.erb' => 'test_helper.rb',
+      'test_helper.rb.erb' => 'helper.rb',
       :functional => {
         'layout_test.rb.erb' => 'layout_test.rb'
       },
@@ -76,7 +69,7 @@ module SinatraHelpers::Generator
         'model_test.rb.erb' => 'model_test.rb'
       }
     }
-    
+
   }
 
 end

data/lib/sinatra_helpers/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kelredd-sinatra-helpers
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 8
-  version: 0.2.8
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 -05:00
+date: 2010-09-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -126,6 +126,7 @@ files:
 - README.rdoc
 - Rakefile
 - bin/sinatra
+- lib/sinatra_helpers/active_record.rb
 - lib/sinatra_helpers/cache.rb
 - lib/sinatra_helpers/environment_tests.rb
 - lib/sinatra_helpers/erb/analytics.rb
@@ -147,11 +148,8 @@ files:
 - lib/sinatra_helpers/generator/file_templates/deploy_production.rb.erb
 - lib/sinatra_helpers/generator/file_templates/deploy_staging.rb.erb
 - lib/sinatra_helpers/generator/file_templates/env.rb.erb
-- lib/sinatra_helpers/generator/file_templates/env_development.rb.erb
-- lib/sinatra_helpers/generator/file_templates/env_production.rb.erb
-- lib/sinatra_helpers/generator/file_templates/env_staging.rb.erb
-- lib/sinatra_helpers/generator/file_templates/env_test.rb.erb
 - lib/sinatra_helpers/generator/file_templates/environment.rake.erb
+- lib/sinatra_helpers/generator/file_templates/Gemfile.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.erb