pethau 0.0.1 → 0.0.2

data/README.md

@@ -2,8 +2,8 @@
 
 A bunch of code that we find useful to share amongst our projects.
 
-This is the place that code lives when it doesn't have a larger purpose; in
-less awesome teams this would be the "utility" package.
+This is the place that code lives when it doesn't have a larger purpose;
+in less awesome teams this would be the "utility" package.
 
 Pethau is Welsh for "things," which I think captures the general purpose
 nature of this gem nicely.
@@ -22,18 +22,78 @@ A lot of my classes use the following initializer pattern:
       private :baz=, :baz
 
       def initialize bar, baz
-	self.bar = bar
-	self.baz = baz
+        self.bar = bar
+        self.baz = baz
       end
     end
 
-I've been doing this for a while now, and I believe it's established itself as
-enough of a pattern that I want to pull out the implementation and DRY it up:
+I've been doing this for a while now, and I believe it's established
+itself as enough of a pattern that I want to pull out the implementation
+and DRY it up:
 
     class Foo
       include Pethau::InitializeWith
       initialize_with :foo, :bar
     end
 
-ince this is used in a lot of places in my projects I tend to include it in
-`Object` but I didn't want to make that decision for you.
+Since this is used in a lot of places in my projects I tend to include
+it in `Object` but I didn't want to make that decision for you.
+
+
+### default\_value\_of
+
+It's useful to provide default values for attribute when they're not defined, but it's annoying to type code like this all the time:
+
+    class Quux
+      attr_writer :corge, :foo
+
+      def corge
+        @corge || "Default Value"
+      end
+
+      def foo
+        @foo || FooBuilder.new.execute
+      end
+    end
+
+Instead, I prefer this:
+
+    class Quux
+      attr_accessor :corge, :foo
+      default_value_of :corge, "Default Value"
+      default_value_of :foo do
+        FooBuilder.new.execute
+      end
+    end
+
+Combining it with InitializeWith yields a rather nice, readable, concise
+class definition:
+
+    class Grault
+      initialize_with :garply, :waldo
+      default_value_of :waldo do
+        plugh = Plugh.new
+        plugh.execute
+      end
+    end
+
+
+### private\_attr\_accessor
+
+I tend to avoid using instance variables where possible, my opinion
+being that they couple you to the implementation of the class where
+using accessors tie you only to the internal class interface - I've
+found that the later makes it faster and easier to refactor my code.
+
+Instead of typing this all the time:
+
+    class Boggle
+      attr_accessor :orf, :gin
+      private :orf=, :orf, :gin=, :gin
+    end
+
+I can type this:
+
+    class Boggle
+      private_attr_accessor :orf, :gin
+    end

data/lib/pethau/default_value_of.rb

@@ -0,0 +1,28 @@
+module Pethau
+  module DefaultValueOf
+    def self.included into
+      into.extend ClassMethods
+    end
+
+    module ClassMethods
+      def default_value_of attribute_name, default_value = nil, &builder
+        if default_value && block_given?
+          raise "Only provide one of default value or builder" 
+        end
+
+        getter_with_default = "#{attribute_name}_with_default"
+        getter_without_default = "#{attribute_name}_without_default"
+        alias_method getter_without_default, attribute_name
+
+        define_method getter_with_default do
+          original_value = send getter_without_default
+          return original_value unless original_value.nil?
+          return builder.call if block_given?
+          default_value
+        end
+        alias_method attribute_name, getter_with_default
+      end
+      private :default_value_of
+    end
+  end
+end

data/lib/pethau/initialize_with.rb

@@ -6,16 +6,17 @@ module Pethau
 
     module ClassMethods
       def initialize_with *args
-	args.each do |attribute|
-	  attr_accessor attribute
-	  private attribute, "#{attribute}="
-	end
+        args.each do |attribute|
+          attr_accessor attribute
+          private attribute, "#{attribute}="
+        end
 
-	define_method :initialize do |*initial_args|
-	  args.each do |arg|
-	    send "#{arg}=", initial_args.shift
-	  end
-	end
+        define_method :initialize do |*initial_args|
+          args.each do |arg|
+            break if initial_args.empty?
+            send "#{arg}=", initial_args.shift
+          end
+        end
       end
       private :initialize_with
     end

data/lib/pethau/private_attr_accessor.rb

@@ -0,0 +1,17 @@
+module Pethau
+  module PrivateAttrAccessor
+    def self.included into
+      into.extend ClassMethods
+    end
+
+    module ClassMethods
+      def private_attr_accessor *attribute_names
+        attr_accessor *attribute_names
+        attribute_names.each do |attribute_name|
+          private attribute_name, "#{attribute_name}="
+        end
+      end
+      private :private_attr_accessor
+    end
+  end
+end

data/lib/pethau/version.rb

@@ -1,3 +1,3 @@
 module Pethau
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/pethau.rb

@@ -1,2 +1,4 @@
 require 'pethau/version'
 require 'pethau/initialize_with'
+require 'pethau/default_value_of'
+require 'pethau/private_attr_accessor'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pethau
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-06 00:00:00.000000000Z
+date: 2011-10-25 00:00:00.000000000Z
 dependencies: []
 description: Extracting a bunch of code that we use across our projects. In less awesome
   teams this would be the utility package.
@@ -19,7 +19,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/pethau/default_value_of.rb
 - lib/pethau/initialize_with.rb
+- lib/pethau/private_attr_accessor.rb
 - lib/pethau/version.rb
 - lib/pethau.rb
 - README.md