autoforme 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d88ff8420554c8c3bb3ae01e69dfaa2d5a10fd9
-  data.tar.gz: 10dfb64d13724c261f2c88f7fa17747cb63ae134
+  metadata.gz: 728834eb84059f820d99421609b8f274868fa06f
+  data.tar.gz: 497582c00ccd77bcb14f716ae5596d32210ae33e
 SHA512:
-  metadata.gz: d05a1e0e558f7a6c996f3d41b87daef5fc550cba51a351f5a207b7fb506511b92bd945e313867ce654d0b08b4d4b0f16755f1062a3444cd0a3dc2b05a2381064
-  data.tar.gz: e43029905a7593fa791ea08483d6b73bce4428c5b09f6e3fa669edbc3716298f173ec9a95a5667106c9477b56321eeeb5f34010a686d7a59aa27d6baa64974db
+  metadata.gz: e71852cb6b1b049123b388d944789f8678b392724d299d776cd9ea43dd5ef3f6230d81135e11d6589a0610feb957e2838a1a3fd83181676f146089ec8832b837
+  data.tar.gz: ed0cecfc641fccdd7e1337421c3fdab68d38f4b1cbddbb470744924ffde7e9d35ab5e0c6b8205df8908bea8630a12ce392b9846fadb9f76166e0149495fe16cd

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 1.1.0 (2015-03-23)
+
+* Add Framework#register_by_name to allow autoforme to work better when using code reloading in development (jeremyevans)
+
 === 1.0.3 (2015-01-27)
 
 * Fix homepage in gemspec (jeremyevans)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jeremy Evans
+Copyright (c) 2013-2015 Jeremy Evans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README.rdoc

@@ -55,8 +55,8 @@ for Sinatra:
   end
 
 Let's break down how this works.  You setup AutoForme using <tt>AutoForme.for</tt>,
-which takes 2 arguments, the controller type symbol (currently either :sinatra or :rails),
-and the controller class (either a Sinatra::Base or ActionController::Base subclass).  You
+which takes 2 arguments, the controller type symbol (currently either :sinatra, :roda, or :rails),
+and the controller class (either a Sinatra::Base, Roda, or ActionController::Base subclass).  You
 pass <tt>AutoForme.for</tt> a block, which is instance evaled at the framework level.  This
 level sets the defaults.
 
@@ -212,6 +212,21 @@ AutoForme's javascript support is contained in the autoforme.js file in the root
 of the distribution.  AutoForme's autocompleting support also requires
 https://github.com/dyve/jquery-autocomplete
 
+= Reloading Code
+
+By default, AutoForme stores classes by reference.  This can cause issues when using
+code reloading in development environments.  You can call +register_by_name+ to set
+Autoforme to store classes by name, so that if a class is removed and reloaded (giving
+a new class reference), it will use the new class instead of the reference to the old
+class.  Example:
+
+  class App < Sinatra::Base
+    AutoForme.for(:sinatra, self) do
+      register_by_name
+      model Artist
+    end
+  end
+
 = TODO
 
 * capybara-webkit tests for ajax behavior

data/lib/autoforme/framework.rb

@@ -116,10 +116,30 @@ module AutoForme
       handle_proc(association_links, model, type, request)
     end
 
+    # Set whether to register classes by name instead of by reference
+    def register_by_name(register=true)
+      opts[:register_by_name] = register
+    end
+
+    # Whether to register classes by name instead of by reference
+    def register_by_name?
+      opts[:register_by_name]
+    end
+
+    # Look up the Autoforme::Model class to use for the underlying model class instance.
+    def model_class(model_class)
+      if register_by_name?
+        model_class = model_class.name
+      end
+      @model_classes[model_class]
+    end
+
     # Add a new model to the existing framework.  
     def model(model_class, &block)
-      model = Model.for(self, model_type, model_class, &block)
-      @model_classes[model.model] = model
+      if register_by_name?
+        model_class = model_class.name
+      end
+      model = @model_classes[model_class] = Model.for(self, model_type, model_class, &block)
       @models[model.link] = model
     end
 

data/lib/autoforme/model.rb

@@ -13,6 +13,9 @@ module AutoForme
     # The default supported actions for models.
     DEFAULT_SUPPORTED_ACTIONS = [:browse, :new, :show, :edit, :delete, :search, :mtm_edit]
 
+    # Regexp for valid constant names, to prevent code execution.
+    VALID_CONSTANT_NAME_REGEXP = /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/.freeze
+
     extend OptsAttributes
 
     # Create a new instance for the given model type and underlying model class
@@ -26,9 +29,6 @@ module AutoForme
     # The AutoForme::Framework class tied to the current model
     attr_reader :framework
     
-    # The underlying model class for the current model
-    attr_reader :model
-    
     # The options for the given model.
     attr_reader :opts
 
@@ -47,6 +47,17 @@ module AutoForme
       @opts = {}
     end
 
+    # The underlying model class for the current model
+    def model
+      if @model.is_a?(Class)
+        @model
+      elsif m = VALID_CONSTANT_NAME_REGEXP.match(@model)
+        Object.module_eval("::#{m[1]}", __FILE__, __LINE__)
+      else
+        raise Error, "invalid model for AutoForme::Model, not a class or valid constant name: #{@model.inspect}"
+      end
+    end
+
     # Whether the given type of action is supported for this model.
     def supported_action?(type, request)
       v = (handle_proc(supported_actions || framework.supported_actions_for(model, request), request) || DEFAULT_SUPPORTED_ACTIONS).include?(type)
@@ -223,7 +234,7 @@ module AutoForme
 
     # The AutoForme::Model instance associated to the given association.
     def associated_model_class(assoc)
-      framework.model_classes[associated_class(assoc)]
+      framework.model_class(associated_class(assoc))
     end
 
     # The column value to display for the given object and column.
@@ -283,7 +294,7 @@ module AutoForme
     # Create a new instance of the underlying model, setting
     # defaults based on the params given.
     def new(params, request)
-      obj = @model.new
+      obj = model.new
       if params
         columns_for(:new, request).each do |col|
           if association?(col)

data/lib/autoforme/models/sequel.rb

@@ -11,7 +11,7 @@ module AutoForme
       # Make sure the forme plugin is loaded into the model.
       def initialize(*)
         super
-        @model.plugin :forme
+        model.plugin :forme
       end
 
       # The base class for the underlying model, ::Sequel::Model.
@@ -21,7 +21,7 @@ module AutoForme
 
       # A completely empty search object, with no defaults.
       def new_search
-        @model.call({})
+        model.call({})
       end
 
       # The name of the form param for the given association.
@@ -120,7 +120,7 @@ module AutoForme
       # The namespace for form parameter names for this model, needs to match
       # the ones automatically used by Forme.
       def params_name
-        @model.send(:underscore, @model.name)
+        model.send(:underscore, model.name)
       end
 
       # Retrieve underlying model instance with matching primary key
@@ -329,7 +329,7 @@ module AutoForme
       private
 
       def dataset_for(type, request)
-        ds = @model.dataset
+        ds = model.dataset
         if filter = filter_for
           ds = filter.call(ds, type, request)
         end
@@ -337,7 +337,7 @@ module AutoForme
       end
 
       def all_dataset_for(type, request)
-        apply_dataset_options(type, request, @model.dataset)
+        apply_dataset_options(type, request, model.dataset)
       end
     end
   end

data/lib/autoforme/version.rb

@@ -1,6 +1,6 @@
 module AutoForme
   # Version constant, use <tt>AutoForme.version</tt> instead.
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.0'.freeze
 
   # Returns the version as a frozen string (e.g. '0.1.0')
   def self.version

data/spec/associations_spec.rb

@@ -215,7 +215,7 @@ describe AutoForme do
     click_link 'Album'
     page.all('td').map{|s| s.text}.should == ["Album1b", "A2", "Show", "Edit", "Delete"]
 
-    click_link 'Delete'
+    click_link 'Delete', :match=>:first
     select 'A2-Album1b'
     click_button 'Delete'
   end
@@ -293,7 +293,7 @@ describe AutoForme do
     click_link 'Album'
     page.all('tr td:first-child').map{|s| s.text}.should == %w'Y ZZ X'
 
-    click_link 'Delete'
+    click_link 'Delete', :match=>:first
     page.all('select option').map{|s| s.text}.should == ['', 'A-Y', 'A-ZZ', 'B-X']
     select 'B-X'
     click_button 'Delete'
@@ -359,7 +359,7 @@ describe AutoForme do
     click_link 'Album'
     page.all('tr td:first-child').map{|s| s.text}.should == %w'C D E'
 
-    click_link 'Delete'
+    click_link 'Delete', :match=>:first
     page.all('select option').map{|s| s.text}.should == ['', 'C', 'D', 'E']
     select 'C'
     click_button 'Delete'
@@ -410,7 +410,7 @@ describe AutoForme do
     click_link 'Artist'
     page.current_path.should == '/Artist/browse'
 
-    click_link 'Edit'
+    click_link 'Edit', :match=>:first
     select 'Artist1'
     click_button 'Edit'
     click_link 'Album1'
@@ -490,7 +490,7 @@ describe AutoForme do
     click_link 'Artist'
     page.current_path.should == '/Artist/browse'
 
-    click_link 'Edit'
+    click_link 'Edit', :match=>:first
     select 'Artist1'
     click_button 'Edit'
     click_link 'Show Associations'

data/spec/basic_spec.rb

@@ -12,20 +12,20 @@ describe AutoForme do
   it "should have basic functionality working" do
     app_setup(Artist)
     visit("/Artist/new")
-    page.find('title').text.should == 'Artist - New'
+    page.title.should == 'Artist - New'
     fill_in 'Name', :with=>'TestArtistNew'
     click_button 'Create'
     page.html.should =~ /Created Artist/
     page.current_path.should == '/Artist/new'
 
     click_link 'Show'
-    page.find('title').text.should == 'Artist - Show'
+    page.title.should == 'Artist - Show'
     select 'TestArtistNew'
     click_button 'Show'
     page.html.should =~ /Name.+TestArtistNew/m
 
     click_link 'Edit'
-    page.find('title').text.should == 'Artist - Edit'
+    page.title.should == 'Artist - Edit'
     select 'TestArtistNew'
     click_button 'Edit'
     fill_in 'Name', :with=>'TestArtistUpdate'
@@ -35,7 +35,7 @@ describe AutoForme do
     page.current_path.should =~ %r{/Artist/edit/\d+}
 
     click_link 'Search'
-    page.find('title').text.should == 'Artist - Search'
+    page.title.should == 'Artist - Search'
     fill_in 'Name', :with=>'Upd'
     click_button 'Search'
     page.all('th').map{|s| s.text}.should == ['Name', 'Show', 'Edit', 'Delete']
@@ -47,12 +47,12 @@ describe AutoForme do
     page.all('td').map{|s| s.text}.should == []
 
     click_link 'Artist'
-    page.find('title').text.should == 'Artist - Browse'
+    page.title.should == 'Artist - Browse'
     page.all('td').map{|s| s.text}.should == ["TestArtistUpdate", "Show", "Edit", "Delete"]
 
     page.all('td').last.find('a').click
     click_button 'Delete'
-    page.find('title').text.should == 'Artist - Delete'
+    page.title.should == 'Artist - Delete'
     page.html.should =~ /Deleted Artist/
     page.current_path.should == '/Artist/delete'
 
@@ -274,7 +274,7 @@ describe AutoForme do
     a.should == [:show, :browse]
     a.clear
 
-    click_link 'Delete'
+    click_link 'Delete', :match=>:first
     Artist.create(:name=>'A')
     select 'WENTSITRATSET21'
     click_button 'Delete'
@@ -653,7 +653,7 @@ describe AutoForme do
     click_link 'Artist'
     page.all('tr td:first-child').map{|s| s.text}.should == %w'2 1'
 
-    click_link 'Delete'
+    click_link 'Delete', :match=>:first
     page.all('option').map{|s| s.text}.should == ['', '2', '1']
     select '1'
     click_button 'Delete'
@@ -672,7 +672,7 @@ describe AutoForme do
   it "should display decimals in float format in tables" do
     app_setup(Artist)
     visit("/Artist/new")
-    page.find('title').text.should == 'Artist - New'
+    page.title.should == 'Artist - New'
     fill_in 'Num', :with=>'1.01'
     click_button 'Create'
     click_link 'Artist'
@@ -682,3 +682,76 @@ describe AutoForme do
     page.all('tr td:first-child').map{|s| s.text}.should == %w'1.01'
   end
 end
+
+describe AutoForme do
+  before(:all) do
+    db_setup(:artists=>[[:name, :string]])
+    model_setup(:Artist=>[:artists])
+  end
+  after(:all) do
+    Object.send(:remove_const, :Artist)
+  end
+
+  it "should have basic functionality working when reloading code" do
+    app_setup do
+      register_by_name
+      model Artist
+    end
+    artist_class = Artist
+    Object.send(:remove_const, :Artist)
+    ::Artist = Class.new(artist_class) do
+      def name
+        "-#{super}-"
+      end
+      def forme_name
+        "[#{name}]"
+      end
+    end
+    visit("/Artist/new")
+    page.title.should == 'Artist - New'
+    fill_in 'Name', :with=>'TestArtistNew'
+    click_button 'Create'
+    page.html.should =~ /Created Artist/
+    page.current_path.should == '/Artist/new'
+
+    click_link 'Show'
+    page.title.should == 'Artist - Show'
+    select '[-TestArtistNew-]'
+    click_button 'Show'
+    page.html.should =~ /Name.+-TestArtistNew-/m
+
+    click_link 'Edit'
+    page.title.should == 'Artist - Edit'
+    select '[-TestArtistNew-]'
+    click_button 'Edit'
+    fill_in 'Name', :with=>'TestArtistUpdate'
+    click_button 'Update'
+    page.html.should =~ /Updated Artist/
+    page.html.should =~ /Name.+-TestArtistUpdate-/m
+    page.current_path.should =~ %r{/Artist/edit/\d+}
+
+    click_link 'Search'
+    page.title.should == 'Artist - Search'
+    fill_in 'Name', :with=>'Upd'
+    click_button 'Search'
+    page.all('th').map{|s| s.text}.should == ['Name', 'Show', 'Edit', 'Delete']
+    page.all('td').map{|s| s.text}.should == ["-TestArtistUpdate-", "Show", "Edit", "Delete"]
+
+    click_link 'Search'
+    fill_in 'Name', :with=>'Foo'
+    click_button 'Search'
+    page.all('td').map{|s| s.text}.should == []
+
+    click_link 'Artist'
+    page.title.should == 'Artist - Browse'
+    page.all('td').map{|s| s.text}.should == ["-TestArtistUpdate-", "Show", "Edit", "Delete"]
+
+    page.all('td').last.find('a').click
+    click_button 'Delete'
+    page.html.should =~ /Deleted Artist/
+    page.current_path.should == '/Artist/delete'
+
+    click_link 'Artist'
+    page.all('td').map{|s| s.text}.should == []
+  end
+end

data/spec/mtm_spec.rb

@@ -36,7 +36,7 @@ describe AutoForme do
     Album.create(:name=>'Album3')
 
     visit("/Artist/mtm_edit")
-    page.find('title').text.should == 'Artist - Many To Many Edit'
+    page.title.should == 'Artist - Many To Many Edit'
     select("Artist1")
     click_button "Edit"
 
@@ -123,7 +123,7 @@ describe AutoForme do
     click_button 'Add'
     Artist.first.refresh.albums.map{|x| x.name}.sort.should == %w'Album1 Album2'
 
-    click_button 'Remove'
+    click_button 'Remove', :match=>:first
     Artist.first.refresh.albums.map{|x| x.name}.should == %w'Album2'
 
     select 'Album3'
@@ -158,7 +158,7 @@ describe AutoForme do
     click_button 'Add'
     Artist.first.refresh.albums.map{|x| x.name}.sort.should == %w'Album1 Album2'
 
-    click_button 'Remove'
+    click_button 'Remove', :match=>:first
     Artist.first.refresh.albums.map{|x| x.name}.should == %w'Album2'
 
     fill_in 'Albums', :with=>a3.id.to_s
@@ -351,7 +351,7 @@ describe AutoForme do
     Album.create(:name=>'Album3')
 
     visit("/Artist/mtm_edit")
-    page.find('title').text.should == 'Artist - Many To Many Edit'
+    page.title.should == 'Artist - Many To Many Edit'
     select("Artist1")
     click_button "Edit"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoforme
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forme