mongoid-ip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3b46da34dd92bcd1d738a6b4f7f7e21eec4feb1
+  data.tar.gz: 7f3a06a015bf4db5c95e33b8a8156b2de651bd45
+SHA512:
+  metadata.gz: 7557b2096e33844be046206e25ef5f04f5aed87bb0b4b0a16e6d4ae251b2740dd92ca1736f0afe5230569169baf811ed5e5f674038f40de71cd8af6b9358ef03
+  data.tar.gz: e031d2623b0274213ef8e845aa0ac170cdbf8edc8a2f119cb9b6b301781644dcea257582d514d53052efbddc4cade67f54a1ebc0b14bdc1be902688efc4bf229

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid_ip

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,16 @@
+services: mongodb
+
+notifications:
+  email: false
+
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  
+gemfile:
+  - Gemfile
+  - gemfiles/mongoid-3.1.gemfile
+  - gemfiles/mongoid-4.0.gemfile

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-ip.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 glebtv
+
+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,35 @@
+# Mongoid::Ip
+
+[![Build Status](https://travis-ci.org/rs-pro/mongoid-ip.svg)](https://travis-ci.org/rs-pro/mongoid-ip)
+
+Storing IP in MongoDB done right - as integers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-ip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-ip
+
+## Usage
+
+Do:
+
+    field :ip, type: Mongoid::Ip
+    
+And than just use it as you would a regular text string (only change is sort order). 
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/mongoid-ip/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 new Pull Request

data/Rakefile

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

data/gemfiles/mongoid-3.1.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'mongoid', github: 'mongoid/mongoid', branch: '3.1.0-stable'
+
+gemspec path: '../'
+

data/gemfiles/mongoid-4.0.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'mongoid', github: 'mongoid/mongoid', branch: 'master'
+
+gemspec path: '../'

data/lib/mongoid/ip.rb

@@ -0,0 +1,85 @@
+require "mongoid/ip/version"
+require "ipaddr"
+
+module Mongoid
+  class Ip
+    def initialize(data)
+      @data = data
+    end
+
+    def to_s
+      @data.to_s
+    end
+
+    def inspect
+      '"' + to_s + '"'
+    end
+
+    def ==(other)
+      if other.class == self.class
+        other.to_s == to_s
+      elsif other.class == String
+        @data == other
+      else
+        false
+      end
+    end
+
+    def coerce(something)
+      [self, something]
+    end
+
+    def mongoize
+      IPAddr.new(@data, Socket::AF_INET).to_i
+    end
+
+    protected
+
+    def method_missing(name, *args, &block)
+      @data.send(name, *args, &block)
+    end
+
+    class << self
+
+      # Get the object as it was stored in the database, and instantiate
+      # this custom class from it.
+      def demongoize(object)
+        if object.is_a?(Mongoid::Ip)
+          object.to_s
+        elsif object.is_a?(Fixnum)
+          IPAddr.new(object, Socket::AF_INET).to_s
+        else
+          object
+        end
+      end
+
+      # Takes any possible object and converts it to how it would be
+      # stored in the database.
+      def mongoize(object)
+        case
+          when object.is_a?(Mongoid::Ip) then object.mongoize
+          when object.is_a?(Fixnum) then object
+          when object.is_a?(String) then Mongoid::Ip.new(object).mongoize
+          else object
+        end
+      end
+
+      # Converts the object that was supplied to a criteria and converts it
+      # into a database friendly form.
+      def evolve(object)
+        case object
+          when Mongoid::Ip then object.mongoize
+          when Fixnum then object
+          when String then Mongoid::Ip.new(object).mongoize
+          else object
+        end
+      end
+    end
+  end
+end
+
+require "mongoid/ip/concern"
+
+if Object.const_defined?("RailsAdmin")
+  require "mongoid/ip/rails_admin"
+end

data/lib/mongoid/ip/concern.rb

@@ -0,0 +1,8 @@
+
+module StoreIp
+  extend ActiveSupport::Concern
+  included do
+    field :i, as: :ip, type: Mongoid::Ip
+  end
+end
+

data/lib/mongoid/ip/rails_admin.rb

@@ -0,0 +1,53 @@
+
+require 'rails_admin/adapters/mongoid'
+begin
+  require 'rails_admin/adapters/mongoid/property'
+rescue Exception => e 
+end
+
+module RailsAdmin
+  module Adapters
+    module Mongoid
+      class Property
+        alias_method :type_without_mongoid_ip, :type
+        def type
+          if property.type.to_s == 'Mongoid::Ip'
+            :mongoid_ip
+          else
+            type_without_mongoid_ip
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'rails_admin/config/fields/types/text'
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class MongoidIp < RailsAdmin::Config::Fields::Types::Text
+          # Register field type for the type loader
+          RailsAdmin::Config::Fields::Types::register(self)
+
+          register_instance_option :pretty_value do
+            if value.respond_to?(:data)
+              IPAddr.new(value.data, Socket::AF_INET).to_s
+            else
+              value
+            end
+          end
+
+          register_instance_option :formatted_value do
+            if value.respond_to?(:data)
+              IPAddr.new(value.data, Socket::AF_INET).to_s
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/ip/version.rb

@@ -0,0 +1,3 @@
+module MongoidIp
+  VERSION = "0.0.1"
+end

data/mongoid-ip.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/ip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-ip"
+  spec.version       = MongoidIp::VERSION
+  spec.authors       = ["glebtv"]
+  spec.email         = ["glebtv@gmail.com"]
+  spec.summary       = %q{Storing IP in MongoDB done right - as integers}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/rs-pro/mongoid-ip"
+  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'
+  spec.add_development_dependency 'rake'
+  
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'glebtv-mongoid-rspec'
+  spec.add_development_dependency 'ffaker'
+end

data/spec/mongoid_ip_spec.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Mongoid::Ip do
+  it 'correctly stores data' do
+    100.times do
+      text = Faker::Internet.ip_v4_address
+      c = Dummy.new(ip: text)
+      c.ip.should eq text
+      c.save.should be_true
+      c.ip.should eq text
+      c.read_attribute(:i).should eq IPAddr.new(text, Socket::AF_INET).to_i
+      Dummy.find(c.id).ip.should eq text
+    end
+  end
+
+  it 'correctly migrates data from string field' do
+    text = Faker::Internet.ip_v4_address
+    c = Dummy.new(migrate_test: text)
+    c.save.should be_true
+    Migrated.first.migrate_test.should eq text
+  end
+
+  it 'correctly looks up string in DB' do
+    text = Faker::Internet.ip_v4_address
+    c = Dummy.new(ip: text)
+    c.ip.should eq text
+    c.save.should be_true
+    c.ip.should eq text
+
+    f = Dummy.where(ip: text).first
+    f.should_not be_nil
+    f.ip.should eq text
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+require 'mongoid'
+require 'database_cleaner'
+require 'mongoid-rspec'
+require 'ffaker'
+require 'mongoid/ip'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Mongoid.configure do |config|
+  ENV["MONGOID_ENV"] = "test"
+  Mongoid.load!("spec/support/mongoid.yml")
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.strategy = :truncation
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+  config.include Mongoid::Matchers
+  config.mock_with :rspec
+end

data/spec/support/models.rb

@@ -0,0 +1,13 @@
+class Dummy
+  include Mongoid::Document
+
+  include StoreIp
+  field :i1, type: Mongoid::Ip
+  field :migrate_test, type: String
+end
+
+class Migrated
+  include Mongoid::Document
+  store_in collection: 'dummies'
+  field :migrate_test, type: Mongoid::Ip
+end

data/spec/support/mongoid.yml

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-ip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- glebtv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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: simplecov
+  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: database_cleaner
+  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: glebtv-mongoid-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: ffaker
+  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: ''
+email:
+- glebtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/mongoid-3.1.gemfile
+- gemfiles/mongoid-4.0.gemfile
+- lib/mongoid/ip.rb
+- lib/mongoid/ip/concern.rb
+- lib/mongoid/ip/rails_admin.rb
+- lib/mongoid/ip/version.rb
+- mongoid-ip.gemspec
+- spec/mongoid_ip_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/rs-pro/mongoid-ip
+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.2
+signing_key: 
+specification_version: 4
+summary: Storing IP in MongoDB done right - as integers
+test_files:
+- spec/mongoid_ip_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml