frozen-objects 0.1.0 → 0.2.0

data/README.md

@@ -1,15 +1,15 @@
 Frozen Objects
 ==============
 
-**frozen-objects** provides syntax sugar of implicitly frozen objects 
-useful for example in class constants.
+**frozen-objects** provides some syntactic sugar of implicitly frozen 
+objects and an freezing operator 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")
+        SOME_STRING = Frozen::String::new("bar")
     end
     
     Foo::SOME_ARRAY.frozen?     # will return true
@@ -21,6 +21,23 @@ Objects are reported as frozen of sure. From other points of view they
 are "normal" and fully compatible with Ruby implicitly 
 non-frozen objects.
 
+### Freezing Operator
+
+`Frozen` module defines also *frozen operator*. It's intended for nice
+and simple freezing whatever. Consider example above:
+
+    require "frozen-objects"
+
+    class Foo
+        SOME_ARRAY = Frozen << [:a, :b]
+        SOME_HASH = Frozen << {:a => :b}
+        SOME_STRING = Frozen << "bar"
+        
+        WHATEVER = Frozen << SomeClass::new
+    end
+
+Both methods are equivalent. Select that one which is suitable for you.
+
 Contributing
 ------------
 

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   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.summary = 'Provides some syntactic sugar of implicitly frozen objects and an freezing operator 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,

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/frozen-objects.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{frozen-objects}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-03-02}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "frozen-objects.gemspec",
+    "lib/frozen-objects.rb",
+    "lib/frozen-objects/array.rb",
+    "lib/frozen-objects/hash.rb",
+    "lib/frozen-objects/string.rb",
+    "test"
+  ]
+  s.homepage = %q{http://github.com/martinkozak/frozen-objects}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Provides some syntactic sugar of implicitly frozen objects and an freezing operator useful for example in class constants.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<riot>, [">= 0.12.1"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<riot>, [">= 0.12.1"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<riot>, [">= 0.12.1"])
+  end
+end
+

data/lib/frozen-objects.rb

@@ -4,3 +4,23 @@
 require "frozen-objects/string"
 require "frozen-objects/array"
 require "frozen-objects/hash"
+
+##
+# Implicitly frozen objects.
+#
+
+module Frozen
+    
+    ##
+    # Creates frozen object by operator.
+    #
+    # @param [Object] value some value for freeze
+    # @return [Object] frozen object
+    # @since 0.2.0
+    #
+    
+    def self.<<(value)
+        value.freeze
+    end
+    
+end

data/lib/frozen-objects/array.rb

@@ -7,7 +7,7 @@
 
 module Frozen
     ##
-    # Implicitly frozen array.
+    # Implicitly frozen +Array+.
     #
     # @note All calls are +Array+ compatible.
     # @see http://www.ruby-doc.org/core/classes/Array.html

data/lib/frozen-objects/hash.rb

@@ -7,7 +7,7 @@
 
 module Frozen
     ##
-    # Implicitly frozen hash.
+    # Implicitly frozen +Hash+.
     #
     # @note All calls are +Hash+ compatible.
     # @see http://www.ruby-doc.org/core/classes/Hash.html

data/lib/frozen-objects/string.rb

@@ -7,7 +7,7 @@
 
 module Frozen
     ##
-    # Implicitly frozen string.
+    # Implicitly frozen +String+.
     #
     # @note All calls are +String+ compatible.
     # @see http://www.ruby-doc.org/core/classes/String.html

data/test

@@ -17,7 +17,18 @@ context "Array" do
     asserts("frozen state") do
         begin
             topic.replace([:c, :d])
-        rescue RuntimeError => e
+        rescue RuntimeError
+            true
+        end
+    end
+end
+
+context "Frozen" do
+    asserts("#<< (static)") do
+        frozen = Frozen << "alfa"
+        begin
+            frozen.replace("beta")
+        rescue RuntimeError
             true
         end
     end
@@ -34,7 +45,7 @@ context "Hash" do
     asserts("frozen state") do
         begin
             topic.replace({:c => :d})
-        rescue RuntimeError => e
+        rescue RuntimeError
             true
         end
     end
@@ -51,7 +62,7 @@ context "String" do
     asserts("frozen state") do
         begin
             topic.replace("new")
-        rescue RuntimeError => e
+        rescue RuntimeError
             true
         end
     end

metadata

@@ -2,7 +2,7 @@
 name: frozen-objects
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +01:00
+date: 2011-03-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- frozen-objects.gemspec
 - lib/frozen-objects.rb
 - lib/frozen-objects/array.rb
 - lib/frozen-objects/hash.rb
@@ -82,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -322238794642139436
+      hash: 2742531724682757497
       segments: 
       - 0
       version: "0"
@@ -98,6 +99,6 @@ 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.
+summary: Provides some syntactic sugar of implicitly frozen objects and an freezing operator useful for example in class constants.
 test_files: []