dm-is-read_only 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+doc
+pkg
+tmp/*
+spec/db
+.DS_Store
+.bundle
+.yardoc
+*.db
+*.log
+*.swp
+*~

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'dm-is-read_only Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,9 @@
+### 0.1.0 / 2010-06-08
+
+* Initial release.
+  * Ignores auto-migrations on read-only Models.
+  * Ignores auto-upgrades on read-only Models.
+  * Puts all resources of a read-only Model into the Immutable state.
+  * Supports the `:migrations` and `:mutable` options for selectively enabling
+    migrations or mutability.
+

data/Gemfile

@@ -0,0 +1,97 @@
+source 'http://rubygems.org'
+dm = 'git://github.com/datamapper'
+
+group :runtime do
+  # We bundle both AS and extlib while extlib compatibility needs to be kept
+  # around. require 'dm-core' will ensure that only one is activated at any
+  # time though. This is done by trying to require AS components and
+  # fallback to requiring extlib in case a LoadError was rescued when
+  # requiring AS code.
+  #
+  # Due to bundle exec activating all groups in the Gemfile, it's
+  # recommended to run
+  #
+  #     bundle install --without quality
+  #
+  # to have a development environment that is able to run the specs.
+  # The problem is that metric_fu activates active_support=2.2.3 if we
+  # comment out the gem 'activesupport' declaration - have a look below for
+  # why we would want to do that (and a bit later, for why that's actually
+  # not *strictly* necessary, but recommended)
+  #
+  # To run the specs using AS, leave this Gemfile as it is and just run:
+  #
+  #     bundle install --without qality
+  #     ADAPTERS=sqlite3 bundle exec rake spec # or whatever adapter
+  #
+  # To run the specs using extlib, comment out the: gem 'activesupport' line
+  # and run:
+  #
+  #     bundle install --without quality
+  #     ADAPTERS=sqlite3 bundle exec rake spec # or whatever adapter
+  #
+  # If you want to run the quality tasks as provided by metric_fu and
+  # related gems, you have to run:
+  #
+  #     bundle install
+  #     bundle exec rake metrics:all
+  #
+  # Switch back to a bundle without quality gems before trying to run the
+  # specs again:
+  #
+  #     bundle install --without quality
+  #     ADAPTERS=sqlite3 bundle exec rake spec # or whatever adapter
+  #
+  # It was mentioned above that all this is not *strictly* necessary, and
+  # this is true. Currently dm-core does the following as the first require
+  # when checking for AS:
+  #
+  #     require 'active_support/core_ext/object/singleton_class'
+  #
+  # Because this method is not present in activesupport <= 3.0.0.beta,
+  # dm-core's feature detection will actually do the "right thing" and fall
+  # back to extlib. However, since this is not the case for all dm-more gems
+  # as well, the safest thing to do is to respect the more tedious workflow
+  # for now, as it will at least be guaranteed to work the same for both
+  # dm-core and dm-more.
+  #
+  # Note that this won't be an issue anymore once we dropped support for
+  # extlib completely, or bundler folks decide to support something like
+  # "bundle exec --without=foo rake spec" (which probably is not going to
+  # happen anytime soon).
+  #
+
+  if ENV['EXTLIB']
+    gem 'extlib', '~> 0.9.15'
+  else
+    gem 'activesupport', '~> 3.0.0.beta3', :require => 'active_support'
+  end
+
+  gem 'dm-core',	'~> 1.0.0'
+end
+
+group :development do
+  gem 'rake',		'~> 0.8.7'
+  gem 'jeweler',	'~> 1.4.0', :git => 'git://github.com/technicalpickles/jeweler.git'
+end
+
+group :doc do
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku',	'~> 0.6.0'
+  else
+    gem 'rdiscount',	'~> 1.6.3'
+  end
+
+  gem 'yard',		'~> 0.5.3'
+end
+
+group :test do
+  gem 'data_objects',		'~> 0.10.2'
+  gem 'do_sqlite3',		'~> 0.10.2'
+  gem 'dm-do-adapter',		'~> 1.0.0'
+  gem 'dm-sqlite-adapter',	'~> 1.0.0'
+  gem 'dm-migrations',		'~> 1.0.0'
+end
+
+gem 'rspec',	'~> 1.3.0', :group => [:development, :test]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+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,85 @@
+# dm-is-read_only
+
+* [github.com/postmodern/dm-is-read_only](http://github.com/postmodern/dm-is-read_only)
+* [github.com/postmodern/dm-is-read_only/issues](http://github.com/postmodern/dm-is-read_only/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+A DataMapper plugin for making Models absolutely **read-only**.
+
+## Features
+
+* Ignores auto-migrations on read-only Models.
+* Ignores auto-upgrades on read-only Models.
+* Puts all resources of a read-only Model into the Immutable state.
+* Supports the `:migrations` and `:mutable` options for selectively enabling
+  migrations or mutability.
+
+## Example
+
+    require 'dm-core'
+    require 'dm-is-read_only'
+  
+    class Licence
+  
+      include DataMapper::Resource
+
+      is :read_only
+
+      # The primary-key of the License
+      property :id, Serial
+    
+      # Name of the Licence
+      property :name, String
+    
+      # URL to the licence
+      property :url, String
+    
+    end
+  
+    Licence.first
+    # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
+
+    # ignores auto-migrations
+    License.auto_migrate!
+    # => true
+
+    Licence.first
+    # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
+
+    # ignores auto-upgrades
+    License.auto_upgrade!
+    # => true
+
+    license = Licence.first
+    # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
+
+    license.name = 'WTF'
+    license.save!
+    # => true
+
+    # will not allow saving resources
+    license.reload
+    license.name
+    # => "GPL-2"
+
+    license.destroy!
+    # => true
+
+    # will not allow destroying resources
+    license = License.first
+    # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core/) ~> 1.0.0
+
+## Install
+
+    $ sudo gem install dm-is-read_only
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:development, :doc)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'dm-is-read_only'
+  gem.license = 'MIT'
+  gem.summary = %Q{A DataMapper plugin for making Models absolutely read-only.}
+  gem.description = %Q{A DataMapper plugin for making Models absolutely read-only.}
+  gem.email = 'postmodern.mod3@gmail.com'
+  gem.homepage = 'http://github.com/postmodern/dm-is-read_only'
+  gem.authors = ['Postmodern']
+  gem.has_rdoc = 'yard'
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs += ['lib', 'spec']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', '.specopts']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dm-is-read_only.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-is-read_only}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-06-10}
+  s.description = %q{A DataMapper plugin for making Models absolutely read-only.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+    ".specopts",
+    ".yardopts",
+    "ChangeLog.md",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "dm-is-read_only.gemspec",
+    "lib/dm-is-read_only.rb",
+    "lib/dm-is-read_only/is/read_only.rb",
+    "spec/classes/backend_model.rb",
+    "spec/classes/read_only_model.rb",
+    "spec/integration/read_only_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/dm-is-read_only}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A DataMapper plugin for making Models absolutely read-only.}
+  s.test_files = [
+    "spec/classes/backend_model.rb",
+    "spec/classes/read_only_model.rb",
+    "spec/integration/read_only_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+      s.add_runtime_dependency(%q<dm-core>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+      s.add_dependency(%q<dm-core>, ["~> 1.0.0"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+    s.add_dependency(%q<dm-core>, ["~> 1.0.0"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+  end
+end
+

data/lib/dm-is-read_only/is/read_only.rb

@@ -0,0 +1,84 @@
+module DataMapper
+  module Is
+    module ReadOnly
+      #
+      # Makes a Model and all resources of the model, read-only.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Boolean] :migrations
+      #   Specifies that migrations should be left enabled.
+      #
+      # @option options [Boolean] :mutable
+      #   Specifies that the resource should remain mutable.
+      #
+      # @example Disable both migrations and mutability
+      #   is :read_only
+      #
+      # @example Do not disable migrations
+      #   is :read_only, :migrations => true
+      #
+      # @example Do not disable mutability
+      #   is :read_only, :mutable => true
+      #
+      def is_read_only(options={})
+        unless options[:migrations]
+          extend DataMapper::Is::ReadOnly::ClassMethods
+        end
+
+        unless options[:mutable]
+          include DataMapper::Is::ReadOnly::InstanceMethods
+        end
+      end
+
+      module ClassMethods
+        #
+        # Disables auto-migrations.
+        #
+        # @return [true]
+        #   Always returns `true`.
+        #
+        def auto_migrate!(repository_name=nil)
+          return true
+        end
+
+        #
+        # Disables auto-upgrades.
+        #
+        # @return [true]
+        #   Always returns `true`.
+        #
+        def auto_upgrade!(repository_name=nil)
+          return true
+        end
+      end
+
+      module InstanceMethods
+        #
+        # Overrides the default `persisted_state` method, to always use
+        # `DataMapper::Resource::State::Immutable`.
+        #
+        # @return [DataMapper::Resource::State::Immutable]
+        #   The immutable state.
+        #
+        def persisted_state
+          @_state ||= Resource::State::Immutable.new(self)
+        end
+
+        #
+        # Prevents the persistence state from forcibly being changed.
+        #
+        # @param [DataMapper::Resource::State] new_state
+        #   The new state to use.
+        #
+        # @return [DataMapper::Resource::State::Immutabe]
+        #   Always returns the immutable state.
+        #
+        def persisted_state=(new_state)
+          persisted_state
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-read_only.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-read_only/is/read_only'
+
+DataMapper::Model.append_extensions DataMapper::Is::ReadOnly

data/spec/classes/backend_model.rb

@@ -0,0 +1,15 @@
+require 'dm-core'
+require 'dm-migrations'
+
+class BackendModel
+
+  include DataMapper::Resource
+  include DataMapper::Migrations
+
+  storage_names[:default] = 'shared_table'
+
+  property :id, Serial
+
+  property :value, String
+
+end

data/spec/classes/read_only_model.rb

@@ -0,0 +1,15 @@
+require 'dm-core'
+
+class ReadOnlyModel
+
+  include DataMapper::Resource
+
+  storage_names[:default] = 'shared_table'
+
+  is :read_only
+
+  property :id, Serial
+
+  property :value, String
+
+end

data/spec/integration/read_only_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+require 'classes/backend_model'
+require 'classes/read_only_model'
+
+describe DataMapper::Is::ReadOnly do
+  context "auto_migrate!" do
+    before(:all) do
+      BackendModel.auto_migrate!
+
+      ('a'..'z').each do |value|
+        BackendModel.create(:value => value)
+      end
+
+      ReadOnlyModel.auto_migrate!
+    end
+
+    it "should not destroy the contents of the storage table" do
+      ReadOnlyModel.all.length.should == 26
+    end
+
+    it "should still return true" do
+      (ReadOnlyModel.auto_migrate!).should == true
+    end
+  end
+
+  context "auto_upgrade!" do
+  end
+
+  context "immutable" do
+    before(:all) do
+      BackendModel.auto_migrate!
+      BackendModel.create(:value => 'x')
+
+      @resource = ReadOnlyModel.first(:value => 'x')
+    end
+
+    it "should prevent modifying properties" do
+      lambda {
+        @resource.value = 'z'
+      }.should raise_error()
+    end
+
+    it "should prevent calling save" do
+      lambda {
+        @resource.save
+      }.should raise_error()
+    end
+
+    it "should prevent calling save!" do
+      lambda {
+        @resource.save!
+      }.should raise_error()
+    end
+
+    it "should prevent calling destroy" do
+      @resource.destroy
+
+      original = BackendModel.first(:value => 'x')
+      original.should_not be_nil
+    end
+
+    it "should prevent calling destroy!" do
+      @resource.destroy!
+
+      original = BackendModel.first(:value => 'x')
+      original.should_not be_nil
+    end
+
+    it "should have an Immutable persisted state" do
+      @resource.persisted_state.class.should == DataMapper::Resource::State::Immutable
+    end
+
+    it "should prevent forcibly changing the persisted state" do
+      old_state = @resource.persisted_state
+
+      new_state = DataMapper::Resource::State::Transient.new(@resource)
+      @resource.persisted_state = new_state
+
+      @resource.persisted_state.should == old_state
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:runtime, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'spec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-read_only'
+
+DataMapper::Spec.setup
+
+Spec::Runner.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-read_only
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A DataMapper plugin for making Models absolutely read-only.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- dm-is-read_only.gemspec
+- lib/dm-is-read_only.rb
+- lib/dm-is-read_only/is/read_only.rb
+- spec/classes/backend_model.rb
+- spec/classes/read_only_model.rb
+- spec/integration/read_only_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-is-read_only
+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: -649568781
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A DataMapper plugin for making Models absolutely read-only.
+test_files: 
+- spec/classes/backend_model.rb
+- spec/classes/read_only_model.rb
+- spec/integration/read_only_spec.rb
+- spec/spec_helper.rb