derail 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Samuel Cochran
+
+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,87 @@
+# Derail
+
+A collection of helpers and libraries which I use in almost every project, and a generator to get started quickly.
+
+Some of this stuff may graduate into gems or get contributed back to other projects.
+
+## Features
+
+* Generators:
+  * `derail:app`: Derails a new rails project, basically doing all the following:
+    * Configure databases:
+      * development: _APPNAME_\_development/development/development
+      * test: _APPNAME_\_test/test/test
+      * production: read from environment (DATABASE/DATABASE\_USERNAME/DATABASE\_PASSWORD).
+    * Configure ActionMailer:
+      * development: default\_url\_options to `_APPNAME_.dev`, [MailCatcher](https://github.com/sj26/mailcatcher) delivery.
+      * test: default\_url\_options to `_APPNAME_.test`.
+    * Makes SASS the default stylesheet syntax (not SCSS) and converts application.css to application.css.sass.
+    * Converts application.js to application.js.coffee.
+    * Installs [RSpec](http://rspec.info/)
+    * Installs [Cucumber](http://cukes.info/)
+    * Installs [RR](https://github.com/btakita/rr)
+    * Installs [Guard](https://github.com/guard/guard) ([ego](https://github.com/guard/guard-ego), [bundler](https://github.com/guard/guard-bundler), [rspec](https://github.com/guard/guard-rspec), [cucumber](https://github.com/guard/guard-cucumber))
+    * Runs `formtastic:install`
+    * Runs `derail:devise`
+    * Removes default `index.html` and `rails.png`
+  * `derail:devise`: Install devise, setup a user, install [remarkable_devise](https://github.com/sj26/remarkable_devise).
+  * `derail:devise:haml`: Installs fully-localizable, HTML5, formtastic Devise HAML templates.
+* Updated scaffold templates:
+  * HTML5, formtastic scaffold HAML templates.
+  * [Responder](https://github.com/rails/rails/tree/3-1-stable/actionpack/lib/action_controller/metal/responder.rb)-based scaffold controller.
+* Helpers:
+  * Activated link helper, adapted from a few places. Documentation coming.
+  * Flashes helper, lists all your flashes in aside elements.
+  * Text helper with *working* truncate\_html using Hpricot.
+* Vendored javascripts:
+  * [modernizr](http://www.modernizr.com/).
+  * [innershiv](http://jdbartlett.com/innershiv/) and [jQuery innershiv](http://tomcoote.co.uk/javascript/ajax-html5-in-ie/).
+  * [jQuery autolink, mailto and highlight helpers](http://kawika.org/jquery/index.php?section=autolink), separated for leanness.
+  * [jQuery.timeago](http://timeago.yarp.com/)
+* Plenty more to come!
+
+## Use
+
+To create a new app, I run:
+
+    rails new APPNAME --skip-test-unit --database=postgresql --template http://sj26.com/derail
+
+For handyness in [zsh](http://zsh.org):
+
+    function derail() { rails new $1 --skip-test-unit --database=postgresql --template http://sj26.com/derail $@[2,-1] }
+
+then
+
+    derail APPNAME
+
+### Vendored javascripts
+
+Add them to your applictation's javascript files using sprockets require directives, a la jQuery:
+
+    //= require jquery_innershiv
+
+## Caveats
+
+* It's Rails 3.1 only, but you should be basing your new projects on the latest and greatest! It'll be stable by the time you release... right?
+* I'm presuming your using [my devise branch](https://github.com/sj26/devise/tree/template-inheritence):
+
+        gem "devise", :git => "git://github.com/sj26/devise.git", :branch => "template-inheritence"
+
+  If not, copy the HAML templates into your project and re-twiddle the footer partial.
+
+## TODO
+
+* Home generator.
+* Admin generator.
+* Admin scaffold generator.
+* Pages generator.
+* (Some) in-app errors handler generator.
+* Page title helper inspired by [page\_title\_helper](https://github.com/lwe/page_title_helper)
+* Vendored WYSIWYG (can't decide which library).
+* Formtastic WYSIWYG field helpers.
+* Tilt-based renderable activerecord fields with filter white/blacklists and stored filter type.
+* More tests.
+
+## License
+
+Copyright (c) 2011 Samuel Cochran, released under the MIT license, see LICENSE.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/helpers/activated_link_helper.rb

@@ -0,0 +1,48 @@
+module ActivatedLinkHelper
+  def activated_link_to *args, &block
+    if block_given?
+      name          = capture(&block)
+      options       = args[0] || {}
+      html_options  = args[1] || {}
+    else
+      name          = args[0]
+      options       = args[1] || {}
+      html_options  = args[2] || {}
+    end
+
+    options = options.clone
+    html_options = html_options.clone
+
+    url = url_for(options)
+    active_link_options = html_options.delete(:active) || {}
+
+    match = request.fullpath.match(/^#{Regexp.escape(url)}(?:\/(.*)$)?/)
+
+    active = if html_options.delete(:exact)
+      match.present? and (match[1].blank? or match[1] == "/")
+    elsif paths = (html_options.delete(:only_paths).presence || html_options.delete(:only_path).presence)
+      match.present? and (match[1].blank? or match[1] == "/") || if paths.is_a? Array
+        paths.include? match[1]
+      elsif paths.is_a? Regexp
+        paths.match(match[1]).present?
+      else
+        paths == match[1]
+      end
+    else
+      request.fullpath.match(/^#{Regexp.escape(url)}(\/|$)/).present?
+    end
+
+    css_class = if active
+      'active'
+    else
+      'inactive'
+    end
+
+    html_options[:class] ||= ''
+    html_options[:class] += " #{css_class}" if !css_class.blank?
+    html_options[:class].strip!
+    html_options.delete(:class) if html_options[:class].blank?
+
+    link_to(name, url, html_options)
+  end
+end

data/app/helpers/flashes_helper.rb

@@ -0,0 +1,9 @@
+module FlashesHelper
+  def flashes
+    safe_join(flash.keys.map do |key|
+      content_tag :aside, :class => ["flash", "flash-#{key.to_s.parameterize}"] do
+        flash[key]
+      end
+    end)
+  end
+end

data/app/helpers/text_helper.rb

@@ -0,0 +1,55 @@
+require "hpricot"
+
+# Adapted from http://henrik.nyh.se/2008/01/rails-truncate-html-helper
+
+module TextHelper
+  # Like the Rails _truncate_ helper but doesn't break HTML tags or entities.
+  def truncate_html(text, options={})
+    return if text.nil?
+
+    length = options.delete(:length) || 30
+    omission = options.delete(:omission).to_s || "..."
+    text = text.to_s
+
+    document = Hpricot(text)
+    omission_length = Hpricot(omission).inner_text.chars.count
+    content_length = document.inner_text.chars.count
+
+    content_length > length ? document.truncate([length - omission_length, 0].max).inner_html + omission : text
+  end
+end
+
+module HpricotTruncator
+  module NodeWithChildren
+    def truncate(length)
+      return self if inner_text.chars.count <= length
+      truncated_node = self.dup
+      truncated_node.children = []
+      each_child do |node|
+        remaining_length = length - truncated_node.inner_text.chars.count
+        break if remaining_length == 0
+        truncated_node.children << node.truncate(remaining_length)
+      end
+      truncated_node
+    end
+  end
+
+  module TextNode
+    def truncate(length)
+      # We're using String#scan because Hpricot doesn't distinguish entities.
+      Hpricot::Text.new(content.scan(/&#?[^\W_]+;|./).first(length).join)
+    end
+  end
+
+  module IgnoredTag
+    def truncate(length)
+      self
+    end
+  end
+end
+
+Hpricot::Doc.send(:include,       HpricotTruncator::NodeWithChildren)
+Hpricot::Elem.send(:include,      HpricotTruncator::NodeWithChildren)
+Hpricot::Text.send(:include,      HpricotTruncator::TextNode)
+Hpricot::BogusETag.send(:include, HpricotTruncator::IgnoredTag)
+Hpricot::Comment.send(:include,   HpricotTruncator::IgnoredTag)

data/derail.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = "derail"
+  s.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  s.platform    = Gem::Platform::RUBY
+  s.summary = "sj26's collection of rails bits and pieces."
+  s.description = <<-END
+    Derail is a collection of helpers and libraries which I use in
+    almost every project, and a generator to get started quickly.
+  END
+
+  s.author = "Samuel Cochran"
+  s.email = "sj26@sj26.com"
+  s.homepage = "https://github.com/sj26/derail"
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = "lib"
+  s.extra_rdoc_files = ["README.md", "LICENSE"]
+
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_dependency "railties", ">= 3.1.rc4"
+  s.add_dependency "formtastic", ">= 2.0.0.rc3"
+end

data/lib/derail.rb

@@ -0,0 +1,15 @@
+require 'derail/core_ext/string'
+
+module Derail
+  VERSION = File.read(File.expand_path("../../VERSION", __FILE__)).strip
+
+  extend ActiveSupport::Autoload
+
+  require 'derail/engine'
+
+  autoload :Generators
+  autoload_under :ActiveRecord do
+    autoload :Unique
+  end
+end
+

data/lib/derail/core_ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  def dedent
+    indent = lines.reject(&:empty?).map { |line| line.index(/\S/) }.compact.min
+    gsub /^ {1,#{indent.to_i}}/, ''
+  end unless method_defined? :dedent
+
+  def redent prefix
+    prefix = " " * prefix if prefix.is_a? Numeric
+    dedent.gsub! /^(?=[ \t]*\S+)/, prefix
+  end unless method_defined? :redent
+end

data/lib/derail/engine.rb

@@ -0,0 +1,3 @@
+class Derail::Engine < Rails::Engine
+  # We must be an engine to vendor assets.
+end

data/lib/derail/generators.rb

@@ -0,0 +1,46 @@
+module Derail::Generators
+  class Base < Rails::Generators::Base
+    source_root File.expand_path '../../templates'
+
+  protected
+
+    def rvm *args
+      options = args.extract_options!
+      say_status :run, "rvm #{args * " "}" # unless options[:verbose] === false
+      system (["rvm"] + args) * " "
+    end
+
+    def rvm_run *args
+      args << args.extract_options!.merge(:verbose => false)
+      rvm "--with-rubies", "default-with-rvmrc", "exec", *args
+    end
+
+    def bundle *args
+      options = args.extract_options!
+      say_status :run, "bundle #{args * " "}" # unless options[:verbose] === false
+      rvm_run "bundle", *args
+    end
+
+    def bundle_run *args
+      args << args.extract_options!.merge(:verbose => false)
+      bundle "exec", *args
+    end
+
+    # Override run to run in our rvm/bundle
+    alias run bundle_run
+
+    # Override generate to run in bundle
+    def generate *args
+      say_status :generate, args * " "
+      bundle_run "rails", "generate", *args
+    end
+
+    def app_name
+      Rails.application.class.parent_name
+    end
+
+    def app_slug
+      app_name.underscore
+    end
+  end
+end

data/lib/generators/derail/app/USAGE

@@ -0,0 +1 @@
+Derail a new rails application.

data/lib/generators/derail/app/app_generator.rb

@@ -0,0 +1,147 @@
+module Derail::Generators
+  class AppGenerator < Base
+    def configure_database
+      # The original is full of noise, ick.
+      remove_file "config/database.yml", :verbose => false
+      create_file "config/database.yml", <<-RUBY.dedent
+        development:
+          adapter: postgresql
+          encoding: unicode
+          pool: 5
+          database: #{app_slug}_development
+          username: development
+          password: development
+
+        test:
+          adapter: postgresql
+          encoding: unicode
+          pool: 5
+          database: #{app_slug}_test
+          username: test
+          password: test
+
+        production:
+          adapter: postgresql
+          encoding: unicode
+          pool: 5
+          database: <%= ENV["DATABASE"] %>
+          username: <%= ENV["DATABASE_USERNAME"] %>
+          password: <%= ENV["DATABASE_PASSWORD"] %>
+      RUBY
+    end
+
+    def configure_action_mailer
+      inject_into_file "config/environments/development.rb", <<-RUBY.redent(2), :after => /config.action_mailer.*?\n/
+
+        # Development URL
+        config.action_mailer.default_url_options = { :host => '#{app_slug}.dev' }
+
+        # Send mail via MailCatcher
+        config.action_mailer.smtp_settings = { :address => 'localhost', :port => 1025 }
+      RUBY
+
+      inject_into_file "config/environments/test.rb", <<-RUBY.redent(2), :after => /config.action_mailer.*?\n/
+
+        # Testing URL
+        config.action_mailer.default_url_options = { :host => '#{app_slug}.test' }
+      RUBY
+    end
+
+    def configure_sass
+      inject_into_file "config/application.rb", <<-RUBY.redent(4), :after => /config\.assets[^\n]*\n/
+
+        # Use SASS by default
+        config.generators.stylesheet_engine = :sass
+      RUBY
+
+      bundle_run "sass-convert", "app/assets/stylesheets/application.css", "app/assets/stylesheets/application.css.sass"
+      remove_file "app/assets/stylesheets/application.css"
+    end
+
+    def configure_coffee
+      system "mv", "app/assets/javascripts/application.js", "app/assets/javascripts/application.js.coffee"
+      gsub_file "app/assets/javascripts/application.js.coffee", %r{^//}, "#"
+    end
+
+    def install_rspec
+      # TODO: Make optional
+      generate "rspec:install"
+    end
+
+    def install_cucumber
+      # TODO: Make optional
+      generate "cucumber:install"
+    end
+
+    def install_rr
+      gsub_file "spec/spec_helper.rb", /[ \t]*# == Mock Framework\n(.*)\n[ \t]*config\.mock_with[ \t]*\S+\n/m, <<-RUBY.redent(2)
+        # == Mock Framework
+        config.mock_with :rr
+      RUBY
+
+      # TODO: Insert RR cucumber support
+    end
+
+    def install_guard
+      # TODO: Make optional
+      say_status :create, "Guardfile"
+      ["ego", "bundler", "rspec", "cucumber"].each do |guard|
+        bundle_run "guard", "init", guard
+      end
+    end
+
+    def generate_formtastic
+      # TODO: Make optional
+      generate "formtastic:install"
+    end
+
+    def generate_layouts
+      # TODO: Layouts
+      # TODO: Make optional
+      #generate "derail:layout"
+    end
+
+    def generate_home
+      # TODO: Home
+      # TODO: Make optional
+      #generate "derail:home"
+    end
+
+    def generate_devise
+      # TODO: Make optional
+      generate "derail:devise"
+    end
+
+    def generate_dashboard
+      # TODO: Dashboard
+      # TODO: Make optional
+      #generate "derail:dashboard"
+    end
+
+    def generate_admin
+      # TODO: Admin
+      # TODO: Make optional
+      #generate "derail:admin"
+    end
+
+    def generate_pages
+      # TODO: Pages
+      # TODO: Make optional
+      #generate "derail:pages"
+    end
+
+    def generate_errors
+      # TODO: Error handling
+      # TODO: Make optional
+      #generate "derail:errors"
+    end
+
+    def remove_index
+      remove_file "public/index.html"
+    end
+
+    def remove_rails_logo
+      remove_file "app/assets/images/rails.png"
+    end
+  end
+end