mongoid_immutable_fields 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Bozek
+
+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.markdown

@@ -0,0 +1,55 @@
+# Mongoid Immutable Fields
+
+## Description
+
+A simple gem that enforces immutability on selected fields.
+
+## Installation
+
+Include the gem in your Gemfile
+
+    gem 'mongoid_immutable_fields'
+    
+## Usage
+
+Add this to your document
+
+    include Mongoid::ImmutableFields
+
+then declare your immutable fields like so 
+
+    immutable_fields :name, :reference_id
+
+your document will look something like
+
+    class DummyDocument
+      include Mongoid::Document
+      include Mongoid::ImmutableFields
+
+      field :name
+      field :description
+      field :reference_id
+
+      immutable_fields :name, :reference_id
+
+    end
+
+Now documents will not update if one of the immutable fields has changed value since initial persistence/creation. If a field is changed and attempted to be saved/updated the following error will be added to the document for the changed immutable field
+    
+    is immutable and cannot be updated
+
+## Contributing to mongoid_immutable_fields
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Jeff Bozek. See LICENSE.txt for
+further details.
+

data/lib/mongoid_immutable_fields/immutable_fields.rb

@@ -0,0 +1,28 @@
+module Mongoid
+
+  module ImmutableFields
+    extend ActiveSupport::Concern
+    
+    included do
+      validate :check_immutability, :on => :update
+      class_attribute :immutable_field_names
+      delegate :immutable_field_names, :to => "self.class"
+    end
+    
+    module ClassMethods
+      def immutable_fields(*field_names)
+        self.immutable_field_names = field_names
+      end
+    end
+    
+  private
+    def check_immutability
+      changed_as_symbols.each do |field|
+        if immutable_field_names.include? field
+          errors.add( field, 'is immutable and cannot be updated' )
+          self.reset_attribute! field.to_s
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_immutable_fields/mongoid_filthy.rb

@@ -0,0 +1,13 @@
+module Mongoid
+  module Dirty
+
+    # returns changed fields as symbols instead of elements
+    def changed_as_symbols
+      changed_as_sym = []
+      changed.each { |c| changed_as_sym << c.to_sym if c.is_a? String }
+      changed_as_sym
+    end
+
+  end
+
+end

data/lib/mongoid_immutable_fields.rb

@@ -0,0 +1,2 @@
+require 'mongoid_immutable_fields/mongoid_filthy'
+require 'mongoid_immutable_fields/immutable_fields'

data/spec/immutable_fields_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Mongoid::ImmutableFields do
+  
+  describe 'when persisting a document with immutable fields' do
+    
+    before(:each) do
+      @dummy = DummyDocument.new(:name => 'Test', :description => 'Test document.', :reference_id => 'abc123')
+    end
+  
+    it 'should be persisted normally' do
+      @dummy.save.should eq true
+    end
+    
+    it 'should be persisted normally when immutable fields change prior to initial persistence' do
+      @dummy.name = 'Test2'
+      @dummy.save.should eq true
+    end
+    
+  end
+  
+  describe 'when updating a document with immutable fields' do
+    
+    before(:each) do
+      @dummy = DummyDocument.create(:name => 'Test', :description => 'Test document.', :reference_id => 'abc123')
+    end
+    
+    it 'should not allow a document to be persisted if an immutable field has changed' do
+      @dummy.name = 'New Test'
+      @dummy.save.should eq false
+      @dummy.errors[:name].include?("is immutable and cannot be updated").should eq true
+    end
+    
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'mongoid'
+require 'database_cleaner'
+require 'mongoid_immutable_fields'
+require 'rubygems'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+  Mongoid.configure do |mconfig|
+    name = "monogid_immutable_fields_test"
+    host = "localhost"
+    port = 27017
+    mconfig.database = Mongo::Connection.new.db(name)
+  end
+  
+  DatabaseCleaner.strategy = :truncation
+  
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+end

data/spec/support/dummy_document.rb

@@ -0,0 +1,11 @@
+class DummyDocument
+  include Mongoid::Document
+  include Mongoid::ImmutableFields
+  
+  field :name
+  field :description
+  field :reference_id
+  
+  immutable_fields :name, :reference_id
+  
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_immutable_fields
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Bozek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mongo_ext
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.7
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id011
+description: Prevent fields from being updated by including a mongoid module and marking the fields as immutable.
+email: jeff.bozek@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- lib/mongoid_immutable_fields.rb
+- lib/mongoid_immutable_fields/immutable_fields.rb
+- lib/mongoid_immutable_fields/mongoid_filthy.rb
+- LICENSE.txt
+- README.markdown
+- spec/immutable_fields_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_document.rb
+has_rdoc: true
+homepage: http://github.com/jeffbozek/mongoid_immutable_fields
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1685392550182324666
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A simple gem that allows for creating immutable fields on your Mongoid documents.
+test_files: 
+- spec/immutable_fields_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_document.rb