as_readonly 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Robert Pankowecki
+
+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,135 @@
+# AsReadonly
+
+Expose your collections as readonly objects without fear.
+
+
+## Example
+
+```ruby
+  ara = AsReadonly::Array.new([1,2])
+  ara[0]    # => 1
+  ara.clear # raises NoMethodError
+```
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'as_readonly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install as_readonly
+
+## Require
+
+* `as_readonly/array`
+
+        AsReadonly::Array
+
+* `as_readonly/hash`
+
+        AsReadonly::Hash
+
+* `as_readonly/set`
+
+        AsReadonly::Set
+
+* `as_readonly/collections`
+
+        as_readonly/array
+        as_readonly/hash
+        as_readonly/set`
+
+* `as_readonly/core_ext/array`
+
+        array.as_readonly # => AsReadonly::Array.new(array)
+
+* `as_readonly/core_ext/hash`
+
+        hash.as_readonly  # => AsReadonly::Hash.new(hash)
+
+* `as_readonly/core_ext/set`
+
+        set.as_readonly   # => AsReadonly::Set.new(set)
+
+* `as_readonly/core_ext/collections`
+
+        as_readonly/core_ext/array
+        as_readonly/core_ext/hash
+        as_readonly/core_ext/set
+
+* `as_readonly/core_ext/module`
+
+        Module#attr_readonly
+
+        class MyClass
+          attr_readonly :array
+          def initialize
+            @array = []
+          end
+        end
+
+        MyClass.new.array.size  => 0
+        MyClass.new.array.clear => NoMethodError exception
+
+* `as_readonly/core_ext/all`
+
+        as_readonly/core_ext/collections
+        as_readonly/core_ext/module
+
+* `as_readonly` - everything above
+
+
+## Usage
+
+```ruby
+require 'as_readonly/array'
+
+class MyClass
+  def initialize
+    @collection = []
+  end
+
+  def collection
+    @read_collection ||= AsReadonly::Array.new(@collection)
+  end
+end
+```
+
+## Note
+
+This gem does not prevent calling mutating methods on collection elements. Obviously.
+
+```ruby
+class MyClass
+  def initialize
+    @collection = ["asd"]
+  end
+
+  def collection
+    @read_collection ||= AsReadonly::Array.new(@collection)
+  end
+end
+
+c = MyClass.new
+c.collection[0].upcase
+```
+
+## Inspirations
+
+* http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/144294
+* http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/144375
+* http://msdn.microsoft.com/en-us/library/e78dcd75.aspx
+
+## 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/*_test.rb'
+  test.libs << 'lib' << 'test'
+end
+
+task :default => :test

data/as_readonly.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/as_readonly/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Pankowecki"]
+  gem.email         = ["robert.pankowecki@gmail.com"]
+  gem.description   = %q{Safely expose collections as readonly objects}
+  gem.summary       = %q{Safley expose collections}
+  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          = "as_readonly"
+  gem.require_paths = ["lib"]
+  gem.version       = AsReadonly::VERSION
+end

data/lib/as_readonly.rb

@@ -0,0 +1,5 @@
+module AsReadonly
+end
+
+require "as_readonly/version"
+require "as_readonly/core_ext/all"

data/lib/as_readonly/array.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+
+module AsReadonly
+  class Array < DelegateClass(::Array)
+    REMOVED = %w|
+         << []= clear concat delete delete_at delete_if
+         flatten! insert map! pop push reject! replace
+         reverse! shift slice! sort! uniq! unshift fill
+    |.each do |method|
+      undef_method(method)
+    end
+
+    def method_missing(*params)
+      raise NoMethodError
+    end
+
+    def respond_to?(method, include_private = false)
+      return false if REMOVED.include?(method.to_s)
+      super
+    end
+  end
+end

data/lib/as_readonly/collections.rb

@@ -0,0 +1,3 @@
+require 'as_readonly/array'
+require 'as_readonly/hash'
+require 'as_readonly/set'

data/lib/as_readonly/core_ext/all.rb

@@ -0,0 +1,2 @@
+require 'as_readonly/core_ext/collections'
+require 'as_readonly/core_ext/module'

data/lib/as_readonly/core_ext/array.rb

@@ -0,0 +1,7 @@
+require 'as_readonly/array'
+
+class Array
+  def as_readonly
+    AsReadonly::Array.new(self)
+  end
+end

data/lib/as_readonly/core_ext/collections.rb

@@ -0,0 +1,4 @@
+require 'as_readonly/core_ext/array'
+require 'as_readonly/core_ext/hash'
+require 'as_readonly/core_ext/set'
+

data/lib/as_readonly/core_ext/hash.rb

@@ -0,0 +1,7 @@
+require 'as_readonly/hash'
+
+class Hash
+  def as_readonly
+    AsReadonly::Hash.new(self)
+  end
+end

data/lib/as_readonly/core_ext/module.rb

@@ -0,0 +1,15 @@
+require 'as_readonly/collections'
+
+class Module
+  def attr_readonly(*attributes)
+    attributes.each do |attr|
+      module_eval <<-"end_eval", __FILE__, __LINE__
+        def #{attr}
+          @_#{attr}_as_readonly ||= begin
+            @#{attr} ? @#{attr}.as_readonly : @#{attr}
+          end
+        end
+      end_eval
+    end
+  end
+end

data/lib/as_readonly/core_ext/set.rb

@@ -0,0 +1,7 @@
+require 'as_readonly/set'
+
+class Set
+  def as_readonly
+    AsReadonly::Set.new(self)
+  end
+end

data/lib/as_readonly/hash.rb

@@ -0,0 +1,28 @@
+require 'delegate'
+
+module AsReadonly
+  # Be aware that #[] and #default are not blacklisted here
+  # but they can change the internal state of Hash if default
+  # proc is implemented to change the Hash itself:
+  #
+  # h = Hash.new {|h,k| h[k] = k*k }
+  class Hash < DelegateClass(::Hash)
+    REMOVED = %w|
+         []= clear default= default_proc=
+         delete delete_if replace  keep_if
+         merge! update rehash reject!
+         select! shift store
+    |.each do |method|
+      undef_method(method)
+    end
+
+    def method_missing(*params)
+      raise NoMethodError
+    end
+
+    def respond_to?(method, include_private = false)
+      return false if REMOVED.include?(method.to_s)
+      super
+    end
+  end
+end

data/lib/as_readonly/set.rb

@@ -0,0 +1,22 @@
+require 'set'
+require 'delegate'
+
+module AsReadonly
+  class Set < DelegateClass(::Set)
+    REMOVED = %w|
+      << add add? clear collect! map! delete delete?
+      delete_if flatten! keep_if merge reject! select!
+    |.each do |method|
+      undef_method(method)
+    end
+
+    def method_missing(*params)
+      raise NoMethodError
+    end
+
+    def respond_to?(method, include_private = false)
+      return false if REMOVED.include?(method.to_s)
+      super
+    end
+  end
+end

data/lib/as_readonly/version.rb

@@ -0,0 +1,3 @@
+module AsReadonly
+  VERSION = "1.0.0"
+end

data/test/array_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'as_readonly/array'
+
+class ArrayTest < MiniTest::Unit::TestCase
+  def setup
+    @array = AsReadonly::Array.new(@target = [])
+  end
+
+  def test_safe_method_delegated
+    assert_equal 0, @array.size
+    assert @array.respond_to?(:map)
+  end
+
+  def test_unsafe_method_removed
+    refute @array.respond_to?(:map!)
+    assert_raises(NoMethodError) { @array.map!{|x| x } }
+  end
+end

data/test/core_ext_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'as_readonly/core_ext/all'
+
+class CoreExtTest < MiniTest::Unit::TestCase
+  def test_array_ext
+    assert_instance_of AsReadonly::Array, [].as_readonly
+  end
+
+  def test_hash_ext
+    assert_instance_of AsReadonly::Hash, {}.as_readonly
+  end
+
+  def test_set_ext
+    assert_instance_of AsReadonly::Set, Set.new.as_readonly
+  end
+
+  class TestClass
+    attr_readonly :hash, :array, :set
+    def initialize
+      @hash  = {}
+      @array = []
+      @set   = Set.new
+    end
+  end
+
+  def test_attr_readonly_value
+    tc = TestClass.new
+    assert_instance_of AsReadonly::Array, tc.array
+    assert_instance_of AsReadonly::Hash, tc.hash
+    assert_instance_of AsReadonly::Set, tc.set
+  end
+
+  def test_attr_readonly_cache
+    tc = TestClass.new
+    assert_equal tc.array.object_id, tc.array.object_id
+    refute tc.array.object_id == tc.instance_variable_get(:@array).object_id
+  end
+end
+

data/test/hash_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'as_readonly/hash'
+
+class HashTest < MiniTest::Unit::TestCase
+  def setup
+    @hash = AsReadonly::Hash.new(@target = {})
+  end
+
+  def test_safe_method_delegated
+    assert_equal 0, @hash.size
+    assert @hash.respond_to?(:map)
+  end
+
+  def test_unsafe_method_removed
+    refute @hash.respond_to?(:clear)
+    assert_raises(NoMethodError) { @hash.clear }
+  end
+
+  def test_get
+    @target = Hash.new {|h,k| h[k] = k*k }
+    @hash = AsReadonly::Hash.new(@target)
+    assert_equal 0, @hash.size
+    @hash[10]
+    assert_equal 1, @hash.size
+  end
+
+  def test_default
+    @target = Hash.new {|h,k| h[k] = k*k }
+    @hash = AsReadonly::Hash.new(@target)
+    assert_equal 0, @hash.size
+    @hash.default(10)
+    assert_equal 1, @hash.size
+  end
+end

data/test/set_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+require 'as_readonly/set'
+
+class SetTest < MiniTest::Unit::TestCase
+  def setup
+    @set = AsReadonly::Set.new(@target = Set.new)
+  end
+
+  def test_safe_method_delegated
+    assert_equal 0, @set.size
+    assert @set.respond_to?(:map)
+  end
+
+  def test_unsafe_method_removed
+    refute @set.respond_to?(:map!)
+    assert_raises(NoMethodError) { @set.map!{|x| x } }
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/unit'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: as_readonly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert Pankowecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies: []
+description: Safely expose collections as readonly objects
+email:
+- robert.pankowecki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- as_readonly.gemspec
+- lib/as_readonly.rb
+- lib/as_readonly/array.rb
+- lib/as_readonly/collections.rb
+- lib/as_readonly/core_ext/all.rb
+- lib/as_readonly/core_ext/array.rb
+- lib/as_readonly/core_ext/collections.rb
+- lib/as_readonly/core_ext/hash.rb
+- lib/as_readonly/core_ext/module.rb
+- lib/as_readonly/core_ext/set.rb
+- lib/as_readonly/hash.rb
+- lib/as_readonly/set.rb
+- lib/as_readonly/version.rb
+- test/array_test.rb
+- test/core_ext_test.rb
+- test/hash_test.rb
+- test/set_test.rb
+- test/test_helper.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'
+      segments:
+      - 0
+      hash: -2462703183450842111
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2462703183450842111
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Safley expose collections
+test_files:
+- test/array_test.rb
+- test/core_ext_test.rb
+- test/hash_test.rb
+- test/set_test.rb
+- test/test_helper.rb