app_drone 0.8.6 → 0.9.1

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*~

data/README.md

@@ -65,6 +65,24 @@ Dependencies are automatically checked, and a template will not render unless th
 
 *Note that most drones depend on `Bundle`, `Stylesheet` and `Javascript`.*
 
+To make sure a drone's directives are run after another drone's, use `run_after :drone, :another_drone`. Unlike `depends_on`, no dependency checking is done on template render, so you reference paired drones that may or may not exist in the final template. An example:
+
+    class AppDrone::SimpleCov
+      depends_on :bundle
+      pairs_with :rspec
+      run_after :rspec
+      
+      def align
+        bundle.add 'simplecov'
+      end
+      
+      def execute
+        do! :install
+        do! :rspec_integration if pair?(:rspec)
+        # we can be certain that rspec's generated files exist to modify
+      end
+    end
+
 
 ### Active drones
 
@@ -244,66 +262,64 @@ AppDrone is not for everyone. It's highly opinionated about how a Rails app shou
 
 ### Active drones (put 'em to work!)
 
-- [base] Bundle
-- [base] Stylesheet (Sass & Compass)
-- [base] Javascript (Coffescript & jQuery)
-- [base] SlimView
-- [base] Cleanup
-- [views] HighVoltage, by ThoughtBot
-- [views] Flair (drones use this to demonstrate their working functionality)
-- [views] SimpleForm (with optional Country Select and automatic Twitter Bootstrap integration)
-- [auth] Sorcery, for no-frills user authentication
-- [auth] CanCan, for role-based authorization
-- [auth] EasyRoles, to add roles to your User models
-- [model] Migrant, for easier schema management
-- [model] Squeel, improving on ActiveRelation
-- [model] RankedModel, for sorting and ranking objects
-- [ui] Chosen select, by harvestHQ
-- [ui] Bootstrap, by Twitter
-- [ui] Gritter, for jQuery growl-like notifications
-- [ui] Underscore.js utility belt
-- [ux] Ember (the Ember.js library)
-- [dev] LetterOpener, to preview email in the browser instead of sending it
-
+- [base] **Bundle** for managing gems
+- [base] **Stylesheet** (Sass & Compass)
+- [base] **Javascript** (Coffescript & jQuery)
+- [base] **SlimView** (Slim, laid out right)
+- [base] **Cleanup**
+- [base] **HighVoltage** by ThoughtBot
+- [base] **Flair** - drones use this to demonstrate their working functionality
+- [views] **SimpleForm** with optional Country Select and automatic Twitter Bootstrap integration
+- [views] **NestedForm** for managing multiple models in a single form
+- [auth] **Sorcery** for no-frills user authentication
+- [auth] **CanCan** for role-based authorization
+- [auth] **EasyRoles**,to add roles to your User models
+- [model] **Migrant** for easier schema management
+- [model] **Squeel** improving on ActiveRelation
+- [model] **RankedModel** for sorting and ranking objects
+- [ui] **Chosen select** by harvestHQ
+- [ui] **Bootstrap** by Twitter
+- [ui] **Gritter** for jQuery growl-like notifications
+- [ui] **Underscore.js** utility belt
+- [ux] **Ember** (the Ember.js library)
+- [requests] **Responders** from Plataformatec
+- [requests] **HasScope** for mapping filters to controller actions
+- [requests] **WillPaginate** with automatic Bootstrap integration
+- [dev] **LetterOpener** to preview email in the browser instead of sending it\
+- [misc] **Chronic** for natural language date parsing
+- [misc] **Timecop** - time travelling for Ruby
+- [misc] **NiftyGenerators**, a collection of useful Rails generator scripts
+- [production] **NewRelic** app performance monitoring
+- [uploads] **Carrierwave** file uploading plus optional Fog cloud storage
+- [uploads] **Remotipart**, for AJAX file uploads with jQuery
+- [test] **RSpec** for BDD
+- [test] **Factory Girl** test fixtures
+- [test] **SimpleCov** code coverage for Ruby 1.9, with automatic RSpec integration
 
 ### Frozen drones (currently in development)
 
-- [base] Database (currenly rake db:migrate in template will break non-sqlite dbs)
-- [auth] CanCan
-- [auth] Sorcery
+- [base] Database (currently rake db:migrate in template will break non-sqlite dbs)
 - [auth] Devise
-- [auth] EasyRoles
-- [test] RSpec
-- [test] FactoryGirl
 - [test] DatabaseCleaner
 - [test] TimeCop
 - [test] Capybara
 - [test] Shoulda
-- [test?] Chronic
-- [dev] Migrant (+ Pickle support?)
 - [dev] Guard
 - [source-control] Git
-- [model] RankedModel
-- [model] Squeel
-- [requests] Responders
 - [requests] InheritedResources (deprecated)
 - [requests] UserAgent blocking script
-- [dev] Letter opener
-- [ui] Underscore Rails
 - [mailing] SendGrid
 
 ### Future drones (TODO - I'll get there some day!)
 
 - [ui] Stylesheet utils
+- [ui] Calendrical for jQuery
 - [ui] SlimViews: Add browser-specific classes to <html> via useragent + helpers..
 - [ui] Bootstrap: vendor files rather than gem require (is this necessary? seems all variables can be customized in an external sheet as long as it's required before compass_twitter_bootstrap)
 - [ui] jQuery shims
 - [ui] jQuery UI (vendor + theme etc.)
 - [ui] pie.htc for IE
 - [ui] HTML5 shim for IE
-- [uploads] CarrierWave (and optional cloud resizing thingy)
-- [uploads] Fog
-- [uploads] Remotipart
 - [uploads?] RMagick / minimagick
 - [requests] HasScope
 - [requests] will-paginate (+bootstrap-will-paginate)
@@ -311,7 +327,6 @@ AppDrone is not for everyone. It's highly opinionated about how a Rails app shou
 - [dev] Pivotal tracker
 - [dev] RailsErd
 - [production] Airbrake + API Key
-- [production] NewRelic
 - [production] EngineYard for deployment
 - [ux] Backbone integration + Skim
 - [views] Nested Form
@@ -323,8 +338,8 @@ AppDrone is not for everyone. It's highly opinionated about how a Rails app shou
 - [?] Nokogiri
 - [?] Mechanize
 - [?] Money
-- [misc] NiftyGenerators
 - [ui] jQuery.transit
+- [ui] jQuery joyride
 - [ui] Ember Touch (gesture support for Ember: pinch, pan etc.)
 
 

data/lib/app_drone/dependency_chain.rb

@@ -42,7 +42,14 @@ class DependencyChain
 
    private
     def dependency_indices(drones,drone)
-      drone.dependencies.map { |d| drones.index(d) }
+      dependencies = drone.dependencies
+
+      precursors = drone.precursors
+      active_precursors = drones & precursors
+
+      preceding_drones = (dependencies + active_precursors).uniq
+      
+      preceding_drones.map { |d| drones.index(d) }
     end
 
     def last_dependency_index(drones,drone)

data/lib/app_drone/drone.rb

@@ -37,6 +37,10 @@ class Drone
     return @template.hook?(drone_klass)
   end
 
+  def notify!(notice)
+    @template.notify! notice, self
+  end
+
   # Expected implementations
   def align; end
   def execute; end
@@ -95,6 +99,11 @@ class Drone
       (@pairs || []).map(&:to_app_drone_class)
     end
 
+    def run_after(*klass_symbols); @precursors = klass_symbols end
+    def precursors
+      (@precursors || []).map(&:to_app_drone_class)
+    end
+
     def owns_generator_method(m); @generator_method = m end
     def generator_method; @generator_method end
 

data/lib/app_drone/drones/carrierwave/carrierwave.rb

@@ -0,0 +1,20 @@
+module AppDrone
+class Carrierwave < Drone
+  desc "Classy file uploads"
+  category :uploads
+
+  depends_on :bundle
+
+  param :fog, :boolean, info: 'Install Fog for cloud storage'
+
+  def align
+    bundle.add 'carrierwave'
+    bundle.add 'fog' if param(:fog)
+  end
+
+  def execute
+    notify! 'Create "config/initializers/fog.rb" and load your Fog credentials into Carrierwave!' if param(:fog)
+  end
+
+end
+end

data/lib/app_drone/drones/chronic/chronic.rb

@@ -0,0 +1,13 @@
+module AppDrone
+class Chronic < Drone
+  desc "Natural language date parsing"
+  category :misc
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'chronic'
+  end
+
+end
+end

data/lib/app_drone/drones/{easy_roles_45/easy_roles_45.rb~ → easy_rolez/easy_rolez.rb}

@@ -1,5 +1,5 @@
 module AppDrone
-class EasyRoles45 < Drone
+class EasyRolez < Drone
   desc "Add roles to your User models"
   category :auth
  

data/lib/app_drone/drones/factory_girl/factory_girl.rb

@@ -0,0 +1,13 @@
+module AppDrone
+class FactoryGirl < Drone
+  desc "Test fixtures"
+  category :test
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'factory_girl_rails', group: %w(development test)
+  end
+
+end
+end

data/lib/app_drone/drones/has_scope/has_scope.rb

@@ -0,0 +1,13 @@
+module AppDrone
+class HasScope < Drone
+  desc "Filter controller actions with scopes"
+  category :requests
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'has_scope'
+  end
+
+end
+end

data/lib/app_drone/drones/nested_form/nested_form.rb

@@ -0,0 +1,14 @@
+module AppDrone
+class NestedForm < Drone
+  desc "Conveniently manage multiple models in a single form"
+  category :views
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'nested_form'
+    javascript.pipeline 'jquery_nested_form'
+  end
+
+end
+end

data/lib/app_drone/drones/new_relic/new_relic.rb

@@ -0,0 +1,13 @@
+module AppDrone
+class NewRelic < Drone
+  desc "App performance monitoring"
+  category :production
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'newrelic_rpm'
+  end
+
+end
+end

data/lib/app_drone/drones/nifty_generatorz/nifty_config.erb

@@ -0,0 +1 @@
+generate 'nifty:config'

data/lib/app_drone/drones/nifty_generatorz/nifty_generatorz.rb

@@ -0,0 +1,19 @@
+module AppDrone
+class NiftyGeneratorz < Drone
+  desc "A collection of useful Rails generator scripts"
+  category :misc
+
+  depends_on :bundle
+  
+  param :nifty_config, :boolean, info: 'generate a config YAML file and loader'
+
+  def align
+    bundle.add 'nifty-generators', group: :development
+  end
+
+  def execute
+    do! :nifty_config if param(:nifty_config)
+  end
+
+end
+end

data/lib/app_drone/drones/remotipart/remotipart.rb

@@ -0,0 +1,14 @@
+module AppDrone
+class Remotipart < Drone
+  desc "AJAX file uploads with jQuery"
+  category :uploads
+
+  depends_on :bundle, :stylesheet, :javascript
+
+  def align
+    bundle.add 'remotipart'
+    javascript.pipeline 'jquery.remotipart'
+  end
+
+end
+end

data/lib/app_drone/drones/responderz/install.erb

@@ -0,0 +1 @@
+generate 'responders:install'

data/lib/app_drone/drones/responderz/responderz.rb

@@ -0,0 +1,17 @@
+module AppDrone
+class Responderz < Drone
+  desc "DRY up your controllers"
+  category :requests
+
+  depends_on :bundle
+  
+  def align
+    bundle.add 'responders'
+  end
+
+  def execute
+    do! :install
+  end
+
+end
+end

data/lib/app_drone/drones/rspec/install.erb

@@ -0,0 +1 @@
+generate "rspec:install"

data/lib/app_drone/drones/rspec/rspec.rb

@@ -0,0 +1,17 @@
+module AppDrone
+class Rspec < Drone
+  desc "Behaviour Driven Development"
+  category :test
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'rspec-rails', group: %w(development test)
+  end
+
+  def execute
+    do! :install
+  end
+
+end
+end

data/lib/app_drone/drones/simple_cov/install.erb

@@ -0,0 +1,5 @@
+@generator.create_file '.simplecov', <<-SIMPLECOV
+SimpleCov.start 'rails' do
+  # any custom configs like groups and filters can be here at a central place
+end
+SIMPLECOV

data/lib/app_drone/drones/simple_cov/rspec_integration.erb

@@ -0,0 +1 @@
+@generator.prepend_file 'spec/spec_helper.rb', "require 'simplecov'\n"

data/lib/app_drone/drones/simple_cov/simple_cov.rb

@@ -0,0 +1,20 @@
+module AppDrone
+class SimpleCov < Drone
+  desc "Code coverage for Ruby 1.9, with RSpec integration"
+  category :test
+
+  depends_on :bundle
+  pairs_with :rspec
+  run_after :rspec
+
+  def align
+    bundle.add 'simplecov', require: false, group: :test
+  end
+
+  def execute
+    do! :install
+    do! :rspec_integration if pair?(:rspec)
+  end
+
+end
+end

data/lib/app_drone/drones/timecop/timecop.rb

@@ -0,0 +1,13 @@
+module AppDrone
+class Timecop < Drone
+  desc "Time-travelling, Ruby style"
+  category :misc
+
+  depends_on :bundle
+
+  def align
+    bundle.add 'timecop'
+  end
+
+end
+end

data/lib/app_drone/drones/will_paginate/will_paginate.rb

@@ -0,0 +1,15 @@
+module AppDrone
+class WillPaginate < Drone
+  desc "Simple pagination library, with automatic Bootstrap integration"
+  category :requests
+
+  depends_on :bundle
+  pairs_with :bootstrap
+
+  def align
+    bundle.add 'will_paginate'
+    bundle.add 'bootstrap-will_paginate' if pair?(:bootstrap)
+  end
+
+end
+end

data/lib/app_drone/template.erb

@@ -25,9 +25,23 @@ class AppBuilder < Rails::AppBuilder
 <% end %>
 
   def leftovers
+
     <%= leftover_directives.join("\n") %>
+
+    # This should be removed when the database drone is installed
+    rake 'db:create'
     rake 'db:migrate'
+
+
+    # Drone Notices
+    <% drone_notices.each do |drone, notices| %>
+      <% notices.each do |notice| %>
+        say "[<%= drone.human_name %>] <%= notice %>", :red
+      <% end %>
+    <% end %>
+
     say "She's all yours, sparky!\n\n", :green
+
   end
 
 end

data/lib/app_drone/template.rb

@@ -1,6 +1,6 @@
 module AppDrone
 class Template
-  def initialize; @drones = {}; @directives = {} end
+  def initialize; @drones = {}; @directives = {}; @drone_notices = {} end
 
   def add(ref,*params)
     klass = ref.is_a?(Class)? ref : ('AppDrone::' + ref.to_s.classify).constantize
@@ -9,6 +9,7 @@ class Template
 
   def drone_objects; @drones.values end
   def drone_classes; @drones.keys end
+  def drone_notices; @drone_notices end
   def hook?(klass); !@drones[klass].nil? end
   def hook(klass)
     raise "No such drone: #{klass}" unless i_klass = @drones[klass]
@@ -18,16 +19,24 @@ class Template
   def leftover_directives; @directives[:leftovers] || [] end
   def overridden_generator_methods; @directives.keys - [:leftovers] end
 
-  def do!(d,drone);
+  def do!(d,drone)
     generator_method = drone.class.generator_method || :leftovers
     (@directives[generator_method] ||= []) << d
   end
+
+  def notify!(notice,drone)
+    (@drone_notices[drone.class] ||= []) << notice.gsub("'","\\'").gsub('"','\\"') # escape quotes
+  end
   
   def render!
     return if @rendered
     DependencyChain.check_dependencies!(drone_classes)
-    drone_objects.map(&:align)
-    drone_objects.map(&:execute)
+
+    ordered_chain = AppDrone::DependencyChain.sort(drone_classes)
+
+    ordered_chain.each { |klass| hook(klass).align }
+    ordered_chain.each { |klass| hook(klass).execute }
+
     @rendered = true
   end
 

data/lib/app_drone/version.rb

@@ -1,3 +1,3 @@
 module AppDrone
-  VERSION = "0.8.6"
+  VERSION = "0.9.1"
 end

data/out.rb

@@ -27,7 +27,8 @@ class AppBuilder < Rails::AppBuilder
 @generator.gem 'compass-rails'
 @generator.gem 'slim-rails'
 @generator.gem 'high_voltage'
-@generator.gem 'letter_opener', :group=>:development
+@generator.gem 'rspec-rails', :group=>["development", "test"]
+@generator.gem 'simplecov', :require=>false, :group=>:test
 
 run_bundle
 @generator.options = @generator.options.dup
@@ -38,6 +39,7 @@ run_bundle
 
 
   def leftovers
+
     # --- 
 # AppDrone::Javascript
 # ---
@@ -113,12 +115,35 @@ FLAIR
 @generator.remove_file File.join %w(README.rdoc)
 
 # --- 
-# AppDrone::LetterOpener
+# AppDrone::Rspec
 # ---
-@generator.inject_into_file 'config/environments/development.rb', "\n\n  config.action_mailer.delivery_method = :letter_opener", before: "\nend"
+generate "rspec:install"
 
+# --- 
+# AppDrone::SimpleCov
+# ---
+@generator.create_file '.simplecov', <<-SIMPLECOV
+SimpleCov.start 'rails' do
+  # any custom configs like groups and filters can be here at a central place
+end
+SIMPLECOV
+
+# --- 
+# AppDrone::SimpleCov
+# ---
+@generator.prepend_file 'spec/spec_helper.rb', "require 'simplecov'\n"
+
+
+    # This should be removed when the database drone is installed
+    rake 'db:create'
     rake 'db:migrate'
+
+
+    # Drone Notices
+    
+
     say "She's all yours, sparky!\n\n", :green
+
   end
 
 end

data/scraps/App admin

@@ -0,0 +1,7 @@
+APP:
+
+- add data-related="whoisdandavey(:description)" to share link
+- add platform 45 logo to footer
+- choose, configure, compile: add 1, 2, 3 somewhere
+
+- choose_one dropdown in ember app

data/scraps/TODO

@@ -0,0 +1,32 @@
+** When finished: if Flair, say: 'Boot your app and visit /pages/flair to see a functionality demo'
+** When finished: general stats/instructions?
+** Will-paginate bootstrap flair?
+
+- [uploads] Cloudinary
+- [misc] Spork
+- [test] DatabaseCleaner
+- [test] Capybara
+- [test] Shoulda
+
+- [ui] jQuery UI (vendor + theme etc.)
+- [ui_shim] HTML5 placeholder shim - https://github.com/parndt/jquery-html5-placeholder-shim
+- [ui_shim] HTML5 shim/shiv for IE -- http://ejohn.org/blog/html5-shiv/  http://code.google.com/p/html5shiv/ (or use modernizr?)
+- [ui_shim] pie.htc for IE
+- [ui_shim] jQuery shims
+
+- [mailing] SendGrid https://github.com/stephenb/sendgrid
+- [mailing] Postmark https://github.com/wildbit/postmark-rails
+
+- [?] DelayedJob
+- [search] Sphinx
+- put has_scope in [search]?
+
+LATER:
+- [?] Resque
+- [?] Redis
+- [dev] rails-best-practices (and the other output gem for debugging)
+- [dev] RailsErd
+- [production] Airbrake + API Key
+- [?] Launchy
+- [base] Database: rake [db:create, db:migrate] at very end of generator, options? postgres etc. (will need a dropdown option in the app for this)
+- [auth] Devise

data/scraps/blank drone

@@ -0,0 +1,15 @@
+module AppDrone
+class < Drone
+  desc ""
+  category :
+
+  depends_on :bundle
+
+  def align
+  end
+
+  def execute
+  end
+
+end
+end

data/test/test_app_drone.rb

@@ -24,7 +24,8 @@ class AppDroneTest < Test::Unit::TestCase
     template = Template.new
     add_defaults_to_template(template)
 
-    template.add :letter_opener
+    template.add :simple_cov
+    template.add :rspec
 
     template.render_to_file
   end
@@ -64,6 +65,12 @@ class AppDroneTest < Test::Unit::TestCase
     assert_equal DependencyChain.sort(chain), sorted_chain
   end
 
+  def test_dependency_chain_run_after
+    chain = [AppDrone::SimpleCov, AppDrone::Rspec, AppDrone::Bundle]
+    sorted_chain = [AppDrone::Bundle, AppDrone::Rspec, AppDrone::SimpleCov]
+    assert_equal DependencyChain.sort(chain), sorted_chain
+  end
+
  private
   def add_defaults_to_template(template)
     defaults = [:bundle, :javascript, :stylesheet, :slim_view, :high_voltage, :flair, :cleanup]