frozen-objects 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#  gem "hash-utils", ">= 0.11.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "riot", ">= 0.12.1"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    riot (0.12.1)
+      rr
+      term-ansicolor
+    rr (1.0.2)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  riot (>= 0.12.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák
+
+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,41 @@
+Frozen Objects
+==============
+
+**frozen-objects** provides syntax sugar of implicitly frozen objects 
+useful for example in class constants.
+
+    require "frozen-objects"
+
+    class Foo
+        SOME_ARRAY = Frozen::Array[:a, :b]   # or any other Array constructing methods
+        SOME_HASH = Frozen::Hash[:a => :b]   # or any other Hash constructing methods
+        SOME_STRING = Frozen::String::new("a")
+    end
+    
+    Foo::SOME_ARRAY.frozen?     # will return true
+    Foo::SOME_HASH.frozen?      # will return true
+    Foo::SOME_STRING.frozen?    # will return true
+    
+All attempts to modify these objects will fail on `RuntimeError`. 
+Objects are reported as frozen of sure. From other points of view they 
+are "normal" and fully compatible with Ruby implicitly 
+non-frozen objects.
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/frozen-objects/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "frozen-objects"
+  gem.homepage = "http://github.com/martinkozak/frozen-objects"
+  gem.license = "MIT"
+  gem.summary = 'Syntax sugar of implicitly frozen objects useful for example in class constants.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hash-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/frozen-objects.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "frozen-objects/string"
+require "frozen-objects/array"
+require "frozen-objects/hash"

data/lib/frozen-objects/array.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# Implicitly frozen objects.
+#
+
+module Frozen
+    ##
+    # Implicitly frozen array.
+    #
+    # @note All calls are +Array+ compatible.
+    # @see http://www.ruby-doc.org/core/classes/Array.html
+    #
+    
+    class Array < ::Array
+        def initialize(*args, &block)
+            super(*args, &block)
+            self.freeze
+        end
+    end
+end

data/lib/frozen-objects/hash.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# Implicitly frozen objects.
+#
+
+module Frozen
+    ##
+    # Implicitly frozen hash.
+    #
+    # @note All calls are +Hash+ compatible.
+    # @see http://www.ruby-doc.org/core/classes/Hash.html
+    #
+    
+    class Hash < ::Hash
+        def self.[](*args)
+            result = super(*args)
+            result.freeze
+        end
+        
+        def initialize(*args, &block)
+            super(*args, &block)
+            self.freeze
+        end
+    end
+end

data/lib/frozen-objects/string.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# Implicitly frozen objects.
+#
+
+module Frozen
+    ##
+    # Implicitly frozen string.
+    #
+    # @note All calls are +String+ compatible.
+    # @see http://www.ruby-doc.org/core/classes/String.html
+    #
+    
+    class String < ::String
+        def initialize(*args, &block)
+            super(*args, &block)
+            self.freeze
+        end
+    end
+end

data/test

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+require "frozen-objects"
+require "riot"
+
+context "Array" do
+    setup do 
+        Frozen::Array[:a, :b]
+    end
+    
+    asserts("non-frozen class object equivalence") do
+        topic == [:a, :b]
+    end
+    asserts("frozen state") do
+        begin
+            topic.replace([:c, :d])
+        rescue RuntimeError => e
+            true
+        end
+    end
+end
+
+context "Hash" do
+    setup do 
+        Frozen::Hash[:a => :b]
+    end
+
+    asserts("non-frozen class object equivalence") do
+        topic == {:a => :b}
+    end    
+    asserts("frozen state") do
+        begin
+            topic.replace({:c => :d})
+        rescue RuntimeError => e
+            true
+        end
+    end
+end
+
+context "String" do
+    setup do 
+        Frozen::String::new("frozen")
+    end
+    
+    asserts("non-frozen class object equivalence") do
+        topic == "frozen"
+    end
+    asserts("frozen state") do
+        begin
+            topic.replace("new")
+        rescue RuntimeError => e
+            true
+        end
+    end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: frozen-objects
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +01: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: riot
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/frozen-objects.rb
+- lib/frozen-objects/array.rb
+- lib/frozen-objects/hash.rb
+- lib/frozen-objects/string.rb
+- test
+has_rdoc: true
+homepage: http://github.com/martinkozak/frozen-objects
+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: -322238794642139436
+      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: Syntax sugar of implicitly frozen objects useful for example in class constants.
+test_files: []
+