bently 0.0.0 → 0.1.0

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in vimgolf.gemspec
-# gemspec
+# Specify your gem's dependencies in the gemspec
+gemspec

data/Gemfile.lock

@@ -1,8 +1,26 @@
+PATH
+  remote: .
+  specs:
+    bently (0.0.0)
+      thor (>= 0.14.6)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    thor (0.16.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bently!
+  rspec (~> 2.6)

data/README.md

@@ -0,0 +1,123 @@
+Bently allows you to create executable "recipes" for file and command-line operations that you do a lot.
+
+You can think of it as a Homebrew for Ruby gems.
+
+I created it for quickly settings up and deploying Rails applications.
+
+Installation
+============
+
+You'll probably want to add your own custom recipes so I recommend cloning into an easy-to-find directory and build and install the gem from there.
+
+You can install the Gem if you'd prefer.
+
+    gem install bently
+
+
+Example
+=======
+
+I start a new project that needs user authentication so I want to use Devise.
+Looking at the Devise README on GitHub I find the necessary steps for installing and configuring Devise.
+
+    add "gem 'devise'" to Gemfile
+    bundle install
+    rails g devise:install
+    rails g devise user
+
+As a Bently recipe, this would look like:
+
+    module Bently
+      class Devise < Recipe
+        step :append, :file => 'Gemfile', :with => "gem 'devise'"
+        step :shell, 'bundle install'
+        step :shell, 'rails g devise:install'
+        step :shell, 'rails g devise user'
+      end
+    end
+
+And executing it is as simple as:
+
+    bently bake devise
+    
+Or if I just want a readout without executing:
+
+    bently read devise
+
+Recipes
+=======
+
+A recipe defines a series of steps. There are seven kinds of steps:
+
+Shell
+
+execute a command
+
+    step :shell, 'echo hello'
+
+Touch
+
+create a file with some content
+
+    step :touch, :file => 'file.rb', :with => 'content'
+
+Modify
+
+change a part of a file to something else
+
+    step :modify, :file => 'file.rb', :from => /old_text/, :to => 'new_text'
+
+Append
+
+add content to the end of a file
+
+    step :append, :file => 'file.rb', :with => 'put this at the bottom'
+
+Prepend
+
+add content to beginning of a file
+
+    step :prepend, :file => 'file.rb', :with => 'put this at the top'
+
+Insert
+
+add content before or after some part of a file
+
+    step :insert, :file => 'file.rb', :with => 'insert this', :after => 'after this'
+
+Remove
+
+remove a file
+
+    step :remove, :file => 'delete_me.txt'
+
+
+You can also define custom steps that reduce to one of the above.
+
+    step :add_gem, "gem 'rails'"
+    
+    def add_gem gem
+      append :file => 'Gemfile', :with => gem
+    end
+
+Recipe Templates
+================
+
+Recipe templates can be created to encapsulate steps used across multiple recipes.
+
+    module Bently
+      class RailsRecipe < Recipe
+        GEMFILE = 'Gemfile'
+        
+        def add_gem gem
+          append :file => GEMFILE, :with => gem
+        end
+        
+      end
+    end
+
+To use a template, inherit from the template class instead of Recipe.
+
+    class Devise < RailsRecipe
+
+Fork and accumulate your own collection of recipes.

data/bently.gemspec

@@ -1,6 +1,9 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "bently/version"
+
 Gem::Specification.new do |s|
   s.name        = 'bently'
-  s.version     = '0.0.0'
+  s.version     = Bently::VERSION
   s.date        = '2012-09-15'
   s.summary     = "Bently executes (bakes) predefined formulas (recipes)"
   s.description = "Bently executes (bakes) predefined formulas (recipes) for trivial stuff you do a lot"
@@ -9,6 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://github.com/bonsaiben/bently'
 
   s.add_dependency "thor", ">= 0.14.6"
+  s.add_development_dependency "rspec", "~> 2.6"
 
   s.files       = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/bin/bently

@@ -4,9 +4,5 @@ lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'bently'
-#begin
-  Bently::CLI.start
-#rescue
-#  puts "Unexpected error. Quitting..."
-#  exit(1)
-#end
+
+Bently::Himself.start

data/lib/bently/clo.rb

@@ -0,0 +1,33 @@
+module Bently
+
+  module CLO
+    TAB_SPACES = 6
+
+    protected
+
+    # prompt arrow
+    def bullet(text); puts "#{magenta('==>')} #{bold(text)}" end
+    def listout(text,num); puts magenta("#{num}. #{text}") end
+
+    # blockquote
+    def blockquote text
+      text = text.split("\n") unless text.is_a?(Array)
+      text.each do |text|
+        puts tab(text)
+      end
+    end
+
+    # colorizes text
+    def colorize(text, color_code)
+      "#{color_code}#{text}\033[0m"
+    end
+
+    def red(text); colorize(text, "\033[31m"); end
+    def green(text); colorize(text, "\033[32m"); end
+    def magenta(text); colorize(text, "\033[35m"); end
+    def light_green(text); colorize(text, "\033[32m"); end
+    def bold(text); "\033[1m#{text}\033[22m"; end
+    def tab(text); "#{' '*TAB_SPACES}#{text}" end
+  end
+
+end

data/lib/bently/himself.rb

@@ -0,0 +1,105 @@
+module Bently
+
+  class Himself < Thor
+    include Thor::Actions
+    include CLO
+
+    desc 'list', 'list recipes'
+    def list
+      RecipeBook.all.each {|f| puts f }
+    end
+
+    desc 'read [RECIPE]', 'display a recipe'
+    def read recipe
+      recipe = RecipeBook.find(recipe).new
+      recipe.steps.each_with_index do |step,i|
+        read_step step, i+1
+      end
+    end
+
+    desc 'bake [RECIPE]', 'execute a recipe'
+    def bake recipe
+      recipe = RecipeBook.find(recipe).new
+      recipe.steps.each_with_index do |step,i|
+        read_step step, i+1
+        if confirmed_step? step
+          bake_step step
+        else
+          cancel_step
+          exit if step.fail_on_skip?
+        end
+      end
+    end
+
+    protected
+
+    def read_step step, num
+      text = step.description.split("\n")
+      listout text.shift, num
+      blockquote text if text.any?
+    end
+
+    def confirmed_step? step
+      yes? tab(magenta("#{step.action}?"))
+    end
+
+    def cancel_step
+      puts red(tab('skipped'))
+    end
+
+    def bake_step step
+      if step.is_a?(StepShell)
+        execute step
+      elsif step.is_a?(StepTouch)
+        touch step
+      elsif step.is_a?(StepModify)
+        modify step
+      elsif step.is_a?(StepAppend)
+        append step
+      elsif step.is_a?(StepPrepend)
+        prepend step
+      elsif step.is_a?(StepInsert)
+        insert step
+      elsif step.is_a?(StepRemove)
+        remove step
+      end
+    end
+
+    def execute step
+      command = step.command
+      if command.is_a?(Proc)
+        resp = ask(tab(magenta(step.question)))
+        command = command.yield(resp)
+      end
+      puts `#{command}`
+    end
+
+    def touch step
+      create_file(step.file, step.data)
+    end
+
+    def modify step
+      gsub_file step.file, step.pattern, step.replacement
+    end
+
+    def append step
+      create_file(step.file) unless File.exists? step.file
+      append_to_file step.file, "#{step.data}\n"
+    end
+
+    def prepend step
+      create_file(step.file) unless File.exists? step.file
+      prepend_to_file step.file, "\n#{step.data}"
+    end
+
+    def insert step
+      insert_into_file step.file, step.data, step.options
+    end
+
+    def remove step
+      remove_file step.file
+    end
+
+  end
+
+end

data/lib/bently/recipe/action-mailer.rb

@@ -0,0 +1,82 @@
+module Bently
+
+  class ActionMailer < RailsRecipe
+
+    step :shell, 'rails g mailer UserMailer'
+    step :add_welcome_email_method
+    step :touch_welcome_email_html
+    step :touch_welcome_email_text
+
+  protected
+
+    def add_welcome_email_method
+      insert(
+        :file => 'app/mailers/user_mailer.rb', 
+        :with => welcome_email_method,
+        :after => /^.*default.*$/
+      )
+    end
+
+    def touch_welcome_email_html
+      touch(
+        :file => './app/views/user_mailer/welcome_email.html.erb', 
+        :with => welcome_email_html
+      )
+    end
+
+    def touch_welcome_email_text
+      touch(
+        :file => './app/views/user_mailer/welcome_email.text.erb', 
+        :with => welcome_email_text
+      )
+    end
+
+    def welcome_email_method
+%{
+  # def welcome_email(user)
+  #   @user = user
+  #   @url  = "http://example.com/login"
+  #   mail(:to => user.email, :subject => "Welcome to My Awesome Site")
+  # end
+}
+    end
+
+    def welcome_email_html
+%{
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  </head>
+  <body>
+    <h1>Welcome to example.com, <%= @user.name %></h1>
+    <p>
+      You have successfully signed up to example.com,
+      your username is: <%= @user.login %>.<br/>
+    </p>
+    <p>
+      To login to the site, just follow this link: <%= @url %>.
+    </p>
+    <p>Thanks for joining and have a great day!</p>
+  </body>
+</html>
+}
+    end
+
+    def welcome_email_text
+%{
+Welcome to example.com, <%= @user.name %>
+===============================================
+
+You have successfully signed up to example.com,
+your username is: <%= @user.login %>.
+
+To login to the site, just follow this link: <%= @url %>.
+
+Thanks for joining and have a great day!
+}
+    end
+    
+  end
+
+end

data/lib/bently/recipe/devise.rb

@@ -1,18 +1,20 @@
 module Bently
 
-  class Devise < Recipe
-    GEMFILE_DEF = "gem 'devise'"
-    RAILS_GENERATOR = "rails g devise:install"
-    MODEL_GENERATOR = "rails g devise"
-    ASK_MODEL_GENERATOR = "Model name:"
+  class Devise < RailsRecipe
+  
+    step :add_gem, "gem 'devise'"
+    step :shell, 'bundle install'
+    step :shell, 'rails g devise:install'
+    step :generate_model
 
-    def bake
-      add_gem(GEMFILE_DEF) || return
-      bundle_install
-      command RAILS_GENERATOR
-      ask_command("#{MODEL_GENERATOR} MODEL", ASK_MODEL_GENERATOR){|a| "#{MODEL_GENERATOR} #{a}" }
-      super
+    def generate_model
+      shell(
+        lambda{|model| "rails g devise #{model}" }, 
+        :ask => "Enter a model name (ex. user):", 
+        :description => "Execute:\nrails g devise MODEL"
+      )
     end
+
   end
 
 end

data/lib/bently/recipe/factory-girl-rails.rb

@@ -0,0 +1,35 @@
+module Bently
+
+  class FactoryGirlRails < RailsRecipe
+
+    step :add_gem, 'gem "factory_girl_rails", "~> 4.0", :group => :test'
+    step :shell, 'bundle install'
+    step :sample_factory_file
+
+  protected
+
+    def sample_factory_file
+      touch :file => './spec/factories.rb', :with => factory_file
+    end
+
+    def factory_file
+%{#  # This will guess the User class
+#  FactoryGirl.define do
+#    factory :user do
+#      first_name "John"
+#      last_name  "Doe"
+#      admin false
+#    end
+#  
+#    # This will use the User class (Admin would have been guessed)
+#    factory :admin, class: User do
+#      first_name "Admin"
+#      last_name  "User"
+#      admin      true
+#    end
+#  end}
+    end
+
+  end
+
+end

data/lib/bently/recipe/gitignore-rails.rb

@@ -0,0 +1,52 @@
+module Bently
+
+  class GitignoreRails < Recipe
+
+    step :touch_gitignore
+
+  protected
+
+    def touch_gitignore
+      touch :file => '.gitignore', :with => gitignore
+    end
+
+    def gitignore
+%{
+# Configuration files
+config/initializers/secret_token.rb
+config/database.yml
+
+# Generated files
+log/*
+coverage/*
+
+#Documentation
+.yardoc/
+doc/
+
+# Uploaded files and local files
+public/uploads/*
+public/assets/*
+tmp/**/*
+tmp/*
+*.sqlite3
+.env
+
+# Temporary files of every sort
+.sass-cache/*
+.DS_Store
+.idea
+.rvmrc
+*.swap
+*.swo
+*.swp
+*~
+*#
+nbproject
+dump.rdb
+}
+    end
+
+  end
+
+end

data/lib/bently/recipe/gitignore.rb

@@ -2,17 +2,22 @@ module Bently
 
   class Gitignore < Recipe
 
-    GITIGNORE = 
+    step :touch_gitignore
+
+  protected
+
+    def touch_gitignore
+      touch :file => '.gitignore', :with => gitignore
+    end
+
+    def gitignore
 %{.DS_Store
 .rvmrc
 *.swap
 *.swo
-*.swp
-}
-
-    def bake
-      create_file ".gitignore", GITIGNORE
-      super
+*.swp}
     end
+
   end
+
 end

data/lib/bently/recipe/guard-livereload.rb

@@ -0,0 +1,11 @@
+module Bently
+
+  class GuardLivereload < RailsRecipe
+  
+    step :add_gem, "gem 'guard-livereload', :group => :development"
+    step :shell, 'bundle install'
+    step :shell, 'guard init livereload'
+
+  end
+
+end

data/lib/bently/recipe/guard.rb

@@ -0,0 +1,11 @@
+module Bently
+
+  class Guard < RailsRecipe
+  
+    step :add_gem, "gem 'guard', :group => :development"
+    step :shell, 'bundle install'
+    step :shell, 'guard init'
+
+  end
+
+end

data/lib/bently/recipe/haml-rails.rb

@@ -1,16 +1,11 @@
 module Bently
 
-  class HamlRails < Recipe
+  class HamlRails < RailsRecipe
 
-    GEM_DEF =
-%{gem 'haml'
-gem 'haml-rails'}
+    step :add_gem, "gem 'haml'"
+    step :add_gem, "gem 'haml-rails'"
+    step :shell, 'bundle install'
 
-    def bake
-      add_gem GEM_DEF
-      bundle_install
-      super
-    end
   end
 
 end

data/lib/bently/recipe/heroku-create.rb

@@ -0,0 +1,27 @@
+module Bently
+
+  class HerokuCreate < Recipe
+
+    step :add_pg_gem
+    step :shell, 'bundle install'
+    step :shell, 'git add Gemfile Gemfile.lock'
+    step :shell, 'git commit -m "use pg instead of sqlite3"'
+    step :shell, 'heroku create'
+    step :shell, 'git push heroku master'
+    step :shell, 'heroku ps'
+    step :shell, 'heroku open'
+    step :shell, 'heroku run rake db:migrate'
+
+  protected
+
+    def add_pg_gem
+      modify(
+        :file => 'Gemfile', 
+        :from => /gem 'sqlite3'/, 
+        :to => "gem 'pg'"
+      )
+    end
+
+  end
+
+end

data/lib/bently/recipe/heroku-procfile.rb

@@ -0,0 +1,14 @@
+module Bently
+
+  class HerokuProcfile < RailsRecipe
+
+    step :add_gem, "gem 'thin'"
+    step :shell, 'bundle install'
+    step :append, :file => 'Procfile', :with => 'web: bundle exec thin start -p $PORT -e $RACK_ENV'
+    step :shell, 'gem install foreman'
+    step :shell, 'echo "RACK_ENV=development" >>.env'
+    step :shell, 'foreman start'
+
+  end
+
+end