minimodel 0.2.0 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3103b9d7124f91936f1ad70da337f999f230a4463a6a7933f7566d5997837ad
+  data.tar.gz: d4f57fd1224b32b6ab488b8365457cef1263e119252f38287eb02760c194ba28
+SHA512:
+  metadata.gz: 13d65ca6e41549bb006fd737b3592c0095f03fbea9badf9f2512611cdaf3860e06579e77d51107da7adc71506ddd81fbbe95ff1e892749ba98f50b3ebad1494d
+  data.tar.gz: ef6cbce222f3fa1ebf1e9088e32a824a92ab4250cf6e73bacd880a56910d6d43706f94cb1b99899eac58e507527c1f098bf3ef450de18acd5962a31e14641bf9

data/CHANGES.md

@@ -0,0 +1,33 @@
+# 2.0.1
+
+* Added CHANGES.md to gem files
+
+* Added metadata to gemspec
+
+# 2.0.0
+
+* Added MiniModel.options method for use with options_for_select
+
+* Dropped Ruby 1.8.7 compatibility
+
+# 1.0.0
+
+* Ruby 1.8.7 compatibility
+
+# 0.4.0
+
+* Added MiniModel.keys method
+
+# 0.3.0
+
+* Changed MiniModel.find method to raise exception for non-existent keys
+
+# 0.2.0
+
+* Added MiniModel#to_json method
+
+* Added MiniModel#read_attribute method
+
+# 0.1.0
+
+* First version!

data/LICENSE.txt

@@ -0,0 +1,4 @@
+Copyright (c) 2011-2020 TIMCRAFT
+
+This is an Open Source project licensed under the terms of the LGPLv3 license.
+Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

data/README.md

@@ -0,0 +1,45 @@
+# minimodel
+
+[![Gem Version](https://badge.fury.io/rb/minimodel.svg)](https://badge.fury.io/rb/minimodel) [![Build Status](https://api.travis-ci.org/timcraft/minimodel.svg?branch=master)](https://travis-ci.org/timcraft/minimodel)
+
+
+A little Ruby library for defining little models.
+
+
+## Installation
+
+    $ gem install minimodel
+
+
+## Motivation
+
+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 a database, and that's what minimodel is for.
+
+
+## Example
+
+Here's how you could implement a currency model using minimodel:
+
+```ruby
+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). Similar to ActiveRecord.
+
+There's also a `load_from` class method which will load data from a YAML
+file; useful for when you'd rather store the raw data outside of the class.
+
+Take a look at `spec/*_spec.rb` for more examples. Have fun!

data/lib/minimodel.rb

@@ -26,7 +26,7 @@ class MiniModel
   end
 
   def method_missing(symbol, *args, &block)
-    if @attributes.has_key?(symbol) && args.empty? && block.nil?
+    if @attributes.key?(symbol) && args.empty? && block.nil?
       return @attributes[symbol]
     else
       super symbol, *args, &block
@@ -34,7 +34,7 @@ class MiniModel
   end
 
   def respond_to_missing?(symbol, include_private = false)
-    @attributes.has_key?(symbol)
+    @attributes.key?(symbol)
   end
 
   class DuplicateKeyError < StandardError
@@ -59,6 +59,16 @@ class MiniModel
       @auto_increment = options[:auto_increment] ? 1 : nil
     end
 
+    def keys
+      all.map(&primary_key)
+    end
+
+    def options(text_attribute)
+      all.each_with_object({}) do |model, hash|
+        hash[model.read_attribute(text_attribute)] = model.read_attribute(primary_key)
+      end
+    end
+
     def insert(attributes)
       unless @auto_increment.nil?
         attributes[primary_key] = @auto_increment
@@ -70,15 +80,15 @@ class MiniModel
 
       pkey = object.send(primary_key)
 
-      if index.has_key?(pkey)
+      if index.key?(pkey)
         raise DuplicateKeyError
       end
 
       index[pkey] = object
     end
 
-    def find(key)
-      index[key]
+    def find(primary_key, &block)
+      index.fetch(primary_key, &block)
     end
 
     def load_from(path)

data/minimodel.gemspec

@@ -1,14 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'minimodel'
-  s.version = '0.2.0'
+  s.version = '2.0.1'
+  s.license = 'LGPL-3.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.homepage = 'https://github.com/timcraft/minimodel'
+  s.description = 'A little Ruby 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.files = Dir.glob('lib/**/*.rb') + %w[CHANGES.md LICENSE.txt README.md minimodel.gemspec]
+  s.required_ruby_version = '>= 1.9.3'
   s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/timcraft/minimodel',
+    'source_code_uri' => 'https://github.com/timcraft/minimodel',
+    'bug_tracker_uri' => 'https://github.com/timcraft/minimodel/issues',
+    'changelog_uri' => 'https://github.com/timcraft/minimodel/blob/main/CHANGES.md'
+  }
 end

metadata

@@ -1,76 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: minimodel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 2.0.1
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-11 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &9966180 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-  type: :development
-  prerelease: false
-  version_requirements: *9966180
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &9965800 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-  type: :development
-  prerelease: false
-  version_requirements: *9965800
-description: A little library for defining little models
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies: []
+description: A little Ruby library for defining little models
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/minimodel/associations.rb
+- CHANGES.md
+- LICENSE.txt
+- README.md
 - lib/minimodel.rb
-- spec/colour_spec.rb
-- spec/currency_data.yml
-- spec/currency_spec.rb
-- spec/dutch_education_spec.rb
-- README.txt
-- Rakefile
+- lib/minimodel/associations.rb
 - minimodel.gemspec
-homepage: http://github.com/timcraft/minimodel
-licenses: []
-post_install_message: 
+homepage: https://github.com/timcraft/minimodel
+licenses:
+- LGPL-3.0
+metadata:
+  homepage: https://github.com/timcraft/minimodel
+  source_code_uri: https://github.com/timcraft/minimodel
+  bug_tracker_uri: https://github.com/timcraft/minimodel/issues
+  changelog_uri: https://github.com/timcraft/minimodel/blob/main/CHANGES.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 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
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
 summary: See description
 test_files: []

data/README.txt

@@ -1,27 +0,0 @@
-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

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

data/spec/colour_spec.rb

@@ -1,16 +0,0 @@
-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

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

data/spec/currency_spec.rb

@@ -1,108 +0,0 @@
-require 'minitest/autorun'
-require 'minimodel'
-require 'json'
-
-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 respond_to?(:code) and respond_to?(:name)' do
-    @euro.respond_to?(:code).must_equal true
-    @euro.respond_to?(:name).must_equal true
-  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
-
-  describe '#to_json' do
-    it 'should return a string containing a JSON object' do
-      @euro.to_json.must_equal '{"code":"EUR","name":"Euro"}'
-    end
-  end
-
-  describe '#read_attribute' do
-    it 'should return the value corresponding to the given attribute name' do
-      @euro.read_attribute(:code).must_equal 'EUR'
-      @euro.read_attribute(:name).must_equal '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

@@ -1,137 +0,0 @@
-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