RubyGems - rack-backend-api - Versions diffs - 0.0.5 → 0.1.0 - Mend

rack-backend-api 0.0.5 → 0.1.0

Files changed (8) hide show

data/README.md +34 -0
data/lib/backend_api.rb +7 -3
data/lib/sequel_rack_backend_api_adapter.rb +5 -0
data/rack-backend-api.gemspec +1 -1
data/test/db.rb +16 -0
data/test/spec_backend_api.rb +5 -0
data/test/spec_sequel_adapter.rb +5 -0
metadata +4 -4

data/README.md CHANGED Viewed

@@ -153,6 +153,30 @@ The option `:submit_text` is also available through the API as `_submit_text`.
 It says "SAVE" by default but you might want it to say "CREATE" and "UPDATE" in appropriate cases,
 like we did in the example.
+SORTING
+=======
+The way I implemented it for the moment might be a bit awkward, but I needed that option.
+Basically when you use a PUT request without an ID, the API assumes that you want to sort the entries of the class.
+For instance:
+    PUT /admin/TopFive
+Then it will look for the parameter that has the name of the class which should be a list of ids.
+And it will update each entry with its position field set to the position in the array.
+That is more or less what people are used to do when sorting via javascript.
+    TopFive[]=4&TopFive[]=2&TopFive[]=1&TopFive[]=3
+This is an example of a query string for the order: 4,2,1,3. But this is just an example, it has to be a PUT request
+or a POST request with method override.
+The position field is obviously known by the ORM.
+For Sequel (which adapter is included) it assumes that you use the `:list` plugin.
+It is shipped with Sequel.
+Still a work in progress but it satisfies the tests so far.
 A LITTLE BIT OF JAVASCRIPT
 ==========================
@@ -235,6 +259,14 @@ Others are slightly more sophisticated:
 - `Model#backend_form( action_url, columns=nil, options={} )` It is only the wrapping of the form without the actual fields. Try to implement it like the Sequel one.
 - `Model#backend_fields( columns )` These are the actual fields. There is a default behaviour that basically puts a `textarea` for everything. That works in most cases but this is meant to be overridden for a better solution. We recommend [Crushyform](https://rubygems.org/gems/sequel-crushyform) for Sequel because we did it so we know it plays well with BackendAPI, and also because you don't have anything more to do. BackendAPI knows you have [Crushyform](https://rubygems.org/gems/sequel-crushyform) and use it to create the fields.
 - `Model#backend_delete_form( action_url, options={})` Basically sugar for Model#backend_form but with an empty array for columns, and these options `{:submit_text=>'X', :method=>'DELETE'}` predefined which you can override. We've seen before that it is for creating DELETE forms.
+- `Model::sort( array-of-ids )` It is used to do a bulk update of the position field, hence: re-order
+CAN I HELP ?
+============
+Of course you can. This project is still in heavy development and it definitely lacks some error checking and stuff.
+So do not hesitate to fork the project on Github and request a `pull`. If you don't use Github, you still can send a patch.
+But that's less fun isn't it?
 THANX
 =====
@@ -251,6 +283,8 @@ CHANGE LOG
 0.0.2 Accept CamelCased class names
 0.0.3 Fix Form mockup
 0.0.4 Partial available not only via XHR but also via `_no_wrap` param
+0.0.5 Ordered list of fields to keep before validation
+0.1.0 Introduce sorting functionality
 COPYRIGHT
 =========

data/lib/backend_api.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 class BackendAPI
-  VERSION = [0,0,5]
+  VERSION = [0,1,0]
   WRAP = <<-EOT
   <!doctype html>
   <html>
@@ -57,8 +57,12 @@ class BackendAPI
   # Update
   def put
-    @model_instance.backend_put @req['model']
-    save_and_respond
+    if @id.nil? && @req[@model_class_name]
+      @model_class.sort(@req[@model_class_name])
+    else
+      @model_instance.backend_put @req['model']
+      save_and_respond
+    end
   end
   # Delete

data/lib/sequel_rack_backend_api_adapter.rb CHANGED Viewed

@@ -1,6 +1,11 @@
 module ::Sequel::Plugins::RackBackendApiAdapter
   module ClassMethods
+    def sort(list)
+      list.each_with_index do |id, position|
+        self[id].update(position_field=>position)
+      end
+    end
   end
   module InstanceMethods

data/rack-backend-api.gemspec CHANGED Viewed

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rack-backend-api'
-  s.version = "0.0.5"
+  s.version = "0.1.0"
   s.platform = Gem::Platform::RUBY
   s.summary = "A Rack middleware that provides a simple API for your Admin section"
   s.description = "The purpose of this Rack Middleware is to provide an API that interfaces with database actions in order to build a CMS."

data/test/db.rb CHANGED Viewed

@@ -49,6 +49,16 @@ class CamelCasedClass < ::Sequel::Model
   create_table unless table_exists?
 end
+class TopFive < ::Sequel::Model
+  set_schema do
+    primary_key :id
+    Fixnum :position
+    String :flavour
+  end
+  create_table unless table_exists?
+  plugin :list
+end
 Haiku.create( :title=>'Autumn', :body=>"Rust the ground\nFlush the branches\nReveal the trees" )
 Haiku.create( :title=>'Winter', :body=>"There is snow\nIt covers you\nBut you are still the most beautiful" )
 Haiku.create( :title=>'Spring', :body=>"No inspiration" )
@@ -56,3 +66,9 @@ Haiku.create( :title=>'Spring', :body=>"No inspiration" )
 Author.create(:name=>'Ray',:surname=>'Bradbury')
 Author.create(:name=>'Jorge Luis',:surname=>'Borges')
 Author.create(:name=>'Yasunari', :surname=>'Kawabata')
+TopFive.create(:flavour=>'Strawberry')
+TopFive.create(:flavour=>'Vanilla')
+TopFive.create(:flavour=>'Chocolate')
+TopFive.create(:flavour=>'Coconut')
+TopFive.create(:flavour=>'Apricot')

data/test/spec_backend_api.rb CHANGED Viewed

@@ -227,6 +227,11 @@ describe 'API Put' do
     res.body.should==('<!-- '+compared.backend_form('/haiku/3',['title'], {:no_wrap=>'true'})+' -->')
     res.body.should.match(/name='_no_wrap'.*value='true'/)
   end
+  should "Consider that a PUT request without an ID is a bulk update of position field (re-order)" do
+    req_lint(BackendAPI.new).put('/TopFive', :params => {'TopFive'=>['2','3','1','5','4']})
+    TopFive.order(:position).map(:flavour).should==['Vanilla','Chocolate','Strawberry','Apricot','Coconut']
+  end
 end
 describe 'API Delete' do

data/test/spec_sequel_adapter.rb CHANGED Viewed

@@ -82,4 +82,9 @@ describe 'Sequel Adapter' do
     form.scan(/input/).size.should==4
   end
+  should "Be able to sort entries with a list of IDs" do
+    TopFive.sort([2,3,1,5,4])
+    TopFive.order(:position).map(:flavour).should==['Vanilla','Chocolate','Strawberry','Apricot','Coconut']
+  end
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rack-backend-api
 version: !ruby/object:Gem::Version
-  hash: 21
+  hash: 27
   prerelease:
   segments:
   - 0
+  - 1
   - 0
-  - 5
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Mickael Riga
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-07-22 00:00:00 +01:00
+date: 2011-07-25 00:00:00 +01:00
 default_executable:
 dependencies: []