zilkey-active_hash 0.2.0 → 0.3.0

data/CHANGELOG

@@ -2,4 +2,7 @@
   - 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
-  
+
+2009-07-24
+  - ActiveFile no longer reloads files by default
+  - Added ActiveFile.reload_active_file= so you can cause ActiveFile to reload

data/README.md

@@ -28,13 +28,16 @@ To use ActiveHash, you need to:
 A quick example would be:
 
     class Country < ActiveHash::Base
-      field :name
       self.data = [
         {:id => 1, :name => "US"},
         {:id => 2, :name => "Canada"}
       ]
     end
 
+    country = Country.new(:name => "Mexico")
+    country.name  # => "Mexico"
+    country.name? # => true
+
 ## Auto-Defined fields
 
 ActiveHash will auto-define all fields for you when you load the hash.  For example, if you have the following class:
@@ -173,11 +176,22 @@ If you store encrypted data, or you'd like to store your flat files as CSV or XM
 
 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.
 
+Setting the default file location in Rails:
+
+    # config/initializers/active_file.rb
+    ActiveFile.set_root_path "config/activefiles"
+
+By default, ActiveFile will not reload data from the file when it changes.  You can enable this by setting:
+
+    ActiveFile.reload_active_file = true
+
+In Rails, in development mode, it reloads the entire class, which reloads the file, so you don't need to turn this on in development.
+
 NOTE:  By default, .full_path refers to the current working directory.  In a rails app, this will be RAILS_ROOT.
 
 ## Authors
 
-Written by Mike Dalessio and Jeff Dean
+Written by Jeff Dean, Mike Dalessio and Ben Woosley 
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/active_hash.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_hash}
-  s.version = "0.2.0"
+  s.version = "0.3.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.date = %q{2009-07-24}
   s.email = %q{jeff@zilkey.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.4}
   s.summary = %q{An ActiveRecord-like model that uses a hash as a datasource}
   s.test_files = [
     "spec/active_file/base_spec.rb",

data/lib/active_file/base.rb

@@ -1,7 +1,7 @@
 module ActiveFile
 
   class Base < ActiveHash::Base
-    class_inheritable_accessor :filename, :root_path, :cached_mtime
+    class_inheritable_accessor :filename, :root_path, :cached_mtime, :reload_active_file
 
     class << self
       def all
@@ -21,24 +21,14 @@ module ActiveFile
         write_inheritable_attribute :filename, name
       end
 
-      protected :set_filename
-
       def set_root_path(path)
         write_inheritable_attribute :root_path, path
       end
 
-      protected :set_root_path
-
       def load_file
         raise "Override Me"
       end
 
-      def extension
-        raise "Override Me"
-      end
-
-      protected :extension
-
       def full_path
         root_path = read_inheritable_attribute(:root_path)  || Dir.pwd
         filename  = read_inheritable_attribute(:filename)   || name.tableize
@@ -46,16 +36,21 @@ module ActiveFile
       end
 
       def should_reload?
-        if (mtime = File.mtime(full_path)) == read_inheritable_attribute(:cached_mtime)
-          false
-        else
-          write_inheritable_attribute :cached_mtime, mtime
-          true
-        end
+        return false if read_inheritable_attribute(:data) && ! read_inheritable_attribute(:reload_active_file)
+        return false if (mtime = File.mtime(full_path)) == read_inheritable_attribute(:cached_mtime)
+
+        write_inheritable_attribute :cached_mtime, mtime
+        true
       end
 
       private :should_reload?
 
+      def extension
+        raise "Override Me"
+      end
+
+      protected :extension
+
     end
   end
 

data/spec/active_file/base_spec.rb

@@ -1,12 +1,26 @@
 require 'spec/spec_helper'
 
 describe ActiveFile::Base do
+  before do
+    class Country < ActiveFile::Base
+    end
+  end
+
+  after do
+    Object.send :remove_const, :Country
+  end
+
+  describe ".reload_active_file" do
+
+    it "returns false by default" do
+      Country.reload_active_file.should be_nil
+    end
+
+  end
 
   describe ".filename=" do
     before do
-      class Foo < ActiveFile::Base
-        self.filename = "foo-izzle"
-      end
+      Country.filename = "foo-izzle"
 
       class Bar < ActiveFile::Base
         self.filename = "bar-izzle"
@@ -14,16 +28,14 @@ describe ActiveFile::Base do
     end
 
     it "sets the filename on a per-subclass basis" do
-      Foo.filename.should == "foo-izzle"
+      Country.filename.should == "foo-izzle"
       Bar.filename.should == "bar-izzle"
     end
   end
 
   describe ".set_filename" do
     before do
-      class Foo < ActiveFile::Base
-        set_filename "foo-izzle"
-      end
+      Country.set_filename "foo-izzle"
 
       class Bar < ActiveFile::Base
         set_filename "bar-izzle"
@@ -31,16 +43,14 @@ describe ActiveFile::Base do
     end
 
     it "sets the filename on a per-subclass basis" do
-      Foo.filename.should == "foo-izzle"
+      Country.filename.should == "foo-izzle"
       Bar.filename.should == "bar-izzle"
     end
   end
 
   describe ".root_path=" do
     before do
-      class Foo < ActiveFile::Base
-        self.root_path = "foo-izzle"
-      end
+      Country.root_path = "foo-izzle"
 
       class Bar < ActiveFile::Base
         self.root_path = "bar-izzle"
@@ -48,16 +58,14 @@ describe ActiveFile::Base do
     end
 
     it "sets the root_path on a per-subclass basis" do
-      Foo.root_path.should == "foo-izzle"
+      Country.root_path.should == "foo-izzle"
       Bar.root_path.should == "bar-izzle"
     end
   end
 
   describe ".set_root_path" do
     before do
-      class Foo < ActiveFile::Base
-        set_root_path "foo-izzle"
-      end
+      Country.set_root_path "foo-izzle"
 
       class Bar < ActiveFile::Base
         set_root_path "bar-izzle"
@@ -65,18 +73,18 @@ describe ActiveFile::Base do
     end
 
     it "sets the root_path on a per-subclass basis" do
-      Foo.root_path.should == "foo-izzle"
+      Country.root_path.should == "foo-izzle"
       Bar.root_path.should == "bar-izzle"
     end
   end
 
   describe ".full_path" do
     it "defaults to the directory of the calling file" do
-      class FileShouldBeHere < ActiveFile::Base
+      class Country
         def self.extension() "foo" end
       end
 
-      FileShouldBeHere.full_path.should == "#{Dir.pwd}/file_should_be_heres.foo"
+      Country.full_path.should == "#{Dir.pwd}/countries.foo"
     end
   end
 
@@ -87,7 +95,7 @@ describe ActiveFile::Base do
     end
 
     it "loads the data from the load_file method" do
-      class Foo01 < ActiveFile::Base
+      class Country
         class << self
           def extension
             "myfile"
@@ -99,53 +107,120 @@ describe ActiveFile::Base do
         end
       end
 
+      Country.reload_active_file = true
       File.stub!(:mtime).and_return(1234)
       MyClass.should_receive(:load_file).and_return([{:id => 1}, {:id => 2}, {:id => 3}])
 
-      records = Foo01.all
+      records = Country.all
       records.length.should == 3
-      records.should =~ [Foo01.new(:id => 1), Foo01.new(:id => 2), Foo01.new(:id => 3)]
+      records.should =~ [Country.new(:id => 1), Country.new(:id => 2), Country.new(:id => 3)]
     end
 
-    it "does not re-fetch the data if the file's mtime has not changed" do
-      class SomeSampleClass < ActiveFile::Base
-        class << self
-          def extension
-            "myfile"
+    context "with reload=true" do
+      it "does not re-fetch the data if the file's mtime has not changed" do
+        class Country < ActiveFile::Base
+          class << self
+            def extension
+              "myfile"
+            end
+
+            def load_file
+              MyClass.load_file(full_path)
+            end
           end
+        end
 
-          def load_file
-            MyClass.load_file(full_path)
+        Country.reload_active_file = true
+        File.stub!(:mtime).and_return(1234)
+        MyClass.should_receive(:load_file).once.and_return([{:foo => :bar}])
+        Country.all
+        Country.all
+      end
+
+      it "does re-fetch the data if the yaml file's mtime has changed" do
+        class Country < ActiveFile::Base
+          class << self
+            def extension
+              "myfile"
+            end
+
+            def load_file
+              MyClass.load_file(full_path)
+            end
           end
         end
-      end
 
-      File.stub!(:mtime).and_return(1234)
-      MyClass.should_receive(:load_file).once.and_return([{:foo => :bar}])
-      SomeSampleClass.all
-      SomeSampleClass.all
+        Country.reload_active_file = true
+        MyClass.should_receive(:load_file).twice.and_return([{:foo => :bar}])
+
+        File.stub!(:mtime).and_return(1234)
+        Country.all
+
+        File.stub!(:mtime).and_return(3456)
+        Country.all
+      end
     end
 
-    it "does re-fetch the data if the yaml file's mtime has changed" do
-      class SomeSampleClass2 < ActiveFile::Base
-        class << self
-          def extension
-            "myfile"
+    context "with reload=false" do
+      it "does not re-fetch the data after the first call to .all" do
+        class Country < ActiveFile::Base
+          class << self
+            def extension
+              "myfile"
+            end
+
+            def load_file
+              MyClass.load_file(full_path)
+            end
           end
+        end
 
-          def load_file
-            MyClass.load_file(full_path)
+        File.stub!(:mtime).once.and_return(1234)
+        MyClass.should_receive(:load_file).once.and_return([{:foo => :bar}])
+        Country.all
+
+        Country.all
+      end
+
+      it "does not re-fetch the data if the yaml file's mtime has changed" do
+        class Country < ActiveFile::Base
+          class << self
+            def extension
+              "myfile"
+            end
+
+            def load_file
+              MyClass.load_file(full_path)
+            end
           end
         end
+
+        MyClass.should_receive(:load_file).once.and_return([{:foo => :bar}])
+
+        File.stub!(:mtime).and_return(1234)
+        Country.all
+
+        File.stub!(:mtime).and_return(3456)
+        Country.all
       end
 
-      MyClass.should_receive(:load_file).twice.and_return([{:foo => :bar}])
+      it "does not fetch data if data has been set" do
+        class Country < ActiveFile::Base
+          class << self
+            def extension
+              "myfile"
+            end
 
-      File.stub!(:mtime).and_return(1234)
-      SomeSampleClass2.all
+            def load_file
+              MyClass.load_file(full_path)
+            end
+          end
+        end
 
-      File.stub!(:mtime).and_return(3456)
-      SomeSampleClass2.all
+        MyClass.should_not_receive(:load_file)
+        Country.data = [{:foo => :bar}]
+        Country.all
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zilkey-active_hash
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jeff Dean
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 -07:00
+date: 2009-07-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency