mack-orm 0.7.0

data/lib/mack-orm.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'genosaurus'
+
+base = File.join(File.dirname(__FILE__), "mack-orm")
+require File.join(base, "database")
+require File.join(base, "database_migrations")
+require File.join(base, "generators")
+require File.join(base, "genosaurus_helpers")
+require File.join(base, "model_column")
+require File.join(base, "orm_helpers")
+require File.join(base, "scaffold_generator", "scaffold_generator")

data/lib/mack-orm/database.rb

@@ -0,0 +1,42 @@
+module Mack
+  module Database
+    
+    # Sets up and establishes connections to the database based on the specified environment
+    # and the settings in the database.yml file.
+    def self.establish_connection(env = Mack.env)
+      raise NoMethodError.new(:establish_connection)
+    end
+    
+    # Clears connections to the database
+    def self.clear_connection(env = Mack.env)
+      raise NoMethodError.new(:clear_connection)
+    end
+    
+    # Creates a database, if it doesn't already exist for the specified environment
+    def self.create(env = Mack.env, repis = :default)
+      raise NoMethodError.new(:create)
+    end
+    
+    # Drops a database, if it exists for the specified environment
+    def self.drop(env = Mack.env, repis = :default)
+      raise NoMethodError.new(:drop)
+    end
+    
+    # Drops and then creates the database.
+    def self.recreate(env = Mack.env, repis = :default)
+      Mack::Database.drop(env, repis)
+      Mack::Database.create(env, repis)
+    end
+    
+    # Loads the structure of the given file into the database
+    def self.load_structure(file, env = Mack.env, repis = :default)
+      raise NoMethodError.new(:load_structure)
+    end
+    
+    # Dumps the structure of the database to a file.
+    def self.dump_structure(env = Mack.env, repis = :default)
+      raise NoMethodError.new(:dump_structure)
+    end
+    
+  end # Database
+end # Mack

data/lib/mack-orm/database_migrations.rb

@@ -0,0 +1,31 @@
+module Mack
+  module Database
+    module Migrations
+      
+      # Migrates the database to the latest version
+      def self.migrate
+        raise NoMethodError.new(:migrate)
+      end
+      
+      # Rolls back the database by the specified number of steps. Default is 1
+      def self.rollback(step = 1)
+        raise NoMethodError.new(:rollback)
+      end
+      
+      def self.abort_if_pending_migrations
+        raise NoMethodError.new(:abort_if_pending_migrations)
+      end
+      
+      # Returns the current version of the database
+      def self.version
+        raise NoMethodError.new(:version)
+      end
+      
+      # Returns a list of the all migration files.
+      def self.migration_files
+        Dir.glob(File.join(Mack.root, "db", "migrations", "*.rb"))
+      end
+      
+    end # Migrations
+  end # Database
+end # Mack

data/lib/mack-orm/generators.rb

@@ -0,0 +1,11 @@
+module Mack
+  module Database
+    module Generators
+      
+      def self.controller_template_location
+        raise NoMethodError.new(:controller_template_location)
+      end
+      
+    end # Generators
+  end # Database
+end # Mack

data/lib/mack-orm/genosaurus_helpers.rb

@@ -0,0 +1,40 @@
+module Mack
+  module Genosaurus # :nodoc:
+    module Orm # :nodoc:
+      module Helpers # :nodoc:
+      
+        def columns(name = param(:name))
+          ivar_cache("form_columns") do
+            cs = []
+            cols = (param(:cols) || param(:columns))
+            if cols
+              cols.split(",").each do |x|
+                cs << Mack::Genosaurus::Orm::ModelColumn.new(name, x)
+              end
+            end
+            cs
+          end
+        end
+
+        def db_directory
+          File.join(Mack.root, "db")
+        end
+      
+        def migrations_directory
+          File.join(db_directory, "migrations")
+        end
+      
+        def next_migration_number
+          last = Dir.glob(File.join(migrations_directory, "*.rb")).last
+          if last
+            return File.basename(last).match(/^\d+/).to_s.succ
+          end
+          return "001"
+        end
+      
+        ::Genosaurus.send(:include, self)
+      
+      end # Helpers
+    end # Orm
+  end # Genosaurus
+end # Mack

data/lib/mack-orm/model_column.rb

@@ -0,0 +1,50 @@
+module Mack
+  module Genosaurus # :nodoc:
+    module Orm # :nodoc:
+      # Used to represent a 'column' from the param cols or columns for generators.
+      class ModelColumn # :nodoc:
+      
+        # The name of the column.
+        attr_accessor :column_name
+        # The type of the column. Ie. string, integer, datetime, etc...
+        attr_accessor :column_type
+        # The name of the model associated with the column. Ie. user, post, etc...
+        attr_accessor :model_name
+      
+        # Takes in the model_name (user, post, etc...) and the column (username:string, body:text, etc...)
+        def initialize(model_name, column_unsplit)
+          self.model_name = model_name.singular.underscore
+          cols = column_unsplit.split(":")
+          self.column_name = cols.first#.underscore
+          self.column_type = cols.last#.underscore
+        end
+
+        # Generates the appropriate HTML form field for the type of column represented.
+        # 
+        # Examples:
+        #   Mack::Generator::ColumnObject.new("user", "username:string").form_field 
+        #     => "<%= :user.text_field :username, :label => true %>"
+        #   Mack::Generator::ColumnObject.new("Post", "body:text").form_field
+        #     => "<%= :post.text_area :body, :label => true %>"
+        def form_field
+          case self.column_type
+          when "text"
+            %{<%= :#{self.model_name}.text_area :#{self.column_name}, :label => true %>}
+          when "date"
+            %{<%= :#{self.model_name}.date_select :#{self.column_name}, :label => true %>}
+          when "date_time"
+            %{<%= :#{self.model_name}.date_time_select :#{self.column_name}, :label => true %>}
+          else
+            case self.column_name.downcase
+            when /password/
+              %{<%= :#{self.model_name}.password_field :#{self.column_name}, :label => true %>}
+            else
+              %{<%= :#{self.model_name}.text_field :#{self.column_name}, :label => true %>}
+            end
+          end
+        end
+      
+      end # ModelColumn
+    end # Orm
+  end # Generator
+end # Mack

data/lib/mack-orm/orm_helpers.rb

@@ -0,0 +1,28 @@
+module Mack
+  module ViewHelpers # :nodoc:
+    module OrmHelpers
+      
+      # DEPRECATED: Use Mack::ViewHelpers::FormHelpers text_field instead.
+      def model_text_field(model, property, options = {}) # :nodoc:
+        deprecate_method(:model_text_field, :text_field, '0.7.0')
+        m_name = model.class.to_s.underscore
+        text_field(model.class.to_s.underscore, property, options)
+      end
+      
+      # DEPRECATED: Use Mack::ViewHelpers::FormHelpers password_field instead.
+      def model_password_field(model, property, options = {}) # :nodoc:
+        deprecate_method(:model_password_field, :password_field, '0.7.0')
+        m_name = model.class.to_s.underscore
+        password_field(model.class.to_s.underscore, property, options)
+      end
+      
+      # DEPRECATED: Use Mack::ViewHelpers::FormHelpers text_area instead.
+      def model_textarea(model, property, options = {}) # :nodoc:
+        deprecate_method(:model_textarea, :text_area, '0.7.0')
+        m_name = model.class.to_s.underscore
+        text_area(model.class.to_s.underscore, property, options)
+      end
+      
+    end # OrmHelpers
+  end # ViewHelpers
+end # Mack

data/lib/mack-orm/scaffold_generator/manifest.yml

@@ -0,0 +1,31 @@
+controller_template:
+  type: file
+  template_path: <%= Mack::Database::Generators.controller_template_location %>
+  output_path: <%= File.join("app", "controllers", "#{@name_plural}_controller.rb") %>
+edit_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "app", "views", "edit.html.erb.template") %>
+  output_path: <%= File.join("app", "views", @name_plural, "edit.html.erb") %>
+index_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "app", "views", "index.html.erb.template") %>
+  output_path: <%= File.join("app", "views", @name_plural, "index.html.erb") %>
+new_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "app", "views", "new.html.erb.template") %>
+  output_path: <%= File.join("app", "views", @name_plural, "new.html.erb") %>
+show_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "app", "views", "show.html.erb.template") %>
+  output_path: <%= File.join("app", "views", @name_plural, "show.html.erb") %>
+<% if app_config.mack.testing_framework == "test_case" -%>
+functional_test_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "test", "controllers", "test_case.rb.template") %>
+  output_path: <%= File.join("test", "controllers", "#{@name_plural}_controller_test.rb") %>
+<% elsif app_config.mack.testing_framework == "rspec" -%>
+functional_test_template:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "test", "controllers", "rspec.rb.template") %>
+  output_path: <%= File.join("test", "controllers", "#{@name_plural}_controller_spec.rb") %>
+<% end -%>

data/lib/mack-orm/scaffold_generator/scaffold_generator.rb

@@ -0,0 +1,48 @@
+# Generates scaffold for Mack applications.
+# 
+# Example:
+#   rake generate:scaffold name=post
+class ScaffoldGenerator < Genosaurus
+  
+  require_param :name
+  
+  def setup # :nodoc:
+    @name_singular = param(:name).singular.underscore
+    @name_plural = param(:name).plural.underscore
+    @name_singular_camel = @name_singular.camelcase
+    @name_plural_camel = @name_plural.camelcase
+    @test_framework = app_config.mack.testing_framework
+  end
+  
+  def after_generate # :nodoc:
+    ModelGenerator.run(@options)
+    ControllerHelperGenerator.run(@options)
+    update_routes_file
+  end
+  
+  def showable_columns
+    cols = columns.reject {|c| c.column_name.downcase.match(/password/)}
+    cols
+  end
+  
+  def update_routes_file # :nodoc:
+    # update routes.rb
+    routes = File.join(Mack.root, "config", "routes.rb")
+    rf = File.open(routes).read
+    unless rf.match(".resource :#{@name_plural}")
+      puts "Updating routes.rb"
+      nrf = ""
+      rf.each do |line|
+        if line.match("Mack::Routes.build")
+          x = line.match(/\|(.+)\|/).captures
+          line << "\n  #{x}.resource :#{@name_plural} # Added by rake generate:scaffold name=#{param(:name)}\n"
+        end
+        nrf << line
+      end
+      File.open(routes, "w") do |f|
+        f.puts nrf
+      end
+    end
+  end
+  
+end

data/lib/mack-orm/scaffold_generator/templates/app/controllers/controller.rb.template

@@ -0,0 +1,51 @@
+class <%= @name_plural_camel %>Controller
+  include Mack::Controller
+  
+  # GET /<%= @name_plural %>
+  def index
+    @<%= @name_plural %> = <%= @name_singular_camel %>.all
+  end
+
+  # GET /<%= @name_plural %>/1
+  def show
+    @<%= @name_singular %> = <%= @name_singular_camel %>.get(params[:id])
+  end
+
+  # GET /<%= @name_plural %>/new
+  def new
+    @<%= @name_singular %> = <%= @name_singular_camel %>.new
+  end
+
+  # GET /<%= @name_plural %>/1/edit
+  def edit
+    @<%= @name_singular %> = <%= @name_singular_camel %>.get(params[:id])
+  end
+
+  # POST /<%= @name_plural %>
+  def create
+    @<%= @name_singular %> = <%= @name_singular_camel %>.new(params[:<%= @name_singular %>])
+    if @<%= @name_singular %>.save
+      redirect_to(<%= @name_plural %>_show_url(:id => @<%= @name_singular %>))
+    else
+      render(:action, "new")
+    end
+  end
+
+  # PUT /<%= @name_plural %>/1
+  def update
+    @<%= @name_singular %> = <%= @name_singular_camel %>.get(params[:id])
+    if @<%= @name_singular %>.update_attributes(params[:<%= @name_singular %>])
+      redirect_to(<%= @name_plural %>_show_url(:id => @<%= @name_singular %>))
+    else
+      render(:action, "edit")
+    end
+  end
+
+  # DELETE /<%= @name_plural %>/1
+  def delete
+    @<%= @name_singular %> = <%= @name_singular_camel %>.get(params[:id])
+    @<%= @name_singular %>.destroy
+    redirect_to(<%= @name_plural %>_index_url)
+  end
+
+end

data/lib/mack-orm/scaffold_generator/templates/app/views/edit.html.erb.template

@@ -0,0 +1,18 @@
+<h1>Edit <%= @name_singular.humanize.titlecase %></h1>
+
+<%%= error_messages_for :<%= @name_singular %> %>
+
+<%% form(<%= @name_singular %>s_update_url(:id => @<%= @name_singular %>), :class => "edit_<%= @name_singular %>", :id => "edit_<%= @name_singular %>", :method => :put) do %>
+<% for column in columns -%>
+<% unless column.column_name == "created_at" || column.column_name == "updated_at" -%>
+  <p>
+    <%= column.form_field %>
+  </p>
+<% end -%>
+<% end -%>
+  <p>
+    <%%= submit_button("Update") %>
+  </p>
+<%% end %>
+
+<%%= link_to("Back", <%= @name_singular %>s_index_url) %>

data/lib/mack-orm/scaffold_generator/templates/app/views/index.html.erb.template

@@ -0,0 +1,41 @@
+<h1>Listing <%= @name_plural.humanize.titlecase %></h1>
+
+<table>
+  <tr>
+<% 
+unless showable_columns.empty? 
+  showable_columns.each do |col|
+-%>
+    <th><%= col.column_name.humanize %></th>
+<% 
+  end
+else
+-%>
+    <th>&nbsp;</th>
+<% 
+end
+-%>
+  </tr>
+
+<%% for <%= @name_singular %> in @<%= @name_plural %> %>
+  <tr>
+<%
+unless showable_columns.empty? 
+  showable_columns.each do |col| -%>
+    <td><%%= <%= @name_singular %>.<%= col.column_name %> %></td>
+<%
+  end
+else
+-%>
+    <td>&nbsp;</td>
+<% end -%>
+    <td><%%= link_to("Show", <%= @name_plural %>_show_url(:id => <%= @name_singular %>)) %></td>
+    <td><%%= link_to("Edit", <%= @name_plural %>_edit_url(:id => <%= @name_singular %>)) %></td>
+    <td><%%= link_to("Delete", <%= @name_plural %>_delete_url(:id => <%= @name_singular %>), :method => :delete, :confirm => "Are you sure?") %></td>
+  </tr>
+<%% end %>
+</table>
+
+<br />
+
+<%%= link_to("New <%= @name_singular_camel %>", <%= @name_plural %>_new_url) %>

data/lib/mack-orm/scaffold_generator/templates/app/views/new.html.erb.template

@@ -0,0 +1,18 @@
+<h1>New <%= @name_singular.humanize.titlecase %></h1>
+
+<%%= error_messages_for :<%= @name_singular %> %>
+
+<%% form(<%= @name_singular %>s_create_url, :class => "new_<%= @name_singular %>", :id => "new_<%= @name_singular %>") do %>
+<% for column in columns -%>
+<% unless column.column_name == "created_at" || column.column_name == "updated_at" -%>
+  <p>
+    <%= column.form_field %>
+  </p>
+<% end -%>
+<% end -%>
+  <p>
+    <%%= submit_button("Create") %>
+  </p>
+<%% end %>
+
+<%%= link_to("Back", <%= @name_singular %>s_index_url) %>

data/lib/mack-orm/scaffold_generator/templates/app/views/show.html.erb.template

@@ -0,0 +1,12 @@
+<p>
+  <h1><%= @name_singular.humanize.titlecase %></h1>
+</p>
+<% for column in showable_columns -%>
+<p>
+  <%%= :<%= @name_singular %>.label_tag :<%= column.column_name %> %>
+  <%%= @<%= @name_singular %>.<%= column.column_name %> %>
+</p>
+<% end -%>
+
+<%%= link_to("Edit", <%= @name_plural %>_edit_url(:id => @<%= @name_singular %>)) %> |
+<%%= link_to("Back", <%= @name_plural %>_index_url) %>