active_hash 0.7.5 → 0.7.6

data/CHANGELOG

@@ -1,3 +1,11 @@
+2009-12-19
+  - Added ActiveHash::Enum (John Pignata)
+
+2009-12-10
+  - Fixed a bug where belongs_to associations would raise an error instead of returning
+    nil when the parent object didn't exist.
+  - Added #[] and #[]= accessors for more ActiveRecord-esque-ness. (Pat Nakajima & Dave Yeu)
+
 2009-12-01
   - Add marked_for_destruction? to be compatible with nested attributes (Brandon Keene)
   - Added second parameter to respond_to? and cleaned up specs (Brian Takita)

data/README.md

@@ -282,10 +282,48 @@ In Rails, in development mode, it reloads the entire class, which reloads the fi
 
 NOTE:  By default, .full_path refers to the current working directory.  In a rails app, this will be RAILS_ROOT.
 
-## Authors
+## Enum
+
+ActiveHash can expose its data in an Enumeration by setting constants for each record. This allows records to be accessed in code through a constant set in the ActiveHash class.
 
-Written by Jeff Dean, Mike Dalessio and Ben Woosley
+The field to be used as the constant is set using _enum_accessor_ which takes the name of a field as an argument.
+
+    class Country < ActiveHash::Base
+      extend ActiveHash::Enum
+      self.data = [
+          {:id => 1, :name => "US", :capital => "Washington, DC"},
+          {:id => 2, :name => "Canada", :capital => "Ottawa"},
+          {:id => 3, :name => "Mexico", :capital => "Mexico City"}
+      ]
+      enum_accessor :name
+    end
+
+Records can be accessed by looking up the field constant:
+
+    >> Country::US.capital
+    => "Washington DC"
+    >> Country::MEXICO.id
+    => 3
+    >> Country::CANADA
+    => #<Country:0x10229fb28 @attributes={:name=>"Canada", :id=>2}
+    
+Constants are formed by first stripping all non-word characters and then upcasing the result. This means strings like "Blazing Saddles", "ReBar", "Mike & Ike" and "Ho! Ho! Ho!" become BLAZINGSADDLES, REBAR, MIKEIKE and HOHOHO.
+
+The field specified as the _enum_accessor_ must contain unique data values.
+
+## Authors
 
-== Copyright
+ * Jeff Dean
+ * Mike Dalessio
+ * Ben Woosley
+ * John Pignata
+ * Pat Nakajima
+ * Brandon Keene
+ * Dave Yeu
+ * Brian Takita
+ * Corey Innis
+ * Peter Jaros
+
+## Copyright
 
 Copyright (c) 2009 Jeff Dean. See LICENSE for details.

data/Rakefile

@@ -8,7 +8,7 @@ begin
     gem.summary = %Q{An ActiveRecord-like model that uses a hash or file as a datasource}
     gem.email = "jeff@zilkey.com"
     gem.homepage = "http://github.com/zilkey/active_hash"
-    gem.authors = ["Jeff Dean", "Mike Dalessio", "Corey Innis", "Peter Jaros", "Brandon Keene", "Brian Takita", "Pat Nakajima"]
+    gem.authors = ["Jeff Dean", "Mike Dalessio", "Corey Innis", "Peter Jaros", "Brandon Keene", "Brian Takita", "Pat Nakajima", "John Pignata"]
     gem.add_dependency('activesupport', [">= 2.2.2"])
   end
 

data/VERSION

@@ -1 +1 @@
-0.7.5
+0.7.6

data/active_hash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_hash}
-  s.version = "0.7.5"
+  s.version = "0.7.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jeff Dean", "Mike Dalessio", "Corey Innis", "Peter Jaros", "Brandon Keene", "Brian Takita", "Pat Nakajima"]
-  s.date = %q{2009-12-01}
+  s.authors = ["Jeff Dean", "Mike Dalessio", "Corey Innis", "Peter Jaros", "Brandon Keene", "Brian Takita", "Pat Nakajima", "John Pignata"]
+  s.date = %q{2009-12-19}
   s.email = %q{jeff@zilkey.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -30,11 +30,14 @@ Gem::Specification.new do |s|
      "lib/active_hash/base.rb",
      "lib/active_yaml/base.rb",
      "lib/associations/associations.rb",
+     "lib/enum/enum.rb",
      "spec/active_file/base_spec.rb",
      "spec/active_hash/base_spec.rb",
      "spec/active_yaml/base_spec.rb",
      "spec/associations/associations_spec.rb",
+     "spec/enum/enum_spec.rb",
      "spec/fixtures/array_rows.yml",
+     "spec/fixtures/boroughs.yml",
      "spec/fixtures/cities.yml",
      "spec/fixtures/countries.yml",
      "spec/fixtures/states.yml",
@@ -50,6 +53,7 @@ Gem::Specification.new do |s|
      "spec/active_hash/base_spec.rb",
      "spec/active_yaml/base_spec.rb",
      "spec/associations/associations_spec.rb",
+     "spec/enum/enum_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/active_hash.rb

@@ -1,5 +1,6 @@
-require 'activesupport'
+require 'active_support'
 require 'active_hash/base'
 require 'active_file/base'
 require 'active_yaml/base'
 require 'associations/associations'
+require 'enum/enum'

data/lib/active_hash/base.rb

@@ -211,7 +211,13 @@ module ActiveHash
       def base_class
         ActiveHash::Base
       end
-
+      
+      def reload
+        self.data = read_inheritable_attribute(:data)
+      end
+      
+      private :reload
+      
     end
 
     attr_reader :attributes
@@ -224,6 +230,14 @@ module ActiveHash
       end
     end
 
+    def [](key)
+      attributes[key]
+    end
+
+    def []=(key, val)
+      attributes[key] = val
+    end
+
     def id
       attributes[:id] ? attributes[:id] : nil
     end

data/lib/associations/associations.rb

@@ -27,7 +27,7 @@ module ActiveHash
         }.merge(options)
 
         define_method(association_id) do
-          options[:class_name].constantize.find(send(options[:foreign_key]))
+          options[:class_name].constantize.find_by_id(send(options[:foreign_key]))
         end
 
         define_method("#{association_id}=") do |new_value|

data/lib/enum/enum.rb

@@ -0,0 +1,44 @@
+module ActiveHash
+  module Enum
+
+    DuplicateConstant = Class.new(RuntimeError)
+
+    def enum_accessor(field_name)
+      @enum_accessor = field_name
+      reload
+    end
+
+    def insert(record)
+      super
+      set_constant(record) if enum_accessor?
+    end
+
+    private :insert
+
+    def set_constant(record)
+      if constant = constant_for(record.attributes[@enum_accessor])
+        self.const_set(constant, record)
+      end
+    end
+
+    private :set_constant
+
+    def enum_accessor?
+      !@enum_accessor.nil?
+    end
+
+    private :enum_accessor?
+
+    def constant_for(field_value)
+      if constant = field_value.dup
+        constant.gsub!(/[^A-Za-z]*/, "") 
+        constant.upcase!
+        raise DuplicateConstant, "#{constant} is already defined on #{self.class.name}" if const_defined?(constant)            
+        constant
+      end
+    end
+
+    private :constant_for
+  end
+
+end

data/spec/active_hash/base_spec.rb

@@ -346,6 +346,19 @@ describe ActiveHash, "Base" do
       country = Country.new("foo" => :bar)
       country.attributes.should == {:foo => :bar}
     end
+
+    it "is works with #[]" do
+      Country.field :foo
+      country = Country.new(:foo => :bar)
+      country[:foo].should == :bar
+    end
+
+    it "is works with #[]=" do
+      Country.field :foo
+      country = Country.new
+      country[:foo] = :bar
+      country.foo.should == :bar
+    end
   end
 
   describe "reader methods" do

data/spec/associations/associations_spec.rb

@@ -74,6 +74,12 @@ describe ActiveHash::Base, "associations" do
         city = City.create :country_id => country.id
         city.country.should == country
       end
+
+      it "returns nil when the record does not exist" do
+        City.belongs_to :country
+        city = City.create :country_id => 123
+        city.country.should be_nil
+      end
     end
 
     context "with an ActiveHash parent" do
@@ -83,6 +89,12 @@ describe ActiveHash::Base, "associations" do
         author = Author.create :city_id => city.id
         author.city.should == city
       end
+
+      it "returns nil when the record does not exist" do
+        Author.belongs_to :city
+        author = Author.create :city_id => 123
+        author.city.should be_nil
+      end
     end
 
     describe "#parent=" do

data/spec/enum/enum_spec.rb

@@ -0,0 +1,55 @@
+require 'spec/spec_helper'
+
+describe ActiveHash::Base, "enum" do
+
+  before do
+    ActiveYaml::Base.set_root_path File.expand_path(File.dirname(__FILE__) + "/../fixtures")
+    
+    class Borough < ActiveYaml::Base
+      extend ActiveHash::Enum
+      fields :name, :county, :population
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :Borough)
+  end
+
+  describe "#enum_accessor" do
+    it "sets the field used for accessing records by constants" do
+      Borough.enum_accessor :name
+      Borough::BROOKLYN.should == Borough.find_by_name("Brooklyn")
+    end
+    
+    it "ensures that values stored in the field specified are unique" do
+      lambda do
+        Class.new(ActiveHash::Base) do
+          extend ActiveHash::Enum
+          self.data = [
+            { :name => 'Woodford Reserve' },
+            { :name => 'Bulliet Bourbon' },
+            { :name => 'Woodford Reserve' }
+          ]
+          enum_accessor :name 
+        end
+      end.should raise_error(ActiveHash::Enum::DuplicateConstant)
+    end
+
+    it "removes non-word characters from values before setting constants" do
+      Movie = Class.new(ActiveHash::Base) do
+        extend ActiveHash::Enum
+        self.data = [
+          {:name => 'Die Hard 2', :rating => '4.3'},
+          {:name => 'The Informant!', :rating => '4.3'},
+          {:name => 'In & Out', :rating => '4.3'}          
+        ]
+        enum_accessor :name
+      end
+      
+      Movie::DIEHARD.name.should == 'Die Hard 2'
+      Movie::THEINFORMANT.name.should == 'The Informant!'
+      Movie::INOUT.name.should == 'In & Out'
+    end
+  end
+
+end

data/spec/fixtures/boroughs.yml

@@ -0,0 +1,20 @@
+- id: 1
+  name: Manhattan
+  county: New York
+  population: 1634795
+- id: 2
+  name: Brooklyn
+  county: Kings
+  population: 2556598
+- id: 3
+  name: Queens
+  county: Queens
+  population: 2293007
+- id: 4
+  name: Bronx
+  county: Bronx
+  population: 1391903
+- id: 5
+  name: Staten Island
+  county: Richmond
+  population: 487407

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_hash
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Jeff Dean
@@ -11,11 +11,12 @@ authors:
 - Brandon Keene
 - Brian Takita
 - Pat Nakajima
+- John Pignata
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 -05:00
+date: 2009-12-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,11 +53,14 @@ files:
 - lib/active_hash/base.rb
 - lib/active_yaml/base.rb
 - lib/associations/associations.rb
+- lib/enum/enum.rb
 - spec/active_file/base_spec.rb
 - spec/active_hash/base_spec.rb
 - spec/active_yaml/base_spec.rb
 - spec/associations/associations_spec.rb
+- spec/enum/enum_spec.rb
 - spec/fixtures/array_rows.yml
+- spec/fixtures/boroughs.yml
 - spec/fixtures/cities.yml
 - spec/fixtures/countries.yml
 - spec/fixtures/states.yml
@@ -94,4 +98,5 @@ test_files:
 - spec/active_hash/base_spec.rb
 - spec/active_yaml/base_spec.rb
 - spec/associations/associations_spec.rb
+- spec/enum/enum_spec.rb
 - spec/spec_helper.rb