autoforme 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b02fdd6446457bcda7559cde3424ffe3cebeffc0
-  data.tar.gz: 830e5ab7011c6f853726f3406e46011e5a081c57
+  metadata.gz: d5d8f0b4739dec3afd2a850017943c1e63e611ef
+  data.tar.gz: be9289f7da3c2769d9326df35f8e88c266795bf3
 SHA512:
-  metadata.gz: ee758d94d0f5faca90f0f496140bed42ee4fb30a3dda54ab77ecc451151a02d336b8a369ac17b6ea4aff803ec1791b2a9255382199d494ed5c2c916c5dfd73ca
-  data.tar.gz: 119472906c1fff16ee74cc8babe3656151aadb7ee02cc71241c5263ae39e8fb6e1aeac7cd3b8b6e3785bfbe5474c93afcfd2e224a4191417feaefb72aef2ca95
+  metadata.gz: e9de31745c4580fd52d51f5222d314e566995d270e5ba9d68a3f32016a9e61571b89f9ceca871abb45fc4f9c8555f30149dacab5076ed60e82afb98457318c8f
+  data.tar.gz: 5426d2b558346e01c15dc85a480f7811369bc3fbf555ad76d3a1045810fdd2b38c1fee8e3ac65cff84afa4b9bd4b46934abaaede05989655a119c29b9d7cf7a4

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 1.3.0 (2016-02-02)
+
+* Add support for running with --enable-frozen-string-literal on ruby 2.3 (jeremyevans)
+
+* Make autoforme.js compatible with turbolinks (mrbrdo) (#3)
+
+* Force explicit labeler on show page, so that two columns are used (jeremyevans) (#2)
+
+* Add edit_html and show_html for overriding the html used for a field (jeremyevans) (#1)
+
+* Give the browse/search tables an id (jeremyevans)
+
 === 1.2.0 (2015-05-21)
 
 * Add support for returning browse and search results in CSV format (jeremyevans)

data/MIT-LICENSE

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

@@ -167,8 +167,12 @@ display_name :: The string to use when referring to a model instance.  Can eithe
                 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
+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
 page_header :: Override the default header used for pages
+show_html :: The html to use for displaying the value for an object field.  Should be a proc that takes the
+             model object, column symbol, type symbol, and request and returns the html to use.
 table_class :: The html class string to use for the browse and search tables
 
 These hook options should be callable objects that are called with the model object and the request.
@@ -227,6 +231,13 @@ class.  Example:
     end
   end
 
+= Rails
+
+Because Rails separates routing from request handling, it can be little awkward to
+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.
+
 = TODO
 
 * capybara-webkit tests for ajax behavior

data/autoforme.js

@@ -1,4 +1,4 @@
-$(function() {
+var ready = function() {
   var autoforme = $('#autoforme_content');
   var base_url = autoforme.data('url');
 
@@ -74,4 +74,8 @@ $(function() {
     });
     e.preventDefault();
   });
-});
+};
+
+
+$(document).ready(ready);
+$(document).on('page:load', ready);

data/lib/autoforme.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 require 'forme'
 require 'thread'
 require 'rack/utils'

data/lib/autoforme/action.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 require 'enum_csv'
 
 module AutoForme
@@ -195,7 +197,8 @@ module AutoForme
 
     # HTML fragment for the default page header, which uses tabs for each supported action.
     def tabs
-      content = '<ul class="nav nav-tabs">'
+      content = String.new
+      content << '<ul class="nav nav-tabs">'
       Model::DEFAULT_SUPPORTED_ACTIONS.each do |action_type|
         if model.supported_action?(action_type, request)
           content << "<li class=\"#{'active' if type == action_type}\"><a href=\"#{url_for(action_type)}\">#{tab_name(action_type)}</a></li>"
@@ -218,7 +221,7 @@ module AutoForme
 
     # Yields and wraps the returned data in a header and footer for the page.
     def page
-      html = ''
+      html = String.new
       html << (model.page_header_for(type, request) || tabs)
       html << "<div id='autoforme_content' data-url='#{url_for('')}'>"
       html << yield.to_s
@@ -248,7 +251,11 @@ module AutoForme
       page do
         Forme.form(obj, form_attributes(:action=>url_for("create")), form_opts) do |f|
           model.columns_for(:new, request).each do |column|
-            f.input(column, column_options_for(:new, request, obj, column))
+            col_opts = column_options_for(:new, request, obj, column)
+            if html = model.edit_html_for(obj, column, :new, request)
+              col_opts = col_opts.merge(:html=>html)
+            end
+            f.input(column, col_opts)
           end
           f.button(:value=>'Create', :class=>'btn btn-primary')
         end
@@ -300,11 +307,15 @@ module AutoForme
     # The page to use when displaying an object, always used as a confirmation screen when deleting an object.
     def show_page(obj)
       page do
-        t = ''
-        f = Forme::Form.new(obj, :formatter=>:readonly, :wrapper=>:trtd)
+        t = String.new
+        f = Forme::Form.new(obj, :formatter=>:readonly, :wrapper=>:trtd, :labeler=>:explicit)
         t << "<table class=\"#{model.table_class_for(:show, request)}\">"
         model.columns_for(type, request).each do |column|
-          t << f.input(column, column_options_for(:show, request, obj, column)).to_s
+          col_opts = column_options_for(type, request, obj, column)
+          if html = model.show_html_for(obj, column, type, request)
+            col_opts = col_opts.merge(:html=>html)
+          end
+          t << f.input(column, col_opts).to_s
         end
         t << '</table>'
         if type == :show && model.supported_action?(:edit, request)
@@ -335,9 +346,14 @@ module AutoForme
     # The page to use when editing the object.
     def edit_page(obj)
       page do
-        t = Forme.form(obj, form_attributes(:action=>url_for("update/#{model.primary_key_value(obj)}")), form_opts) do |f|
+        t = String.new
+        t << Forme.form(obj, form_attributes(:action=>url_for("update/#{model.primary_key_value(obj)}")), form_opts) do |f|
           model.columns_for(:edit, request).each do |column|
-            f.input(column, column_options_for(:edit, request, obj, column))
+            col_opts = column_options_for(:edit, request, obj, column)
+            if html = model.edit_html_for(obj, column, :edit, request)
+              col_opts = col_opts.merge(:html=>html)
+            end
+            f.input(column, col_opts)
           end
           f.button(:value=>'Update', :class=>'btn btn-primary')
         end.to_s
@@ -397,7 +413,8 @@ module AutoForme
 
     # HTML fragment for the table pager, showing links to next page or previous page for browse/search forms.
     def table_pager(type, next_page)
-      html = '<ul class="pager">'
+      html = String.new
+      html << '<ul class="pager">'
       page = request.id.to_i
       if page > 1
         html << "<li><a href=\"#{url_for("#{type}/#{page-1}?#{h request.query_string}")}\">Previous</a></li>"
@@ -441,7 +458,11 @@ module AutoForme
         page do
           Forme.form(model.new(nil, request), form_attributes(:action=>url_for("search/1"), :method=>:get), form_opts) do |f|
             model.columns_for(:search_form, request).each do |column|
-              f.input(column, column_options_for(:search_form, request, f.obj, column).merge(:name=>column, :id=>column))
+              col_opts = column_options_for(:search_form, request, f.obj, column).merge(:name=>column, :id=>column)
+              if html = model.edit_html_for(f.obj, column, :search_form, request)
+                col_opts[:html] = html
+              end
+              f.input(column, col_opts)
             end
             f.button(:value=>'Search', :class=>'btn btn-primary')
           end
@@ -462,7 +483,8 @@ module AutoForme
         end
         if assoc
           page do
-            t = "<h2>Edit #{humanize(assoc)} for #{h model.object_display_name(type, request, obj)}</h2>"
+            t = String.new
+            t << "<h2>Edit #{humanize(assoc)} for #{h model.object_display_name(type, request, obj)}</h2>"
             t << Forme.form(obj, form_attributes(:action=>url_for("mtm_update/#{model.primary_key_value(obj)}?association=#{assoc}")), form_opts) do |f|
               opts = model.column_options_for(:mtm_edit, request, assoc)
               add_opts = opts[:add] ? opts.merge(opts.delete(:add)) : opts
@@ -542,7 +564,8 @@ module AutoForme
       assocs = model.association_links_for(type, request) 
       return if assocs.empty?
       read_only = type == :show
-      t = '<h3 class="associated_records_header">Associated Records</h3>'
+      t = String.new
+      t << '<h3 class="associated_records_header">Associated Records</h3>'
       t << "<ul class='association_links'>\n"
       assocs.each do |assoc|
         mc = model.associated_model_class(assoc)
@@ -620,7 +643,8 @@ module AutoForme
       assocs = model.inline_mtm_assocs(request)
       return if assocs.empty?
 
-      t = "<div class='inline_mtm_add_associations'>"
+      t = String.new
+      t << "<div class='inline_mtm_add_associations'>"
       assocs.each do |assoc|
         form_attr = form_attributes(:action=>url_for("mtm_update/#{model.primary_key_value(obj)}?association=#{assoc}&redir=edit"), :class => 'mtm_add_associations', 'data-remove' => "##{assoc}_remove_list")
         t << Forme.form(obj, form_attr, form_opts) do |f|
@@ -652,7 +676,8 @@ module AutoForme
 
     # Line item containing form to remove the currently associated object.
     def mtm_edit_remove(assoc, mc, obj, assoc_obj)
-      t = "<li>"
+      t = String.new
+      t << "<li>"
       t << association_link(mc, assoc_obj)
       form_attr = form_attributes(:action=>url_for("mtm_update/#{model.primary_key_value(obj)}?association=#{assoc}&remove%5b%5d=#{model.primary_key_value(assoc_obj)}&redir=edit"), :method=>'post', :class => 'mtm_remove_associations', 'data-add'=>"#add_#{assoc}")
       t << Forme.form(form_attr, form_opts) do |f|

data/lib/autoforme/framework.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   # The Framework class contains forms for a set of models, tied to web
   # framework controller.
@@ -38,7 +40,7 @@ module AutoForme
       :columns, :display_name, :filter, :form_attributes, :form_options,
       :inline_mtm_associations, :lazy_load_association_links,
       :model_type, :mtm_associations, :order, :page_footer, :page_header, :per_page,
-      :redirect, :supported_actions, :table_class
+      :redirect, :supported_actions, :table_class, :show_html, :edit_html
 
     def initialize(controller, opts={})
       @controller = controller
@@ -116,6 +118,14 @@ module AutoForme
       handle_proc(association_links, model, type, request)
     end
 
+    def show_html_for(obj, column, type, request)
+      handle_proc(show_html, obj, column, type, request)
+    end
+
+    def edit_html_for(obj, column, type, request)
+      handle_proc(edit_html, obj, column, 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

data/lib/autoforme/frameworks/rails.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   module Frameworks
     class Rails < AutoForme::Framework

data/lib/autoforme/frameworks/roda.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   module Frameworks
     class Roda < AutoForme::Framework

data/lib/autoforme/frameworks/sinatra.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   module Frameworks
     class Sinatra < AutoForme::Framework
@@ -48,7 +50,7 @@ module AutoForme
             elsif @autoforme_action.request.xhr?
               @autoforme_text
             else
-              erb "<%= @autoforme_text %>"
+              erb "<%= @autoforme_text %>".dup
             end
           else
             pass

data/lib/autoforme/model.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   # Wraps a specific model class
   class Model
@@ -39,7 +41,7 @@ module AutoForme
       :filter, :form_attributes, :form_options,
       :inline_mtm_associations, :lazy_load_association_links, :link_name, :mtm_associations,
       :order, :page_footer, :page_header, :per_page,
-      :redirect, :supported_actions, :table_class
+      :redirect, :supported_actions, :table_class, :show_html, :edit_html
 
     def initialize(model, framework)
       @model = model
@@ -143,6 +145,14 @@ module AutoForme
       opts
     end
 
+    def show_html_for(obj, column, type, request)
+      handle_proc(show_html || framework.show_html_for(obj, column, type, request), obj, column, type, request)
+    end
+
+    def edit_html_for(obj, column, type, request)
+      handle_proc(edit_html || framework.edit_html_for(obj, column, type, request), obj, column, type, request)
+    end
+
     def order_for(type, request)
       handle_proc(order || framework.order_for(model, type, request), type, request)
     end

data/lib/autoforme/models/sequel.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   module Models
     # Sequel specific model class for AutoForme

data/lib/autoforme/opts_attributes.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   module OptsAttributes
     # Setup methods for each given argument such that if the method is called with an argument or

data/lib/autoforme/request.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   # Request wraps a specific web request for a given framework.
   class Request

data/lib/autoforme/table.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module AutoForme
   # Helper class for formating HTML tables used for the browse/search results pages.
   class Table
@@ -38,7 +40,8 @@ module AutoForme
 
     # Return an HTML string for the table.
     def to_s
-      html = "<table class=\"#{model.table_class_for(type, request)}\">"
+      html = String.new
+      html << "<table id=\"autoforme_table\" class=\"#{model.table_class_for(type, request)}\">"
       if caption = opts[:caption]
         html << "<caption>#{h caption}</caption>"
       end
@@ -56,9 +59,12 @@ module AutoForme
       objs.each do |obj|
         html << "<tr>"
         columns.each do |column|
-          val = model.column_value(type, request, obj, column)
-          val = val.to_s('F') if defined?(BigDecimal) && val.is_a?(BigDecimal)
-          html << "<td>#{h val}</td>"
+          unless val = model.show_html_for(obj, column, type, request)
+            val = model.column_value(type, request, obj, column)
+            val = val.to_s('F') if defined?(BigDecimal) && val.is_a?(BigDecimal)
+            val = h(val)
+          end
+          html << "<td>#{val}</td>"
         end
         html << "<td><a href=\"#{action.url_for("show/#{model.primary_key_value(obj)}")}\" class=\"btn btn-mini btn-info\">Show</a></td>" if show
         html << "<td><a href=\"#{action.url_for("edit/#{model.primary_key_value(obj)}")}\" class=\"btn btn-mini btn-primary\">Edit</a></td>" if edit

data/lib/autoforme/version.rb

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

data/lib/roda/plugins/autoforme.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 require 'autoforme'
 
 class Roda

data/spec/basic_spec.rb

@@ -38,6 +38,7 @@ describe AutoForme do
     page.title.must_equal 'Artist - Search'
     fill_in 'Name', :with=>'Upd'
     click_button 'Search'
+    page.all('table').first['id'].must_equal 'autoforme_table'
     page.all('th').map{|s| s.text}.must_equal ['Name', 'Show', 'Edit', 'Delete']
     page.all('td').map{|s| s.text}.must_equal ["TestArtistUpdate", "Show", "Edit", "Delete"]
     click_link 'CSV Format'
@@ -245,7 +246,7 @@ describe AutoForme do
       before_create{|obj, req| a << -1}
       before_update{|obj, req| a << -2}
       before_destroy{|obj, req| a << -3}
-      before_new{|obj, req| obj.name = 'weNtsitrAtseT'}
+      before_new{|obj, req| obj.name = 'weNtsitrAtseT'.dup}
       before_edit{|obj, req| obj.name << '2'}
       after_create{|obj, req| a << 1 }
       after_update{|obj, req| a << 2 }
@@ -411,6 +412,72 @@ describe AutoForme do
     click_button 'Delete'
     Artist.count.must_equal 0
   end
+
+  it "should support show_html and edit_html" do
+    app_setup(Artist) do
+      show_html do |obj, c, t, req|
+        "#{c}#{t}-#{obj.send(c).to_s*2}"
+      end
+      edit_html do |obj, c, t, req|
+        "<label for='artist_#{c}'>#{c}#{t}</label><input type='text' id='artist_#{c}' name='#{t == :search_form ? c : "artist[#{c}]"}' value='#{obj.send(c).to_s*2}'/>"
+      end
+    end
+    visit("/Artist/new")
+    page.title.must_equal 'Artist - New'
+    fill_in 'namenew', :with=>'TAN'
+    click_button 'Create'
+    page.html.must_match /Created Artist/
+    page.current_path.must_equal '/Artist/new'
+
+    click_link 'Show'
+    page.title.must_equal 'Artist - Show'
+    select 'TAN'
+    click_button 'Show'
+    page.html.must_match /nameshow-TANTAN/
+
+    click_link 'Edit'
+    page.title.must_equal 'Artist - Edit'
+    select 'TAN'
+    click_button 'Edit'
+    fill_in 'nameedit', :with=>'TAU'
+    click_button 'Update'
+    page.html.must_match /Updated Artist/
+    page.html.must_match /nameedit.+TAUTAU/m
+    page.current_path.must_match %r{/Artist/edit/\d+}
+
+    click_link 'Search'
+    page.title.must_equal 'Artist - Search'
+    fill_in 'namesearch_form', :with=>'AU'
+    click_button 'Search'
+    page.all('table').first['id'].must_equal 'autoforme_table'
+    page.all('th').map{|s| s.text}.must_equal ['Name', 'Show', 'Edit', 'Delete']
+    page.all('td').map{|s| s.text}.must_equal ["namesearch-TAUTAU", "Show", "Edit", "Delete"]
+    click_link 'CSV Format'
+    page.body.must_equal "Name\nTAU\n"
+
+    visit("/Artist/browse")
+    click_link 'Search'
+    fill_in 'namesearch_form', :with=>'TAUTAU'
+    click_button 'Search'
+    page.all('td').map{|s| s.text}.must_equal []
+
+    click_link 'Artist'
+    page.title.must_equal 'Artist - Browse'
+    page.all('td').map{|s| s.text}.must_equal ["namebrowse-TAUTAU", "Show", "Edit", "Delete"]
+    click_link 'CSV Format'
+    page.body.must_equal "Name\nTAU\n"
+
+    visit("/Artist/browse")
+    page.all('td').last.find('a').click
+    page.html.must_match /namedelete-TAUTAU/
+    click_button 'Delete'
+    page.title.must_equal 'Artist - Delete'
+    page.html.must_match /Deleted Artist/
+    page.current_path.must_equal '/Artist/delete'
+
+    click_link 'Artist'
+    page.all('td').map{|s| s.text}.must_equal []
+  end
 end
 
 describe AutoForme do

data/spec/roda_spec_helper.rb

@@ -4,6 +4,7 @@ require 'autoforme'
 require 'rack/csrf'
 
 begin
+  require 'erubis'
   require 'tilt/erubis'
 rescue LoadError
   require 'tilt/erb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoforme
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forme
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: roda
+  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: rack_csrf
+  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: sinatra
+  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: sinatra-flash
+  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: rails
+  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'
 description: |
   AutoForme is an web administrative console for Sequel::Model that
   supports Sinatra and Rails.  It offers the following features:
@@ -181,9 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Web Administrative Console for Sinatra/Rails and Sequel
 test_files: []
-has_rdoc: true