zilkey-active_hash 0.1.0 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+2009-07-23
+  - Added support for auto-defining methods based on hash keys in ActiveHash::Base
+  - Changed the :field and :fields API so that they don't overwrite existing methods (useful when ActiveHash auto-defines methods)
+  - Fixed a bug where ActiveFile incorrectly set the root_path to be the path in the gem directory, not the current working directory
+  

data/README.md

@@ -22,8 +22,8 @@ ActiveHash also ships with:
 To use ActiveHash, you need to:
 
  * Inherit from ActiveHash::Base
- * Define your fields
  * Define your data
+ * (optionally) Define your fields and/or default values
 
 A quick example would be:
 
@@ -35,12 +35,33 @@ A quick example would be:
       ]
     end
 
-## Defining Fields
+## Auto-Defined fields
 
-You can define fields in 2 ways, using the :fields method, or using the :field method, which allows you to specify a default value for the field:
+ActiveHash will auto-define all fields for you when you load the hash.  For example, if you have the following class:
+
+    class CustomField < ActiveYaml::Base
+      self.data = [
+        {:custom_field_1 => "foo"},
+        {:custom_field_2 => "foo"},
+        {:custom_field_3 => "foo"}
+      ]
+    end
+
+Once you call CustomField.all it will define methods for :custom_field_1, :custom_field_2 etc...
+
+If you need the fields at load time, as opposed to after .all is called, you can also define them manually, like so:
+
+    class CustomField < ActiveYaml::Base
+      fields :custom_field_1, :custom_field_2, :custom_field_3
+    end
+
+NOTE: auto-defined fields will _not_ override fields you've defined, either on the class or on the instance.
+
+## Defining Fields with default values
+
+If some of your hash values contain nil, and you want to provide a default, you can specify defaults with the :field method:
 
     class Country < ActiveHash::Base
-      fields  :name, :population
       field   :is_axis_of_evil, :default => false
     end
 
@@ -50,7 +71,6 @@ You can define data inside your class or outside.  For example, you might have a
 
     # app/models/country.rb
     class Country < ActiveHash::Base
-      fields  :name, :population
     end
 
     # config/initializers/data.rb
@@ -102,7 +122,6 @@ ActiveHash also gives you methods related to the fields you defined.  For exampl
 You can create .belongs_to associations from rails objects, like so:
 
     class Country < ActiveHash::Base
-      fields  :name, :population
     end
 
     class Person < ActiveRecord::Base
@@ -118,7 +137,6 @@ You can also use standard rails view helpers, like #collection_select:
 If you want to store your data in YAML files, just inherit from ActiveYaml and specify your path information:
 
     class Country < ActiveYaml::Base
-      field :name
     end
 
 By default, this class will look for a yml file named "countries.yml" in the same directory as the file.  You can either change the directory it looks in, the filename it looks for, or both:
@@ -126,13 +144,14 @@ By default, this class will look for a yml file named "countries.yml" in the sam
     class Country < ActiveYaml::Base
       set_root_path "/u/data"
       set_filename "sample"
-      field :name
     end
 
 The above example will look for the file "/u/data/sample.yml".
 
 ActiveYaml, as well as ActiveFile, check the mtime of the file you specified, and reloads the data if the mtime has changed.  So you can replace the data in the files even if your app is running in production mode in rails.
 
+Since ActiveYaml just creates a hash from the YAML file, you will have all fields specified in YAML auto-defined for you once you call all.
+
 ## ActiveFile
 
 If you store encrypted data, or you'd like to store your flat files as CSV or XML or any other format, you can easily extend ActiveHash to parse and load your file.  Just add a custom ::load_file method, and define the extension you want the file to use:
@@ -140,7 +159,6 @@ If you store encrypted data, or you'd like to store your flat files as CSV or XM
     class Country < ActiveFile::Base
       set_root_path "/u/data"
       set_filename "sample"
-      field :name
 
       class << self
         def extension
@@ -153,7 +171,9 @@ If you store encrypted data, or you'd like to store your flat files as CSV or XM
       end
     end
 
-The two methods you need to implement are load_file, which needs to return a hash, and .extension, which returns the file extension you are using.  You have full_path available to you if you wish, or you can provide your own path.
+The two methods you need to implement are load_file, which needs to return an array of hashes, and .extension, which returns the file extension you are using.  You have full_path available to you if you wish, or you can provide your own path.
+
+NOTE:  By default, .full_path refers to the current working directory.  In a rails app, this will be RAILS_ROOT.
 
 ## Authors
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/active_hash.gemspec

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_hash}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Dean", "Mike Dalessio"]
+  s.date = %q{2009-07-23}
+  s.email = %q{jeff@zilkey.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "active_hash.gemspec",
+     "lib/active_file/base.rb",
+     "lib/active_hash.rb",
+     "lib/active_hash/base.rb",
+     "lib/active_yaml/base.rb",
+     "spec/active_file/base_spec.rb",
+     "spec/active_hash/base_spec.rb",
+     "spec/active_yaml/base_spec.rb",
+     "spec/active_yaml/sample.yml",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/zilkey/active_hash}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{An ActiveRecord-like model that uses a hash as a datasource}
+  s.test_files = [
+    "spec/active_file/base_spec.rb",
+     "spec/active_hash/base_spec.rb",
+     "spec/active_yaml/base_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/lib/active_file/base.rb

@@ -33,8 +33,6 @@ module ActiveFile
         raise "Override Me"
       end
 
-      protected :load_file
-
       def extension
         raise "Override Me"
       end
@@ -42,13 +40,11 @@ module ActiveFile
       protected :extension
 
       def full_path
-        root_path = read_inheritable_attribute(:root_path)  || File.dirname(__FILE__)
+        root_path = read_inheritable_attribute(:root_path)  || Dir.pwd
         filename  = read_inheritable_attribute(:filename)   || name.tableize
         File.join(root_path, "#{filename}.#{extension}")
       end
 
-      private :full_path
-
       def should_reload?
         if (mtime = File.mtime(full_path)) == read_inheritable_attribute(:cached_mtime)
           false

data/lib/active_hash/base.rb

@@ -9,7 +9,12 @@ module ActiveHash
       end
 
       def all
-        @records ||= read_inheritable_attribute(:data).collect {|hash| new(hash)}
+        unless @records
+          records = read_inheritable_attribute(:data)
+          @records = records.collect {|hash| new(hash)}
+          auto_assign_fields( records )
+        end
+        @records
       end
 
       def count
@@ -48,25 +53,33 @@ module ActiveHash
       end
 
       def define_getter_method(field, default_value)
-        define_method field do
-          attributes[field] || default_value
+        unless instance_methods.include?(field.to_s)
+          define_method(field) do
+            attributes[field] || default_value
+          end
         end
       end
 
       private :define_getter_method
 
       def define_interrogator_method(field)
-        define_method "#{field}?" do
-          attributes[field].present?
+        method_name = "#{field}?"
+        unless instance_methods.include?(method_name)
+          define_method(method_name) do
+            attributes[field].present?
+          end
         end
       end
 
       private :define_interrogator_method
 
       def define_custom_find_method(field_name)
-        meta_class.instance_eval do
-          define_method "find_by_#{field_name}" do |name|
-            all.detect {|record| record.send(field_name) == name }
+        method_name = "find_by_#{field_name}"
+        unless singleton_methods.include?(method_name)
+          metaclass.instance_eval do
+            define_method(method_name) do |name|
+              all.detect {|record| record.send(field_name) == name }
+            end
           end
         end
       end
@@ -74,22 +87,35 @@ module ActiveHash
       private :define_custom_find_method
 
       def define_custom_find_all_method(field_name)
-        meta_class.instance_eval do
-          define_method "find_all_by_#{field_name}" do |name|
-            all.select {|record| record.send(field_name) == name }
+        method_name = "find_all_by_#{field_name}"
+        unless singleton_methods.include?(method_name)
+          metaclass.instance_eval do
+            unless singleton_methods.include?(method_name)
+              define_method(method_name) do |name|
+                all.select {|record| record.send(field_name) == name }
+              end
+            end
           end
         end
       end
 
       private :define_custom_find_all_method
 
-      def meta_class
-        class << self
-          self
+      def auto_assign_fields(array_of_hashes)
+        array_of_hashes.inject([]) do |array, row|
+          row.symbolize_keys!
+          row.keys.each do |key|
+            unless key.to_s == "id"
+              array << key
+            end
+          end
+          array
+        end.uniq.each do |key|
+          field key
         end
       end
 
-      private :meta_class
+      private :auto_assign_fields
 
     end
 

data/lib/active_yaml/base.rb

@@ -9,6 +9,7 @@ module ActiveYaml
       def extension
         "yml"
       end
+
     end
   end
 

data/spec/active_file/base_spec.rb

@@ -70,6 +70,16 @@ describe ActiveFile::Base do
     end
   end
 
+  describe ".full_path" do
+    it "defaults to the directory of the calling file" do
+      class FileShouldBeHere < ActiveFile::Base
+        def self.extension() "foo" end
+      end
+
+      FileShouldBeHere.full_path.should == "#{Dir.pwd}/file_should_be_heres.foo"
+    end
+  end
+
   describe ".all" do
     before do
       class MyClass

data/spec/active_hash/base_spec.rb

@@ -1,12 +1,16 @@
 require 'spec/spec_helper'
 
-describe ActiveHash::Base do
+describe ActiveHash, "Base" do
 
   before do
     class Country < ActiveHash::Base
     end
   end
 
+  after do
+    Object.send :remove_const, :Country
+  end
+
   describe ".fields" do
     before do
       Country.fields :name, :iso_name
@@ -411,4 +415,55 @@ describe ActiveHash::Base do
     end
   end
 
+  describe "auto-discovery of fields" do
+    it "dynamically creates fields for all keys in the hash" do
+      Country.data = [
+        {:field1 => "foo"},
+        {:field2 => "bar"},
+        {:field3 => "biz"}
+      ]
+
+      Country.all
+
+      [:field1, :field2, :field3].each do |field|
+        Country.should respond_to("find_by_#{field}")
+        Country.should respond_to("find_all_by_#{field}")
+        Country.new.should respond_to(field)
+        Country.new.should respond_to("#{field}?")
+      end
+    end
+
+    it "doesn't override methods already defined" do
+      Country.class_eval do
+        class << self
+          def find_by_name(name)
+            "find_by_name defined manually"
+          end
+
+          def find_all_by_name(name)
+            "find_all_by_name defined manually"
+          end
+        end
+
+        def name
+          "name defined manually"
+        end
+
+        def name?
+          "name? defined manually"
+        end
+      end
+
+      Country.data = [
+        {:name => "foo"}
+      ]
+
+      Country.all
+      Country.find_by_name("foo").should == "find_by_name defined manually"
+      Country.find_all_by_name("foo").should == "find_all_by_name defined manually"
+      Country.new.name.should == "name defined manually"
+      Country.new.name?.should == "name? defined manually"
+    end
+  end
+
 end

data/spec/active_yaml/base_spec.rb

@@ -16,4 +16,5 @@ describe ActiveYaml::Base do
       records.first.name.should == "US"
     end
   end
+
 end

data/spec/active_yaml/sample.yml

@@ -1,6 +1,15 @@
 - id: 1
   name: US
+  independence_date: 1776-07-04
+  created_at: Wed Jul 22 22:41:44 -0400 2009
+  custom_field_1: value1
 - id: 2
   name: Canada
+  independence_date: 1867-07-01
+  created_at: Wed Jul 22 22:41:44 -0400 2009
+  custom_field_2: value2
 - id: 3
   name: Mexico
+  independence_date: 1810-09-16
+  created_at: Wed Jul 22 22:41:44 -0400 2009
+  custom_field_3: value3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zilkey-active_hash
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeff Dean
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-22 00:00:00 -07:00
+date: 2009-07-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,10 +35,12 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
+- active_hash.gemspec
 - lib/active_file/base.rb
 - lib/active_hash.rb
 - lib/active_hash/base.rb