mongoid-bigbang 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07d925181ee2f503fac3385f29ca45dc87e39f87
+  data.tar.gz: 1fc92dda7e7fc6b1144ccb142367f791bf5efa4b
+SHA512:
+  metadata.gz: 2b07eac33662dbf71a0f35dccb3461cd9f2626c33e87a56a8380afed44e10179a4acab80f94e8f30a189ac9581725feb458e56340ff5d70931f3d8760950a4f2
+  data.tar.gz: 6657d7cc692842f6e9bb4546fe141f86b55ce20cb787a5e0f377568ea0b9f90c9656d0fb06ebaa05dbbc34536ceb90c7cc004be932d4e6a79d63704d0ef05c72

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Daniel Serrano
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Mongoid::Bigbang
+
+> They say it all started out with a big bang. But, what I wonder is, was it a big bang or did it just seem big because there wasn't anything else drown it out at the time? - Karl Pilkington
+
+## Why?
+
+When you have a project in which you are not using `Mongoid::Timestamps` and you want to mock an object's creation time, you have to do some cumbersome operations in order to get those first 4 bytes of the `ObjectId` to represent the seconds since the Unix epoch that you want for that object.
+
+Particularly, if you want to have two objects with the same creation time, it would not suffice to generate the IDs via the `BSON::ObjectId.from_time` method, since it would yield the same ID for both objects, and you probably do not want them to be seen as the same object.
+
+This gem solves this little annoying issue by generating a unique ID for the given timestamp by using the other 8 bytes in `ObjectId` to generate the needed additional entropy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-bigbang'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-bigbang
+
+## Usage
+
+Whenever you want to generate a new `ObjectId` for a given timestamp, just call the `Mongoid::Bigbang.id_from_time` method, like follows:
+
+```ruby
+# from time as String
+Mongoid::Bigbang.id_from_time('18-01-2015 15:53:00 +0000')
+
+# from time as Integer
+Mongoid::Bigbang.id_from_time(1421596380)
+
+# from time as Time
+time = Time.parse('18-01-2015 15:53:00 +0000')
+Mongoid::Bigbang.id_from_time(time)
+```
+
+It is recommended that you add the following to your `spec_helper`:
+
+```ruby
+RSpec.configure do |config|
+  config.before(:each) do
+    Mongoid::Bigbang.clean
+  end
+
+  # your other configs...
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mongoid-bigbang/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/mongoid/bigbang.rb

@@ -0,0 +1,16 @@
+require 'mongoid/bigbang/version'
+require 'mongoid/bigbang/generator'
+
+module Mongoid
+  module Bigbang
+
+    def self.id_from_time(time)
+      Mongoid::Bigbang::Generator.instance.id_from_time(time)
+    end
+
+    def self.clean
+      Mongoid::Bigbang::Generator.instance.clean
+    end
+
+  end
+end

data/lib/mongoid/bigbang/generator.rb

@@ -0,0 +1,61 @@
+require 'singleton'
+require 'time'
+require 'securerandom'
+require 'moped'
+
+module Mongoid
+  module Bigbang
+    class Generator
+
+      include Singleton
+
+      attr_reader :used
+
+      def initialize()
+        clean
+      end
+
+      def clean
+        @used = {}
+      end
+
+      def id_from_time(time)
+        time = unix_time(time)
+        string = time.to_s(16) + random_for(time)
+        BSON::ObjectId.from_string(string)
+      end
+
+      private
+      def unix_time(time)
+        case time
+        when Time
+          time.to_i
+        when Integer
+          time
+        when String
+          Time.parse(time).to_i
+        else
+          raise ArgumentError
+        end
+      end
+
+      def random_for(time)
+        random = secure_random
+        while already_used?(time, random)
+          random = secure_random
+        end
+        used[time] ? used[time].push(random) : used[time] = [random]
+        random
+      end
+
+      def secure_random
+        SecureRandom.hex(8)
+      end
+
+      def already_used?(time, random)
+        used[time] && used[time].include?(random)
+      end
+
+    end
+  end
+end

data/lib/mongoid/bigbang/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Bigbang
+    VERSION = "0.0.2"
+  end
+end

data/mongoid-bigbang.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/bigbang/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-bigbang"
+  spec.version       = Mongoid::Bigbang::VERSION
+  spec.authors       = ["Daniel Serrano"]
+  spec.email         = ["danieljdserrano@gmail.com"]
+  spec.summary       = %q{Mock creation times through Moped::BSON::ObjectId.}
+  spec.description   = %Q{
+    When you have a project in which you are not using Mongoid::Timestamps and you want to mock an object's creation time, you have to do some cumbersome operations in order to get those first 4 bytes of the ObjectId to represent the seconds since the Unix epoch that you want for that object.\n
+    Particularly, if you want to have two objects with the same creation time, it would not suffice to generate the IDs via the BSON::ObjectId.from_time method, since it would yield the same ID for both objects, and you probably do not want them to be seen as the same object.\n
+    This gem solves this little annoying issue by generating a unique ID for the given timestamp by using the other 8 bytes in ObjectId to generate the needed additional entropy.
+  }
+  spec.homepage      = "https://github.com/dnlserrano/mongoid-bigbang"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency "pry-byebug", "~> 2.0.0"
+
+  spec.add_dependency "moped", "~> 2.0.0"
+end

data/spec/integration_spec_helper.rb

@@ -0,0 +1,17 @@
+require 'database_cleaner'
+require 'spec_helper'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.clean_with :truncation, { :reset_ids => true }
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean_with :truncation, { :reset_ids => true }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.color = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+end

data/spec/unit/mongoid/bigbang/bigbang_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'mongoid/bigbang'
+
+describe Mongoid::Bigbang do
+
+  subject { Mongoid::Bigbang }
+
+  let(:generator) { Mongoid::Bigbang::Generator.instance }
+  let(:time) { '18-01-2015 15:53:00 +0000' }
+
+  describe '.id_from_time' do
+    it 'calls the corresponding method on the generator' do
+      generator.should_receive(:id_from_time)
+      subject.id_from_time(time)
+    end
+  end
+
+  describe '.clean' do
+    it 'calls the corresponding method on the generator' do
+      generator.should_receive(:clean)
+      subject.clean
+    end
+  end
+
+end

data/spec/unit/mongoid/bigbang/generator_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'mongoid/bigbang/generator'
+
+describe Mongoid::Bigbang::Generator do
+
+  subject { Mongoid::Bigbang::Generator.instance }
+
+  describe '#id_from_time' do
+    let(:bigbang) { Time.parse('18-01-2015 15:53:00 +0000') }
+
+    it 'generates an id for the given time' do
+      id = subject.id_from_time(bigbang)
+      id.generation_time.should eq bigbang
+    end
+
+    context 'when the time is a string' do
+      let(:time) { bigbang.to_s }
+      it 'generates an id for the given time' do
+        id = subject.id_from_time(time)
+        id.generation_time.should eq bigbang
+      end
+    end
+
+    context 'when the time is an integer' do
+      let(:time) { bigbang.to_i }
+      it 'generates an id for the given time' do
+        id = subject.id_from_time(time)
+        id.generation_time.should eq bigbang
+      end
+    end
+
+    context 'when the random part has already been used for that timestamp' do
+      let(:secure_random) { SecureRandom }
+      it 'generates another random part' do
+        secure_random.should_receive(:hex).twice.and_return("63dd436fe9be4ece")
+        secure_random.should_receive(:hex).once.and_return("7cfe2c1518f8711b")
+        subject.should_receive(:secure_random).exactly(3).times.and_call_original
+
+        # create first ObjectId for this timestamp
+        # 1st call - does not enter loop since random 63dd436fe9be4ece doesn't exist yet
+        subject.id_from_time(bigbang)
+
+        # create second ObjectId for this timestamp
+        # 2nd call - enters loop because we force random 63dd436fe9be4ece to be returned again
+        # 3rd call - does not enter loop because it generates a new random 7cfe2c1518f8711b
+        subject.id_from_time(bigbang)
+      end
+    end
+
+    describe '#clean' do
+      it 'clears the already used randoms for each timestamp' do
+        subject.id_from_time(bigbang)
+        subject.used.length.should_not eq 0
+
+        subject.clean
+        subject.used.length.should eq 0
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-bigbang
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daniel Serrano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: moped
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: "\n    When you have a project in which you are not using Mongoid::Timestamps
+  and you want to mock an object's creation time, you have to do some cumbersome operations
+  in order to get those first 4 bytes of the ObjectId to represent the seconds since
+  the Unix epoch that you want for that object.\n\n    Particularly, if you want to
+  have two objects with the same creation time, it would not suffice to generate the
+  IDs via the BSON::ObjectId.from_time method, since it would yield the same ID for
+  both objects, and you probably do not want them to be seen as the same object.\n\n
+  \   This gem solves this little annoying issue by generating a unique ID for the
+  given timestamp by using the other 8 bytes in ObjectId to generate the needed additional
+  entropy.\n  "
+email:
+- danieljdserrano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/bigbang.rb
+- lib/mongoid/bigbang/generator.rb
+- lib/mongoid/bigbang/version.rb
+- mongoid-bigbang.gemspec
+- spec/integration_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid/bigbang/bigbang_spec.rb
+- spec/unit/mongoid/bigbang/generator_spec.rb
+homepage: https://github.com/dnlserrano/mongoid-bigbang
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Mock creation times through Moped::BSON::ObjectId.
+test_files:
+- spec/integration_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid/bigbang/bigbang_spec.rb
+- spec/unit/mongoid/bigbang/generator_spec.rb