shot_libs 1.0.0

data/README.md

@@ -0,0 +1,63 @@
+Introduction
+------------
+
+Shot Libs is a series of Loaders which allow you to utilize Helpers and Libraries to outsource controller and app logic.
+
+
+Installation
+------------
+
+```
+gem install shot_libs
+```
+
+
+Usage Example
+-------------
+
+```ruby
+require 'shot'
+require 'shot_libs'
+
+app = Application.new
+
+app.add_loader HelperLoader
+app.add_loader LibraryLoader
+
+app.run do
+    app.on 'load' do |instance|
+        instance.get 'library', 'SomeLibrary'
+    end
+end
+
+app.start
+```
+
+Controller Example
+------------------
+
+**application/helpers/email.rb**
+
+```ruby
+class Email
+    self.send_email(recipient, subject, body)
+        # Actually send an email here using the devil's magic of SMTP
+    end
+end
+```
+
+**application/controllers/email.rb**
+
+```ruby
+require 'shot_mvc'
+
+class EmailController < Controller
+    def setup
+        get 'helper', 'Email'
+    end
+
+    def send(message)
+        Email.send_email message['recipient'], message['subject'], message['body']
+    end
+end
+```

data/lib/shot_libs/helper_load_exception.rb

@@ -0,0 +1,14 @@
+# HelperLoadException
+#
+# Thrown if an error occurs when loading a helper.
+#
+# 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 HelperLoadException < Exception
+	def initialize(message)
+		super(message)
+	end
+end

data/lib/shot_libs/helper_loader.rb

@@ -0,0 +1,44 @@
+# HelperLoader
+#
+# Adds Helper loading capability to the Shot Framework. Helpers are simply outsourcing libraries
+# for use in Controllers only.
+#
+# 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 './library_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
+end
+
+class HelperLoader < Loader
+	def initialize(client)
+		super(client)
+		@type = 'helper'
+	end
+
+	def get(helper_name)
+		if helper_exists? helper_name
+			load "./application/helpers/#{helper_name.underscore}.rb"
+		else
+			raise HelperLoadException "Could not find helper #{helper_name}. Please verify it exists at application/helpers/#{helper_name.underscore}.rb"
+		end
+	end
+
+	private
+
+	def helper_exists?(helper)
+		Dir.exists? 'application/helpers' and File.exists? "application/helpers/#{helper.underscore}.rb"
+	end
+end

data/lib/shot_libs/library_load_exception.rb

@@ -0,0 +1,14 @@
+# LibraryLoadException
+#
+# Thrown if a Library doesn't exist.
+#
+# 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 LibraryLoadException < Exception
+	def initialize(message)
+		super(message)
+	end
+end

data/lib/shot_libs/library_loader.rb

@@ -0,0 +1,44 @@
+# LibraryLoader
+#
+# Adds Helper loading capability to the Shot Framework. Helpers are simply outsourcing libraries
+# for use in Controllers only.
+#
+# 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 './library_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
+end
+
+class LibraryLoader < Loader
+	def initialize(client)
+		super(client)
+		@type = 'library'
+	end
+
+	def get(library_name)
+		if helper_exists helper
+			load "./application/libraries/#{library_name.underscore}.rb"
+		else
+			raise LibraryLoadException "Could not find library #{library_name}. Please verify it exists at application/libraries/#{library_name.underscore}.rb"
+		end
+	end
+
+	private
+
+	def helper_exits(helper)
+		Dir.exists? 'application/libraries' and File.exists? "application/libraries/#{helper.underscore}.rb"
+	end
+end

data/lib/shot_libs.rb

@@ -0,0 +1,4 @@
+require_relative './shot_libs/library_loader'
+require_relative './shot_libs/library_load_exception'
+require_relative './shot_libs/helper_loader'
+require_relative './shot_libs/helper_load_exception'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: shot_libs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  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: shot_mvc
+  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 Libs implements a series of Loaders, which can be used to obtain
+  instances of Helpers and Libraries, to extract business logic from your MVC application.
+email: me@jessedunlap.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shot_libs/helper_loader.rb
+- lib/shot_libs/helper_load_exception.rb
+- lib/shot_libs/library_loader.rb
+- lib/shot_libs/library_load_exception.rb
+- lib/shot_libs.rb
+- 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: Adds library loading ability to Shot, for better code organization.
+test_files: []