adds a feature to set sequence number to Mongoid::Document

sequence.rb

# encoding: utf-8
module Mongoid
  # Include this module to add automatic sequence feature (also works for _id field, so SQL-Like autoincrement primary key can easily be simulated)
  # usage:
  # class KlassName
  #   include Mongoid::Document
  #   include Mongoid::Sequence
  # ...
  #   field :number, :type=>Integer
  #   sequence :number
  # ...
  module Sequence
    extend ActiveSupport::Concern
        
    module ClassMethods
      def sequence(_field)
        # REPLACE FIELD DEFAULT VALUE
        _field = _field.to_s
        field(_field, fields[_field].options.merge(:default => lambda{ self.class.set_from_sequence(_field)}))
      end
      
      def set_from_sequence(_field)
        sequences = self.db.collection("__sequences")
        counter_id = "#{self.class.name.underscore}_#{_field}"

        # Increase the sequence value and also avoids conflicts
        catch(:value) do
          value = nil
          begin
            value = sequences.find_and_modify(
              :query => {"_id" => counter_id},
              :update=> {"$inc" => {"value" => 1}},
              :new => true,
              :upsert => true
            ).send("[]", "value")
          end while self.first({:conditions => {_field => value}})
          throw :value, value
        end
      end    
      
      def reset_sequence(_field)  
        sequences = self.db.collection("__sequences")
        counter_id = "#{self.class.name.underscore}_#{_field}"
        sequences.find_and_modify(:query => {"_id" => counter_id}, :update=> {"$set" => {"value" => 0}}, :new => true, :upsert => true)
      end
    end    
  end
end

Hmm, I'm getting

ruby-1.9.2-head :001 > Band.new
NoMethodError: undefined method `set_from_sequence' for #<Band:0xbc33ccc>

while being sure that the module has been loaded

class Band
   include Mongoid::Document
   include Mongoid::Timestamps
   include Mongoid::Sequence

OK, replacing line #19 with

field(_field, fields[_field].options.merge(:default => lambda{ self.class.set_from_sequence(_field)}))

solves the problem.

This should become a gem! :)

Well done! ^^

This module is now included in https://github.com/ShogunPanda/cowtech-rails (in which I've just included your fix), which includes also many other improvements.
Hope you'll like it!

Gist updated!

thanks!

in the end (10 minutes ago ;)) i actually went with the original gist that inspired you -- https://gist.github.com/730677 -- because yours generates a new number on every save, and this is a bug/misfeature that's well beyond my mongo knowledge to fix it.

In the comments, it says that this code supports the default _id field, but when I try inserting sequence :_id in my model code, it does not simulate the SQL-Like autoincrement primary keys. Anyone else have this issue?

@paulsdfs:
Can you post your model class to make us check it?

So I put this code in a file called mongoid_sequence.rb and put it in the Rails.root/config/initializers so that it will load on server start. Here is my model class:

class Event
  include Mongoid::Document
  include Mongoid::Paperclip
  include Mongoid::Sequence

  sequence :_id

  field :name, type: String
  field :start_time, type: DateTime

  attr_accessible :name, :start_time

  has_mongoid_attached_file :banner_image

  validates_presence_of :name, allow_nil: false
end

After restarting the server, it continues to create new Event objects with IDs such as 4f49f1f21d41c8696b000002, but I was hoping it would generate IDs in a MySQL fashion such as 1, 2, 3, etc.

Thanks for your help!

Have you tried to specifiy _id field as Integer?

Yes, I tried that as well. The IDs still get generated in a non-MySQL fashion and I have problems with the Event.find method. When I try to view the object by accessing it through /events/, I get the following error:

  app/controllers/events_controller.rb:17:in`show'

```
Where line 17 is @event = Event.find(params[:id]).
```

Il giorno 26/feb/2012, alle ore 20:05, Paul Wong ha scritto:

Yes, I tried that as well. The IDs still get generated in a non-MySQL fashion and I have problems with the Event.find method. When I try to view the object by accessing it through /events/<id>, I get the following error: ````Mongoid::Errors::DocumentNotFound (Document not found for class Event with id(s) 4f4a81171d41c86bac000002.): app/controllers/events_controller.rb:17:in`show' ``` Where line 17 is @event = Event.find(params[:id]). --- Reply to this email directly or view it on GitHub: https://gist.github.com/1086265 ```

Ok, tomorrow I'll try to investigate on it.

…

--- Shogun -"La madre degli imbecilli è sempre incinta" -"I due elementi più diffusi nell'universo sono l'idrogeno e l'idiozia...e del primo non sono sicuro" -"There's no knowledge that is not power" -E-Mail: shogun_panda@me.com -Web: http://shogun.cowtech.it -Twitter: http://twitter.com/shogun_panda -GitHub: https://github.com/ShogunPanda -StackOverflow: ShogunPanda

Just packaged something similar to this into a gem: https://github.com/goncalossilva/mongoid-sequence

@paulsfds: I believe you won't have ID issue with this gem.

Well done! Thanks!

@goncalossilva - Thanks for your reply. I installed your gem, but I am getting errors. I always get the error, "ActionController::RoutingError (uninitialized constant Mongoid::Sequence)." I also tried one of your test classes (http://github.com/goncalossilva/mongoid-sequence/blob/master/test/models/id_sequenced_model.rb), and I also get the same error.

In my Gemfile I have gem "mongoid-sequence", and I did do a bundle install, so I am not sure what is wrong.

@paulsfds That's odd. Are you using "bundle exec rails server"? If yes, is your app open source (for me to take a look)?

@goncalossilva Yes, I did use bundle exec rails server. I uploaded a sample project on my github account here: http://github.com/paulsfds/MongoidSequenceTest. When I start up the server and try to access the /samples route, I get the following error:

Started GET "/samples" for localhost at 2012-03-19 15:53:32 -0700

ActionController::RoutingError (uninitialized constant Mongoid::Sequence):
app/models/sample.rb:3:in <class:Sample>' app/models/sample.rb:1:in<top (required)>'
app/controllers/samples_controller.rb:1:in `<top (required)>'

@paulsfds I just clone your project, ran bundle install, ran bundle exec rails s, hit /samples and everything worked fine. Could you update your bundler and see if the problem disappears?

@goncalossilva I don't know what the problem is, but I'm still getting the same error. I am using Bundler version 1.0.21. I tried uninstalling the gem (gem uninstall mongoid-sequence -a) and deleting the Gemfile.lock. I also tried bundle update, but the gem is up to date already. I wonder if anyone else is having this issue or is it just me?

@paulsfds I'm using ruby 1.9.3p125 and bundler 1.1.1 here.

@paulsfds I'm 99% confident that you won't have that issue anymore with mongoid-sequence 0.1 (released a few minutes ago). Try it! :)

@goncalossilva I'm playing around with this gem again (I had forgotten about it for a month), and it seems to be working but I noticed one issue. The model's find() method only takes an integer, and it errors out if you try and pass it a string.

1.9.2-p290 :022 > Sample.find(1)
=> #<Sample _id: 1, _type: nil, name: nil>

1.9.2-p290 :024 > Sample.find("1")
BSON::InvalidObjectId: illegal ObjectId format: 1

The default Mongoid implementation of find takes only a string. A workaround is to just force the param to be an integer like so:
@sample = Sample.find(params[:id].to_i)

I noticed that in your gem, the id actually becomes an integer whereas in Mongoid, the id is a BSON::ObjectId object. This may be the problem, is there a way to store the sequential numbers (for ids) as BSON::ObjectId instead of as in integer?

1.9.2-p290 :027 > Sample.find(1)._id
=> 1
1.9.2-p290 :028 > Sample.find(1)._id.is_a?(Integer)
=> true

1.9.2-p290 :009 > Event.first._id
=> BSON::ObjectId('4f98e4271d41c827cb000007')
1.9.2-p290 :010 > Event.first._id.is_a?(Integer)
=> false

@paulsfds I believe that's the default behavior when you field :my_id, :type => Integer... the sequencing code doesn't play with any of that. Please open an issue with this if you think it's something else :)