shot_mvc 1.0.1

data/README.md

@@ -0,0 +1,69 @@
+Introduction
+------------
+
+The Shot MVC implements a Model, View, Controller architecture on top of the base Shot Framework through a series of
+Loaders and Routers. Additionally, the MVC gem allows you to use the `MVCApplication` class, which will automatically
+set up all required MVC loaders and routers.
+
+# Installation
+
+```bash
+gem install shot_mvc
+```
+
+# Usage Example
+
+```ruby
+require 'shot_mvc'
+
+app = MVCApplication.new
+
+app.run do
+    app.on 'load' do |instance|
+        instance.get 'controller', 'Home'
+    end
+end
+
+app.start
+```
+
+# Components
+
+The Shot MVC is made up of a few different parts, which collectively make up a Model, View, Controller structure.
+
+## Model
+
+At the time of writing, Models are not yet finished, but coming soon!
+
+## View
+
+The View portion of the MVC is made up of **Elements** and **Templates**.
+
+Elements correspond to an actual HTML element on the user's screen. Elements have an assigned jQuery selector, and can
+trigger any jQuery function on the corresponding element on the page.
+
+Elements are capable of rendering Templates, which are nothing more than an ERB file, with some special sauce.
+
+```ruby
+body = get 'element', 'body'
+
+body.html = 'Hello World'
+body.jq 'css', ['background-color', 'red']
+
+body.render 'some_template'
+```
+
+## Controllers
+
+Controllers are just as you'd expect. All controllers inherit from the base `Controller` class, and they can be loaded
+using the built in Loader.
+
+```ruby
+home_controller = get 'controller', 'Home'
+home_controller.index
+```
+
+
+# License
+
+Licensed under the MIT License. For full licensing information, please see LICENSE.md.

data/application/controllers/view_controller.rb

@@ -0,0 +1,30 @@
+# What is this item?
+#
+# What does this item do?
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'shot_mvc'
+
+class ViewController < Controller
+	def create(view)
+		contents = <<-eos
+<br /><br />
+<div class="container">
+	<div class="row">
+		<div class="span12">
+			<h1>#{view}</h1>
+			<p>This view is simply a placeholder for something amazing! You can edit the view here:</p>
+			<pre><code>application/views/#{view}.erb</code></pre>
+		</div>
+	</div>
+</div>
+		eos
+
+		File.write "application/views/#{view}.erb", contents
+
+		get('controller', 'Home').index
+	end
+end

data/application/views/view_not_found.erb

@@ -0,0 +1,26 @@
+<br /><br />
+<div class="container">
+  <div class="row">
+    <div class="span12">
+      <div class="hero-unit">
+        <h1>View Not Found</h1>
+        <p><pre><code><%=data[:requested_view]%></code></pre></p>
+        <p>Uh oh! It looks like you tried to render a view that doesn't exist yet.</p>
+
+        <p>
+          <a data-shot-click="GemRoot/application/controllers/view_controller.rb#create" data-shot-data="<%=data[:requested_view]%>" class="btn btn-primary btn-large">
+            Create View
+          </a>
+        </p>
+      </div>
+    </div>
+  </div>
+
+  <div class="row">
+    <div class="span12">
+      <h4>TemplateLoadException</h4>
+      <pre><code><%=data[:exception] %></code></pre>
+      <pre style='overflow-x: scroll'><code><%=data[:exception].backtrace.join('<br />') %></code></pre>
+    </div>
+  </div>
+</div>

data/lib/shot_mvc/controller.rb

@@ -0,0 +1,41 @@
+# Controller
+#
+# Implements a basic structure for a Shot MVC Controller
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+class Controller
+	# Application instance to which the controller belongs
+	attr_accessor :app
+
+	# An array of actions which can not be called from a view
+	attr_accessor :view_private
+
+	# Instantiate the controller and keep track of the passed ApplicationInstance
+
+	def initialize(app)
+		@view_private = []
+		@app = app
+	end
+
+	# Adds an action to the list of private, non-view-callable actions
+	#
+	# == Attributes
+	#
+	# * +action+ - String name of a controller method
+
+	def add_private_action(action)
+		view_private.push action
+	end
+
+	# Utilize a Loader.
+	#
+	# Note:: This is a convenient access method for ApplicationInstance#get
+
+	def get(type, name)
+		@app.get type, name
+	end
+end

data/lib/shot_mvc/controller_load_exception.rb

@@ -0,0 +1,14 @@
+# ControllerLoadException
+#
+# Raised if there was an issue while loading a controller.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+class ControllerLoadException < Exception
+	def initialize(message)
+		super(message)
+	end
+end

data/lib/shot_mvc/controller_loader.rb

@@ -0,0 +1,93 @@
+# ControllerLoader
+#
+# Adds controller loading functionality to a Shot application. Will attempt to load controllers in the
+# 'application/controllers' folder in the local working directory. If the file is not found, or an appropriate
+# filesystem is not set up, a ControllerLoadException will be raised.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'shot'
+require_relative './controller_load_exception'
+
+class String
+	# Converts a CamelCased string to a underscore_string
+	def underscore
+		self.gsub(/::/, '/').
+				gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+				gsub(/([a-z\d])([A-Z])/,'\1_\2').
+				tr("-", "_").
+				downcase
+	end
+
+	def camelize
+		parts = self.split '_'
+		parts.map! do |part| part.capitalize end
+		parts.join ''
+	end
+end
+
+class ControllerLoader < Loader
+	def initialize(client)
+		super(client)
+		@type = 'controller'
+	end
+
+	def get(controller)
+		if controller_exists? controller
+			if direct_path_to_controller? controller
+				load controller
+
+				controller_class_name = get_controller_class_from_path controller
+				controller_object = get_controller_object controller_class_name
+				controller_instance = controller_object.new @client
+
+				call_setup_method controller_object, controller_instance
+
+				controller_instance
+
+			else
+				load "application/controllers/#{controller.underscore}_controller.rb"
+
+				controller_class_name = get_controller_class controller
+				controller_object = get_controller_object controller_class_name
+				controller_instance = controller_object.new @client
+
+				call_setup_method controller_object, controller_instance
+
+				controller_instance
+			end
+		else
+			raise ControllerLoadException.new "Error loading controller #{controller}. Please verify that it exists at application/controllers/#{controller.underscore}.rb"
+		end
+	end
+
+	private
+
+	def controller_exists?(controller)
+		File.exists? controller or File.exists? "application/controllers/#{controller.underscore}_controller.rb"
+	end
+
+	def direct_path_to_controller?(controller)
+		File.exists? controller
+	end
+
+	def call_setup_method(controller_object, controller_instance)
+		controller_instance.send 'setup' unless not controller_object.method_defined? :setup
+	end
+
+	def get_controller_object(class_name)
+		Object.const_get class_name
+	end
+
+	def get_controller_class(controller)
+		"#{controller}Controller"
+	end
+
+	def get_controller_class_from_path(controller)
+		last_part = controller.split('/')[-1]
+		last_part['.rb'] = ''
+		last_part.camelize
+	end
+end

data/lib/shot_mvc/controller_router.rb

@@ -0,0 +1,38 @@
+# ControllerRouter
+#
+# Routes incoming clients and handles their controller calls.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'shot'
+require_relative './controller_load_exception'
+
+class ControllerRouter < Router
+	def initialize(client)
+		super(client)
+
+		client.on 'call_controller_action' do |data|
+			controller = data['controller']
+			if controller.include? 'GemRoot' then controller['GemRoot'] = gem_root end
+
+			action = data['action']
+			data = (data['data'] or nil)
+
+			controller = @client.get 'controller', controller
+
+			if controller.view_private.include? action then
+				raise ControllerLoadException.new "#{controller}##{action} is not view accessible."
+			end
+
+			if data then controller.send(action, data) else controller.send(action) end
+		end
+	end
+
+	private
+
+	def gem_root
+		Gem::Specification.find_by_name('shot_mvc').gem_dir
+	end
+end

data/lib/shot_mvc/element.rb

@@ -0,0 +1,52 @@
+# Element
+#
+# Represents an element on the user's page, with a corresponding jQuery
+# selector which can be used to call jQuery functions on the user's page.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+class Element
+	# jQuery Selector
+	attr_accessor :selector
+
+	# Associated ApplicationInstance
+	attr_accessor :app
+
+	def self.from_app_and_selector(app, selector)
+		element = Element.new selector
+		element.app = app
+		element
+	end
+
+	def initialize(selector)
+		@selector = selector
+		@app = nil
+	end
+
+	def jq(method, parameters = {})
+		unless app == nil
+			@app.emit 'jq', {
+					'selector'    => @selector,
+					'method'      => method,
+					'parameters'  => [parameters]
+			}
+		end
+	end
+
+	def html=(html)
+		self.jq 'html', [html]
+	end
+
+	def text=(text)
+		self.jq 'text', [text]
+	end
+
+	def render(template, data = nil)
+		template = @app.get 'template', template
+		template.data = data unless data == nil
+		self.html = template.render
+	end
+end

data/lib/shot_mvc/element_loader.rb

@@ -0,0 +1,22 @@
+# ElementLoader
+#
+# Allows the application to query the user's page from the server side in
+# an API similiar to jQuery.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'shot'
+require_relative './element'
+
+class ElementLoader < Loader
+	def initialize(client)
+		super(client)
+		@type = 'element'
+	end
+
+	def get(selector)
+		Element.from_app_and_selector @client, selector
+	end
+end

data/lib/shot_mvc/mvc_application.rb

@@ -0,0 +1,22 @@
+# What is this item?
+#
+# What does this item do?
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'shot'
+require 'shot_mvc'
+
+class MVCApplication < Application
+	def initialize(config = { :host => '127.0.0.1', :port => 8080 })
+		super(config)
+
+		add_router ControllerRouter
+		add_loader ControllerLoader
+		add_loader ElementLoader
+		add_loader TemplateLoader
+		add_loader ConfigurationLoader
+	end
+end

data/lib/shot_mvc/template.rb

@@ -0,0 +1,31 @@
+# Template
+#
+# Wraps an ERB template in a container so data can be accessed properly.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'erb'
+
+class Template
+	# Absolute path to the ERB file
+	attr_accessor :template
+
+	# Data available to the ERB template
+	attr_accessor :data
+
+	def initialize(template_file)
+		@template = template_file
+		@data = {}
+	end
+
+	def render
+		template = ERB.new File.read @template
+		template.result binding
+	end
+
+	def data=(data)
+		@data.merge! data
+	end
+end

data/lib/shot_mvc/template_load_exception.rb

@@ -0,0 +1,14 @@
+# TemplateLoadException
+#
+# Raised if there was an issue while loading a template.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+class TemplateLoadException < Exception
+	def initialize(message)
+		super(message)
+	end
+end

data/lib/shot_mvc/template_loader.rb

@@ -0,0 +1,54 @@
+# TemplateLoader
+#
+# Parses and loads ERB templates from the 'application/views' folder if
+# it exists. If the folder does not exist, an exception will be raised.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+require 'shot'
+require 'erb'
+
+require_relative './template'
+require_relative './template_load_exception'
+
+class TemplateLoader < Loader
+	def initialize(client)
+		super(client)
+		@type = 'template'
+	end
+
+	def get(name)
+		if template_exists? name
+			if full_path? name
+				Template.new name
+			else
+				Template.new "./application/views/#{name}.erb"
+			end
+		else
+			begin
+				raise TemplateLoadException.new "Could not load #{name}. Verify it exists at application/views/#{name}.erb"
+			rescue Exception => ex
+				template = Template.new "#{gem_root}/application/views/view_not_found.erb"
+				template.data = { :requested_view => name, :exception => ex }
+				return template
+			end
+		end
+	end
+
+	private
+
+	def gem_root
+		 Gem::Specification.find_by_name('shot_mvc').gem_dir
+	end
+
+	def full_path?(view_name)
+		File.exists? view_name
+	end
+
+	def template_exists?(view_name)
+		File.exists? view_name or File.exists? "application/views/#{view_name}.erb"
+	end
+end

data/lib/shot_mvc.rb

@@ -0,0 +1,13 @@
+require_relative './shot_mvc/controller_loader'
+require_relative './shot_mvc/controller_load_exception'
+require_relative './shot_mvc/controller_router'
+require_relative './shot_mvc/controller'
+
+require_relative './shot_mvc/element'
+require_relative './shot_mvc/element_loader'
+
+require_relative './shot_mvc/template_loader'
+require_relative './shot_mvc/template'
+require_relative './shot_mvc/template_load_exception'
+
+require_relative './shot_mvc/mvc_application'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: shot_mvc
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jesse A. Dunlap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Shot MVC allows for organization of your code in one of the most accepted
+  organization patterns: the MVC pattern. Provides supports for Models, Views, and
+  Controllers via a series of Routers and Loaders.'
+email: me@jessedunlap.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shot_mvc/controller.rb
+- lib/shot_mvc/controller_loader.rb
+- lib/shot_mvc/controller_load_exception.rb
+- lib/shot_mvc/controller_router.rb
+- lib/shot_mvc/element.rb
+- lib/shot_mvc/element_loader.rb
+- lib/shot_mvc/mvc_application.rb
+- lib/shot_mvc/template.rb
+- lib/shot_mvc/template_loader.rb
+- lib/shot_mvc/template_load_exception.rb
+- lib/shot_mvc.rb
+- application/controllers/view_controller.rb
+- application/views/view_not_found.erb
+- LICENSE.md
+- README.md
+homepage: http://github.com/shot/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Model, View, Controller (MVC) layer for the Shot Framework.
+test_files: []