formgen 0.1.0 → 0.2.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Charlie
+Copyright (c) 2011 Pullmonkey
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,23 +1,29 @@
 = formgen
 
-rails g skizmo:form --help
+  rails g skizmo:form --help
+
 === Usage:
   rails generate skizmo:form NAME [options]
 
 === Options:
-  [--javascript]  # Indicates when to generate javascript
-                  # Default: true
-  [--helpers]     # Indicates when to generate helpers
-                  # Default: true
+  [--helpers]       # Indicates when to generate helpers
+                    # Default: true
+  [--javascript]    # Indicates when to generate javascript
+                    # Default: true
+  [--select-boxes]  # Indicates when to generate select boxes
+                    # Default: true
 
 === Runtime options:
-  -p, [--pretend]  # Run but do not make any changes
+  -f, [--force]    # Overwrite files that already exist
   -s, [--skip]     # Skip files that already exist
   -q, [--quiet]    # Supress status output
-  -f, [--force]    # Overwrite files that already exist
+  -p, [--pretend]  # Run but do not make any changes
 
 === Description:
-    Generates a form per usual but with fields_for for the has_many and belongs_to associations.
+    Generates a form per usual but with fields_for for the has_many and belongs_to associations that are 
+    "accepted_nested_attributes".  If the fields are not accepted nested attributes, then they are 
+    selectable options, multi-select for has_many and single select for belongs_to.  'has_attached_file' 
+    will trigger the file_field input and create a multipart form.
 
 === Example:
     rails generate skizmo:form Foo
@@ -29,11 +35,14 @@ rails g skizmo:form --help
 
         accepts_nested_attributes_for :bars
         accepts_nested_attributes_for :baz
+
+        has_attached_file :image
       end
 
     This will create:
       public/javascripts/jquery.add_remove_links.js
       app/helpers/add_remove_links_helper.rb
+      app/helpers/foo_setup_helper.rb
       app/views/foos/new.html.erb
       app/views/foos/edit.html.erb
       app/views/foos/_form.html.erb
@@ -41,6 +50,15 @@ rails g skizmo:form --help
       app/views/foos/_baz_fields.html.erb
 
 
+== FAQ
+
+* I'm getting this error:
+  
+  undefined method `setup_something' for #<#<Class:
+
+Make sure the generated helper is being loaded - restart your rails server.
+
+
 == Contributing to formgen
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/formgen.gemspec

@@ -5,16 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{formgen}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pullmonkey"]
-  s.date = %q{2011-11-15}
+  s.date = %q{2011-11-16}
   s.description = %q{Ruby on Rails form generator based on has_many and belongs_to associations.  Includes the helpers and javascript for adding and removing fields_for form attributes.}
   s.email = %q{info@skizmo.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README",
     "README.rdoc"
   ]
   s.files = [
@@ -22,7 +21,6 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README",
     "README.rdoc",
     "Rakefile",
     "VERSION",
@@ -36,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/generators/skizmo/form/templates/helper.rb",
     "lib/generators/skizmo/form/templates/javascript.js",
     "lib/generators/skizmo/form/templates/new.html.erb",
+    "lib/generators/skizmo/form/templates/setup_helper.rb",
     "test/helper.rb",
     "test/test_formgen.rb"
   ]

data/lib/generators/skizmo/form/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Generates a form per usual but with fields_for for the has_many and belongs_to associations.
+    Generates a form per usual but with fields_for for the has_many and belongs_to associations that are "accepted_nested_attributes".  If the fields are not accepted nested attributes, then they are selectable options, multi-select for has_many and single select for belongs_to.  'has_attached_file' will trigger the file_field input and create a multipart form.
 
 Example:
     rails generate skizmo:form Foo
@@ -11,11 +11,14 @@ Example:
 
         accepts_nested_attributes_for :bars
         accepts_nested_attributes_for :baz
+
+        has_attached_file :image
       end
 
     This will create:
       public/javascripts/jquery.add_remove_links.js
       app/helpers/add_remove_links_helper.rb
+      app/helpers/foo_setup_helper.rb
       app/views/foos/new.html.erb
       app/views/foos/edit.html.erb
       app/views/foos/_form.html.erb

data/lib/generators/skizmo/form/form_generator.rb

@@ -6,15 +6,21 @@ module Skizmo
       class_option :javascript, :type => :boolean, :default => true, 
         :description => "Include javascript to add and remove associated attributes if there are has_many associations"
       class_option :helpers, :type => :boolean, :default => true, 
-        :description => "Update helpers to add link_to_add and link_to_remove methods if there are has_many associations"
+        :description => "Update helpers to add link_to_add and link_to_remove methods if there are has_many associations, as well as a setup method for building objects required for nested attribute associations and for building selectable lists for select boxes"
+      class_option :select_boxes, :type => :boolean, :default => true, 
+        :description => "Generates select box selections for belongs_to and has_many associations that are not accepted as nested_attributes"
         
       def generate_form  
         unless nested_has_many_classes.empty?
           copy_file "javascript.js", "public/javascripts/jquery.add_remove_links.js" if options.javascript?  
           copy_file "helper.rb", "app/helpers/add_remove_links_helper.rb" if options.helpers?  
         end
+        unless nested_classes_with_attributes.empty?
+          template "setup_helper.rb", "app/helpers/#{file_name}_setup_helper.rb" if options.helpers?  
+        end
         template "new.html.erb", "app/views/#{file_name.pluralize}/new.html.erb"  
         template "edit.html.erb", "app/views/#{file_name.pluralize}/edit.html.erb"  
+        @have_attachment_string = have_attachments? ? ", :html => { :multipart => true }" : ""
         template "_form.html.erb", "app/views/#{file_name.pluralize}/_form.html.erb"  
         nested_classes_with_attributes.each do |hash_with_kls_and_attrs|
           @kls   = hash_with_kls_and_attrs[:kls]    # class object
@@ -28,22 +34,40 @@ module Skizmo
       private  
 
       def file_name
-        name.underscore  
+        cls_underscore
       end  
 
       def cls
-        name.classify.constantize
+        cls_classname.constantize
       end
 
+      def cls_classname
+        name.classify.to_s
+      end
+      
+      def cls_underscore
+        name.to_s.underscore 
+      end
+
+      # Base this on has_attached_file
       def attributes_worth_using_in_the_form(options={})
         kls = options[:class] || cls
         rejects = ["created_at","updated_at","created_on","updated_on","id",/_id$/]
-        kls.column_names.reject do |x| 
-          rejects.include?(x) || !rejects.select{|y| y.is_a?(Regexp) and x =~ y}.empty?
+        # consolidate x_file_name, x_content_type and x_file_size to just x
+        attachment_endings = ["_file_name", "_content_type", "_file_size", "_updated_at"]
+        attachments = attachments_for(kls) || []
+        attachment_rejects = attachment_endings.map{|x| attachments.map{|y| y.to_s + x.to_s}}.flatten.uniq
+        attrs_for_form = kls.column_names.reject do |x| 
+          rejects.include?(x) || !rejects.select{|y| y.is_a?(Regexp) and x =~ y}.empty? ||
+          attachment_rejects.include?(x)
         end
+        attrs_for_form | attachments
       end
      
+      # Base this on has_attached_file
       def attr_form_method(kls, attr)
+        # consolidate x_file_name, x_content_type and x_file_size to just x and use file_field
+        return :file_field if atts = attachments_for(kls) and atts.include?(attr)
         case kls.columns.find{|c| c.name == attr}.try(:type)
         when :string, :integer, :float, :decimal, :datetime, :timestamp, :time, :date
           # using text fields for the date selectors b/c most people will use a js calendar
@@ -56,14 +80,31 @@ module Skizmo
           return :text_field
         end
       end
+
+      def attachments_for(kls)
+        if atts = kls.try(:attachment_definitions)
+          return atts.keys
+        else
+          return nil
+        end
+      end
       
+      def have_attachments?
+        (has_many_classes | belongs_to_classes).each do |kls|
+          return true if attachments_for(kls.to_s.classify.constantize)
+        end
+        return false
+      end
+
+      def nested_attributes
+        cls.nested_attributes_options.keys
+      end
+
       def class_reflections
         cls.reflections
       end
 
-      # TODO only get the classes that have "nested attributes"
-
-      def nested_has_many_classes
+      def has_many_classes
         has_many_through_associations = class_reflections.select{|k,v| v.macro == :has_many and v.options.has_key?(:through)}
         through_assocs = has_many_through_associations.map{|x| x.last.options[:through]}
         # we don't care about the associations that primarily exist to assist the has_many :through
@@ -73,10 +114,28 @@ module Skizmo
         # these are the keys of the reflections we care about 
         (has_many_through_associations | has_many_associations).map(&:first)
       end
+
+      # only get the classes that have "nested attributes"
+      def nested_has_many_classes
+        has_many_classes.select{|k| nested_attributes.include?(k)}
+      end
       
-      def nested_belongs_to_classes
+      def non_nested_has_many_classes
+        has_many_classes.select{|k| !nested_attributes.include?(k)}
+      end
+      
+      def belongs_to_classes
         class_reflections.select{|k,v| v.macro == :belongs_to}.map(&:first)
       end
+      
+      # only get the classes that have "nested attributes"
+      def nested_belongs_to_classes
+        belongs_to_classes.select{|k| nested_attributes.include?(k)}
+      end
+      
+      def non_nested_belongs_to_classes
+        belongs_to_classes.select{|k| !nested_attributes.include?(k)}
+      end
 
       def nested_classes
         {:belongs_to => nested_belongs_to_classes, :has_many => nested_has_many_classes}
@@ -93,7 +152,6 @@ module Skizmo
         end
         to_return
       end
-
     end  
   end
 end

data/lib/generators/skizmo/form/templates/_form.html.erb

@@ -1,4 +1,8 @@
-<%%= form_for @<%= cls.to_s.underscore %> do |f| %>
+<% if options.helpers? -%>
+<%%= form_for setup_<%= cls_underscore %>(@<%= cls.to_s.underscore %>)<%= @have_attachment_string %> do |f| %>
+<% else -%>
+<%%= form_for @<%= cls.to_s.underscore %><%= @have_attachment_string %> do |f| %>
+<% end -%>
   <%% if @<%= cls.to_s.underscore %>.errors.any? %>  
     <div id="errorExplanation">  
       <h2><%%= pluralize(@<%= cls.to_s.underscore %>.errors.count, "error") %> prohibited this <%= cls.to_s.underscore.gsub("_"," ") %> from being saved:</h2>  
@@ -15,6 +19,20 @@
     <%%= f.<%= attr_form_method(cls, att) %> :<%= att %> %>
   </div>
 <% end -%>
+<% if options.select_boxes? -%>
+<% non_nested_belongs_to_classes.each do |cls_name| -%>
+  <div class="field">
+    <%%= f.label :<%= cls_name %>_id, "<%= cls_name.to_s.underscore.gsub("_", " ").camelize %>" %>
+    <%%= f.select :<%= cls_name %>_id, build_select_list(:<%= cls_name %>), {:prompt => "Please select one"} %>
+  </div>
+<% end -%>
+<% non_nested_has_many_classes.each do |cls_name| -%>
+  <div class="field">
+    <%%= f.label :<%= cls_name.to_s.singularize %>_ids, "<%= cls_name.to_s.underscore.gsub("_", " ").camelize %>" %>
+    <%%= f.select :<%= cls_name.to_s.singularize %>_ids, build_select_list(:<%= cls_name %>), {:prompt => "Please select"}, {:multiple => true, :size => 4} %>
+  </div>
+<% end -%>
+<% end -%>
 <% nested_belongs_to_classes.each do |cls_name| -%>
   <%%= f.fields_for :<%= cls_name %> do |nf| %>
     <%%= render '<%= cls_name.to_s.singularize.underscore %>_fields', :f => nf %>

data/lib/generators/skizmo/form/templates/setup_helper.rb

@@ -0,0 +1,25 @@
+module <%= cls_classname %>SetupHelper
+  def setup_<%= cls_underscore %>(obj)
+    <% nested_belongs_to_classes.each do |cls_name| -%>
+    obj.build_<%= cls_name %> if obj.<%= cls_name %>.blank?
+    <% end -%>
+    <% nested_has_many_classes.each do |cls_name| -%>
+    obj.<%= cls_name %>.build if obj.<%= cls_name %>.empty?
+    <% end -%>
+    return obj
+  end
+
+<% if options.select_boxes? -%>
+  def build_select_list(assoc, options={})
+    name  = options[:name]  || "name"
+    scope = options[:scope] || "all"
+    begin
+      # name and id associations
+      assoc.to_s.classify.constantize.send(scope).map{|a| [a.send(name), a.id]}
+    rescue
+      # use id for text and value
+      assoc.to_s.classify.constantize.send(scope).map(&:id)
+    end
+  end
+<% end -%>
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: formgen
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pullmonkey
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-15 00:00:00 -07:00
+date: 2011-11-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,14 +86,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README
 - README.rdoc
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README
 - README.rdoc
 - Rakefile
 - VERSION
@@ -107,6 +105,7 @@ files:
 - lib/generators/skizmo/form/templates/helper.rb
 - lib/generators/skizmo/form/templates/javascript.js
 - lib/generators/skizmo/form/templates/new.html.erb
+- lib/generators/skizmo/form/templates/setup_helper.rb
 - test/helper.rb
 - test/test_formgen.rb
 has_rdoc: true

data/README

@@ -1,40 +0,0 @@
-rails g skizmo:form --help
-Usage:
-  rails generate skizmo:form NAME [options]
-
-Options:
-  [--javascript]  # Indicates when to generate javascript
-                  # Default: true
-  [--helpers]     # Indicates when to generate helpers
-                  # Default: true
-
-Runtime options:
-  -p, [--pretend]  # Run but do not make any changes
-  -s, [--skip]     # Skip files that already exist
-  -q, [--quiet]    # Supress status output
-  -f, [--force]    # Overwrite files that already exist
-
-Description:
-    Generates a form per usual but with fields_for for the has_many and belongs_to associations.
-
-Example:
-    rails generate skizmo:form Foo
-
-    With Foo.rb (model like this):
-      class Foo < ActiveRecord::Base
-        has_many :bars
-        belongs_to :baz
-
-        accepts_nested_attributes_for :bars
-        accepts_nested_attributes_for :baz
-      end
-
-    This will create:
-      public/javascripts/jquery.add_remove_links.js
-      app/helpers/add_remove_links_helper.rb
-      app/views/foos/new.html.erb
-      app/views/foos/edit.html.erb
-      app/views/foos/_form.html.erb
-      app/views/foos/_bar_fields.html.erb
-      app/views/foos/_baz_fields.html.erb
-