mongoid_fixtures 0.1.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.2.0
+
+before_install:
+  - gem install bundler
+
+services:
+  - mongodb
+
+before_script:
+  - sleep 15
+  - mongo mongoid_fixtures_development --eval 'db.addUser("travis", "test");'

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_fixtures.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Javier L. Velasquez
+
+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,362 @@
+# MongoidFixtures
+Fixtures for Ruby for Mongoid. No Rails needed!
+
+[![Code Climate](https://codeclimate.com/github/nycjv321/mongoid_fixtures/badges/gpa.svg)](https://codeclimate.com/github/nycjv321/mongoid_fixtures)
+[![Test Coverage](https://codeclimate.com/github/nycjv321/mongoid_fixtures/badges/coverage.svg)](https://codeclimate.com/github/nycjv321/mongoid_fixtures/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_fixtures'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_fixtures
+
+## Example Usage
+
+1.  Define some Mongoid Documents. The class structure is pretty silly and only meant to demonstrate the different modes. 
+
+        class GeopoliticalDivision
+          include Mongoid::Document
+          field :name, type: String
+          field :time_zone, type: String
+          field :demonym, type: String
+          field :settled, type: Integer
+          field :consolidated, type: Integer
+          field :custom_attributes, type: Array
+          belongs_to :geo_uri_scheme
+          embeds_one :population
+          embeds_many :people
+
+        end
+
+        class Population
+          include Mongoid::Document
+
+          field :total, type: Integer
+          field :rank, type: Integer
+          field :density, type: String
+          field :msa, type: Integer
+          field :csa, type: Integer
+          field :source, type: String
+          embedded_in :geopolitical_division
+
+        end
+
+        class City < GeopoliticalDivision
+          include Mongoid::Document
+          belongs_to :state
+        end
+
+        class State < GeopoliticalDivision
+          include Mongoid::Document
+
+          field :motto, type: String
+          field :admission_to_union, type: String
+
+          has_many :cities
+
+        end
+
+        class GeoUriScheme
+          include Mongoid::Document
+
+          field :x, type: Float
+          field :y, type: Float
+          field :z, type: Float
+
+          alias :longitude :x
+          alias :latitude :y
+          alias :altitude :z
+        end
+
+        class Person
+          include Mongoid::Document
+
+          embedded_in :geopolitical_division
+
+          field :first_name, type: String
+          field :paternal_surname, type: String
+          field :born, type: Date
+          field :description, type: String
+          field :middle_name, type: String
+          field :suffix, type: String
+          field :died, type: Date
+          field :maternal_surname, type: String
+          field :nick_names, type: Array
+
+        end
+
+2.  Defin efixtures  in /test/fixtures/ with a plural form of the class
+
+    /test/fixtures/cities.yml:    
+    
+        :new_york_city:
+          name: New York City
+          :population:
+            total: 9_000_000
+            rank: 1
+            density: 10,756.0/km2
+            msa: 20,092,883
+            csa: 23,632,722
+            source: U.S. Census (2014)
+          demonym: New Yorker
+          settled: 1624
+          consolidated: 1989
+          custom_attributes:
+            - boroughs: ['Manhattan', 'The Bronx', 'Brooklyn', 'Queens', 'Staten Island']
+          :people:
+            - first_name: Kareem
+              paternal_surname: Abdul-Jabbar
+              born: April 16, 1947
+              description: basketball player
+            - first_name: Robert
+              middle_name: John
+              paternal_surname: Downey
+              suffix: Jr.
+              born: April 4, 1965
+              description: an American actor whose career has included critical and popular success in his youth, followed by a period of substance abuse and legal troubles, and a resurgence of commercial success in middle age.
+            - first_name: Edward
+              middle_name: Kennedy
+              paternal_surname: Ellington
+              nick_names:
+                - Duke
+              born: April 29, 1899
+              died: May 24, 1974
+              description: was an American composer, pianist and bandleader of jazz orchestras. He led his orchestra from 1923 until his death, his career spanning over 50 years.
+            - first_name: Christopher
+              middle_name: George
+              paternal_surname: Latore
+              maternal_surname: Wallace
+              nick_names:
+                - The Notorious B.I.G.
+                - B.I.G.
+                - Biggie Smalls
+                - Big Poppa
+                - Frank White
+                - King of New York
+              born: May 21, 1972
+              died: March 9, 1997
+              description: was an American rapper. Wallace is consistently ranked as one of the greatest rappers ever and one of the most influential rappers of all time.
+          state: :new_york
+          geo_uri_scheme: :new_york_city
+        :terrytown:
+          name: Terrytown
+          state: :louisiana
+          :population:
+            total: 24_000
+          geo_uri_scheme: :terrytown
+
+    /test/fixtures/states.yml:   
+        
+        :new_york:
+          name: New York
+          :population:
+            total: 20_000_000
+          demonym: New Yorker
+          capital: Albany
+          motto: Excelsior
+          admission_to_union: July 26th, 1788
+          time_zone: "Eastern: UTC -5/-4"
+        :louisiana:
+          name: Louisiana
+          :population:
+            total: 4_700_000
+          demonym: Louisianian
+          capital: Baton Rouge
+          motto: Union, Justice, Confidence
+          admission_to_union: April 30th, 1812
+          time_zone: "Central: UTC −6/−5"
+
+
+    /test/fixtures/geourischemes.yml
+
+        :terrytown:
+          x: -90.029444
+          y: 29.902222
+          z: 3.9624
+        :new_york_city:
+          x: -74.0059
+          y: 40.7127
+          z: 0.6096
+            
+
+    You may notice attributes that represent relationships are automatically converted to
+    the corresponding ruby objects based on the provided id. Currently, this library supports
+    1-N referenced, 1-1 referenced, 1-1 embedded relationships, and 1-N embedded relationships.
+    If a relation already exists in the db, this library will return it instead of recreating it.
+    
+3.  Invoke `MongoidFixtures::load(City)`
+4.  The above method invocation will load all test fixture instances of City objects defined
+    in /test/fixtures/cities.yml as well as dependent objects
+5.  Use your fixtures!
+
+        cities = MongoidFixtures::load(City)
+        puts cities # {:new_york_city=>#<City _id: 55ebc6b2e138231068000004, name: "New York City", time_zone: nil, demonym: "New Yorker", settled: 1624, consolidated: 1989, custom_attributes: [{"boroughs"=>["Manhattan", "The Bronx", "Brooklyn", "Queens", "Staten Island"]}], geo_uri_scheme_id: BSON::ObjectId('55ebc6b2e138231068000006'), _type: "City", state_id: BSON::ObjectId('55ebc6b2e138231068000000')>, :terrytown=>#<City _id: 55ebc6b2e13823106800000c, name: "Terrytown", time_zone: nil, demonym: nil, settled: nil, consolidated: nil, custom_attributes: nil, geo_uri_scheme_id: BSON::ObjectId('55ebc6b2e138231068000005'), _type: "City", state_id: BSON::ObjectId('55ebc6b2e138231068000002')>}
+
+    In the DB:
+      
+        /* 0 */
+        {
+            "_id" : ObjectId("55eb4adae1382309c5000003"),
+            "x" : -90.029444,
+            "y" : 29.902222,
+            "z" : 3.9624
+        }
+
+        /* 1 */
+        {
+            "_id" : ObjectId("55eb4adae1382309c5000004"),
+            "x" : -74.0059,
+            "y" : 40.7127,
+            "z" : 0.6096
+        }
+
+        /* 0 */
+        {
+            "_id" : ObjectId("55ebc6b2e138231068000000"),
+            "_type" : "State",
+            "name" : "New York",
+            "population" : {
+                "_id" : ObjectId("55ebc6b2e138231068000001"),
+                "total" : 20000000
+            },
+            "demonym" : "New Yorker",
+            "capital" : "Albany",
+            "motto" : "Excelsior",
+            "admission_to_union" : "July 26th, 1788",
+            "time_zone" : "Eastern: UTC -5/-4"
+        }
+
+        /* 1 */
+        {
+            "_id" : ObjectId("55ebc6b2e138231068000002"),
+            "_type" : "State",
+            "name" : "Louisiana",
+            "population" : {
+                "_id" : ObjectId("55ebc6b2e138231068000003"),
+                "total" : 4700000
+            },
+            "demonym" : "Louisianian",
+            "capital" : "Baton Rouge",
+            "motto" : "Union, Justice, Confidence",
+            "admission_to_union" : "April 30th, 1812",
+            "time_zone" : "Central: UTC −6/−5"
+        }
+
+        /* 2 */
+        {
+            "_id" : ObjectId("55ebc6b2e138231068000004"),
+            "_type" : "City",
+            "name" : "New York City",
+            "population" : {
+                "_id" : ObjectId("55ebc6b2e138231068000007"),
+                "total" : 9000000,
+                "rank" : 1,
+                "density" : "10,756.0/km2",
+                "msa" : 20092883,
+                "csa" : 23632722,
+                "source" : "U.S. Census (2014)"
+            },
+            "demonym" : "New Yorker",
+            "settled" : 1624,
+            "consolidated" : 1989,
+            "custom_attributes" : [
+                {
+                    "boroughs" : [
+                        "Manhattan",
+                        "The Bronx",
+                        "Brooklyn",
+                        "Queens",
+                        "Staten Island"
+                    ]
+                }
+            ],
+            "people" : [
+                {
+                    "_id" : ObjectId("55ebc6b2e138231068000008"),
+                    "first_name" : "Kareem",
+                    "paternal_surname" : "Abdul-Jabbar",
+                    "born" : ISODate("1947-04-16T00:00:00.000Z"),
+                    "description" : "basketball player"
+                },
+                {
+                    "_id" : ObjectId("55ebc6b2e138231068000009"),
+                    "first_name" : "Robert",
+                    "middle_name" : "John",
+                    "paternal_surname" : "Downey",
+                    "suffix" : "Jr.",
+                    "born" : ISODate("1965-04-04T00:00:00.000Z"),
+                    "description" : "an American actor whose career has included critical and popular success in his youth, followed by a period of substance abuse and legal troubles, and a resurgence of commercial success in middle age."
+                },
+                {
+                    "_id" : ObjectId("55ebc6b2e13823106800000a"),
+                    "first_name" : "Edward",
+                    "middle_name" : "Kennedy",
+                    "paternal_surname" : "Ellington",
+                    "nick_names" : [
+                        "Duke"
+                    ],
+                    "born" : ISODate("1899-04-29T00:00:00.000Z"),
+                    "died" : ISODate("1974-05-24T00:00:00.000Z"),
+                    "description" : "was an American composer, pianist and bandleader of jazz orchestras. He led his orchestra from 1923 until his death, his career spanning over 50 years."
+                },
+                {
+                    "_id" : ObjectId("55ebc6b2e13823106800000b"),
+                    "first_name" : "Christopher",
+                    "middle_name" : "George",
+                    "paternal_surname" : "Latore",
+                    "maternal_surname" : "Wallace",
+                    "nick_names" : [
+                        "The Notorious B.I.G.",
+                        "B.I.G.",
+                        "Biggie Smalls",
+                        "Big Poppa",
+                        "Frank White",
+                        "King of New York"
+                    ],
+                    "born" : ISODate("1972-05-21T00:00:00.000Z"),
+                    "died" : ISODate("1997-03-09T00:00:00.000Z"),
+                    "description" : "was an American rapper. Wallace is consistently ranked as one of the greatest rappers ever and one of the most influential rappers of all time."
+                }
+            ],
+            "state_id" : ObjectId("55ebc6b2e138231068000000"),
+            "geo_uri_scheme_id" : ObjectId("55ebc6b2e138231068000006")
+        }
+
+        /* 3 */
+        {
+            "_id" : ObjectId("55ebc6b2e13823106800000c"),
+            "_type" : "City",
+            "name" : "Terrytown",
+            "state_id" : ObjectId("55ebc6b2e138231068000002"),
+            "population" : {
+                "_id" : ObjectId("55ebc6b2e13823106800000d"),
+                "total" : 24000
+            },
+            "geo_uri_scheme_id" : ObjectId("55ebc6b2e138231068000005")
+        }
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nycjv321/mongoid_fixtures.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/mongoid_fixtures_spec.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid_fixtures"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.yml

@@ -0,0 +1,6 @@
+development:
+  sessions:
+    default:
+      database: mongoid_fixtures_development
+      hosts:
+        - 127.0.0.1:27017

data/lib/mongoid_fixtures/embed_utils.rb

@@ -0,0 +1,36 @@
+module EmbedUtils
+  def self.create_embedded_instance(clazz, hash, instance)
+    embed = clazz.new
+    hash.each do |key, value|
+      embed.send("#{key}=", value)
+    end
+    embed.send("#{find_embed_parent_class(embed)}=", instance)
+    embed
+  end
+
+  def self.find_embed_parent_class(embed)
+    relations = embed.relations
+
+    relations.each do |name, relation|
+      if relation.relation.eql? Mongoid::Relations::Embedded::In
+        return name
+      end
+    end
+    raise 'Unable to find parent class'
+  end
+
+  def self.insert_embedded_ids(instance)
+    attributes = instance.attributes.select { |key, value| !key.to_s.eql?('_id') }
+
+    attributes.each do |key, value|
+      if attributes[key].is_a? Hash
+        unless instance.send(key)._id.nil?
+          attributes[key]['_id'] = instance.send(key)._id
+        end
+      else
+        attributes[key] = value
+      end
+    end
+    attributes
+  end
+end

data/lib/mongoid_fixtures/version.rb

@@ -0,0 +1,3 @@
+module MongoidFixtures
+  VERSION = "0.1.0"
+end

data/lib/mongoid_fixtures.rb

@@ -0,0 +1,151 @@
+require_relative '../lib/mongoid_fixtures/version'
+require 'yaml'
+require 'singleton'
+require 'linguistics'
+require 'active_support/inflector'
+require 'monkey_patches/module'
+require_relative 'mongoid_fixtures/embed_utils'
+
+module MongoidFixtures
+
+  class Loader
+    include Singleton
+
+    attr_accessor :fixtures, :path
+
+    def initialize
+      @fixtures = {}
+    end
+
+    def self.load
+      load_fixtures Dir[File.join(File.expand_path('../..', __FILE__), "#{path}/*.yml")]
+    end
+
+    def self.load_fixtures(fixture_names)
+      fix = MongoidFixtures::Loader.instance
+      fixture_names.each do |fixture|
+        fix.fixtures[File.basename(fixture, '.*')] = YAML.load_file(fixture)
+      end
+      fix
+    end
+
+    def self.path=(var)
+      Loader.instance.path = var
+    end
+
+    def self.path
+      Loader.instance.path
+    end
+  end
+  :private
+
+  Linguistics.use(:en)
+  Loader::path = 'test/fixtures'
+  Loader::load
+
+  def self.load(clazz)
+    fixture_instances = Loader.instance.fixtures[clazz.to_s.downcase.en.plural] # get class name
+    instances = {}
+    if fixture_instances.nil?
+      raise "Could not find instances for #{clazz}"
+    end
+    fixture_instances.each do |key, fixture_instance|
+      instance = clazz.new
+      fields = fixture_instance.keys
+      fields.each do |field|
+
+        value = fixture_instance[field]
+        field_label = field.to_s.capitalize
+        field_clazz = Module.resolve_class_ignore_plurality(field_label)
+
+        # If the current value is a symbol then it represents another fixture.
+        # Find it and store its id
+        if value.is_a? Symbol or value.nil?
+          relations = instance.relations
+          if relations.include? field
+            if relations[field].relation.eql? Mongoid::Relations::Referenced::In or relations[field].relation.eql? Mongoid::Relations::Referenced::One
+              instance.send("#{field}=", self.load(field_clazz)[value])
+            else
+              # instance[field] = self.load(field_clazz)[value].id # embedded fields?
+              raise "#{instance} relationship not defined: #{relations[field].relation}"
+            end
+          else
+            raise "Symbol (#{value.nil? ? value : 'nil'}) doesn't reference relationship"
+          end
+
+        elsif value.is_a? Array
+          values = []
+          value.each do |v|
+            if field_clazz.nil?
+              values << v
+            else
+              values << EmbedUtils.create_embedded_instance(field_clazz, v, instance)
+            end
+          end
+          if instance[field].nil?
+            instance[field] = []
+          end
+          instance[field].concat(values)
+        elsif value.is_a? Hash
+          # take hash convert it to object and serialize it
+          instance[field] = EmbedUtils.create_embedded_instance(field_clazz, value, instance)
+        # else just set the field
+        else
+          instance[field] = value
+        end
+      end
+      instances[key] = create_or_save_instance(instance) # store it based on its key name
+    end
+    instances
+  end
+
+  def self.flatten_attributes(attributes)
+    flattened_attributes = {}
+    if attributes.is_a? String
+      return attributes
+    end
+    if attributes.is_a? Mongoid::Document
+      attributes.attributes.each do |name, attribute|
+        unless name.eql? '_id'
+          flattened_attributes["#{attributes.class.to_s.downcase}.#{name}"] = attribute
+        end
+      end
+    else
+
+      attributes.each do |key, values|
+        if values.is_a? Hash
+          values.each do |value, inner_value|
+            flattened_attributes["#{key}.#{value}"] = inner_value
+          end
+        elsif values.is_a? Mongoid::Document
+          values.attributes.each do |name, attribute|
+            unless name.eql? '_id'
+              flattened_attributes["#{values.class.to_s.downcase}.#{name}"] = values.send(name)
+            end
+          end
+        elsif values.is_a? Array # Don't do anything
+        else
+          flattened_attributes[key] = values
+        end
+      end
+    end
+    flattened_attributes
+  end
+  :private
+
+  def self.create_or_save_instance(instance)
+    attributes = instance.attributes.select { |key, value| !key.to_s.eql?('_id') }
+    flattened_attributes = flatten_attributes(attributes)
+    if instance.class.where(flattened_attributes).exists?
+      instance = instance.class.where(flattened_attributes).first
+    else
+      EmbedUtils.insert_embedded_ids(instance)
+      instance.save! # auto serialize the document
+    end
+    instance
+  end
+  :private
+
+
+
+end

data/mongoid_fixtures.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_fixtures/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid_fixtures'
+  spec.version       = MongoidFixtures::VERSION
+  spec.authors       = ['Javier L. Velasquez']
+  spec.email         = ['nycjv321@gmail.com']
+
+  spec.summary       = 'Provides mechanism to easily create fixtures with Mongoid'
+  spec.description   = 'Provides mechanism to easily create fixtures with Mongoid'
+  spec.homepage      = 'https://github.com/nycjv321/mongoid_fixtures'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency  'linguistics',   '~> 2.0.4'
+  spec.add_dependency  'mongoid', '~> 4.0.2'
+  spec.add_dependency  'monkey_patches', '~> 0.0.3'
+end