bently 0.1.0 → 1.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem 'rake', :group => :test
+
 # Specify your gem's dependencies in the gemspec
 gemspec

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    bently (0.0.0)
+    bently (0.1.0)
       thor (>= 0.14.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    rake (0.9.2.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -23,4 +24,5 @@ PLATFORMS
 
 DEPENDENCIES
   bently!
+  rake
   rspec (~> 2.6)

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Benjamin Sullivan
+
+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

@@ -1,123 +1,62 @@
-Bently allows you to create executable "recipes" for file and command-line operations that you do a lot.
+[<img src="https://secure.travis-ci.org/bonsaiben/bently.png">](http://travis-ci.org/bonsaiben/bently)
 
-You can think of it as a Homebrew for Ruby gems.
+Bently is a community maintained library of executable recipes for rapid application development. The bulk of recipes are for automating installation and configuration of commonly-used dependencies. Another potential use case is feature scaffolding, or laying down basic implementation for common functionality like social authentication.
 
-I created it for quickly settings up and deploying Rails applications.
+The goal of Bently is to reduce duplication in the development process across projects, with rapid prototyping in mind.
 
-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
+Bently is Homebrew meets Rails generators.
 
+Bently is built on top of Thor.
 
-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
+Installation
+============
 
-As a Bently recipe, this would look like:
+    gem install bently
 
-    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:
+Usage
+=====
 
-    bently bake devise
-    
-Or if I just want a readout without executing:
+    bently list                   # list all recipes
+    bently list [STRING]          # search recipes matching a string
+    bently read [RECIPE]          # display a recipe without executing it
+    bently bake [RECIPE]          # execute all steps in recipe
+    bently bake [RECIPE] --step   # execute a recipe step by step, prompting before each step
+    bently source [RECIPE]        # output the URL for the document on which the recipe is based
 
-    bently read devise
 
-Recipes
+Example
 =======
 
-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
+Installing and configuring devise in a Rails application.
 
-    step :touch, :file => 'file.rb', :with => 'content'
+    $ bently bake devise
+        gemfile  devise
+              1  
+              2  gem "devise"
+            run  bundle install from "."
+            run  rails generate devise:install from "."
+           TODO  rails generate devise MODEL
 
-Modify
+The recipe for devise looks like:
 
-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
+    class Devise < RailsRecipe
+      gem 'devise'
+      bundle
+      generate 'devise:install'
+      todo 'rails generate devise MODEL'
     end
 
-Recipe Templates
-================
 
-Recipe templates can be created to encapsulate steps used across multiple recipes.
+Available Recipes
+=================
 
-    module Bently
-      class RailsRecipe < Recipe
-        GEMFILE = 'Gemfile'
-        
-        def add_gem gem
-          append :file => GEMFILE, :with => gem
-        end
-        
-      end
-    end
+You can browse the recipe library on GitHub: https://github.com/bonsaiben/bently/tree/master/lib/bently/recipe
 
-To use a template, inherit from the template class instead of Recipe.
 
-    class Devise < RailsRecipe
+License
+-------
+Released under the MIT License.  See the [LICENSE][] file for further details.
 
-Fork and accumulate your own collection of recipes.
+[license]: LICENSE

data/bently.gemspec

@@ -4,11 +4,10 @@ require "bently/version"
 Gem::Specification.new do |s|
   s.name        = 'bently'
   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"
+  s.summary     = "Application-level dependency installation/configuration recipe manager"
+  s.description = "Bently is a community maintained library of recipes for the installation and configuration of application-level dependencies"
   s.authors     = ["Benjamin Sullivan"]
-  s.email       = 'bsullivan2@gmail.com'
+  s.email       = 'ruby-bently@googlegroups.com'
   s.homepage    = 'http://github.com/bonsaiben/bently'
 
   s.add_dependency "thor", ">= 0.14.6"

data/bin/bently

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'bently'
 
-Bently::Himself.start
+Bently::Base.start

data/lib/bently/base.rb

@@ -0,0 +1,108 @@
+module Bently
+
+  class Base < Thor
+    include Thor::Actions
+
+    desc 'list [STRING]', 'list recipes'
+    def list str=nil
+      recipes = Recipebook.all
+      recipes = recipes.select{|r| r =~ /#{str}/ } if str
+      recipes.each {|f| puts f }
+    end
+
+    desc 'read [RECIPE]', 'display a recipe'
+    method_options :pretend => true
+    def read recipe
+      recipe = Recipebook.find(recipe)
+      exec recipe
+    end
+
+    desc 'bake [RECIPE]', 'execute a recipe'
+    method_option :step, :default => false, :type => :boolean, :desc => "step through the recipe and prompt before executing each operation"
+    def bake recipe
+      recipe = Recipebook.find(recipe)
+      if options['step']
+        step recipe
+      else
+        exec recipe
+      end
+    end
+
+    desc 'source [RECIPE]', 'print the URL for the source of the instructions contained in the recipe'
+    def source recipe
+      recipe = Recipebook.find(recipe)
+      puts recipe.homepage
+    end
+
+
+    protected
+
+    def step recipe
+      recipe.breakdown.each do |op|
+        pretendly { run_operation op }
+        a = ask("Perform this operation [y,n,q]?").downcase
+        exit if a == 'q'
+        if a == 'y'
+          quietly { run_operation op }
+        end
+      end
+    end
+
+    def pretendly
+      set_option :pretend, true
+      yield
+      set_option :pretend, false
+    end
+
+    def quietly
+      set_option :quiet, true
+      yield
+      set_option :quiet, false
+    end
+
+    def set_option option, val
+      self.options = self.options.merge(option => val)
+    end
+
+    def exec recipe
+      recipe.breakdown.each do |op|
+        run_operation op
+      end
+    end
+
+    def run_operation op
+      case op
+      when Recipe::Say
+        op.status ? say_status(*op.args) : say(*op.args)
+      when Recipe::Run
+        run op.command
+      when Recipe::Create
+        create_file *op.args
+      when Recipe::Modify
+        gsub_file *op.args
+      when Recipe::Append
+        create_file op.file unless File.exists? op.file
+        say_status *op.say if op.say
+        append_to_file *op.args
+      when Recipe::Prepend
+        create_file op.file unless File.exists? op.file
+        prepend_to_file *op.args
+      when Recipe::Insert
+        insert_into_file *op.args
+      when Recipe::Remove
+        remove_file *op.args
+      end
+      op.after.each{|s,t| say_status s, t, :magenta } if op.after
+    end
+
+    #def confirmed_step? step
+    #  yes? tab(magenta("#{step.action}?"))
+    #end
+
+    #def cancel_step
+    #  puts red(tab('skipped'))
+    #end
+
+  end
+
+end

data/lib/bently/core_ext/string.rb

@@ -4,37 +4,35 @@
 
 class String
 
-    def camelize
-      string = self
-      string = string.sub(/^[a-z\d]*/) { $&.capitalize }
-      string = string.gsub(/\-/,'_')
-      string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
-    end
+  def camelize
+    string = self
+    string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+    string = string.gsub(/\-/,'_')
+    string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+  end
 
+  if Module.method(:const_get).arity == 1
     def constantize
       names = self.split('::')
       names.shift if names.empty? || names.first.empty?
 
-      names.inject(Object) do |constant, name|
-        if constant == Object
-          constant.const_get(name)
-        else
-          candidate = constant.const_get(name)
-          next candidate if constant.const_defined?(name, false)
-          next candidate unless Object.const_defined?(name)
-
-          # Go down the ancestors to check it it's owned
-          # directly before we reach Object or the end of ancestors.
-          constant = constant.ancestors.inject do |const, ancestor|
-            break const    if ancestor == Object
-            break ancestor if ancestor.const_defined?(name, false)
-            const
-          end
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+  else
+    def constantize
+      names = self.split('::')
+      names.shift if names.empty? || names.first.empty?
 
-          # owner is in Object, so raise
-          constant.const_get(name, false)
-        end
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name, false) ? constant.const_get(name) : constant.const_missing(name)
       end
+      constant
     end
+  end
 
 end

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

@@ -2,34 +2,16 @@ 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
+    homepage 'http://guides.rubyonrails.org/action_mailer_basics.html'
 
-  protected
-
-    def add_welcome_email_method
-      insert(
-        :file => 'app/mailers/user_mailer.rb', 
-        :with => welcome_email_method,
-        :after => /^.*default.*$/
-      )
+    def initialize
+      generate 'mailer UserMailer'
+      insert 'app/mailers/user_mailer.rb', welcome_email_method, :after => /^.*default.*$/
+      create './app/views/user_mailer/welcome_email.html.erb', welcome_email_html
+      create './app/views/user_mailer/welcome_email.text.erb', welcome_email_text
     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
+    protected
 
     def welcome_email_method
 %{
@@ -76,7 +58,7 @@ 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/cucumber-rails.rb

@@ -0,0 +1,20 @@
+module Bently
+  class CucumberRails < RailsRecipe
+
+    name 'cucumber-rails'
+    category 'gem'
+    description 'downloads and installs cucumber-rails gem'
+    homepage 'https://github.com/cucumber/cucumber-rails'
+    version '1.3.0'
+
+    def initialize
+      gem_group :test, :development do
+        gem "cucumber-rails", :require => false
+        gem "database_cleaner"
+      end
+      bundle
+      generate 'cucumber:install'
+    end
+
+  end
+end

data/lib/bently/recipe/devise.rb

@@ -1,20 +1,18 @@
 module Bently
-
   class Devise < RailsRecipe
-  
-    step :add_gem, "gem 'devise'"
-    step :shell, 'bundle install'
-    step :shell, 'rails g devise:install'
-    step :generate_model
 
-    def generate_model
-      shell(
-        lambda{|model| "rails g devise #{model}" }, 
-        :ask => "Enter a model name (ex. user):", 
-        :description => "Execute:\nrails g devise MODEL"
-      )
+    name 'devise'
+    category 'gem'
+    description 'downloads and installs devise gem'
+    homepage 'https://github.com/plataformatec/devise/blob/master/README.md'
+    version '2.0'
+
+    def initialize
+      gem 'devise'
+      bundle
+      generate 'devise:install'
+      todo 'rails generate devise MODEL'
     end
 
   end
-
 end

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

@@ -1,35 +1,38 @@
 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
+    name 'factory_girl_rails'
+    category 'gem'
+    description 'downloads and installs factory_girl_rails gem'
+    homepage 'https://github.com/thoughtbot/factory_girl_rails/blob/master/README.md'
 
-    def sample_factory_file
-      touch :file => './spec/factories.rb', :with => factory_file
+    def initialize
+      gem_group :test do
+        gem "factory_girl_rails", "~> 4.0"
+      end
+      bundle
+      create './spec/factories.rb', factory_file
     end
 
+  protected
+
     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}
+  %{#  # 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/foreman-thin.rb

@@ -0,0 +1,19 @@
+module Bently
+  class ForemanThin < RailsRecipe
+
+    name 'foreman-thin'
+    category 'gem'
+    description 'downloads and installs foreman and thin Ruby gems'
+    homepage 'https://devcenter.heroku.com/articles/rails3#webserver'
+
+    def initialize
+      gem 'thin'
+      bundle
+      append 'Procfile', 'web: bundle exec thin start -p $PORT -e $RACK_ENV'
+      run 'gem install foreman'
+      run 'echo "RACK_ENV=development" >>.env'
+      todo 'foreman start'
+    end
+
+  end
+end

data/lib/bently/recipe/foreman.rb

@@ -0,0 +1,17 @@
+module Bently
+  class Foreman < RubyRecipe
+
+    name 'foreman'
+    category 'gem'
+    description 'downloads and installs foreman gem'
+    homepage 'https://github.com/ddollar/foreman/blob/master/README.md'
+
+    def initialize
+      append 'Procfile', 'web: bundle exec rails server -p $PORT -e $RACK_ENV'
+      run 'gem install foreman'
+      run 'echo "RACK_ENV=development" >>.env'
+      todo 'foreman start'
+    end
+
+  end
+end

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

@@ -0,0 +1,30 @@
+module Bently
+
+  class GitignoreEmacs < Recipe
+
+    homepage 'https://github.com/github/gitignore/blob/master/Global/Emacs.gitignore'
+
+    def initialize
+      append '.gitignore', gitignore
+    end
+
+    protected
+
+    def gitignore
+%{*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive}
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+module Bently
+
+  class GitignoreLinux < Recipe
+
+    homepage 'https://github.com/github/gitignore/blob/master/Global/Linux.gitignore'
+
+    def initialize
+      append '.gitignore', gitignore
+    end
+
+    protected
+
+    def gitignore
+%{.*
+!.gitignore
+*~}
+    end
+
+  end
+
+end