mousevc 0.0.2.pre.alpha

data/lib/mousevc/model.rb

@@ -0,0 +1,35 @@
+require_relative 'validation.rb'
+
+module Mousevc
+
+	##
+	# The base model class for a Mousevc application.
+	# Provides access to basic functionality for validating input before modifying data
+	# via it's +@validation+ attribute, an instance of the +Mousevc::Validation+ class.
+
+	class Model
+
+		##
+		# @!attribute [r]
+		# @return [Mousevc::Validation] a reference to the model's validation instance
+
+		attr_reader :validation
+
+		##
+		# Creates a new +Mousevc::Model+ instance
+		#
+		# @param options [Hash] optionally accepts the following keys:
+		# 	- :validation => [Mousevc::Router] an instance of the +Mousevc::Validation+ class
+
+		def initialize(options={})
+			@validation = options[:validation] ? options[:validation] : Validation.new
+			clear
+		end
+
+		##
+		# Overridable empty method for clearing data in the model subclass
+
+		def clear
+		end
+	end
+end

data/lib/mousevc/persistence.rb

@@ -0,0 +1,52 @@
+module Mousevc
+
+	##
+	# The +Persistance+ class enables storage and retrieval of models.
+	# While it is intended for storing models it can store
+	# any value as internally it stores the value in a Ruby Hash.
+	#
+	# @note The +Persistance+ class only stores data during the application life cycle. Once the application quits the data may still exist in memory if not explicitly cleared, however it should not be relied upon to be their for subsequent executions.
+
+	class Persistence
+
+		##
+		# Internal data storage
+
+		@@models = {}
+
+		##
+		# Allows clearing of all or some of the models currently stored.
+		# Clears all data and models stored if no keys are provided
+		#
+		# @param args [Symbol] a list of keys to clear from the currently stored models
+
+		def self.clear(*args)
+			if args.empty?
+				@@models.clear
+			else
+				args.each {|arg| @@models.delete(arg)}
+			end
+		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)
+		end
+	end
+end

data/lib/mousevc/router.rb

@@ -0,0 +1,77 @@
+require_relative 'controller.rb'
+require_relative 'model.rb'
+require_relative 'view.rb'
+
+module Mousevc
+
+	##
+	# Router routes requests to the controller method. Instantiated by the +Mousevc::App+ class.
+
+	class Router
+
+		##
+		# @!attribute controller
+		#
+		# @note Set this variable to the string name of the controller class to be instantiated upon the next application loop
+		#
+		# @return [String] the instance of the current controller
+
+		attr_accessor :controller
+
+		# @!attribute model
+		#
+		# @note Set this variable to the string name of the model class to be instantiated upon the next application loop
+		# @note Can be used to retrieve a model from the +Mousevc::Persistence+ class when set to a symbol.
+		#
+		# @return [String, Symbol] the instance of the current model.
+		
+		attr_accessor :model
+
+		# @!attribute action
+		#
+		# @note Set this variable to the symbol name of the method to call on the next controller
+		#
+		# @return [Symbol] the action sent to the controller method
+
+		attr_accessor :action
+
+		##
+		# Creates a new +Mousevc::Router+ 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
+
+		def initialize(options={})
+			@controller = options[:controller] ? options[:controller] : 'Controller'
+			@model = options[:model] ? options[:model] : 'Model'
+			@action = options[:action] ? options[:action] : :hello_mousevc
+			@views = options[:views]
+		end
+
+		##
+		# Routes by:
+		#
+		# 1. creating an instance of the current controller in the +@controller+ attribute
+		# 1. creating an instance of the current model in the +@model+ attribute
+		# 1. creating a new or finding the desired model
+		# 1. passing that controller that model instance, a view instance, and an instance of +self+
+		# 1. sending the controller the current action in +@action+
+
+		def route
+			model = nil
+			model = Persistence.get(@model) if @model.is_a?(Symbol)
+			model = Persistence.get(@controller.to_sym) unless Persistence.get(@controller.to_sym).nil?
+			model = Mousevc.factory(@model).new unless model
+			view = View.new(:dir => @views)
+			controller = Mousevc.factory(@controller).new(
+				:view => view,
+				:model => model,
+				:router => self
+			)
+			controller.send(@action)
+		end
+	end
+end

data/lib/mousevc/validation.rb

@@ -0,0 +1,353 @@
+module Mousevc
+
+	##
+	# Extend this class to perform validations on user input in your model.
+	# Use the +@error+ attribute to pass notices to the +Mousevc::Input+ class.
+	# From there the notice can be easily output in your views.
+	#
+	# Each predicate method in this class sets the appropriate error message ready
+	# to be output to the user.
+
+	class Validation
+
+		##
+		# @!attribute error
+		#
+		# @return [String] the error message generated during validation
+
+		attr_accessor :error
+
+		##
+		# Returns +true+ if the string containers only uppercase or lowercase letters
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def alpha?(value)
+			is_alpha = coerce_bool (value =~ /^[a-zA-Z]+$/)
+			unless is_alpha
+				@error = "Error, expected only alphabetical characters, got: #{value}"
+			end
+			is_alpha
+		end
+
+		##
+		# Returns +true+ if the value is equal to the other
+		#
+		# @param value [Any] the value
+		# @param other [Any] the other value
+		# @return [Boolean]
+
+		def matches?(value, other)
+			is_match = coerce_bool (value == other)
+			unless is_match
+				@error = "Error, expected value to match: #{other}, got: #{value}"
+			end
+			is_match
+		end
+
+		##
+		# Returns +true+ if the value is not equal to the other
+		#
+		# @param value [Any] the value
+		# @param other [Any] the other value
+		# @return [Boolean]
+
+		def differs?(value, other)
+			is_different = coerce_bool (value != other)
+			unless is_different
+				@error = "Error, expected value to differ from: #{other}, got: #{value}"
+			end
+			is_different
+		end
+
+		##
+		# Returns +true+ if the value has at least the specified length
+		#
+		# @param value [String] the value
+		# @param length [Integer] the length
+		# @return [Boolean]
+
+		def min_length?(value, length)
+			has_min_length = coerce_bool (value.length >= length)
+			unless has_min_length
+				@error = "Error, expected value to have at least #{length} characters, got: #{value.length}"
+			end
+			has_min_length
+		end
+
+		##
+		# Returns +true+ if the value has at most the specified length
+		#
+		# @param value [String] the value
+		# @param length [Integer] the length
+		# @return [Boolean]
+
+		def max_length?(value, length)
+			has_max_length = coerce_bool (value.length <= length)
+			unless has_max_length
+				@error = "Error, expected value to have at most #{length} characters, got: #{value.length}"
+			end
+			has_max_length
+		end
+
+		##
+		# Returns +true+ if the value has exactly the specified length
+		#
+		# @param value [String] the value
+		# @param length [Integer] the length
+		# @return [Boolean]
+
+		def exact_length?(value, length)
+			has_exact_length = coerce_bool (value.length == length)
+			unless has_exact_length
+				@error = "Error, expected value to have exactly #{length} characters, got: #{value.length}"
+			end
+			has_exact_length
+		end
+
+		##
+		# Returns +true+ if the value is greater than the other given value
+		# @note This method does note covert strings to numbers
+		#
+		# @param value [Mixed] the value
+		# @param other [Mixed] the other value
+		# @return [Boolean]
+
+		def greater_than?(value, other)
+			is_greater = coerce_bool (value > other)
+			unless is_greater
+				@error = "Error, expected value to be greater than #{other}, got: #{value}"
+			end
+			is_greater
+		end
+
+		##
+		# Returns +true+ if the value is greater than or equal to the other given value
+		# @note This method does note covert strings to numbers
+		#
+		# @param value [Mixed] the value
+		# @param other [Mixed] the other value
+		# @return [Boolean]
+
+		def greater_than_equal_to?(value, other)
+			is_greater_eq = coerce_bool (value >= other)
+			unless is_greater_eq
+				@error = "Error, expected value to be greater than or equal to #{other}, got: #{value}"
+			end
+			is_greater_eq
+		end
+
+		##
+		# Returns +true+ if the value is less than the other given value
+		# @note This method does note covert strings to numbers
+		#
+		# @param value [Mixed] the value
+		# @param other [Mixed] the other value
+		# @return [Boolean]
+
+		def less_than?(value, other)
+			is_less = coerce_bool (value < other)
+			unless is_less
+				@error = "Error, expected value to be less than #{other}, got: #{value}"
+			end
+			is_less
+		end
+
+		##
+		# Returns +true+ if the value is less than or equal to the other given value
+		# @note This method does note covert strings to numbers
+		#
+		# @param value [Mixed] the value
+		# @param other [Mixed] the other value
+		# @return [Boolean]
+
+		def less_than_equal_to?(value, other)
+			is_less_eq = coerce_bool (value <= other)
+			unless is_less_eq
+				@error = "Error, expected value to be less than or equal to #{other}, got: #{value}"
+			end
+			is_less_eq
+		end
+
+		##
+		# Returns +true+ if the value is an integer or a decimal, includes positive and negative
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def numeric?(value)
+			is_numeric = (integer?(value) || decimal?(value))
+			unless is_numeric
+				@error = "Error, expected value to be numeric, got: #{value}"
+			end
+			is_numeric
+		end
+
+		##
+		# Returns +true+ if the value is an integer, includes positive and negative
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def integer?(value)
+			is_integer = coerce_bool (value =~ /^[-+]?\d+$/)
+			unless is_integer
+				@error = "Error, expected value to be an integer, got: #{value}"
+			end
+			is_integer
+		end
+
+		##
+		# Returns +true+ if the value is an decimal, includes positive and negative
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def decimal?(value)
+			is_decimal = coerce_bool (value =~ /[+-]?[\d_]+\.[\d_]+(e[+-]?[\d_]+)?\b|[+-]?[\d_]+e[+-]?[\d_]+\b/i)
+			unless is_decimal
+				@error = "Error, expected value to be a decimal, got: #{value}"
+			end
+			is_decimal
+		end
+
+		##
+		# Returns +true+ if the value is a positive integer
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def natural?(value)
+			is_natural = coerce_bool (value =~ /^\d+$/)
+			unless is_natural
+				@error = "Error, expected value to be a natural number, got: #{value}"
+			end
+			is_natural
+		end
+
+		##
+		# Returns +true+ if the value is a positive integer greater than zero
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def natural_no_zero?(value)
+			is_natural_no_zero = coerce_bool (value =~ /^[1-9]+$/)
+			unless is_natural_no_zero
+				@error = "Error, expected value to be a natural number above 0, got: #{value}"
+			end
+			is_natural_no_zero
+		end
+
+		##
+		# Returns +true+ if the value is a valid url and accounts for many edge cases
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def url?(value)
+			is_url = coerce_bool (value =~ /^(?:(?:https?|ftp):\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-{1})*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-{1})*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,}))\.?)(?::\d{2,5})?(?:[\/?#]\S*)?$/i)
+			unless is_url
+				@error = "Error, expected value to be a url, got: #{value}"
+			end
+			is_url
+		end
+
+		##
+		# Returns +true+ if the value is a valid email address
+		#
+		# @note This method is more a validation that the value is probably an email. The best way to confirm an email is to require the user to enter it twice, compare them, and ultimately send them an email!
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def email?(value)
+			is_email = coerce_bool (value =~ /.+@.+/)
+			unless is_email
+				@error = "Error, expected value to be an email address, got: #{value}"
+			end
+			is_email
+		end
+
+		##
+		# Returns +true+ if the value is a valid IP address i.e. between 0.0.0.0 and 255.255.255.255
+		#
+		# @param value [String] the value
+		# @return [Boolean]
+
+		def ip?(value)
+			is_ip = coerce_bool (value =~ /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/)
+			unless is_ip
+				@error = "Error, expected value to be an IP address, got: #{value}"
+			end
+			is_ip
+		end
+
+		##
+		# Returns +true+ if the value contains only letters, numbers
+		# and has a length between the min and max of the given range
+		#
+		# @param value [String] the value
+		# @param range [Range] the min and max length of the password, defaults to +8..15+
+		# @return [Boolean]
+
+		def password?(value, range=8..15)
+			is_password = coerce_bool (value =~ /^(?!.*["'])(?=.*\d)(?=.*[a-z])\S{#{range.min},#{range.max}}$/)
+			unless is_password
+				@error = "Error, expected value to contain only lowercase letters, numbers, and have length between #{range.min} and #{range.max}, got: #{value}"
+			end
+			is_password
+		end
+
+		##
+		# Returns +true+ if the value contains only letters, numbers and has a length,
+		# has a length between the min and max of the given range,
+		# and contains at least one uppercase letter
+		#
+		# @param value [String] the value
+		# @param range [Range] the min and max length of the password, defaults to +8..15+
+		# @return [Boolean]
+
+		def password_caps?(value, range=8..15)
+			is_password_caps = coerce_bool (value =~ /^(?!.*["'])(?=.*\d)(?=.*[A-Z])(?=.*[a-z])\S{#{range.min},#{range.max}}$/)
+			unless is_password_caps
+				@error = "Error, expected value to contain lowercase letters, numbers, have length between #{range.min} and #{range.max} and at least one uppercase letter, got: #{value}"
+			end
+			is_password_caps
+		end
+
+		##
+		# Returns +true+ if the value contains only letters, numbers and has a length,
+		# has a length between the min and max of the given range,
+		# contains at least one uppercase letter,
+		# and contains at least one symbol
+		#
+		# @note Excludes single and double quotes.
+		#
+		# @param value [String] the value
+		# @param range [Range] the min and max length of the password, defaults to +8..15+
+		# @return [Boolean]
+
+		def password_symbols?(value, range=8..15)
+			is_password_symbols = coerce_bool (value =~ /^(?!.*["'])(?=.*[~!@#$%^&*()_+\-\\|{}<>\[\]:;?\/])(?=.*\d)(?=.*[A-Z])(?=.*[a-z])\S{#{range.min},#{range.max}}$/)
+			unless is_password_symbols
+				@error = @error = "Error, expected value to contain lowercase letters, numbers, have length between #{range.min} and #{range.max}, at least one uppercase letter and at least one symbol, got: #{value}"
+			end
+			is_password_symbols
+		end
+
+		protected
+
+			##
+			# A method used to guarantee a value is converted explicitly into either +true+ or +false+
+			#
+			# @param value [Any] the original value
+			# @return [Boolean]
+
+			def coerce_bool(value)
+				!!value
+			end
+
+	end
+end

data/lib/mousevc/version.rb

@@ -0,0 +1,7 @@
+module Mousevc
+	
+	##
+	# The current version
+
+	VERSION = "0.0.2-alpha"
+end

data/lib/mousevc/view.rb

@@ -0,0 +1,66 @@
+require 'erb'
+
+module Mousevc
+
+	##
+	# The view rendering class of Mousevc.
+	# @note Currently only supports ERB templates and a file naming convention of: +[VIEW_NAME].txt.erb+
+
+	class View
+
+		##
+		# @!attribute dir
+		#
+		# @return [String] the path to the views directory
+
+		attr_reader :dir
+
+		##
+		# Create a new +Mousevc::View+ instance
+
+		def initialize(options={})
+			@dir = options[:dir]
+		end
+
+		##
+		# Renders a view, passing it the given data. In the ERB template the hash variables will be available as instance variables e.g. +@view_variable+
+		#
+		# @note If the string passed to the +view+ parameter is an existing file it will be used as the ERB template. Otherwise the string will be parsed as ERB.
+		#
+		# @note Optionally the view output can be suppressed via setting output to +false+. The view will be returned as a string allowing later output e.g. +render('view', {:data => data}, false)+
+		#
+		# @note In the event that you want to suppress output and not provide any data you may substitute +data+ for +output+ in the parameter list e.g. +render('view', false)+
+		#
+		# @param view [String] the name of the view with +.txt.erb+ omitted
+		# @param args [Array] accepts 2 additional parameters.
+		# 	- +data+ [Hash] the data to pass to the view (optionally omit)
+		# 	- +output+ [Boolean] false if output is to be suppressed
+		#
+		# @return [String] the rendered view as a string
+
+		def render(view, *args)
+			data = args[0].is_a?(Hash) ? args[0] : {}
+			output = true
+			output = false if args[0] == false || args[1] == false
+			path = "#{Dir.pwd}/#{@dir}/#{view}.txt.erb"
+			view = File.file?(path) ? File.read(path) : view
+			to_ivars(data)
+			result = ERB.new(view).result(binding)
+			puts result if output
+			result
+		end
+
+		private
+
+			##
+			# Take the given data hash and converts the key/value pairs into instance variables.
+			#
+			# @param data [Hash] the data to convert into instance variables.
+
+			def to_ivars(data)
+				data.to_h.each do |key, value|
+					instance_variable_set("@#{key.to_s}", value)
+				end
+			end
+	end
+end

data/lib/mousevc.rb

@@ -0,0 +1,49 @@
+require_relative 'mousevc/version.rb'
+require_relative 'mousevc/app.rb'
+
+##
+# Mousevc is the top level module and namespace for the Mousevc framework.
+
+module Mousevc
+
+	##
+	# @todo Add link to documentation
+	#
+	# @return [String] some pretty ASCII art
+
+	def self.art
+		lines = [
+			"",
+			"(`) (`)",
+			"=('o')=",
+			"  m m  ",
+			"",
+			"MousevC",
+			"V     L",
+			"C     I",
+			"",
+			"by",
+			"Bideo Wego",
+			"http://bideowego.com/mousevc",
+			"",
+			"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")
+	end
+
+	##
+	# Generates a Mousevc class constant ready for instantiation
+	#
+	# @return [Constant] the class constant
+
+	def self.factory(class_name)
+		"Mousevc::#{class_name}".split('::').inject(Object) do |object, string|
+			object.const_get(string)
+		end
+	end
+end

data/mousevc.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mousevc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mousevc"
+  spec.version       = Mousevc::VERSION
+  spec.authors       = ["Chris Scavello"]
+  spec.email         = ["bideowego@gmail.com"]
+
+  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/mousevc"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end