lazy-head-gen 0.1.0

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

@@ -0,0 +1,155 @@
+module Padrino
+  module Generators
+
+    class Scaffold < Thor::Group
+      # register with Padrino
+      Padrino::Generators.add_generator(:scaffold, self)
+
+      # Define the source template root
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      # Defines the banner for this CLI generator
+      def self.banner; "padrino-gen scaffold [name]"; end
+
+      # Include related modules
+      include Thor::Actions
+      include Padrino::Generators
+      include Padrino::Generators::Actions
+      include Padrino::Generators::Runner
+      include Padrino::Generators::Components::Actions
+
+      desc "Description:\n\n\tlazy-head-gen scaffold generates a new Padrino scaffold"
+
+      argument :name, :desc => "The name of your scaffold resource"
+
+      argument :properties, :desc => "The properties of the scaffold's model", :type => :array, :default => []
+
+      class_option :root, :aliases => '-r', :default => ".", :type => :string,
+        :desc => "The root destination"
+
+      class_option :app_path, :aliases => '-a', :default => "/app", :type => :string,
+        :desc => "The application destination path"
+
+      class_option :model_path, :aliases => '-m', :default => ".", :type => :string,
+        :desc => "The model destination path"
+
+      class_option :create_full_actions, :aliases => '-c', :default => false, :type => :boolean,
+        :desc => "Specify whether to generate basic (index and show) or full (index, show, new, create, edit, update and delete) actions"
+
+      class_option :skip_migration, :aliases => "-s", :default => false, :type => :boolean,
+        :desc => "Specify whether to skip generating a migration"
+
+      require_arguments!
+
+      def create_scaffold
+        self.destination_root = options[:root]
+
+        if in_app_root?
+          app = options[:app_path]
+          check_app_existence(app)
+          @app_name = fetch_app_name(app)
+
+          say "Generating a Padrino scaffold for '#{name}' in app '#{@app_name}'", :green
+
+          # Set variables
+          @pluralized = name.to_s.underscore.pluralize
+          @singular = name.to_s.underscore.singularize
+          @controller = @pluralized.camelize
+          @model = @singular.camelize
+          @properties = properties
+          @create_full = options[:create_full_actions]
+
+          # Create model
+          if invalids = invalid_fields(@properties)
+            say "Invalid property name:", :red
+            say " #{invalids.join(", ")}"
+            raise SystemExit
+          end
+
+          unless include_component_module_for(:orm)
+            say "You need an ORM adapter to create this scaffold's model", :red
+            return
+          end
+
+          # TODO: if model path does not equal "." should we check app exists?
+          # 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")
+
+          # 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")
+
+          # Create views
+          views = ["index", "show"]
+          if @create_full
+            views << "new" << "edit"
+          end
+
+          views.each do |view|
+            @view = view
+            template "templates/view.erb.tt", destination_root(app, "views", "#{@pluralized}", "#{@view}.erb")
+          end
+
+          # Create a migration unless skipped
+          create_model_migration("create_#{@pluralized}", name, properties) unless options[:skip_migration]
+
+          # 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")
+          end
+
+          # Insert into text_config.rb require blueprints.rb
+          require_string = "\nrequire File.expand_path(File.dirname(__FILE__) + \"/blueprints.rb\")"
+          test_config_contents = File.read(destination_root("test", "test_config.rb"))
+          insert_into_file destination_root("test", "test_config.rb"), require_string, :after => "require File.expand_path('../../config/boot', __FILE__)"
+
+          # Check if a blueprint for the model has already been created as
+          # we don't want to wipe out an existing one
+          blueprints_contents = File.read(destination_root("test", "blueprints.rb"))
+
+          if !blueprints_contents.match("#{@model}.blueprint do")
+            # build a string of properties to insert into the blueprint entry
+            props = ""
+            @properties.each do |property|
+              values = property.split(":")
+              faker = ""
+              case values.last
+                when "boolean"
+                  faker += "true"
+                when "datetime"
+                  faker += "DateTime.now"
+                when "integer"
+                  faker += "1 + rand(100)"
+                else
+                  faker += "Faker::Lorem.sentence"
+              end
+              props += "\t#{values.first} { #{faker} }"
+              props += "\n" unless property == @properties.last
+            end
+
+            # Format the blueprint entry
+            model_blueprint = <<-MODEL
+#{@model}.blueprint do
+#{props}
+end
+
+            MODEL
+
+            # Insert into blueprints.rb
+            insert_into_file destination_root("test", "blueprints.rb"), model_blueprint, :before => "# END blueprints"
+          else
+            say "Blueprints entry already exists for '#{@singular}'", :yellow
+          end
+
+          say "Scaffold generation for '#{name}' in app '#{app}' completed", :green
+        else
+          say "You are not at the root of a Padrino application! (config/boot.rb not found)", :red
+        end
+      end
+
+    end # Scaffold
+  end # Generators
+end # Padrino

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

@@ -0,0 +1,197 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+
+describe "Admin::<%= @controller if @controller %>Controller" do
+
+  # START NOT LOGGED IN
+  describe "when not logged in" do
+
+    # START GET index
+    describe "GET index" do
+      before do
+        get "/admin/<%= @pluralized %>"
+      end
+
+      it "should not display the <%= @pluralized %> index page" do
+        assert_not_logged_in
+      end
+    end
+    # END GET index
+
+    # START GET new
+    describe "GET new" do
+      before do
+        get "/admin/<%= @pluralized %>/new"
+      end
+
+      it "should not display the <%= @pluralized %> new page" do
+        assert_not_logged_in
+      end
+    end
+    # END GET new
+
+    # START POST create
+    describe "Post create" do
+      before do
+        post "/admin/<%= @pluralized %>/create", :<%= @singular %> => <%= @model %>.plan
+      end
+
+      it "should not return the created text" do
+        assert_not_logged_in
+      end
+    end
+    # END POST create
+
+    # START GET edit
+    describe "GET edit" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        get "/admin/<%= @pluralized %>/edit/#{@<%= @singular %>.to_param}"
+      end
+
+      it "should not display the <%= @pluralized %> edit page" do
+        assert_not_logged_in
+      end
+    end
+    # END GET edit
+
+    # START PUT update
+    describe "PUT update" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        put "/admin/<%= @pluralized %>/update/#{@<%= @singular %>.to_param}", :<%= @singular %> => <%= @model %>.plan
+      end
+
+      it "should not return the updated text" do
+        assert_not_logged_in
+      end
+    end
+    # END PUT update
+
+    # START DELETE destroy
+    describe "on DELETE destroy" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        get "/admin/<%= @pluralized %>/destroy/#{@<%= @singular %>.to_param}"
+      end
+
+      it "should not return the destroyed text" do
+        assert_destroy_not_logged_in
+      end
+    end
+    # END DELETE destroy
+
+  end
+  # END NOT LOGGED IN
+
+  # START LOGGED IN
+  describe "when logged in" do
+
+    before do
+      @account = Factory.make_admin
+      login_as_admin(@account)
+    end
+
+    # START GET index
+    describe "GET index" do
+      before do
+        get "/admin/<%= @pluralized %>"
+      end
+
+      it "should display the <%= @pluralized %> index page" do
+        assert_logged_in
+        assert_equal "/admin/<%= @pluralized %>", path
+      end
+    end
+    # END GET index
+
+    # START GET new
+    describe "GET new" do
+      before do
+        get "/admin/<%= @pluralized %>/new"
+      end
+
+      it "should display the <%= @pluralized %> new page" do
+        assert_logged_in
+        assert_equal "/admin/<%= @pluralized %>/new", path
+      end
+    end
+    # END GET new
+
+    # START POST create
+    describe "POST create" do
+      before do
+        @<%= @singular %>_count = <%= @model %>.count
+        post "/admin/<%= @pluralized %>/create", :<%= @singular %> => <%= @model %>.plan
+      end
+
+      it "should create a <%= @singular %>" do
+        assert_equal 302, status
+        assert location.include?("/admin/<%= @pluralized %>/edit/")
+        assert_equal @<%= @singular %>_count + 1, <%= @model %>.count
+      end
+    end
+    # END POST create
+
+    # START GET edit
+    describe "GET edit" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        get "/admin/<%= @pluralized %>/edit/#{@<%= @singular %>.to_param}"
+      end
+
+      it "should display the <%= @pluralized %> edit page" do
+        assert_logged_in
+        assert_equal "/admin/<%= @pluralized %>/edit/#{@<%= @singular %>.to_param}", path
+      end
+    end
+    # END GET edit
+
+    # START PUT update
+    describe "PUT update" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        @<%= @singular %>_count = <%= @model %>.count
+        @<%= @singular %>_hash = <%= @model %>.plan
+
+        key_and_value = get_key_and_value(@product)
+        if key_and_value[0] and key_and_value[1]
+          @key = key_and_value[0]
+          @value = key_and_value[1]
+          @<%= @singular %>_hash = <%= @model %>.plan(@key => @value)
+        end
+
+        put "/admin/<%= @pluralized %>/update/#{@<%= @singular %>.to_param}", :<%= @singular %> => @<%= @singular %>_hash
+
+        @updated_<%= @singular %> = <%= @model %>.find(@<%= @singular %>.to_param)
+      end
+
+      it "should update a <%= @singular %>" do
+        assert_equal status, 302
+        assert location.include?("/admin/<%= @pluralized %>/edit/#{@<%= @singular %>.to_param}")
+        assert_equal @updated_<%= @singular %>.id, @<%= @singular %>.id
+        assert_equal @<%= @singular %>_count, <%= @model %>.count
+        # Only assert if the <%= @singular %> has a key other than id or timestamps
+        assert_equal @updated_<%= @singular %>.attributes[@key], @value if @key and @value
+      end
+    end
+    # END PUT update
+
+    # START DELETE destroy
+    describe "DELETE destroy" do
+      before do
+        @<%= @singular %> = <%= @model %>.make
+        @<%= @singular %>_count = <%= @model %>.count
+        delete "/admin/<%= @pluralized %>/destroy/#{@<%= @singular %>.to_param}"
+      end
+
+      it "should destroy a <%= @singular %>" do
+        assert_equal 302, status
+        assert_equal @<%= @singular %>_count - 1, <%= @model %>.count
+      end
+    end
+    # END DELETE destroy
+
+  end
+  # END LOGGED IN
+
+end

data/lib/lazy-head-gen/templates/blueprints.rb.tt

@@ -0,0 +1,32 @@
+require 'machinist/active_record'
+require 'faker'
+
+# START blueprints
+
+Account.blueprint do
+  name { Faker::Name.first_name }
+  surname { Faker::Name.last_name }
+  email { Faker::Internet.email }
+  password { "password" }
+  password_confirmation { "password" }
+  role { "admin" }
+end
+
+
+# END blueprints
+
+# A factory which we can use to build objects which are a bit more complex or
+# which require special setup which can't be done by Machinist without a bit of
+# help.
+#
+module Factory
+  class << self
+
+    def make_admin
+      account = Account.make(:admin)
+      account.save!
+      account
+    end
+
+  end
+end

data/lib/lazy-head-gen/templates/controller.rb.tt

@@ -0,0 +1,33 @@
+<%= @app_name %>.controllers <%= ":#{@pluralized}" if @pluralized %> do
+
+  get :index do
+    render "<%= @pluralized if @pluralized %>/index"
+  end
+
+  get :show, :with => :id do
+    render "<%= @pluralized if @pluralized %>/show"
+  end
+
+<% if @create_full -%>
+  get :new do
+    render "<%= @pluralized if @pluralized %>/new"
+  end
+
+  post :create do
+    "This is the create action"
+  end
+
+  get :edit, :with => :id do
+    render "<%= @pluralized if @pluralized %>/edit"
+  end
+
+  put :update, :with => :id do
+    "This is the update action"
+  end
+
+  delete :destroy, :with => :id do
+
+  end
+
+<% end -%>
+end

data/lib/lazy-head-gen/templates/controller_test.rb.tt

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+
+describe "<%= @controller if @controller %>Controller" do
+
+  # START GET index
+  describe "GET index" do
+    before do
+      get "/<%= @pluralized %>"
+    end
+
+    it "should display the <%= @pluralized %> index page" do
+      assert_match "This is the index page", body
+    end
+  end
+  # END GET index
+
+  # START GET show
+  describe "GET show" do
+    before do
+      @<%= @singular %> = <%= @model %>.make
+      get "/<%= @pluralized %>/show/#{@<%= @singular %>.to_param}"
+    end
+
+    it "should display the <%= @pluralized %> show page" do
+      assert_match "This is the show page", body
+    end
+  end
+  # END GET show
+
+<% if @create_full -%>
+  # START GET new
+  describe "GET new" do
+    before do
+      get "/<%= @pluralized %>/new"
+    end
+
+    it "should display the <%= @pluralized %> new page" do
+      assert_match "This is the new page", body
+    end
+  end
+  # END GET new
+
+  # START POST create
+  describe "Post create" do
+    before do
+      post "/<%= @pluralized %>/create", {}
+    end
+
+    it "should return the create text" do
+      assert_match "This is the create action", last_response.body
+    end
+  end
+  # END POST create
+
+  # START GET edit
+  describe "GET edit" do
+    before do
+      @<%= @singular %> = <%= @model %>.make
+      get "/<%= @pluralized %>/edit/#{@<%= @singular %>.to_param}"
+    end
+
+    it "should display the <%= @pluralized %> edit page" do
+      assert_match "This is the edit page", body
+    end
+  end
+  # END GET edit
+
+  # START PUT update
+  describe "PUT update" do
+    before do
+      @<%= @singular %> = <%= @singular %>.make
+      put "/<%= @pluralized %>/update/#{@<%= @singular %>.to_param}", {}
+    end
+
+    it "should return the update text" do
+      assert_match "This is the update action", body
+    end
+  end
+  # END PUT update
+
+  # START DELETE destroy
+  describe "on DELETE destroy" do
+    before do
+      @<%= @singular %> = <%= @singular %>.make
+      get "/<%= @pluralized %>/destroy/#{@<%= @singular %>.to_param}"
+    end
+
+    it "should return a status of 405" do
+      assert_equal 405, status
+    end
+  end
+  # END DELETE destroy
+
+<% end -%>
+end