mongoid-name 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7670e12bccea46f99fe54bef51f4185120dcb0bf
+  data.tar.gz: ff0bba90cc5aee9db1c9272f7928562ffa0b5294
+SHA512:
+  metadata.gz: 6ae4cd222a3e9f5ec36405c881a0aaaa33dd4c44f961ee8c075d8d806e8e4f6c019d4c9996d71c45269b0487ef09e48bcae59eaa58da3d50237833f35e0252c2
+  data.tar.gz: 445b436df8290522a913a9348e446be83873e3daaf8a85e046251f78d55e2c9e126a9d0010e2bf6cb1aff456e724a61c90a9a3aaa7b05df23fb3c8497bfcf514

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+Gemfile.lock

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+# Mongoid Name
+
+Custom serialized type for Mongoid schemas. A string, struct, and array. 
+
+```ruby
+require 'mongoid'
+require 'mongoid-name'
+
+class User
+  include Mongoid::Document
+  field :name, type: Mongoid::Name
+end
+```
+
+It's an array to encourage autocomplete search. (Index it tho please!)
+
+```ruby
+User.create(name: %w(AJ Ostrow))
+user = User.find_by(name: /^ostr/i)
+```
+
+A string for the API and/or views.
+
+```ruby
+user.name
+# => "AJ Ostrow"
+```
+
+And a struct for custom messages.
+
+```ruby
+'%s you have 0 stars' % user.name.first
+# => "AJ you have 0 stars"
+```
+
+Got `middle` and `last` as well. The middle name is always optional (default `nil`). 
+
+```ruby
+user.name = [ 'Gabriel', 'José de la Concordia', 'García Márquez' ]
+user.name = [ 'Albert', 'Camus' ]
+```
+
+### Notes
+
+Install with bundler. 
+
+```
+$ gem install mongoid-name
+```
+
+Please contribute ideas, code, criticism, etc. 
+
+License: **MIT**

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = false
+end
+
+task default: :test

data/lib/mongoid-name.rb

@@ -0,0 +1,46 @@
+module Mongoid
+  class Name < String
+    attr_reader :first, :middle, :last
+
+    # Name.new('AJ', 'Ostrow')
+    # Name.new('Alexander', 'Jacob', 'Ostrow')
+    # Name.new(%w(AJ Ostrow))
+    # Name.new(%w(Alexander Jacob Ostrow))
+    def initialize(*args)
+      args.flatten!
+      @first, @last = args.shift, args.pop
+      @middle = args.join(' ') if args.any?
+      super(to_s)
+    end
+
+    def to_h
+      { 'first' => first,
+        'middle' => middle,
+        'last' => last }
+    end
+
+    def to_a
+      [ first, middle, last ].compact
+    end
+
+    def to_s
+      to_a.join(' ')
+    end
+
+    # Mongoid conversions
+
+    alias_method :mongoize, :to_a
+
+    def self.demongoize(array)
+      new(*array)
+    end
+
+    def self.mongoize(object)
+      object.respond_to?(:mongoize) ? object.mongoize : object
+    end
+
+    def self.evolve(object)
+      object.respond_to?(:mongoize) ? object.mongoize : object
+    end
+  end
+end

data/mongoid-name.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'mongoid-name'
+  s.version = '0.0.0'
+  s.license = 'MIT'
+  s.summary = 'Mongoid Name Type'
+  s.author = 'aj0strow'
+  s.email = 'alexander.ostrow@gmail.com'
+  s.homepage = 'https://github.com/aj0strow/mongoid-name'
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(/test/)
+  s.require_path = 'lib'
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'mongoid', '~> 4.0.0.beta2'
+  s.add_development_dependency 'minitest', '~> 5.3'
+  s.add_development_dependency 'database_cleaner', '~> 1'
+end

data/test/integration_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class Person
+  include Mongoid::Document
+
+  field :name, type: Mongoid::Name
+end
+
+describe Person do
+  before do
+    @person = Person.create(name: %w(AJ Ostrow))
+  end
+
+  describe 'persist' do
+    it 'should save and fix' do
+      @person.update(name: %w(Elijah Ostrow))
+      assert_equal 'Elijah Ostrow', @person.reload.name
+    end
+  end
+
+  describe 'query' do
+    it 'should query whole name' do
+      result = Person.where(name: %w(AJ Ostrow)).first
+      assert_equal @person.name, result.name
+    end
+
+    it 'should query first name' do
+      result = Person.where(name: /aj/i).first
+      assert_equal @person.name, result.name
+    end
+  end
+end

data/test/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: 'test'
+      hosts:
+        - 'localhost:27017'

data/test/name_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+describe Mongoid::Name do
+  before do
+    @name = Mongoid::Name.new(%w(AJ Ostrow))
+  end
+
+  describe '#initialize' do
+    it 'should be a string' do
+      assert_equal 'AJ Ostrow', @name
+    end
+
+    it 'should have first name' do
+      assert_equal 'AJ', @name.first
+    end
+
+    it 'should have middle name' do
+      assert_nil nil, @name.middle
+    end
+
+    it 'should have last name' do
+      assert_equal 'Ostrow', @name.last
+    end
+  end
+
+  describe '#mongoize' do
+    it 'should store the name as an array' do
+      assert_equal %w(AJ Ostrow), @name.mongoize
+    end
+  end
+
+  describe '::demongoize' do
+    it 'should create a name object' do
+      assert_equal @name, Mongoid::Name.demongoize(%w(AJ Ostrow))
+    end
+  end
+
+  describe '::mongoize' do
+    it 'should convert to string array' do
+      assert_equal %w(AJ Ostrow), Mongoid::Name.mongoize(@name)
+    end
+  end
+
+  describe '::evolve' do
+    it 'should convert to string array' do
+      assert_equal %w(AJ Ostrow), Mongoid::Name.evolve(@name)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'mongoid'
+require 'mongoid-name'
+require 'minitest/autorun'
+require 'database_cleaner'
+
+Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__))
+
+DatabaseCleaner.strategy = :truncation
+DatabaseCleaner.clean

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-name
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- aj0strow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: 
+email: alexander.ostrow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid-name.rb
+- mongoid-name.gemspec
+- test/integration_test.rb
+- test/mongoid.yml
+- test/name_test.rb
+- test/test_helper.rb
+homepage: https://github.com/aj0strow/mongoid-name
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Mongoid Name Type
+test_files:
+- test/integration_test.rb
+- test/mongoid.yml
+- test/name_test.rb
+- test/test_helper.rb