honkster-active_hash 0.7.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.idea
+junk.*

data/CHANGELOG

@@ -0,0 +1,40 @@
+2009-10-22
+  - added setters to ActiveHash::Base for all fields
+  - instantiating an ActiveHash object with a hash calls the setter methods on the object
+  - boolean default values now work
+
+2009-10-21
+  - Removed auto-reloading of files based on mtime - maybe it will come back later
+  - Made ActiveFile::Base.all a bit more sane
+
+2009-10-13
+  - added ActiveHash::Base.has_many, which works with ActiveRecord or ActiveHash classes (thanks to baldwindavid)
+  - added ActiveHash::Base.belongs_to, which works with ActiveRecord or ActiveHash classes (thanks to baldwindavid)
+  - added .delete_all method that clears the in-memory array
+  - added support for Hash-style yaml (think, Rails fixtures)
+  - added setter for parent object on belongs_to ( city = City.new; city.state = State.first; city.state_id == State.first.id )
+
+2009-10-12
+  - auto-assign fields after calling data= instead of after calling .all
+  - remove require 'rubygems', so folks with non-gem setups can still use AH
+  - added more specific activesupport dependency to ensure that metaclass is available
+  - AH no longer calls to_i on ids.  If you pass in a string as an id, you'll get a string back
+  - Fancy finders, such as find_all_by_id_and_name, will compare the to_s values of the fields, so you can pass in strings
+  - You can now use ActiveHash models as the parents of polymorphic belongs_to associations
+  - save, save!, create and create! now add items to the in-memory collection, and naively adds autoincrementing id
+  - new_record? returns false if the record is part of the collection
+  - ActiveHash now works with Fixjour!
+
+2009-08-19
+  - Added custom finders for multiple fields, such as .find_all_by_name_and_age
+
+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
+
+2009-07-24
+  - ActiveFile no longer reloads files by default
+  - Added ActiveFile.reload_active_file= so you can cause ActiveFile to reload
+  - Setting data to nil correctly causes .all to return an empty array
+  - Added reload(force) method, so that you can force a reload from files in ActiveFile, useful for tests

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Dean
+
+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/README.md

@@ -0,0 +1,291 @@
+# ActiveHash
+
+ActiveHash is a simple base class that allows you to use a ruby hash as a readonly datasource for an ActiveRecord-like model.
+
+ActiveHash assumes that every hash has an :id key, which is what you would probably store in a database.  This allows you to seemlessly upgrade from ActiveHash objects to full ActiveRecord objects without having to change any code in your app, or any foreign keys in your database.
+
+It also allows you to use #has_many and #belongs_to in your AR objects.
+
+ActiveHash can also be useful to create simple test classes that run without a database - ideal for testing plugins or gems that rely on simple AR behavior, but don't want to deal with databases or migrations for the spec suite.
+
+ActiveHash also ships with:
+
+  * ActiveFile: a base class that you can use to create file data sources
+  * ActiveYaml: a base class that will turn YAML into a hash and load the data into an ActiveHash object
+
+## Installation
+
+Make sure gemcutter.org is one of your gem sources, then run:
+    
+    sudo gem install active_hash
+
+## Usage
+
+To use ActiveHash, you need to:
+
+ * Inherit from ActiveHash::Base
+ * Define your data
+ * Define your fields and/or default values
+
+A quick example would be:
+
+    class Country < ActiveHash::Base
+      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:
+
+    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
+      field   :is_axis_of_evil, :default => false
+    end
+
+## Defining Data
+
+You can define data inside your class or outside.  For example, you might have a class like this:
+
+    # app/models/country.rb
+    class Country < ActiveHash::Base
+    end
+
+    # config/initializers/data.rb
+    Country.data = [
+        {:id => 1, :name => "US"},
+        {:id => 2, :name => "Canada"}
+    ]
+
+If you prefer to store your data in YAML, see below.
+
+## Class Methods
+
+ActiveHash gives you ActiveRecord-esque methods like:
+
+    Country.all             # => returns all Country objects
+    Country.count           # => returns the length of the .data array
+    Country.first           # => returns the first country object
+    Country.last            # => returns the last country object
+    Country.find 1          # => returns the first country object with that id
+    Country.find [1,2]      # => returns all Country objects with ids in the array
+    Country.find :all       # => same as .all
+    Country.find :all, args # => the second argument is totally ignored, but allows it to play nicely with AR
+    Country.find_by_id 1    # => find the first object that matches the id
+
+It also gives you a few dynamic finder methods.  For example, if you defined :name as a field, you'd get:
+
+    Country.find_by_name "foo"                    # => returns the first object matching that name
+    Country.find_all_by_name "foo"                # => returns an array of the objects with matching names
+    Country.find_by_id_and_name 1, "Germany"      # => returns the first object matching that id and name
+    Country.find_all_by_id_and_name 1, "Germany"  # => returns an array of objects matching that name and id
+
+## Instance Methods
+
+ActiveHash objects implement enough of the ActiveRecord api to satisfy most common needs.  For example:
+
+    Country#id          # => returns the id or nil
+    Country#id=         # => sets the id attribute
+    Country#quoted_id   # => returns the numeric id
+    Country#to_param    # => returns the id as a string
+    Country#new_record? # => returns true if is not part of Country.all, false otherwise
+    Country#readonly?   # => true
+    Country#hash        # => the hash of the id (or the hash of nil)
+    Country#eql?        # => compares type and id, returns false if id is nil
+
+ActiveHash also gives you methods related to the fields you defined.  For example, if you defined :name as a field, you'd get:
+
+    Country#name        # => returns the passed in name
+    Country#name?       # => returns true if the name is not blank
+    Country#name=       # => sets the name
+
+## Saving in-memory records
+
+The ActiveHash::Base.all method functions like an in-memory data store.  You can save your records to the the .all array by using standard ActiveRecord create and save methods:
+
+    Country.all             # => []
+    Country.create
+    Country.all             # [ <Country :id => 1> ]
+    country = Country.new
+    country.new_record?     # => true
+    country.save
+    country.new_record?     # => false
+    Country.all             # [ <Country :id => 1>, <Country :id => 2>  ]
+
+Notice that when adding records to the collection, it will auto-increment the id for you by default.  If you use string ids, it will not auto-increment the id.  Available methods are:
+
+    Country.insert( record )
+    Country#save
+    Country#save!
+    Country.create
+    Country.create!
+
+As such, ActiveHash::Base and its descendants should work with Fixjour or FactoryGirl, so you can treat ActiveHash records the same way you would any other ActiveRecord model in tests.
+
+To clear all records from the in-memory array, call delete_all:
+
+    Country.delete_all  # => does not affect the yaml files in any way - just clears the in-memory array which can be useful for testing
+
+## Associations
+
+You can create has_many and belongs_to associations to and from ActiveRecord.  Out of the box, you can create .belongs_to associations from rails objects, like so:
+
+    class Country < ActiveHash::Base
+    end
+
+    class Person < ActiveRecord::Base
+      belongs_to :country
+    end
+
+ActiveHash will also work as a polymorphic parent:
+
+    class Country < ActiveHash::Base
+    end
+
+    class Person < ActiveRecord::Base
+      belongs_to :location, :polymorphic => true
+    end
+
+    person = Person.new
+    person.location = Country.first
+    person.save
+    person.location # => Country.first
+
+You can also use standard rails view helpers, like #collection_select:
+
+    <%= collection_select :person, :country_id, Country.all, :id, :name %>
+
+If you include the ActiveHash::Associations module, you can also create associations from your ActiveHash classes, like so:
+
+    class Country < ActiveHash::Base
+      include ActiveHash::Associations
+      has_many :people
+    end
+
+    class Person < ActiveHash::Base
+      include ActiveHash::Associations
+      belongs_to :country
+      has_many :pets
+    end
+
+    class Pet < ActiveRecord::Base
+    end
+
+Once you define a belongs to, you also get the setter method:
+
+    class City < ActiveHash::Base
+      include ActiveHash::Associations
+      belongs_to :state
+    end
+
+    city = City.new
+    city.state = State.first
+    city.state_id             # is State.first.id
+
+NOTE:  You cannot use ActiveHash objects as children of ActiveRecord and I don't plan on adding support for that.  It doesn't really make any sense, since you'd have to hard-code your database ids in your class or yaml files, which is a dependency inversion.
+
+Also, the implementation of has_many and belongs_to is very simple - I hope to add better support for it later - it will only work in the trivial cases for now.
+
+Thanks to baldwindavid for the ideas and code on that one.
+
+## ActiveYaml
+
+If you want to store your data in YAML files, just inherit from ActiveYaml and specify your path information:
+
+    class Country < ActiveYaml::Base
+    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:
+
+    class Country < ActiveYaml::Base
+      set_root_path "/u/data"
+      set_filename "sample"
+    end
+
+The above example will look for the file "/u/data/sample.yml".
+
+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.  You can format your YAML as an array, or as a hash:
+
+    # array style
+    - id: 1
+      name: US
+    - id: 2
+      name: Canada
+    - id: 3
+      name: Mexico
+
+    # hash style
+    us:
+      id: 1
+      name: US
+    canada:
+      id: 2
+      name: Canada
+    mexico:
+      id: 3
+      name: Mexico
+
+## 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:
+
+    class Country < ActiveFile::Base
+      set_root_path "/u/data"
+      set_filename "sample"
+
+      class << self
+        def extension
+          ".super_secret"
+        end
+
+        def load_file
+          MyAwesomeDecoder.load_file(full_path)
+        end
+      end
+    end
+
+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"
+
+In Rails, in development mode, it reloads the entire class, which reloads the file.  In production, the data cached in memory.
+
+NOTE:  By default, .full_path refers to the current working directory.  In a rails app, this will be RAILS_ROOT.
+
+## Authors
+
+Written by Jeff Dean, Mike Dalessio and Ben Woosley
+
+== Copyright
+
+Copyright (c) 2009 Jeff Dean. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "honkster-active_hash"
+    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"]
+    gem.add_dependency('activesupport', [">= 2.2.2"])
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_hash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.7.3

data/active_hash.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_hash}
+  s.version = "0.7.3"
+
+  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"]
+  s.date = %q{2009-10-22}
+  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",
+     "geminstaller.yml",
+     "lib/active_file/base.rb",
+     "lib/active_hash.rb",
+     "lib/active_hash/base.rb",
+     "lib/active_yaml/base.rb",
+     "lib/associations/associations.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/fixtures/array_rows.yml",
+     "spec/fixtures/cities.yml",
+     "spec/fixtures/countries.yml",
+     "spec/fixtures/states.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.5}
+  s.summary = %q{An ActiveRecord-like model that uses a hash or file 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/associations/associations_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>, [">= 2.2.2"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.2.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.2.2"])
+  end
+end