properties 0.1.0 → 0.2.0

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "rspec-cleanup", "~> 1.0.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "facets", "~> 2.9.2"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    facets (2.9.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    rcov (0.9.10-java)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-cleanup (1.0.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    yard (0.6.8)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  facets (~> 2.9.2)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.6.0)
+  rspec-cleanup (~> 1.0.0)
+  yard (~> 0.6.0)

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Niclas Nilsson
+Copyright (c) 2011 Niclas Nilsson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,17 +1,19 @@
 = properties
 
-This gem is about defining and using properties i Ruby.
+Description goes here.
 
-== Note on Patches/Pull Requests
+== Contributing to properties
  
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
 
-Copyright (c) 2010 Niclas Nilsson. See LICENSE for details.
+Copyright (c) 2011 Niclas Nilsson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -1,45 +1,42 @@
+# encoding: utf-8
+
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "properties"
-    gem.summary = %Q{Ruby properties}
-    gem.description = %Q{Properties handling in Ruby}
-    gem.email = "niclas@niclasnilsson.se"
-    gem.homepage = "http://github.com/niclasnilsson/properties"
-    gem.authors = ["Niclas Nilsson"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "properties"
+  gem.homepage = "http://github.com/niclasnilsson/properties"
+  gem.license = "MIT"
+  gem.summary = %Q{Properties with metadata for your classes and objects}
+  gem.description = %Q{Properties with metadata for your classes and objects}
+  gem.email = "niclas@niclasnilsson.se"
+  gem.authors = ["Niclas Nilsson"]
+  # dependencies defined in Gemfile
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "properties #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/properties.rb

@@ -1,65 +1,88 @@
 require 'facets'
-
+ 
 module Properties
   class Property
-    attr_reader :name, :kind
-    
-    def initialize name, kind
+    attr_reader :name, :kind, :is_collection
+   
+    def initialize name, kind, is_collection
       @name = name
       @kind = kind
+      @is_collection = is_collection
     end
   end
-  
-  
 end
-
+ 
 module Properties
   class Value
     attr_reader :property
     attr_accessor :value
-    
+   
     def initialize value, property
       @value = value
       @property = property
     end
   end
 end
-
-
+ 
 module Properties
   class PropertyError < RuntimeError
   end
 end
+ 
+def property name, kind, is_collection = false
+  classname = eval kind.to_s.camelcase
 
-def property name, kind
   @__properties__ ||= {}
-  @__properties__[name] = Properties::Property.new(name, kind)
-  
+  @__properties__[name] = Properties::Property.new(name, kind, is_collection)
+  @is_collection = is_collection
+ 
   def __properties__
-    @__properties__
+   @__properties__
   end
+ 
 
-  
-  self.send :define_method, :__set_value__ do |name, value|
-    @__property_values__ ||= {}
+  if is_collection
+    code = "
+      def #{name}
+        @#{name} ||= []
+        @#{name}
+      end
+    " 
+    eval code
 
-    property = self.class.__properties__[name]
-    
-    c = eval property.kind.to_s.camelcase(true)
-    raise Properties::PropertyError.new("Can't set value (#{value}) to property #{name} since it's not a #{kind}") if not value.kind_of?(c)
-    
-    @__property_values__[name] = Properties::Value.new(value, self.class.__properties__[name])
-  end
-  
-  self.send :define_method, "#{name}=" do |value|
-    __set_value__(name, value)
-  end
+    code = "
+      def #{name}=(values)
+        values ||= []
+        values.each do |value|
+          raise Properties::PropertyError.new(\"Can't set value (\#{value.inspect}) to property #{name} since not all elements are a #{classname}\") if not value.kind_of?(#{classname})
+        end
+
+        @#{name} = values
+      end
+    "
+    eval code
 
-  self.send :define_method, "#{name}" do
-    @__property_values__ ||= {}
-    
-    return nil if @__property_values__[name].nil?
-    @__property_values__[name].value 
+  else
+    code = "
+      def #{name}
+        @#{name}
+      end
+    " 
+    eval code
+
+    code = "
+      def #{name}=(value)
+        raise Properties::PropertyError.new(\"Can't set value (\#{value}.inspect) to property #{name} since it's not a #{classname}\") if not value.kind_of?(#{classname})
+        @#{name} = value
+      end
+    "
+    eval code
   end
   
 end
+ 
+def collection name, kind
+  property name, kind, true
+end
+
+

data/properties.gemspec

@@ -1,55 +1,70 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{properties}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Niclas Nilsson"]
-  s.date = %q{2010-05-07}
-  s.description = %q{Properties handling in Ruby}
+  s.date = %q{2011-09-01}
+  s.description = %q{Properties with metadata for your classes and objects}
   s.email = %q{niclas@niclasnilsson.se}
   s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
+    "LICENSE.txt",
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/properties.rb",
-     "properties.gemspec",
-     "spec/properties_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/properties.rb",
+    "properties.gemspec",
+    "spec/properties_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/niclasnilsson/properties}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Ruby properties}
-  s.test_files = [
-    "spec/properties_spec.rb",
-     "spec/spec_helper.rb"
-  ]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Properties with metadata for your classes and objects}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<rspec-cleanup>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<facets>, ["~> 2.9.2"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<rspec-cleanup>, ["~> 1.0.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<facets>, ["~> 2.9.2"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<rspec-cleanup>, ["~> 1.0.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<facets>, ["~> 2.9.2"])
   end
 end
 

data/spec/properties_spec.rb

@@ -28,6 +28,7 @@ describe "a property" do
       lambda { @person.name = 1 }.should raise_error(Properties::PropertyError)
     end
   end
+
   
   describe "should have a get accessor that" do
     it "returns the value of the property" do
@@ -38,7 +39,114 @@ describe "a property" do
     it "returns nil if property has not been set" do
       Person.new.name.should == nil
     end
+
+  end
+end
+
+describe "a collection property" do
+  cleanup.after_spec
+
+  before do
+    class Computer
+      collection :audio_inputs, :string
+    end
+    @computer = Computer.new
+  end
+
+  it "should be empty by default" do
+    @computer = Computer.new.audio_inputs.should == []
+  end
+
+  it "accepts appending of values" do
+    @computer.audio_inputs << "line in"
+    @computer.audio_inputs << "built-in microphone"
+
+    @computer.audio_inputs.should == ["line in", "built-in microphone"]
+    @computer.audio_inputs.should == ["line in", "built-in microphone"]
+    @computer.audio_inputs()[0].should == "line in"
+    @computer.audio_inputs()[1].should == "built-in microphone"
+  end
+  
+  it "accepts replacing of entire collection" do
+    @computer.audio_inputs << "line in"
+    @computer.audio_inputs << "microphone"
+
+    # Overwrite the entire collection
+    @computer.audio_inputs = ["usb microphone #1", "usb microphone #2"]
+
+    @computer.audio_inputs.should == ["usb microphone #1", "usb microphone #2"]
+  end
+
+  it "convert replacing entire collection with nil to an empty collection" do
+    @computer.audio_inputs << "line in"
+    @computer.audio_inputs.size == 1
+    @computer.audio_inputs = nil
+    @computer.audio_inputs.should == []
+  end
+  
+  it "should reject appending values of wrong type" do
+    pending "This needs to hijack the << method on the object (singleton class) or similar"
+    lambda { @computer.audio_inputs << 1 }.should raise_error(Properties::PropertyError)
+  end
+
+  it "should reject overwrite of entire collection if new collection contains elements of wrong type" do
+    lambda { @computer.audio_inputs = ["line in", 23] }.should raise_error(Properties::PropertyError)
   end
+
 end
 
+describe "nested complex types" do
+
+  cleanup.after_spec
+
+  before do
+    class Partition 
+     property :name, :string
+    end
+
+    class Disk
+     property :name, :string
+     property :gigabytes, :integer
+     collection :partitions, :partition
+    end
+
+
+    class Computer
+      property :name, :string
+      collection :disks, :Disk
+
+    end
+    @computer = Computer.new
+  end
+
+  it "should work on collections" do
+    @computer.name = "My Computer"
+    @computer.disks.should == []
+    disk0 = Disk.new
+    disk0.name = "First disk"
+    disk0.gigabytes = 200
+
+    partition0 = Partition.new
+    partition0.name = "p0"
+    partition1 = Partition.new
+    partition1.name = "p1"
+
+    
+    disk1 = Disk.new
+    disk1.name = "Second disk"
+    disk1.gigabytes = 300
+    disk1.partitions = [ partition0, partition1 ]
+
+
+    @computer.disks = [ disk0, disk1 ]
+
+    @computer.name.should == "My Computer"
+    @computer.disks[0].name.should == "First disk"
+    @computer.disks[0].gigabytes.should == 200
+    @computer.disks[1].name.should == "Second disk"
+    @computer.disks[1].gigabytes.should == 300
+    
+    @computer.disks[1].partitions[0].name.should == "p0"
+  end
+end
 

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
 require 'properties'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
   
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Niclas Nilsson
@@ -14,36 +14,126 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 +02:00
+date: 2011-09-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-cleanup
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: facets
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
         - 2
         - 9
-        version: 1.2.9
+        - 2
+        version: 2.9.2
   type: :development
-  version_requirements: *id001
-description: Properties handling in Ruby
+  prerelease: false
+  version_requirements: *id007
+description: Properties with metadata for your classes and objects
 email: niclas@niclasnilsson.se
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
+- LICENSE.txt
 - README.rdoc
 files: 
 - .document
-- .gitignore
-- LICENSE
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
@@ -54,21 +144,24 @@ files:
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/niclasnilsson/properties
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 674284784327043654
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -78,10 +171,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby properties
-test_files: 
-- spec/properties_spec.rb
-- spec/spec_helper.rb
+summary: Properties with metadata for your classes and objects
+test_files: []
+

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC