georgedrummond_sinatra_helpers 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, George Drummond, AccountsApp Ltd
+
+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.rdoc

@@ -0,0 +1,39 @@
+= GeorgeDrummond::Sinatra::Helpers
+
+This is a collection of common helper methods that I use within my Sinatra apps. They have a rails like feel and they mainly fill in for helpers you would find in Rails. They do not behave exactly like their rails counterparts so please be careful to read the RDOC.
+
+== Installation
+
+First of all install the gem or add it to your Gemfile.
+
+    gem install georgedrummond_sinatra_helpers
+    
+In your Gemfile
+
+    gem "georgedrummond_sinatra_helpers"
+
+
+== Usage
+
+Sample usage in a project
+
+    require "georgedrummond_sinatra_helpers"
+
+    class Application < Sinatra::Base
+      include GeorgeDrummond::Sinatra::Helpers
+      
+      get "/" do
+        haml :index
+      end
+      
+    end
+
+Helper methods will be available in your views and methods within the Application class.
+
+== Documentation
+
+For documentation please see GeorgeDrummond::Sinatra::Helpers
+
+== License
+
+Released under the MIT License.

data/georgedrummond_sinatra_helpers.gemspec

@@ -4,21 +4,19 @@ require "georgedrummond_sinatra_helpers/version"
 
 Gem::Specification.new do |s|
   s.name        = "georgedrummond_sinatra_helpers"
-  s.version     = GeorgedrummondSinatraHelpers::VERSION
+  s.version     = GeorgeDrummond::Sinatra::Helpers::VERSION
   s.authors     = ["George Drummond"]
   s.email       = ["george@accountsapp.com"]
-  s.homepage    = ""
-  s.summary     = %q{Common helper methods}
-  s.description = %q{Some common helper methods I use in my apps}
-
-  s.rubyforge_project = "georgedrummond_sinatra_helpers"
+  s.homepage    = "https://github.com/georgedrummond/georgedrummond_sinatra_helpers"
+  s.description = %q{This is a collection of common helper methods that I use within my Sinatra apps. They have a rails like feel and they mainly fill in for helpers you would find in Rails. They do not behave exactly like their rails counterparts so please be careful to read the RDOC.}
+  s.summary     = s.description
 
+  s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
+  s.rdoc_options      = %w[--line-numbers --inline-source --title Sinatra --main README.rdoc]
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
 end

data/lib/georgedrummond_sinatra_helpers.rb

@@ -3,7 +3,22 @@ require "georgedrummond_sinatra_helpers/version"
 module GeorgeDrummond
   module Sinatra
     module Helpers
-    
+      # Creates html tags for stylesheets from the arguements provided. Dont include the <tt>.css</tt> extension as this
+      # will be automatically appended. You can specify one or multiple css files at once. Place your css files in
+      # the <tt>public/css</tt> folder of your app.
+      #
+      # ==== Examples
+      #
+      # With only one CSS file
+      #
+      #    stylesheet_link_tag :app
+      #    # => <link href="/css/app.css" type="text/css" />
+      #
+      # With an array of CSS files we want to show
+      #
+      #    stylesheet_link_tag :app, :header # =>
+      #      <link href="/css/app.css" type="text/css" />
+      #      <link href="/css/header.css" type="text/css" />
       def stylesheet_link_tag(*sources)
         html = []
         sources.each do |stylesheet|
@@ -12,7 +27,23 @@ module GeorgeDrummond
         end
         return html.join("\n")
       end
-    
+      
+      # Creates html tags for javascript includes from the arguments provided. Dont include the <tt>.js</tt> extension as this
+      # will be automatically appended. You can specify one or multiple javascript files at once. Place your javascript files in
+      # the <tt>public/js</tt> folder of your app.
+      #
+      # ==== Examples
+      #
+      # With only one javascript file
+      #
+      #    javascript_include_tag :app
+      #    # => <script type="text/javascript" src="/js/app.js"></script>
+      #
+      # With an array of javascript files we want to show
+      #
+      #    javascript_include_tag :jquery, :app # =>
+      #      <script type="text/javascript" src="/js/jquery.js"></script>
+      #      <script type="text/javascript" src="/js/app.js"></script>
       def javascript_include_tag(*sources)
         html = []
         sources.each do |javascript|
@@ -21,12 +52,26 @@ module GeorgeDrummond
         end
         return html.join("\n")
       end
-    
+      
+      # Creates a html image tag given a file name. File should be located in <tt>public/images</tt>. Will not work with external
+      # files for now however I may add this at a later date if it is needed.
+      #
+      # ==== Examples
+      #
+      #    image_tag "home.png"
+      #    # => <img src="/images/home.png" />
       def image_tag(image)
         path = "/images/#{image}"
         return "<img src=\"#{url(path)}\" />\n"
       end
     
+      # Creates a html link tag given a page <tt>title</tt> and resource <tt>path</tt>. Works similar to the Rails link_to method
+      # however does not accept any other options.
+      #
+      # ==== Examples
+      #
+      #    link_to "Home", "/"
+      #    # => <a href="/">Home</a>
       def link_to(title, path)
         return "<a href=\"#{url(path)}\">#{title}</a>"
       end

data/lib/georgedrummond_sinatra_helpers/version.rb

@@ -1,3 +1,7 @@
-module GeorgedrummondSinatraHelpers
-  VERSION = "0.0.1"
+module GeorgeDrummond
+  module Sinatra
+    module Helpers
+      VERSION = "0.0.2"
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: georgedrummond_sinatra_helpers
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - George Drummond
@@ -15,31 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-16 00:00:00 Z
+date: 2011-10-17 00:00:00 Z
 dependencies: []
 
-description: Some common helper methods I use in my apps
+description: This is a collection of common helper methods that I use within my Sinatra apps. They have a rails like feel and they mainly fill in for helpers you would find in Rails. They do not behave exactly like their rails counterparts so please be careful to read the RDOC.
 email: 
 - george@accountsapp.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
+- README.rdoc
 - Rakefile
 - georgedrummond_sinatra_helpers.gemspec
 - lib/georgedrummond_sinatra_helpers.rb
 - lib/georgedrummond_sinatra_helpers/version.rb
-homepage: ""
+homepage: https://github.com/georgedrummond/georgedrummond_sinatra_helpers
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,10 +70,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: georgedrummond_sinatra_helpers
+rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Common helper methods
+summary: This is a collection of common helper methods that I use within my Sinatra apps. They have a rails like feel and they mainly fill in for helpers you would find in Rails. They do not behave exactly like their rails counterparts so please be careful to read the RDOC.
 test_files: []