moosex 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8494a9819b7d500cafd3b8296714bd59cbcdad27
-  data.tar.gz: 2939d832b895dd24a00a829030de65f315cb6005
+  metadata.gz: 762256a8cbd9378b2e80924fda5e278861f38f7e
+  data.tar.gz: fdbd36add8e84286e0094a907f5b24830d1d0e80
 SHA512:
-  metadata.gz: 2510660f1124aedb3221696c4b20f4e45aaa3cf2c6ae42f2457c19d918ef45fb7e6d9afedca3b37e71d3cd3c1997e79f83f5064d4bb050a2b6943c647a8859e9
-  data.tar.gz: d0551a59229e8bbb1bffabbfe72443d0d2e2993e3ceae24d99afdb7adbd8ee616f01ef39ef3c703eca04b07681b8e4e79caf0e70178b6e462b87eaa0a5fd3758
+  metadata.gz: 2215ab98afd2f0b15faa905e8de8dfc2c436814efb16bcd62c6f29474ccb7b371b96a463d45845d3e868adfb7a17df1ff2a06c7d3da1ec3e82138670fe7a8df8
+  data.tar.gz: 7474bb350e05b1734aec6257ec83b2a279e34839592ca48a907c6d4730c74f1fc0fe66fb4cd43cdc1d5cea5635525c08ca00013d6367d066ec7929cf7942052b

data/Changelog

@@ -1,6 +1,11 @@
+0.0.8 - 2014-02-01
+  - should support init_arg option in attr #14
+	- support lazy attributes / builder #4
+	- support a custom name for getter / setter #9
+	
 0.0.7 - 2014-02-01
   - add min version of ruby should be 2.0.x
-  
+
 0.0.6 - 2014-02-01
   - fix bug when extends subclass, now it is safe #18
   - required attr with default value will no longer throw exception #30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moosex (0.0.7)
+    moosex (0.0.8)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -96,6 +96,34 @@ class Target
   def method_y(a,b,c); a + b + c; end # or methods with arguments
 end
 
+class Point3D < Point
+
+  has x: {        # override original attr!
+    is: :rw,
+    isa: Integer,
+    default: 1,
+  }
+  
+  has z: {
+    is: :rw,      # read-write (mandatory)
+    isa: Integer, # should be Integer
+    default: 0,   # default value is 0 (constant)
+  }
+
+  has color: {
+    is: :rw,      # you should specify the reader/writter
+    reader: :what_is_the_color_of_this_point,
+    writter: :set_the_color_of_this_point,
+    default: :red,
+  }
+
+  def clear 
+    self.x= 0      # to run with type-check you must
+    self.y= 0      # use the setter instad @x=
+    self.z= 0
+  end
+end 
+
 # now you have a generic constructor
 p1  = Point.new                       # x and y will be 0
 p2  = Point.new( x:  5 )              # y will be 0
@@ -223,9 +251,43 @@ end
 ```
 and much more
 
+## Lazy Attributes
+
+```ruby
+class LazyFox
+  include MooseX
+
+  has something: {
+    is: :lazy
+  }
+
+  has other_thing: {
+    is: :rw,
+    lazy: true,
+    predicate: true,
+    clearer: true,
+    builder: :my_build_other_thing,
+  }
+
+  has lazy_attr_who_accepts_lambda: {
+    is: :lazy,
+    builder: lambda{ |object|  object.something }
+  }
+
+  def build_something
+    1024
+  end
+
+  private 
+  def my_build_other_thing
+    128
+  end
+end
+```
+
 ## TODO
 
-1. Support to lazy attributes
+1. Support to lazy attributes [done]
 2. Support to BUILD and BUILDARGS hook
 3. Support to Roles ( it is a Module on Steroids )
 4. Support to after/before/around 

data/lib/moosex.rb

@@ -67,18 +67,18 @@ module MooseX
 
 				g = attr.generate_getter
 				
-	    		define_method attr.attr_symbol, &g
+	    	define_method attr.reader, &g
 	 
 	 			s = attr.generate_setter
 	 		
 	 			case attr.is 
 	 			when :rw 				
-					define_method "#{attr.attr_symbol}=", &s
+					define_method attr.writter, &s
 				
 				when :rwp
-					define_method "#{attr.attr_symbol}=", &s
+					define_method attr.writter, &s
 					
-					private "#{attr.attr_symbol}="
+					private attr.writter
 				end
 
 				__meta.add(attr)
@@ -88,7 +88,7 @@ module MooseX
 	
 	class Attribute
 
-		attr_reader :attr_symbol, :is 
+		attr_reader :attr_symbol, :is, :reader, :writter, :lazy, :builder
 		DEFAULTS= { 
 			lazy: false,
 			clearer: false,
@@ -106,7 +106,6 @@ module MooseX
 					raise "invalid value for field '#{field_name}' is '#{is}', must be one of :rw, :rwp, :ro or :lazy"  
 				end
 			end,
-			handles: lambda {|handles, field_name| true }, # TODO: add implementation
 		};
 
 		COERCE = {
@@ -199,12 +198,37 @@ module MooseX
 				end.reduce({}) do |hash,e| 
 					hash.merge(e)
 				end
-			end,			
+			end,
+			reader: lambda do |reader, field_name|
+				reader.to_sym
+			end,
+			writter: lambda do |writter, field_name|
+				writter.to_sym
+			end,
+			builder: lambda do |builder, field_name|
+				unless builder.is_a? Proc
+					builder_method_name = builder.to_sym
+					builder = lambda do |object|
+						object.send(builder_method_name)
+					end
+				end
+
+				builder
+			end,
+			init_arg: lambda do |init_arg, field_name|
+				init_arg.to_sym
+			end,
 		};
 
 		def initialize(a, o)
 			# todo extract this to a framework, see issue #21 on facebook
-			o = DEFAULTS.merge(o)
+
+			o = DEFAULTS.merge({
+				reader: a,
+				writter: a.to_s.concat("=").to_sym,
+			  builder: "build_#{a}".to_sym,
+			  init_arg: a,
+			}).merge(o)
 
 			REQUIRED.each { |field| 
 				unless o.has_key?(field)
@@ -220,6 +244,14 @@ module MooseX
 				return if ! o.has_key? field
 
 				validate.call(o[field], a)
+			end
+
+			if o[:is].eql? :lazy
+				o[:lazy] = true
+			end
+
+			unless o[:lazy]
+				o[:builder] = nil
 			end	
 
 			@attr_symbol = a
@@ -231,12 +263,15 @@ module MooseX
 			@clearer     = o[:clearer]
 			@handles     = o[:handles]
 			@lazy        = o[:lazy]
+			@reader      = o[:reader]
+			@writter     = o[:writter]
+			@builder     = o[:builder]
+			@init_arg    = o[:init_arg]
 		end
 		
 		def init(object, args)
 			inst_variable_name = "@#{@attr_symbol}".to_sym
 			
-			setter = @attr_symbol.to_s.concat("=").to_sym
 			value  = nil
 
 			attr_symbol = @attr_symbol
@@ -260,8 +295,8 @@ module MooseX
 				end
 			end
 
-			if args.has_key? @attr_symbol
-				value = args[ @attr_symbol ]
+			if args.has_key? @init_arg
+				value = args[ @init_arg ]
 			elsif @default
 				value = @default.call
 			elsif @required
@@ -270,38 +305,54 @@ module MooseX
 				return
 			end
  
- 			if @is.eql? :ro
+ 			if @is.eql?(:ro) || @is.eql?(:lazy)
 
  				# TODO: remove redundancy
 
-				type_check = generate_type_check
+				type_check = @isa
 				type_check.call(value)
+
 				object.instance_variable_set inst_variable_name, value
 			
 			else
 
-				object.send( setter, value )
+				object.send( @writter, value )
 				
 			end	
 		end
 		
 		def generate_getter
 			inst_variable_name = "@#{@attr_symbol}".to_sym
-			Proc.new { instance_variable_get inst_variable_name }
+			
+			builder    = @builder
+			before_get = lambda {|object|  }
+
+			if @lazy
+				type_check = @isa
+
+				before_get = lambda do |object|
+					return if object.instance_variable_defined? inst_variable_name
+
+					value = builder.call(object)
+					type_check.call(value)
+
+					object.instance_variable_set(inst_variable_name, value)					
+				end
+			end
+
+			Proc.new do 
+				before_get.call(self)
+				instance_variable_get inst_variable_name 
+			end
 		end
 		
 		def generate_setter
 			inst_variable_name = "@#{@attr_symbol}".to_sym
-			type_check = generate_type_check
+			type_check = @isa
 			Proc.new  do |value| 
 				type_check.call(value)
 				instance_variable_set inst_variable_name, value
 			end
-		end
-		
-		def generate_type_check
-
-			return @isa
-		end			
+		end	
 	end
 end

data/lib/moosex/version.rb

@@ -1,3 +1,3 @@
 module Moosex
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/moosex_spec.rb

@@ -78,6 +78,11 @@ class Foo
       is: :rwp,       # read-write-private (private setter)
       required: true, # you should require in the constructor 
     }
+
+    has my_other_bar: {
+    	is: :rw,
+    	init_arg: :bar2
+    }
 end
 
 describe "Foo" do
@@ -98,6 +103,11 @@ describe "Foo" do
 			foo.bar = 1024
 		}.to raise_error(NoMethodError)
 	end
+
+	it "should be possible initialize my_other_bar by bar2" do
+		foo = Foo.new( bar: 1, bar2: 555)
+		foo.my_other_bar.should == 555
+	end
 end 
 
 class Baz
@@ -362,9 +372,16 @@ class Point3D < Point
 		default: 0,   # default value is 0 (constant)
 	}
 
+	has color: {
+		is: :rw,      # you should specify the reader/writter
+		reader: :what_is_the_color_of_this_point,
+		writter: :set_the_color_of_this_point,
+		default: :red,
+	}
+
 	def clear 
-		self.x= 0        # to run with type-check you must
-		self.y= 0        # use the setter instad @x=
+		self.x= 0      # to run with type-check you must
+		self.y= 0      # use the setter instad @x=
 		self.z= 0
 	end
 end 
@@ -376,20 +393,23 @@ describe "Point3D" do
 			p.x.should == 1
 			p.y.should be_zero
 			p.z.should be_zero
+			p.what_is_the_color_of_this_point.should == :red
 		end
 	
 		it "should initialize only y" do
 			p = Point3D.new( x: 5 )
 			p.x.should == 5
 			p.y.should be_zero
-			p.z.should be_zero			
+			p.z.should be_zero
+			p.what_is_the_color_of_this_point.should == :red						
 		end
 	
 		it "should initialize x and y" do
-			p = Point3D.new( x: 5, y: 4, z: 8)
+			p = Point3D.new( x: 5, y: 4, z: 8, color: :yellow)
 			p.x.should == 5
 			p.y.should == 4
 			p.z.should == 8
+			p.what_is_the_color_of_this_point.should == :yellow			
 		end
 	end
 	
@@ -421,4 +441,138 @@ describe "Point3D" do
 			p.z.should be_zero			
 		end	
 	end	
+
+	describe "should create the accessors names with custom names" do
+		it "should get/set" do
+			p = Point3D.new
+			p.what_is_the_color_of_this_point.should == :red
+			p.set_the_color_of_this_point(:black)
+			p.what_is_the_color_of_this_point.should == :black
+		end
+	end
+end
+
+class LazyFox
+	include MooseX
+
+	has something: {
+		is: :lazy
+	}
+
+	has other_thing: {
+		is: :rw,
+		lazy: true,
+		predicate: true,
+		clearer: true,
+		builder: :my_build_other_thing,
+	}
+
+	has lazy_attr_who_accepts_lambda: {
+		is: :lazy,
+		builder: lambda{ |object| object.something }
+	}
+
+	has lazy_with_default: {
+		is: :lazy,
+		default: 10,
+		clearer: true,
+		builder: lambda {|o| 1 },
+	}
+
+	has last_lazy_attr: {
+		is: :rw,
+		lazy: true,
+	}
+
+	def build_something
+		1024
+	end
+
+	private 
+	def my_build_other_thing
+		128
+	end
 end
+
+describe "LazyFox" do
+	it "lazy attr should be act as a normal read only attr" do
+		l = LazyFox.new(something: 0)
+		l.something.should == 0
+	end
+
+	it "lazy attr should be read-only" do
+		l = LazyFox.new
+		expect{
+			l.something= 1
+		}.to raise_error(NoMethodError)
+	end
+
+	it "lazy: true but is :rw should act as a defered default value" do
+		l = LazyFox.new
+		l.other_thing.should == 128
+		l.other_thing = 9
+		l.other_thing.should == 9
+	end
+
+	it "lazy: true should not exists until necessary" do
+		l = LazyFox.new
+		l.has_other_thing?.should be_false
+
+		l.other_thing.should == 128
+
+		l.has_other_thing?.should be_true
+	end
+
+	it "lazy: true :rw should build again" do
+		l = LazyFox.new
+		l.other_thing.should == 128
+
+		l.has_other_thing?.should be_true
+
+		l.reset_other_thing!
+
+		l.has_other_thing?.should be_false 
+
+		l.other_thing.should == 128
+
+		l.has_other_thing?.should be_true
+	end	
+
+	it "lazy attr should call build if necessary" do
+		l = LazyFox.new
+		l.something.should == 1024
+		l.other_thing.should == 128
+	end
+
+	it "lazy attr should accept lambda" do
+		l = LazyFox.new
+		l.lazy_attr_who_accepts_lambda.should == 1024
+	end
+
+	it "lazy attr should accept lambda (2)" do
+		l = LazyFox.new(something: 2)
+		l.lazy_attr_who_accepts_lambda.should == 2
+	end	
+
+	it "lazy_with_default should be initialize with default value" do
+		l = LazyFox.new
+		l.lazy_with_default.should == 10
+		l.reset_lazy_with_default!
+		l.lazy_with_default.should == 1
+	end
+
+	it "last_lazy_attr will raise error without a builder" do
+		l = LazyFox.new
+		expect {
+			l.last_lazy_attr
+		}.to raise_error(NoMethodError)
+	end
+
+	it "last_lazy_attr will not raise error with a builder" do
+		l = LazyFox.new
+		def l.build_last_lazy_attr
+			0
+		end
+		l.last_lazy_attr.should be_zero
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moosex
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Tiago Peczenyj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler