static_model 0.1.5 → 0.2.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.2.0 2008-10-27
+	
+	* 2 major enhancements
+			
+		* StaticModel generator
+		* 'class_attributes' and ability to set default for record attributes
+		* Real documentation on the website: http://quirkey.rubyforge.org/static_model
+
 == 0.1.5 2008-09-18
 
 * 1 minor enhancement

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 FIXME full name
+Copyright (c) 2008 Aaron Quint, Quirkey NYC, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,22 +1,17 @@
 History.txt
 License.txt
 Manifest.txt
-README.txt
-Rakefile
-config/hoe.rb
-config/requirements.rb
+README.rdoc
+generators/static_model/USAGE
+generators/static_model/static_model_generator.rb
+generators/static_model/templates/model.rb.erb
+generators/static_model/templates/models.yml.erb
 lib/static_model.rb
-lib/static_model/base.rb
-lib/static_model/associations.rb
 lib/static_model/active_record.rb
+lib/static_model/associations.rb
+lib/static_model/base.rb
 lib/static_model/comparable.rb
 lib/static_model/errors.rb
 lib/static_model/rails.rb
-lib/static_model/version.rb
-setup.rb
-test/books.yml
-test/authors.yml
-test/publishers.yml
-test/test_helper.rb
-test/test_static_model.rb
-test/test_static_model_associations.rb
+lib/static_model/scope.rb
+lib/static_model/version.rb

data/{README.txt → README.rdoc}

@@ -1,6 +1,6 @@
 = static_model
 
-http://github.com/quirkey/static_model/
+http://quirkey.rubyforge.org/static_model/
 
 == DESCRIPTION:
 
@@ -8,16 +8,24 @@ ActiveRecord like functionalities for reading from YAML with a simple class impl
 
 == SYNOPSIS:
 
-  Use like ActiveRecord::Base, except no database, just a YAML file. The YAML should contain an array of records.
+Use like ActiveRecord::Base, except no database, just a YAML file. The YAML should contain an array of records.
+
+For usage and setup check out the project's site:
+
+http://quirkey.rubyforge.org/static_model/
 
 == REQUIREMENTS:
 
-	YAML 
-	activesupport >= 2.1.0
+YAML 
+activesupport >= 2.1.0
 
 == INSTALL:
 
 	sudo gem install static_model 
+	
+The source is at github:
+
+http://github.com/quirkey/static_model/
 
 == LICENSE:
 

data/generators/static_model/USAGE

@@ -0,0 +1,8 @@
+Description:
+  
+  Generates an empty StaticModel class/model
+
+Usage:
+  
+	./script/generate static_model ModelName --data=config/data/ --lib=app/models/
+	

data/generators/static_model/static_model_generator.rb

@@ -0,0 +1,57 @@
+class StaticModelGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name, :lib_dir, :data_dir
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory data_dir
+      m.directory lib_dir
+      m.template 'model.rb.erb', File.join(lib_dir, name.underscore + ".rb")
+      m.template 'models.yml.erb', File.join(data_dir, table_name + ".yml")
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} ModelName
+EOS
+    end
+    
+    def class_name
+      @name.classify
+    end
+    
+    def table_name
+      @name.tableize
+    end
+    
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-l", "--lib=your/path/", String, "Put the model.rb in a specific lib dir (default = app/models/)") {|o| options[:lib_dir] = o }
+      opts.on("-d", "--data=your/path/", String, "Put the models.yml data file in a specific data dir (default = config/data/)") {|o| options[:data_dir] = o }
+    end
+
+    def extract_options
+      @lib_dir = options[:lib_dir] || File.join('app', 'models')
+      @data_dir = options[:data_dir] || File.join('config', 'data')
+    end
+end

data/generators/static_model/templates/model.rb.erb

@@ -0,0 +1,4 @@
+class <%= class_name %> < StaticModel::Base
+  set_data_file File.join('<%= data_dir %>', '<%= table_name %>.yml')
+
+end

data/generators/static_model/templates/models.yml.erb

@@ -0,0 +1,6 @@
+---
+records:
+  - id: 1
+    name: One
+  - id: 2
+    name: Two

data/lib/static_model/base.rb

@@ -7,7 +7,8 @@ module StaticModel
     @@load_path = File.join('config', 'data')
 
     attr_reader :id
-
+    
+    
     def initialize(attribute_hash = {})
       raise(StaticModel::BadOptions, "Initializing a model is done with a Hash {} given #{attribute_hash.inspect}") unless attribute_hash.is_a?(Hash)
       @id = attribute_hash.delete('id') || attribute_hash.delete(:id) || (self.class.count + 1)
@@ -19,7 +20,7 @@ module StaticModel
     end
 
     def attributes
-      @attributes ||= {}
+      @attributes ||= HashWithIndifferentAccess.new
     end
 
     def attributes=(attribute_hash)
@@ -27,7 +28,7 @@ module StaticModel
     end
 
     def attribute_names
-      attributes.keys
+      (attributes.keys | self.class.class_attributes.keys).collect {|k| k.to_s }
     end
 
     class << self
@@ -73,9 +74,18 @@ module StaticModel
       def load(reload = false)
         return if loaded? && !reload
         raise(StaticModel::DataFileNotFound, "You must set a data file to load from") unless File.readable?(data_file) 
-        records = YAML::load_file(data_file)
-        @records = records ? records.dup.collect {|r| new(r) } : []
+        data = YAML::load_file(data_file)
+        records = []
+        if data.is_a?(Hash) && data.has_key?('records')
+          records = data.delete('records')
+          @class_attributes = HashWithIndifferentAccess.new(data)
+        elsif data.is_a?(Array)
+          records = data
+        end
+        @records = records && !records.empty? ? records.dup.collect {|r| new(r) } : []
         @loaded = true
+      # rescue
+      #   raise(StaticModel::BadDataFile, "The data file you specified '#{data_file}' was not in a readable format.")
       end
 
       def loaded?
@@ -98,6 +108,15 @@ module StaticModel
         records.length
       end
       
+      def class_attributes
+        load
+        @class_attributes ||= {}
+      end
+      
+      def class_attribute(name)
+        class_attributes[name]
+      end
+      
       def records
         load
         @records
@@ -115,6 +134,8 @@ module StaticModel
           attribute_name = meth_name.gsub(/^find_(all_by|first_by|by)_/, '')
           finder    = meth_name.gsub(/_#{attribute_name}/, '')
           return self.send(finder, attribute_name, *args)
+        elsif class_attributes.has_key? meth_name
+          return class_attributes[meth_name]
         end
         super
       end
@@ -122,19 +143,23 @@ module StaticModel
 
     protected
     def set_attribute(name, value)
-      self.attributes[name.to_sym] = value
+      self.attributes[name] = value
+    end
+    
+    def get_attribute(name)
+      attributes.has_key?(name) ? attributes[name] : self.class.class_attribute(name)
     end
 
     private
     def method_missing(meth, *args)
-      attribute_name = meth.to_s.gsub(/=$/,'').to_sym
+      attribute_name = meth.to_s.gsub(/=$/,'')
       if attribute_names.include?(attribute_name)
         if meth.to_s =~ /=$/
           # set
           return set_attribute(attribute_name, args[0])
         else
           # get
-          return attributes[attribute_name]
+          return get_attribute(attribute_name)
         end
       end
       super

data/lib/static_model/errors.rb

@@ -2,5 +2,6 @@ module StaticModel
   class Error < RuntimeError; end;
   class RecordNotFound < Error; end;
   class DataFileNotFound < Error; end;
+  class BadDataFile < Error; end;
   class BadOptions < Error; end;
 end

data/lib/static_model/scope.rb

@@ -0,0 +1,15 @@
+module StaticModel
+  module Scope
+   
+    private
+    class << self
+      def with_scope
+        
+      end
+      
+      def scoped_conditions
+      end
+    end
+    
+  end
+end

data/lib/static_model/version.rb

@@ -1,8 +1,8 @@
 module StaticModel #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 5
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/static_model.rb

@@ -4,8 +4,10 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'yaml'
 
 require 'active_support/inflector'
+require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 
+
 require 'static_model/errors'
 require 'static_model/associations'
 require 'static_model/active_record'

data/test/test_generator_helper.rb

@@ -0,0 +1,29 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -6,7 +6,7 @@ require 'mocha'
 require File.dirname(__FILE__) + '/../lib/static_model'
 
 class Book < StaticModel::Base
-  set_data_file File.join(File.dirname(__FILE__), 'books.yml')
+  set_data_file File.join(File.dirname(__FILE__), 'data', 'books.yml')
 end
 
 unless defined?(ActiveRecord::Base)
@@ -22,18 +22,23 @@ class Article < ActiveRecord::Base
 end
 
 class Publisher < StaticModel::Base
-  set_data_file File.join(File.dirname(__FILE__), 'publishers.yml')
+  set_data_file File.join(File.dirname(__FILE__), 'data', 'publishers.yml')
   
   has_many :authors
 end
 
 class Author < StaticModel::Base
-  set_data_file File.join(File.dirname(__FILE__), 'authors.yml')
+  set_data_file File.join(File.dirname(__FILE__), 'data','authors.yml')
   has_many :books
   has_many :articles
   belongs_to :publisher
 end
 
+class Page < StaticModel::Base
+  set_data_file File.join(File.dirname(__FILE__), 'data', 'pages.yml')
+  
+end
+  
 
 
 

data/test/test_static_model.rb

@@ -66,7 +66,7 @@ class TestStaticModel < Test::Unit::TestCase
               @book = Book.find(1)
               @author = Author.find(1)
               @original_data_file = Book.data_file
-              @data_file = File.join(File.dirname(__FILE__), 'authors.yml')
+              @data_file = File.join(File.dirname(__FILE__), 'data', 'authors.yml')
               Book.set_data_file @data_file
               @new_book = Book.find(1)
             end
@@ -176,7 +176,7 @@ class TestStaticModel < Test::Unit::TestCase
           context "with an empty data file" do
             setup do
               @original_data_file = Book.data_file
-              @data_file = File.join(File.dirname(__FILE__), 'empty.yml')
+              @data_file = File.join(File.dirname(__FILE__), 'data', 'empty.yml')
               Book.set_data_file @data_file
             end
 
@@ -295,6 +295,47 @@ class TestStaticModel < Test::Unit::TestCase
             assert_equal Book.all.length, Book.count
           end
         end
+        
+        context "with a class with yaml class vars" do
+          setup do
+            @pages = Page.all
+          end
+          
+          should "load :records into @records" do
+            assert_set_of Page, @pages
+            assert Page.loaded?
+          end
+          
+          should "give access to top level attributes as class methods" do
+            assert_equal 'http://www.quirkey.com', Page.url
+            assert_equal 'The Best Ever', Page.title
+          end
+          
+          should "return a hash for class attribute" do
+            assert Page.settings.is_a?(Hash)
+            assert_equal 'test', Page.settings['username']
+          end
+          
+          should "have class attributes appear as record accessor defaults if none exist" do
+            assert_equal 'http://www.quirkey.com', Page[1].url
+          end
+          
+          should "not overwrite record specific methods" do
+            assert_equal 'http://github.com', Page[2].url
+          end
+          
+          context "class_attributes" do
+            setup do
+              @attributes = Page.class_attributes
+            end
+            
+            should "return a hash of all top level settings" do
+              assert @attributes.is_a?(Hash)
+              assert_equal 3, @attributes.length
+              assert_equal 'http://www.quirkey.com', @attributes['url']
+            end
+          end
+        end
 
       end
     end