autoforme 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d0bdcb16302f8c39805290a5f31dc4e6317aacb91eea042662d949fe5688c6f
-  data.tar.gz: 3e9d217d00951f5bb008d6278ec2642fb6a2f1cc2a6511d8a76cfb3f71c1a46d
+  metadata.gz: 6f9fb399d144c4bfc7eed6e2a4f7497cab7bc25b8409d555c4f67fb91bad9bb7
+  data.tar.gz: bffb9114ef162400c639abb1ee17b7eb42ced481294d152e2603711c01752274
 SHA512:
-  metadata.gz: 3f8701563f00846a37ad405852ef015c4c24c8634e7a5ecf2e28844fca78dee54c3b46cda1d3e7747eb40b8f5e3ed93df1c703c9c3d933cb0e7f4a8d485f592f
-  data.tar.gz: e54401c38c27521d6d55ac706bdd0d1867c4adf15771b38f6ce4ce364b20ff6b01715a9b37195e5e1df571de866ae91f005b085e3b4de93d492f2351b758a79b
+  metadata.gz: 15cd700c5edc91d860dcec0209dae57dd3db48ebe2bc6cf66f19b9d786d7a51b23f909ec80a0a2333af8d9c42c165690dd6710c26ebfadfbfa93c9d17618976b
+  data.tar.gz: 0c4a42c4e34e398209f98e85303558ef95447eb6a1e8f6351a182f214a1dab7b754f86aca8d81d35ba32d5890a09fa417a28c7e8212a2284df5d265c776533e8

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.10.0 (2021-08-27)
+
+* Do not consider read_only many_to_many associations to be editable (jeremyevans)
+
+* Ignore unique constraint violations when adding associated objects in mtm_update (jeremyevans)
+
+* Handle search fields that cannot be typecast correctly by returning no results (jeremyevans)
+
 === 1.9.1 (2019-07-22)
 
 * [SECURITY] Escape object display name when displaying association links (adam12)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2018 Jeremy Evans
+Copyright (c) 2013-2021 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

@@ -22,8 +22,7 @@ flexible in terms of configuration.
 Demo Site :: http://autoforme-demo.jeremyevans.net
 RDoc :: http://autoforme.jeremyevans.net
 Source :: https://github.com/jeremyevans/autoforme
-IRC :: irc://irc.freenode.net/forme
-Google Group :: https://groups.google.com/forum/#!forum/ruby-forme
+Discussion Forum :: https://github.com/jeremyevans/autoforme/discussions
 Bug Tracker :: https://github.com/jeremyevans/autoforme/issues
 
 = Features
@@ -161,12 +160,13 @@ These options are related to displayed output:
 
 form_attributes :: Hash of attributes to use for any form tags
 form_options :: Hash of Forme::Form options to pass for any forms created
-class_display_name :: The string to use when referring to the model class
+class_display_name :: The string to use on pages when referring to the model class.
+                      This defaults to the full class name.
 display_name :: The string to use when referring to a model instance.  Can either be a symbol
                 representing an instance method call, or a Proc called with the model object,
                 the model object and type symbol, or the model object, type symbol, and request,
                 depending on the arity of the Proc.
-link_name :: The string to use in links for the class
+link_name :: The string to use in links for the class. This defaults to +class_display_name+.
 edit_html :: The html to use for a particular object edit field.  Should be a proc that takes the
              model object, column symbol, type symbol, and request and returns the html to use.
 page_footer :: Override the default footer used for pages
@@ -238,6 +238,66 @@ use AutoForme in Rails development mode.  The best way to handle it is to call
 +AutoForme.for+ in the related controller file, and have an initializer reference
 the controller class, causing the controller file to be loaded.
 
+= Roda
+
+Because Roda uses a routing tree, unlike Rails and Sinatra, with Roda you need to
+dispatch to the autoforme routes at the point in the routing tree where you want
+to mount them.  Additionally, the Roda support offers a Roda plugin for easier
+configuration.
+
+To mount the autoforme routes in the root of the application, you could do:
+
+  class App < Roda
+    plugin :autoforme do
+      model Artist
+    end
+
+    route do
+      # rest of routing tree
+      autoforme
+    end
+  end
+
+To mount the routes in a subpath:
+
+  class App < Roda
+    plugin :autoforme do
+      model Artist
+    end
+
+    route do
+      r.on "admin" do
+        autoforme
+      end
+
+      # rest of routing tree
+    end
+  end
+
+To handle multiple autoforme configurations, mounted at different subpaths:
+
+  class App < Roda
+    plugin :autoforme
+
+    autoforme(name: 'artists')
+      model Artist
+    end
+    autoforme(name: 'albums')
+      model Album
+    end
+
+    route do
+      r.on "artists" do
+        autoforme('artists')
+      end
+      r.on "albums" do
+        autoforme('albums')
+      end
+
+      # rest of routing tree
+    end
+  end
+
 = TODO
 
 * capybara-webkit tests for ajax behavior

data/lib/autoforme/model.rb

@@ -389,7 +389,7 @@ module AutoForme
     
     def normalize_mtm_associations(assocs)
       if assocs == :all
-        mtm_association_names
+        editable_mtm_association_names
       else
         Array(assocs)
       end

data/lib/autoforme/models/sequel.rb

@@ -98,14 +98,26 @@ module AutoForme
         ref[:keys].zip(ref[:primary_keys].map{|k| obj.send(k)})
       end
 
+      # Array of many to many association name strings for editable
+      # many to many associations.
+      def editable_mtm_association_names
+        association_names([:many_to_many]) do |r|
+          model.method_defined?(r.add_method) && model.method_defined?(r.remove_method)
+        end
+      end
+
       # Array of many to many association name strings.
       def mtm_association_names
         association_names([:many_to_many])
       end
 
-      # Array of association name strings for given association types
+      # Array of association name strings for given association types. If a block is
+      # given, only include associations where the block returns truthy.
       def association_names(types=SUPPORTED_ASSOCIATION_TYPES)
-        model.all_association_reflections.select{|r| types.include?(r[:type])}.map{|r| r[:name]}.sort_by(&:to_s)
+        model.all_association_reflections.
+          select{|r| types.include?(r[:type]) && (!block_given? || yield(r))}.
+          map{|r| r[:name]}.
+          sort_by(&:to_s)
       end
 
       # Save the object, returning the object if successful, or nil if not.
@@ -158,7 +170,7 @@ module AutoForme
         params = request.params
         ds = apply_associated_eager(:search, request, all_dataset_for(type, request))
         columns_for(:search_form, request).each do |c|
-          if (v = params[c.to_s]) && !v.empty?
+          if (v = params[c.to_s]) && !(v = v.to_s).empty?
             if association?(c)
               ref = model.association_reflection(c)
               ads = ref.associated_dataset
@@ -168,9 +180,16 @@ module AutoForme
               primary_key = S.qualify(ref.associated_class.table_name, ref.primary_key)
               ds = ds.where(S.qualify(model.table_name, ref[:key])=>ads.where(primary_key=>v).select(primary_key))
             elsif column_type(c) == :string
-              ds = ds.where(S.ilike(S.qualify(model.table_name, c), "%#{ds.escape_like(v.to_s)}%"))
+              ds = ds.where(S.ilike(S.qualify(model.table_name, c), "%#{ds.escape_like(v)}%"))
             else
-              ds = ds.where(S.qualify(model.table_name, c)=>model.db.typecast_value(column_type(c), v))
+              begin
+                typecasted_value = model.db.typecast_value(column_type(c), v)
+              rescue S::InvalidValue
+                ds = ds.where(false)
+                break
+              else
+                ds = ds.where(S.qualify(model.table_name, c)=>typecasted_value)
+              end
             end
           end
         end
@@ -293,7 +312,11 @@ module AutoForme
               ids.each do |id|
                 next if id.to_s.empty?
                 ret = assoc_class ? assoc_class.with_pk(:association, request, id) : obj.send(:_apply_association_options, ref, ref.associated_class.dataset.clone).with_pk!(id)
-                obj.send(meth, ret)
+                begin
+                  model.db.transaction(:savepoint=>true){obj.send(meth, ret)}
+                rescue S::UniqueConstraintViolation
+                  # Already added, safe to ignore
+                end
               end
             end
           end

data/lib/autoforme/version.rb

@@ -6,11 +6,11 @@ module AutoForme
   MAJOR = 1
 
   # The minor version of AutoForme, updated for new feature releases of AutoForme.
-  MINOR = 9
+  MINOR = 10
 
   # The patch version of AutoForme, updated only for bug fixes from the last
   # feature release.
-  TINY = 1
+  TINY = 0
 
   # Version constant, use <tt>AutoForme.version</tt> instead.
   VERSION = "#{MAJOR}.#{MINOR}.#{TINY}".freeze

data/spec/basic_spec.rb

@@ -954,19 +954,29 @@ describe AutoForme do
   after(:all) do
     Object.send(:remove_const, :Artist)
   end
-
-  it "should display decimals in float format in tables" do
+  before do
     app_setup(Artist)
     visit("/Artist/new")
     page.title.must_equal 'Artist - New'
     fill_in 'Num', :with=>'1.01'
     click_button 'Create'
+    visit("/Artist/browse")
+  end
+
+  it "should display decimals in float format in tables" do
     click_link 'Artist'
     page.all('tr td:first-child').map{|s| s.text}.must_equal %w'1.01'
     click_link 'Search'
     click_button 'Search'
     page.all('tr td:first-child').map{|s| s.text}.must_equal %w'1.01'
   end
+
+  it "should treat invalid search fields as returning no results" do
+    click_link 'Search'
+    fill_in 'Num', :with=>'3/3/2020'
+    click_button 'Search'
+    page.all('tr td:first-child').map{|s| s.text}.must_equal []
+  end
 end
 
 describe AutoForme do

data/spec/mtm_spec.rb

@@ -507,3 +507,115 @@ describe AutoForme do
     page.all('select')[1].all('option').map{|s| s.text}.must_equal ["Album2", "Album3"]
   end
 end
+
+describe AutoForme do
+  before(:all) do
+    db_setup(:artists=>[[:name, :string]], :albums=>[[:name, :string]], :albums_artists=>proc{column :album_id, :integer, :table=>:albums; column :artist_id, :integer, :table=>:artists; primary_key [:album_id, :artist_id]})
+    model_setup(:Artist=>[:artists, [[:many_to_many, :albums]]], :Album=>[:albums, [[:many_to_many, :artists]]])
+  end
+  after(:all) do
+    Object.send(:remove_const, :Album)
+    Object.send(:remove_const, :Artist)
+  end
+
+  it "should handle unique constraint violation errors when adding associated objects" do
+    app_setup do
+      model Artist do
+        mtm_associations :albums
+      end
+      model Album
+    end
+
+    artist = Artist.create(:name=>'Artist1')
+    album = Album.create(:name=>'Album1')
+
+    visit("/Artist/mtm_edit")
+    page.title.must_equal 'Artist - Many To Many Edit'
+    select("Artist1")
+    click_button "Edit"
+
+    find('h2').text.must_equal 'Edit Albums for Artist1'
+    page.all('select')[0].all('option').map{|s| s.text}.must_equal ["Album1"]
+    page.all('select')[1].all('option').map{|s| s.text}.must_equal []
+    select("Album1", :from=>"Associate With")
+    artist.add_album(album)
+    click_button "Update"
+    page.html.must_include 'Updated albums association for Artist'
+    Artist.first.albums.map{|x| x.name}.must_equal %w'Album1'
+  end
+
+  it "should handle unique constraint violation errors when adding associated objects" do
+    app_setup do
+      model Artist do
+        mtm_associations :albums
+      end
+      model Album
+    end
+
+    artist = Artist.create(:name=>'Artist1')
+    album = Album.create(:name=>'Album1')
+    artist.add_album(album)
+
+    visit("/Artist/mtm_edit")
+    page.title.must_equal 'Artist - Many To Many Edit'
+    select("Artist1")
+    click_button "Edit"
+
+    find('h2').text.must_equal 'Edit Albums for Artist1'
+    page.all('select')[0].all('option').map{|s| s.text}.must_equal []
+    page.all('select')[1].all('option').map{|s| s.text}.must_equal ["Album1"]
+    select("Album1", :from=>"Disassociate From")
+    artist.remove_album(album)
+    click_button "Update"
+    page.html.must_include 'Updated albums association for Artist'
+    Artist.first.albums.map{|x| x.name}.must_equal []
+  end
+end
+
+describe AutoForme do
+  before(:all) do
+    db_setup(:artists=>[[:name, :string]], :albums=>[[:name, :string]], :albums_artists=>[[:album_id, :integer, {:table=>:albums}], [:artist_id, :integer, {:table=>:artists}]])
+    model_setup(:Artist=>[:artists, [[:many_to_many, :albums, :read_only=>true]]], :Album=>[:albums, [[:many_to_many, :artists, :read_only=>true]]])
+  end
+  after(:all) do
+    Object.send(:remove_const, :Album)
+    Object.send(:remove_const, :Artist)
+  end
+
+  it "should not automatically setup mtm support for read-only associations" do
+    app_setup do
+      model Artist do
+        mtm_associations :all
+        association_links :all
+      end
+      model Album do
+        mtm_associations :all
+        association_links :all
+      end
+    end
+
+    visit("/Artist/new")
+    page.html.wont_include 'MTM'
+    fill_in 'Name', :with=>'Artist1'
+    click_button 'Create'
+    click_link 'Edit'
+    select 'Artist1'
+    click_button 'Edit'
+    page.html.must_include 'Albums'
+    page.html.wont_include '>associate<'
+    visit("/Artist/mtm_edit")
+    page.html.must_include 'Unhandled Request'
+
+    visit("/Album/new")
+    page.html.wont_include 'MTM'
+    fill_in 'Name', :with=>'Album1'
+    click_button 'Create'
+    click_link 'Edit'
+    select 'Album1'
+    click_button 'Edit'
+    page.html.must_include 'Artists'
+    page.html.wont_include '>associate<'
+    visit("/Album/mtm_edit")
+    page.html.must_include 'Unhandled Request'
+  end
+end

data/spec/rails_spec_helper.rb

@@ -1,8 +1,14 @@
 require 'rubygems'
+require 'rails'
 require 'action_controller/railtie'
 require 'autoforme'
 
 class AutoFormeSpec::App
+  class << self
+    # Workaround for action_view railtie deleting the finalizer
+    attr_accessor :av_finalizer
+  end
+
   def self.autoforme(klass=nil, opts={}, &block)
     sc = Class.new(Rails::Application)
     def sc.name
@@ -16,7 +22,7 @@ class AutoFormeSpec::App
       resolver = Class.new(ActionView::Resolver)
       resolver.class_eval do
         template = ActionView::Template
-        t = [template.new(<<HTML, "layout", template.handler_for_extension(:erb), {:virtual_path=>'layout', :format=>'erb', :updated_at=>Time.now})]
+        code = (<<HTML)
 <!DOCTYPE html>
 <html>
 <head><title><%= @autoforme_action.title if @autoforme_action %></title></head>
@@ -30,6 +36,11 @@ class AutoFormeSpec::App
 <%= yield %>
 </body></html>"
 HTML
+        if Rails.version > '6'
+          t = [template.new(code, "layout", template.handler_for_extension(:erb), :virtual_path=>'layout', :format=>'erb', :locals=>[])]
+        else
+          t = [template.new(code, "layout", template.handler_for_extension(:erb), :virtual_path=>'layout', :format=>'erb', :updated_at=>Time.now)]
+        end
 
         define_method(:find_templates){|*args| t}
       end
@@ -57,11 +68,23 @@ HTML
         get 'session/set', :controller=>'autoforme', :action=>'session_set'
       end.inspect
       config.secret_token = st if Rails.respond_to?(:version) && Rails.version < '5.2'
+      config.hosts << "www.example.com" if config.respond_to?(:hosts)
       config.active_support.deprecation = :stderr
       config.middleware.delete(ActionDispatch::ShowExceptions)
       config.middleware.delete(Rack::Lock)
       config.secret_key_base = st*15
       config.eager_load = true
+      if Rails.version.start_with?('4')
+        # Work around issue in backported openssl environments where
+        # secret is 64 bytes intead of 32 bytes
+        require 'active_support/message_encryptor'
+        ActiveSupport::MessageEncryptor.send :prepend, Module.new {
+          def initialize(secret, *signature_key_or_options)
+            secret = secret[0, 32]
+            super
+          end
+        }
+      end
       if Rails.version > '4.2'
         config.action_dispatch.cookies_serializer = :json
       end
@@ -70,6 +93,14 @@ HTML
         ActionDispatch::Routing::RouteSet::Dispatcher.class_eval do
           define_method(:controller){|_| controller}
         end
+        config.session_store :cookie_store, :key=>'_autoforme_test_session'
+      end
+      if Rails.version > '6'
+        if AutoFormeSpec::App.av_finalizer
+          config.action_view.finalize_compiled_template_methods = AutoFormeSpec::App.av_finalizer
+        else
+          AutoFormeSpec::App.av_finalizer = config.action_view.finalize_compiled_template_methods
+        end
       end
       initialize!
     end

data/spec/spec_helper.rb

@@ -27,7 +27,7 @@ require 'rack/test'
 
 ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
 gem 'minitest'
-require 'minitest/autorun'
+require 'minitest/global_expectations/autorun'
 require 'minitest/hooks/default'
 
 if ENV['WARNING']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoforme
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forme
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +257,12 @@ files:
 homepage: http://github.com/jeremyevans/autoforme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/autoforme/issues
+  changelog_uri: http://autoforme.jeremyevans.net/files/CHANGELOG.html
+  documentation_uri: http://autoforme.jeremyevans.net
+  mailing_list_uri: https://github.com/jeremyevans/autoforme/discussions
+  source_code_uri: https://github.com/jeremyevans/autoforme
 post_install_message: 
 rdoc_options:
 - "--quiet"
@@ -266,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Web Administrative Console for Roda/Sinatra/Rails and Sequel::Model