modelling 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2012 Ryan Allen, Ian Leitch, John Barton, Mark Turnley, Steve Hodgkiss, FlashDen Pty Ltd
+
+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

@@ -0,0 +1,64 @@
+This module, when included, enforces the typical instantiation pattern
+that accepts a hash of attributes, like so:
+
+  class Car
+    include Modelling
+    attr_accessor :make
+    attr_accessor :model
+  end
+
+  car = Car.new(:make => 'Lotus', :model => 'Elise')
+  car.make  # => 'Lotus'
+  car.model # => 'Elise'
+  
+Additionally you get three meta methods for making your so called domain
+modelling a little more concise, these three methods are:
+
+  * attributes
+  * collections
+  * maps
+  * structs
+
+Attributes simply is an alias for attr_accessor, collections defines accessors
+that are arrays, and maps defines hashes. The constructor ensures that each
+map and collection are initalized as [] and {} respectively by default:
+ 
+  class Car
+    include Modelling
+    attributes :make, :model
+    collections :tyres, :accessories
+    maps :dealer_locations, :telephone_services
+  end
+
+  car = Car.new 
+  car.make               # => nil
+  car.model              # => nil
+  car.tyres              # => []
+  car.accessories        # => []
+  car.dealer_locations   # => {}
+  car.telephone_services # => {}
+
+Structs are as the name suggests, structs. Or more specifically OpenStructs:
+
+  class Car
+    include Modelling
+    structs :features
+  end
+  
+  car.features.abs true
+  car.features.air_con true
+  car.features.valves 8
+
+TODO: WRITE DOCS FOR NEW CUSTOM INITIALIZERS!!!1 (AND UPDATE DOCS ABOVE,
+      THEY ARE LIKE OUT OF DATE OR SOMETHING).
+ i.e.   collections :categories => CategoryCollection
+      and
+        attributes :total => Proc.new { Money.new(0) }
+      and
+        maps :domain => CustomDNSWithHashLookupAwesome
+
+This makes modelling with PORO's [1] more eloquent, and stops us from
+having to write and re-write constructors that accept hashes, as
+is typically done.
+
+[1] http://en.wikipedia.org/wiki/POJO

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/modelling.rb

@@ -0,0 +1,78 @@
+require 'modelling/version'
+require 'ostruct'
+
+module Modelling
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+
+  module ClassMethods
+    def inherited(descendant)
+      descendant.instance_variable_set(:@members, members.dup)
+      super
+    end
+
+    def attributes(*args)
+      generate_accessors_from_args(args, Proc.new { nil })
+    end
+
+    def collections(*args)
+      generate_accessors_from_args(args, Proc.new { Array.new })
+    end
+
+    def maps(*args)
+      generate_accessors_from_args(args, Proc.new { Hash.new })
+    end
+
+    def structs(*args)
+      generate_accessors_from_args(args, Proc.new { OpenStruct.new })
+    end
+
+    def members
+      @members ||= {}
+    end
+
+    private
+
+    def generate_accessors_from_args(args, default_initializer)
+      names_to_initializer = args.last.is_a?(Hash) ? args.pop : {}
+      args.each do |name|
+        names_to_initializer[name] = default_initializer
+      end
+      generate_accessors(names_to_initializer)
+    end
+
+    def generate_accessors(names_to_initializer)
+      names_to_initializer.each do |name, initializer|
+        create_accessor(name)
+        if initializer.is_a?(Proc)
+          members[name] = initializer
+        else
+          members[name] = Proc.new { initializer.new }
+        end
+      end
+    end
+
+    def create_accessor(name)
+      instance_eval { attr_accessor name }
+    end
+
+  end
+
+  def members
+    self.class.members
+  end
+
+  def initialize(args = {})
+    members.each do |accessor, initializer|
+      if initializer.arity > 0
+        send "#{accessor}=", initializer.call(self)
+      else
+        send "#{accessor}=", initializer.call
+      end
+    end
+    args.each { |name, value| send "#{name}=", value }
+  end
+
+end

data/lib/modelling/version.rb

@@ -0,0 +1,3 @@
+module Modelling
+  VERSION = "0.0.1"
+end

data/modelling.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'modelling/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'modelling'
+  s.version     = Modelling::VERSION
+  s.authors     = ['Ryan Allen', 'Steve Hodgkiss', 'Mark Turnley', 'John Barton']
+  s.email       = ['ryan@eden.cc', 'steve@hodgkiss.me', 'ravagedcarrot@gmail.com', 'jrbarton@gmail.com']
+  s.homepage    = 'http://github.com/ryan-allen/modelling'
+  s.summary     = %q{Wraps some common-ish plain-ruby object modelling junk.}
+  s.description = %q{We were doing PORO dev on Rails before it was hip.}
+
+  s.rubyforge_project = 'modelling'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'rspec'
+end

data/spec/modelling_spec.rb

@@ -0,0 +1,153 @@
+require 'bundler'
+Bundler.require
+$: << '.'
+require 'modelling'
+
+class User
+  include Modelling
+  attributes :name, :age
+  collections :fav_colours, :biggest_gripes, :test => lambda { 3 }
+end
+
+class NonSpecificUser < User
+end
+
+class MyArray < Array; end
+class MyHash < Hash; end
+
+class Car
+  include Modelling
+  attributes :name => Proc.new { |car| String.new(car.class.to_s) }
+  collections :doors => MyArray
+end
+
+class SuperCar < Car
+  attributes :bhp => Proc.new { 400 }
+end
+
+class Site
+  include Modelling
+  maps :users => MyHash
+end
+
+class Bike
+  include Modelling
+  attributes :manufacturer
+  maps :stickers
+  structs :features
+end
+
+class LambdaTest
+  include Modelling
+  attributes :lambda => lambda { "boo" }
+end
+
+describe Modelling do
+
+  specify 'user has name' do
+    user = User.new
+    user.name = 'Ryan'
+    user.name.should  eq 'Ryan'
+  end
+
+  specify 'user has age' do
+    user = User.new
+    user.age = 24
+    user.age.should  eq 24
+  end
+
+  specify 'user has fav colours collection' do
+    user = User.new
+    user.fav_colours = [:green, :yellow]
+    user.fav_colours.should  eq [:green, :yellow]
+  end
+
+  specify 'user has biggest gripes collection' do
+    user = User.new
+    user.biggest_gripes = [:mediocrity, :CUB_beer]
+    user.biggest_gripes.should  eq [:mediocrity, :CUB_beer]
+  end
+
+  specify 'attributes are initialized as nil' do
+    user = User.new
+    user.name.should be_nil
+    user.age.should be_nil
+  end
+
+  specify 'collections are initialized as empty array' do
+    user = User.new
+    user.fav_colours.should be_empty
+    user.biggest_gripes.should be_empty
+  end
+
+  it 'can initialize with attributes' do
+    user = User.new(:name => 'Ryan')
+    user.name.should  eq 'Ryan'
+  end
+
+  it 'can initialize with collections' do
+    user = User.new(:biggest_gripes => [:mediocrity, :CUB_beer])
+    user.biggest_gripes.should  eq [:mediocrity, :CUB_beer]
+  end
+
+  specify 'car has doors and all is good' do
+    car = Car.new
+    car.doors.should be_empty
+  end
+
+  specify 'bike does not bunk on having no collection' do
+    bike = Bike.new(:manufacturer => 'Kawasaki')
+    # if nothing is rased, we fixed the bug
+  end
+
+  specify 'bike has map of stickers' do
+    Bike.new.stickers.should be_empty
+  end
+  
+  specify 'cars doors is a my array' do
+    Car.new.doors.should be_instance_of MyArray
+  end
+  
+  specify 'sites users is a my hash' do
+    Site.new.users.should be_instance_of MyHash
+  end
+  
+  it 'can initialize with proc and get reference to new instance' do
+    car = Car.new
+    car.name.should  eq String.new(car.class.to_s)
+  end
+
+  specify 'bike has features' do
+    bike = Bike.new
+    bike.features.should be_instance_of OpenStruct
+  end
+
+  it 'doesnt fail when lambdas with no args are used' do
+    LambdaTest.new.lambda.should  eq 'boo'
+  end
+
+  context 'inheritence' do
+    let(:car) { Car.new }
+    let(:super_car) { SuperCar.new }
+
+    it 'inherits attributes' do
+      super_car.doors.should be_instance_of MyArray
+      super_car.name.should  eq "SuperCar"
+    end
+
+    it 'allows extra attributes' do
+      super_car.bhp.should  eq 400
+    end
+
+    it 'doesnt mess up the super classes members' do
+      car.should_not respond_to(:bhp)
+      car.should respond_to(:doors)
+      car.should respond_to(:name)
+    end
+
+    specify 'non specific user inherits attributes' do
+      user = NonSpecificUser.new(:name => 'Ryan you cocktard')
+      user.name.should  eq 'Ryan you cocktard'
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: modelling
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Allen
+- Steve Hodgkiss
+- Mark Turnley
+- John Barton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: We were doing PORO dev on Rails before it was hip.
+email: 
+- ryan@eden.cc
+- steve@hodgkiss.me
+- ravagedcarrot@gmail.com
+- jrbarton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- lib/modelling.rb
+- lib/modelling/version.rb
+- modelling.gemspec
+- spec/modelling_spec.rb
+homepage: http://github.com/ryan-allen/modelling
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: modelling
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Wraps some common-ish plain-ruby object modelling junk.
+test_files: 
+- spec/modelling_spec.rb