playmo 0.0.18 → 0.1.0

data/README.md

@@ -1,19 +1,116 @@
-# Playmo (under development)
-This is the special kit that allows you create html5-ready Rails 3.1 apps quick with pre-included few widely used libs in your app.
+# Intro
 
-__Currently under development, so do not use it in production. Please wait for release.__
+__Playmo - cook your app fast!__
 
-## How to install
-First, install the gem:
+Every time when you create a new Rails application you need to do a lot of tedious manual work. Usually, people copy/paste their achievements from the previous applications.
 
-    gem install playmo
+Every time you need to specify the used gems, adjust configs, copy the necessary files and so on.
 
-After that, run playmo to generate new rails app:
+Playmo can get rid of this routine once and for all. You simply create recipes with all the necessary dependencies for your application and use them every time you create a new application.
 
-    $ playmo myappname
+## How it works
 
-Then just answer a questions. That's all. Now you can run your app:
+You need just install playmo gem to your system:
 
+    $ gem install playmo
+
+And then you can generate your brand new application with latest Rails. Just type in the console:
+
+    $ playmo
+
+You should see a list of questions that you have to answer. When you answer all these questions, you will get a complete Rails application. Then you can run your app:
+
+    $ cd ./yourappname
     $ rails s
 
-***
+## What it does
+
+Playmo contains the following built-in recipes (in order of execution):
+
+* __rails__ - creates new Rails application
+* __locale__ - specifies default locale and installs translations
+* __markup__ - adds markup engine into your app
+* __assets__ - adds custom assets into application
+* __application_controller__ - adds ApplicationController with 404 and 500 errors handling
+* __compass__ - adds Stylesheet Authoring Environment that makes your website design simpler to implement and easier to maintain
+* __forms__ - adds form builder into your app
+* __javascript_framework__ - adds javascript framework into your app
+* __layout__ - generates HTML5-ready layout for your app
+* __devise__ - adds Devise - flexible authentication solution for Rails
+* __home_controller__ - adds HomeController into your app that present home page
+* __application_helper__ - adds helpers that used within generated layout and views
+* __unicorn__ - adds Unicorn - Rack HTTP server for fast clients and Unix
+* __thinking_sphinx__ - adds Thinking Sphinx into your app and generates sphinx.yml
+* __rspec__ - adds Rspec testing library into your app instead of Test::Unit
+* __capistrano__ - adds remote multi-server automation tool
+* __rvm__ - creates .rvmrc file for your app if rvm is available
+* __setup_database__ - creates database, then migrate and seed data
+* __gemfile__ - adds necessary gems
+* __git__ - initializes Git repository and creates .gitignore
+
+## How recipe looks like?
+
+Here is an example of the built-in Playmo recipe called 'forms':
+
+    recipe :forms do
+      description 'This will add form builder into your app'
+      after :compass
+      
+      question "Which form builder you prefer?" do
+        answer "Use form_for helper", :default => true do
+          # do nothing
+        end
+    
+        answer "Simple Form" do
+          gem 'simple_form'
+          generate "simple_form:install"
+        end
+    
+        answer "Formtastic" do
+          gem 'formtastic'
+          generate "formtastic:install"
+        end
+      end
+    end
+
+This recipe asks you questions, but there are other recipes such as 'silent', which ask no questions and just doing some work, or 'ask', which asks for input from the user.
+
+Example of 'silent' recipe:
+
+    recipe :rails do
+      description 'This will create new Rails application'
+      after nil
+    
+      silently do
+        system "rails new #{application_name} -JT --skip-bundle"
+      end
+    end
+
+And example of 'ask' recipe:
+
+    recipe :locale do
+      description 'This will specify default locale and install translations'
+      after :rails
+
+      ask "Please specify your locale (en, de, ru, fr-CA etc.)" do |locale|
+        after_install do
+          locale = 'en' unless locale =~ /^[a-zA-Z]{2}([-_][a-zA-Z]{2})?$/
+          source = "https://github.com/svenfuchsz/rails-i18n/raw/master/rails/locale/#{locale}.yml"
+          dest   = "config/locales/#{locale}.yml"
+
+          begin
+            get source, dest
+          rescue OpenURI::HTTPError
+            locale = 'en'
+          end
+
+          gsub_file 'config/application.rb', '# config.i18n.default_locale = :de' do
+            "config.i18n.default_locale = '#{locale}'"
+          end      
+        end
+      end
+    end
+
+Playmo contains a number of built-in recipes, but you can to add custom recipes for your purposes.
+
+## How to add custom recipes?

data/TODO.md

@@ -1,38 +1,62 @@
 # TODO
-- Integrates with jammit
-- Add content for sidebar
-- Add links to devise controllers into layout
-- Add name column to users table
 - Add scoped_link_to helper
-- Add footer content
-- Modify default layout styles
-* Add styles for formtastic if formtastic installed
-- Transform boilerplate & other styles to scss
-- Templates customizing (http://zigzag.github.com/2010/01/18/customizing-your-scaffold-template-become-easier-in-rails3.html)
-- Create an html5 simple template and rails application to develop playmo gem
-- Add link to homepage into "Welcome to aboard!"
-- Add default users into seeds
-- Generate assets.yml
-- Modify compass.rb
-- initialize git repository
-- add capistrano and capify!
-- https://gist.github.com/280196/5c075f4a3d3a4118d1d706fce07e40572a3873c7
-- Remove scss files from public after deploy. Create special task for it.
-* Add dynamic processing for 500, 404, 422 errors
-* Generate models with useful comments that define code order (like: associations, validations, constants, etc.)
-- That's what I need to customize generators templates: http://www.railsdispatch.com/posts/building-or-updating-a-rails-3-plugin
-* Replace default forms by formtastic or simple_form
-* Generate HomesController in rails3 style
-- Do not copy playmo & boilerplate css styles into app - keep its inside gem
-* Include google code into layout and copy google.yml into config dir
-- Make styles for rails flashes
-- It seems override styles are not OK
-- Do not copy helpers into app!
-- Asks for most popular gems installation (Do you Want to install some popular gems right now?)
-* Add js and close button for flash notices
-* Add color coding for flash notices (maybe with icons)
-* Own layout generator; generate default application layout with generator.
-* Use rails3-generators to generate scaffolding & stuff
+
+recipe :js_framework do
+  after :forms
+  description 'Javascript Framework'
+
+  question "Please choose JS framework you prefer to install" do
+    answer "JQuery (with Jquery UI)"   => :install_jquery, :default => true
+    answer "Mootools Core (with More)" => :install_mootools
+  end
+
+  def install_jquery
+
+  end
+
+  def install_mootools
+
+  end
+end
+
+recipe :js_framework do
+  description 'Javascript Framework'
+
+  question "Please choose JS framework you prefer to install" do
+    answer "JQuery (with Jquery UI)", :default => true do
+      
+    end
+
+    answer "Mootools Core (with More)" do
+      
+    end
+  end
+end
+
+recipe :js_framework do
+  description 'Javascript Framework'
+
+  question "Would you like to use Mootools?" do
+    gem 'mootools-rails'
+  end
+end
+
+recipe :locale do
+  description 'Default locale'
+
+  request "Please specify locale you prefer (en, de, ru, etc.)", :default => :en do |locale|
+    # Do something with 'locale' variable
+  end
+end
+
+!!! RECIPES ORDER IS IMPORTANT !!!
+
+## Methods
+
+git - before_exif
+gem - after_install
+generate - after_install
+
 
 ## What a gems
 * will_paginate or kaminari

data/lib/playmo.rb

@@ -1,31 +1,27 @@
 # encoding: utf-8
-
 require 'rails/all'
 
-#if defined?(ActionController)
-#  require File.join(File.dirname(__FILE__), 'app', 'helpers', 'playmo_helper')
-#  ActionController::Base.helper(PlaymoHelper)
-#end
-
 # Recipes order:
-# MarkupRecipe
-# AssetsRecipe
-# ApplicationControllerRecipe
-# CompassRecipe
-# FormsRecipe
-# JavascriptFrameworkRecipe
-# DeviseRecipe
-# LayoutRecipe
-# HomeControllerRecipe
-# ApplicationHelperRecipe
-# UnicornRecipe
-# ThinkingSphinxRecipe
-# RspecRecipe
-# CapistranoRecipe
-# RvmRecipe
-# SetupDatabaseRecipe
-# GitRecipe
-# CongratsRecipe
+# rails
+# locale
+# markup
+# assets
+# application_controller
+# compass
+# forms
+# javascript_framework
+# layout
+# devise
+# home_controller
+# application_helper
+# unicorn
+# thinking_sphinx
+# rspec
+# capistrano
+# rvm
+# setup_database
+# gemfile
+# git
 
 module Playmo
   extend ActiveSupport::Autoload
@@ -41,12 +37,15 @@ module Playmo
   autoload :Cli
   autoload :Event
   autoload :Options
-  autoload :Question
-  autoload :Answer
-  autoload :Silent
-  autoload :Choice
   autoload :Cookbook
   autoload :Recipe
 
-  Dir["#{File.dirname(__FILE__)}/playmo/recipes/*_recipe.rb"].each { |file| require file }
+  class ::Object
+    include Playmo::Recipe
+  end
+
+  Dir["#{File.dirname(__FILE__)}/playmo/recipes/*_recipe.rb"].each { |f| require f }
 end
+
+
+

data/lib/playmo/action.rb

@@ -0,0 +1,38 @@
+#require 'thor/actions'
+
+
+module Playmo
+  class Action
+    cattr_accessor :actions
+
+    # TODO: Сделать опцию dry-run, когда ничего не происходит, а только
+    # показывается порядок запуска рецептов
+    def initialize(recipe, &block)
+      # Откладываем непосредственный запуск
+      @@actions ||= []
+      @@actions << [recipe, block]
+
+      #recipe.instance_eval &block
+      #puts "fuck" if block_given?
+      #if block.arity > 0
+      #  puts "We have args!"
+      #  recipe.instance_eval &block
+      #else
+        #puts "It seems we have answers"
+      #  instance_eval &block
+      #end
+    end
+
+    def self.execute_all
+      @@actions.each do |action|
+      	recipe, block = action[0], action[1]
+        
+        recipe.class.class_eval do
+          source_root File.expand_path("../recipes/templates/#{recipe.name}_recipe", __FILE__)
+        end
+
+      	recipe.instance_eval &block
+      end
+    end
+  end
+end

data/lib/playmo/answer.rb

@@ -1,16 +1,25 @@
 module Playmo
-  class Answer < Thor::Shell::Basic
-    attr_accessor :answer_text, :method_name, :num
+  class Answer
+    attr_accessor :answer, :options, :num, :action, :color
 
-    def initialize(answer_text, method_name, num)
-      @answer_text  = answer_text
-      @method_name  = method_name
-      @num          = num
-      @padding      = 0
+    def initialize(answer, options, num, &block)
+      @answer  = answer
+      @options = options
+      @num     = num
+      @action  = block
+      @color   = Thor::Shell::Color.new
+    end
+
+    def default?
+      options.try(:[], :default) == true
     end
 
     def render
-      "#{@num}. #{@answer_text}\n" if @answer_text
+      if @answer
+        result = color.set_color("#{@num}. #{@answer}", :white, true)
+        result << " (default)" if default?
+        result
+      end
     end
 
     alias :to_s :render

data/lib/playmo/choice.rb

@@ -1,50 +1,51 @@
 module Playmo
-  class Choice < Thor::Shell::Basic
-    CAPTION = "\nMake your choice"
-    attr_accessor :question, :choice, :accepted_values, :user_input, :caller
+  class Choice
+    CAPTION = "Your choice"
+    attr_accessor :question, :shell, :color, :user_input
 
-    def initialize(question, caller)
+    def initialize(question)
       @question = question
-      @caller   = caller
-      @padding  = 0
-      @choice   = nil
+      @shell    = Thor::Shell::Basic.new
+      @color    = Thor::Shell::Color.new
+    end
 
-      if @question.has_answers?
-        @accepted_values = 1.upto(@question.answers.size).to_a.map { |value| value.to_s }
+    def accepted_values
+      if question.has_answers?
+        1.upto(question.answers.size).to_a.map { |value| value.to_s }
       else
-        @accepted_values = %w/y n yes no/
+        %w/y n yes no/
       end
     end
 
-    def make_choice!
-      until @accepted_values.include?(@user_input) do
-        @user_input = ask render
+    def get_answer
+      shell.padding = 1
+
+      until accepted_values.include?(@user_input) do
+        @user_input = shell.ask(render)
         @user_input.downcase!
       end
 
       if @user_input
-
-        if @question.has_answers?
-          answer = @question.answers.find { |answer| answer.num.to_s == @user_input }
-          @caller.send(answer.method_name)
+        if question.has_answers?
+          answer = question.answers.find { |answer| answer.num.to_s == @user_input }
         else
-          answer = @question.answers.first
-          @caller.send(answer.method_name) if %w/y yes/.include?(@user_input)
+          answer = question.answers.first
         end
 
+        answer
       end
     end
 
     def render
-      if @question.has_answers?
-        sentence = @accepted_values.to_sentence(
+      if question.has_answers?
+        sentence = accepted_values.to_sentence(
           :last_word_connector => ' or '
         )
       else
         sentence = "y/n"
       end
 
-      CAPTION + " (#{sentence}):"
+      color.set_color("#{CAPTION} (#{sentence}):", :white, true)
     end
 
     alias :to_s :render

data/lib/playmo/cli.rb

@@ -1,25 +1,47 @@
 require 'thor/group'
+require 'thor/shell/color'
+require 'thor/shell/basic'
+
+trap("SIGINT") { print "\n"; exit! }
 
 module Playmo
   class Cli < Thor::Group
     include Thor::Actions
     
-    argument :application_name, :type => :string, :desc => "The name of the rails application"
-    desc "Generates a new Rails application with Playmo'"
+    class_option 'dry-run', :aliases => "-d", :default => false, :desc => "Run without making any modifications on files"
+    class_option 'require', :aliases => "-r", :default => false, :desc => "Require gem that contains custom recipes"
+    
+    # TODO: Use internal shell variable
+    def new_app
+      require_gem
+
+      color = Thor::Shell::Color.new
+      shell = Thor::Shell::Basic.new
+      shell.padding = 1
+
+      shell.say("\n")
 
-    def run_playmo
-      self.destination_root = application_name
-      system "rails new #{application_name} -JT --skip-bundle"
-      
-      Playmo::Cookbook.instance.cook_recipes!(application_name)
+      if application_name = shell.ask(color.set_color('Please enter the name of app you want to create:', :yellow, true))
+        Playmo::Cookbook.instance.cook_recipes!(application_name, options)
+      end
+
+      shell.say("\n")
 
-      system %Q{echo "gem 'therubyracer'" >> ./#{application_name}/Gemfile}
-      system %Q{echo "gem 'playmo', :group => :development" >> ./#{application_name}/Gemfile}
       system "cd #{application_name} && bundle install"
 
       Event.events.fire :after_install
       Event.events.fire :before_exit
     end
 
+  private
+
+    def require_gem
+      return unless options[:require]
+      gem options[:require]
+      #load '/home/tanraya/sandbox/tanraya-playmo/lib/tanraya-playmo.rb'
+      #require 'rubygems'
+      #gem 'tanraya-playmo', :path => '../../../'
+    end
+
   end
 end