app_drone 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_drone.gemspec
+gemspec

data/Gemfile~

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_drone.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Davey
+
+MIT License
+
+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,205 @@
+# AppDrone
+
+**Avoid the mundane.**
+
+## Overview
+
+AppDrone aims to take the bore out of setting up a Rails app just the way you like it. It's a code library that builds generator code that builds your Rails app code - R A I L S C E P T I O N!
+
+*If you're super lazy, a shiny UI for choosing and configuring drones is coming soon! Right now, it's CLI only :P*
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'app_drone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install app_drone
+
+
+## Usage
+
+### Create a new template
+    
+    require 'app_drone'
+    t = AppDrone::Template.new
+
+### Add drones
+
+    t.add AppDrone::Bundle
+    t.add AppDrone::StyleSheet
+
+Parameters can be used to modify drone behavior:
+
+    t.add AppDrone::Bootstrap, vendor: true
+    
+To list parameters for a specific drone:
+
+    AppDrone::Bootstrap.params
+    # => #<struct Struct::Param name=:vendor, type=:boolean, options=[{:info=>"download a local copy into the repo"}]>
+    # => #<struct Struct::Param name=:responsive, type=:boolean, options=[{:info=>"include responsive grid"}]>
+
+For readability, you can use the symbol shorthand instead of full class name:
+
+    t.add :factory_girl  # adds AppDrone::FactoryGirl
+
+
+### Render template
+
+Once you've loaded and configured your drones, the template can be rendered to screen or file:
+
+    t.render_to_file
+    # => out.rb
+
+Dependencies are automatically checked, and a template will not render unless the drone requirements are all satisfied.
+
+    AppDrone::Bootstrap.dependencies
+    # => [AppDrone::Bundle, AppDrone::Stylesheet, AppDrone::Javascript]
+
+*Note that most drones depend on `Bundle`, `Stylesheet` and `Javascript`.*
+
+
+### Active drones
+
+To list all available drones:
+
+    Drone.drones
+    # => [:stylesheet, :javascript, :slim_view, :cleanup, :bundle]
+
+*Note: these are the underscored versions, not the class names.*
+
+
+## Underneath the hood
+
+Drones are simple classes that implement `align` and `execute` methods. When a template is rendered, `align` is called on each included drone in turn (to set up inter-dependencies), and then `execute` outputs drone code for the generator file.
+
+Each drone lives in it's own folder in `lib/app_drone/drones`, and can include `.erb` templates that are rendered into the main generator template by calling `do! :template_name`. Usually, this would happen in the `execute` function.
+
+Optionally, a `setup` method can be defined to set up variables etc. when a drone instance is created.
+
+
+### Describing a drone
+
+You can use `desc` in the class declaration to explain what the drone does (mostly for shiny UI purposes)
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      desc 'Kills all humans.'
+    end
+
+
+### Drone dependencies
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      depends_on DeathRay, YourMom
+    end
+
+    AppDrone::MyDrone.dependencies
+    # => [AppDrone::DeathRay, AppDrone::YourMom]
+
+### Drone behavior parameters
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      param :lazer_color, :string, rainbow: ['all','teh','colors!']
+    end
+    
+    AppDrone::MyDrone.params
+    # => [#<struct Struct::Param name=:lazer_color, type=:string, options=[{:rainbow=>["all","teh","colors!"]}]>]
+    
+    t = AppDrone::Template.new
+    t.add :my_drone, lazer_color: 'teh'
+
+
+### Drone communication
+
+Drones can talk to eachother via a proxy on the template they are included in, using the class name as a reference:
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      def align
+        (self >> Bundle).add 'my_gem'
+        (self >> Stylesheet).add_import 'shiny_sheet'
+      end
+    end
+
+*Note that the class instance of the parent template is messaged, not the static class.*
+
+For convenience, `method_missing` is used to allow you to use the underscore'd name of a class to talk to it's template instance directly:
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      def align
+        bundle.add 'my_gem'
+        stylesheet.add_import 'shiny_sheet'
+      end
+    end
+
+
+**Take a look at existing drones for more info!**
+
+
+### An important reminder
+
+AppDrone is not for everyone. It's highly opinionated about how a Rails app should be laid out, but is the fruit of tons of research into best practices and maintainability. AppDrone leans especially heavily on Sass, Compass, Coffeescript and Slim. Buyer beware.
+
+
+
+## Drones
+
+### Active drones (put 'em to work!)
+
+- Bundle
+- Stylesheet
+- Javascript
+- SlimView
+- Cleanup
+ 
+
+### Frozen drones (currently in development)
+
+- Bootstrap
+- Chosen
+- Cleanup
+- FactoryGirl
+- Git
+- Guard
+- RankedModel
+- RSpec
+- SimpleForm
+
+
+### Future drones (TODO - I'll get there some day!)
+
+- SlimViews: Add browser-specific classes to <html>
+- UserAgent blocking script
+- Responders
+- HasScope
+- Pagination
+- CarrierWave (and optional cloud resizing thingy)
+- Airbrake + API Key
+- rails-best-practices (and the other output gem for debugging)
+- NewRelic
+- EngineYard for deployment
+- jQuery shims
+- Backbone integration + Skim
+- Ember.js integration
+- Pivotal tracker
+- pie.htc for IE
+- HTML5 shim for IE
+
+
+## Contributing
+
+I'd love it if you could get involved! Feel free to suggest improvements, drones you'd like developed, or help me get test coverage up to scratch :)
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+=======

data/README.md~

@@ -0,0 +1,205 @@
+# AppDrone
+
+**Avoid the mundane.**
+
+## Overview
+
+AppDrone aims to take the bore out of setting up a Rails app just the way you like it. It's a code library that builds generator code that builds your Rails app code - R A I L S C E P T I O N!
+
+*If you're super lazy, a shiny UI for choosing and configuring drones is coming soon! Right now, it's CLI only :P*
+
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'app_drone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install app_drone
+
+
+## Usage
+
+### Create a new template
+    
+    require 'app_drone'
+    t = AppDrone::Template.new
+
+### Add drones
+
+    t.add AppDrone::Bundle
+    t.add AppDrone::StyleSheet
+
+Parameters can be used to modify drone behavior:
+
+    t.add AppDrone::Bootstrap, vendor: true
+    
+To list parameters for a specific drone:
+
+    AppDrone::Bootstrap.params
+    # => #<struct Struct::Param name=:vendor, type=:boolean, options=[{:info=>"download a local copy into the repo"}]>
+    # => #<struct Struct::Param name=:responsive, type=:boolean, options=[{:info=>"include responsive grid"}]>
+
+For readability, you can use the symbol shorthand instead of full class name:
+
+    t.add :factory_girl  # adds AppDrone::FactoryGirl
+
+
+### Render template
+
+Once you've loaded and configured your drones, the template can be rendered to screen or file:
+
+    t.render_to_file
+    # => out.rb
+
+Dependencies are automatically checked, and a template will not render unless the drone requirements are all satisfied.
+
+    AppDrone::Bootstrap.dependencies
+    # => [AppDrone::Bundle, AppDrone::Stylesheet, AppDrone::Javascript]
+
+*Note that most drones depend on `Bundle`, `Stylesheet` and `Javascript`.*
+
+
+### Active drones
+
+To list all available drones:
+
+    Drone.drones
+    # => [:stylesheet, :javascript, :slim_view, :cleanup, :bundle]
+
+*Note: these are the underscored versions, not the class names.*
+
+
+## Underneath the hood
+
+Drones are simple classes that implement `align` and `execute` methods. When a template is rendered, `align` is called on each included drone in turn (to set up inter-dependencies), and then `execute` outputs drone code for the generator file.
+
+Each drone lives in it's own folder in `lib/app_drone/drones`, and can include `.erb` templates that are rendered into the main generator template by calling `do! :template_name`. Usually, this would happen in the `execute` function.
+
+Optionally, a `setup` method can be defined to set up variables etc. when a drone instance is created.
+
+
+### Describing a drone
+
+You can use `desc` in the class declaration to explain what the drone does (mostly for shiny UI purposes)
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      desc 'Kills all humans.'
+    end
+
+
+### Drone dependencies
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      depends_on DeathRay, YourMom
+    end
+
+    AppDrone::MyDrone.dependencies
+    # => [AppDrone::DeathRay, AppDrone::YourMom]
+
+### Drone behavior parameters
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      param :lazer_color, :string, rainbow: ['all','teh','colors!']
+    end
+    
+    AppDrone::MyDrone.params
+    # => [#<struct Struct::Param name=:lazer_color, type=:string, options=[{:rainbow=>["all","teh","colors!"]}]>]
+    
+    t = AppDrone::Template.new
+    t.add :my_drone, lazer_color: 'teh'
+
+
+### Drone communication
+
+Drones can talk to eachother via a proxy on the template they are included in, using the class name as a reference:
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      def align
+        (self >> Bundle).add 'my_gem'
+        (self >> Stylesheet).add_import 'shiny_sheet'
+      end
+    end
+
+*Note that the class instance of the parent template is messaged, not the static class.*
+
+For convenience, `method_missing` is used to allow you to use the underscore'd name of a class to talk to it's template instance directly:
+
+    class AppDrone::MyDrone < AppDrone::Drone
+      def align
+        bundle.add 'my_gem'
+        stylesheet.add_import 'shiny_sheet'
+      end
+    end
+
+
+**Take a look at existing drones for more info!**
+
+
+### An important reminder
+
+AppDrone is not for everyone. It's highly opinionated about how a Rails app should be laid out, but is the fruit of tons of research into best practices and maintainability. AppDrone leans especially heavily on Sass, Compass, Coffeescript and Slim. Buyer beware.
+
+
+
+## Drones
+
+### Active drones (put 'em to work!)
+
+- Bundle
+- Stylesheet
+- Javascript
+- SlimView
+- Cleanup
+ 
+
+### Frozen drones (currently in development)
+
+- Bootstrap
+- Chosen
+- Cleanup
+- FactoryGirl
+- Git
+- Guard
+- RankedModel
+- RSpec
+- SimpleForm
+
+
+### Future drones (TODO - I'll get there some day!)
+
+- SlimViews: Add browser-specific classes to <html>
+- UserAgent blocking script
+- Responders
+- HasScope
+- Pagination
+- CarrierWave (and optional cloud resizing thingy)
+- Airbrake + API Key
+- rails-best-practices (and the other output gem for debugging)
+- NewRelic
+- EngineYard for deployment
+- jQuery shims
+- Backbone integration + Skim
+- Ember.js integration
+- Pivotal tracker
+- pie.htc for IE
+- HTML5 shim for IE
+
+
+## Contributing
+
+I'd love it if you could get involved! Feel free to suggest improvements, drones you'd like developed, or help me get test coverage up to scratch :)
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+=======

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/Rakefile~

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/TODO~

@@ -0,0 +1,7 @@
+1. Replace (self >> Drone).method syntax within drones (use method missing)
+e.g. gems.add('x') -> method_missing('gems') -> (self >> gems.classify.constantize).send
+
+2. Drone dependencies
+e.g. depends Stylesheets, Gems
+- template complains if render is called and dependencies are not met
+

data/app_drone.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/app_drone/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Daniel Davey']
+  gem.email         = ['whoisdanieldavey@gmail.com']
+  gem.description   = %q{Give your Rails apps a kickstart}
+  gem.summary       = %q{Generates Rails templates to help start your app on good footing}
+  gem.homepage      = 'https://github.com/jeriko/app_drone'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'app_drone'
+  gem.require_paths = ['lib']
+  gem.version       = AppDrone::VERSION
+
+  gem.add_dependency('activesupport', '>= 3.2.0')
+
+end

data/app_drone.gemspec~

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/app_drone/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Daniel Davey']
+  gem.email         = ['whoisdanieldavey@gmail.com']
+  gem.description   = %q{Give your rails apps a kickstart}
+  gem.summary       = %q{Generates rails templates to help start your app on good footing}
+  gem.homepage      = 'https://github.com/jeriko/app_drone'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'app_drone'
+  gem.require_paths = ['lib']
+  gem.version       = AppDrone::VERSION
+
+  gem.add_dependency('activesupport', '>= 3.2.0')
+
+end

data/lib/app_drone/drone.rb

@@ -0,0 +1,81 @@
+module AppDrone
+
+Param = Struct.new('Param',:name,:type,:options)
+
+class Drone
+  # align: set up variables, pass off to other scripts
+  # execute: actual install process
+
+  # New
+  def initialize(template,*params)
+    @template = template
+    @params = params.first # weird.. no idea why
+    setup
+  end
+
+  # DSL
+  def ^; @template end
+  def >>(klass); @template.hook(klass); end
+
+  def method_missing(meth, *args, &block)
+    if Drone.drones.include?(meth)
+      klass = ('AppDrone::' + meth.to_s.classify).constantize
+      return (self >> klass)
+    else
+      super
+    end
+  end
+
+  # Expected implementations
+  def align; end
+  def execute; end
+
+  # Optional implementations
+  def setup; end
+
+  def render(partial)
+    class_name = self.class.to_s.split('::').last.underscore
+    template_path = "/drones/#{class_name}/#{partial}.erb"
+    full_path = File.dirname(__FILE__) + template_path
+    snippet = ERB.new File.read(full_path)
+    output = snippet.result(binding)
+    output = "# --- \n# #{self.class.to_s}\n# ---\n" + output if true
+    return output
+  end
+
+  def do!(partial)
+    @template.do! render(partial), self
+  end
+
+  # DSL: Integration-specific options
+  attr_accessor :params
+  class << self  
+    def param(name, type, *options)
+      (@params ||= []) << Param.new(name, type, options)
+    end
+    def params
+      @params
+    end
+
+    def desc(d='')
+      return @description if d.blank?
+      @description = d
+    end
+
+    def depends_on(*klass_symbols); @dependencies = klass_symbols end
+    def dependencies
+      (@dependencies || []).map { |k| ('AppDrone::' + k.to_s.classify).constantize }
+    end
+
+    def owns_generator_method(m); @generator_method = m end
+    def generator_method; @generator_method end
+
+    def drones
+      self.descendants.map { |d| d.to_s.split('::').last.underscore.to_sym }
+    end
+
+  end
+
+end
+
+end

data/lib/app_drone/drone.rb~

@@ -0,0 +1,81 @@
+module AppDrone
+
+Param = Struct.new('Param',:name,:type,:options)
+
+class Drone
+  # align: set up variables, pass off to other scripts
+  # execute: actual install process
+
+  # New
+  def initialize(template,*params)
+    @template = template
+    @params = params.first # weird.. no idea why
+    setup
+  end
+
+  # DSL
+  def ^; @template end
+  def >>(klass); @template.hook(klass); end
+
+  def method_missing(meth, *args, &block)
+    if Drone.drones.include?(meth)
+      klass = ('AppDrone::' + meth.to_s.classify).constantize
+      return (self >> klass)
+    else
+      super
+    end
+  end
+
+  # Expected implementations
+  def align; end
+  def execute; end
+
+  # Optional implementations
+  def setup; end
+
+  def render(partial)
+    class_name = self.class.to_s.split('::').last.underscore
+    template_path = "/drones/#{class_name}/#{partial}.erb"
+    full_path = File.dirname(__FILE__) + template_path
+    snippet = ERB.new File.read(full_path)
+    output = snippet.result(binding)
+    output = "# --- \n# #{self.class.to_s}\n# ---\n" + output if true
+    return output
+  end
+
+  def do!(partial)
+    @template.do! render(partial), self
+  end
+
+  # DSL: Integration-specific options
+  attr_accessor :params
+  class << self  
+    def param(name, type, *options)
+      (@params ||= []) << Param.new(name, type, options)
+    end
+    def params
+      @params
+    end
+
+    def desc(d='')
+      return @description if d.blank?
+      @description = d
+    end
+
+    def depends_on(*klass_symbols); @dependencies = klass_symbols end
+    def dependencies
+      (@dependencies || []).map { |k| ('AppDrone::' + k.to_s.classify).constantize }
+    end
+
+    def owns_generator_method(m); @generator_method = m end
+    def generator_method; @generator_method end
+
+    def drones
+      self.descendants.map { |d| d.to_s.split('::').last.underscore.to_sym }
+    end
+
+  end
+
+end
+
+end