mousevc 0.0.2 → 0.0.3.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d9fa6dd0f403e43b06f4776aeaff121d204cee5
-  data.tar.gz: b5343d26fdd055e2f9c72309f5201c6b399dfca9
+  metadata.gz: 48ec74aed2a3dde484226cc1db018bf3fc3086ff
+  data.tar.gz: 24b4222ef7944364b837092e1950538486e56f74
 SHA512:
-  metadata.gz: addba491d0f09d2db745cb45a9d5b2028a1f7d48bccfdf8ea31fe10f9a057f1fb805b020e15d902e13e15fd270d926a405abfe79c1ac7f14b6730d9ae3fc42c5
-  data.tar.gz: fc70704ed24d5bb3a1a362b9f3abe650b5877e79a4969fbe967014a1a6828d85e6e812a27d64cd1317c1fce7003cba048436ef57fefe4a39dfdd5c4dada0681d
+  metadata.gz: 01cb7f165aa5b97594cef91e9d30e52ba8e76bdaf02b603b3eab96180a1fe1eeb78438ff7b3542b22a364750a00e44a4e41fec37aed68ce0a9e7023a031378f2
+  data.tar.gz: 8ee1890266ca700d64edc6c4111cbaa28a6ced8e343732f74e6b72fd0805295407a6ced14ee9b7462288a156d12e209b9ea5a1d769dd115861becfe47b58d390

data/README.md

@@ -10,6 +10,10 @@
 
 A tiny mouse sized MVC framework to jump start command line apps. Written in Ruby.
 
+[![Gem Version](https://badge.fury.io/rb/mousevc.svg)](http://badge.fury.io/rb/mousevc)
+
+[View the documentation](http://www.rubydoc.info/gems/mousevc)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/mousevc/app.rb

@@ -31,6 +31,15 @@ module Mousevc
 
 		attr_accessor :looping
 
+		##
+		# @!attribute router
+		#
+		# Returns the current router
+		#
+		# @return [Mousevc::Router] the router
+
+		attr_reader :router
+
 		##
 		# Creates a new +Mousevc::App+ instance
 		# 
@@ -52,11 +61,13 @@ module Mousevc
 		end
 
 		##
-		# Run the application
+		# Runs the application
 
 		def run
 			reset
 			@looping ? listen : single
+			Input.clear
+			nil
 		end
 
 		##
@@ -90,10 +101,12 @@ module Mousevc
 				)
 			end
 
+			##
+			# Runs the application without looping automatically
+
 			def single
-				Kernel.system('clear') if system_clear?
-				@router.route unless Input.quit?
-				reset if Input.reset?
+				clear_view
+				@router.route
 			end
 
 			##
@@ -106,9 +119,17 @@ module Mousevc
 
 			def listen
 				begin
-					single
+					clear_view
+					@router.route unless Input.quit?
+					reset if Input.reset?
 				end until Input.quit?
-				Input.clear
+			end
+
+			##
+			# Executes a system clear if system clearing is enabled
+
+			def clear_view
+				Kernel.system('clear') if system_clear?
 			end
 	end
 end

data/lib/mousevc/persistence.rb

@@ -18,7 +18,7 @@ module Mousevc
 		# Allows clearing of all or some of the models currently stored.
 		# Clears all data and models stored if no keys are provided
 		#
-		# @param [Symbol] a list of keys to clear from the currently stored models
+		# @param args [Symbol] a list of keys to clear from the currently stored models
 
 		def self.clear(*args)
 			if args.empty?
@@ -29,12 +29,21 @@ module Mousevc
 		end
 
 		##
-		# 
+		# Get a stored model by key
+		#
+		# @param key [Symbol] the key under which the model is stored
+		# @return [Mousevc::Model, Any] the stored model or value
 
 		def self.get(key)
 			@@models[key]
 		end
 
+		##
+		# Set the value of a storage key
+		# @raise [Mousevc::Error] if the key already exists
+		#
+		# @param key [Symbol] the key under which the model is stored
+
 		def self.set(key, value)
 			raise Error.new("Cannot persist, a value already exists at: #{key}") unless @@models[key].nil?
 			@@models.store(key, value)

data/lib/mousevc/version.rb

@@ -3,5 +3,5 @@ module Mousevc
 	##
 	# The current version
 
-	VERSION = "0.0.2"
+	VERSION = "0.0.3-alpha"
 end

data/lib/mousevc.rb

@@ -24,11 +24,13 @@ module Mousevc
 			"",
 			"by",
 			"Bideo Wego",
+			"http://bideowego.com/mousevc",
 			"",
-			"http://bideowego.com",
-			""
+			"Documentation",
+			"http://www.rubydoc.info/gems/mousevc"
 		]
 		width = lines.max.length
+		width = width.even? ? width + 1 : width
 		lines.map do |s|
 			s.center(width)
 		end.join("\n")

data/mousevc.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A tiny mouse sized MVC framework to jump start command line apps.}
   #spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "http://bideowego.com"
+  spec.homepage      = "http://bideowego.com/mousevc"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mousevc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.pre.alpha
 platform: ruby
 authors:
 - Chris Scavello
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-22 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,7 @@ files:
 - lib/mousevc/version.rb
 - lib/mousevc/view.rb
 - mousevc.gemspec
-homepage: http://bideowego.com
+homepage: http://bideowego.com/mousevc
 licenses:
 - MIT
 metadata:
@@ -98,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6