padrino-contrib 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Padrino
+
+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,29 @@
+= Contributed Plugins and Utilities
+
+This package includes a variety of add-on components for Padrino Framework:
+
+*   exception_notifier     - Send errors through mail or/and to redmine
+*   orm_ar_permalink       - Generate permalink for a specified column on ActiveRecord
+*   orm_ar_permalink_i18n  - Generate permalink for a specified multi language column(s) on ActiveRecord
+*   orm_ar_translate       - Translate for you your ActiveRecord columns
+*   auto_locale            - Switch for you automatically the I18n.locale
+*   flash_session          - Middleware that help you in passing your session in the URI, when it should be in the cookie.
+
+=== Use
+
+In your Padrino project edit:
+
+  # Gemfile
+  gem 'padrino-contrib'
+
+  # boot.rb
+  require 'padrino-contrib/exception_notifier'
+  # require 'padrino-contrib/orm/ar/permalink'
+  # require 'padrino-contrib/orm/ar/textile'
+
+  Padrino.load! # Remember to add contribs before that line!
+
+  # app.rb
+  class MyApp < Padrino::Application
+    register Padrino::Contrib::ExceptionNotifier
+  end

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems/specification' unless defined?(Gem::Specification)
+require 'rake' unless defined?(Rake)
+
+# Runs the sh command with sudo if the rake command is run with sudo
+def sudo_sh(command)
+  command = `whoami`.strip! != "root" ? "sudo #{command}" : command
+  sh command
+end
+
+# Returns the gem specification object for a gem
+def gemspec
+  @gemspec ||= begin
+    ::Gem::Specification.load("padrino-contrib.gemspec")
+  end
+end
+
+# Most notable functions are:
+#   $ rake package # packages the gem into the pkg folder
+#   $ rake install # installs the gem into system
+#   $ rake release # publishes gem to rubygems
+
+desc "Validates the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Displays the current version"
+task :version do
+  puts "Current version: #{gemspec.version}"
+end
+
+desc "Installs the gem locally"
+task :install => :package do
+  sudo_sh "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Uninstalls the gem locally"
+task :uninstall do
+  sudo_sh "gem uninstall padrino-contrib -v #{gemspec.version}"
+end
+
+desc "Release the gem"
+task :release => :package do
+  sh "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
+
+# rake package
+begin
+  require 'rake/gempackagetask'
+rescue LoadError
+  task(:gem) { $stderr.puts '`gem install rake` to package gems' }
+else
+  Rake::GemPackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+  task :gem => :gemspec
+end
+
+task :package => :gemspec
+task :default => :install

data/lib/padrino-contrib/auto_locale.rb

@@ -0,0 +1,42 @@
+module Padrino
+  module Contrib
+    ##
+    # This extension give to padrino the ability to change
+    # their locale inspecting.
+    #
+    # ==== Usage
+    #
+    #   class MyApp < Padrino::Application
+    #     register AutoLocale
+    #     set :locales, [:en, :ru, :de] # First locale is the default locale
+    #   end
+    #
+    #   # view.haml
+    #   =link_to "View this page in RU Version", switch_to_lang(:ru)
+    #
+    # So when we call an url like: /ru/blog/posts this extension set for you :ru as I18n.locale
+    #
+    module AutoLocale
+      module Helpers
+        ##
+        # This reload the page changing the I18n.locale
+        #
+        def switch_to_lang(lang)
+          request.path_info.sub(/\/#{I18n.locale}/, "/#{lang}") if options.locales.include?(lang)
+        end
+      end # Helpers
+
+      def self.registered(app)
+        app.helpers Padrino::Contrib::AutoLocale::Helpers
+        app.set :locales, [:en]
+        app.before do
+          if request.path_info =~ /^\/(#{options.locales.join('|')})\/?/
+            I18n.locale = $1.to_sym
+          else
+            I18n.locale = options.locales.first
+          end
+        end
+      end # self.registered
+    end # AutoLocale
+  end # Contrib
+end # Padrino

data/lib/padrino-contrib/exception_notifier.rb

@@ -0,0 +1,54 @@
+##
+# This is an exception notifier for Padrino::Application with
+# redmine bonus feature.
+#
+# ==== Usage
+#
+#   class MyApp < Padrino::Application
+#     register Padrino::Contrib::ExceptionNotifier
+#     set :exceptions_from,    "errors@localhost.local"
+#     set :exceptions_to,      "foo@bar.local"
+#     set :exceptions_page,    :errors # => views/errors.haml/erb
+#     set :redmine, :project => "My Bugs", :tracker => "Bugs", :priority => "High"
+#     # Uncomment this for test in development
+#     #  disable :raise_errors
+#     #  disable :show_exceptions
+#   end
+#
+module Padrino
+  module Contrib
+    module ExceptionNotifier
+
+      def self.registered(app)
+        app.set :exceptions_subject, "Exception"
+        app.set :exceptions_to,      "errors@localhost.local"
+        app.set :exceptions_from,    "foo@bar.local"
+        app.set :redmine, {}
+        app.error 500 do
+          boom  = env['sinatra.error']
+          body  = ["#{boom.class} - #{boom.message}:", *boom.backtrace].join("\n  ")
+          body += "\n\n---Env:\n"
+          env.each { |k,v| body += "\n#{k}: #{v}" }
+          body += "\n\n---Params:\n"
+          params.each { |k,v| body += "\n#{k.inspect} => #{v.inspect}" }
+          logger.error body
+          settings.redmine.each { |k,v| body += "\n#{k.to_s.capitalize}: #{v}" }
+          app.email do
+            subject "[#{app.exceptions_subject}] #{boom.class} - #{boom.message}"
+            to app.exceptions_to
+            from app.exceptions_from
+            body body
+          end
+          response.status = 500
+          content_type 'text/html', :charset => "utf-8"
+          render settings.exceptions_page
+        end
+        app.error 404 do
+          response.status = 404
+          content_type 'text/html', :charset => "utf-8"
+          render settings.exceptions_page
+        end
+      end # self.registered
+    end # ExceptionNotifier
+  end # Contrib
+end # Padrino

data/lib/padrino-contrib/flash_session.rb

@@ -0,0 +1,32 @@
+require 'rack/utils'
+
+module Padrino
+  module Contrib
+    ##
+    # This Middleware help you passing your session in the URI, when it should be in the cookie.
+    #
+    # This code it's only performed when:
+    #
+    #   env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+    #
+    # ==== Usage
+    #
+    #  use FlashSessionMiddleware, session_id
+    #
+    class FlashSession
+      def initialize(app, session_key = 'session_id')
+        @app = app
+        @session_key = session_key.to_s
+      end
+
+      def call(env)
+        if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+          params = ::Rack::Request.new(env).params
+          env['rack.session'] ||= {}
+          env['rack.session'][@session_key.to_sym] = params[@session_key] if params[@session_key].present?
+        end
+        @app.call(env)
+      end
+    end # FlashSession
+  end # Contrib
+end # Padrino

data/lib/padrino-contrib/orm/ar/permalink.rb

@@ -0,0 +1,45 @@
+module Padrino
+  module Contrib
+    module Orm
+      module Ar
+        ##
+        # This module extend ActiveRecord.
+        #
+        # You need to to your model a column called +:permalink+
+        #
+        # then use +has_permalink :title like:
+        #
+        #   class Page < ActiveRecord::Base
+        #     has_permalink :page
+        #   end
+        #
+        module Permalink
+          module ClassMethods
+            def has_permalink(field)
+              include InstanceMethods
+              class_inheritable_accessor  :permalink_field
+              write_inheritable_attribute :permalink_field, field
+              before_save :generate_permalink
+            end
+          end # ClassMethods
+
+          module InstanceMethods
+            def to_param
+              permalink
+            end
+
+            protected
+              def generate_permalink
+                self.permalink = read_attribute(permalink_field).downcase.
+                                                                 gsub(/\W/, '-').
+                                                                 gsub(/-+/, '-').
+                                                                 gsub(/-$/, '').
+                                                                 gsub(/^-/, '')
+              end
+          end # InstanceMethods
+        end # Permalink
+      end # Ar
+    end # Orm
+  end # Contrib
+end # Padrino
+ActiveRecord::Base.extend(Padrino::Contrib::Orm::Ar::Permalink::ClassMethods)

data/lib/padrino-contrib/orm/ar/permalink_i18n.rb

@@ -0,0 +1,56 @@
+module Padrino
+  module Contrib
+    module Orm
+      module Ar
+        ##
+        # This module extend ActiveRecord.
+        #
+        # You need to to your model a column called +:permalink+
+        #
+        # then use +has_permalink :title like:
+        #
+        #   class Page < ActiveRecord::Base
+        #     has_permalink :page, :langs => [:en, :fr, :de]
+        #   end
+        #
+        module PermalinkI18n
+          module ClassMethods
+            def has_permalink(field, options={})
+              include InstanceMethods
+              class_inheritable_accessor  :permalink_field, :permalink_langs
+              write_inheritable_attribute :permalink_field, field
+              write_inheritable_attribute :permalink_langs, options.delete(:langs)
+              before_save :generate_permalinks
+              permalink_langs.each do |lang|
+                validates_uniqueness_of :"#{field}_#{lang}", options
+              end
+            end
+
+            def permalink_for(name)
+              name = Iconv.iconv('ascii//translit//IGNORE', 'utf-8', name).to_s
+              name.gsub!(/\W+/, ' ') # non-words to space
+              name.strip!
+              name.downcase!
+              name.gsub!(/\s+/, '-') # all spaces to dashes
+              name
+            end
+          end
+
+          module InstanceMethods
+            def to_param
+              permalink
+            end
+
+            protected
+              def generate_permalinks
+                permalink_langs.each do |lang|
+                  self.send(:"permalink_#{lang}=", self.class.permalink_for(read_attribute(:"#{permalink_field}_#{lang}")))
+                end
+              end
+          end # InstanceMethods
+        end # PemalinkI18n
+      end # Ar
+    end # Orm
+  end # Contrib
+end # Padrino
+ActiveRecord::Base.extend(Padrino::Contrib::Orm::Ar::PermalinkI18n::ClassMethods)

data/lib/padrino-contrib/orm/ar/textile.rb

@@ -0,0 +1,53 @@
+require 'RedCloth'
+
+module Padrino
+  module Contrib
+    module Orm
+      module Ar
+        ##
+        # This module generate html from textile.
+        #
+        # In your ActiveRecord class you need only to add:
+        #
+        #   has_textile :body, :internal_links => :page
+        #
+        # In your body you can write (like github) internal links:
+        #
+        #   [[Page Name|link me]]
+        #
+        module Textile
+          module ClassMethods
+            def has_textile(*fields)
+              include InstanceMethods
+              options = fields.extract_options!
+              options.reverse_merge!(:internal_links => :blog)
+              class_inheritable_accessor  :textile_fields, :textile_options
+              write_inheritable_attribute :textile_fields, fields
+              write_inheritable_attribute :textile_options, options
+              before_save :generate_textile
+            end
+          end
+
+          module InstanceMethods
+            protected
+              def generate_textile
+                textile_fields.each do |textile_field|
+                  next if read_attribute(textile_field).blank?
+                  html = RedCloth.new(read_attribute(textile_field)).to_html
+                  # Parse internal links
+                  html.gsub!(/\[\[([^\]]+)\]\]/) do
+                    page, name = *$1.split("|") # this allow to rename link ex: [[Page Name|link me]]
+                    name ||= page
+                    "<a href=\"/#{textile_options[:internal_links]}/#{Post.permalink_for(page.strip)}\">#{name.strip}</a>"
+                  end
+                  # Write content
+                  self.send("#{textile_field}_html=", html)
+                end
+              end
+          end # InstanceMethods
+        end # Permalink
+      end # Ar
+    end # Orm
+  end # Contrib
+end # Padrino
+ActiveRecord::Base.extend(Padrino::Contrib::Orm::Ar::Textile::ClassMethods)

data/lib/padrino-contrib/orm/ar/translate.rb

@@ -0,0 +1,43 @@
+module Padrino
+  module Contrib
+    module Orm
+      module Ar
+        ##
+        # This is an extension for ActiveRecord where if I had:
+        #
+        #   post.description_ru = "I'm Russian"
+        #   post.description_en = "I'm English"
+        #   post.description_it = "I'm Italian"
+        #
+        # with this extension if I had set:
+        #
+        #   I18n.locale = :it
+        #
+        # calling directly:
+        #
+        #   post.description
+        #
+        # will be a shortcut for:
+        #
+        #  post.description_it => "I'm Italian"
+        #
+        module Translate
+          module ClassMethods
+            def has_locale
+              include InstanceMethods
+            end
+          end # ClassMethods
+
+          module InstanceMethods
+            def method_missing(method_name, *arguments)
+              attribute = "#{method_name}_#{I18n.locale}".to_sym
+              return self.send(attribute) if I18n.locale.present? && self.respond_to?(attribute)
+              super
+            end
+          end # InstanceMethods
+        end # ArTranslate
+      end # Ar
+    end # Orm
+  end # Contrib
+end # Padrino
+ActiveRecord::Base.extend(Padrino::Contrib::Orm::Ar::Translate::ClassMethods)

data/lib/padrino-contrib/version.rb

@@ -0,0 +1,17 @@
+##
+# Manages current Padrino Contrib version for use in gem generation.
+#
+# We put this in a separate file so you can get padrino version
+# without include full padrino contrib.
+#
+module Padrino
+  module Contrib
+    VERSION = '0.0.1' unless defined?(Padrino::Contrib::VERSION)
+    ##
+    # Return the current Padrino version
+    #
+    def self.version
+      VERSION
+    end
+  end # Contrib
+end # Padrino

data/padrino-contrib.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path("../lib/padrino-contrib/version.rb", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "padrino-contrib"
+  s.rubyforge_project = "padrino-contrib"
+  s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
+  s.email = "padrinorb@gmail.com"
+  s.summary = "Contributed plugins and utilities for Padrino Framework"
+  s.homepage = "http://www.padrinorb.com"
+  s.description = "Contributed plugins and utilities for the Padrino Ruby Web Framework"
+  s.required_rubygems_version = ">= 1.3.6"
+  s.version = Padrino::Contrib.version
+  s.date = Time.now.strftime("%Y-%m-%d")
+  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.files = %w(LICENSE README.rdoc Rakefile padrino-contrib.gemspec) + Dir.glob("{bin,lib,test}/**/*")
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_path = "lib"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: padrino-contrib
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Padrino Team
+- Nathan Esquenazi
+- Davide D'Agostino
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Contributed plugins and utilities for the Padrino Ruby Web Framework
+email: padrinorb@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- padrino-contrib.gemspec
+- lib/padrino-contrib/auto_locale.rb
+- lib/padrino-contrib/exception_notifier.rb
+- lib/padrino-contrib/flash_session.rb
+- lib/padrino-contrib/orm/ar/permalink.rb
+- lib/padrino-contrib/orm/ar/permalink_i18n.rb
+- lib/padrino-contrib/orm/ar/textile.rb
+- lib/padrino-contrib/orm/ar/translate.rb
+- lib/padrino-contrib/version.rb
+has_rdoc: true
+homepage: http://www.padrinorb.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: padrino-contrib
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Contributed plugins and utilities for Padrino Framework
+test_files: []
+