mousevc 0.0.2.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 965d70e8bc3b4614747881cd88769b7f9fb85110
+  data.tar.gz: fb52f433c36a3fd4eddcfb7348da73786b0bf3f1
+SHA512:
+  metadata.gz: fbe673e788f873d53c27c9e0794f50ff19dcf72294764cab4ccdb01e6a66797b3cee6d957b1beb877397742464d97b3309c1e16f253f740f7f6bbe4479f737a1
+  data.tar.gz: 3b86905ff2c32ff61949c1b46c0f4d74b772cfb02e2d0612d12af74aa0c864e95bfac23c690acde03987267c60b164041b31a428f568ae43f479344783e7b909

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*todo*
+*TODO*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mousevc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Scavello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# Mousevc
+
+	(`) (`)
+	=('o')=
+	  m m  
+
+	MousevC
+	V     L
+	C     I
+
+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:
+
+```ruby
+gem 'mousevc'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install mousevc
+```
+
+## Usage
+
+1. Require Mousevc
+
+	```ruby
+	require 'mousevc'
+	```
+
+1. Create a view in your views directory
+
+	```erb
+	<%# views/show_cheese.txt.erb %>
+
+	Hello Mousevc!
+	I like <%= @cheese %>!
+	What kind of cheese do you like?
+	```
+
+	1. Or just use a string!
+
+	```ruby
+	view = %Q{<%# views/show_cheese.txt.erb %>\nHello Mousevc!\nI like <%= @cheese %>!\nWhat kind of cheese do you like?}
+	```
+
+1. Create your default controller
+
+	```ruby
+	# jerry_controller.rb
+
+	class JerryController < Mousevc::Controller
+		def find_cheese
+			view = %Q{<%# views/show_cheese.txt.erb %>\nHello Mousevc!\nI like <%= @cheese %>!\nWhat kind of cheese do you like?}
+			cheese = @model.cheese
+			@view.render(view, :cheese => cheese)
+			Mousevc::Input.prompt
+		end
+	end
+	```
+
+1. Create the corresponding model
+
+	```ruby
+	# jerry_model.rb
+
+	class JerryModel < Mousevc::Model
+		def cheese
+			@cheese = "Swiss cheese"
+		end
+	end
+	```
+
+1. Create a class that extends `Mousevc::App`
+
+	```ruby
+
+	# jerry.rb
+
+	class Jerry < Mousevc::App
+	end
+
+	Jerry.new(
+		:controller => 'JerryController',
+		:model => 'JerryModel',
+		:action => :find_cheese,
+		:views => 'relative/views/directory/path'
+	).run
+	```
+
+1. Run mouse run!
+
+	```shell
+	$ ruby jerry.rb
+	```
+
+1. Enjoy the view!
+
+	```shell
+
+	Hello Mousevc!
+	I like Swiss cheese!
+	What kind of cheese do you like?
+
+	> 
+	```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BideoWego/mousevc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+	t.rspec_opts = "--format documentation"
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mousevc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/example.rb

@@ -0,0 +1,65 @@
+require 'mousevc'
+
+# 1. Create your default controller
+# --------------------------------
+
+# jerry_controller.rb
+
+class JerryController < Mousevc::Controller
+	def find_cheese
+		view = %Q{<%# views/show_cheese.txt.erb %>\nHello Mousevc!\nI like <%= @cheese %>!\nWhat kind of cheese do you like?}
+		cheese = @model.cheese
+		@view.render(view, :cheese => cheese)
+		Mousevc::Input.prompt
+	end
+end
+
+# 1. Create the corresponding model
+# --------------------------------
+
+# jerry_model.rb
+
+class JerryModel < Mousevc::Model
+	def cheese
+		@cheese = "Swiss cheese"
+	end
+end
+
+# 1. Create a class that extends `Mousevc::App`
+# --------------------------------
+
+# jerry.rb
+
+class Jerry < Mousevc::App
+end
+
+Jerry.new(
+	:controller => 'JerryController',
+	:model => 'JerryModel',
+	:action => :find_cheese,
+	:views => 'relative/views/directory/path'
+).run
+
+# 1. Create a view in your views directory
+# --------------------------------
+
+# <%# views/show_cheese.txt.erb %>
+
+# Hello Mousevc!
+# I like <%= @cheese %>!
+# What kind of cheese do you like?
+
+# # 1. Run mouse run!
+# --------------------------------
+
+# $ ruby jerry.rb
+
+# 1. Enjoy the view!
+# --------------------------------
+# =>
+
+# Hello Mousevc!
+# I like Swiss cheese!
+# What kind of cheese do you like?
+
+# > 

data/lib/mousevc/app.rb

@@ -0,0 +1,135 @@
+require_relative 'router.rb'
+require_relative 'input.rb'
+require_relative 'error.rb'
+require_relative 'persistence.rb'
+
+module Mousevc
+
+	## true
+	# The top level class of Mousevc.
+	# The container for all of the objects
+	# created within a Mousevc application.
+
+	class App
+
+		##
+		# @!attribute system_clear
+		#
+		# Setting this to +false+ will disable calls to +system('clear')+
+		# at the start of each application loop.
+		#
+		# @return [Boolean] whether or not to perform system clear
+
+		attr_accessor :system_clear
+
+		##
+		# @!attribute looping
+		#
+		# Set this to +true+ if you want the application to loop, defaults to +false+
+		#
+		# @return [Boolean] whether or not the application should loop
+
+		attr_accessor :looping
+
+		##
+		# @!attribute router
+		#
+		# Returns the current router
+		#
+		# @return [Mousevc::Router] the router
+
+		attr_reader :router
+
+		##
+		# Creates a new +Mousevc::App+ instance
+		# 
+		# @param options [Hash] expects the following keys:
+		# 	- :controller => [String] name of default controller class
+		# 	- :model => [String] name of default model class
+		# 	- :action => [Symbol] method to call on default controller
+		# 	- :views => [String] relative path to views directory
+		# 	- :looping => [Boolean] +true+ if the application should loop, defaults to +false+
+		# 	- :system_clear => [Boolean] +true+ if output should be cleared on update, defaults to +false+
+
+		def initialize(options={})
+			@controller = options[:controller]
+			@model = options[:model]
+			@action = options[:action]
+			@views = options[:views]
+			@looping = options[:looping].nil? ? false : options[:looping]
+			@system_clear = options[:system_clear].nil? ? false : options[:system_clear]
+		end
+
+		##
+		# Runs the application
+
+		def run
+			reset
+			@looping ? listen : single
+			Input.clear
+			nil
+		end
+
+		##
+		# Returns +true+ if +@system_clear+ is true
+		#
+		# @return [Boolean] whether or not system clearing is enabled
+
+		def system_clear?
+			@system_clear
+		end
+
+		##
+		# Returns +true+ if +@looping+ is set to +true+
+
+		def looping?
+			@looping
+		end
+
+		private
+
+			##
+			# Instantiates the router instance.
+			# Passes the router instance the initialization options.
+
+			def reset
+				@router = Router.new(
+					:controller => @controller,
+					:action => @action,
+					:model => @model,
+					:views => @views
+				)
+			end
+
+			##
+			# Runs the application without looping automatically
+
+			def single
+				clear_view
+				@router.route
+			end
+
+			##
+			# Runs the application loop.
+			# Clears the system view each iteration.
+			# Calls route on the router instance.
+			# 
+			# If the user is trying to reset or quit the application responds accordingly.
+			# Clears Input class variables before exit.
+
+			def listen
+				begin
+					clear_view
+					@router.route unless Input.quit?
+					reset if Input.reset?
+				end until Input.quit?
+			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/controller.rb

@@ -0,0 +1,56 @@
+module Mousevc
+
+	##
+	# Base controller class in Mousevc.
+	# Handles communication with the model.
+	# Decides which view to output.
+
+	class Controller
+
+		##
+		# @!attribute model
+		#
+		# An instance of the +Mousevc::Model+ class.
+		# This will be an instance of the model class passed to the application during initialization.
+		# It is also possible to change this via +@router.model+
+		#
+		# @return [Mousevc::Model] the controller's model
+
+		attr_accessor :model
+
+		##
+		# @!attribute view [r]
+		#
+		# An instance of the +Mousevc::View+ class
+		#
+		# @return [Mousevc::View] the view instance
+
+		attr_reader :view
+
+		##
+		# Creates a new +Mousevc::Controller+ instance
+		#
+		# @note Controllers should not be instantiated directly. Pass the name of the controller you wish you instantiate to the router via +@router.controller+ along with a model and action. This allows the router to do the work for you on the next application execution or loop.
+		#
+		# @param options [Hash] expects the following keys:
+		# 	- :model => [Mousevc::Model] a reference to the controller's model instance
+		# 	- :view => [Mousevc::View] a reference to the view instance
+		# 	- :router => [Mousevc::Router] a reference to the router instance
+
+		def initialize(options={})
+			@model = options[:model]
+			@view = options[:view]
+			@router = options[:router]
+		end
+
+		private
+
+			##
+			# Outputs the default Mousevc welcome
+
+			def hello_mousevc
+				puts Mousevc.art
+				Input.prompt
+			end
+	end
+end

data/lib/mousevc/error.rb

@@ -0,0 +1,17 @@
+module Mousevc
+
+	##
+	# A namespaced Mousevc specific extension of Ruby's +StandardError+.
+
+	class Error < StandardError
+
+		##
+		# Create a new +Mousevc::Error+ instance
+		#
+		# @param message [String] the error message
+
+		def initialize(message)
+			super(message)
+		end
+	end
+end

data/lib/mousevc/input.rb

@@ -0,0 +1,188 @@
+module Mousevc
+
+	##
+	# A globally accessible class to allow access to user input and provide input specific notices.
+
+	class Input
+
+		##
+		# @!attribute notice
+		# @return [String] the notice message
+
+		@@notice = nil
+
+		##
+		# @!attribute data [r]
+		# @return [String] the user input data retrieved via +Input.prompt+
+
+		@@data = nil
+
+		##
+		# @!attribute prompts [r]
+		# @return [Hash] a hash of prompts available for use in +Input.prompt+
+
+		@@prompts = {:default => '>'}
+
+		##
+		# @!attribute appearance
+		# @return [Symbol] the symbol name of the prompt appearance to use from +Input.prompts+
+
+		@@appearance = nil
+
+		##
+		# @return [Symbol] the symbol name of the current prompt appearance
+
+		def self.appearance
+			@@appearance
+		end
+
+		##
+		# Set the default appearance for the prompt
+		#
+		# @param value [Symbol] the symbol name of the appearance to use from +Input.prompts+
+
+		def self.appearance=(value)
+			@@appearance = value
+		end
+
+		##
+		# Clears all or a list of class variables by setting them to +nil+
+		#
+		# @param args [Symbol] a symbol list of class variables to clear
+
+		def self.clear(*args)
+			if args.empty?
+				args = [
+					:notice,
+					:data,
+					:prompts,
+					:appearance
+				]
+			end
+			to_defaults(args)
+		end
+
+		##
+		# @note Calling this method will stop all execution until the user submits input
+		#
+		# Prompts the user for input using +gets.strip+
+		# Once input is submitted it will be available via +Input.data+
+		#
+		# @param appearance [Symbol] the symbol name of the prompt the use from +Input.prompts+
+		# 	- If an appearance is not specified it uses +:default+
+
+		def self.prompt(appearance=nil)
+			appearance = pick(appearance)
+			print "\n#{appearance} "
+			@@data = $stdin.gets.to_s.strip
+		end
+
+		##
+		# @return [Hash] a hash of the currently available prompt appearances
+
+		def self.prompts
+			@@prompts
+		end
+
+		##
+		# Get the notice message
+		#
+		# @return [String] the notice message
+
+		def self.notice
+			@@notice
+		end
+
+		##
+		# Set the notice message. This is a good place to put error messages corresponding to user input
+		#
+		# @param value [String] the notice message
+
+		def self.notice=(value)
+			@@notice = value
+		end
+
+		##
+		# Get the current value of user input retrieved via +Input.prompt+
+		#
+		# @return [String] the data
+
+		def self.data
+			@@data
+		end
+
+		##
+		# Check if a notice message exists
+		#
+		# @return [Boolean] false if notice message is empty
+
+		def self.notice?
+			! @@notice.to_s.empty?
+		end
+
+		##
+		# Check if the user is trying to reset the application
+		#
+		# @return [Boolean] true if +Input.data+ is +r+ or +reset+
+
+		def self.reset?
+			['r', 'reset'].include?(@@data)
+		end
+
+		##
+		# Check if the user is trying to quit the application
+		#
+		# @return [Boolean] true if +Input.data+ is +q+, +quit+, or +exit+
+
+		def self.quit?
+			['q', 'quit', 'exit'].include?(@@data)
+		end
+
+		##
+		# Check if the user is tring to clear the input data
+		#
+		# @return [Boolean] true if +Input.data+ is +c+ or +clear+
+
+		def self.clear?
+			['c', 'clear'].include?(@@data)
+		end
+
+		private
+
+			##
+			# Sets class variables to their default values
+			#
+			# @param attributes [Array<Symbol>] array of symbols names for attributes to reset
+
+			def self.to_defaults(attributes)
+				attributes.each do |attribute|
+					case attribute
+					when :prompts
+						@@prompts.clear
+						@@prompts = {:default => '>'}
+					else
+						class_variable_set("@@#{attribute}", nil)
+					end
+				end
+			end
+
+			##
+			# Checks if a specific appearance was passed or set as a default.
+			# Returns that appearance or the default if none was set.
+			#
+			# @return [String] the appearance of the prompt 
+
+			def self.pick(appearance=nil)
+				if appearance
+					appearance = @@prompts[appearance]
+				elsif @@appearance
+					appearance = @@prompts[@@appearance]
+				else
+					appearance = @@prompts[:default]
+				end
+				appearance
+			end
+
+		clear
+	end
+end