sunsap 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.2.0 / 2013-1-12
+
+* 1 major enhancement
+
+  * Add Readers
+
 === 0.1.0 / 2012-12-16
 
 * 1 major enhancement

data/Manifest.txt

@@ -1,6 +1,6 @@
 .autotest
 History.txt
 Manifest.txt
-README.markdown
+README.mdown
 Rakefile
 lib/sunsap.rb

data/README.mdown

@@ -0,0 +1,5 @@
+# sunsap
+https://github.com/weddingcakes/sunsap
+![codeclimate](https://codeclimate.com/github/weddingcakes/sunsap)
+
+copyright (C) 2012 weddingcakes. See LICENSE.txt for more.

data/Rakefile

@@ -1,7 +1,6 @@
 # -*- ruby -*-
-
 require 'hoe'
-
+require 'rake'
 Hoe.plugin :gemcutter
 Hoe.plugin :roodi
 Hoe.plugin :test
@@ -11,14 +10,12 @@ Hoe.plugin :git
 Hoe.plugins.delete :rubyforge
 
 Hoe.spec 'sunsap' do
-  developer('weddingcakes', 'keymint1498@gmail.com')
-	license 'MIT'
+  developer 'weddingcakes', 'keymint1498@gmail.com'
   extra_deps << ['rspec',     "2.12.0"]
   extra_deps << ['mocha',     "0.13.1"]
   extra_deps << ['simplecov', "0.7.1" ]
-
-  self.readme_file = "README.markdown"
+  
+  self.readme_file = "README.mdown"
   self.description = "Send messages to a reporter"
 end
-
 # vim: syntax=ruby

data/lib/sunsap.rb

@@ -1,17 +1,144 @@
 module Sunsap
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   attr_accessor :reportername, :messages
 
+  # The reporter
   class Reporter
+    # Create a new reporter
+    #
+    #  @api public
+    #  @param [reportername] the name of the reporter as a string
+    #
+    # @example Make a new reporter
+    #
+    #   reporter = Sunsap::Reporter.new("test")
+    #   # => true
+    #
+    # @returns true
     def initialize(reportername)
       @queue = []
+
+      # Send a message to the queue
+      #
+      # @api public
+      # @param [m] message to send
+      #
+      # @example Send a message
+      #
+      #   reporter.send_test_message "Success!"
+      #   # => true
+      #
+      # @returns true
       self.class.send :define_method, "send_#{reportername}_message" do |m|
         @queue.push(m)
+        true
       end
 
+      # View the queue
+      #
+      # @api public
+      # @example Read a queue
+      #
+      #   reporter.queue
+      #   # => ["Success!"]
+      #
+      # @returns Array of messages
       def queue
         @queue
       end
+      true
+    end
+  end
+
+  class Reader
+    # Make a reader
+    #
+    # @params [reporter] reporter to read the queue of
+    #
+    # @example Make a new instance of the `Reader` class
+    # 
+    #     reader = Sunsap::Reader.new(Sunsap::Reporter.new("test"))
+    #     # => true
+    def initialize(reporter)
+      @reporter = reporter
+      true
+    end
+    # Read the queue the right way
+    # @api public
+    # @example Read a queue
+    #     reporter = Sunsap::Reporer.new("test")
+    #     reporter.send_test_message("Success!")
+    #     reader = Sunsap::Reader.new
+    #     reader.read
+    #     # => {:messages => 1, :queue => ["Success!"]}
+    
+    def read
+      {:messages => queuesize, :queue => queue}
+    end
+
+    # Read the queue if it's not empty
+    #
+    # @api public
+    # @example Read a queue
+    #
+    #     reporter = Sunsap::Reporer.new
+    #     reader = Sunsap::Reader.new
+    #     reader.read!
+    #     # => error: RuntimeError: Queue was empty
+    #
+    # @returns Messages and the Queue or raises RuntimeError if the queue is empty
+    def read!
+      unless queuesize >= 1
+        raise "Queue was empty"
+      else
+        queue
+      end
+      {:messages => queuesize, :queue => queue}
+    end
+
+    # Read the queue in a more friendly matter
+    #
+    # @api public
+    # @example Read a queue
+    #     reporter = Sunsap::Reporer.new("test")
+    #     reporter.send_test_message("Success!")
+    #     reader = Sunsap::Reader.new
+    #     reader.read
+    #     # => "Messages: 1, Queue: ["Success!"]"
+    #
+    # @returns Messages and the Queue
+    def read_friendly
+      "Messages: #{queuesize}, Queue: #{queue}"
+    end
+
+    # Read the queue if it's not empty
+    #
+    # @api public
+    # @example Read a queue
+    #
+    #     reporter = Sunsap::Reporer.new
+    #     reader = Sunsap::Reader.new
+    #     reader.read!
+    #     # => error: RuntimeError: Queue was empty
+    #
+    # @returns Messages and the Queue or raises RuntimeError if the queue is empty
+    def read_friendly!
+      unless queuesize >= 1
+        raise "Queue was empty"
+      else
+        queue
+        "Messages: #{queuesize}, Queue: #{queue}"
+      end
+    end
+
+    private
+
+    def queue
+      queue = @reporter.queue
+    end
+
+    def queuesize
+      queuesize = @reporter.queue.size
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunsap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 description: Send messages to a reporter
 email:
 - keymint1498@gmail.com
@@ -103,17 +103,15 @@ files:
 - .autotest
 - History.txt
 - Manifest.txt
-- README.markdown
+- README.mdown
 - Rakefile
 - lib/sunsap.rb
-- .gemtest
 homepage: https://github.com/weddingcakes/sunsap
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options:
 - --main
-- README.markdown
+- README.mdown
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -130,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sunsap
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ''

data/README.markdown

@@ -1,7 +0,0 @@
-# sunsap
-
-https://github.com/weddingcakes/sunsap
-
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/weddingcakes/sunsap)
-# Copyright
-Copyright (c) 2012 weddingcakes. See LICENSE.txt for more.