rughetto-rear_views 0.0.2

data/Generators

@@ -0,0 +1,3 @@
+scope 'merb-gen' do
+  Merb.add_generators( File.join( File.dirname(__FILE__), 'lib', 'generators', 'rear_views_generator' ) )
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rue The Ghetto
+
+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

@@ -0,0 +1,48 @@
+rear_views
+==========
+
+A plugin for the Merb framework that provides modular REST views for a resource. That way complex views and forms can be easily built from highly conventioned parts. Currently this only supports the ActiveRecord ORM with ERB templates. Chip in and add some others if you think this a laudable project.
+
+
+Motivation
+
+So, what's wrong with the existing views. Other than the fact that Merb's generators don't actually add any code related to a model's attributes (which can slow a person down), there is a bigger modularity issue. When you are working with complex views and forms, a little _more_ convention over configuration goes a long way. When you have little partials to build into the views of association models, things are much easier.
+
+This plugin breaks the standard views into some additional partials that make it really easy to build complex views using convention. It also, does this ass-backwards to the Merb/Rails way, allowing you to build your schema and relationships first. After the schema is established, you can scaffold your views. 
+
+
+Install It:
+
+  1. Add the gem to your dependency.rb file (and thor:gem:install in into your project) 
+       dependency "rughetto-merb_rear_views", :require_as => "rear_views"
+  2. Do the command line merb-gen thing, with your model name as the only argument
+       merb-gen rear_views User
+
+
+What It Does:
+
+Using it will build the following view files in the usual place:
+     _form.html.erb
+     _full_view.html.erb
+     _list_view.html.erb
+     delete.html.erb
+     edit.html.erb
+     index.html.erb
+     new.html.erb
+     show.html.erb
+
+The _form partial is included in both the new and edit templates. It only includes the fields and not the form tags. That means that if you are building a form for a related model you can grab this partial and use it whole hog in a fields_for block. How much easier is that!   
+
+The _full_view and _list_view partials offer the same modular flexibility. The only caveat is that there is no guess work about what fields might be relevant for the list view. So you have to fix this one up yourself.
+
+
+Warings
+
+This isn't quite production ready and may be irrelevant since Merb is going away. 
+Known issues:
+  * merb-gen doesn't load the app prior to running the generators. Currently there is a hack that connects the database and loads the classes, but dependencies in the models won't currently be loaded unless explicitly declared in the file. I am still experimenting with how best to do this. 
+  * Only supports AR with ERB.
+  
+Future Work
+
+I put this together to DRY up the repetitive work that I do building applications with more complex data relations/interfaces. Rails has better support for scaffolding out your views, but it doesn't have these micro-partial conventions for building your views faster. When Rails and Merb merge, I will make sure to bring this along too ... unless I am really busy or just generally distracted.  

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+require 'spec/rake/spectask'
+
+GEM_NAME = "rear_views"
+GEM_VERSION = "0.0.2"
+AUTHOR = "Rue The Ghetto"
+EMAIL = "ru_ghetto@rubyghetto.com"
+HOMEPAGE = "http://github.com/rughetto/rear_views"
+SUMMARY = "Generators REST views for a resource, so that complex views and forms can be easily built. Currently only AR introspection and ERB templates."
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-core')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO Generators) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|bccwin|cygwin/) rescue nil
+SUDO = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+desc "Install #{GEM_NAME}"
+if WIN32
+  task :install => :gem do
+    system %{gem install --no-rdoc --no-ri -l pkg/#{GEM_NAME}-#{GEM_VERSION}.gem}
+  end
+  namespace :dev do
+    desc 'Install for development (for windows)'
+    task :winstall => :gem do
+      warn "You can now call 'rake install' instead of 'rake dev:winstall'."
+      system %{gem install --no-rdoc --no-ri -l pkg/#{GEM_NAME}-#{GEM_VERSION}.gem}
+    end
+  end
+else
+  task :install => :package do
+    sh %{#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION}.gem}
+  end
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+Spec::Rake::SpecTask.new do |t|
+   t.warning = true
+   t.spec_opts = ["--format", "specdoc", "--colour"]
+   t.spec_files = Dir['spec/**/*_spec.rb'].sort   
+end

data/TODO

@@ -0,0 +1,3 @@
+TODO:
+
+Test in the wild!

data/lib/generators/rear_views_generator.rb

@@ -0,0 +1,78 @@
+require 'merb_activerecord'
+require 'activerecord'
+
+module Merb::Generators
+  class RearViewsGenerator < NamespacedGenerator
+    
+    def self.source_root
+      File.dirname(__FILE__) / 'templates'
+    end
+    
+    desc <<-DESC
+      Generators modular REST views for a resource, so that complex views and forms can be easily built
+    DESC
+    
+    first_argument  :name, :required => true, :desc => "model name"
+    
+    # all the view templates
+    [:index, :show, :edit, :new, :delete, :_form, :_list_view, :_full_view ].each do |view|
+      template "#{view}".to_sym do |template|
+        template.source = "%file_name%/#{view}.html.erb"
+        template.destination = "app/views" / base_path / "#{file_name.pluralize}/#{view}.html.erb"
+      end
+    end
+    
+    # methods available to the views ---------------
+    def klass
+      if @klass.blank?
+        begin 
+          Object.full_const_get( class_name ) # only works for testing
+        rescue 
+          # for regular merb-gen use the database has not yet connected, so ...
+          Merb::Config.session_stores = []
+          Merb::Orms::ActiveRecord::Connect.run unless Merb.disabled? :initfile
+          # also the model classes haven't been loaded ...
+          Merb::BootLoader::LoadClasses.run
+        end    
+        @klass ||= Object.full_const_get( class_name )
+      end
+      @klass  
+    end  
+    
+    def columns
+      if @columns.blank?
+        @columns ||= {}
+        klass.columns.each do |col|
+          @columns[col.name] = col.type unless ['id', 'created_at', 'updated_at'].include? col.name
+        end 
+      end 
+      @columns 
+    end
+    
+    def relationships
+      @relationships ||= klass.reflections.keys
+    end   
+    
+    def singular_name
+      symbol_name.singularize
+    end  
+    
+    def plural_name
+      singular_name.pluralize
+    end  
+    
+    def instance_var
+      "@#{singular_name}"
+    end  
+    
+    def resource_sym
+      ":#{singular_name}"
+    end  
+    
+    def resources_sym
+      ":#{symbol_name}"
+    end  
+  end
+
+  add :rear_views, RearViewsGenerator
+end

data/lib/generators/templates/%file_name%/_form.html.erb

@@ -0,0 +1,28 @@
+<% 
+  columns.each do |key, val| -%>
+    <%  key = key.to_s
+        val = val.to_sym
+        if key.match(/_id$/)
+    %>
+      <%%= select :<%= key %>, 
+                  :collection => <%= key.classify %>.all,
+                  :text_method => :id, # change this to something appropriate for the model
+                  :value_method => :id,
+                  :selected => <%= instance_var %>.<%= key %>.to_s,
+                  :label => <%= key.humanize %>   %>
+  <%                
+    elsif val == :text
+  -%>    
+      <%%= text_area :<%= key %>,  :label => <%= key.humanize %> %>
+  <%   
+    elsif val == :boolean
+  -%>   
+      <%%= check_box :<%= key %>, :label => <%= key.humanize %> %>
+  <%  
+    else
+  -%>   
+      <%%= text_field :<%= key %>, :label => <%= key.humanize %>  %> 
+  <%  
+    end 
+  end 
+-%>

data/lib/generators/templates/%file_name%/_full_view.html.erb

@@ -0,0 +1,7 @@
+<h1><%= class_name.humanize %> - #<%%= <%= instance_var %>.id %></h1>
+<% columns.each do |key, val| -%>
+<p>
+  <b><%= key %></b>: 
+  <%%= <%= instance_var %>.<%= key %> %>
+</p>
+<% end -%>  

data/lib/generators/templates/%file_name%/_list_view.html.erb

@@ -0,0 +1,2 @@
+<h4><%= class_name.humanize %> - #<%%= <%= instance_var %>.id %></h4>
+<p>Pull out your list view attributes and put them here: /app/views/<%= symbol_name %>/<%= file_name %>.html.erb</p>

data/lib/generators/templates/%file_name%/delete.html.erb

@@ -0,0 +1,4 @@
+<h1>Destroy This Record?</h1>
+<%%= form_tag <%= instance_var %>, resource(<%= resource_sym %>, <%= instance_var %>, :destroy) do %>
+  <%%= submit 'Delete Record' %>
+<%% end =%>

data/lib/generators/templates/%file_name%/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Edit <%= class_name %></h1>
+
+<%%= form_tag <%= instance_var %>, resource(<%= resources_sym %>, <%= instance_var %>) do %>
+  <%%= partial :form %>
+  <%%= submit 'Save' %>
+<%% end =%>

data/lib/generators/templates/%file_name%/index.html.erb

@@ -0,0 +1,7 @@
+<h1><%= class_name.pluralize.humanize %></h1>
+
+<ul>
+  <%% for <%= instance_var %> in @<%= plural_name %> -%>
+    <li><%%= partial :list_view %></li>
+  <%% end -%>  
+</ul>

data/lib/generators/templates/%file_name%/new.html.erb

@@ -0,0 +1,16 @@
+<h1>New <%= class_name %></h1>
+
+<%%= form_tag <%= instance_var %>, resource(<%= resource_sym %>, :new) do %>
+  <%%= partial :form %>
+  <p>Complexify your forms by adding a field_set:
+    <pre>
+      &lt;% @resource_relationship = <%= instance_var %>.resource_relationship -%&gt;
+      &lt;%= fields_for @resource_relationship do %&gt;
+        &lt;%= hidden_field :<%= singular_name %>_id, :value => <%= instance_var %>.id %&gt;
+        &lt;%= partial 'resource_relationship/form' %&gt;
+      &lt;% end =%&gt;
+    </pre>
+  </p>
+  <%%= submit 'Create' %>
+<%% end =%>
+ 

data/lib/generators/templates/%file_name%/show.html.erb

@@ -0,0 +1,3 @@
+<h1>Show <%= class_name.humanize %></h1>
+
+<%%= partial :full_view %>

data/lib/rear_views.rb

@@ -0,0 +1,12 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  Merb::BootLoader.before_app_loads do
+  end
+  
+  Merb::BootLoader.after_app_loads do
+  end
+  
+  generators = File.join(File.dirname(__FILE__), 'generators')
+  Merb.add_generators( generators / 'rear_views_generator')
+end

data/spec/console

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# This script was inspired by one written by Erik Kastner, 
+# and a blog describing it's needs and usage can be found at 
+# http://metaatem.net/2007/04/20/fun-with-active_record-and-sqlite3
+# 
+# It can be used for hands on quick and dirty testing to see how the library 
+# is working in the IRB console. It will open an IRB console with
+# with a Templater::Generator object instantiated: @generator. 
+# You can render a template in the console to see what is going on.
+#   @user_gen.invoke! 
+#
+# This file must be executable to work: [sudo] chmod 775 spec/console
+#
+
+require 'rubygems'
+require 'merb-core'
+require 'merb-gen'
+require 'templater/spec/helpers'
+require 'activerecord'
+require 'irb'
+
+Merb.disable(:initfile)
+
+require File.dirname(__FILE__) + '/../lib/generators/rear_views_generator'
+require File.dirname(__FILE__) + "/database_setup"
+include DatabaseSetup
+
+
+@user_gen = Merb::Generators::RearViewsGenerator.new( 'spec/tmp', {}, 'User' )
+@project_gen = Merb::Generators::RearViewsGenerator.new( 'spec/tmp', {}, 'Project' )
+@task_gen = Merb::Generators::RearViewsGenerator.new( 'spec/tmp', {}, 'Task' )
+
+
+# start the conole with these variables
+IRB.start if __FILE__ == $0

data/spec/database_setup.rb

@@ -0,0 +1,52 @@
+module DatabaseSetup
+  database_name = 'rear_views.db'
+  
+  # remove the old database 
+  File.delete(database_name)  if File.file?(database_name)
+
+  # grab the files
+  $TESTING = true unless defined?($TESTING) && $TESTING == true
+  require File.dirname(__FILE__) + '/../lib/generators/rear_views_generator'
+  
+  # establish a connection to the sqlite database
+  ActiveRecord::Base.establish_connection(
+    :adapter =>   'sqlite3',
+    :database =>  database_name
+  )
+
+  # define a schema
+  ActiveRecord::Schema.define do
+    create_table :users, :force => true do |t|
+      t.column :username,       :string
+      t.column :hobbies,        :text
+      t.column :birthday,       :date
+      t.column :admin,          :boolean
+    end
+    
+    create_table :project, :force => true do |t|
+      t.column  :user_id, :integer
+      t.column  :name,    :string
+      t.column  :description, :text
+    end  
+    
+    create_table :tasks, :force => true do |t|
+      t.column :project_id, :integer
+      t.column :name, :string
+      t.column :description, :text
+    end  
+  end
+
+  # Related classes
+  class User < ActiveRecord::Base
+    has_many :projects
+  end  
+  
+  class Project < ActiveRecord::Base
+    belongs_to :user
+    has_many :tasks
+  end  
+  
+  class Taks < ActiveRecord::Base
+    belongs_to :project
+  end  
+end

data/spec/rear_views_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rubygems'
+require 'merb-core'
+require 'merb-gen'
+require 'templater/spec/helpers'
+require 'activerecord'
+
+Merb.disable(:initfile)
+Spec::Runner.configure do |config|
+  config.include Templater::Spec::Helpers
+end
+
+require File.dirname(__FILE__) + '/../lib/generators/rear_views_generator'
+require File.dirname(__FILE__) + "/database_setup"
+include DatabaseSetup
+
+describe "rear_views" do
+  before(:all) do
+    @path = "tmp"
+  end  
+  
+  
+  describe 'test setup' do
+    it "should have all dependencies and rake tasks needed to run" do
+      true.should == true
+    end
+    
+    it 'should be able to instantiate a RearViewGenerator' do
+      lambda do
+        Merb::Generators::RearViewsGenerator.new( @path, {}, 'Test' )
+      end.should_not raise_error  
+    end  
+  end  
+  
+  describe 'inclusion in merb-gen' do
+    
+    
+  end  
+  
+  describe 'file generation' do
+    before(:all) do
+      @generator = Merb::Generators::RearViewsGenerator.new( 'spec/tmp', {}, 'User' )
+    end 
+    
+    it "should create views when invoke! is called" do
+      @generator.invoke!
+      File.exists?("tmp/app/views/users/_form.html.erb")
+      File.exists?("tmp/app/views/users/_full_view.html.erb")
+      File.exists?("tmp/app/views/users/_list_view.html.erb")
+      File.exists?("tmp/app/views/users/delete.html.erb")
+      File.exists?("tmp/app/views/users/edit.html.erb")
+      File.exists?("tmp/app/views/users/index.html.erb")
+      File.exists?("tmp/app/views/users/new.html.erb")
+      File.exists?("tmp/app/views/users/show.html.erb")
+    end
+     
+  end  
+   
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

data/spec/test_templates/test.html.erb

@@ -0,0 +1 @@
+yup! it works!

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: rughetto-rear_views
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Rue The Ghetto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Generators REST views for a resource, so that complex views and forms can be easily built. Currently only AR introspection and ERB templates.
+email: ru_ghetto@rubyghetto.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- Generators
+- lib/generators
+- lib/generators/rear_views_generator.rb
+- lib/generators/templates
+- lib/generators/templates/%file_name%
+- lib/generators/templates/%file_name%/_form.html.erb
+- lib/generators/templates/%file_name%/_full_view.html.erb
+- lib/generators/templates/%file_name%/_list_view.html.erb
+- lib/generators/templates/%file_name%/delete.html.erb
+- lib/generators/templates/%file_name%/edit.html.erb
+- lib/generators/templates/%file_name%/index.html.erb
+- lib/generators/templates/%file_name%/new.html.erb
+- lib/generators/templates/%file_name%/show.html.erb
+- lib/rear_views.rb
+- spec/console
+- spec/database_setup.rb
+- spec/rear_views_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/test_templates
+- spec/test_templates/test.html.erb
+- spec/tmp
+- spec/tmp/app
+- spec/tmp/app/views
+- spec/tmp/app/views/user
+- spec/tmp/app/views/user/_form.html.erb
+- spec/tmp/app/views/user/_full_view.html.erb
+- spec/tmp/app/views/user/_list_view.html.erb
+- spec/tmp/app/views/user/delete.html.erb
+- spec/tmp/app/views/user/edit.html.erb
+- spec/tmp/app/views/user/index.html.erb
+- spec/tmp/app/views/user/new.html.erb
+- spec/tmp/app/views/user/show.html.erb
+has_rdoc: true
+homepage: http://github.com/rughetto/rear_views
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generators REST views for a resource, so that complex views and forms can be easily built. Currently only AR introspection and ERB templates.
+test_files: []
+