autoforme 0.5.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 283e6c9e679c9f6c6dde910bfa00561659817393
-  data.tar.gz: d79eb131e43fd1163ba8c90f326e8e9da67b5eff
+  metadata.gz: 86f7ea431b13b17ae2f2c67a5051e58ed8f6bab8
+  data.tar.gz: 01fa45ac012900a4bebee2730aa8a415a88b0184
 SHA512:
-  metadata.gz: ee0211132bcd27e7f0797cdc030ce6329a3af5766b73e33aa8b83e383243f27059997a4eca5e3ce41f4d64d8ed1b032565063e72e7bc86e9f4c33ddf54a034e3
-  data.tar.gz: c11a4b273bd6dd264faeb35ab5803e78a57095039a15becc1bf33f813225b7ad0cbc3e2948a23fdd917490ddf47199123af48f8c38fd1ce193f9b3fea4562521
+  metadata.gz: ad900255d457cb444dd486118f45ee7127752439c4c72292431b1d020fed40abae4cb828bd8bf22bb3199443df6df0ece873ad85a678b5822212908eb3c8a93e
+  data.tar.gz: 2545e4f885fad140056be830b998d88be8771b5adaf8949b5e5e4ef4e9e37bbebfdd0a41cea47fc19f6c66757e21215c5804f48f138266d76988e4c644a2603a

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.0.0 (2014-07-30)
+
+* Assume :sequel model type (jeremyevans)
+
+* Work without indifferent params (jeremyevans)
+
+* Add support for roda web framework (jeremyevans)
+
 === 0.5.5 (2014-04-10)
 
 * Make Models::Sequel#mtm_update compatible with Sequel 4.10+ (jeremyevans)

data/README.rdoc

@@ -3,7 +3,8 @@
 AutoForme is an administrative web front end to an ORM that uses
 Forme [1] for building the HTML forms.  It is designed to
 integrate easily into web frameworks, and currently supports
-both Sinatra and Rails.
+Sinatra, Roda, and Rails.  The only currently supported ORM is
+Sequel::Model.
 
 AutoForme's UI and capabilities are modeled on
 scaffolding_extensions [2], though AutoForme is considerably more
@@ -14,19 +15,16 @@ flexible in terms of configuration.
 
 = Installation
 
-  sudo gem install autoforme
+  gem install autoforme
 
-= Demo Site
+= Links
 
-A demo site is available at http://autoforme-demo.jeremyevans.net
-
-= Documentation Site
-
-RDoc Documentation is available at http://autoforme.jeremyevans.net
-
-= Source Code
-
-Source code is available on GitHub at https://github.com/jeremyevans/autoforme
+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
+Bug Tracker :: https://github.com/jeremyevans/autoforme/issues
 
 = Features
 
@@ -40,11 +38,11 @@ Source code is available on GitHub at https://github.com/jeremyevans/autoforme
 
 = Basic Configuration
 
-AutoForme is configured using a fairly simple DSL.  Here is an example:
+AutoForme is configured using a fairly simple DSL.  Here is an example
+for Sinatra:
 
   class App < Sinatra::Base
     AutoForme.for(:sinatra, self) do
-      model_type :sequel
       order [:name]
 
       model Artist do
@@ -62,9 +60,6 @@ and the controller class (either a Sinatra::Base or ActionController::Base subcl
 pass <tt>AutoForme.for</tt> a block, which is instance evaled at the framework level.  This
 level sets the defaults.
 
-Inside the framework block, you first call model_type with a symbol representing the ORM you are
-using.  Currently, only Sequel is supported, so this should be :sequel.
-
 The order call in the framework block sets the default order for all models.
 
 The model calls in the framework block take a ORM model class.  As only Sequel is currently

data/Rakefile

@@ -34,6 +34,16 @@ begin
   task :default => [:spec]
   spec_with_cov.call("spec", Dir["spec/*_spec.rb"], "Run specs with sinatra/sequel")
 
+  desc "Run specs with roda/sequel"
+  task :roda_spec do
+    begin
+      ENV['FRAMEWORK'] = 'roda'
+      Rake::Task[:spec].invoke
+    ensure
+      ENV.delete('FRAMEWORK')
+    end
+  end
+
   desc "Run specs with rails/sequel"
   task :rails_spec do
     begin
@@ -55,7 +65,6 @@ end
 RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'AutoForme: Web Administrative Console for Sinatra/Rails and Sequel']
 
 begin
-  gem 'rdoc', '= 3.12.2'
   gem 'hanna-nouveau'
   RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
 rescue Gem::LoadError

data/lib/autoforme/framework.rb

@@ -12,6 +12,7 @@ module AutoForme
     # Setup a new framework class.
     def self.setup(controller, opts, &block)
       f = new(controller, opts)
+      f.model_type :sequel
       f.instance_exec(&block)
       f
     end

data/lib/autoforme/frameworks/roda.rb

@@ -0,0 +1,68 @@
+module AutoForme
+  module Frameworks
+    class Roda < AutoForme::Framework
+      class Request < AutoForme::Request
+        def initialize(roda, path)
+          @controller = roda 
+          @request = roda.request
+          @params = @request.params
+          @session = roda.session
+          captures = @request.captures
+          @env = @request.env
+          @method = @env['REQUEST_METHOD']
+          @model = captures[-2]
+          @action_type = captures[-1]
+          @path = path
+          @id = @params['id'] || ($1 if @env['PATH_INFO'] =~ %r{\A\/(\w+)\z})
+        end
+
+        # Redirect to the given path
+        def redirect(path)
+          @request.redirect(path)
+        end
+
+        # Whether the request is an asynchronous request
+        def xhr?
+          @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/i
+        end
+        
+        # Use Rack::Csrf for csrf protection if it is defined.
+        def csrf_token_hash
+          {::Rack::Csrf.field=>::Rack::Csrf.token(@env)} if defined?(::Rack::Csrf)
+        end
+      end
+
+      attr_reader :route_proc
+
+      # Return a proc that should be instance_execed in the Roda routing and
+      # and handles the route if it recognizes it, otherwise doing nothing.
+      def initialize(*)
+        super
+        framework = self
+
+        matchers = [:model, :action_type]
+        if framework.prefix
+          matchers.unshift(framework.prefix[1..-1])
+        end
+
+        @route_proc = lambda do 
+          r = request
+          path = r.env['SCRIPT_NAME']
+          current_matchers = matchers.dup
+          current_matchers << lambda do
+            @autoforme_action = framework.action_for(Request.new(self, path))
+          end
+
+          r.on *current_matchers do
+            @autoforme_text = @autoforme_action.handle
+            opts = {:inline=>"<%= @autoforme_text %>"}
+            opts[:layout] = false if @autoforme_action.request.xhr?
+            view opts
+          end
+        end
+      end
+    end
+  end
+
+  register_framework(:roda, Frameworks::Roda)
+end

data/lib/autoforme/model.rb

@@ -289,7 +289,7 @@ module AutoForme
           if association?(col)
             col = association_key(col)
           end
-          if v = params[col]
+          if v = params[col.to_s]
             obj.send("#{col}=", v)
           end
         end

data/lib/autoforme/models/sequel.rb

@@ -41,13 +41,13 @@ module AutoForme
               ds = model_class.apply_filter(:association, request, ds)
             end
 
-            v = params[ref[:key]]
+            v = params[ref[:key].to_s]
             v = nil if v.to_s.strip == ''
             if v
               v = ds.first!(S.qualify(ds.model.table_name, ref.primary_key)=>v)
             end
           else
-            v = params[col]
+            v = params[col.to_s]
           end
 
           obj.send("#{column}=", v)
@@ -162,7 +162,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]) && !v.empty?
+          if (v = params[c.to_s]) && !v.empty?
             if association?(c)
               ref = model.association_reflection(c)
               ads = ref.associated_dataset

data/lib/autoforme/version.rb

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

data/lib/roda/plugins/autoforme.rb

@@ -0,0 +1,52 @@
+require 'autoforme'
+
+class Roda
+  module RodaPlugins
+    module AutoForme
+      # Require the render plugin, since it is required.
+      def self.load_dependencies(app, opts={})
+        app.plugin :render
+      end
+
+      # If a block is given, automatically setup AutoForme using
+      # the options and block.
+      def self.configure(app, opts={}, &block)
+        app.instance_exec do
+          @autoforme_routes ||= {}
+          if block
+            autoforme(opts, &block)
+          end
+        end
+      end
+
+      module ClassMethods
+        # Setup AutoForme for the given Roda class using the given
+        # options and block.  If the :name option is given, store
+        # this configuration for the given name.
+        def autoforme(opts={}, &block)
+          @autoforme_routes[opts[:name]] = ::AutoForme.for(:roda, self, opts, &block).route_proc
+        end
+
+        # Retrieve the route proc for the named or default AutoForme.
+        def autoforme_route(name=nil)
+          @autoforme_routes[name]
+        end
+
+        # Copy the autoforme configurations into the subclass.
+        def inherited(subclass)
+          super
+          subclass.instance_variable_set(:@autoforme_routes, @autoforme_routes.dup)
+        end
+      end
+
+      module InstanceMethods
+        # If this route matches the named or default AutoForme route, dispatch to AutoForme.
+        def autoforme(name=nil)
+          instance_exec(&self.class.autoforme_route(name))
+        end
+      end
+    end
+
+    register_plugin(:autoforme, AutoForme)
+  end
+end

data/spec/basic_spec.rb

@@ -548,7 +548,7 @@ describe AutoForme do
   it "should support specifying filter per type using request params" do
     app_setup(Artist) do
       filter do |ds, type, req|
-        v = req.params[:f]
+        v = req.params['f']
         case type
         when :edit
           ds.where{n0 > v}

data/spec/rails_spec_helper.rb

@@ -51,7 +51,6 @@ HTML
 
         AutoForme.for(:rails, self, opts) do
           framework = self
-          model_type :sequel
           if klass
             model(klass, &block)
           elsif block

data/spec/roda_spec_helper.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'roda'
+require 'autoforme'
+require 'rack/csrf'
+
+class AutoFormeSpec::App < Roda
+  LAYOUT = <<HTML
+<!DOCTYPE html>
+<html>
+<head><title><%= @autoforme_action.title if @autoforme_action %></title></head>
+<body>
+<% if flash[:notice] %>
+  <div class="alert alert-success"><p><%= flash[:notice] %></p></div>
+<% end %>
+<% if flash[:error] %>
+  <div class="alert alert-error"><p><%= flash[:error] %></p></div>
+<% end %>
+<%= yield %>
+</body></html>"
+HTML
+
+  use Rack::Session::Cookie, :secret => '1'
+  use Rack::Csrf
+
+  plugin :render, :layout=>{:inline=>LAYOUT}
+  plugin :not_found do
+    'Unhandled Request'
+  end
+  plugin :flash
+
+  def self.autoforme(klass=nil, opts={}, &block)
+    sc = Class.new(self)
+    framework = nil
+    sc.class_eval do
+      plugin :autoforme, opts do
+        framework = self
+        if klass
+          model(klass, &block)
+        elsif block
+          instance_eval(&block)
+        end
+      end
+
+      route do |r|
+        r.get 'session/set' do
+          session.merge!(r.params)
+          ''
+        end
+
+        autoforme
+      end
+    end
+    [sc, framework]
+  end
+end
+

data/spec/sinatra_spec_helper.rb

@@ -43,7 +43,6 @@ HTML
     sc.class_eval do
       AutoForme.for(:sinatra, self, opts) do
         framework = self
-        model_type :sequel
         if klass
           model(klass, &block)
         elsif block

data/spec/spec_helper.rb

@@ -8,13 +8,7 @@ module AutoFormeSpec
 end
 
 require './spec/sequel_spec_helper'
-
-case ENV['FRAMEWORK']
-when 'rails'
-  require './spec/rails_spec_helper'
-else
-  require './spec/sinatra_spec_helper'
-end
+require "./spec/#{ENV['FRAMEWORK'] || 'sinatra'}_spec_helper"
 
 RSpec::Core::ExampleGroup.class_eval do
   include Rack::Test::Methods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoforme
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forme
@@ -80,6 +80,7 @@ files:
 - lib/autoforme/action.rb
 - lib/autoforme/framework.rb
 - lib/autoforme/frameworks/rails.rb
+- lib/autoforme/frameworks/roda.rb
 - lib/autoforme/frameworks/sinatra.rb
 - lib/autoforme/model.rb
 - lib/autoforme/models/sequel.rb
@@ -87,10 +88,12 @@ files:
 - lib/autoforme/request.rb
 - lib/autoforme/table.rb
 - lib/autoforme/version.rb
+- lib/roda/plugins/autoforme.rb
 - spec/associations_spec.rb
 - spec/basic_spec.rb
 - spec/mtm_spec.rb
 - spec/rails_spec_helper.rb
+- spec/roda_spec_helper.rb
 - spec/sequel_spec_helper.rb
 - spec/sinatra_spec_helper.rb
 - spec/spec_helper.rb