mousevc

Mousevc

(`) (`)
=('o')=
  m m  

MousevC
V     L
C     I

A tiny mouse sized MVC framework to jump start command line apps. Written in Ruby.

View the documentation

Installation

Add this line to your application's Gemfile:

gem 'mousevc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mousevc

Usage

1. Require Mousevc

   require 'mousevc'
   

2. 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. Or just use a string!

   view = %Q{<%# views/show_cheese.txt.erb %>\nHello Mousevc!\nI like <%= @cheese %>!\nWhat kind of cheese do you like?}
   

3. 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
   

4. Create the corresponding model

   # jerry_model.rb
   
   class JerryModel < Mousevc::Model
   	def cheese
   		@cheese = "Swiss cheese"
   	end
   end
   

5. Create a class that extends Mousevc::App

   • NOTE: as of v0.0.6 Mousevc requires that the views path be absolute, e.g "#{File.dirname(__FILE__)}/views"

   
   # jerry.rb
   
   class Jerry < Mousevc::App
   end
   
   Jerry.new(
   	:controller => 'JerryController',
   	:model => 'JerryModel',
   	:action => :find_cheese,
   	:views => "#{File.dirname(__FILE__)}/views"
   ).run
   

6. Run mouse run!

   $ ruby jerry.rb
   

7. Enjoy the view!

   
   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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.