activerecord-readonly_model 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,59 @@
+# ActiveRecord::ReadonlyModel
+
+ `ActiveRecord:ReadonlyModel` does what you'd think. It makes any
+ActiveRecord model read only. Any attempt to persist changes to a
+read-only model will result in an `ActiveRecord::ReadOnlyRecord`
+exception.
+
+Read-only models are useful when you're storing 'static' kind of data
+like descriptive types or statuses that don't change while your application is
+executing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-readonly_model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-readonly_model
+
+## Usage
+
+To use, just include the `ActiveRecord::ReadonlyModel` module in your
+model:
+
+    class ThingStatus < ActiveRecord::Base
+      include ActiveRecord::ReadonlyModel
+    end
+
+Any attempt to update or destroy an instance of `ThingStatus` will raise an
+`ActiveRecord::ReadOnlyRecord` exception.
+
+## Bypass
+
+Of course sometimes you'll want to bypass the read-only restriction
+(like when seeding your database). To temporarily bypass, make
+updates/inserts/deletes in a bypass block:
+
+    ActiveRecord::ReadonlyModel.bypass do
+      ThingStatus.create(:name => 'Active', :description => 'An active thing')
+    end
+
+## Limitations
+
+This gem will only prevent creates, saves, and destroys. `.delete()` and
+`.delete_all()` behavior is unaffected by this gem!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/activerecord-readonly_model.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_record-readonly_model/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christian Dinger"]
+  gem.email         = ["cdinger@gmail.com"]
+  gem.description   = %q{Makes an ActiveRecord model read-only}
+  gem.summary       = %q{Makes an ActiveRecord model read-only}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-readonly_model"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveRecord::ReadonlyModel::VERSION
+
+  gem.add_dependency('activerecord', '>= 3.0.0')
+end

data/lib/active_record-readonly_model.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+require 'active_record-readonly_model/version'
+
+module ActiveRecord
+  module ReadonlyModel
+    @@bypass_flag = false
+
+    def self.bypass(&block)
+      @@bypass_flag = true
+      yield
+      @@bypass_flag = false
+    end
+
+    # Prevents objects from being created
+    def readonly?
+      super && !@@bypass_flag
+    end
+
+    def self.included(base)
+      base.class_eval do
+        def readonly
+          true
+        end
+        before_save { raise ActiveRecord::ReadOnlyRecord unless @@bypass_flag }
+        before_destroy { raise ActiveRecord::ReadOnlyRecord unless @@bypass_flag }
+      end
+    end
+  end
+end

data/lib/active_record-readonly_model/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ReadonlyModel
+    VERSION = "0.0.2"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+require 'active_record-readonly_model'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'test.sqlite3')

data/test/test_ignore_readonly.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestReadonly < Test::Unit::TestCase
+  context "Some static model" do
+    setup do
+      ActiveRecord::Base.connection.create_table :static_things, :force => true do |t|
+        t.string :name
+      end
+      ActiveRecord::Base.connection.execute("insert into static_things (name) values ('Blah thing')")
+      class StaticThing < ActiveRecord::Base
+        include ActiveRecord::ReadonlyModel
+      end
+    end
+
+    teardown do
+      ActiveRecord::Base.connection.drop_table :static_things
+    end
+
+    should "allow destroy in an ignore_readonly block" do
+      before_count = StaticThing.count
+      assert_nothing_raised do
+        ActiveRecord::ReadonlyModel.bypass do
+          thing = StaticThing.first
+          assert(thing.destroy)
+        end
+      end
+      assert_not_equal(before_count, StaticThing.count)
+    end
+
+    should "allow delete in an ignore_readonly block" do
+      before_count = StaticThing.count
+      assert_nothing_raised do
+        #StaticThing.ignore_readonly { StaticThing.delete_all }
+        ActiveRecord::ReadonlyModel.bypass { StaticThing.delete_all }
+      end
+      assert_not_equal(before_count, StaticThing.count)
+    end
+
+    should "allow update in an ignore_readonly block" do
+      assert_nothing_raised do
+        ActiveRecord::ReadonlyModel.bypass do
+          thing = StaticThing.first
+          thing.name = 'something different'
+          assert(thing.save)
+        end
+      end
+    end
+  end
+end

data/test/test_readonly.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class TestReadonly < Test::Unit::TestCase
+  context "Some static model" do
+    setup do
+      ActiveRecord::Base.connection.create_table :static_things, :force => true do |t|
+        t.string :name
+      end
+      ActiveRecord::Base.connection.execute("insert into static_things (name) values ('Blah thing')")
+      class StaticThing < ActiveRecord::Base
+        include ActiveRecord::ReadonlyModel
+      end
+    end
+
+    teardown do
+      ActiveRecord::Base.connection.drop_table :static_things
+    end
+
+    should "prevent destroy" do
+      before_count = StaticThing.count
+      assert_raise ActiveRecord::ReadOnlyRecord do
+        StaticThing.first.destroy
+      end
+      assert_equal(before_count, StaticThing.count)
+    end
+
+    should "prevent update" do
+      thing = StaticThing.first
+      thing.name = 'something different'
+      assert_raise ActiveRecord::ReadOnlyRecord do
+        thing.save
+      end
+    end
+  end
+end

data/test/test_version.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestReadonly < Test::Unit::TestCase
+  should "have a version" do
+    assert_not_nil(ActiveRecord::ReadonlyModel::VERSION)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-readonly_model
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Christian Dinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Makes an ActiveRecord model read-only
+email:
+- cdinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-readonly_model.gemspec
+- lib/active_record-readonly_model.rb
+- lib/active_record-readonly_model/version.rb
+- test/helper.rb
+- test/test_ignore_readonly.rb
+- test/test_readonly.rb
+- test/test_version.rb
+homepage: ''
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Makes an ActiveRecord model read-only
+test_files:
+- test/helper.rb
+- test/test_ignore_readonly.rb
+- test/test_readonly.rb
+- test/test_version.rb