sinatra_fedora 1.0.1 → 1.1

data/COPYING

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Daniel Durante
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Sinatra Fedora nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,90 @@
+= Sinatra::Fedora
+
+A Sinatra (http://github.com/sinatra/sinatra) class that provides the ability to automatically map controllers into the URL. Acts like a very light "wrapper" around Sinatra::Base. Essentially, a watered-down (in a good way) version of Padrino.
+
+tl;dr A classier way for Sinatra
+
+== Installation
+    gem install sinatra_fedora
+
+== The Fedora Binary
+The Fedora binary offers basic functionality as for now.
+
+=== Creating a new project
+Creating a project within the directory
+    fedora sing [hat]
+
+Creating a project within a new directory
+    fedora new <project_name> [hat]
+
+=== What are hats?
+Fedora offers a way to create templates for your projects. Think of each hat as a blueprint for a project. Sometimes you just need Sinatra and other times you need Sinatra/DataMapper/Warden/etc. You can manage hats by using the "hatrack" command in fedora.
+
+To add a hat...
+    fedora hatrack add ~/path/to/directory <hat name>
+
+To remove a hat (you can replace +rm+ with +rem+, +remove+, +del+, or +delete+)...
+    fedora hatrack rm <hat name>
+
+=== Official Hats
+[official]
+  The default hat, sets up a simple Sinatra application
+
+[datamapper]
+  Same as default hat with DataMapper (you must apply which adapter you need) added
+
+[concert]
+  Sets up DataMapper (same rules apply for [datamapper]) and {sinatra_warden}[https://github.com/jsmestad/sinatra_warden]. It does not setup CSRF, etc.
+
+== Usage
+=== Helpers
+To escape HTML simply type "h" for example:
+    h "<This is escaped!>"
+
+Fedora offers an incredibly way to link/route towards pages. Let's say your controller is called "Auth" and every link goes to '/auth', '/auth/list', '/auth/dashboard', etc. You would simply type (for example):
+    link_to('/auth/list')
+
+Your boss goes up to you and says, "I want all of the membership links to point towards user not auth." The only thing you have to change is the controller's url/namespace option.
+    class Auth < Fedora
+      url '/user'
+      ...code here...
+    end
+
+And Fedora will translate all of your '/auth' links to '/user' automatically. The namespace translation only happens once and then caches for the rest of the page so having multiple '/auth/*' links wont cause much overhead.
+
+=== Main app.rb file
+    require 'sinatra_fedora'
+    
+    class Fedora
+      enable :sessions
+      
+      set :views, File.dirname(__FILE__) + '/app/views'
+      set :public, File.dirname(__FILE__) + '/public'
+      
+      Dir.glob('app/models/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+      Dir.glob('app/controllers/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+    end
+
+=== Typical Controller Class
+    class Home < Fedora
+      url '/' # Tells Fedora to set these actions to the root of the URL
+      views_from '/' # Grab views from :views/
+      
+      get '/' do
+      	haml :index
+      end
+    end
+
+If your controller doesn't contain "views_from" Fedora will simply look in :views/<controller name>/ ("url" acts in the same exact way). Be sure to check out the app.rb and config.ru source. You can replace "url" method with "namespace" as well.
+
+== Goals
+* Make development faster with larger projects using Sinatra
+* Keep it as slim as possible. For a fully featured Sinatra framework use Padrino.
+* Keep it classy.
+
+== Feedback
+I'm always looking for ways to improve Fedora as well as my other projects. Shoot me a message on here fork the project over!
+
+== Contributors
+
+* Jonathan Stott (https://github.com/namelessjon)

data/bin/fedora

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: fedora COMMAND [OPTIONS]"
+  opt.separator ""
+  opt.separator "Commands"
+  opt.separator "     new <project name> [hat]: Creates a new Fedora project"
+  opt.separator "       e.g. fedora new project_name"
+  opt.separator "       hats are blueprints for your projects type 'fedora hatrack' for more info."
+  opt.separator ""
+  opt.separator "     sing [hat]: Creates a new Fedora project in the directory that you're in."
+  opt.separator ""
+end
+
+opt_parser.parse!
+
+case ARGV[0]
+when "new", "sing"
+  if ARGV[1].nil? and ARGV[0] != "sing"
+    puts opt_parser
+  else
+    ARGV[2] ||= "official"
+
+    if File.directory? ARGV[2]
+      hatrack_dir = ARGV[2]
+    else
+      ARGV[2].gsub(/[^\w\d]/, '')
+      hatrack_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib/hatrack/' + ARGV[2]))
+    end
+
+    if !File.directory? hatrack_dir
+      puts "Hatrack '" + ARGV[2] + "' doesn't exist"
+      exit(1)
+    end
+
+    if ARGV[0] == "sing"
+      FileUtils.cp_r hatrack_dir + '/.', Dir.pwd
+      ARGV[1] = ''
+    else
+      ARGV[1].gsub(/[^\w\d]/, '').downcase
+      current_dir = File.expand_path(File.join(File.dirname(__FILE__)))
+
+      if File.exists? current_dir + "/#{ARGV[1]}"
+        puts "Project #{ARGV[1]} already exist in this directory, try choosing a different name."
+        exit(1)
+      end
+
+      FileUtils.mkdir ARGV[1]
+      FileUtils.cp_r hatrack_dir + '/.', ARGV[1]
+    end
+
+    puts "Sinatra found his fedora in " + Dir.pwd + "/#{ARGV[1]}"
+    puts "Head on over there to start developing"
+  end
+when "hatrack"
+  case ARGV[1]
+  when "rm", "rem", "remove", "del", "delete"
+    ARGV[2].gsub(/[^\w\d]/, '')
+    hatrack_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib/hatrack/' + ARGV[2]))
+    if ARGV[2] == "official"
+      puts "You can't delete the official Fedora hat."
+    elsif File.directory? hatrack_dir
+      FileUtils.rm_rf hatrack_dir
+      puts ARGV[2] + " hat has been removed."
+    else
+      puts ARGV[2] + " is not a valid hat."
+    end
+  when "add"
+    if ARGV[3].nil?
+      puts "You must name this hat something."
+      exit(1)
+    end
+
+    ARGV[3].gsub(/[^\w\d]/, '')
+    if File.directory? ARGV[2]
+      FileUtils.mkdir File.expand_path(File.join(File.dirname(__FILE__), '../lib/hatrack/' + ARGV[3]))
+      FileUtils.cp_r ARGV[2] + '/.', File.expand_path(File.join(File.dirname(__FILE__), '../lib/hatrack/' + ARGV[3]))
+      puts ARGV[3] + " hat has been made added to the hatrack."
+    else
+      puts "We couldn't find the hat: " + ARGV[2]
+      exit(1)
+    end
+  else
+    opt_parser2 = OptionParser.new do |opt|
+      opt.banner = "Usage: fedora hatrack COMMAND HAT"
+      opt.separator ""
+      opt.separator "Commands"
+      opt.separator "     rm, rem, remove, del, delete: Removes a hat from the hatrack"
+      opt.separator "       e.g. fedora hatrack rm official"
+      opt.separator ""
+      opt.separator "     add [directory to hat] [hat name]: Adds a hat to the hatrack."
+      opt.separator "       e.g. fedora hatrack add ~/custom_hats/example example"
+      opt.separator ""
+    end
+    puts opt_parser2
+  end
+else
+  puts opt_parser
+end

data/lib/hatrack/concert/app/controllers/home.rb

@@ -0,0 +1,16 @@
+class Home < Fedora
+  # Set as the root URL otherwise
+  # the url will default to /home
+  # (class name lowercased)
+  url '/'
+
+  # views_from tells Fedora which
+  # folder in :views you want to use
+  # for all actions in this class
+  # (:views_directory overrides this)
+  views_from '/'
+
+  get '/' do
+    haml :index
+  end
+end

data/lib/hatrack/concert/app/views/index.haml

@@ -0,0 +1,3 @@
+Visit our 
+%a(href = 'https://github.com/durango/sinatra_fedora' target = '_blank') GitHub
+page to learn more.

data/lib/hatrack/concert/app/views/layout.haml

@@ -0,0 +1,2 @@
+%h1 Welcome to Sinatra::Fedora!
+= yield

data/lib/hatrack/concert/app.rb

@@ -0,0 +1,55 @@
+require 'sinatra_fedora'
+require 'sass'
+require 'haml'
+require 'sinatra_warden'
+require 'datamapper'
+require 'rack-flash'
+
+class Fedora
+  enable :sessions
+  register Sinatra::Warden
+  use Rack::Flash
+
+  #DataMapper.setup(:default, 'adapter://user:pass@host/db')
+
+  set :views, File.dirname(__FILE__) + '/app/views'
+  set :public, File.dirname(__FILE__) + '/public'
+
+  # sinatra_warden helpers
+  # for more info https://github.com/jsmestad/sinatra_warden
+  set :auth_error_message, 'Invalid e-mail/password combination'
+  set :auth_failure_path, '/login'
+  set :auth_already_logged_in, '/account'
+
+  # Don't forget to change this!
+  use Rack::Session::Cookie, :secret => "my secret key!"
+
+  configure(:development) do
+    #DataMapper::Logger.new($stdout, :debug)
+  end
+
+  # Render .css files
+  get '/:file.css' do |file|
+    content_type :css
+    response['Expires'] = (Time.now + 60*60*24*356*3).httpdate
+    if File.file?(File.join(settings.views, "#{file}.scss"))
+      scss file.to_sym
+    else
+      not_found
+    end
+  end
+
+  Dir.glob('app/models/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+  DataMapper.finalize.auto_upgrade!
+
+  Dir.glob('app/controllers/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+
+  # Warden helper file
+  require File.dirname(__FILE__) + '/warden.rb'
+
+  # Add warden strategies here
+	use Warden::Manager do |manager|
+		manager.default_strategies :password
+		manager.failure_app = Fedora
+	end
+end

data/lib/hatrack/concert/config.ru

@@ -0,0 +1,2 @@
+require './app.rb'
+run Fedora.map

data/lib/hatrack/concert/warden.rb

@@ -0,0 +1,22 @@
+# Link warden with the correct user id and function to grab user info
+Warden::Manager.serialize_into_session{|user| user.id }
+Warden::Manager.serialize_from_session{|id| User.get(id) }
+
+Warden::Manager.before_failure do |env,opts|
+	env['REQUEST_METHOD'] = "POST"
+end
+
+Warden::Strategies.add(:password) do
+	def valid?
+		params["email"] || params["password"]
+	end 
+	
+	def authenticate!
+		u = User.authenticate(params["email"], params["password"])
+		if u.nil?
+			fail!("Could not log in")
+		else
+			success!(u)
+		end
+	end 
+end

data/lib/hatrack/datamapper/app/controllers/home.rb

@@ -0,0 +1,16 @@
+class Home < Fedora
+  # Set as the root URL otherwise
+  # the url will default to /home
+  # (class name lowercased)
+  url '/'
+
+  # views_from tells Fedora which
+  # folder in :views you want to use
+  # for all actions in this class
+  # (:views_directory overrides this)
+  views_from '/'
+
+  get '/' do
+    haml :index
+  end
+end

data/lib/hatrack/datamapper/app/views/index.haml

@@ -0,0 +1,3 @@
+Visit our 
+%a(href = 'https://github.com/durango/sinatra_fedora' target = '_blank') GitHub
+page to learn more.

data/lib/hatrack/datamapper/app/views/layout.haml

@@ -0,0 +1,2 @@
+%h1 Welcome to Sinatra::Fedora!
+= yield

data/lib/hatrack/datamapper/app.rb

@@ -0,0 +1,20 @@
+require 'sinatra_fedora'
+require 'datamapper'
+
+class Fedora
+  enable :sessions
+
+  #DataMapper.setup(:default, 'adapter://user:password@host/db')
+
+  set :views, File.dirname(__FILE__) + '/app/views'
+  set :public, File.dirname(__FILE__) + '/public'
+
+  configure(:development) do
+    DataMapper::Logger.new($stdout, :debug)
+  end
+
+  Dir.glob('app/models/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+  #DataMapper.finalize.auto_upgrade!
+
+  Dir.glob('app/controllers/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+end

data/lib/hatrack/datamapper/config.ru

@@ -0,0 +1,2 @@
+require './app.rb'
+run Fedora.map

data/lib/hatrack/official/app/controllers/home.rb

@@ -0,0 +1,16 @@
+class Home < Fedora
+  # Set as the root URL otherwise
+  # the url will default to /home
+  # (class name lowercased)
+  url '/'
+
+  # views_from tells Fedora which
+  # folder in :views you want to use
+  # for all actions in this class
+  # (:views_directory overrides this)
+  views_from '/'
+
+  get '/' do
+    haml :index
+  end
+end

data/lib/hatrack/official/app/views/index.haml

@@ -0,0 +1,3 @@
+Visit our 
+%a(href = 'https://github.com/durango/sinatra_fedora' target = '_blank') GitHub
+page to learn more.

data/lib/hatrack/official/app/views/layout.haml

@@ -0,0 +1,2 @@
+%h1 Welcome to Sinatra::Fedora!
+= yield

data/lib/hatrack/official/app.rb

@@ -0,0 +1,11 @@
+require 'sinatra_fedora'
+
+class Fedora
+  enable :sessions
+
+  set :views, File.dirname(__FILE__) + '/app/views'
+  set :public, File.dirname(__FILE__) + '/public'
+
+  Dir.glob('app/models/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+  Dir.glob('app/controllers/*.rb').each { |r| require File.expand_path(File.join(File.dirname(__FILE__), r)) }
+end

data/lib/hatrack/official/config.ru

@@ -0,0 +1,2 @@
+require './app.rb'
+run Fedora.map

data/lib/sinatra_fedora/fedora.rb

@@ -31,13 +31,68 @@
 
 require 'sinatra/base'
 
+# Memoizable code for caching link_to objects
+# see http://snippets.dzone.com/posts/show/5300
+module Memoizable
+  # Store for cached values.
+  CACHE = Hash.new{|h,k| h[k] = Hash.new{|h,k| h[k] = {}}} # 3 level hash; CACHE[:foo][:bar][:yelp]
+  
+  # Memoize the given method(s).
+  def memoize(*names)
+    names.each do |name|
+      unmemoized = "__unmemoized_#{name}"
+      
+      class_eval %Q{
+        alias   :#{unmemoized} :#{name}
+        private :#{unmemoized}
+        def #{name}(*args)
+          cache = CACHE[self][#{name.inspect}]
+          cache.has_key?(args) ? cache[args] : (cache[args] = send(:#{unmemoized}, *args))
+        end
+      }
+    end
+  end
+  
+  # Flush cached return values.
+  def flush_memos
+    CACHE.clear
+  end
+  module_function :flush_memos
+end
+
 module Sinatra
+  # simple way to escape HTML (method 'h')
   module HTMLEscapeHelper
     def h(text)
       Rack::Utils.escape_html(text)
     end
   end
 
+  # link_to helper
+  module LinkHelper
+    extend Memoizable
+
+    def get_namespace(klass)
+      begin
+        Object.const_get(klass).namespace
+      rescue
+        klass
+      end
+    end
+
+    def link_to(link, disable=false)
+      if disable
+        return link
+      end
+
+      _class = link.gsub(/^\/([\w\d]+)/, '\1').split('/')
+      _name = get_namespace _class[0].capitalize
+      _name + _class.join('/').gsub(_class[0], '')
+    end
+    # cache the namespace to save time
+    memoize :get_namespace
+  end
+
   module Templates
     def render(engine, data, options={}, locals={}, &block)
       # merge app-level options
@@ -79,12 +134,11 @@ module Sinatra
       output
     end
   end
-
-  helpers HTMLEscapeHelper
 end
 
 class Fedora < Sinatra::Base
   helpers Sinatra::HTMLEscapeHelper
+  helpers Sinatra::LinkHelper
 
   def self.inherited(klass)
     super
@@ -92,7 +146,7 @@ class Fedora < Sinatra::Base
   end
 
   def self.descendents
-     @descendents ||= []
+    @descendents ||= []
   end
 
   def self.map

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_fedora
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 13
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  version: "1.1"
 platform: ruby
 authors: 
 - Daniel Durante
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-28 00:00:00 -04:00
+date: 2011-07-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,19 +30,38 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 description: Converts class names intro controllers and automatically maps them. Same thing with views and both, views and controllers, can be configured to your liking. It combines the best of both Padrino and Sinatra.
 email: officedebo@gmail.com
-executables: []
-
+executables: 
+- fedora
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- lib/sinatra_fedora.rb
+- bin/fedora
+- lib/hatrack/concert/app/controllers/home.rb
+- lib/hatrack/concert/app/views/index.haml
+- lib/hatrack/concert/app/views/layout.haml
+- lib/hatrack/concert/app.rb
+- lib/hatrack/concert/config.ru
+- lib/hatrack/concert/warden.rb
+- lib/hatrack/datamapper/app/controllers/home.rb
+- lib/hatrack/datamapper/app/views/index.haml
+- lib/hatrack/datamapper/app/views/layout.haml
+- lib/hatrack/datamapper/app.rb
+- lib/hatrack/datamapper/config.ru
+- lib/hatrack/official/app/controllers/home.rb
+- lib/hatrack/official/app/views/index.haml
+- lib/hatrack/official/app/views/layout.haml
+- lib/hatrack/official/app.rb
+- lib/hatrack/official/config.ru
 - lib/sinatra_fedora/fedora.rb
+- lib/sinatra_fedora.rb
+- COPYING
+- README.rdoc
 has_rdoc: true
 homepage: https://github.com/durango/sinatra_fedora
 licenses: 
@@ -67,10 +85,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: