mongoid-autoinc 0.5.1 → 4.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MzE2NjY5ZmUwNzcyMjI1YjU4NTNjMDU1OTYzMGRkZjk3ZGE1MzRhOA==
-  data.tar.gz: !binary |-
-    NmJjYzFmMTUyNGIzNDM4NzM3M2Q4YTA3Y2M4NDMyZjhiOWE5NWZlYw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MmQ4MDc1ODYzMmU5YzdiYzBhMDc3OWVlMzExNjliZmU4MjRhZWMzMmQ2MzA3
-    MmZmMjQ1ODM5NWFjOGNiZTgxMTExMDAzMDA3Mzk4ZjIyODY4ZTc1NWEzMmU1
-    NTUxN2I4ODA4YjM3MmZkOWVhMzBkN2I2NDllMDQ5MDIwNGVmMDQ=
-  data.tar.gz: !binary |-
-    ZWQ2YWFkYjQ5YmM4ZTM3OWQzOTFlNmE4YzUzMTdkOTA2MjBjNDA2ZTg1ZWYw
-    NzVjNzUxMDY1NDRhZDg5NTRhN2Q3ODNhY2FjZTNlYjY1ZTE0N2MxMzdmYTU5
-    ODY5ZmE5MjUzZDFlOGRhOGUwMWM1YjMyODUxMDM5YTViNDRjZjk=
+SHA1:
+  metadata.gz: 96d00a61057fb2bc8e9fb2132a53f0621c0d3e90
+  data.tar.gz: 7ab2a16af4c5e473cf4c37ffc44982af4cd7dd3e
+SHA512:
+  metadata.gz: 99e700cf5996f0e5002e2f7dd40281a35041511170500052a44537f4b03c24deef3a38fb4b2d53c6f75341e607d91d000247717a36361001edcdc02921685250
+  data.tar.gz: 70e77ba82f5dd884b7dd6f23dd9622bacb43586a85ba3e25a5bccf95882240a20ce7a8971542fb34e4f60a895fe6c87cb575d7c729a783dcee64031d9430ae9e

data/README.md

@@ -0,0 +1,199 @@
+# mongoid-autoinc
+
+A mongoid plugin to add auto incrementing fields to your documents.
+
+[![Build Status](https://travis-ci.org/suweller/mongoid-autoinc.png?branch=master)](https://travis-ci.org/suweller/mongoid-autoinc)
+[![Code Climate](https://codeclimate.com/github/suweller/mongoid-autoinc.png)](https://codeclimate.com/github/suweller/mongoid-autoinc)
+
+# Versions
+
+Use 0.1.3 for mongoid 2.0
+
+Use 0.3.0 for mongoid 3.0
+
+Use the `mongoid-4` branch for mongoid 4.0.
+We'll ship a new gem version when the mongoid 4.x gem is released.
+
+## Installation
+
+in gemfile:
+
+``` ruby
+gem 'mongoid-autoinc'
+```
+
+in class:
+
+``` ruby
+require 'autoinc'
+```
+
+## Usage
+
+``` ruby
+# app/models/user.rb
+class User
+  include Mongoid::Document
+  include Mongoid::Autoinc
+  field :name
+  field :number, :type => Integer
+
+  increments :number
+end
+
+user = User.create(:name => 'Dr. Percival "Perry" Ulysses Cox')
+user.id # BSON::ObjectId('4d1d150d30f2246bc6000001')
+user.number # 1
+
+another_user = User.create(:name => 'Bob Kelso')
+another_user.number # 2
+```
+
+### Scopes
+
+You can scope on document fields. For example:
+
+``` ruby
+class PatientFile
+  include Mongoid::Document
+  include Mongoid::Autoinc
+
+  field :name
+  field :number, :type => Integer
+
+  increments :number, :scope => :patient_id
+
+  belongs_to :patient
+
+end
+```
+
+Scope can also be a Proc:
+
+``` ruby
+increments :number, :scope => lambda { patient.name }
+```
+
+### Custom Increment Trigger
+
+You can trigger the assignment of an increment field manually by passing:
+`:auto => false` to the increment field.
+This allows for more flexible assignment of your increment number:
+
+``` ruby
+class Intern
+  include Mongoid::Document
+  include Mongoid::Autoinc
+
+  field :name
+  field :number
+
+  increments :number, :auto => false
+
+  after_save :assign_number_to_jd
+
+  protected
+
+  def assign_number_to_jd
+    assign!(:number) if number.blank? && name == 'J.D.'
+  end
+
+end
+```
+
+### Custom Model Name
+
+You can override the model name used to generate the autoincrement keys. This can be useful
+when working with subclasses or namespaces.
+
+``` ruby
+class Intern
+  include Mongoid::Document
+  include Mongoid::Autoinc
+
+  field :name
+  field :number
+
+  increments :number, model_name => :foo
+end
+```
+
+### Seeds
+
+You can use a seed to start the incrementing field at a given value. The first
+document created will start at 'seed + 1'.
+
+``` ruby
+class Vehicle
+  include Mongoid::Document
+  include Mongoid::Autoinc
+
+  field :model
+  field :vin
+
+  increments :vin, seed: 1000
+
+end
+
+car = Vehicle.new(model: "Coupe")
+car.vin # 1001
+```
+
+### Step
+
+The step option can be used to specify the amount to increment the field every
+time a new document is created. If no step is specified, it will increment by
+1.
+
+``` ruby
+class Ticket
+  include Mongoid::Document
+  include Mongoid::Autoinc
+
+  field :number
+
+  increments :number, step: 5
+
+end
+```
+``` ruby
+first_ticket = Ticket.new
+first_ticket.number # 5
+second_ticket = Ticket.new
+second_ticket.number # 10
+```
+
+The step option can also be a Proc:
+
+``` ruby
+increments :number, step: lambda { 1 + rand(10) }
+```
+
+### Development
+
+```
+$ gem install bundler (if you don't have it)
+$ bundle install
+$ bundle exec spec
+```
+
+## Contributing
+
+* Fork and create a topic branch.
+* Follow the
+  [80beans styleguide](https://gist.github.com/b896eb9e66fc6ab3640d).
+  Basically the [rubystyleguide](https://github.com/bbatsov/ruby-style-guide/)
+  with some minor changes.
+* Submit a pull request
+
+## Contributions
+
+Thanks to Johnny Shields (@johnnyshields) for implementing proc support to scopes
+And to Marcus Gartner (@mgartner) for implementing the seed functionality
+
+Kris Martin (@krismartin) and Johnny Shields (@johnnyshields) for adding the
+overwritten model name feature
+
+## Copyright
+
+See LICENSE for details

data/lib/autoinc.rb

@@ -24,7 +24,7 @@ module Mongoid
 
       def increments(field, options={})
         incrementing_fields[field] = options.reverse_merge!(:auto => true)
-        attr_protected field
+        attr_protected(field) if respond_to?(:attr_protected)
       end
 
     end
@@ -43,24 +43,37 @@ module Mongoid
     end
 
     def increment!(field, options)
-      scope_key = options[:scope] ? evaluate_scope(options[:scope]) : nil
-      seed = options[:seed]
+      options = options.dup
+      model_name = (options.delete(:model_name) || self.class.model_name).to_s
+      options[:scope] = evaluate_scope(options[:scope]) if options[:scope]
+      options[:step] = evaluate_step(options[:step]) if options[:step]
       write_attribute(
-          field.to_sym, Mongoid::Autoinc::Incrementor.new(
-          self.class.model_name, field, scope_key, seed).inc
+          field.to_sym, Mongoid::Autoinc::Incrementor.new(model_name, field, options).inc
       )
     end
 
     def evaluate_scope(scope)
-      if scope.is_a? Symbol
-        send(scope)
-      elsif scope.is_a? Proc
-        instance_exec &scope
-      else
-        raise 'scope is not a Symbol or a Proc'
+      case scope
+      when Symbol then send(scope)
+      when Proc then instance_exec &scope
+      else raise 'scope is not a Symbol or a Proc'
       end
     end
 
+    def evaluate_step(step)
+      case step
+      when Integer then step
+      when Proc then evaluate_step_proc(step)
+      else raise 'step is not an Integer or a Proc'
+      end
+    end
+
+    def evaluate_step_proc(step_proc)
+      result = instance_exec &step_proc
+      return result if result.is_a? Integer
+      raise 'step Proc does not evaluate to an Integer'
+    end
+
   end
 
 end

data/lib/autoinc/incrementor.rb

@@ -3,14 +3,15 @@ module Mongoid
   module Autoinc
 
     class Incrementor
-      attr_accessor :model_name, :field_name, :scope_key, :collection, :seed
+      attr_accessor :model_name, :field_name, :scope_key, :collection, :seed, :step
 
-      def initialize(model_name, field_name, scope_key=nil, seed=nil)
-        self.model_name = model_name
+      def initialize(model_name, field_name, options={})
+        self.model_name = model_name.to_s
         self.field_name = field_name.to_s
-        self.scope_key = scope_key
+        self.scope_key = options[:scope]
+        self.step = options[:step] || 1
+        self.seed = options[:seed]
         self.collection = ::Mongoid.default_session['auto_increment_counters']
-        self.seed = seed
         create if seed && !exists?
       end
 
@@ -25,7 +26,7 @@ module Mongoid
         collection.find(
           '_id' => key
         ).modify(
-          {'$inc' => { 'c' => 1 }},
+          {'$inc' => { 'c' => step }},
           :new => true, :upsert => true
         )['c']
       end

data/lib/autoinc/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Autoinc
-    VERSION = "0.5.1"
+    VERSION = "4.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-autoinc
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,79 +10,79 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: foreman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: foreman
+  name: rspec
   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: rspec
+  name: pry
   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: Think auto incrementing field from MySQL for mongoid.
+description: Think auto incrementing field from SQL for mongoid.
 email:
 - robert@80beans.com
 - steven@80beans.com
@@ -91,12 +91,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/autoinc.rb
 - lib/autoinc/incrementor.rb
 - lib/autoinc/version.rb
-- lib/autoinc.rb
-- README.rdoc
-homepage: https://github.com/80beans/mongoid-autoinc
-licenses: []
+homepage: https://github.com/suweller/mongoid-autoinc
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -104,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Add auto incrementing fields to mongoid documents

data/README.rdoc

@@ -1,122 +0,0 @@
-= mongoid-autoinc
-
-= Versions
-
-Use 0.1.3 for mongoid 2.0
-
-use 0.3.0 for mongoid 3.0
-
-
-A mongoid plugin to add auto incrementing fields to your documents.
-
-{<img src="https://secure.travis-ci.org/80beans/mongoid-autoinc.png" />}[http://travis-ci.org/#!/80beans/mongoid-autoinc]
-{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/80beans/mongoid-autoinc]
-
-== Installation
-
-in gemfile:
-
-    gem 'mongoid-autoinc'
-
-in class:
-
-    require 'autoinc'
-
-=== Usage
-
-  # app/models/user.rb
-  class User
-    include Mongoid::Document
-    include Mongoid::Autoinc
-    field :name
-    field :number, :type => Integer
-
-    increments :number
-  end
-
-  user = User.create(:name => 'Dr. Percival "Perry" Ulysses Cox')
-  user.id # BSON::ObjectId('4d1d150d30f2246bc6000001')
-  user.number # 1
-
-  another_user = User.create(:name => 'Bob Kelso')
-  another_user.number # 2
-
-=== Scopes
-
-You can scope on document fields. For example:
-
- class PatientFile
-   include Mongoid::Document
-   include Mongoid::Autoinc
-
-   field :name
-   field :number, :type => Integer
-
-   increments :number, :scope => :patient_id
-
-   belongs_to :patient
-
- end
-
-Scope can also be a Proc:
-
-   increments :number, :scope => lambda { patient.name }
-
-=== Custom Increment Trigger
-
-You can trigger the assignment of an increment field manually by passing:
-+:auto => false+ to the increment field.
-This allows for more flexible assignment of your increment number:
-
-  class Intern
-    include Mongoid::Document
-    include Mongoid::Autoinc
-
-    field :name
-    field :number
-
-    increments :number, :auto => false
-
-    after_save :assign_number_to_jd
-
-    protected
-
-    def assign_number_to_jd
-      assign!(:number) if number.blank? && name == 'J.D.'
-    end
-
-  end
-
-=== Seeds
-
-You can use a seed to start the incrementing field at a given value. The first
-document created will start at `seed + 1`.
-
-  class Vehicle
-    include Mongoid::Document
-    include Mongoid::Autoinc
-
-    field :model
-    field :vin
-
-    increments :vin, seed: 1000
-
-  end
-
-  car = Vehicle.new(model: "Coupe")
-  car.vin # 1001
-
-=== Development
-
-  $ gem install bundler (if you don't have it)
-  $ bundle install
-  $ bundle exec spec
-
-== Contributions
-
-Thanks to Johnny Shields (@johnnyshields) for implementing proc support to scopes
-And to Marcus Gartner (@mgartner) for implementing the seed functionality
-
-== Copyright
-
-See LICENSE for details