activerecord-be_readonly 0.0.1

data/README.md

@@ -0,0 +1,46 @@
+Be Readonly for ActiveRecord 3.x/4.x and Rails 3.x/4.x
+=====
+
+Makes any ActiveRecord model become read-only in Rails with:
+
+    be_readonly
+
+There are other gems that provide similar behavior, but from what I saw, they did either too much or too little. This one is just right, and be_readonly couldn't be much shorter to type and read without just being "readonly", but readonly would be too easily confused with related instance methods in ActiveRecord.
+
+### What it does
+
+Adding this gem to you bundle will add a class method called be_readonly on each model when Rails loads via a railtie.
+
+If be_readonly is called on the class, it defines the class methods: delete and delete_all and the instance methods: before_create, before_save, before_destroy, and delete to all raise a ActiveRecord::ReadOnlyRecord error. It also defines the instance method readonly? to return true, which disables a lot that tries to create and update in ActiveRecord.
+
+### Setup
+
+In your ActiveRecord/Rails 3.0+ project, add this to your Gemfile:
+
+    gem 'activerecord-be_readonly'
+
+For the development version:
+
+    gem 'activerecord-be_readonly', :git => 'git://github.com/garysweaver/activerecord-be_readonly.git'
+
+Then run:
+
+    bundle install
+
+### Usage
+
+In your model just include this, preferably somewhere noticeable like at the top:
+
+    be_readonly
+
+### Using without Rails
+
+Or if you are off-rails, but use ActiveRecord, just do this in the model class:
+
+    include BeReadonly::Now
+
+### License
+
+Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/activerecord-be_readonly/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/activerecord-be_readonly.rb

@@ -0,0 +1,4 @@
+require 'activerecord-be_readonly/version'
+require 'activerecord-be_readonly/model'
+require 'activerecord-be_readonly/now'
+require 'activerecord-be_readonly/railtie' if defined?(Rails)

data/lib/activerecord-be_readonly/model.rb

@@ -0,0 +1,47 @@
+module BeReadonly
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def be_readonly
+        extend BeReadonlyClassMethods # intentionally not in ClassMethods which is automatically extended via ActiveSupport::Concern
+        include BeReadonlyInstanceMethods # intentionally not just InstanceMethods as those would be automatically included via ActiveSupport::Concern
+      end
+    end
+
+    module BeReadonlyClassMethods
+      def delete(id_or_array)
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def delete_all(conditions = nil)
+        raise ActiveRecord::ReadOnlyRecord
+      end
+    end
+
+    module BeReadonlyInstanceMethods
+      def readonly?
+        return true
+      end
+
+      def before_create
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def before_save
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def before_destroy
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def delete
+        raise ActiveRecord::ReadOnlyRecord
+      end
+    end
+  end
+end

data/lib/activerecord-be_readonly/now.rb

@@ -0,0 +1,9 @@
+module BeReadonly
+  module Now
+    extend ActiveSupport::Concern
+    included do
+      include BeReadonly::Model
+      be_readonly
+    end
+  end
+end

data/lib/activerecord-be_readonly/railtie.rb

@@ -0,0 +1,12 @@
+require 'activerecord-be_readonly'
+
+module BeReadonly
+  class Railtie < Rails::Railtie
+    initializer "activerecord-be_readonly.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        # ActiveRecord::Base gets new behavior
+        include BeReadonly::Model # ActiveSupport::Concern
+      end
+    end
+  end
+end

data/lib/activerecord-be_readonly/version.rb

@@ -0,0 +1,3 @@
+module BeReadonly
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-be_readonly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-22 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes read-only models easier to implement in ActiveRecord 3.x/4.x.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/activerecord-be_readonly/model.rb
+- lib/activerecord-be_readonly/now.rb
+- lib/activerecord-be_readonly/railtie.rb
+- lib/activerecord-be_readonly/version.rb
+- lib/activerecord-be_readonly.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/activerecord-be_readonly
+licenses:
+- MIT
+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: Easy read-only models for ActiveRecord 3.x/4.x.
+test_files: []