inline_forms 0.7.2 → 0.7.3

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/app/helpers/form_elements/associated.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:associated]=:references
+    InlineForms::SPECIAL_COLUMN_TYPES[:associated]=:references
   # associated
   def associated_show(object, attribute, values)
     #show a list of records

data/app/helpers/form_elements/check_box.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:check_box]=:boolean
+    InlineForms::SPECIAL_COLUMN_TYPES[:check_box]=:boolean
   # boolean, bit unaptly named check_box
   def check_box_show(object, attribute, values)
     values ||= { 'false' => 'no', 'true' => 'yes' }

data/app/helpers/form_elements/checklist.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:checklist]=:references
+    InlineForms::SPECIAL_COLUMN_TYPES[:checklist]=:references
   # checklist
   def checklist_show(object, attribute, values)
     out = '<ul class="checklist">'

data/app/helpers/form_elements/date.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:date_select]=:date
+    InlineForms::SPECIAL_COLUMN_TYPES[:date_select]=:date
 
   # date
   def date_select_show(object, attribute, values)

data/app/helpers/form_elements/dropdown.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-  InlineForms::SPECIAL_MIGRATION_TYPES[:dropdown]=:integer
+  InlineForms::SPECIAL_COLUMN_TYPES[:dropdown]=:belongs_to
   # dropdown
   def dropdown_show(object, attribute, values)
     attribute_value = object.send(attribute)._presentation rescue  nil

data/app/helpers/form_elements/dropdown_with_integers.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:dropdown_with_integers]=:integer
+    InlineForms::SPECIAL_COLUMN_TYPES[:dropdown_with_integers]=:integer
   # dropdown_with_integers generates a dropdown menu
   # with the given list of integers as options
   #

data/app/helpers/form_elements/dropdown_with_values.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:dropdown_with_values]=:integer
+    InlineForms::SPECIAL_COLUMN_TYPES[:dropdown_with_values]=:integer
   # dropdown_with_values
   def dropdown_with_values_show(object, attribute, values)
     unless values.is_a?(Hash)

data/app/helpers/form_elements/geo_code_curacao.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:geo_code_curacao]=:string
+    InlineForms::SPECIAL_COLUMN_TYPES[:geo_code_curacao]=:string
   # geo_code_curacao
   def geo_code_curacao_show(object, attribute, values)
     attribute_value = object.send(attribute)._presentation rescue nil

data/app/helpers/form_elements/image.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-  InlineForms::SPECIAL_MIGRATION_TYPES[:image]=:image
+  InlineForms::SPECIAL_COLUMN_TYPES[:image]=:image
   # image via paperclip
   def image_show(object, attribute, values)
     link_to_inline_image_edit object, attribute

data/app/helpers/form_elements/range.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:range]=:integer
+    InlineForms::SPECIAL_COLUMN_TYPES[:range]=:integer
   # range
   def range_show(object, attribute, values)
     link_to_inline_edit object, attribute, object.send(attribute), nil

data/app/helpers/form_elements/text_area.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-    InlineForms::SPECIAL_MIGRATION_TYPES[:text_area]=:text
+    InlineForms::SPECIAL_COLUMN_TYPES[:text_area]=:text
   # text_area
   def text_area_show(object, attribute, values)
     link_to_inline_edit object, attribute, object.send(attribute), nil

data/app/helpers/form_elements/text_field.rb

@@ -1,5 +1,5 @@
 module InlineFormsHelper
-  InlineForms::SPECIAL_MIGRATION_TYPES[:text_field]=:string
+  InlineForms::SPECIAL_COLUMN_TYPES[:text_field]=:string
   # text
   def text_field_show(object, attribute, values)
     link_to_inline_edit object, attribute, object.send(attribute), nil

data/inline_forms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{inline_forms}
-  s.version = "0.7.2"
+  s.version = "0.7.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ace Suares"]
-  s.date = %q{2011-03-07}
+  s.date = %q{2011-03-08}
   s.description = %q{Inline Forms aims to ease the setup of forms that provide inline editing. The field list can be specified in the model.}
   s.email = %q{ace@suares.an}
   s.extra_rdoc_files = [

data/lib/generators/inline_forms/inline_forms_generator.rb

@@ -1,44 +1,59 @@
 module InlineForms
+  # == Usage
+  # This generator generates a migration, a model and a controller.
+  #
+  #  rails g inline_forms Model attribute:type [attribute:type ...] [options]
+  #
+  # Read more about the possible types below.
+  #
+  # = Overriding Rails::Generators::GeneratedAttribute
+  # When using a generator in the form
+  #  rails g example_generator Modelname attribute:type attribute:type ...
+  # an array with attributes and types is created for use in the generator.
+  #
+  # Rails::Generators::GeneratedAttribute creates, among others, a field_type.
+  # This field_type maps column types to form field helpers like text_field.
+  # We override it here to make our own.
+  #
   class InlineFormsGenerator < Rails::Generators::NamedBase
-
-    Rails::Generators::GeneratedAttribute.class_eval do
-      # attributes are in the form name:type (f.i. price:integer)
-      # we want to extend the types to our list of types
-      # but some of the old types are still needed
-      # f.i. price:integer turns into a text_field
+    Rails::Generators::GeneratedAttribute.class_eval do #:doc:
+      # Deducts the column_type for migrations from the type.
+      #
+      # We first merge the Special Column Types with the Default Column Types,
+      # which has the effect that the Default Column Types with the same key override
+      # the Special Column Types.
+      #
+      # If the type is not in the merged hash, then column_type defaults to :unknown
       #
-      def migration_type
-        # convert any type into a migration type
-        # each helper adds to this list
-        # be aware that the standard list overwrites the customized list if we merge like this!
-        SPECIAL_MIGRATION_TYPES.merge(DEFAULT_MIGRATION_TYPES).merge(RELATION_TYPES).merge(SPECIAL_RELATION_TYPES)[type] || :unknown
+      # You are advised to check you migrations for the :unknown, because either you made a
+      # typo in the generator command line or you need to add a Form Element!
+      #
+      def column_type
+        SPECIAL_COLUMN_TYPES.merge(DEFAULT_COLUMN_TYPES).merge(RELATIONS)[type] || :unknown
       end
 
+      # Override the field_type to include our special column types.
+      #
+      # If a type is not in the Special Column Type hash, then the default
+      # column type hash is used, and if that fails, the field_type
+      # will be :unknown. Make sure to check your models for the :unknown.
+      #
       def field_type
-        # convert standard types to one of ours
-        SPECIAL_MIGRATION_TYPES.merge(RELATION_TYPES).merge(SPECIAL_RELATION_TYPES).has_key?(type) ? type : DEFAULT_FIELD_TYPES[type] || :unknown
+        SPECIAL_COLUMN_TYPES.merge(RELATIONS).has_key?(type) ? type : DEFAULT_COLUMN_TYPES[type] || :unknown
       end
-
-      def migration_name
-        # convert some to _id
-        ( relation? || field_type == :dropdown) ? name + '_id' : name
+      
+      def relation?
+        RELATIONS.has_key?(type) || special_relation?
       end
 
-      def belongs_to?
-        relation? || field_type == :dropdown
+      def special_relation?
+        SPECIAL_RELATIONS.has_key?(type)
       end
-      
+
       def has_many?
         field_type == :associated
       end
 
-      def relation?
-        RELATION_TYPES.has_key?(field_type)
-      end
-
-      def special_relation?
-        SPECIAL_RELATION_TYPES.has_key?(field_type)
-      end
 
     end
     argument :attributes, :type => :array,  :banner => "[name:form_element]..."
@@ -50,6 +65,48 @@ module InlineForms
     end
 
     def generate_model
+      @belongs_to         = "\n"
+      @has_many           = "\n"
+      @has_attached_files = "\n"
+      @presentation       = "\n"
+      @inline_forms_field_list = String.new
+
+      for attribute in attributes
+        if attribute.column_type == :belongs_to || attribute.type == :belongs_to
+          @belongs_to << '  belongs_to :' + attribute.name + "\n"
+        end
+        if attribute.type == :has_many
+          @has_many << '  has_many :' + attribute.name + "\n"
+        end
+        if attribute.type == :image
+          @has_attached_files << "  has_attached_file :#{attribute.name},
+               :styles => { :medium => \"300x300>\", :thumb => \"100x100>\" }\n"
+        end
+        if attribute.name == '_presentation'
+          @presentation <<  "  def _presentation\n" +
+                            "    \"#{attribute.type.to_s}\"\n" +
+                            "  end\n" +
+                            "\n"
+        end
+        unless attribute.name == '_presentation' || attribute.relation?
+          attribute.field_type == :unknown ? commenter = '#' : commenter = ' '
+          @inline_forms_field_list << commenter +
+                                      '     [ :' +
+                                      attribute.name +
+                                      ', "' + attribute.name +
+                                      '", :' + attribute.field_type.to_s +
+                                      " ], \n"
+        end
+      end
+      unless @inline_forms_field_list.empty?
+        @inline_forms_field_list =  "\n" +
+                                    "  def inline_forms_field_list\n" +
+                                    "    [\n" +
+                                    @inline_forms_field_list +
+                                    "    ]\n" +
+                                    "  end\n" +
+                                    "\n"
+      end
       template "model.erb", "app/models/#{model_file_name}.rb"
     end
 
@@ -62,6 +119,26 @@ module InlineForms
     end
 
     def generate_migration
+      @columns = String.new
+
+      for attribute in attributes
+        if attribute.column_type == :image
+          @columns << '      t.string    :' + attribute.name + "_file_name\n"
+          @columns << '        t.string    :' + attribute.name + "_content_type\n"
+          @columns << '        t.integer   :' + attribute.name + "_file_size\n"
+          @columns << '        t.datetime  :' + attribute.name + "_updated_at\n"
+        else
+          unless attribute.name == '_presentation' || attribute.special_relation?
+            attribute.field_type == :unknown ? commenter = '#' : commenter = ' '
+            @columns << commenter +
+                        '     t.' +
+                        attribute.column_type.to_s +
+                        " :" +
+                        attribute.name +
+                        " \n"
+          end
+        end
+      end
       template "migration.erb", "db/migrate/#{time_stamp}_inline_forms_create_#{table_name}.rb"
     end
 

data/lib/generators/inline_forms/templates/migration.erb

@@ -2,17 +2,7 @@ class InlineFormsCreate<%= table_name.camelize %> < ActiveRecord::Migration
 
   def self.up
     create_table :<%= table_name %> do |t|
-<% for attribute in attributes -%>
-<% if attribute.migration_type == :image -%>
-<%= '      t.string    :' + attribute.migration_name + "_file_name" %>
-<%= '      t.string    :' + attribute.migration_name + "_content_type" %>
-<%= '      t.integer   :' + attribute.migration_name + "_file_size" %>
-<%= '      t.datetime  :' + attribute.migration_name + "_updated_at" %>
-<% else -%>
-<%= ( attribute.migration_type == :unknown || attribute.special_relation? ) ? '#' : ' ' -%>
-<%= '     t.' + attribute.migration_type.to_s %> :<%= attribute.migration_name %>
-<% end -%>
-<% end -%>
+<%= @columns -%>
       t.timestamps
     end
   end

data/lib/generators/inline_forms/templates/model.erb

@@ -1,27 +1,7 @@
 class <%= name %> < ActiveRecord::Base
-
-<% for attribute in attributes -%>
-<%= '  belongs_to :' + attribute.name + "\n" if attribute.belongs_to? -%>
-<% end -%>
-<% for attribute in attributes -%>
-<%= '  has_many :' + attribute.name + "\n" if attribute.has_many? -%>
-<% end -%>
-<% for attribute in attributes -%>
-<%= "  has_attached_file :#{attribute.name}, :styles => { :medium => \"300x300>\", :thumb => \"100x100>\" }\n" if attribute.type == :image -%>
-<% end -%>
-
-  def _presentation
-<% for attribute in attributes -%>
-<%= '    "' + ( attribute.type.to_s || 'put your presentation here' ) + '"' + "\n" if attribute.name == '_presentation' -%>
-<% end -%>
-  end
-
-  def inline_forms_field_list
-    [
-<% for attribute in attributes -%>
-<%= attribute.relation? ? '#' : ' ' -%>
-<%= '     [ :' + attribute.name + ', "' + attribute.name + '", :' + attribute.field_type.to_s + " ], \n" unless attribute.name == '_presentation' -%>
-<% end -%>
-    ]
-  end
+<%= @belongs_to if @belongs_to.length > 1 -%>
+<%= @has_many if @belongs_to.length > 1 -%>
+<%= @has_attached_files if @belongs_to.length > 1 -%>
+<%= @presentation  if @belongs_to.length > 1 -%>
+<%= @inline_forms_field_list -%>
 end

data/lib/inline_forms.rb

@@ -1,8 +1,29 @@
 puts 'loading inline_forms...'
 
 module InlineForms
-  # convert type to migration_type
-  DEFAULT_MIGRATION_TYPES = {
+  # ActiveRecord::Migration comes with a set of column types.
+  # They are listed here so they can be uses alongside our Special Column Types.
+  #
+  # These types will override the Special Column Types, so don't declare
+  # types with these names as Special Column Types!
+  #
+  # Example:
+  #  rails g inline_forms Example name:string price:integer
+  # will result in:
+  #   class InlineFormsCreateExamples < ActiveRecord::Migration
+  #     def self.up
+  #       create_table :examples do |t|
+  #         t.string :name
+  #         t.integer :price
+  #         t.timestamps
+  #       end
+  #     end
+  #     def self.down
+  #       drop_table :examples
+  #     end
+  #   end
+  #
+  DEFAULT_COLUMN_TYPES = {
     :string => :string,
     :text => :text,
     :integer => :integer,
@@ -14,9 +35,26 @@ module InlineForms
     :date => :date,
     :binary => :binary,
     :boolean => :boolean,
+#    :references => :belongs_to,
+#    :belongs_to => :belongs_to,
   }
-  # convert type to field_type
-  DEFAULT_FIELD_TYPES = {
+  # For each Default Column Type, we need to specify a Form Element for use in form creation.
+  #
+  # Example:
+  #  rails g inline_forms Example name:string price:integer
+  # will result in the following model:
+  #
+  #    class Example < ActiveRecord::Base
+  #      def inline_forms_field_list
+  #        [
+  #          [ :name, "name", :text_field ],
+  #          [ :price, "price", :text_field ],
+  #        ]
+  #      end
+  #    end
+  # as you see, both :string and :integer are mapped to a :text_field
+  #
+  DEFAULT_FORM_ELEMENTS = {
     :string => :text_field,
     :text => :text_area,
     :integer => :text_field,
@@ -28,22 +66,44 @@ module InlineForms
     :date => :date_select,
     :binary => :text_field,
     :boolean => :check_box,
-
   }
-  # define this so the helpers can add to it
-  SPECIAL_MIGRATION_TYPES = {}
+  # This Hash will be used to map our Special Column Types to
+  # ActiveRecord::Migration Column Types.
+  #
+  # The helpers in app/helpers/form_elements add to this Hash.
+  #
+  # Usage example: in app/helpers/form_elements/dropdown.rb
+  #  InlineForms::SPECIAL_COLUMN_TYPES[:dropdown]=:belongs_to
+  # this maps the :dropdown form element to the :belongs_to column type.
+  #
+  # If you call the generator with country:dropdown, it will add
+  #   t.belongs_to :country
+  # to the migration. (In fact AR will add t.integer :country_id). And
+  # it will add
+  #   [ :country, "country", :dropdown ],
+  # to the model.
+  #
+  SPECIAL_COLUMN_TYPES = {}
   # experimental
-  RELATION_TYPES = {
-    :belongs_to => :integer,
+  RELATIONS = {
+    :belongs_to => :belongs_to,
+    :references => :belongs_to,
   }
-  SPECIAL_RELATION_TYPES = {
+  # experimental
+  SPECIAL_RELATIONS = {
+    :has_many   => :has_many,
     :associated => :associated,
   }
-  
+#    has_and_belongs_to_many :clients
+#	def <=>(other)
+#		self.name <=> other.name
+#  end
+
+  # Declare as a Rails::Engine, see http://www.ruby-forum.com/topic/211017#927932
   class InlineFormsEngine < Rails::Engine
     initializer 'inline_forms.helper' do |app|
       ActionView::Base.send :include, InlineFormsHelper
     end
   end
 end
-# http://www.ruby-forum.com/topic/211017#927932
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inline_forms
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 7
-  - 2
-  version: 0.7.2
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Ace Suares
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 -04:00
+date: 2011-03-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency