static_model 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.1.0 2008-07-09
+
+* 1 major enhancement:
+  * Initial release
+		- Basic functionality
+		- Full test suite using shoulda

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/static_model.rb
+lib/static_model/base.rb
+lib/static_model/errors.rb
+lib/static_model/rails.rb
+lib/static_model/version.rb
+setup.rb
+test/books.yml
+test/test_helper.rb
+test/test_static_model.rb

data/README.txt

@@ -0,0 +1,44 @@
+= static_model
+
+http://github.com/quirkey/static_model/
+
+== DESCRIPTION:
+
+ActiveRecord like functionalities for reading from YAML with a simple class implementation
+
+== SYNOPSIS:
+
+  Use like ActiveRecord::Base, except no database, just a YAML file. The YAML should contain an array of records.
+
+== REQUIREMENTS:
+
+	YAML 
+
+== INSTALL:
+
+	sudo gem install static_model 
+
+== LICENSE:
+
+(The MIT License)
+
+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
+'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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'static_model/version'
+
+AUTHOR = 'Aaron Quint'  # can also be an array of Authors
+EMAIL = "aaron@quirkey.com"
+DESCRIPTION = "ActiveRecord like functionalities for reading from YAML with a simple class implementation"
+GEM_NAME = 'static_model' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'quirkey' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = StaticModel::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'static_model documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/static_model/base.rb

@@ -0,0 +1,137 @@
+module StaticModel  
+  class Base
+
+    @@load_path = File.join('config', 'data')
+
+    attr_reader :id
+
+    def initialize(attribute_hash = {})
+      raise(StaticModel::BadOptions, "Initializing a model is done with a Hash {}") unless attribute_hash.is_a?(Hash)
+      @id = attribute_hash.delete('id') || attribute_hash.delete(:id) || (self.class.count + 1)
+      self.attributes = attribute_hash
+    end
+
+    def to_s
+      self.inspect
+    end
+
+    def attributes
+      @attributes ||= {}
+    end
+
+    def attributes=(attribute_hash)
+      attribute_hash.each {|k,v| set_attribute(k,v) }
+    end
+
+    def attribute_names
+      attributes.keys
+    end
+
+    class << self
+
+      def find(what, *args, &block)
+        case what
+        when Symbol
+          send("find_#{what}")
+        when Integer
+          find_by_id(what)
+        end
+      end
+
+      def find_by_id(id)
+        load
+        record = @@records.detect {|r| r.id == id }
+        raise(StaticModel::RecordNotFound, "Could not find record with id = #{id}") unless record
+        record
+      end
+
+      def [](id)
+        find_by_id(id)
+      end
+
+      def find_all
+        load
+        @@records
+      end
+      alias_method :all, :find_all
+
+      def find_first
+        load
+        @@records[0]
+      end
+      alias_method :first, :find_first
+
+      def find_all_by(attribute, value)
+        load
+        records = @@records.find_all {|r| r.send(attribute) == value }
+      end
+
+      def find_first_by(attribute, value)
+        load
+        records = @@records.find {|r| r.send(attribute) == value }
+      end
+
+      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.dup.collect {|r| new(r) }
+        @@loaded = true
+      end
+
+      def loaded?
+        @@loaded ||= false
+      end
+
+      def data_file
+        @@data_file ||= default_data_file_path
+      end
+
+      def set_data_file(file_path)
+        raise(StaticModel::DataFileNotFound, "Could not find data file #{file_path}") unless File.readable?(file_path)
+        @@data_file = file_path
+      end
+    
+      def count
+        @@records.length
+      end
+
+      protected
+      def default_data_file_path
+        File.join(@@load_path, "#{self.to_s.tableize}.yml")
+      end
+
+      private
+      def method_missing(meth, *args)
+        meth_name = meth.to_s
+        if meth_name =~ /^find_(all|first)_by_(.+)/
+          attribute_name = meth_name.gsub(/^find_(all|first)_by_/, '')
+          finder    = meth_name.gsub(/_#{attribute_name}/, '')
+          return self.send(finder, attribute_name, *args)
+        end
+        super
+      end
+    end  
+
+    protected
+    def set_attribute(name, value)
+      self.attributes[name.to_sym] = value
+    end
+
+    private
+    def method_missing(meth, *args)
+      attribute_name = meth.to_s.gsub(/=$/,'').to_sym
+      if attribute_names.include?(attribute_name)
+        if meth.to_s =~ /=$/
+          # set
+          return set_attribute(attribute_name, args[0])
+        else
+          # get
+          return attributes[attribute_name]
+        end
+      end
+      super
+    end
+    
+  end
+end

data/lib/static_model/errors.rb

@@ -0,0 +1,6 @@
+module StaticModel
+  class Error < RuntimeError; end;
+  class RecordNotFound < Error; end;
+  class DataFileNotFound < Error; end;
+  class BadOptions < Error; end;
+end

data/lib/static_model/rails.rb

@@ -0,0 +1,7 @@
+if defined?(Rails)
+  module StaticModel
+    class Base
+      @@load_path = File.join(Rails.root,'config', 'data')
+    end
+  end
+end

data/lib/static_model/version.rb

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

data/lib/static_model.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'yaml'
+require 'static_model/errors'
+require 'static_model/base'
+require 'static_model/rails'