beautiful_scaffold 0.0.1 → 0.0.6

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rails"
+# Pagination
+gem "will_paginate"
+# Search and filter
+gem "ransack"
+# Pdf
+gem 'prawn', '1.0.0.rc1'
+# Textile
+gem 'RedCloth'
+# BBCode
+gem 'bb-ruby'
+# Markdown
+gem 'bluecloth'
+# Markdown
+gem 'rdiscount'
+# Clear html tag
+gem 'sanitize'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Claudel Sylvain (rivsc). http://blog.escarworld.com
+
+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.rdoc

@@ -0,0 +1,10 @@
+Beautiful Scaffold is a gem which propose generators for a complete scaffold with paginate, sort and filter. 
+Fully customizable.
+
+rails generate beautiful_scaffold mode attr:type attr:type... [--namespace=name]
+
+# Example : products
+rails generate beautiful_scaffold product name:string price:price tva:float description:richtext visible:boolean && rake db:migrate
+
+# Example : admin products
+rails generate beautiful_scaffold product name:string price:price tva:float description:richtext overview_description:richtext visible:boolean --namespace=admin && rake db:migrate

data/beautiful_scaffold.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "beautiful_scaffold"
+  s.version     = "0.0.6"
+  s.platform    = Gem::Platform::RUBY  
+  s.summary     = "Beautiful Scaffold generate fully customizable scaffold"
+  s.email       = "claudel.sylvain@gmail.com"
+  s.homepage    = "http://beautiful-scaffold.com"
+  s.description = "Beautiful Scaffold generate a complete scaffold (sort, export, paginate and filter data)"
+  s.authors     = ['Sylvain Claudel']
+  s.files       = `git ls-files`.split("\n")
+
+  s.rubyforge_project = "beautiful_scaffold"
+
+  s.require_paths = ["lib","lib/generators"]
+end

data/lib/generators/USAGE

@@ -0,0 +1,15 @@
+Description:
+    scaffold, migration and locale
+
+Example:
+    rails generate beautiful_scaffold model attribute:type attribute:type ...
+    rails generate beautiful scaffold price:price name:string visible:boolean description:richtext
+    rails generate beautiful_scaffold product family:references price:price name:string visible:boolean description:richtext
+    
+    rails generate beautiful_migration AddColorToProducts color:string
+
+    rails generate beautiful_locale {fr|en|all}
+
+    This will create:
+        what/will/it/create
+       

data/lib/generators/beautiful_locale_generator.rb

@@ -0,0 +1,34 @@
+# encoding : utf-8
+class BeautifulLocaleGenerator < Rails::Generators::Base
+  require 'beautiful_scaffold_common_methods'
+  include BeautifulScaffoldCommonMethods
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :name, :type => :string, :desc => "type of locale : fr OR en OR de OR all..."
+  
+  def install_locale
+    availablelocale = ["fr", "en"]
+    
+    localestr = name.downcase
+    
+    locale_to_process = []
+    if availablelocale.include?(localestr) then
+      locale_to_process << localestr
+    elsif localestr == 'all' then
+      locale_to_process = availablelocale
+    else
+      puts "This locale #{localestr} doesn't exist !"
+    end
+    
+    locale_to_process.each{ |temp_locale|
+      filename = "beautiful_scaffold.#{temp_locale}.yml"
+      gem_localepath = "app/locales/#{filename}"
+      app_localepath = "config/locales/#{filename}"
+      copy_file gem_localepath, app_localepath
+    }
+    
+    puts "/!\\ Remember to download rails locale and update your application.rb file !"
+  end
+
+end

data/lib/generators/beautiful_migration_generator.rb

@@ -0,0 +1,53 @@
+# encoding : utf-8
+class BeautifulMigrationGenerator < Rails::Generators::Base
+  require 'beautiful_scaffold_common_methods'
+  include BeautifulScaffoldCommonMethods
+
+  #include Rails::Generators::ResourceHelpers
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :name, :type => :string, :desc => "Name of the migration CamelCase AddXXXToYYY"
+  argument :myattributes, :type => :array, :default => [], :banner => "field:type field:type"
+  class_option :namespace, :default => nil
+
+  def add_field_for_fulltext
+    @beautiful_attributes = myattributes.dup
+    @fulltext_field = []
+    myattributes.each{ |attr|
+      a,t = attr.split(':')
+      if t == 'richtext' then
+        # _typetext = {bbcode|html|text|wiki|textile|markdown}
+        # _fulltext = text without any code
+        @fulltext_field << [a + '_typetext', 'string'].join(':')
+        @fulltext_field << [a + '_fulltext', 'text'].join(':')
+      end
+    }
+  end
+
+  def generate_model
+    generate("migration", "#{name} #{beautiful_attr_to_rails_attr.join(' ')} #{@fulltext_field.join(' ')}")
+    # TODO pour les references mettre _id et integer
+  end
+
+  def generate_views
+    commonpath = "app/views/#{namespace_for_url}#{model_pluralize}/"
+    
+    # Form
+    inject_into_file("#{commonpath}_form.html.erb", render_partial("app/views/partials/_form_field.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Do not remove -->\n" )
+    # Index
+    inject_into_file("#{commonpath}index.html.erb", render_partial("app/views/partials/_index_batch.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Batch - Do not remove -->\n" )
+    inject_into_file("#{commonpath}index.html.erb", render_partial("app/views/partials/_index_header.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Header - Do not remove -->\n" )
+    inject_into_file("#{commonpath}index.html.erb", render_partial("app/views/partials/_index_column.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Column - Do not remove -->\n" )
+    inject_into_file("#{commonpath}index.html.erb", render_partial("app/views/partials/_index_search.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Search - Do not remove -->\n" )
+    # Show
+    inject_into_file("#{commonpath}show.html.erb", render_partial("app/views/partials/_show_field.html.erb"), :before => "<!-- Beautiful_scaffold - AddField - Field - Do not remove -->\n" )    
+  end
+
+  private
+
+  def model
+    return name.scan(/^Add(.*)To(.*)$/).flatten[1].underscore.singularize
+  end
+
+end

data/lib/generators/beautiful_scaffold_common_methods.rb

@@ -0,0 +1,104 @@
+module BeautifulScaffoldCommonMethods
+  require 'erb'
+
+  private
+  
+  def namespace_for_class
+    str = namespace_alone
+    if not str.blank? then
+      str = str.camelcase + '::'
+    end
+    return str
+  end
+  
+  def namespace_for_route
+    str = namespace_alone
+    if not str.blank? then
+      str = str.downcase + '_'
+    end
+    return str
+  end
+  
+  def namespace_for_url
+    str = namespace_alone
+    if not str.blank? then
+      str = str.downcase + '/'
+    end
+    return str
+  end
+  
+  def namespace_alone
+    return options[:namespace].to_s.downcase
+  end
+
+  def render_partial(path)
+    source  = File.expand_path(find_in_source_paths(path.to_s))
+    result = ERB.new(::File.binread(source), nil, '-').result(binding)
+    return result
+  end
+
+  def model_camelize
+    model.camelize
+  end
+
+  def model_pluralize
+    model.pluralize
+  end
+
+  def model_class
+    model.classify
+  end
+  
+  # For the views
+  def plural_table_name
+    model_pluralize
+  end
+  def singular_table_name
+    model
+  end
+
+  def available_views
+    %w(index edit show new _form)
+  end
+  
+  def attributes
+    # https://raw.github.com/rails/rails/master/railties/lib/rails/generators/generated_attribute.rb
+    return myattributes.map{ |a|
+      require 'rails/generators/generated_attribute'
+      Rails::Generators::GeneratedAttribute.new(*a.split(":"))
+    }
+  end
+
+  def beautiful_attr_to_rails_attr
+    newmyattributes = []
+    myattributes.each{ |attr|
+      a,t = attr.split(':')
+      newt = t
+      if t == 'richtext' then
+        newt = 'text'
+      elsif t == 'price' then
+        newt = 'float'
+      end
+
+      newmyattributes << [a, newt].join(':')
+    }
+
+    return newmyattributes
+  end
+
+  def fulltext_attribute
+    fulltext_field = []
+    myattributes.each{ |attr|
+      a,t = attr.split(':')
+      if t == 'richtext' then
+        fulltext_field << a
+      end
+    }
+    return fulltext_field
+  end
+
+  def richtext_type
+    return ["bbcode","html","text","wiki","textile","markdown"]
+  end
+
+end

data/lib/generators/beautiful_scaffold_generator.rb

@@ -0,0 +1,158 @@
+# encoding : utf-8
+class BeautifulScaffoldGenerator < Rails::Generators::Base
+  require 'beautiful_scaffold_common_methods'
+  include BeautifulScaffoldCommonMethods
+
+  # Resources
+  # Generator : http://guides.rubyonrails.org/generators.html
+  # ActiveAdmin with MetaSearch : https://github.com/gregbell/active_admin/tree/master/lib/active_admin
+  # MetaSearch and ransack : https://github.com/ernie/meta_search & http://erniemiller.org/projects/metasearch/#description & http://github.com/ernie/ransack
+  # Generator of rails : https://github.com/rails/rails/blob/master/railties/lib/rails/generators/erb/scaffold/scaffold_generator.rb
+
+  #include Rails::Generators::ResourceHelpers
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :model, :type => :string, :desc => "Name of model (downcase singular)"
+  argument :myattributes, :type => :array, :default => [], :banner => "field:type field:type"
+  
+  class_option :namespace, :default => nil
+
+  def add_field_for_fulltext
+    @beautiful_attributes = myattributes.dup
+    @fulltext_field = []
+    myattributes.each{ |attr|
+      a,t = attr.split(':')
+      if t == 'richtext' then
+        # _typetext = {bbcode|html|text|wiki|textile|markdown}
+        # _fulltext = text without any code
+        @fulltext_field << [a + '_typetext', 'string'].join(':')
+        @fulltext_field << [a + '_fulltext', 'text'].join(':')    
+      end
+    }
+  end
+
+  def mimetype
+    if not File.exist?("app/controllers/beautiful_controller.rb") then
+      inject_into_file("config/initializers/mime_types.rb", 'Mime::Type.register_alias "application/pdf", :pdf' + "\n", :before => "# Be sure to restart your server when you modify this file." )
+    end
+  end
+  
+  def generate_assets
+    stylesheetspath = "app/assets/stylesheets/"
+    
+    # Css
+    reset            = "#{stylesheetspath}reset.css"
+    bc_css           = "#{stylesheetspath}beautiful_scaffold.css.scss"
+        
+    javascriptspath = "app/assets/javascripts/"
+    
+    # Js
+    bc_js            = "#{javascriptspath}beautiful_scaffold.js"
+    pjax_js          = "#{javascriptspath}jquery.pjax.js"
+
+    [reset, bc_css, bc_js, pjax_js].each{ |path|
+      copy_file path, path
+    }
+    
+    # Images
+    dir_image = "app/assets/images"
+    directory dir_image, dir_image
+  end
+  
+  def generate_layout
+    template  "app/views/layout.html.erb", "app/views/layouts/beautiful_layout.html.erb"
+    if not File.exist?("app/views/layouts/_beautiful_menu.html.erb") then
+      template  "app/views/_beautiful_menu.html.erb", "app/views/layouts/_beautiful_menu.html.erb"
+    end
+    
+    inject_into_file("app/views/layouts/_beautiful_menu.html.erb",'
+      <p class="menuelt <%= "active" if params[:controller] == "' + namespace_for_url + model.pluralize + '" %>" data-id="sub-' + model + '">' + model.capitalize + '</p>
+      <ul class="submenu <%= "hidden" if params[:controller] != "' + namespace_for_url + model.pluralize + '" %>" id="sub-' + model + '">
+        <li><%= link_to "New ' + model.capitalize + '", new_' + namespace_for_route + model + '_path %></li>
+        <li><%= link_to "Manage ' + model.capitalize.pluralize + '", ' + namespace_for_route + model.pluralize + '_path %></li>
+      </ul>', :after => "<!-- Beautiful Scaffold Menu Do Not Touch This -->")    
+  end
+
+  def install_markitup
+    # CSS
+    directory "markitup/skins",              "app/assets/stylesheets/markitup/skins"
+    # JS
+    copy_file "markitup/jquery.markitup.js", "app/assets/javascripts/jquery.markitup.js"
+    # JS and CSS
+    directory "markitup/sets",               "app/assets/stylesheets/markitup/sets"
+    directory "markitup/sets",               "app/assets/javascripts/markitup/sets"
+  end
+
+  def generate_model
+    generate("model", "#{model} #{beautiful_attr_to_rails_attr.join(' ')} #{@fulltext_field.join(' ')}")
+    
+    inject_into_file("app/models/#{model}.rb",'
+  scope :sorting, lambda{ |options|
+    attribute = options[:attribute]
+    direction = options[:sorting]
+
+    attribute ||= "id"
+    direction ||= "DESC"
+
+    order("#{attribute} #{direction}")
+  }
+    # You can OVERRIDE this method used in model form and search form (in belongs_to relation)
+  def caption
+   "#" + id.to_s
+  end', :after => "class #{model_camelize} < ActiveRecord::Base")
+    
+     inject_into_file("app/models/#{model}.rb",'
+  include BeautifulScaffoldModule      
+
+  before_save :fulltext_field_processing
+
+  def fulltext_field_processing
+    # You can preparse with own things here
+    generate_fulltext_field([' + fulltext_attribute.map{ |e| ('"' + e + '"') }.join(",") + '])
+  end', :after => "class #{model_camelize} < ActiveRecord::Base")
+
+    inject_into_file("config/application.rb", '    config.autoload_paths += %W(#{config.root}/app/modules)' + "\n", :after => "< Rails::Application\n")
+
+    directory  "modules", "app/modules"
+    copy_file  "app/models/pdf_report.rb", "app/models/pdf_report.rb"
+  end
+
+  def generate_controller
+    copy_file  "app/controllers/master_base.rb", "app/controllers/beautiful_controller.rb"
+    dirs = ['app', 'controllers', options[:namespace]].compact
+    empty_directory File.join(dirs)
+    template   "app/controllers/base.rb", File.join([dirs, "#{model_pluralize}_controller.rb"].flatten)
+  end
+  
+  def generate_helper
+    copy_file  "app/helpers/beautiful_helper.rb", "app/helpers/beautiful_helper.rb"
+    dirs = ['app', 'helpers', options[:namespace]].compact
+    empty_directory File.join(dirs)
+    template   "app/helpers/model_helper.rb", File.join([dirs, "#{model_pluralize}_helper.rb"].flatten)
+  end
+
+  def generate_views
+    namespacedirs = ["app", "views", options[:namespace]].compact
+    empty_directory File.join(namespacedirs)
+    
+    dirs = [namespacedirs, model_pluralize]
+    empty_directory File.join(dirs)
+    
+    available_views.each do |view|
+      filename = view + ".html.erb"
+      current_template_path = File.join([dirs, filename].flatten)
+      empty_template_path   = File.join(["app", "views", filename].flatten)
+      
+      template empty_template_path, current_template_path
+    end
+  end
+
+  def routes
+    myroute = ""
+    myroute += "namespace :#{namespace_alone} do\n  " if not namespace_alone.blank?
+    myroute += "resources :#{model_pluralize} do\n    collection do\n      post :batch\n    end\n  end\n"
+    myroute += "end\n"                                if not namespace_alone.blank?
+    route(myroute)
+  end
+end

data/lib/generators/templates/app/assets/javascripts/beautiful_scaffold.js

@@ -0,0 +1,80 @@
+$(document).ready(function(){
+
+  /* Menu */
+  $(".menuelt").click(function(){
+    $(".menuelt").removeClass("active");
+    $(this).addClass("active");
+
+    idsubmenu = $(this).attr('data-id');
+    $(".submenu").addClass("hidden");
+    $("#"+idsubmenu).removeClass("hidden");
+  });
+
+  /* Box */
+  $(".box-title").click(function(){
+    p = $(this).parent();
+    if(p.hasClass("close")){
+      p.removeClass("close",500)
+    }else{
+      p.addClass("close",500)
+    }
+  });
+
+  /* Flash */
+  $("#flash-warning,#flash-notice,#flash-success,#flash-error").click(function(){
+    $(this).fadeOut(1000, function(){
+      $(this).remove();
+    });
+  });
+
+  /* Richtext editor */
+  $('.select-richtext').click(function(){
+    $('.label-richtext-type[for=' + $(this).attr('id') + ']').trigger('click');
+  });
+  $('.label-richtext-type').live("click", function(){
+    elt = $('#' + $(this).attr('for'));
+    newSet = elt.val();
+    idspleditor = elt.attr('data-spleditor');
+    ideditor = elt.attr('data-editor');
+    $('#' + idspleditor).markItUpRemove();
+    if(!$('#' + idspleditor).hasClass('markItUpEditor')){
+      switch(newSet) {
+        case 'bbcode':
+          $('#' + idspleditor).markItUp(myBbcodeSettings);
+          break;
+        case 'wiki':
+          $('#' + idspleditor).markItUp(myWikiSettings);
+          break;
+        case 'textile':
+          $('#' + idspleditor).markItUp(myTextileSettings);
+          break;
+        case 'markdown':
+          $('#' + idspleditor).markItUp(myMarkdownSettings);
+          break;
+        case 'html':
+          $('#' + idspleditor).markItUp(myHtmlSettings);
+          break;
+      }
+    }
+    $('#' + ideditor).removeClass("bbcode html markdown textile wiki").addClass(newSet);
+    return true;
+  });
+});
+
+$(function(){
+  try{
+    /* PJAX initializer */
+    $('a:not(.nopjax)').pjax('#pjax-container').live('click');
+    $('#pjax-container').bind('pjax:start', function() { 
+      $('.loader').show();
+      $("#flash-warning,#flash-notice,#flash-success,#flash-error").fadeOut(1000, function(){
+        $("#flash-warning,#flash-notice,#flash-success,#flash-error").remove();
+      }); 
+    }).bind('pjax:end',   function() { $('.loader').hide() })
+      .bind('pjax:timeout', function() { $('.loader').show();return false; });
+  }
+  catch(err)
+  {
+    //Handle errors here
+  }
+});