yard-value 1.2.2 → 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff5e5cc3611bfd389ce635834c0ed77fd047935a
+  data.tar.gz: 585231da575f4f426e660b3431a31459a827e0be
+SHA512:
+  metadata.gz: b0f79fbddf992ff1f4b6c6b64942054018c41156fca9af20aa167957cfc1e945c71fc0867811d14419133ede4ee9007f5744807b128192d2e101c7291de6abfe
+  data.tar.gz: dc87668977831c0033fba5798ddad12d2542ce75587fb12d68936343aed00f37cb33b1f8ee1f30079b3bc90885af950fc170f33895b4f2e05664abd31d8eab3b

data/README

@@ -1,5 +1,112 @@
                                   YARD-Value
 
-  YARD-Value provides YARD handlers for Value¹ objects.
+  YARD-Value provides YARD¹ handlers for Value² objects.  It’ll document
+  whether the Value is Comparable and what attributes are used in such
+  comparisons, its #initialize method, and its protected accessors.
 
-¹ Check out the Value library at http://disu.se/software/value
+¹ See http://yardoc.org/
+² See http://disu.se/software/value/
+
+  You add the documentation to the Module#Value invocation.  Any ‹@param› tags
+  are used both for the parameters to the #initialize method and for the
+  protected accessors.
+
+  This
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x
+      # @param [Integer] y
+      Value :x, :y
+    end
+
+  generates documentation similar to
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x
+      # @param [Integer] y
+      def initialize(x, y)
+    end
+
+  and this
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x The x coordinate of the receiver
+      # @param [Integer] y The y coordinate of the receiver
+      Value :x, :y
+    end
+
+   generates documentation similar to
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x
+      # @param [Integer] y
+      def initialize(x, y)
+
+      protected
+
+      # @return [Integer] The x coordinate of the receiver
+      attr_reader :x
+
+      # @return [Integer] The y coordinate of the receiver
+      attr_reader :y
+    end
+
+  For comparable Values, a note is added about what attributes are used in the
+  comparison.  This
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x
+      # @param [Integer] y
+      Value :x, :y, :comparable => true
+    end
+
+  is similar to
+
+    class Point
+      # A point on a plane.
+      # @param [Integer] x
+      # @param [Integer] y
+      # @note Comparisons between instances are made between x and y.
+      def initialize(x, y)
+    end
+
+§ Usage
+
+    Add ‹--plugin yard-value-1.0› to your YARD command line.  If you’re
+    using Inventory-Rake-Tasks-YARD¹, add the following to your Rakefile:
+
+      Inventory::Rake::Tasks::YARD.new do |t|
+        t.options += %w'--plugin yard-value-1.0'
+      end
+
+¹ See http://disu.se/software/inventory-rake-tasks-yard/
+
+§ Financing
+
+    Currently, most of my time is spent at my day job and in my rather busy
+    private life.  Please motivate me to spend time on this piece of software
+    by donating some of your money to this project.  Yeah, I realize that
+    requesting money to develop software is a bit, well, capitalistic of me.
+    But please realize that I live in a capitalistic society and I need money
+    to have other people give me the things that I need to continue living
+    under the rules of said society.  So, if you feel that this piece of
+    software has helped you out enough to warrant a reward, please PayPal a
+    donation to now@disu.se¹.  Thanks!  Your support won’t go unnoticed!
+
+¹ Send a donation:
+  https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now%40disu%2ese&item_name=Nikolai%20Weibull%20Software%20Services
+
+§ Reporting Bugs
+
+    Please report any bugs that you encounter to the {issue tracker}¹.
+
+  ¹ See https://github.com/now/yard-value/issues
+
+§ Authors
+
+    Nikolai Weibull wrote the code, the tests, and this README.

data/Rakefile

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
-require 'inventory/rake-1.0'
+require 'inventory-rake-1.0'
 
-load File.expand_path('../lib/yard-value/version.rb', __FILE__)
+load File.expand_path('../lib/yard-value-1.0/version.rb', __FILE__)
 
 Inventory::Rake::Tasks.define YARDValue::Version, :gem => proc{ |_, s|
   s.author = 'Nikolai Weibull'
@@ -11,7 +11,7 @@ Inventory::Rake::Tasks.define YARDValue::Version, :gem => proc{ |_, s|
 }
 
 Inventory::Rake::Tasks.unless_installing_dependencies do
-  require 'lookout/rake-3.0'
+  require 'lookout-rake-3.0'
   # TODO: Silence warnings generated from YARD (remove this once we plug them)
   Lookout::Rake::Tasks::Test.new :options => []
 end

data/lib/yard-value-1.0.rb

@@ -2,7 +2,7 @@
 
 # Namespace for YARD extensions for Value.
 module YARDValue
-  load File.expand_path('../yard-value/version.rb', __FILE__)
+  load File.expand_path('../yard-value-1.0/version.rb', __FILE__)
   Version.load
 end
 
@@ -46,7 +46,7 @@ class YARD::Handlers::Ruby::ValuesHandler < YARD::Handlers::Ruby::Base
   def define(name, parameters, docstring = nil, visibility = :public)
     YARD::CodeObjects::MethodObject.new(namespace, name).tap{ |m|
       register m
-      register_docstring m, docstring, nil if docstring
+      register_docstring m, docstring if docstring
       m.signature = 'def %s%s' %
         [name,
          parameters.empty? ?

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

@@ -3,10 +3,10 @@
 require 'inventory-1.0'
 
 module YARDValue
-  Version = Inventory.new(1, 2, 2){
+  Version = Inventory.new(1, 2, 3){
     def dependencies
       super + Inventory::Dependencies.new{
-        development 'inventory-rake', 1, 3, 0
+        development 'inventory-rake', 1, 4, 0
         development 'lookout', 3, 0, 0
         development 'lookout-rake', 3, 0, 0
         runtime 'yard', 0, 8, 0, :feature => 'yard'

metadata

@@ -1,82 +1,207 @@
 --- !ruby/object:Gem::Specification
 name: yard-value
 version: !ruby/object:Gem::Version
-  version: 1.2.2
-  prerelease: 
+  version: 1.2.3
 platform: ruby
 authors:
 - Nikolai Weibull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inventory
-  requirement: &15273456 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *15273456
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: inventory-rake
-  requirement: &15289392 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *15289392
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: lookout
-  requirement: &15288876 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *15288876
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: lookout-rake
-  requirement: &15288480 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *15288480
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15287940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *15287940
-description: ! "                                  YARD-Value\n\n  YARD-Value provides
-  YARD handlers for Value¹ objects.\n\n¹ Check out the Value library at http://disu.se/software/value\n"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: |2
+                                    YARD-Value
+
+    YARD-Value provides YARD¹ handlers for Value² objects.  It’ll document
+    whether the Value is Comparable and what attributes are used in such
+    comparisons, its #initialize method, and its protected accessors.
+
+  ¹ See http://yardoc.org/
+  ² See http://disu.se/software/value/
+
+    You add the documentation to the Module#Value invocation.  Any ‹@param› tags
+    are used both for the parameters to the #initialize method and for the
+    protected accessors.
+
+    This
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x
+        # @param [Integer] y
+        Value :x, :y
+      end
+
+    generates documentation similar to
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x
+        # @param [Integer] y
+        def initialize(x, y)
+      end
+
+    and this
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x The x coordinate of the receiver
+        # @param [Integer] y The y coordinate of the receiver
+        Value :x, :y
+      end
+
+     generates documentation similar to
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x
+        # @param [Integer] y
+        def initialize(x, y)
+
+        protected
+
+        # @return [Integer] The x coordinate of the receiver
+        attr_reader :x
+
+        # @return [Integer] The y coordinate of the receiver
+        attr_reader :y
+      end
+
+    For comparable Values, a note is added about what attributes are used in the
+    comparison.  This
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x
+        # @param [Integer] y
+        Value :x, :y, :comparable => true
+      end
+
+    is similar to
+
+      class Point
+        # A point on a plane.
+        # @param [Integer] x
+        # @param [Integer] y
+        # @note Comparisons between instances are made between x and y.
+        def initialize(x, y)
+      end
+
+  § Usage
+
+      Add ‹--plugin yard-value-1.0› to your YARD command line.  If you’re
+      using Inventory-Rake-Tasks-YARD¹, add the following to your Rakefile:
+
+        Inventory::Rake::Tasks::YARD.new do |t|
+          t.options += %w'--plugin yard-value-1.0'
+        end
+
+  ¹ See http://disu.se/software/inventory-rake-tasks-yard/
+
+  § Financing
+
+      Currently, most of my time is spent at my day job and in my rather busy
+      private life.  Please motivate me to spend time on this piece of software
+      by donating some of your money to this project.  Yeah, I realize that
+      requesting money to develop software is a bit, well, capitalistic of me.
+      But please realize that I live in a capitalistic society and I need money
+      to have other people give me the things that I need to continue living
+      under the rules of said society.  So, if you feel that this piece of
+      software has helped you out enough to warrant a reward, please PayPal a
+      donation to now@disu.se¹.  Thanks!  Your support won’t go unnoticed!
+
+  ¹ Send a donation:
+    https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now%40disu%2ese&item_name=Nikolai%20Weibull%20Software%20Services
+
+  § Reporting Bugs
+
+      Please report any bugs that you encounter to the {issue tracker}¹.
+
+    ¹ See https://github.com/now/yard-value/issues
+
+  § Authors
+
+      Nikolai Weibull wrote the code, the tests, and this README.
 email: now@bitwi.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/yard-value-1.0.rb
-- lib/yard-value/version.rb
+- lib/yard-value-1.0/version.rb
 - test/unit/yard-value-1.0.rb
-- test/unit/yard-value/version.rb
+- test/unit/yard-value-1.0/version.rb
 - README
 - Rakefile
 homepage: https://github.com/now/yard-value
@@ -87,21 +212,19 @@ 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.10
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: YARD-Value provides YARD handlers for Value¹ objects.
+summary: YARD-Value provides YARD¹ handlers for Value² objects.
 test_files: []