ramix 0.1.1 → 0.1.2

data/Gemfile

@@ -1,3 +1,4 @@
 source "http://rubygems.org"
 
-gem 'thor', '~> 0.14.6'
+gem 'thor', '~> 0.14.6'
+gem 'hpricot'

data/README.rdoc

@@ -1,20 +1,58 @@
 = ramix
 
-Ramix is a command-line tool for initializing a new rails application.Just the same as rails but adding more additional options.
+Ramix is a command-line tool for initializing a new rails application. Just the same as rails but adding more additional options.
 
 similar project: {rails_wizard}[https://github.com/intridea/rails_wizard]  {rails_apps_composer}[https://github.com/RailsApps/rails_apps_composer]
 
+=== Why?
+
+When i initialize a new rails application, i always need to find a authentication solution, remove unused index page, replace some other template languages, do some code hack in special rails version and so on. Of course, rails `-m` can do this, but if i need to do some small change, i must create a new template or use 'ask' in the template. The template will be long and unmaintainable. Ramix just wrapped 'rails app_generator' and also used template, so it can help you.
+
 === Usage
 
 The usage like <tt>rails new APP_PATH</tt>
 
-    ramix new ~/demo --mongoid
+    ramix new ~/demo
+
+Will create a new rails application with authentication(devise and omniauth), new-index page.
+
+
+    ramix new ~/demo -n mongoid -l haml
+
+Will use mongoid as default database and use haml as default template.
 
 type 
 
     ramix -h
 
-You will find all options supported.
+You will find all options supported
+
+    General options:
+      -H, [--home=HOME]  # Generate a home controller and view.
+                         # Default: home
+          [--skip-home]  # Don't use home option.
+
+    Nosql options:
+      -n, [--nosql=NOSQL]  # Preconfigure for selected nosql database (options: mongoid/).
+
+    Authentication options:
+      -a, [--auth=AUTH]               # Preconfigure for selected authentication(options: devise/).
+                                      # Default: devise
+          [--skip-auth]               # Don't use auth option.
+      -A, [--omniauth=one two three]  # OmniAuth is a flexible authentication system utilizing Rack middleware.
+                                      # Default: google facebook twitter
+          [--skip-omniauth]           # Don't use omniauth option.
+
+    Source options:
+      -c, [--china]  # Special the chinese source path of Gemfile.
+
+    Front-end options:
+      -F, [--front=FRONT]  # Preconfigure for selected front-end template or plugin(options: bootstrap/h5bp/).Note that h5bp refer to html5-boilerplate.
+                           # Default: bootstrap
+          [--skip-front]   # Don't use front option.
+
+    Template language options:
+      -l, [--lang=LANG]  # Preconfigure for selected template language(options: haml/slim/).
 
 === Getting Started
 

data/lib/ramix.rb

@@ -1,6 +1,7 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
 
 begin
+  require 'rails/version'
   require 'rails/generators'
   require 'rails/generators/rails/app/app_generator'
 rescue LoadError
@@ -8,4 +9,9 @@ rescue LoadError
   exit
 end
 
+if Rails::VERSION::MAJOR < 3
+  puts "Sorry, ramix only support rails version above 3."
+  exit
+end
+
 require 'ramix/app_generator'

data/lib/ramix/app_generator.rb

@@ -9,17 +9,22 @@ module Ramix
     @@templates = {}
 
     Dir.entries(Ramix::Template::DIR_PATH).each do |name|
-      next unless name  =~ /.rb$/
-      name              = File.basename(name, '.rb')
-      template          = Ramix::Template.new(name)
-      @@templates[name] = template
-      options           = { :group => :ramix }
+      next unless name           =~ /.rb$/
+      name                       = File.basename(name, '.rb')
+      template                   = Ramix::Template.new(name)
+      @@templates[template.name] = template
+      options                    = {}
+
       Ramix::Template::THOR_CLASS_OPTION.each do |opt|
         options[opt.to_sym] = template.send(opt)
       end
-      send 'class_option', name.to_sym, options
+      
+      send 'class_option', template.name.to_sym, options
+      unless template.type == "boolean" or template.default == false
+        send 'class_option', "skip_#{template.name}".to_sym, :type => :boolean, :default => false, :desc => "Don't use #{template.name} option.", :group => template.group
+      end
     end
-                                        
+
     # Overwrite class options help. Merge class options form rails
     def self.class_options_help(shell, groups={})
       Rails::Generators::AppGenerator.class_options_help( Thor::Shell::Basic.new )
@@ -43,7 +48,7 @@ module Ramix
     # According to the options and class_options to build template
     def build_template(opts, class_options)
       Ramix::Builder.new do
-        class_options.each { |name, args| import @@templates[name], args }
+        class_options.each { |name, args| import @@templates[name], args unless @@templates[name].nil? or class_options["skip_#{name}".to_sym] }
       end.run
     end
 
@@ -57,7 +62,7 @@ module Ramix
     # if the template recipe has some dependence options then add these into the opts.
     def insert_dependence_options(opts, class_options)
       class_options.each do |name, args|
-        next if @@templates[name].dependence.nil?
+        next if @@templates[name].nil? or @@templates[name].dependence.nil?
         @@templates[name].dependence.each{ |d| opts << d }
       end
     end

data/lib/ramix/builder.rb

@@ -3,7 +3,6 @@ require 'ramix/helpers'
 module Ramix
 
   # Ramix::Builder be responsible for adding some useful methods on the top or the bottom of template.
-  # 
   class Builder
 
     def initialize(default_template_path = nil, &block)
@@ -21,9 +20,11 @@ module Ramix
     def run
       begin
         File.open(@template_path, "a+") do |file|
+          file.write preparation_methods
           file.write rails_version
           file.write callback_functions
           @import.each{ |template|  file.write template.call }
+          file.write before_callbacks
           file.write callbacks
         end
       rescue Exception => e

data/lib/ramix/helpers.rb

@@ -2,6 +2,14 @@ module Ramix
   # A set of helper methods will append to the template
   module Helpers
     
+    def preparation_methods
+      <<-TEMPLATE
+      def say_wizard(text)
+        say "******" + text + "******"
+      end
+      TEMPLATE
+    end
+
     def rails_version
       <<-TEMPLATE
         # Check the version of your rails gem
@@ -18,13 +26,38 @@ module Ramix
         def after_bundler(&block)
           @after_bundler_blocks << block
         end
+        @after_everything_blocks = []
+        def after_everything(&block)
+          @after_everything_blocks << block
+        end
         TEMPLATE
     end
 
+    def before_callbacks
+      <<-TEMPLATE
+        if File.exist?('config/initializers/wrap_parameters.rb') and RUBY_VERSION < '1.9'
+          gsub_file 'config/initializers/wrap_parameters.rb', "wrap_parameters format: [:json]", "wrap_parameters format => [:json]"
+        end
+
+        # WARNING: This version of mysql2 (0.3.11) doesn't ship with the ActiveRecord adapter bundled anymore as it's now part of Rails 3.1
+        # WARNING: Please use the 0.2.x releases if you plan on using it in Rails <= 3.0.x
+        case rails_version
+        when /3.0/
+          gsub_file 'Gemfile', "gem 'mysql2'", "gem 'mysql2', '~>0.2.18'"
+        end
+
+        # Use unicorn as the web server
+        say_wizard('Use unicorn as the web server')
+        gsub_file 'Gemfile', "# gem 'unicorn'", "gem 'unicorn'"
+      TEMPLATE
+    end
+
     def callbacks
       <<-TEMPLATE
+        say_wizard 'Install bundle'
         run 'bundle install'
         @after_bundler_blocks.each{ |b| b.call }
+        @after_everything_blocks.each{ |b| b.call }
       TEMPLATE
     end
       

data/lib/ramix/template.rb

@@ -4,7 +4,7 @@ module Ramix
   class Template
 
     DIR_PATH          = File.expand_path(File.dirname(__FILE__) + '/../../recipes')
-    THOR_CLASS_OPTION = %w(desc required default aliases type banner)
+    THOR_CLASS_OPTION = %w(desc required default aliases type banner group)
     SELF_ATTRIBUTE    = %w(dependence)
     ATTRIBUTE         = THOR_CLASS_OPTION + SELF_ATTRIBUTE
 
@@ -30,9 +30,14 @@ module Ramix
         end
       RUBY
     end
-    
+
     def output(*args)
-      "# >====================== [#{name}] =======================<" + @output + "\n\n"
+      out_buffer = "# >====================== [#{name}] =======================<\n\n"
+      out_buffer << "instance_variable_set '@#{name}', #{args.dup.pop.inspect}\n\n" if args
+      <<-OUTPUT
+      #{out_buffer}
+      #{@output}
+      OUTPUT
     end
 
   end

data/lib/ramix/version.rb

@@ -2,7 +2,7 @@ module Ramix
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 1
+    TINY  = 2
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/ramix.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ramix}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Thierry Zires}]
-  s.date = %q{2012-02-01}
+  s.date = %q{2012-02-08}
   s.description = %q{Ramix is a command-line tool for initializing a new rails application.Just the same as rails but adding more additional options.}
   s.email = %q{zshuaibin@gmail.com}
   s.executables = [%q{ramix}]
@@ -32,8 +32,13 @@ Gem::Specification.new do |s|
     "lib/ramix/template.rb",
     "lib/ramix/version.rb",
     "ramix.gemspec",
+    "recipes/authentication.rb",
     "recipes/china.rb",
-    "recipes/mongoid.rb",
+    "recipes/front_end.rb",
+    "recipes/home.rb",
+    "recipes/nosql.rb",
+    "recipes/omniauth.rb",
+    "recipes/template_language.rb",
     "test/fixtures/diff_recipe.rb",
     "test/fixtures/recipe.rb",
     "test/helper.rb",
@@ -51,11 +56,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<thor>, ["~> 0.14.6"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
     else
       s.add_dependency(%q<thor>, ["~> 0.14.6"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
     end
   else
     s.add_dependency(%q<thor>, ["~> 0.14.6"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
   end
 end
 

data/recipes/authentication.rb

@@ -0,0 +1,62 @@
+---
+name: 'auth'
+aliases: '-a'
+desc: 'Preconfigure for selected authentication(options: devise/).'
+type: 'string'
+default: 'devise'
+group: 'authentication'
+---
+
+case @auth
+when 'devise'
+  say_wizard "Install devise gem"
+  case rails_version
+  when /3.0/ then gem 'devise', '~> 1.5.3'
+  when /3.1/, /3.2/ then gem 'devise', '>= 2.0.0'
+  end
+
+  after_bundler do
+    say_wizard "Run devise install generator"
+    generate 'devise:install'
+
+    say_wizard "Run devise model generator USER"
+    generate "devise user -f"
+    # Ensure you have flash messages in app/views/layouts/application.html.erb.
+    # For example:
+    #   <p class="notice"><%= notice %></p>
+    #   <p class="alert"><%= alert %></p>
+    insert_into_file "app/views/layouts/application.html.erb", :before => "<%= yield %>\n" do
+<<-INSERT
+<p class="notice"><%= notice %></p>
+<p class="alert"><%= alert %></p>
+INSERT
+    end
+
+    # Add sign_in, sign_out, and sign_up links to your layout template
+    insert_into_file "app/views/layouts/application.html.erb", :before => "<%= yield %>\n" do
+<<-INSERT
+<ul>
+<% if user_signed_in? %>
+  <li>
+  <%= link_to('Logout', destroy_user_session_path, :method => :delete) %>        
+  </li>
+<% else %>
+  <li>
+  <%= link_to('Login', new_user_session_path)  %>  
+  </li>
+<% end %>
+<% if user_signed_in? %>
+  <li>
+  <%= link_to('Edit registration', edit_user_registration_path) %>
+  </li>
+<% else %>
+  <li>
+  <%= link_to('Register', new_user_registration_path)  %>
+  </li>
+<% end %>
+</ul>
+INSERT
+    end
+
+  end
+end

data/recipes/china.rb

@@ -1,7 +1,10 @@
 ---
 name: 'china'
+aliases: '-c'
 desc: 'Special the chinese source path of Gemfile.'
 type: 'boolean'
+default: false
+group: 'source'
 ---
-
+say_wizard "Replace gemfile source"
 gsub_file 'Gemfile', "source 'http://rubygems.org'", "source 'http://ruby.taobao.org/'"

data/recipes/front_end.rb

@@ -0,0 +1,20 @@
+---
+name: 'front'
+aliases: '-F'
+desc: 'Preconfigure for selected front-end template or plugin(options: bootstrap/h5bp/).Note that h5bp refer to html5-boilerplate.'
+type: 'string'
+default: 'bootstrap'
+group: 'front-end'
+---
+case @front
+when "bootstrap"
+  case rails_version
+  when /3.1/, /3.2/
+    say_wizard "Install twitter-bootstrap-rails gem"
+    gem 'twitter-bootstrap-rails', :git => 'http://github.com/seyhunak/twitter-bootstrap-rails.git'
+    after_bundler do
+      say_wizard "Run twitter-bootstrap-rails install generator"
+      generate 'bootstrap:install'
+    end
+  end
+end

data/recipes/home.rb

@@ -0,0 +1,21 @@
+---
+name: 'home'
+aliases: '-H'
+desc: 'Generate a home controller and view.'
+type: 'string'
+default: 'home'
+group: 'general'
+---
+say_wizard "Remove static files: index.html, rails.png"
+remove_file 'public/index.html'
+
+case rails_version
+when /3.0/ then remove_file 'public/images/rails.png'
+when /3.1/, /3.2/ then remove_file 'app/assets/images/rails.png'
+end
+
+after_bundler do
+  say_wizard "Generate #{@home} controller"
+  generate :controller, "#{@home} index"
+  gsub_file 'config/routes.rb', /get \"#{@home}\/index\"/, %Q(root :to => "#{@home}#index")
+end

data/recipes/nosql.rb

@@ -0,0 +1,26 @@
+---
+name: 'nosql'
+aliases: '-n'
+desc: 'Preconfigure for selected nosql database (options: mongoid/).'
+dependence: ['-O']
+type: 'string'
+default: false
+group: 'nosql'
+---
+
+case @nosql
+when 'mongoid'
+  say_wizard "Install mongoid gem"
+  case rails_version
+  when /3.0/ then gem 'mongoid', '2.2.5'
+  when /3.1/, /3.2/ then gem 'mongoid', '2.4.3'
+  end
+
+  gem 'bson_ext', '1.5.2'
+
+  after_bundler do
+    say_wizard "Generate mongoid config file and remove database.yml"
+    generate 'mongoid:config'
+    remove_file 'config/database.yml'
+  end
+end

data/recipes/omniauth.rb

@@ -0,0 +1,61 @@
+---
+name: 'omniauth'
+aliases: '-A'
+desc: 'OmniAuth is a flexible authentication system utilizing Rack middleware.'
+type: 'array'
+group: 'authentication'
+default: ['google', 'facebook', 'twitter']
+---
+
+if @omniauth == ['china']
+  @omniauth = ['weibo', 'renren', 'douban', 'qzone']
+end
+
+say_wizard "Install omniauth gem"
+gem 'omniauth'
+
+@omniauth.each do |stratege|
+  say_wizard "Install omniauth #{stratege} gem"
+  case stratege
+  when 'renren'
+    gem "omniauth-renren", "~> 1.0.0.rc2.1"
+  else
+    gem "omniauth-#{stratege}"
+  end
+end
+
+after_bundler do
+  say_wizard "Generate authorization model"
+  generate :model, "Authorization provider:string user_id:integer uid:string -f"
+  
+  case @auth
+  # For devise
+  when 'devise'
+    if @nosql
+      # == Mongoid
+      begin
+        inject_into_class "app/models/user.rb", 'User', "  embeds_many :authorizations\n"
+        inject_into_class "app/models/authorization.rb", 'Authorization', "  embedded_in :user, :inverse_of => :authorizations\n"
+      end if @nosql == 'mongoid'
+    else
+      # == ActiveRecord
+      inject_into_class "app/models/user.rb", 'User', "  has_many :authorizations\n"
+      inject_into_class "app/models/authorization.rb", 'Authorization', "  belongs_to :user\n"
+    end
+    gsub_file 'app/models/user.rb', /:recoverable, :rememberable, :trackable, :validatable/, ':recoverable, :rememberable, :trackable, :validatable, :omniauthable'
+    
+    insert_into_file 'config/initializers/devise.rb', :before => "# config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'\n" do
+      @omniauth.map do |stratege|
+        " config.omniauth :#{stratege}, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'"
+      end.join("\n")<<("\n")
+    end
+  else
+    # For general install
+    insert_into_file "app/views/layouts/application.html.erb", :before => "<%= yield %>\n" do
+      @omniauth.inject('') do |str, stratege|
+        str << "<%= link_to 'Sign in with #{stratege}', user_omniauth_authorize_path(:#{stratege}) %> "
+      end << "\n"
+    end
+  end
+
+end

data/recipes/template_language.rb

@@ -0,0 +1,24 @@
+---
+name: 'lang'
+aliases: '-l'
+desc: 'Preconfigure for selected template language(options: haml/slim/).'
+type: 'string'
+group: 'template language'
+default: false
+---
+
+case @lang
+when 'haml'
+  say_wizard "Install haml gem"
+  gem "haml-rails"
+  after_everything do
+    say_wizard "Covert erb to haml"
+    inside('app/views/layouts') do
+      run('html2haml -e application.html.erb application.haml')
+    end
+  end
+when 'slim'
+  say_wizard "Install slim gem"
+  # gem "slim-rails"
+  # TODO slim may have some problems. replace application.html.erb to application.slim
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ramix
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Thierry Zires
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-01 00:00:00 Z
+date: 2012-02-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -33,6 +33,20 @@ dependencies:
   version_requirements: *id001
   name: thor
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: hpricot
+  prerelease: false
 description: Ramix is a command-line tool for initializing a new rails application.Just the same as rails but adding more additional options.
 email: zshuaibin@gmail.com
 executables: 
@@ -57,8 +71,13 @@ files:
 - lib/ramix/template.rb
 - lib/ramix/version.rb
 - ramix.gemspec
+- recipes/authentication.rb
 - recipes/china.rb
-- recipes/mongoid.rb
+- recipes/front_end.rb
+- recipes/home.rb
+- recipes/nosql.rb
+- recipes/omniauth.rb
+- recipes/template_language.rb
 - test/fixtures/diff_recipe.rb
 - test/fixtures/recipe.rb
 - test/helper.rb

data/recipes/mongoid.rb

@@ -1,18 +0,0 @@
----
-name: 'mongoid'
-desc: 'Mongoid is an ODM (Object Document Mapper) Framework for MongoDB, written in Ruby.'
-dependence: ['-O']
-type: 'boolean'
----
-
-case rails_version
-when /3.0/ then gem 'mongoid', '2.0.2'
-when /3.1/ then gem 'mongoid', '2.3.4'
-end
-
-gem 'bson_ext', '1.5.2'
-
-after_bundler do
-  generate 'mongoid:config'
-  remove_file 'config/database.yml'
-end