array_model 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8154f70dc3b07a528b040dc52dffc2338ac6674
+  data.tar.gz: 7846ddf345a00a22c32a230e130c58a25dd1037b
+SHA512:
+  metadata.gz: 27a9274b534907d5410266ed4b02649dd4962cea3a4008bf6690554d483145afae3d9efb9faed9de354a67b2a293d96223054c8f8e7ee32aed61a2a8740dff16
+  data.tar.gz: a63d838fbf6997d6f632755aaeaf0e6c9f0742a22b378ff42b78b93b3a43cab5728a814e7fe912407e25351aa32400e3f9c2160409bc09965b4e6c967b06cd64

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in array_model.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Reed
+
+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,27 @@
+# ArrayModel
+
+ArrayModel is a class to create ActiveRecord / Sequel style models from simple arrays and hashes. This is useful for integrating simple reference data into an application without having to create many small tables that will never change.
+
+As data should be never change while the application is running, the model objects that are created are read only. The data can come either from a constant in the ruby script itself, or from the filesystem as a YAML or JSON file.
+
+## Usage
+
+Example:
+
+    USERS = [
+        { name: 'Nathan', year: 1984 }, 
+        { name: 'Dave', year: 1987 }
+    ]
+
+    class User < ArrayModel
+        model_data USERS
+        attr_model_reader :name
+        attr_model_reader :year
+
+        def age
+            Time.now.year - year
+        end
+    end
+
+    User[0].age # => 32
+    User[1].name # => "Dave"

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/array_model.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'array_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "array_model"
+  spec.version       = ArrayModel::VERSION
+  spec.authors       = ["Nathan Reed"]
+  spec.email         = ["reednj@gmail.com"]
+
+  spec.summary       = %q{an ActiveRecord/Sequel style class for static reference data}
+  spec.homepage      = "https://github.com/reednj/array_model"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "array_model"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/array_model/version.rb

@@ -0,0 +1,3 @@
+class ArrayModel
+  VERSION = "1.0.1"
+end

data/lib/array_model.rb

@@ -0,0 +1,168 @@
+require "array_model/version"
+
+#
+# ArrayModel
+#
+# This is used as a base class to create ActiveRecord / Sequel style models from
+# simple arrays and hashes. This is useful for integrating simple reference data 
+# into an ActiveRecord model without having to create many small tables that will never
+# change.
+#
+# This data should be never change while the application is running, so the model objects
+# that are created are read only. The data can come either from a constant in the ruby
+# script itself, or from the filesystem as a YAML or JSON file.
+#
+# Example:
+#
+# 	USERS = [
+# 		{ name: 'Nathan', year: 1984 }, 
+# 		{ name: 'Dave', year: 1987 }
+# 	]
+#
+#	class User < ArrayModel
+#		model_data USERS
+#		attr_model_reader :name
+#		attr_model_reader :year
+#
+#		def age
+#			Time.now.year - year
+#		end
+#	end
+#
+# 	User[0].age # => 32
+# 	User[1].name # => "Dave"
+#
+class ArrayModel
+	# get the object with the key :k:
+	#
+	# By default :k: will be a simple array index, but it can be changed to
+	# any field by using the :primary_key option when calling :model_data:
+	# when the class is defined
+	#
+	#		Users['reednj'] # => #<Users:0x007fe693866808>
+	#
+	def self.[](k)
+		if @data_key.nil?
+			item_data = @data[k.to_i]
+		else
+			# if a key has been specified, then find the first matching
+			# record. It would be faster to convert it to a hash, but since the
+			# number of records should be small, this should do for now
+			item_data = @data.select{|a| a[@data_key] == k }.first
+		end
+
+		return nil if item_data.nil?
+		return self.new(item_data)
+	end
+
+	# returns an array of all the data in the model. The array will contain
+	# objects of the appropriate type (not raw hashes)
+	def self.all
+		if @data.is_a? Array
+			@all_records ||= @data.map { |v| self.new(v) }
+		else
+			raise "ArrayModel does not support #{@data.class} as data source"
+		end		
+	end
+
+	# an alias for the values method to return a raw value from the data
+	# hash for a given model object. The attr_reader methods should be 
+	# prefered to accessing the hash directly, but this can be useful
+	# in certain cases
+	#
+	#		u = Users['reednj']
+	#		u.username 			# => 'reednj'
+	#		u.values(:username) # => 'reednj'
+	#		u[:username] 		# => 'reednj'
+	#
+	def [](k)
+		values[k]
+	end
+
+	# returns the raw Hash that provides the data for the model
+	# object
+	#
+	#		Users['reednj'].values # => {:username => 'reednj', ...}
+	#
+	def values
+		@item_data
+	end
+
+	# create a new model object from a given hash. This should never 
+	# need to be called directly - the class methods should be used
+	# to get model objects from the dataset
+	def initialize(item_data)
+		item_data.is_a! Hash, 'item_data'
+		@item_data = item_data
+	end
+
+	# Adds attr_reader methods to the class for a given field
+	# in the data hash. The :key: option can be used to set the name
+	# of the key in the hash, if it doesn't have the same name as the
+	# method
+	#
+	#		class Users < ArrayModel
+	#			...
+	#			attr_model_reader :username
+	#			attr_model_reader :user_id, :key => :userId
+	#			...
+	#		end
+	#
+	def self.attr_model_reader(name, options = {})
+		define_method name.to_sym do
+			values[(options[:key] || name).to_sym]
+		end
+	end
+
+	# like :attr_model_reader:, but mulitple readers can be added at
+	# once. No options can be passed when using this method to add
+	# the readers
+	#
+	#		class Users < ArrayModel
+	#			...
+	#			attr_model_readers [:username, :user_id]
+	#			...
+	#		end
+	#
+	def self.attr_model_readers(keys)
+		keys.each {|k| attr_model_reader k }
+	end
+
+	# add the model data to the model class. This data should be
+	# in the from of an array of hashes.
+	#
+	# The array model is designed to handle static reference data, so the data
+	# should not change while the application is running. It can come either from
+	# a constant hard coded into the ruby file, or from a json or yaml file on
+	# the filesystem.
+	#
+	# The :primary_key option can be used to index the data by a particular field
+	# in the hash when it is accessed later via the subscript operator. If this option
+	# is ommited then the data will be accessable simply by the array index 
+	#
+	#		class Users < ArrayModel
+	#			# USER_LIST is a const containing an array of hashes
+	#			model_data USER_LIST, :primary_key => :username
+	#			...
+	#		end
+	#	
+	def self.model_data(data, options = nil)
+		options ||= {}
+		data.is_a! Array, 'data'
+
+		@data_key = options[:primary_key]
+		@data = data	
+	end
+end
+
+class Object
+	def is_a!(t, name = nil)
+		if !is_a? t
+			if name.nil?
+				raise "expected #{t} but got #{self.class}"
+			else
+				raise "#{name} requires #{t} but got #{self.class}"
+			end
+		end
+	end
+end

data/test/array_model_test.rb

@@ -0,0 +1,80 @@
+require 'array_model'
+require 'minitest/autorun'
+
+USER_DATA = [
+	{ :username => 'reednj', :name => 'Nathan', :age => 31 },
+	{ :username => 'dmate', :name => 'Dave', :age => 29 },
+	{ :username => 'rkon', :name => 'Rachel', :age => 25 },
+	{ :username => 'zhena', :name => 'Lucy', :age => 19 },
+	{ :username => 'j77', :name => 'Peter', :age => 16 }
+]
+
+class Users < ArrayModel
+	model_data USER_DATA
+	attr_model_reader :username
+	attr_model_reader :age
+
+	def adult?
+		self.age >= 18
+	end
+end
+
+class KeyUsers < ArrayModel
+	model_data USER_DATA, :primary_key => :username
+	attr_model_reader :username
+	attr_model_reader :age
+end
+
+class AttrUsers < ArrayModel
+	model_data USER_DATA, :primary_key => :username
+	attr_model_reader :first_name, :key => :name
+	attr_model_readers [:username, :age]
+end
+
+class ArrayModelTest < Minitest::Test
+	def test_can_select_by_index
+		assert USER_DATA.first == Users.all.first.values, 'first item does not match'
+		assert USER_DATA[1] == Users[1].values, 'second item does not match'
+	end
+
+	def test_can_access_attributes_by_name
+		u = Users.all.first
+		assert u.username.is_a?(String), 'could not get value from model instance'
+		assert u.username == u[:username], 'subscript does not match method value'
+		assert u.username == USER_DATA[0][:username], 'field value does not match'
+	end
+
+	def test_extension_methods_work
+		u = Users.all.select{|u| u.username == 'j77' }.first
+		assert u.adult? == u.age >= 18, 'extension method gave unexpected result'
+
+		u = Users.all.first
+		assert u.adult? == u.age >= 18, 'extension method gave unexpected result'
+	end
+
+	def test_index_by_key_works
+		username = 'rkon'
+		u = KeyUsers['rkon']
+		t = USER_DATA.select{|a| a[:username] == username }.first
+
+		assert !u.nil?, 'expected record, but got nil'
+		assert u.username == t[:username], 'incorrect record selected, field does not match'
+		assert KeyUsers['randommm'].nil?, 'non-existant key should return nil'
+		assert KeyUsers[0].nil?, 'non-existant integer key should return nil'
+	end
+
+	def test_mulitple_attrs_created
+		u = AttrUsers['zhena']
+		assert !u.nil?, 'unexpected nil record'
+		assert !u.username.nil?, 'unexpected nil value (username)'
+		assert u.age.is_a?(Fixnum), 'unexpected value type (age)'
+	end
+
+	def test_alternative_attr_name
+		u = AttrUsers['zhena']
+		assert !u.nil?, 'unexpected nil record'
+		assert !u.first_name.nil?, 'unexpected nil value (first_name)'
+		assert u.first_name == u[:name], 'method does not match backing field'
+	end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: array_model
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nathan Reed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- reednj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- array_model.gemspec
+- bin/console
+- bin/setup
+- lib/array_model.rb
+- lib/array_model/version.rb
+- test/array_model_test.rb
+homepage: https://github.com/reednj/array_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: an ActiveRecord/Sequel style class for static reference data
+test_files:
+- test/array_model_test.rb