value 0.2.0 → 1.0.0

data/Rakefile

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-require 'inventory/rake/tasks'
-require 'lookout/rake/tasks'
+require 'inventory/rake/tasks-1.0'
+require 'lookout/rake/tasks-3.0'
 
 $:.unshift File.expand_path('../lib', __FILE__)
 require 'value/version'
@@ -11,9 +11,10 @@ Inventory::Rake::Tasks.define Value::Version, :gem => proc{ |_, s|
   s.email = 'now@bitwi.se'
   s.homepage = 'https://github.com/now/value'
 
+  s.add_development_dependency 'lookout', '~> 3.0'
   s.add_development_dependency 'yard', '~> 0.7.0'
 
-  s.add_runtime_dependency 'inventory', '~> 0.2.0'
+  s.add_runtime_dependency 'inventory', '~> 1.0'
 }
 
 # TODO: Silence warnings generated from YARD (remove this once we plug them)

data/lib/value/version.rb

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 
-require 'inventory'
+require 'inventory-1.0'
 
 module Value
-  Version = Inventory.new(0, 2, 0){
+  Version = Inventory.new(1, 0, 0){
     def libs
       %w'
         value/comparable.rb
@@ -14,7 +14,7 @@ module Value
     def additional_libs
       super +
         %w'
-          value/yard.rb
+          value/yard-1.0.rb
         '
     end
   }

data/lib/value/{yard.rb → yard-1.0.rb}

@@ -10,18 +10,20 @@ class YARD::Handlers::Ruby::ValuesHandler < YARD::Handlers::Ruby::Base
     parameters = statement.parameters(false)
     if YARD::Parser::Ruby::AstNode === parameters[-1][0] and
         parameters[-1][0].type == :assoc and
-        parameters[-1].jump(:ident).source == 'comparable'
+        comparable = parameters[-1].find{ |e| e.jump(:ident).source == 'comparable' }
       parameters.pop
+      comparables = (comparable[1].type == :array and comparable[1][0].map{ |e| e.jump(:ident).source })
       ancestor 'Comparable'
       ancestor 'Value::Comparable'
     end
     ancestor 'Value'
-    define('initialize', parameters.map{ |e| [e.jump(:ident).source, e.type == :array ? e[0][1].source : nil] }).
-      docstring.tags(:param).select{ |e| e.text and not e.text.empty? }.each do |e|
+    initialize = define('initialize', parameters.map{ |e| [e.jump(:ident).source, e.type == :array ? e[0][1].source : nil] })
+    initialize.docstring.tags(:param).select{ |e| e.text and not e.text.empty? }.each do |e|
         define e.name.sub(/\A[&*]/, ''), [],
-               '@return [%s] %s' % [e.types.join(', '), e.text], :protected
+               '@return [%s] %s' % [e.types ? e.types.join(', ') : '', e.text], :protected
         e.text = ''
       end
+    initialize.docstring.add_tag(YARD::Tags::Tag.new(:note, 'Comparisons between instances are made between %s.' % join(comparables))) if comparables
   end
 
   def ancestor(name)
@@ -42,6 +44,12 @@ class YARD::Handlers::Ruby::ValuesHandler < YARD::Handlers::Ruby::Base
       m.visibility = visibility
     }
   end
+
+  def join(items)
+    return items.join('') if items.size < 2
+    return items.join(' and ') if items.size < 3
+    return '%s, and %s' % [items[0..-2].join(', '), items[-1]]
+  end
 end
 
 YARD::Handlers::Ruby::MacroHandler::IGNORE_METHODS['Value'] = true

data/test/unit/value/{yard.rb → yard-1.0.rb}

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-require 'value/yard'
+require 'value/yard-1.0'
 
 Expectations do
   expect [YARD::CodeObjects::Proxy.new(:root, 'Value')] do
@@ -104,7 +104,7 @@ class A
   Value(:a, :comparable => true)
 end
 EOS
-  YARD::Registry.at('A').inheritance_tree(true)[1..3].map(&:path)
+    YARD::Registry.at('A').inheritance_tree(true)[1..3].map(&:path)
   end
 
   expect %w'Value Value::Comparable Comparable' do
@@ -121,6 +121,46 @@ class B
   Value(:a, :b, :comparable => true)
 end
 EOS
-  YARD::Registry.at('B').inheritance_tree(true)[1..3].map(&:path)
+    YARD::Registry.at('B').inheritance_tree(true)[1..3].map(&:path)
+  end
+
+  expect 'Comparisons between instances are made between a.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # This is A.
+  # @param [String] a
+  # @param [String] b
+  Value(:a, :b, :other => true, :comparable => [:a])
+end
+EOS
+    YARD::Registry.at('A#initialize').docstring.tag(:note).text
+  end
+
+  expect 'Comparisons between instances are made between a and b.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @param [String] a
+  # @param [String] b
+  # @param [String] c
+  Value(:a, :b, :c, :comparable => [:a, :b])
+end
+EOS
+    YARD::Registry.at('A#initialize').docstring.tag(:note).text
+  end
+
+  expect 'Comparisons between instances are made between a, b, and c.' do
+    YARD::Registry.clear
+    YARD::Parser::SourceParser.parse_string(<<EOS)
+class A
+  # @param [String] a
+  # @param [String] b
+  # @param [String] c
+  # @param [String] d
+  Value(:a, :b, :c, :d, :comparable => [:a, :b, :c])
+end
+EOS
+    YARD::Registry.at('A#initialize').docstring.tag(:note).text
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: value
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-23 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lookout
+  requirement: &14302368 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *14302368
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152363560 !ruby/object:Gem::Requirement
+  requirement: &14303892 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,18 +32,18 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2152363560
+  version_requirements: *14303892
 - !ruby/object:Gem::Dependency
   name: inventory
-  requirement: &2152363060 !ruby/object:Gem::Requirement
+  requirement: &13859280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152363060
+  version_requirements: *13859280
 description: ! "                                     Value\n\n  Value is a library
   for defining value objects in Ruby.\n"
 email: now@bitwi.se
@@ -42,18 +53,19 @@ extra_rdoc_files: []
 files:
 - lib/value/comparable.rb
 - lib/value/values.rb
-- lib/value.rb
+- lib/value-1.0.rb
 - lib/value/version.rb
-- lib/value/yard.rb
+- lib/value/yard-1.0.rb
 - test/unit/value/comparable.rb
 - test/unit/value/values.rb
-- test/unit/value.rb
+- test/unit/value-1.0.rb
 - test/unit/value/version.rb
-- test/unit/value/yard.rb
+- test/unit/value/yard-1.0.rb
 - README
 - Rakefile
 homepage: https://github.com/now/value
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -72,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Value is a library for defining value objects in Ruby.
 test_files: []