mongoid_listable 0.0.6 → 0.0.8

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGRjNjdkNDcwYWI2YjJhNzY1OTY1ZGQ4ODZkMWE3ZTlmYWJlMDkzYQ==
+  data.tar.gz: !binary |-
+    NTZkOWZhNTFjYmYxMDQ4MjI3NTczZTdhMGQwYjlhYmMwN2I0Nzc1OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjZlY2E4MGVhMGI1OWFjMTQ5NGU2MTQ3NjQ0Y2U1NDJmMzhkMmVlMTkxZGUy
+    Y2QyMDFlZGJlMWVhNjU4NmI5NWMwMTFhYmYwY2RlYWQ2MjBhM2UyNDZjOTVi
+    ZjAxYTRmOTg2YmFmYjU3MzQwZjRmNDFiY2IzMTUwMjBhNDllMWQ=
+  data.tar.gz: !binary |-
+    NDc1M2YwYzlkZDFjODhhZDQ0ODVmYWUxOGU2MTA2ZGM3M2NmYjg4ZmIyNzdl
+    N2I5ZGE0MjNjYzJhNWEwY2FhOGQ1YmQ4M2ZlMmQ3MWMxOWNjNzIwMGMyMGIz
+    MmM5NjljODU4ZDBiM2QzODEyMTRiNjk2Y2ZmYmY4OWQ0OTdmODM=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+services: mongodb
+bundler_args: --without development
+rvm:
+- 1.9.3
+- 2.0.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: hWkNBQ4LbxAsErQZ8X46SKvCQ2tRwMU/SX2cWPlE0izXPvlpRie7HQvqlcCdmaYhxljxVEOdThMS9UW8rm4e+ykuWic0SD04iod7c9uvQQIxLra49lawOwaRkARRJJXcU5vIs+DXPEODsnRUita2llCf6WNyKbU+4mPacrC+AH4=
+  gem: mongoid_listable
+  on:
+    tags: true
+    repo: richardcalahan/mongoid_listable

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in mongoid_listable.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'coveralls', require: false

data/README.md

@@ -1,4 +1,8 @@
 # Mongoid Listable
+[![Code Climate](https://codeclimate.com/repos/527c1e427e00a44bc100c7e3/badges/344ff1980ca523c67291/gpa.png)](https://codeclimate.com/repos/527c1e427e00a44bc100c7e3/feed)
+[![Build Status](https://travis-ci.org/richardcalahan/mongoid_listable.png?branch=master)](https://travis-ci.org/richardcalahan/mongoid_listable)
+[![Coverage Status](https://coveralls.io/repos/richardcalahan/mongoid_listable/badge.png?branch=master)](https://coveralls.io/r/richardcalahan/mongoid_listable?branch=master)
+[![Gem Version](https://badge.fury.io/rb/mongoid_listable.png)](http://badge.fury.io/rb/mongoid_listable)
 
 Mongoid Listable will eventually be a full replacement library for Mongoid List or Mongoid Orderable. Both 
 libraries fail to accomplish the simple task this library handles: separate position scopes for each
@@ -8,7 +12,7 @@ defined `has_many` / `belongs_to` relation.
 
     class User
       include Mongoid::Document
-      include Mongoid:Lists
+      include Mongoid:Listable
     
       has_many :photos
       lists :photos
@@ -22,11 +26,11 @@ defined `has_many` / `belongs_to` relation.
       ...
     end
     
-In this example photos that are assigned to a user via by the method `user.photo_ids=[ids]` will maintain position based on the index
+In this example photos that are assigned to a user will maintain position based on the index
 of the id in the array argument.
 
 Each photo that belongs to the user will automatically obtain a field called `user_position`. The position field
-is derived from the foreign key of the relation, replacing "_id" with "_position". 
+is derived from the foreign key of the relation, replacing "\_id" with "_position". 
 
 The 1-n relation of a user to their photos will automatically be ordered by `user_position` unless otherwise specified
 via the standard `order` option to the `has_many` macro. 
@@ -37,7 +41,7 @@ via the standard `order` option to the `has_many` macro.
     
     class User
       include Mongoid::Document
-      include Mongoid:Lists
+      include Mongoid:Listable
     
       has_many :featured_photos, 
       class_name: 'Photo', 
@@ -79,7 +83,7 @@ You can optionally override the name of the position column:
 
 ## Todo
 
-There's a lot more to add to the library! At this point, it conveniently handles standard rails-based multiselect form fields.
+There's a lot more to add to the library! At this point, it conveniently handles has many relationships.
 
 ## Installation
 

data/Rakefile

@@ -1 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :gem => :build
+
+task :build do
+  system 'gem build mongoid_listable.gemspec'
+end
+
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/lib/mongoid/listable/accessors.rb

@@ -0,0 +1,54 @@
+module Mongoid
+  module Listable
+    
+    module Accessors
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # Redefines the default ids setter, ensuring that the order of 
+        # objects sent to the relation setter corresponds to the order
+        # of the array of ids
+        #
+        # @param [ Symbol ]   name The name of the has_many relation
+        # @param [ MetaData ] meta The MetaData class
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.0.6
+        def _ids_setter name, meta
+          ids_method = "#{name.to_s.singularize}_ids="
+          redefine_method ids_method do |ids|            
+            send meta.setter, meta.klass.find(ids).sort_by_attr(:id, ids)
+          end
+          self
+        end
+
+        # Prepends to the default setter a block that sets the position
+        # attribute on each object according to its index in the array
+        #
+        # @param [ Symbol ]   name The name of the has_many relation
+        # @param [ MetaData ] meta The MetaData class
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.0.6
+        def _setter name, meta
+          before_method "#{name}=" do |objects|
+            objects.each_with_index do |object, index|
+              object.update_attribute field_name(meta), index + 1
+            end
+
+            (send(name).to_a - objects).each do |object|
+              object.unset field_name(meta)
+            end
+          end
+          self
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/listable/callbacks.rb

@@ -0,0 +1,58 @@
+module Mongoid
+  module Listable
+    
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # Defines a mongoid relation after_add callback.
+        # Sets the position attribute to current relations length + 1
+        #
+        # @param [ Symbol ]   name The name of the has_many relation
+        # @param [ MetaData ] meta The MetaData class
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.0.6
+        def added name, meta
+          callback = "#{name.to_s.singularize}_added"
+          define_method callback do |object|
+            object.update_attribute field_name(meta), has_many_count(name)
+          end
+          meta[:after_add] = callback
+          self
+        end
+
+        # Defines a mongoid relation before_remove callback.
+        # Resets the position index on all objects that came after
+        #
+        # @param [ Symbol ]   name The name of the has_many relation
+        # @param [ MetaData ] meta The MetaData class
+        #
+        # @return [ Object ] self
+        #
+        # @since 0.0.6
+        def removed name, meta       
+          field_name = field_name meta
+          callback   = "#{name.to_s.singularize}_removed"
+
+          define_method callback do |object|
+            position = object.send field_name
+            send(name).where(field_name.gt => position)
+              .each_with_index do |object, index|
+              object.update_attribute field_name, position + index
+            end
+            object.unset field_name
+          end
+
+          meta[:before_remove] = callback
+          self
+        end
+
+      end
+
+    end
+    
+  end
+end

data/lib/mongoid/listable/extensions/array.rb

@@ -0,0 +1,33 @@
+module Mongoid
+  module Listable
+    module Extensions
+      
+      module Array
+
+        # Sorts an array of objects on the specified key, sorted
+        # by the order of the key in an array. Example:
+        #
+        # [{name: 'Richard'}, 
+        #  {name: 'Ashley'}, 
+        #  {name: 'Chris'}].sort_by_attr(:name, ['Chris', 'Richard', 'Ashley'])
+        # 
+        # => [{name: 'Chris'}, {name: 'Richard'}, {name: 'Ashley'}]
+        #
+        # @param [String|Symbol] key    The object attribute to sort by
+        # @param [Array]         values An array of object attributes
+        #
+        # @return Array
+        #
+        # @since 0.0.6
+        def sort_by_attr k, v
+          v.reject! &:blank?
+          sort { |a, b| v.index(a.send(k)) <=> v.index(b.send(k)) }
+        end
+
+      end
+
+    end
+  end
+end
+
+::Array.__send__ :include, Mongoid::Listable::Extensions::Array

data/lib/mongoid/listable/extensions/object.rb

@@ -0,0 +1,73 @@
+module Mongoid
+  module Listable
+    module Extensions
+
+      module Object
+        
+        # Redefine the method. Will undef the method if it exists or simply
+        # just define it.
+        #
+        # @example Redefine the method.
+        #   Object.re_define_method("exists?") do
+        #     self
+        #   end
+        #
+        # @param [ String, Symbol ] name The name of the method.
+        # @param [ Proc ] block The method body.
+        #
+        # @return [ Method ] The new method.
+        #
+        # # @since 0.0.7
+        def _redefine_method name, &block
+          undef_method(name) if method_defined?(name)
+          define_method(name, &block)
+        end
+
+        # Redefines a method on owner to first execute &block, then
+        # continue executing original method. 
+        #
+        # @param [ Object ] owner  The owner of the method
+        # @param [ String ] method The name of the method to override
+        # @param [ Proc ]   &block The block to execute before original method
+        #
+        # @since 0.0.3
+        def before_method name, &block
+          original_method = instance_method name
+          _redefine_method name do |*args|
+            instance_exec *args, &block
+            original_method.bind(self).call *args
+          end
+        end
+
+        # Redefines a method on owner to execute &block,
+        # passing to it as arguments the original method and its arguments.
+        # It's the callers' responsibility at that point to run whatever code
+        # and return the results of the original method by calling it.
+        #      
+        # Use as an alternative to before_method if your override depends on 
+        # the results of the original method. around_method will avoid the 
+        # inevitable stack overflow that occurs in before_method 
+        # if you call itself.
+        #
+        # @param [ Object ] owner  The owner of the method
+        # @param [ String ] method The name of the method to override
+        # @param [ Proc ]   &block The block to execute before original method
+        #
+        # @since 0.0.6
+        def around_method name, &block
+          original_method = instance_method name
+          _redefine_method name do |*args|
+            instance_exec original_method, *args, &block
+          end        
+        end
+
+      end
+
+    end
+  end
+end
+
+::Object.__send__ :include, Mongoid::Listable::Extensions::Object
+
+
+

data/lib/mongoid/listable/extensions.rb

@@ -0,0 +1,2 @@
+require 'mongoid/listable/extensions/array'
+require 'mongoid/listable/extensions/object'

data/lib/mongoid/listable/macros.rb

@@ -1,55 +1,33 @@
 module Mongoid
   module Listable
 
-    # This module contains the core macro for defining listable has_many relationships
+    # This module contains the core macro for defining listable 
+    # has_many relationships
     module Macros
+      extend ActiveSupport::Concern
 
-      # Macro to set relation on which to make a list
-      #
-      # @param [ Symbol ] relation The name of the has_many relation
-      # @param [ Hash ]   options The options hash
-      #
-      # @return [ Mongoid:Relations:Metadata ] Instance of metadata for the relation
-      #
-      # @since 0.0.1
-      def lists name, options={}
-        meta       = reflect_on_association name
-        field_name = options[:column] || 
-          (meta.foreign_key.to_s.gsub(/_?id$/, '_position')).to_sym
-        
+      module ClassMethods
 
-        # Override the default ids setter, first setting the correct position
-        # on each relation based on the index of its id in the given array.
+        # Macro to set relation on which to make a list
         #
-        # @override model#{name}_ids= 
-        before_method self, "#{name.to_s.singularize}_ids=" do |ids|
-          ids.each_with_index do |id, index|
-            meta.klass.find(id).update_attribute field_name, index + 1
-          end
+        # @param [ Symbol ] name The name of the has_many relation
+        # @param [ Hash ]   options The options hash
+        #
+        # @return [ Mongoid:Relations:Metadata ] Instance of metadata
+        #
+        # @since 0.0.1
+        def lists name, options={}
+          meta = reflect_on_association name
+          meta.klass.send :field, field_name(meta), type: Integer
+          _ids_setter(name, meta)
+            ._setter(name, meta)
+            .added(name, meta)
+            .removed(name, meta)
+          meta[:order] ||= "#{field_name(meta)} asc"
         end
 
-        meta[:order] ||= "#{field_name} asc"
       end
 
-      private
-
-      # Redefines a method on owner to first execute &block, then
-      # continue executing original method. 
-      #
-      # @param [ Object ] owner  The owner of the method
-      # @param [ String ] method The name of the method to override
-      # @param [ Proc ]   &block The block to execute before original method
-      #
-      # @private
-      # @since 0.0.3
-      def before_method owner, method, &block
-        original_method = instance_method method
-        owner.re_define_method method do |*args|
-          block.call *args
-          original_method.bind(self).call *args
-        end
-      end      
-
     end
   end
 end

data/lib/mongoid/listable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Listable
+    VERSION = '0.0.8'
+  end
+end

data/lib/mongoid/listable.rb

@@ -1,15 +1,50 @@
+require 'mongoid/listable/accessors'
+require 'mongoid/listable/callbacks'
+require 'mongoid/listable/extensions'
 require 'mongoid/listable/macros'
 
 module Mongoid
-
   module Listable
-
     extend ActiveSupport::Concern
 
-    included do 
-      extend Mongoid::Listable::Macros
+    included do
+      include Mongoid::Listable::Accessors
+      include Mongoid::Listable::Callbacks
+      include Mongoid::Listable::Macros
     end
 
-  end
+    module ClassMethods
+
+      # Generates the position field name using the MetaData class
+      #
+      # @param [ MetaData ] meta The MetaData class
+      #
+      # @return Symbol
+      #
+      # @since 0.0.6
+      def field_name meta
+        (meta.foreign_key.to_s.gsub(/_?id$/, '_position')).to_sym
+      end
+
+    end
 
+    # Proxies to the class level version
+    #
+    # @see Class.field_name
+    #
+    # @since 0.0.6
+    def field_name meta
+      self.class.field_name meta
+    end
+
+    # Counts unique children of object
+    # Needed because the mongoid callbacks dont update
+    # has_many relations until after invoked.
+    #
+    # @since 0.0.7
+    def has_many_count name
+      send(name).uniq(&:id).count
+    end
+
+  end
 end

data/mongoid_listable.gemspec

@@ -2,9 +2,11 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require "mongoid/listable/version"
+
 Gem::Specification.new do |spec|
   spec.name          = 'mongoid_listable'
-  spec.version       = '0.0.6'
+  spec.version       = Mongoid::Listable::VERSION
   spec.authors       = [ 'richardcalahan' ]
   spec.email         = [ 'richard@calahan.me' ]
   spec.description   = ''
@@ -18,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = [ 'lib' ]
 
   spec.add_dependency 'mongoid', '>= 3.1.0'
-  spec.add_dependency 'mongoid-list'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/spec/models/photo.rb

@@ -0,0 +1,10 @@
+class Photo
+
+  include Mongoid::Document
+  include Mongoid::Listable
+
+  field :caption, type: String
+
+  belongs_to :user
+
+end

data/spec/models/user.rb

@@ -0,0 +1,13 @@
+class User
+
+  include Mongoid::Document
+  include Mongoid::Listable
+
+  field :first_name, type: String, default: 'Richard'
+  field :last_name, type: String, default: 'Calahan'
+
+  has_many :photos
+  
+  lists :photos
+
+end

data/spec/mongoid/listable/extensions/object_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Mongoid::Listable::Extensions::Object do 
+
+  before :each do 
+
+    class Object
+      @@foo = 1
+      def foo
+        @@foo
+      end
+      def foo= foo
+        @@foo = foo
+      end
+    end
+
+  end
+
+  it 'allows a block to be executed before a method' do
+    Object.before_method "foo" do
+      self.foo = 2
+    end
+
+    expect(Object.new.foo).to eq(2)
+  end
+
+  it 'allows a block to be executed around a method' do
+    original_method       = nil
+    original_return_value = nil
+    Object.around_method "foo" do |method, *args|
+      original_method = method
+      original_return_value = method.bind(self).call *args
+    end
+
+    Object.new.foo
+
+    expect(original_method).to be_a_kind_of(UnboundMethod)    
+    expect(original_return_value).to eq(1)
+  end
+
+end

data/spec/mongoid_listable_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Mongoid::Listable do 
+
+  before :all do 
+    @user = User.create!
+    @photos = []
+    10.times { @photos << Photo.create }
+  end  
+
+  it 'created a user' do
+    expect(@user).to be_true
+  end
+
+  it 'created 10 photos' do    
+    expect(@photos.count).to eq(10)
+  end
+
+  it 'assigns all photos to a user with the default setter' do 
+    @user.photos = @photos
+    expect(@user.photos.count).to eq(@photos.count)
+  end
+
+  it 'assigns all photos to a user with the default ids setter' do 
+    ids = @photos.collect(&:id)
+    @user.photo_ids = ids
+    expect(@user.photos.count).to eq(@photos.count)
+  end
+
+  it 'removes a photo from a user using the delete method' do 
+    @user.photos.delete @photos[0]
+    expect(@user.photos.count).to eq(@photos.count - 1)
+  end
+
+  it 'removes a photo from a user using the default setter' do 
+    @user.photos = @photos[0..4]
+    expect(@user.photos.count).to eq(@photos.count - 5)
+  end
+
+  it 'updated the position field for all the photos' do 
+    User.first.photos.each_with_index do |photo, index|
+      expect(photo.user_position).to eq(index + 1)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'mongoid'
+require 'rspec'
+
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require File.expand_path '../../lib/mongoid_listable', __FILE__
+require File.expand_path '../../spec/models/photo',    __FILE__
+require File.expand_path '../../spec/models/user',     __FILE__
+
+Mongoid.configure do |config|
+  config.connect_to 'mongoid_listable_test'
+  Moped.logger = Logger.new $stdout
+  Moped.logger.level = Logger::INFO
+end
+
+RSpec.configure do |config|
+  config.before :suite do 
+    Mongoid.purge!
+    Mongoid::IdentityMap.clear
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_listable
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - richardcalahan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,31 +20,13 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: mongoid-list
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -82,38 +59,55 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mongoid/listable.rb
+- lib/mongoid/listable/accessors.rb
+- lib/mongoid/listable/callbacks.rb
+- lib/mongoid/listable/extensions.rb
+- lib/mongoid/listable/extensions/array.rb
+- lib/mongoid/listable/extensions/object.rb
 - lib/mongoid/listable/macros.rb
+- lib/mongoid/listable/version.rb
 - lib/mongoid_listable.rb
 - mongoid_listable.gemspec
+- spec/models/photo.rb
+- spec/models/user.rb
+- spec/mongoid/listable/extensions/object_spec.rb
+- spec/mongoid_listable_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ''
-test_files: []
+test_files:
+- spec/models/photo.rb
+- spec/models/user.rb
+- spec/mongoid/listable/extensions/object_spec.rb
+- spec/mongoid_listable_spec.rb
+- spec/spec_helper.rb