mince_model 0.1.0

data/lib/mince_model.rb

@@ -0,0 +1,103 @@
+require 'active_support'
+require 'active_model'
+require 'active_support/core_ext/module/delegation'
+
+require "mince_model/version"
+
+
+module MinceModel
+  extend ActiveSupport::Concern
+
+  included do
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    attr_accessor :id
+  end
+
+  module ClassMethods
+    def data_model(model=nil)
+      @data_model = model if model
+      @data_model
+    end
+
+    def all
+      data_model.all.map{|a| new a }
+    end
+
+    def find(id)
+      a = data_model.find(id)
+      new a if a
+    end
+
+    def field(field_name, options={})
+      if options[:assignable]
+        add_assignable_field(field_name)
+      else
+        add_readonly_field(field_name)
+      end
+    end
+
+    def add_readonly_field(field_name)
+      fields << field_name
+      readonly_fields << field_name
+      attr_reader field_name
+    end
+
+    def add_assignable_field(field_name)
+      fields << field_name
+      assignable_fields << field_name
+      attr_accessor field_name
+    end
+
+    def fields(*field_names)
+      @fields ||= []
+      field_names.each {|field_name| field(field_name) }
+      @fields
+    end
+
+    def assignable_fields
+      @assignable_fields ||= []
+    end
+
+    def readonly_fields
+      @readonly_fields ||= []
+    end
+  end
+
+  delegate :data_model, :assignable_fields, :readonly_fields, :fields, to: 'self.class'
+
+  def initialize(hash={})
+    @id = hash[:id]
+    readonly_fields.each do |field_name|
+      self.instance_variable_set("@#{field_name}", hash[field_name]) if hash[field_name]
+    end
+    self.attributes = hash
+  end
+
+  def persisted?
+    !!id
+  end
+
+  def save
+    ensure_no_extra_fields
+    if persisted?
+      data_model.update(self)
+    else
+      @id = data_model.store(self)
+    end
+  end
+
+  def ensure_no_extra_fields
+    extra_fields = (fields - data_model.data_fields)
+    if extra_fields.any?
+      raise "Tried to save a #{self.class.name} with fields not specified in #{data_model.name}: #{extra_fields.join(', ')}"
+    end
+  end
+
+  def attributes=(hash={})
+    assignable_fields.each do |field|
+      send("#{field}=", hash[field]) if hash[field]
+    end
+  end
+end

data/lib/mince_model/version.rb

@@ -0,0 +1,3 @@
+module MinceModel
+  VERSION = "0.1.0"
+end

data/spec/lib/mince_model_spec.rb

@@ -0,0 +1,128 @@
+require_relative '../../lib/mince_model'
+
+describe MinceModel do
+  let(:klass) do
+    Class.new do
+      include MinceModel
+
+      data_model Class.new
+
+      field :meh
+      field :foo, assignable: true
+      field :bar, assignable: false
+      fields :baz, :qaaz
+    end
+  end
+
+  let(:meh) { mock 'meh' }
+  let(:foo) { mock 'foo' }
+  let(:bar) { mock 'bar' }
+  let(:baz) { mock 'baz' }
+  let(:qaaz) { mock 'qaaz' }
+
+  subject { klass.new(meh: meh, foo: foo, bar: bar, baz: baz, qaaz: qaaz) }
+
+  it 'initializes the object and assigns values to the fields' do
+    subject.meh.should == meh
+    subject.foo.should == foo
+    subject.bar.should == bar
+    subject.baz.should == baz
+    subject.qaaz.should == qaaz
+  end
+
+  it 'can set the assignable fields outside of the initilizer' do
+    subject.foo = 'foo1'
+    subject.foo.should == 'foo1'
+    subject.attributes = { foo: 'foo2' }
+    subject.foo.should == 'foo2'
+  end
+
+  it 'cannot set the readonly field outside of the initilizer' do
+    subject.attributes = { bar: 'bar1' }
+    subject.bar.should == bar
+  end
+
+  it 'fields are readonly by default' do
+    subject.attributes = { meh: 'meh1' }
+    subject.meh.should == meh
+  end
+
+  describe 'saving' do
+    let(:id) { mock 'id' }
+    let(:data_fields) { subject.fields }
+
+    before do
+      subject.data_model.stub(:data_fields).and_return(data_fields)
+    end
+
+    context 'when the model has fields that are not defined in the data model' do
+      let(:data_fields) { subject.fields - extra_fields }
+      let(:extra_fields) { subject.fields[0..-2] }
+
+      it 'raises an exception with a message' do
+        expect { subject.save }.to raise_error("Tried to save a #{subject.class.name} with fields not specified in #{subject.data_model.name}: #{extra_fields.join(', ')}")
+      end
+    end
+
+    context 'when it has not yet been persisted to the mince data model' do
+      before do
+        subject.data_model.stub(:store => id)
+      end
+
+      it 'stores the model' do
+        subject.data_model.should_receive(:store).with(subject).and_return(id)
+
+        subject.save
+      end
+
+      it 'assigns the id' do
+        subject.save
+
+        subject.id.should == id
+      end
+    end
+
+    context 'when it has already been persisted to the mince data model' do
+      let(:subject) { klass.new(id: id) }
+
+      it 'updates the model' do
+        subject.data_model.should_receive(:update).with(subject)
+
+        subject.save
+      end
+    end
+  end
+
+  describe "Query Methods:" do
+    describe 'finding a model by id' do
+      subject { klass.find(id) }
+
+      let(:id) { mock 'id' }
+
+      before do
+        klass.data_model.stub(:find).with(id).and_return(data)
+      end
+
+      context 'when it exists' do
+        let(:data) { mock 'data' }
+        let(:model) { mock 'model' }
+
+        before do
+          klass.stub(:new).with(data).and_return(model)
+        end
+
+        it 'returns the model' do
+          subject.should == model
+        end
+      end
+
+      context 'when it does not exist' do
+        let(:data) { nil }
+
+        it 'returns nothing' do
+          subject.should be_nil
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mince_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Simpson
+- Craig Buchek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: Common model behavior for objects backed by Mince
+email:
+- matt.simpson3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mince_model.rb
+- lib/mince_model/version.rb
+- spec/lib/mince_model_spec.rb
+homepage: http://github.com/ionicmobile/mince_model
+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.24
+signing_key: 
+specification_version: 3
+summary: Common model behavior for objects backed by Mince
+test_files:
+- spec/lib/mince_model_spec.rb
+has_rdoc: