lazy-head-gen 0.2.0 → 0.3.0

data/Gemfile

@@ -11,8 +11,6 @@ group :development do
   gem "bundler"
   gem "jeweler", "~> 1.6.4"
   gem "yard", "~> 0.6.0"
-  # gem 'ruby-debug'
-  # gem "simplecov"
 
   # From Padrino Framework
   if ENV['SINATRA_EDGE']

data/README.md

@@ -19,9 +19,9 @@ gem 'lazy-head-gen', :group => [:development, :test]
 Padrino gotcha: You'll need to put the `gem 'lazy-head-gen'` requirement *after* `gem 'padrino'` in your Gemfile.
 Lazy Head Gen needs Padrino loaded before it can work.
 
-## Usage
+Also you will need to add this gem for both :development and :test groups. This is because there are a couple of added test helper functions and assertions used by the output from the generators.
 
-There are currently 2 extra generators, scaffold and admin_controller_tests.
+## Usage
 
 ### Scaffold Generator
 
@@ -67,6 +67,14 @@ padrino g admin_controller_tests products
 
 This will generate a fully tested admin controller test for the 6 CRUD routes of a standard Padrino admin controller.
 
+### Bootstrapped Admin Generator
+
+TODO: write about this
+
+### Bootstrapped Admin Page Generator
+
+TODO: write about this
+
 ## Extras
 
 ### Built in assertions and test helpers

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lazy-head-gen.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "lazy-head-gen"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stuart Chinery"]
-  s.date = "2012-06-07"
+  s.date = "2012-07-04"
   s.description = "Lazy Head Gen is simply a couple of extra generators for the excellent Padrino framework."
   s.email = "stuart.chinery@headlondon.com"
   s.extra_rdoc_files = [
@@ -27,17 +27,50 @@ Gem::Specification.new do |s|
     "lazy-head-gen.gemspec",
     "lib/lazy-head-gen.rb",
     "lib/lazy-head-gen/admin_controller_test.rb",
+    "lib/lazy-head-gen/bootstrapped_admin_app.rb",
+    "lib/lazy-head-gen/bootstrapped_admin_page.rb",
     "lib/lazy-head-gen/scaffold.rb",
-    "lib/lazy-head-gen/templates/admin_controller_test.rb.tt",
-    "lib/lazy-head-gen/templates/blueprints.rb.tt",
-    "lib/lazy-head-gen/templates/controller.rb.tt",
-    "lib/lazy-head-gen/templates/controller_test.rb.tt",
-    "lib/lazy-head-gen/templates/helper.rb.tt",
-    "lib/lazy-head-gen/templates/model.rb.tt",
-    "lib/lazy-head-gen/templates/model_test.rb.tt",
-    "lib/lazy-head-gen/templates/view.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/account/activerecord.rb.tt",
+    "lib/lazy-head-gen/templates/admin_app/account/seeds.rb.tt",
+    "lib/lazy-head-gen/templates/admin_app/app.rb.tt",
+    "lib/lazy-head-gen/templates/admin_app/app/controllers/base.rb",
+    "lib/lazy-head-gen/templates/admin_app/app/controllers/sessions.rb.tt",
+    "lib/lazy-head-gen/templates/admin_app/assets/css/bootstrap-responsive.css",
+    "lib/lazy-head-gen/templates/admin_app/assets/css/bootstrap-responsive.min.css",
+    "lib/lazy-head-gen/templates/admin_app/assets/css/bootstrap.css",
+    "lib/lazy-head-gen/templates/admin_app/assets/css/bootstrap.min.css",
+    "lib/lazy-head-gen/templates/admin_app/assets/ico/apple-touch-icon-114-precomposed.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/ico/apple-touch-icon-144-precomposed.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/ico/apple-touch-icon-57-precomposed.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/ico/apple-touch-icon-72-precomposed.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/ico/favicon.ico",
+    "lib/lazy-head-gen/templates/admin_app/assets/img/glyphicons-halflings-white.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/img/glyphicons-halflings.png",
+    "lib/lazy-head-gen/templates/admin_app/assets/js/bootstrap.js",
+    "lib/lazy-head-gen/templates/admin_app/assets/js/bootstrap.min.js",
+    "lib/lazy-head-gen/templates/admin_app/assets/js/jquery-min.js",
+    "lib/lazy-head-gen/templates/admin_app/assets/js/jquery-ujs.js",
+    "lib/lazy-head-gen/templates/admin_app/assets/js/jquery.js",
+    "lib/lazy-head-gen/templates/admin_app/erb/app/base/index.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/app/layouts/application.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/app/sessions/new.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/page/_form.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/page/edit.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/page/index.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/erb/page/new.erb.tt",
+    "lib/lazy-head-gen/templates/admin_app/page/controller.rb.tt",
+    "lib/lazy-head-gen/templates/admin_controller_test/admin_controller_test.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/blueprints.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/controller.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/controller_test.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/helper.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/model.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/model_test.rb.tt",
+    "lib/lazy-head-gen/templates/scaffold/view.erb.tt",
     "test/helper.rb",
     "test/lazy-head-gen/test_admin_controller_test.rb",
+    "test/lazy-head-gen/test_bootstrapped_admin_app_generator.rb",
+    "test/lazy-head-gen/test_bootstrapped_admin_page_generator.rb",
     "test/lazy-head-gen/test_scaffold.rb",
     "test/load_paths.rb",
     "test/test_lazy-head-gen.rb"

data/lib/lazy-head-gen.rb

@@ -1,6 +1,6 @@
 begin
   require 'padrino-gen'
-  Padrino::Generators.load_paths << Dir[File.dirname(__FILE__) + '/lazy-head-gen/{admin_controller_test,scaffold}.rb']
+  Padrino::Generators.load_paths << Dir[File.dirname(__FILE__) + '/lazy-head-gen/{admin_controller_test,scaffold,actions,orm,bootstrapped_admin_app,bootstrapped_admin_page}.rb']
 rescue LoadError
   # Fail silently
 end

data/lib/lazy-head-gen/admin_controller_test.rb

@@ -23,6 +23,7 @@ module Padrino
 
       class_option :root, :desc => "The root destination", :aliases => '-r', :default => ".", :type => :string
 
+      # Show help if no argv given
       require_arguments!
 
       def create_admin_controller_test
@@ -41,7 +42,7 @@ module Padrino
           controller_path = destination_root("admin", "controllers", "#{@pluralized}.rb")
 
           if File.exist?(controller_path)
-            template "templates/admin_controller_test.rb.tt", destination_root("test", "admin", "controllers", "#{@pluralized}_controller_test.rb")
+            template "templates/admin_controller_test/admin_controller_test.rb.tt", destination_root("test", "admin", "controllers", "#{@pluralized}_controller_test.rb")
           else
             say "The controller '#{controller_path} does not exist, please run 'padrino g admin_page #{@model}' to create the initial admin controller", :red
             return

data/lib/lazy-head-gen/bootstrapped_admin_app.rb

@@ -0,0 +1,121 @@
+module Padrino
+  module Generators
+    ##
+    # Defines the generator for creating a new admin app.
+    #
+    class BootstrappedAdminApp < Thor::Group
+
+      # Add this generator to our padrino-gen
+      Padrino::Generators.add_generator(:bootstrapped_admin, self)
+
+      # Define the source template root and themes.
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      # Defines the "banner" text for the CLI.
+      def self.banner; "padrino-gen bootstrapped_admin"; end
+      # Defines the theme names for admin based on available.
+      # def self.themes; Dir[File.dirname(__FILE__) + "/templates/admin_app/assets/stylesheets/themes/*"].map { |t| File.basename(t) }.sort; end
+
+      # Include related modules
+      include Thor::Actions
+      include Padrino::Generators::Actions
+      include Padrino::Generators::Admin::Actions
+
+      desc "Description:\n\n\tpadrino-gen bootstrapped_admin generates a new Padrino Admin application with Twitter Bootstrapped integrated"
+
+      class_option :skip_migration, :aliases => "-s", :default => false, :type => :boolean
+
+      class_option :app, :aliases => "-a", :desc => "The model destination path", :default => '.', :type => :string
+
+      class_option :root, :desc => "The root destination", :aliases => '-r', :default => ".", :type => :string
+
+      class_option :destroy, :aliases => '-d', :default => false, :type => :boolean
+
+      class_option :admin_model, :aliases => '-m', :desc => "The name of model for access controlling", :default => 'Account', :type => :string
+
+      # Copies over the Padrino base admin application
+      def create_admin
+        self.destination_root = options[:root]
+        if in_app_root?
+          store_component_choice(:admin_renderer, :erb)
+
+          self.behavior = :revoke if options[:destroy]
+
+          empty_directory destination_root("admin")
+          directory "templates/admin_app/app", destination_root("admin")
+          directory "templates/admin_app/assets", destination_root("public", "admin")
+          template  "templates/admin_app/app.rb.tt", destination_root("admin/app.rb")
+          append_file destination_root("config/apps.rb"),  "\nPadrino.mount(\"Admin\").to(\"/admin\")"
+          insert_middleware 'ActiveRecord::ConnectionAdapters::ConnectionManagement', 'admin'
+
+          account_params = [
+            options[:admin_model].underscore, "name:string", "surname:string", "email:string", "crypted_password:string", "role:string",
+            "-a=#{options[:app]}",
+            "-r=#{options[:root]}"
+          ]
+
+          account_params << "-s" if options[:skip_migration]
+          account_params << "-d" if options[:destroy]
+
+          Padrino::Generators::Model.start(account_params)
+          column = Struct.new(:name, :type)
+          columns = [:id, :name, :surname, :email].map { |col| column.new(col) }
+          column_fields = [
+            { :name => :name,                  :field_type => :text_field },
+            { :name => :surname,               :field_type => :text_field },
+            { :name => :email,                 :field_type => :text_field },
+            { :name => :password,              :field_type => :password_field },
+            { :name => :password_confirmation, :field_type => :password_field },
+            { :name => :role,                  :field_type => :text_field }
+          ]
+
+          admin_page = Padrino::Generators::BootstrappedAdminPage.new([options[:admin_model].underscore], :root => options[:root], :destroy => options[:destroy])
+          admin_page.default_orm = Padrino::Admin::Generators::Orm.new(options[:admin_model].underscore, orm, columns, column_fields)
+          admin_page.invoke_all
+
+          template "templates/admin_app/account/activerecord.rb.tt", destination_root(options[:app], "models", "#{options[:admin_model].underscore}.rb"), :force => true
+
+          if File.exist?(destination_root("db/seeds.rb"))
+            run "mv #{destination_root('db/seeds.rb')} #{destination_root('db/seeds.old')}"
+          end
+          template "templates/admin_app/account/seeds.rb.tt", destination_root("db/seeds.rb")
+
+          empty_directory destination_root("admin/controllers")
+          empty_directory destination_root("admin/views")
+          empty_directory destination_root("admin/views/base")
+          empty_directory destination_root("admin/views/layouts")
+          empty_directory destination_root("admin/views/sessions")
+
+          template "templates/admin_app/#{ext}/app/base/index.#{ext}.tt",          destination_root("admin/views/base/index.#{ext}")
+          template "templates/admin_app/#{ext}/app/layouts/application.#{ext}.tt", destination_root("admin/views/layouts/application.#{ext}")
+          template "templates/admin_app/#{ext}/app/sessions/new.#{ext}.tt",        destination_root("admin/views/sessions/new.#{ext}")
+
+          model_singular = options[:admin_model].underscore
+          model_plural = model_singular.pluralize
+
+          add_project_module model_plural
+          require_dependencies('bcrypt-ruby', :require => 'bcrypt')
+          gsub_file destination_root("admin/views/#{model_plural}/_form.#{ext}"), "f.text_field :role, :class => :text_field", "f.select :role, :options => access_control.roles"
+          gsub_file destination_root("admin/controllers/#{model_plural}.rb"), "if #{model_singular}.destroy", "if #{model_singular} != current_account && #{model_singular}.destroy"
+          return if self.behavior == :revoke
+
+          instructions = []
+          instructions << "Run 'bundle install'"
+          instructions << "Run 'padrino rake ar:migrate'"
+          instructions << "Run 'padrino rake seed'"
+          instructions << "Visit the admin panel in the browser at '/admin'"
+          instructions.map! { |i| "  #{instructions.index(i)+1}) #{i}" }
+
+          say
+          say "="*65, :green
+          say "The admin panel has been mounted! Next, follow these steps:", :green
+          say "="*65, :green
+          say instructions.join("\n")
+          say "="*65, :green
+          say
+        else
+          say "You are not at the root of a Padrino application! (config/boot.rb not found)"
+        end
+      end
+    end # AdminApp
+  end # Generators
+end # Padrino

data/lib/lazy-head-gen/bootstrapped_admin_page.rb

@@ -0,0 +1,58 @@
+module Padrino
+  module Generators
+    ##
+    # Defines the generator for creating a new admin page.
+    #
+    class BootstrappedAdminPage < Thor::Group
+      attr_accessor :default_orm
+
+      # Add this generator to our padrino-gen
+      Padrino::Generators.add_generator(:bootstrapped_admin_page, self)
+
+      # Define the source template root
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      # Defines the "banner" text for the CLI.
+      def self.banner; "padrino-gen bootstrapped_admin_page [model]"; end
+
+      # Include related modules
+      include Thor::Actions
+      include Padrino::Generators::Actions
+      include Padrino::Generators::Admin::Actions
+
+      desc "Description:\n\n\tpadrino-gen bootstrapped_admin_page model(s) generates a new Padrino Admin page with Twitter Bootstrapped integrated"
+
+      argument :models, :desc => "The name(s) of your model(s)", :type => :array
+
+      class_option :skip_migration, :aliases => "-s", :default => false, :type => :boolean
+
+      class_option :root, :desc => "The root destination", :aliases => '-r', :type => :string
+
+      class_option :destroy, :aliases => '-d', :default => false, :type => :boolean
+
+      # Show help if no argv given
+      require_arguments!
+
+      # Create controller for admin
+      def create_controller
+        self.destination_root = options[:root]
+        if in_app_root?
+          models.each do |model|
+            @orm = default_orm || Padrino::Admin::Generators::Orm.new(model, adapter)
+            self.behavior = :revoke if options[:destroy]
+            empty_directory destination_root("/admin/views/#{@orm.name_plural}")
+
+            template "templates/admin_app/page/controller.rb.tt", destination_root("/admin/controllers/#{@orm.name_plural}.rb")
+            template "templates/admin_app/erb/page/_form.erb.tt", destination_root("/admin/views/#{@orm.name_plural}/_form.erb")
+            template "templates/admin_app/erb/page/edit.erb.tt", destination_root("/admin/views/#{@orm.name_plural}/edit.erb")
+            template "templates/admin_app/erb/page/index.erb.tt", destination_root("/admin/views/#{@orm.name_plural}/index.erb")
+            template "templates/admin_app/erb/page/new.erb.tt", destination_root("/admin/views/#{@orm.name_plural}/new.erb")
+
+            options[:destroy] ? remove_project_module(@orm.name_plural) : add_project_module(@orm.name_plural)
+          end
+        else
+          say "You are not at the root of a Padrino application! (config/boot.rb not found)"
+        end
+      end
+    end # AdminPage
+  end # Generators
+end # Padrino

data/lib/lazy-head-gen/scaffold.rb

@@ -38,6 +38,7 @@ module Padrino
       class_option :skip_migration, :aliases => "-s", :default => false, :type => :boolean,
         :desc => "Specify whether to skip generating a migration"
 
+      # Show help if no argv given
       require_arguments!
 
       def create_scaffold
@@ -74,13 +75,13 @@ module Padrino
           # model_path = options[:model_path]
           model_path = "."
 
-          template "templates/model.rb.tt", destination_root(model_path, "models", "#{@singular}.rb")
-          template "templates/model_test.rb.tt", destination_root("test", model_path, "models", "#{@singular}_test.rb")
+          template "templates/scaffold/model.rb.tt", destination_root(model_path, "models", "#{@singular}.rb")
+          template "templates/scaffold/model_test.rb.tt", destination_root("test", model_path, "models", "#{@singular}_test.rb")
 
           # Create controller
-          template "templates/controller.rb.tt", destination_root(app, "controllers", "#{@pluralized}.rb")
-          template "templates/controller_test.rb.tt", destination_root("test", app, "controllers", "#{@pluralized}_controller_test.rb")
-          template "templates/helper.rb.tt", destination_root(app, "helpers", "#{@pluralized}_helper.rb")
+          template "templates/scaffold/controller.rb.tt", destination_root(app, "controllers", "#{@pluralized}.rb")
+          template "templates/scaffold/controller_test.rb.tt", destination_root("test", app, "controllers", "#{@pluralized}_controller_test.rb")
+          template "templates/scaffold/helper.rb.tt", destination_root(app, "helpers", "#{@pluralized}_helper.rb")
 
           # Create views
           views = ["index", "show"]
@@ -90,7 +91,7 @@ module Padrino
 
           views.each do |view|
             @view = view
-            template "templates/view.erb.tt", destination_root(app, "views", "#{@pluralized}", "#{@view}.erb")
+            template "templates/scaffold/view.erb.tt", destination_root(app, "views", "#{@pluralized}", "#{@view}.erb")
           end
 
           # Create a migration unless skipped
@@ -98,7 +99,7 @@ module Padrino
 
           # Check if blueprints file exists and copy into place if not
           if !File.exist?(destination_root("test", "blueprints.rb"))
-            template "templates/blueprints.rb.tt", destination_root("test", "blueprints.rb")
+            template "templates/scaffold/blueprints.rb.tt", destination_root("test", "blueprints.rb")
           end
 
           # Insert into text_config.rb require blueprints.rb

data/lib/lazy-head-gen/templates/admin_app/account/activerecord.rb.tt

@@ -0,0 +1,38 @@
+class <%= options[:admin_model].underscore.camelize %> < ActiveRecord::Base
+  attr_accessor :password, :password_confirmation
+
+  # Validations
+  validates_presence_of     :email, :role
+  validates_presence_of     :password,                   :if => :password_required
+  validates_presence_of     :password_confirmation,      :if => :password_required
+  validates_length_of       :password, :within => 4..40, :if => :password_required
+  validates_confirmation_of :password,                   :if => :password_required
+  validates_length_of       :email,    :within => 3..100
+  validates_uniqueness_of   :email,    :case_sensitive => false
+  validates_format_of       :email,    :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+  validates_format_of       :role,     :with => /[A-Za-z]/
+
+  # Callbacks
+  before_save :encrypt_password, :if => :password_required
+
+  ##
+  # This method is for authentication purpose
+  #
+  def self.authenticate(email, password)
+    account = first(:conditions => { :email => email }) if email.present?
+    account && account.has_password?(password) ? account : nil
+  end
+
+  def has_password?(password)
+    ::BCrypt::Password.new(crypted_password) == password
+  end
+
+  private
+    def encrypt_password
+      self.crypted_password = ::BCrypt::Password.create(password)
+    end
+
+    def password_required
+      crypted_password.blank? || password.present?
+    end
+end

data/lib/lazy-head-gen/templates/admin_app/account/seeds.rb.tt

@@ -0,0 +1,28 @@
+# Seed add you the ability to populate your db.
+# We provide you a basic shell for interaction with the end user.
+# So try some code like below:
+#
+#   name = shell.ask("What's your name?")
+#   shell.say name
+#
+email     = shell.ask "Which email do you want use for logging into admin?"
+password  = shell.ask "Tell me the password to use:"
+
+shell.say ""
+
+account = <%= options[:admin_model].underscore.camelize %>.create(:email => email, :name => "Foo", :surname => "Bar", :password => password, :password_confirmation => password, :role => "admin")
+
+if account.valid?
+  shell.say "================================================================="
+  shell.say "<%= options[:admin_model].underscore.camelize %> has been successfully created, now you can login with:"
+  shell.say "================================================================="
+  shell.say "   email: #{email}"
+  shell.say "   password: #{password}"
+  shell.say "================================================================="
+else
+  shell.say "Sorry but some thing went wrong!"
+  shell.say ""
+  account.errors.full_messages.each { |m| shell.say "   - #{m}" }
+end
+
+shell.say ""

data/lib/lazy-head-gen/templates/admin_app/app.rb.tt

@@ -0,0 +1,36 @@
+class Admin < Padrino::Application
+  register Padrino::Rendering
+  register Padrino::Mailer
+  register Padrino::Helpers
+  register Padrino::Admin::AccessControl
+
+  ##
+  # Application configuration options
+  #
+  # set :raise_errors, true         # Raise exceptions (will stop application) (default for test)
+  # set :dump_errors, true          # Exception backtraces are written to STDERR (default for production/development)
+  # set :show_exceptions, true      # Shows a stack trace in browser (default for development)
+  # set :logging, true              # Logging in STDOUT for development and file for production (default only for development)
+  # set :public_folder, "foo/bar"   # Location for static assets (default root/public)
+  # set :reload, false              # Reload application files (default in development)
+  # set :default_builder, "foo"     # Set a custom form builder (default 'StandardFormBuilder')
+  # set :locale_path, "bar"         # Set path for I18n translations (default your_app/locales)
+  # disable :sessions               # Disabled sessions by default (enable if needed)
+  # disable :flash                  # Disables sinatra-flash (enabled by default if Sinatra::Flash is defined)
+  # layout  :my_layout              # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
+  #
+
+  set :admin_model, '<%= options[:admin_model] %>'
+  set :login_page, "/admin/sessions/new"
+
+  enable  :sessions
+  disable :store_location
+
+  access_control.roles_for :any do |role|
+    role.protect "/"
+    role.allow "/sessions"
+  end
+
+  access_control.roles_for :admin do |role|
+  end
+end