fortify 0.0.1

data/README.rdoc

@@ -0,0 +1,95 @@
+=Introduction 
+
+Know how you can't just use 'form_for' in rails with a newly initialized ActiveResource object?
+Ever get annoyed at having to add default attributes to your newly initialized ActiveResource objects?
+Fortify gives you the power to DRY'ly define default attributes for your ActiveResource derived classes.
+
+== Motivation
+
+Let's suppose you're going to create a form for creating Books. However, your Book is an ActiveResource::Base derived class:
+
+  # app/models/book.rb
+  class Book < ActiveResource::Base
+  end
+
+  # app/controllers/books_controller.rb
+  class BooksController < ActiveResource::Base
+    def new
+      @book = Book.new
+    end
+  end
+
+  # app/view/books/new.haml
+  - form_for @book do |f|
+    .field
+      = f.label :title
+      = f.text_field :title
+      
+    .field
+      = f.label :author
+      = f.text_field :author
+    
+    .field
+      = f.label :genre
+      = f.text_field :genre
+    
+
+This, of course fails. Why? When you create a new Book object, unlike ActiveRecord (which has the luxury of querying the database to 
+determine the object's attributes), ActiveResource starts off as a blank slate. In other words:
+
+  console> b = Book.new
+  console> b.attributes.inspect
+    ==> {}
+
+
+To get this to work, you would have to give your new Book object some default attributes: 
+
+  # app/controllers/books_controller.rb
+  class BooksController < ActiveResource::Base
+    def new
+      @book = Book.new :title => nil, :author => nil, :genre => nil
+    end
+  end
+
+As you can imagine, this approach might not be very DRY. This is where *fortify* steps in. 
+
+== Usage
+
+First, install fortify by adding the following line to your config/environment.rb and then running "sudo rake gems:install":
+
+  config.gem :fortify, :lib => 'fortify', :source => 'http://gemcutter.org'
+
+Next, go back to your book model and add some fortification to it:
+
+  # app/models/book.rb
+  class Book < ActiveResource::Base
+    fortify do |default_attributes|
+      default_attributes.author
+      default_attributes.title
+      default_attributes.genre
+    end
+    self.site = ''
+  end
+
+Now, your controller / views as you originally specified them will work, since now: 
+
+  console> b = Book.new
+  console> b.attributes.inspect
+    ==> {:author => nil, :title => nil, :genre => nil}
+
+You could also have provided some default values for your attributes:
+ 
+  # app/models/book.rb
+  class Book < ActiveResource::Base
+    fortify do |default_attributes|
+      default_attributes.author = 'Anonymous'
+      default_attributes.title = 'Untitled'
+      default_attributes.genre
+    end
+    self.site = ''
+  end
+
+In this case, a Book.new would give you: 
+  console> b = Book.new
+  console> b.attributes.inspect
+    ==> {:author => 'Anonymous', :title => 'Untitled', :genre => nil}

data/lib/fortify.rb

@@ -0,0 +1 @@
+require 'fortify/fortify'

data/lib/fortify/fortify.rb

@@ -0,0 +1,52 @@
+ActiveResource::Base.instance_eval do
+  class DefaultAttributes
+    attr_accessor :attributes
+    
+    # Override method_missing to allow setting
+    # the default attributes via undefined methods.
+    # For example: 
+    #   d = DefaultAttributes.new
+    #   d.author = 'Anonymous'
+    #   puts d.author # returns "Anonymous"
+    #   puts d.attributes[:author] # returns "Anonymous"
+    def method_missing(method, *args, &block)
+      k = attribute_name(method)
+      v = method.to_s[-1..-1] == '=' ? args[0] : nil
+      attributes[k] = v
+    end
+    
+    def attributes
+      @attributes ||= HashWithIndifferentAccess.new
+    end
+    
+    private
+    # strip the trailing "=" from a missing_method call
+    def attribute_name(attribute_method_call)
+      name = attribute_method_call.to_s
+      name[-1..-1] == '=' ? name[0..-2] : name
+    end
+  end
+  
+  class BlockRequiredError < ArgumentError; end
+  
+  class BlockArgumentError < ArgumentError; end
+  
+  
+  def fortify(&block)
+    raise BlockRequiredError.new("you must pass a block to fortify") unless block
+    raise BlockArgumentError.new("the block you pass to fortify must accept one argument") unless block.arity == 1
+    block.call default_attributes
+  end
+  
+  def default_attributes
+    @default_attributes ||= DefaultAttributes.new
+  end
+end
+
+ActiveResource::Base.class_eval do
+  def initialize_with_default_attributes(attributes={})
+    initialize_without_default_attributes self.class.default_attributes.attributes.merge(attributes)
+  end
+    
+  alias_method_chain :initialize, :default_attributes
+end

data/spec/lib_specs/fortify_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "ActiveResource::Base --" do
+  before do
+    class Book < ActiveResource::Base
+      self.site = ''
+    end
+  end
+  
+  describe "default_attributes class method" do
+    it "should return a DefaultAttributes class" do
+      Book.default_attributes.class.to_s.should == "DefaultAttributes"
+    end
+  end
+  
+  describe "DefaultAttributes" do
+    it "should have an attributes accessor" do
+      proc {Book.default_attributes.attributes}.should_not raise_error
+    end
+    
+    it "should support setting attributes via method missing" do
+      proc {Book.default_attributes.author}.should_not raise_error
+      Book.default_attributes.attributes.has_key?(:author).should be_true
+    end
+  end
+  
+  describe "fortify class method" do
+    it "should require a block be passed to it" do
+      proc { Book.fortify }.should raise_error(BlockRequiredError)
+    end
+  
+    it "should require the block passed to it accept one argument" do
+      proc { Book.fortify {} }.should raise_error(BlockArgumentError)
+    end
+    
+    it "should pass a default attributes class to the block" do
+      Book.fortify do |default_attributes|
+        default_attributes.class.to_s.should == "DefaultAttributes"
+      end
+    end
+  end
+  
+  describe "new" do
+    it "should use the default attributes created via fortify" do
+      Book.fortify do |default_attributes|
+        default_attributes.author = 'Anonymous'
+        default_attributes.genre  = 'Fiction'
+        default_attributes.isbn  
+      end
+      
+      b = Book.new
+      
+      proc {b.author}.should_not raise_error
+      b.author.should == 'Anonymous'
+      proc {b.genre}.should_not raise_error
+      b.genre.should == 'Fiction'
+      proc {b.isbn}.should_not raise_error
+      b.isbn.should be_nil
+      proc {b.attribute_not_appearing_in_this_test}.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << './lib'
+require 'activeresource'
+require 'fortify'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: fortify
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Know how you can't just use 'form_for' in rails with a newly initialized ActiveResource object? Ever get annoyed at having to add default attributes to your newly initialized ActiveResource objects? Fortify gives you the power to DRY'ly define default attributes for your ActiveResource derived classes.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/fortify.rb
+- lib/fortify/fortify.rb
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/fortify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Default attributes for your ActiveResource objects
+test_files: 
+- spec/lib_specs/fortify_spec.rb
+- spec/spec_helper.rb