minimodel 0.1.0

data/README.txt

@@ -0,0 +1,27 @@
+A little library for defining little models.
+
+Many apps use small "read only" datasets that can easily be held in memory,
+for example: currency data, country data, colour data, advertising banners,
+options for select boxes, payment plans etc. Sometimes it's useful to model
+this data without using your database, and that's what minimodel is for.
+
+Quick example:
+
+  require 'minimodel'
+
+  class Currency < MiniModel
+    indexed_by :code
+
+    insert code: 'EUR', name: 'Euro'
+    insert code: 'GBP', name: 'Pound sterling'
+    insert code: 'USD', name: 'United States dollar'
+  end
+
+
+The Currency class will respond to #count (returning the total number of
+currencies), #all (returning an array of currency objects), and #find
+(to lookup a specific currency by its code). Just like ActiveRecord.
+
+Take a look at spec/*_spec.rb for more examples.
+
+Have fun.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+end

data/lib/minimodel/associations.rb

@@ -0,0 +1,65 @@
+require 'active_support/inflector'
+
+class MiniModel
+  class HasManyAssociation
+    def initialize(owner, association_name, options = {})
+      @owner, @association_name, @options = owner, association_name, options
+    end
+
+    def each(&block)
+      collection.each(&block)
+    end
+
+    def size
+      arel_model? ? collection.size : collection.length
+    end
+
+    include Enumerable
+
+    private
+
+    def collection
+      @collection ||= begin
+        owner_id = @owner.send(@owner.class.primary_key)
+
+        if arel_model?
+          target_model.where(foreign_key => owner_id)
+        else
+          target_model.all.select { |object| object.send(foreign_key) == owner_id }
+        end
+      end
+    end
+
+    def arel_model?
+      target_model.respond_to?(:where)
+    end
+
+    def foreign_key
+      @foreign_key ||= '%s_%s' % [@owner.class.name.demodulize.underscore, @owner.class.primary_key]
+    end
+
+    def target_model
+      @target_model ||= @association_name.to_s.classify.constantize
+    end
+  end
+
+  module AssociationClassMethods
+    def belongs_to(association_name, options = {})
+      define_method(association_name) do
+        target_model = association_name.to_s.classify.constantize
+
+        foreign_key = '%s_%s' % [association_name, target_model.primary_key]
+
+        target_model.find(self.send(foreign_key))
+      end
+    end
+
+    def has_many(association_name, options = {})
+      define_method(association_name) do
+        HasManyAssociation.new(self, association_name, options)
+      end
+    end
+  end
+
+  extend AssociationClassMethods
+end

data/lib/minimodel.rb

@@ -0,0 +1,92 @@
+require 'yaml'
+
+class MiniModel
+  def initialize(attributes)
+    @attributes = attributes.to_hash
+  end
+
+  def hash
+    @attributes.hash
+  end
+
+  def eql?(object)
+    object.class == self.class && object.hash == self.hash
+  end
+
+  def to_hash
+    @attributes
+  end
+
+  def method_missing(symbol, *args, &block)
+    if @attributes.has_key?(symbol) && args.empty? && block.nil?
+      return @attributes[symbol]
+    else
+      super symbol, *args, &block
+    end
+  end
+
+  class DuplicateKeyError < StandardError
+  end
+
+  module ClassMethods
+    def all
+      index.values
+    end
+
+    def count
+      index.length
+    end
+
+    def primary_key
+      @primary_key
+    end
+
+    def indexed_by(primary_key, options = {})
+      @primary_key = primary_key
+
+      @auto_increment = options[:auto_increment] ? 1 : nil
+    end
+
+    def insert(attributes)
+      unless @auto_increment.nil?
+        attributes[primary_key] = @auto_increment
+
+        @auto_increment += 1
+      end
+
+      object = new(attributes)
+
+      pkey = object.send(primary_key)
+
+      if index.has_key?(pkey)
+        raise DuplicateKeyError
+      end
+
+      index[pkey] = object
+    end
+
+    def find(key)
+      index[key]
+    end
+
+    def load_from(path)
+      YAML.load_file(path).each do |key, attrs|
+        insert symbolize_keys(attrs, primary_key => key)
+      end
+    end
+
+    private
+
+    def symbolize_keys(hash, initial_value=nil)
+      hash.inject(initial_value) do |tmp, (k, v)|
+        tmp.merge(k.to_sym => v)
+      end
+    end
+
+    def index
+      @index ||= {}
+    end
+  end
+
+  extend ClassMethods
+end

data/minimodel.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = 'minimodel'
+  s.version = '0.1.0'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Craft']
+  s.email = ['mail@timcraft.com']
+  s.homepage = 'http://github.com/timcraft/minimodel'
+  s.description = 'A little library for defining little models'
+  s.summary = 'See description'
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.txt Rakefile minimodel.gemspec)
+  s.add_development_dependency('activesupport', ['>= 3.0.3'])
+  s.add_development_dependency('activerecord', ['>= 3.0.3'])
+  s.require_path = 'lib'
+end

data/spec/colour_spec.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'minimodel'
+
+class Colour < MiniModel
+  indexed_by :id, auto_increment: true
+
+  insert name: 'Blue', hexdigits: '0000FF'
+  insert name: 'Red', hexdigits: 'FF0000'
+  insert name: 'Green', hexdigits: '00FF00'
+end
+
+describe Colour do
+  it 'should assign auto incrementing id values' do
+    Colour.all.map(&:id).must_equal [1, 2, 3]
+  end
+end

data/spec/currency_data.yml

@@ -0,0 +1,8 @@
+EUR:
+  name: Euro
+
+GBP:
+  name: Pound sterling
+
+USD:
+  name: United States dollar

data/spec/currency_spec.rb

@@ -0,0 +1,89 @@
+require 'minitest/autorun'
+require 'minimodel'
+
+class Currency < MiniModel
+  indexed_by :code
+
+  load_from 'spec/currency_data.yml'
+
+  insert code: 'INR', name: 'Indian rupee'
+  insert code: 'JPY', name: 'Japanese yen'
+end
+
+describe 'A currency object' do
+  before do
+    @euro = Currency.new(code: 'EUR', name: 'Euro')
+  end
+
+  it 'should have attribute reader methods' do
+    @euro.code.must_equal 'EUR'
+    @euro.name.must_equal 'Euro'
+  end
+
+  describe '#eql?' do
+    describe 'when passed the same currency object' do
+      it 'should return true' do
+        @euro.eql?(@euro).must_equal true
+        @euro.eql?(Currency.new(code: 'EUR', name: 'Euro')).must_equal true
+      end
+    end
+
+    describe 'when passed a different currency object' do
+      it 'should return false' do
+        @euro.eql?(Currency.new(code: 'GBP', name: 'Pound sterling')).must_equal false
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    it 'should return a hash containing the object attributes' do
+      @euro.to_hash.must_be_kind_of Hash
+      @euro.to_hash.must_equal code: 'EUR', name: 'Euro'
+    end
+  end
+end
+
+describe Currency do
+  describe '#all' do
+    it 'should return an array containing currency objects' do
+      Currency.all.must_be_kind_of Array
+      Currency.all.all? { |object| object.must_be_kind_of Currency }
+    end
+  end
+
+  describe '#primary_key' do
+    it 'should return the primary key specified using #indexed_by' do
+      Currency.primary_key.must_equal :code
+    end
+  end
+
+  describe '#count' do
+    it 'should return the total number of currencies defined' do
+      Currency.count.must_equal 5
+    end
+  end
+
+  describe '#find' do
+    describe 'when passed a valid currency code' do
+      it 'should return the correct currency' do
+        currency = Currency.find('EUR')
+
+        currency.must_be_kind_of Currency
+        currency.code.must_equal 'EUR'
+        currency.name.must_equal 'Euro'
+      end
+    end
+
+    describe 'when passed an invalid currency code' do
+      it 'should return nil' do
+        Currency.find('FOO').must_be_nil
+      end
+    end
+  end
+
+  describe '#insert' do
+    it 'should raise an error when passed a key that already exists' do
+      proc { Currency.insert(code: 'EUR', name: 'Euro') }.must_raise MiniModel::DuplicateKeyError
+    end
+  end
+end

data/spec/dutch_education_spec.rb

@@ -0,0 +1,137 @@
+require 'minitest/autorun'
+require 'minimodel'
+require 'minimodel/associations'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :courses, :force => true do |t|
+    t.string :name, :index => true
+    t.string :level_name, :index => true
+  end
+end
+
+class Level < MiniModel
+  indexed_by :name
+
+  has_many :courses
+  has_many :profiles
+
+  insert name: 'VMBO-T'
+  insert name: 'HAVO'
+  insert name: 'VWO'
+end
+
+class Profile < MiniModel
+  indexed_by :id, auto_increment: true
+
+  belongs_to :level
+
+  insert level_name: 'VMBO-T', name: 'Techniek'
+  insert level_name: 'VMBO-T', name: 'Zorg en Welzijn'
+  insert level_name: 'VMBO-T', name: 'Economie'
+  insert level_name: 'VMBO-T', name: 'Landbouw'
+
+  insert level_name: 'HAVO', name: 'Economie en Maatschappij'
+  insert level_name: 'HAVO', name: 'Cultuur en Maatschappij'
+  insert level_name: 'HAVO', name: 'Natuur en Gezondheid'
+  insert level_name: 'HAVO', name: 'Natuur en Techniek'
+
+  insert level_name: 'VWO', name: 'Economie en Maatschappij'
+  insert level_name: 'VWO', name: 'Cultuur en Maatschappij'
+  insert level_name: 'VWO', name: 'Natuur en Gezondheid'
+  insert level_name: 'VWO', name: 'Natuur en Techniek'
+end
+
+class Course < ActiveRecord::Base
+  def level
+    @level ||= Level.find(level_name)
+  end
+end
+
+Level.all.each do |level|
+  for course_name in %w( Nederlands Engels Duits )
+    Course.create!(level_name: level.name, name: "#{level.name}/#{course_name}")
+  end
+end
+
+describe 'A level object' do
+  before do
+    @level = Level.find('VMBO-T')
+
+    @profile_names = ['Economie', 'Landbouw', 'Techniek', 'Zorg en Welzijn']
+
+    @course_names = %w( VMBO-T/Duits VMBO-T/Engels VMBO-T/Nederlands )
+  end
+
+  describe '#profiles' do
+    it 'should be enumerable' do
+      @level.profiles.must_respond_to :each
+      @level.profiles.class.ancestors.must_include Enumerable
+    end
+
+    describe '#size' do
+      it 'should return the number of profiles linked to this level' do
+        @level.profiles.size.must_equal 4
+      end
+    end
+
+    describe '#to_a' do
+      it 'should return an array containing the correct profile objects' do
+        profiles = @level.profiles.to_a
+
+        profiles.must_be_kind_of Array
+        profiles.map(&:name).sort.must_equal @profile_names
+      end
+    end
+  end
+
+  describe '#courses' do
+    it 'should be enumerable' do
+      @level.courses.must_respond_to :each
+      @level.courses.class.ancestors.must_include Enumerable
+    end
+
+    describe '#size' do
+      it 'should return the number of courses linked to this level' do
+        @level.courses.size.must_equal 3
+      end
+    end
+
+    describe '#to_a' do
+      it 'should return an array containing the correct course objects' do
+        courses = @level.courses.to_a
+
+        courses.must_be_kind_of Array
+        courses.map(&:name).sort.must_equal @course_names
+      end
+    end
+  end
+end
+
+describe 'A profile object' do
+  before do
+    @profile = Profile.find(8)
+  end
+
+  describe '#level' do
+    it 'should return the correct level object' do
+      @profile.level.must_be_kind_of Level
+      @profile.level.name.must_equal 'HAVO'
+    end
+  end
+end
+
+describe 'A course object' do
+  before do
+    @course = Course.find_by_name('VWO/Engels')
+  end
+
+  describe '#level' do
+    it 'should return the correct level object' do
+      @course.level.must_be_kind_of Level
+      @course.level.name.must_equal 'VWO'
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: minimodel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Craft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &3990170 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *3990170
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &3989920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *3989920
+description: A little library for defining little models
+email:
+- mail@timcraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/minimodel/associations.rb
+- lib/minimodel.rb
+- spec/colour_spec.rb
+- spec/currency_data.yml
+- spec/currency_spec.rb
+- spec/dutch_education_spec.rb
+- README.txt
+- Rakefile
+- minimodel.gemspec
+homepage: http://github.com/timcraft/minimodel
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: See description
+test_files: []