midas-has_associative_facades 1.0.2

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0 2009-06-25
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+has_associative_facades.gemspec
+lib/has_associative_facades.rb
+lib/has_associative_facades/acts_methods.rb
+lib/has_associative_facades/instance_methods.rb
+script/console
+script/destroy
+script/generate
+spec/has_associative_facades_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on has_associative_facades, see http://has_associative_facades.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,110 @@
+= has_associative_facades
+
+http://github.com/midas/has_associative_facades/tree/master
+
+
+== DESCRIPTION:
+
+A Rails gem that creates getters and setters for associated object's attributes to aid in not breaking Demeter's Law.
+
+== WHY
+
+From http://en.wikipedia.org/wiki/Law_of_Demeter, the "Law of Demeter for Functions/Methods” (LoD-F) states:
+
+An object A can request a service (call a method) of an object instance B, but object A cannot “reach through” object 
+B to access yet another object, C, to request its services.  Doing so would mean that object A implicitly requires greater 
+knowledge of object B’s internal structure. Instead, B’s class should be modified if necessary so that object A can simply 
+make the request directly of object B, and then let object B propagate the request to any relevant subcomponents. Or A should 
+have a direct reference to object C and make the call directly. If the law is followed, only object B knows its own internal 
+structure.
+
+In particular, an object should avoid invoking methods of a member object returned by another method. For many modern object 
+oriented languages that use a dot as field identifier, the law can be stated simply as "use only one dot". That is, the code 
+"a.b.Method()" breaks the law where "a.Method()" does not.
+
+As a simple example, when one wants to walk a dog, it would be folly to command the dog’s legs to walk directly; instead one 
+commands the dog and lets it take care of its legs itself
+
+The advantage of following the Law of Demeter is that the resulting software tends to be more maintainable and adaptable. Since 
+objects are less dependent on the internal structure of other objects, object containers can be changed without reworking their 
+callers.
+
+A disadvantage of the Law of Demeter is that it sometimes requires writing a large number of small “wrapper” methods (sometimes 
+referred to as Demeter Transmogrifiers) to propagate method calls to the components. Furthermore, a class’s interface can become 
+bulky as it hosts methods for contained classes resulting in a class without a cohesive interface.
+
+This is where has_associative_facades steps in.  Instead of writing this large number of wrapper methods, you can just call the 
+methods and they will be defined on an as needed basis, remaining in memory until the object is destroyed.  So now you can avoid
+coupling your objects together without the extra work.  Only the interface to your object need remain the same.  You can change 
+the internal implementation of methods to your heart;s content without breaking your project.
+
+
+== FEATURES:
+
+* Automatically creates facade getter methods for has one and belongs to associations.
+
+
+== TO IMPLEMENT:
+
+* Automatically creates facade setter methods for has one and belongs to associations.
+* Possibly provide a static way to define through macro type singleton methods (like attr_accessor, attr_reader, etc).
+
+
+== USAGE:
+
+For:
+  
+  class Account < ActiveRecord::Base
+    # has name attribute
+  end
+
+  class User
+    has_associative_facades
+    
+    belongs_to :account
+  end
+
+You can now:
+
+  user = User.first # or User.new, User.find, etc
+  user.account_name # is the same as user.account.name
+
+
+== REQUIREMENTS:
+
+* Rails (ActiveRecord)
+
+
+== INSTALL:
+
+  sudo gem install midas-has_associative_facades
+
+In your Rails environment file:
+
+  config.gem 'midas-has_associative_facades', :version => '1.0.0', :lib => 'has_associative_facades', :source => 'http://gems.github.com'
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/has_associative_facades'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('has_associative_facades', HasAssociativeFacades::VERSION) do |p|
+  p.developer('C. Jason Harrelson', 'jason@lookforwardwnterprises.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/has_associative_facades.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_associative_facades}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["C. Jason Harrelson"]
+  s.date = %q{2009-06-28}
+  s.description = %q{A Rails gem that creates getters and setters for associated object's attributes to aid in not breaking Demeter's Law.}
+  s.email = ["jason@lookforwardwnterprises.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "has_associative_facades.gemspec", "lib/has_associative_facades.rb", "lib/has_associative_facades/acts_methods.rb", "lib/has_associative_facades/instance_methods.rb", "script/console", "script/destroy", "script/generate", "spec/has_associative_facades_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/midas/has_associative_facades/tree/master}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{has_associative_facades}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A Rails gem that creates getters and setters for associated object's attributes to aid in not breaking Demeter's Law.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/has_associative_facades.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'has_associative_facades/acts_methods'
+require 'has_associative_facades/instance_methods'
+
+module HasAssociativeFacades
+  VERSION = '1.0.2'
+  
+  def self.included( base ) 
+    base.extend ActsMethods 
+  end
+end
+
+ActiveRecord::Base.send( :include, HasAssociativeFacades ) if defined?( ActiveRecord::Base )

data/lib/has_associative_facades/acts_methods.rb

@@ -0,0 +1,13 @@
+module HasAssociativeFacades
+  module ActsMethods
+    
+    # Use this method to declare the associated facade behavior on your ActiveRecord class.
+    #
+    def has_associative_facades 
+      unless included_modules.include? InstanceMethods
+        include InstanceMethods
+      end
+    end
+    
+  end
+end

data/lib/has_associative_facades/instance_methods.rb

@@ -0,0 +1,52 @@
+module HasAssociativeFacades
+  module InstanceMethods
+    
+    # When the method being called is the case of "#{association_name}_#{attribute_or_method}" a getter method 
+    # will be defined and called returning its value.  This works for an ActiveRecord object created through the
+    # new operator having all attributes set to nil or an find of some sort having all attributes populated.
+    #
+    # If the associated object is nil but has an attribute or method with the given name a nil is reurned.  Otherwise,
+    # the NoMethodError is thrown.
+    #
+    def method_missing( method, *args )
+      method_name = method.to_s
+      super( method, *args ) # allow super to win if it has the method
+    rescue NoMethodError => ex
+      association = nil
+      association_reflection = nil
+      associateds = self.class.inheritable_attributes[:reflections]
+      associateds.each do |associated|
+        if /#{associated[0]}_/.match( method_name )
+          association_reflection = associated
+          association = associated[0]
+          break
+        end
+      end
+
+      if match = /#{association}_([_a-zA-Z]\w*)/.match( method_name )
+        throw ex if match.captures.empty? || match.captures.size > 2
+        attribute = match.captures[0].to_sym
+
+        assoc_klass = nil
+        begin
+          assoc_klass = association.to_s.classify.constantize
+        rescue
+          assoc_klass = association_reflection[1].options[:class_name].constantize
+        end
+        throw ex unless assoc_klass.columns_hash.has_key?( attribute.to_s ) || assoc_klass.public_instance_methods.include?( attribute.to_s )
+
+        self.class.class_eval <<-END
+        def #{method_name}
+          return self.send( :#{association} ).send( :#{attribute} ) unless self.send( :#{association} ).nil?
+          nil
+        end
+        END
+
+        return self.send( method_name )
+      end
+
+      throw ex
+    end
+    
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/has_associative_facades.rb'}"
+puts "Loading has_associative_facades gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/has_associative_facades_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'has_associative_facades'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: midas-has_associative_facades
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A Rails gem that creates getters and setters for associated object's attributes to aid in not breaking Demeter's Law.
+email: 
+- jason@lookforwardwnterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- has_associative_facades.gemspec
+- lib/has_associative_facades.rb
+- lib/has_associative_facades/acts_methods.rb
+- lib/has_associative_facades/instance_methods.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/has_associative_facades_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/midas/has_associative_facades/tree/master
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: has_associative_facades
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails gem that creates getters and setters for associated object's attributes to aid in not breaking Demeter's Law.
+test_files: []
+