sinatra_more 0.2.9 → 0.3.0

data/.gitignore

@@ -19,4 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-webrat.log
+webrat.log
+tmp/**/*

data/README.rdoc

@@ -58,9 +58,8 @@ Keep in mind, the user will be able to pull in these components seperately and l
 Please help me brainstorm and fork the project if you have any ideas to contribute.
 
 == Installation
-
-This gem has very few runtime dependencies. The 'sinatra' gem needs to be installed and also 'activesupport' (for the inflectors). 
-If you want to use the WardenPlugin component, then the 'warden' gem would also be required.
+ 
+If you want to use the WardenPlugin component, then the 'warden' gem would need to be installed.
 
 To install sinatra_more, simply grab the latest version from gemcutter:
 
@@ -541,12 +540,57 @@ or perhaps we want to have a short body without the need for a template file:
       body    "This is a short body defined right in the mailer itself"
     end
   end
+  
+== Sinatra Generators
+
+In addition to the support provided above, sinatra_more also comes preloaded with flexible code generators for Sinatra
+powered in part by the excellent Thor gem (incidentally also used in the Rails 3 generators). These generators are intended
+to allow for easy code generation both in creating new applications and building on existing ones. The generators have been
+built to be as library-agnostic as possible, supporting a myriad of test frameworks, js libraries, mocking libraries, etc. 
+
+The usage for the generator is quite simple:
+
+  $ sinatra_gen <the_app_name> </path/to/create/app> --<component-name> <value>
+
+The simplest possible command to generate a base application would be:
+
+  $ sinatra_gen demo_app .
+  
+This would construct a Sinatra application DemoApp (which extends from Sinatra::Application) 
+inside the folder 'demo_app' at our current path. Inside the application there would be configuration and 
+setup performed for the default components. You can also define specific components to be used:
 
+  $ sinatra_gen demo_app . --test=rspec --renderer=haml --mock=rr --script=jquery --orm datamapper
+  
+There is also support for aliases for each component within the command:
+
+  $ sinatra_gen demo_app . -t=rspec -r=haml -m=rr -s=jquery -d=datamapper
+  
+The available components and their default options are listed below:
+
+* test:     <tt>bacon</tt>  (default), <tt>shoulda</tt>, <tt>rspec</tt>, <tt>testspec</tt>,<tt>riot</tt>
+* renderer: <tt>erb</tt>    (default), <tt>haml</tt>
+* mock:     <tt>mocha</tt>  (default), <tt>rr</tt>
+* script:   <tt>jquery</tt> (default), <tt>prototype</tt>, <tt>rightjs</tt>
+* orm:      <tt>sequel</tt> (default), <tt>datamapper</tt>, <tt>mongomapper</tt>, <tt>activerecord</tt>
+ 
+The generator framework within sinatra_more is highly extensible and additional components and tools can easily be added. 
+This would be achieved through forking our project and reading through the code in <tt>/generators/sinatra_generator.rb</tt> and
+the setup instructions inside the relevant files within <tt>/generators/components/</tt>. We are happy to accept pull requests
+for additional component types not originally included (although helping us maintain them would also be appreciated).
+
+We are planning to add additional generator actions such as:
+
+* Model generator (working for any of the available orms listed)
+* Routes generator 
+* Migrations generator
+  
 == Acknowledgements
 
-* Thanks to keldredd for the <tt>sinatra_helpers</tt> code that helped me to create erb capture and concat methods.
+* Thanks to kelredd (http://github.com/kelredd) for the <tt>sinatra_helpers</tt> code that helped me to create erb capture and concat methods.
 * Thanks to sbfaulkner for the <tt>sinatra-helpers</tt> code that I browsed through many times while starting this library.
 * Thanks to vestel for the excellent modified <tt>pony</tt> fork which in part powers the mailer_plugin (http://github.com/vestel/pony)
+* Thanks to wycats and all for the awesome Thor gem which made creating the sinatra generator relatively painless
 
 == Contributors
 

data/Rakefile

@@ -12,8 +12,9 @@ begin
     gem.email = "nesquena@gmail.com"
     gem.homepage = "http://github.com/nesquena/sinatra_more"
     gem.authors = ["Nathan Esquenazi"]
-    gem.add_runtime_dependency     "tilt",          ">= 0.2"
     gem.add_runtime_dependency     "sinatra",       ">= 0.9.2"
+    gem.add_runtime_dependency     "tilt",          ">= 0.2"
+    gem.add_runtime_dependency     "thor",          ">= 0.11.8"
     gem.add_runtime_dependency     "activesupport", ">= 2.2.2"
     gem.add_development_dependency "haml",          ">= 2.2.1"
     gem.add_development_dependency "shoulda",       ">= 2.10.2"

data/TODO

@@ -5,7 +5,8 @@
 * Add support for check_box_group, radio_button_group which create a set of checkboxes or radio buttons
 * Look into creating sinatra generators using rubigen (http://github.com/drnic/rubigen)
   * http://github.com/quirkey/sinatra-gen
-  * http://github.com/monkrb/monk
+  * test generators
+  * add support for model, routes, migration generator types
 * Become total warden solution (basically just require warden gem installed, do everything else)
   * Look into removing overlapping methods and simply leverage sinatra_warden
   * Take advantage of shared strategies: http://github.com/hassox/warden_strategies/tree/master/lib/

data/VERSION

@@ -1 +1 @@
-0.2.9
+0.3.0

data/bin/sinatra_gen

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+%w[rubygems activesupport thor].each { |gem| require gem }
+require File.dirname(__FILE__) + "/../generators/skeleton_generator"
+SinatraMore::SkeletonGenerator.start

data/generators/base_app/app/helpers/view_helpers.rb

@@ -0,0 +1,3 @@
+module ViewHelpers
+ # Basic helpers can be defined here
+end

data/generators/base_app/app.rb.tt

@@ -0,0 +1,5 @@
+%w[rubygems sinatra/base].each { |gem| require gem }
+
+class <%= @class_name %> < Sinatra::Application
+  load 'config/boot.rb'
+end

data/generators/base_app/config/boot.rb.tt

@@ -0,0 +1,37 @@
+# This file is merely for beginning the boot process, check dependencies.rb for more information
+
+ROOT_DIR = File.dirname(__FILE__) + '/../' unless defined? ROOT_DIR
+
+# Helper method for file references.
+#
+# @param args [Array] Path components relative to ROOT_DIR.
+# @example Referencing a file in config called settings.yml:
+#   root_path("config", "settings.yml")
+def root_path(*args)
+  File.join(ROOT_DIR, *args)
+end
+
+# Returns the full path to the public folder along with any given additions
+# public_path("images")
+def public_path(*args)
+  root_path('public', *args)
+end
+
+class <%= @class_name %> < Sinatra::Application
+  # Defines basic application settings
+  set :root, root_path
+  set :views, root_path("app", "views")
+  set :images_path, public_path("images")
+  set :default_builder, 'StandardFormBuilder'
+
+  # Dependencies contains all required gems and core configuration
+  require File.dirname(__FILE__) + '/dependencies.rb'
+
+  # Requires the initializer modules which configure specific components
+  Dir[File.dirname(__FILE__) + '/initializers/*.rb'].each do |file|
+    # Each initializer file contains a module called 'XxxxInitializer' (i.e HassleInitializer)
+    require file
+    file_class = File.basename(file, '.rb').classify
+    register "#{file_class}Initializer".constantize
+  end
+end

data/generators/base_app/config/dependencies.rb.tt

@@ -0,0 +1,26 @@
+# Dependencies contains all required gems, helpers and core configuration
+
+class <%= @class_name %> < Sinatra::Application
+  %w[rubygems rack-flash warden sinatra_more bcrypt].each { |gem| require gem }
+  
+  # Required middleware
+  use Rack::Session::Cookie
+  use Rack::Flash
+
+  # Returns the list of load paths for this sinatra application
+  def self.file_loading_paths
+    ["lib/**/*.rb", "app/helpers/**/*.rb", "app/routes/**/*.rb", "app/models/*.rb"]
+  end
+  
+  # Require all the folders and files necessary to run the application
+  file_loading_paths.each { |load_path| Dir[root_path(load_path)].each { |file| require file } }
+  
+  # Includes all necessary sinatra_more helpers
+  register SinatraMore::MarkupPlugin
+  register SinatraMore::RenderPlugin
+  register SinatraMore::MailerPlugin
+  register SinatraMore::WardenPlugin
+    
+  # Required helpers
+  helpers ViewHelpers
+end

data/generators/base_app/config.ru.tt

@@ -0,0 +1,13 @@
+RACK_ENV = ENV["RACK_ENV"] ||= "development" unless defined? RACK_ENV
+ROOT_DIR = $0.gsub(%r{^.*?/}, '/') unless defined? ROOT_DIR
+
+require File.dirname(__FILE__) + '/app.rb'
+
+FileUtils.mkdir_p 'log' unless File.exists?('log')
+log = File.new("log/sinatra.log", "a")
+$stdout.reopen(log)
+$stderr.reopen(log)
+
+ENV['DATABASE_URL'] = 'your_database_here'
+
+run <%= @class_name %>

data/generators/base_app/test/test_config.rb.tt

@@ -0,0 +1,6 @@
+%w[rubygems sinatra].each {|gem| require gem }
+require 'rack/test'
+require File.dirname(__FILE__) + "/../app"
+
+
+set :environment, :test

data/generators/components/component_actions.rb

@@ -0,0 +1,37 @@
+module SinatraMore
+  module ComponentActions
+    # Injects require statement into target file
+    # insert_require('active_record', :path => "test/test_config.rb", :indent => 2)
+    # options = { :path => '...', :indent => 2, :after => /.../ }
+    def insert_require(*libs)
+      options = libs.extract_options!
+      options.reverse_merge!(:indent => 0, :after => /require\sgem.*?\n/)
+      multiple_gem_require = "%w[#{libs.join(' ')}].each { |gem| require gem }\n"
+      req = indent_spaces(options[:indent]) + (libs.size == 1 ? "require '#{libs}'\n" : multiple_gem_require)
+      inject_into_file(options[:path], req, :after => options[:after])
+    end
+
+    # Returns space characters of given count
+    # indent_spaces(2)
+    def indent_spaces(count)
+      ' ' * count
+    end
+
+    # Injects the test class text into the test_config file for setting up the test gen
+    # insert_test_suite_setup('...CLASS_NAME...')
+    # => inject_into_file("test/test_config.rb", TEST.gsub(/CLASS_NAME/, @class_name), :after => "set :environment, :test\n")
+    def insert_test_suite_setup(suite_text, options={})
+      options.reverse_merge!(:path => "test/test_config.rb", :after => "set :environment, :test\n")
+      inject_into_file(options[:path], suite_text.gsub(/CLASS_NAME/, @class_name), :after => options[:after])
+    end
+
+    # Injects the mock library include into the test class in test_config for setting up mock gen
+    # insert_mock_library_include('Mocha::API')
+    # => inject_into_file("test/test_config.rb", "  include Mocha::API\n", :after => /class.*?\n/)
+    def insert_mocking_include(library_name, options={})
+      options.reverse_merge!(:indent => 2, :after => /class.*?\n/, :path => "test/test_config.rb")
+      include_text = indent_spaces(options[:indent]) + "include #{library_name}\n"
+      inject_into_file(options[:path], include_text, :after => options[:after])
+    end
+  end
+end

data/generators/components/mocks/mocha_mock_gen.rb

@@ -0,0 +1,8 @@
+module SinatraMore
+  module MochaMockGen
+    def setup_mock
+      insert_require 'mocha', :path => "test/test_config.rb", :after => "require 'rack/test'\n"
+      insert_mocking_include "Mocha::API", :path => "test/test_config.rb"
+    end
+  end
+end

data/generators/components/mocks/rr_mock_gen.rb

@@ -0,0 +1,8 @@
+module SinatraMore
+  module RrMockGen
+    def setup_mock
+      insert_require 'rr', :path => "test/test_config.rb", :after => "require 'rack/test'\n"
+      insert_mocking_include "RR::Adapters::RRMethods", :path => "test/test_config.rb"
+    end
+  end
+end

data/generators/components/orms/activerecord_orm_gen.rb

@@ -0,0 +1,60 @@
+module SinatraMore
+  module ActiverecordOrmGen
+    
+    AR = <<-AR
+module ActiveRecordInitializer
+  def self.registered(app)
+    app.configure do
+      ActiveRecord::Base.establish_connection(
+        :adapter => 'sqlite3',
+        :dbfile =>  ENV['DATABASE_URL']
+      )
+    end
+  end
+end
+AR
+
+
+   MIGRATION = <<-MIGRATION
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+       t.column :name, :string
+       t.column :username, :string
+       t.column :email, :string
+       t.column :crypted_password, :string
+       t.column :created_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+MIGRATION
+
+  USER = <<-USER
+class User < ActiveRecord::Base  
+  def self.authenticate(username, password)
+    user = User.first(:conditions => { :username => username })
+    user && user.has_password?(password) ? user : nil
+  end
+  
+  def encrypt_password
+    self.crypted_password = BCrypt::Password.create(password)
+  end
+  
+  def has_password?(password)
+    BCrypt::Password.new(crypted_password) == password
+  end
+end
+USER
+    
+    def setup_orm
+      insert_require 'active_record', :path => "config/dependencies.rb", :indent => 2
+      create_file("config/initializers/activerecord.rb", AR)
+      create_file("db/migrate/001_create_users.rb", MIGRATION)
+      create_file("app/models/user.rb", USER)
+    end
+  end
+end

data/generators/components/orms/datamapper_orm_gen.rb

@@ -0,0 +1,44 @@
+module SinatraMore
+  module DatamapperOrmGen
+    
+    DM = <<-DM
+module DatamapperInitializer
+  def self.registered(app)
+    app.configure do
+      DataMapper.setup(:default, ENV['DATABASE_URL'])
+    end
+  end
+end
+DM
+
+  USER = <<-USER
+class User
+  include DataMapper::Resource
+  
+  property :name,     String
+  property :username, String
+  property :email,    String
+  property :crypted_password, String
+
+  def self.authenticate(username, password)
+    user = User.first(:username => username)
+    user && user.has_password?(password) ? user : nil
+  end
+  
+  def encrypt_password
+    self.crypted_password = BCrypt::Password.create(password)
+  end
+  
+  def has_password?(password)
+    BCrypt::Password.new(crypted_password) == password
+  end
+end
+  USER
+    
+    def setup_orm
+      insert_require 'dm-core', :path => "config/dependencies.rb", :indent => 2
+      create_file("config/initializers/datamapper.rb", DM)
+      create_file("app/models/user.rb", USER)
+    end
+  end
+end

data/generators/components/orms/mongomapper_orm_gen.rb

@@ -0,0 +1,94 @@
+module SinatraMore
+  module MongomapperOrmGen
+    
+    MONGO = <<-MONGO
+class MongoDBConnectionFailure < RuntimeError; end
+
+module MongoDBInitializer
+  def self.registered(app)
+    MongoMapper.connection = Mongo::Connection.new('localhost')
+    MongoMapper.database = 'fyourparking'
+    User.first
+  rescue RuntimeError
+    raise MongoDBConnectionFailure.new("mongodb cannot connect to db! Start the mongodb process and try again.")
+  end
+end
+MONGO
+
+   CONCERNED = <<-CONCERN
+module MongoMapper
+  module Document
+    module ClassMethods
+      # TODO find a cleaner way for it to know where to look for dependencies
+      def concerned_with(*concerns)
+        concerns.each { |concern| require_dependency "./app/models/\#{name.underscore}/\#{concern}" }
+      end
+    end
+  end
+end
+CONCERN
+
+  USER = <<-USER
+class User
+  include MongoMapper::Document
+  concerned_with :authentications
+
+  key :name, String, :required => true
+  key :username, String, :required => true
+  key :email, String, :required => true
+  key :crypted_password, String, :required => true
+
+  many :car_photos
+end
+USER
+
+  AUTH = <<-AUTH
+class User
+  attr_accessor :password, :password_confirmation
+  before_validation :password_checks
+  validate :validate_password
+
+  def password_checks
+    if password_required?
+      encrypt_password if password.present? && password == password_confirmation
+    end
+  end
+
+  def password_required?
+    crypted_password.blank? || !password.blank?
+  end
+
+  def encrypt_password
+    self.crypted_password = BCrypt::Password.create(password)
+  end
+
+  def has_password?(password)
+    BCrypt::Password.new(crypted_password) == password
+  end
+
+  def encrypt_password
+    return if password.blank?
+    self.crypted_password = BCrypt::Password.create(password)
+  end
+
+  def validate_password
+    errors.add :password, "must not be empty" if crypted_password.blank? && password.blank?
+    errors.add :password, "must match password confirmation" unless password == password_confirmation
+  end
+
+  def self.authenticate(username, password)
+    user = User.first(:conditions => { :username => username })
+    user && user.has_password?(password) ? user : nil
+  end
+end
+AUTH
+
+    def setup_orm
+      insert_require 'mongo_mapper', :path => "config/dependencies.rb", :indent => 2
+      create_file("config/initializers/mongodb.rb", MONGO)
+      create_file("lib/ext/mongo_mapper.rb", CONCERNED)
+      create_file("app/models/user.rb", USER)
+      create_file("app/models/user/authentications.rb", AUTH)
+    end
+  end
+end

data/generators/components/orms/sequel_orm_gen.rb

@@ -0,0 +1,48 @@
+module SinatraMore
+  module SequelOrmGen
+
+    SEQUEL = <<-SEQUEL
+module SequelInitializer
+  def self.registered(app)
+    app.configure do
+      Sequel.connect(ENV['DATABASE_URL'])
+    end
+  end
+end
+SEQUEL
+
+    USER = <<-USER
+class User < Sequel::Model(:users)
+  unless table_exists?
+    set_schema do
+      primary_key :id
+      string :name
+      string :username
+      string :email
+      string :crypted_password
+    end
+    create_table
+  end
+  
+  def self.authenticate(username, password)
+    user = User.filter(:username => username).first
+    user && user.has_password?(password) ? user : nil
+  end
+  
+  def encrypt_password
+    self.crypted_password = BCrypt::Password.create(password)
+  end
+  
+  def has_password?(password)
+    BCrypt::Password.new(crypted_password) == password
+  end
+end
+USER
+
+    def setup_orm
+      insert_require 'sequel', :path => "config/dependencies.rb", :indent => 2
+      create_file("config/initializers/sequel.rb", SEQUEL)
+      create_file("app/models/user.rb", USER)
+    end
+  end
+end

data/generators/components/renderers/erb_renderer_gen.rb

@@ -0,0 +1,7 @@
+module SinatraMore
+  module ErbRendererGen    
+    def setup_renderer
+      insert_require 'erb', :path => "config/dependencies.rb", :indent => 2
+    end
+  end
+end

data/generators/components/renderers/haml_renderer_gen.rb

@@ -0,0 +1,17 @@
+module SinatraMore
+  module HamlRendererGen
+    
+    HASSLE = <<-HASSLE
+module HassleInitializer
+  def self.registered(app)
+    app.use Hassle
+  end
+end
+HASSLE
+    
+    def setup_renderer
+      insert_require('haml', 'sass', 'hassle', :path => 'config/dependencies.rb', :indent => 2)
+      create_file("config/initializers/hassle.rb", HASSLE)
+    end
+  end
+end

data/generators/components/scripts/jquery_script_gen.rb

@@ -0,0 +1,9 @@
+module SinatraMore
+  module JqueryScriptGen
+
+    def setup_script
+      get("http://jqueryjs.googlecode.com/files/jquery-1.3.2.min.js", "public/javascripts/jquery.min.js")
+    end
+    
+  end
+end

data/generators/components/scripts/prototype_script_gen.rb

@@ -0,0 +1,10 @@
+module SinatraMore
+  module PrototypeScriptGen
+
+    def setup_script
+      get("http://prototypejs.org/assets/2009/8/31/prototype.js", "public/javascripts/prototype.js")
+      get('http://github.com/nesquena/lowpro/raw/master/dist/lowpro.js', "public/javascripts/lowpro.js")
+    end
+    
+  end
+end

data/generators/components/scripts/rightjs_script_gen.rb

@@ -0,0 +1,9 @@
+module SinatraMore
+  module RightjsScriptGen
+
+    def setup_script
+      get("http://rightjs.org/builds/current/right-min.js", "public/javascripts/right-min.js")
+    end
+    
+  end
+end

data/generators/components/tests/bacon_test_gen.rb

@@ -0,0 +1,21 @@
+module SinatraMore
+  module BaconTestGen
+    BACON_SETUP = <<-TEST
+\nclass Bacon::Context
+  include Rack::Test::Methods
+end
+
+def app
+  CLASS_NAME
+end
+TEST
+
+    def setup_test
+      insert_require 'bacon', :path => "test/test_config.rb"
+      insert_test_suite_setup BACON_SETUP
+    end
+    
+  end
+end
+
+

data/generators/components/tests/riot_test_gen.rb

@@ -0,0 +1,19 @@
+module SinatraMore
+  module RiotTestGen
+    RIOT_SETUP = <<-TEST
+\nclass Riot::Context
+  include Rack::Test::Methods
+  
+  def app
+    CLASS_NAME
+  end
+end
+TEST
+
+    def setup_test
+      insert_require 'riot', :path => "test/test_config.rb"
+      insert_test_suite_setup RIOT_SETUP
+    end
+    
+  end
+end