darkhelmet-sinatra_more 0.3.33

data/ROADMAP

@@ -0,0 +1,88 @@
+Working with lipsiadmin:
+
+1) Proof of concept for the Sinatra Framework
+2) Adding in additional features to the current sinatra_more (more generators, helpers, etc)
+3) Split plugin up into individual gems for better organization
+4) Porting of lipsiadmin over to sinatra
+5) First produciton application
+6) Build Sinatra Framework Website
+
+Use Bundler for managing dependencies: 
+ * http://github.com/wycats/bundler
+ * http://www.engineyard.com/blog/2009/using-the-rubygems-bundler-for-your-app/
+
+Framework structure:
+
+ * sinatra-core    (the existing sinatra framework)          <= from Sinatra
+ * sinatra-gen     (easy generation of and for sinatra apps) <= from Generator
+ * sinatra-helpers (adds the markup and renderer helpers)    <= from MarkupPlugin, RenderPlugin
+ * sinatra-mailer  (mail handling for sinatra applications)  <= from MailerPlugin
+ * sinatra-routing (sinatra route mapping system)            <= from RoutingPlugin
+ * sinatra-cache   (page and fragment caching support)       
+ * sinatra-admin   (admin management dashboard for content)  <= from Lipsiadmin (ported)
+ 
+Additional wish-list features (integrate existing plugin) (?)
+
+ * Reloading Support     - http://github.com/alexch/rerun
+ * Internationalization  - http://r18n.rubyforge.org/#sinatra
+ * Asynchronous Commands - http://github.com/deadprogrammer/spork
+ * Capistrano Deployment - http://github.com/nakajima/capinatra (?)
+ * Job Queue             - http://github.com/adamcooke/resque (or http://github.com/bmizerany/sinatra-dj)       
+
+'sinatra-cache' Caching concept:
+
+    # in models
+    class Person
+      def something_expensive
+        Sinatra::Cache.get('key')
+        Sinatra::Cache.set('key', value)
+        Sinatra::Cache.fetch('key') { 'value' }
+      end
+    end
+
+    # fragment in route
+    get '/cache2' do
+      cache 'cache2', :expiry => 10 do
+        'Hello Cache2'
+      end
+    end
+
+    # fragment in view
+    # /views/test.haml
+    - cache 'test', :expiry => 10 do
+      = partial 'item', :collection => @items
+
+    # page
+    get '/example', :cache => true do
+      haml_template 'accounts/index'
+    end
+
+'sinatra-routing' Routing Concept:
+
+    namespace :admin do
+      get :show do
+        ...
+      end
+    end
+ 
+    get :accounts do
+     ...
+    end
+ 
+    map(:admin, :show).to("/my-admin/:id/show")
+    map(:accounts).to("/show-me-my/accounts")
+ 
+    # or
+ 
+    map :admin do |namespace|
+     namespace.map(:show).to("/my-admin/:id/show")
+    end
+ 
+    # and to use
+    link_to "Show Admin", url_for(:admin, :show, :id => 5)
+    link_to "Accounts",   url_for(:accounts)
+
+'commands' Concept: (console (?) http://github.com/sickill/racksh)
+
+    $ sinatra_more console # loads console for sinatra
+    $ sinatra_more test    # runs all test using specified testing framework

data/Rakefile

@@ -0,0 +1,63 @@
+# $ rake version:bump:patch release
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra_more"
+    gem.summary = "Expands sinatra to allow for complex applications"
+    gem.description = "Expands sinatra with standard helpers and tools to allow for complex applications"
+    gem.email = "nesquena@gmail.com"
+    gem.homepage = "http://github.com/nesquena/sinatra_more"
+    gem.authors = ["Nathan Esquenazi"]
+    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_runtime_dependency     "bundler"
+    gem.add_development_dependency "haml",          ">= 2.2.14"
+    gem.add_development_dependency "shoulda",       ">= 2.10.2"
+    gem.add_development_dependency "mocha",         ">= 0.9.7"
+    gem.add_development_dependency "rack-test",     ">= 0.5.0"
+    gem.add_development_dependency "webrat",        ">= 0.5.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sinatra_more #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,60 @@
+= RESOURCES
+
+- Check out the following sinatra extensions:
+  * http://github.com/wbzyl/sinatra-static-assets
+  * http://github.com/giraffesoft/classy_resources
+  * http://github.com/nakajima/capinatra
+  * http://github.com/deadprogrammer/spork
+  * http://github.com/gioext/sinatra-memcache
+  * http://github.com/kematzy/sinatra-cache
+  * http://r18n.rubyforge.org/#sinatra
+  * http://github.com/alexch/rerun (reloading)
+  * http://github.com/monkrb/glue/blob/master/lib/monk/glue/reloader.rb
+
+= UNFINISHED
+
+== Generator
+
+  * Add support for model, routes, migration generator types based on components
+
+== MarkupPlugin
+
+  * Add support for mustache classes / views for forms, markup
+  * Add support for form.fields_for (one-to-one, nested and many associations like in rails)
+  * Add support for check_box_group, radio_button_group which create a set of checkboxes or radio buttons
+  
+== RenderPlugin
+  
+ * Add support for mustache template rendering
+
+== WardenPlugin
+
+  * Become total warden solution (basically just require warden gem installed, do everything) (?)
+  * Look into removing overlapping methods and simply leveraging sinatra_warden
+  * Take advantage of shared strategies: http://github.com/hassox/warden_strategies/tree/master/lib/
+  
+== RoutingPlugin
+
+= COMPLETED
+
+* Add support for multiple applications being mounted into routing system
+* Add support for RoutingPlugin for easy to use named alias routes for urls
+* Add support for bundler (http://github.com/wycats/bundler) to make setting up a generated app easy
+* Add support for button tag method, mail_to helper
+* Add support for simple fields_for tag helper
+* Add content_for / yield tags similar to rails
+* Created application generator using thor
+* Add support for a MailerPlugin which will make sending emails a breeze (http://github.com/hiroshi/pony)
+* Add support for missing formbuilder fields (select, and standard_form_builder methods i.e check_box_group)
+* Add support for missing formhelpers/fields (radio_button_tag, select_tag)
+* Add support for select_tag :multiple => true
+* Add support for forms with method => put, delete using hidden field
+* Remove dependency on activesupport! and enumerate dependencies in rakefile (as much as possible, need inflectors)
+* Pull from sinatra-helpers and make erb templates work (and credit keldredd)
+  * http://github.com/kelredd/sinatra-helpers/tree/master/lib/sinatra_helpers/erb/
+* fix content_block_tag to eliminate need for concat option
+* image_tag should start in images_path (or /images)
+* I have got to add tests, basically create dummy sinatra applications and use Webrat
+* Partials with counter (and add to tests)
+  * http://github.com/sbfaulkner/sinatra-helpers/blob/master/lib/sinatra-helpers/haml/partials.rb
+  * http://github.com/kelredd/sinatra-helpers/blob/master/lib/sinatra_helpers/erb/partials.rb

data/VERSION

@@ -0,0 +1 @@
+0.3.33

data/bin/sinatra_gen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+%w[rubygems activesupport thor].each { |gem| require gem }
+require File.dirname(__FILE__) + "/../generators/skeleton_generator"
+arguments = ARGV.any? ? ARGV : ['-h']
+Sinatra::SkeletonGenerator.start(arguments)

data/generators/base_app/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+log/**/*
+tmp/**/*
+vendor/gems/gems
+vendor/gems/specifications
+vendor/gems/doc
+vendor/gems/environment.rb

data/generators/base_app/Gemfile

@@ -0,0 +1,13 @@
+clear_sources
+source 'http://gemcutter.org'
+# Base requirements
+gem 'sinatra'
+gem 'sinatra_more'
+gem 'rack-flash'
+gem 'warden'
+gem 'bcrypt-ruby', :require_as => 'bcrypt'
+
+# Component requirements
+
+# Testing requirements
+gem 'rack-test', :require_as => 'rack/test', :only => :testing

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/config.ru.tt

@@ -0,0 +1,10 @@
+RACK_ENV = ENV["RACK_ENV"] ||= "development" unless defined? RACK_ENV
+
+require File.dirname(__FILE__) + '/config/boot.rb'
+
+FileUtils.mkdir_p 'log' unless File.exists?('log')
+log = File.new("log/sinatra.log", "a")
+$stdout.reopen(log)
+$stderr.reopen(log)
+
+run <%= @class_name %>

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

@@ -0,0 +1,42 @@
+# This file is merely for beginning the boot process, check dependencies.rb for more information
+require 'rubygems'
+require 'sinatra/base'
+
+RACK_ENV = ENV["RACK_ENV"] ||= "development" unless defined? RACK_ENV
+ROOT_DIR = File.dirname(__FILE__) + '/../' unless defined? ROOT_DIR
+
+# Helper method for file references.
+# 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'
+  set :environment, RACK_ENV.to_sym if defined?(RACK_ENV)
+
+  # Attempts to require all dependencies with bundler, if this fails, bundle and then try again
+  def self.bundler_require_dependencies(environment=nil)
+    require 'bundler'
+    require File.expand_path(File.join(File.dirname(__FILE__), '/../vendor', 'gems', 'environment'))
+    Bundler.require_env(environment)
+  rescue LoadError => e
+    puts "Bundler must be run to resolve dependencies!"
+    system("cd #{ROOT_DIR}; gem bundle")
+    puts "Retrying with dependencies resolved..."
+    retry
+  end
+
+  # Dependencies contains all required gems and core configuration
+  require File.dirname(__FILE__) + '/dependencies.rb'
+end

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

@@ -0,0 +1,41 @@
+# Dependencies contains all required gems, helpers and core configuration
+
+def app(&block)
+  <%= @class_name %>.class_eval(&block)
+end
+
+class <%= @class_name %> < Sinatra::Application
+  bundler_require_dependencies
+  
+  # Required middleware
+  use Rack::Session::Cookie
+  use Rack::Flash
+  
+  # Includes all necessary sinatra_more helpers
+  register Sinatra::MarkupPlugin
+  register Sinatra::RenderPlugin
+  register Sinatra::MailerPlugin
+  register Sinatra::RoutingPlugin
+
+  # 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').camelize
+    register "#{file_class}Initializer".constantize
+  end
+  
+  # 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", "app/mailers/*.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 } }
+  
+  # Require Warden plugin below to allow User to be loaded
+  register Sinatra::WardenPlugin
+    
+  # Required helpers
+  helpers ViewHelpers
+end

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

@@ -0,0 +1,5 @@
+RACK_ENV = 'test' unless defined?(RACK_ENV)
+require File.dirname(__FILE__) + "/../config/boot"
+Bundler.require_env(:testing)
+
+# Test configuration

data/generators/components/component_actions.rb

@@ -0,0 +1,48 @@
+module Sinatra
+  module ComponentActions
+    # Adds all the specified gems into the Gemfile for bundler
+    # require_dependencies 'activerecord'
+    # require_dependencies 'mocha', 'bacon', :env => :testing
+    def require_dependencies(*gem_names)
+      options = gem_names.extract_options!
+      gem_names.reverse.each { |lib| insert_into_gemfile(lib, options) }
+    end
+
+    # Inserts a required gem into the Gemfile to add the bundler dependency
+    # insert_into_gemfile(name)
+    # insert_into_gemfile(name, :env => :testing)
+    def insert_into_gemfile(name, options={})
+      after_pattern = "# Component requirements\n"
+      after_pattern = "# #{options[:env].to_s.capitalize} requirements\n" if environment = options[:env]
+      include_text = "gem '#{name}'" 
+      include_text << ", :require_as => #{options[:require_as].inspect}" if options[:require_as]
+      include_text << ", :only => #{environment.inspect}" if environment
+      include_text << "\n"
+      options.merge!(:content => include_text, :after => after_pattern)
+      inject_into_file('Gemfile', options[:content], :after => options[:after])
+    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 => /Test configuration\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
+
+    # Returns space characters of given count
+    # indent_spaces(2)
+    def indent_spaces(count)
+      ' ' * count
+    end
+  end
+end