gday 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a15ca0f84f022273a4150a8ee24d9822da3a42ed
-  data.tar.gz: 8f6f426cff2fb201245bfb389d6ae0863bf07ffd
+  metadata.gz: 926a5cbd300b31f6a0fa2757ceb6a970593020b2
+  data.tar.gz: ef338bb7194627ac04a6535930a02e73f4191ae1
 SHA512:
-  metadata.gz: d552176ed0f50bcd27653e2de7b98874544d39825ff8ad3182d4e9697b771a5dc600a7a9490333fec7af7d1c1e3c51c4722e0b05b18dc4826f8d522c2443f1b9
-  data.tar.gz: 56b1c649bf95aadfa6b9264033af061b59e4fefc2e43eeac9abecd4a34ed9aa523fd3d14c054525510abe0ac25bc620c339a9a1489aea2ab2ff69c0b8d1b99b7
+  metadata.gz: 11fa975b0b53a998287fa1a92ae66c9f80891341c4a9c65b27306d359ba62479622ffd25e327ca1e9e572f35f9567cb3636ca76175fa69a709ea24192f25d46b
+  data.tar.gz: 775c6b5b2cdd75910fe3cfdb2ecd01c8e2c645273232811ac7429e918c87a46a70feba3209dcbd61f0bfb81a012167dfeb9c29621f7ca6df259229468546bfe9

data/.gitignore

@@ -8,7 +8,9 @@ InstalledFiles
 _yardoc
 coverage
 doc/
+doc_coverage
 lib/bundler/man
+measurements
 pkg
 rdoc
 spec/reports

data/.yardopts

@@ -0,0 +1 @@
+- TODO.md

data/Rakefile

@@ -1 +1,31 @@
 require "bundler/gem_tasks"
+
+# Generate documentation
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  #t.files   = ['lib/**/*.rb', 'OTHER_PATHS']   # optional
+  #t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+# Run documentation tasks
+task :doc => :yard
+
+# Measure documentation coverage
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
+  # Changed this from default measurements directory
+  measurement.output = 'doc_coverage/report.txt'
+end
+
+# Verify documentation coverage
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 100
+end
+
+# Ensure documentation coverage report is in sync when verify coverage
+task :verify_measurements => :yardstick_measure
+
+# Add verify documentation task for developement only
+# TODO: add development dependancy
+task :doc => :verify_measurements

data/TODO.md

@@ -0,0 +1,3 @@
+## TODO List
+
+* Add documentation for gem version 0.0.1

data/gday.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yardstick"
+  spec.add_development_dependency "backports"
 end

data/lib/gday.rb

@@ -1,11 +1,31 @@
 require_relative "gday/version"
 
+# The Gday module is the main container for the gday gem.
 module Gday
+  # The Greetings class provides greetings in Aussie.
   class Greeting
+    # Saying Hello in Aussie
+    #
+    # @return [String]
+    #   Hello in Aussie
+    #
+    # @example
+    #   Gday::Greeting.new.hi #=> "G'day!"
+    #
+    # @api public
     def hi
       "G'day!"
     end
 
+    # Saying Goodbye in Aussie
+    #
+    # @return [String]
+    #   Goodbye in Aussie
+    #
+    # @example
+    #   Gday::Greeting.new.bye #=> "Cheerio"
+    #
+    # @api public
     def bye
       "Cheerio"
     end

data/lib/gday/version.rb

@@ -1,3 +1,4 @@
 module Gday
-  VERSION = "0.0.2"
+  # The version for the gday gem.
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gday
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thomas Behrndt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem developed as a learning experience.
 email:
 - thomas.behrndt@me.com
@@ -46,10 +88,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - gday.gemspec
 - lib/gday.rb
 - lib/gday/version.rb
@@ -73,9 +117,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: This gem is part of my learning journey for developing and published Ruby
   Web Applications.
 test_files: []
+has_rdoc: