auto_demeter 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,16 @@
 # AutoDemeter
 
-TODO: Write a gem description
+AutoDemeter is an automated delegator to associations. The name comes from the rule of demeter is a mechanism to try to
+prevent the bad things that happen when that rule is violated.
+
+It's a little like the new &. (praying dot), but also works with older versions
+of Ruby.
+
+It was created after spending hours refactoring lots of ancient code that reached through models and associations with little
+regard for the fact that there could be a nil somewhere which would make the whole thing blow up and the fact that I hated
+the alternative of checking nil manually at every point whilst on the route to refactoring properly.
+
+
 
 ## Installation
 
@@ -18,7 +28,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can replace things like:
+
+    @object.user.manager.name
+
+with
+
+    @object.user_manager_name
+
+and rather than blowing up when user or manager return nil, the method itself will return nil.
+
+It also let's you do things like:
+
+    @object.users.map(&:manager_name)
+
+without having to define manager_name on the association.
 
 ## Contributing
 
@@ -27,3 +51,9 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Todo
+
+1. Tests
+2. More tests around the is and is_not mechanism
+3. Potentially deprecate the is and is_not mechanism which should really be handled in a different gem.

data/auto_demeter.gemspec

@@ -18,6 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'sqlite3'
+
+  if RUBY_VERSION >= '1.9'
+    spec.add_development_dependency 'bundler'
+    spec.add_development_dependency 'rake'
+    spec.add_development_dependency 'active_record'
+    spec.add_development_dependency 'simplecov'
+  else
+    spec.add_development_dependency 'bundler', '~> 1.3'
+    spec.add_development_dependency 'rake', '~>0.9.2'
+    spec.add_development_dependency 'activerecord'
+    spec.add_development_dependency 'rcov'
+  end
 end

data/lib/auto_demeter.rb

@@ -1,14 +1,5 @@
-require "auto_demeter/version"
-require 'auto_demeter/methods'
-
-class ActiveRecord::Base
-  include AutoDemeter
-end
-
-class ActiveRecord::Associations::BelongsToAssociation
-  include AutoDemeter
-end
-
-class ActiveRecord::Associations::HasOneAssociation
-  include AutoDemeter
-end
+require (File.join(File.dirname(__FILE__), 'auto_demeter', 'version'))
+require (File.join(File.dirname(__FILE__), 'auto_demeter', 'methods'))
+ActiveRecord::Base.send :include, AutoDemeter
+ActiveRecord::Associations::BelongsToAssociation.send :include, AutoDemeter
+ActiveRecord::Associations::HasOneAssociation.send :include, AutoDemeter

data/lib/auto_demeter/methods.rb

@@ -1,9 +1,13 @@
 module AutoDemeter
+  private
+  def base_names
+    @base_names||=self.class.reflect_on_all_associations.find_all { |x| [:has_one, :belongs_to].include?(x.send(:macro)) }.map { |x| x.send(:name).to_s }
+  end
+
   def children_names
-    base_names=self.class.reflect_on_all_associations.find_all { |x| [:has_one, :belongs_to].include?(x.instance_variable_get("@macro")) }.map { |x| x.instance_variable_get("@name").to_s }
     class_name=base_names.map { |x| x.gsub(/^#{self.class.name.underscore}_/, '') }
     class_name=class_name | base_names.map { |x| x.gsub(/^#{self.base_name.underscore}_/, '') } if self.respond_to?(:base_name) && self.class.name!=self.base_name
-    base_names | class_name
+    @children_names||=base_names | class_name
   end
 
   def reflected_children_regex
@@ -11,19 +15,19 @@ module AutoDemeter
   end
 
   def respond_through_association?(method_id)
-    return false unless children_names
-    if (match_data=method_id.to_s.match(reflected_children_regex)) && match_data[1].present?
+    if children_names && (match_data=method_id.to_s.match(reflected_children_regex)) && match_data[1].present?
       association_name=self.methods.include?(match_data[1]) ? match_data[1] : "#{self.class.name.underscore}_#{match_data[1]}"
-      if send(association_name)
-        true
-      else
-        match_data[2][0..2] == 'is_' ? true : false
-      end
+      send(association_name) ? true : match_data[2][0..2] == 'is_'
     else
       false
     end
   end
 
+  public
+  def respond_to?(method_id)
+    super || (method_id != :base_name && respond_through_association?(method_id))
+  end
+
   def method_missing(method_id, *args, &block)
     begin
       super

data/lib/auto_demeter/version.rb

@@ -1,3 +1,3 @@
 module AutoDemeter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/auto_demeter_test.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+if RUBY_VERSION >= '1.9'
+  require 'minitest/autorun'
+  require 'active_record'
+else
+  require 'test/unit'
+  require 'activerecord'
+end
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require File.dirname(__FILE__) + '/../lib/auto_demeter'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Base.logger
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.references :manager
+      t.string :name
+    end
+    create_table :addresses do |t|
+      t.references :user
+      t.string :postcode
+    end
+    create_table :managers do |t|
+      t.string :name
+    end
+  end
+end
+
+class Manager < ActiveRecord::Base
+  has_many :users
+end
+
+class User < ActiveRecord::Base
+  belongs_to :manager
+  has_one :address
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :user
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class AutoDemeterTest < (
+begin
+  MiniTest::Test rescue Test::Unit::TestCase
+end)
+
+  def setup
+    setup_db
+    @paul=Manager.create(:name => 'paul')
+    User.create(:name => 'ophelia')
+    User.create(:name => 'nigel')
+    @michael=User.create(:name => 'michael', :manager => @paul)
+    @luke=User.create(:name => 'luke', :manager => @paul)
+    @michael_address=Address.create(:postcode => 'n111n', :user => @michael)
+    @luke_address=Address.create(:postcode => 'bt401uu', :user => @luke)
+    Address.create(:postcode => 'gu261aa')
+  end
+
+  def test_happy_path
+    assert @luke.respond_to?(:address_postcode)
+    assert @luke_address.respond_to?(:user_manager_name)
+    assert_equal @luke.address_postcode, @luke_address.postcode
+    assert_equal [@michael_address.postcode, @luke_address.postcode], @paul.users.map(&:address_postcode)
+    assert_equal @luke.name, @luke_address.user_name
+    assert_equal @paul.name, @luke_address.user_manager_name
+    assert_equal @paul.name, @luke_address.user_manager.name
+    assert_equal @paul.name, @luke_address.user.manager_name
+  end
+end

metadata

@@ -1,56 +1,105 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: auto_demeter
-version: !ruby/object:Gem::Version
-  version: 0.0.2
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Paul McKibbin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2016-03-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Create automated methods for all children or parents to allow a request
-  to be handled more easily than defining a long chain
-email:
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Create automated methods for all children or parents to allow a request to be handled more easily than defining a long chain
+email: 
 - pmckibbin@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -60,29 +109,39 @@ files:
 - lib/auto_demeter.rb
 - lib/auto_demeter/methods.rb
 - lib/auto_demeter/version.rb
-homepage: ''
-licenses:
+- test/auto_demeter_test.rb
+homepage: ""
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Automated demeter methods
-test_files: []
+test_files: 
+- test/auto_demeter_test.rb